Sign in

v55

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-012046146.0 KB
Products

Update products

Update products with specified sku and source values to replace existing field data with the data supplied in the request. When the update is processed, the merge strategy is used to apply changes to scalar and object type fields.

For array type fields, a new value can be appended to the existing list. For an object list, you can update a specific object by matching on a key field. The following fields are supported:

  • attributes - match on code
  • images - match on url
  • routes - match on path
  • links - match on type and sku
  • bundles match on type and group
  • configurations match on type and attributeCode
  • externalIds match on type and origin

Note: Before submitting an update request, verify that the target entity exists using the products GraphQL query. Update operations do not verify that the entity exists. Requests targeting a nonexistent entity are accepted, but the update has no effect.

patch/v1/catalog/products

Headers

Authorizationstring required

Authorization Bearer token

Content-Type'application/json' required
Content-Encoding'gzip'

Use this header if the payload is compressed with gzip.

Request body

skustring required

SKU (Stock Keeping Unit) is a unique identifier for a product.

namestring

Product name

slugstring

The URL key for the product.

descriptionstring nullable

The main description for the product

shortDescriptionstring nullable

A short description of the product

status'ENABLED' | 'DISABLED'

Indicates whether the product is visible on the storefront. The value is "Enabled" if it is visible, and "Disabled" if it is not visible.

visibleInstring[]

Storefront area where the product is visible. An empty list means that it is not visible as a stand alone product.

  • CATALOG: Product is visible on Product Listing Page and Product Detail Page.
  • SEARCH: Product is visible on Search Results Page and Product Detail Page.

Example request

[
  {
    "sku": "MH01",
    "source": {
      "locale": "English"
    },
    "name": "Kangaroo Hoodie",
    "slug": "kangaroo-hoodie.html",
    "description": "A kangaroo hoodie for all seasons",
    "shortDescription": "A hoodie for all seasons with a kangaroo pocket",
    "status": "ENABLED",
    "visibleIn": [
      "CATALOG"
    ]
  }
]

Response

All items accepted and will be processed asynchronously