CatalogController

Overview

• Description

  • Catalog Object

• Concepts

  • CatalogDrafts

    • Publishing a draft

  • Visibility

• Batch Uploader Feedback Codes

  • Warnings

  • Errors

• API Reference

  • Catalogs

    • POST - Create-Catalog

    • GET /id

    • PUT /id

    • DELETE /id

  • Items

    • Item object

    • GET /id/items

    • POST /id/items

    • POST /id/threeDimensionalAssets

  • Materials

    • GET /id/materials

    • POST /id/materials

  • Tags

    • GET /id/tags

    • POST /id/tags

    • GET /id/allTags

  • Prices

    • GET /id/prices

    • POST /id/prices

  • Components

    • GET /id/components

    • POST /id/components

  • Drafts

    • GET /id/drafts

    • POST /id/drafts - Create empty draft

    • POST /id/drafts - Create from ZIP

  • Imports

    • CatalogImportStatus Object

  • Meshes

    • GET /id/meshes

    • GET /id/meshes

Description

Path /v2/catalogs

Handles all request regarding catalog: creating, updating, deleting.

Catalog JSON Object

An example for a catalog JSON object.

{
  "catalog": {
    "translations": [
      {
        "id": "7fb1db43-b997-4703-be83-6e3e975b901a",
        "language": "en",
        "label": "label in language",
        "description": "description in language",
        "created": "2024-05-24T07:42:20.000Z",
        "updated": "2024-05-24T07:42:21.000Z"
      }
    ],
    "id": "<catalog_id>",
    "free": false,
    "public": false,
    "featured": false,
    "created": "2024-05-24T07:42:20.000Z",
    "updated": "2024-05-24T07:42:21.000Z",
    "active": true,
    "hidden": false,
    "visibilityStatus": 0,
    "publiclyOrderable": false,
    "mandatory": false,
    "draftOf": "<parent_catalog_id>",
    "draftStatus": {
      "draftCatalogId": "<draft_catalog_id>",
      "targetCatalogId": "<live_catalog_id>",
      "status": 10,
      "progress": 0,
      "locksLiveCatalog": true,
      "lockDraftCatalog": false,
      "mergePolicies": {}
    },
    "links": {
      "items": "/catalogs/<catalog_id>/items",
      "catalogSets": "/catalogs/<catalog_id>/catalogSets",
      "allItems": "/catalogs/<catalog_id>/allItems",
      "components": "/catalogs/<catalog_id>/components",
      "materials": "/catalogs/<catalog_id>/materials",
      "textures": "/catalogs/<catalog_id>/textures",
      "allTags": "/catalogs/<catalog_id>/allTags",
      "rootTags": "/catalogs/<catalog_id>/rootTags",
      "retailers": "/catalogs/<catalog_id>/retailers",
      "retailerInfos": "/catalogs/<catalog_id>/retailerInfos",
      "visibleToTenants": "/catalogs/<catalog_id>/visibleToTenants",
      "visibleToUsers": "/catalogs/<catalog_id>/visibleToUsers",
      "meshes": "/catalogs/<catalog_id>/meshes",
      "imports": "/catalogs/<catalog_id>/imports",
      "catalogElementAdditionalInfos": "/catalogs/<catalog_id>/catalogElementAdditionalInfos"
    },
    "language": "en",
    "name": "catalog name",
    "label": "catalog label",
    "orderable": false,
    "requestable": false,
    "retailPriceAllowed": false,
    "hiddenByUs