Update Products in Catalogs

Updates existing products across your catalogs. This is the legacy version of the Products API, which allows you to access product data that hasn’t yet been rewritten to the newer API model with localizedContent. If possible, Kibo recommends calling the /products endpoint with an x-api-version header set to “1” instead of using this V1 endpoint (as it may be deprecated at some point). This is only necessary if you upgraded your implementation to use the new API version by default to support multi-locale catalogs.

PUT /commerce/catalog/admin/productsV1/{productCode}/ProductInCatalogs

Error

A valid request URL is required to generate request examples

200

[
  {
    "activeDateRange": {
      "endDate": "2023-11-07T05:31:56Z",
      "startDate": "2023-11-07T05:31:56Z"
    },
    "auditInfo": {
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "updateDate": "2023-11-07T05:31:56Z"
    },
    "catalogId": 123,
    "content": {
      "localeCode": "<string>",
      "productFullDescription": "<string>",
      "productImages": [
        {
          "altText": "<string>",
          "cmsId": "<string>",
          "id": 123,
          "imageLabel": "<string>",
          "imageUrl": "<string>",
          "localeCode": "<string>",
          "mediaType": "<string>",
          "productImageGroupId": "<string>",
          "sequence": 123,
          "videoUrl": "<string>"
        }
      ],
      "productName": "<string>",
      "productShortDescription": "<string>"
    },
    "dateFirstAvailableInCatalog": "2023-11-07T05:31:56Z",
    "isActive": true,
    "isContentOverridden": true,
    "isPriceOverridden": true,
    "isSEOContentOverridden": true,
    "price": {
      "creditValue": 123,
      "isoCurrencyCode": "<string>",
      "map": 123,
      "mapEndDate": "2023-11-07T05:31:56Z",
      "mapStartDate": "2023-11-07T05:31:56Z",
      "msrp": 123,
      "price": 123,
      "salePrice": 123
    },
    "primaryProductCategory": {
      "categoryId": 123
    },
    "productCategories": [
      {
        "categoryId": 123
      }
    ],
    "seoContent": {
      "localeCode": "<string>",
      "metaTagDescription": "<string>",
      "metaTagKeywords": "<string>",
      "metaTagTitle": "<string>",
      "seoFriendlyUrl": "<string>",
      "titleTagTitle": "<string>"
    }
  }
]

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

productCode · string · required

Query Parameters

responseFields · string

limits which fields are returned in the response body

Body

application/json

activeDateRange · object

Active Effectivity Dates

Show child attributes

auditInfo · object

Show child attributes

catalogId · integer<int32>

The CatalogId of the catalog that the product is associated with (The catalog must a valid catalog within the MasterCatalog that the product belongs to)

content · object

Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.

Show child attributes

dateFirstAvailableInCatalog · string<date-time> | null

Date this product was first Available for sale in the catalog. This is utilized in expressions that reference DaysInCatloag.

isActive · boolean | null

If true, the product is marked as available for sale in the catalog. Setting a product to IsActive = false will prevent it from being shown on the customer facing storefront.

isContentOverridden · boolean | null

If true, the content for this product is overridden in the catalog. If false, the MasterCatalog level content will be used for the product.

isPriceOverridden · boolean | null

If true, the price for this product is overridden in the catalog. If false, the MasterCatalog level price will be used for the product.

isSEOContentOverridden · boolean | null

If true, the SEO content for this product is overridden in the catalog. If false, the MasterCatalog level SEO content will be used for the product.

price · object

Price of the product and currency used.

Show child attributes

primaryProductCategory · object

Categories to which the product belongs.

Show child attributes

productCategories · object[] | null

Categories to which the product belongs for this catalog.

Show child attributes

seoContent · object

Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.

Show child attributes

Response

200

application/json

Success

activeDateRange · object

Active Effectivity Dates

Show child attributes

auditInfo · object

Show child attributes

catalogId · integer<int32>

The CatalogId of the catalog that the product is associated with (The catalog must a valid catalog within the MasterCatalog that the product belongs to)

content · object

Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.

Show child attributes

dateFirstAvailableInCatalog · string<date-time> | null

Date this product was first Available for sale in the catalog. This is utilized in expressions that reference DaysInCatloag.

isActive · boolean | null

If true, the product is marked as available for sale in the catalog. Setting a product to IsActive = false will prevent it from being shown on the customer facing storefront.

isContentOverridden · boolean | null

If true, the content for this product is overridden in the catalog. If false, the MasterCatalog level content will be used for the product.

isPriceOverridden · boolean | null

If true, the price for this product is overridden in the catalog. If false, the MasterCatalog level price will be used for the product.

isSEOContentOverridden · boolean | null

If true, the SEO content for this product is overridden in the catalog. If false, the MasterCatalog level SEO content will be used for the product.

price · object

Price of the product and currency used.

Show child attributes

primaryProductCategory · object

Categories to which the product belongs.

Show child attributes

productCategories · object[] | null

Categories to which the product belongs for this catalog.

Show child attributes

seoContent · object

Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.

Show child attributes