PATCH
/
products
/
{id}
Update Product
curl --request PATCH \
  --url https://api.wizcommerce.com/v1/products/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "group_code": "PRD1",
  "reference_id": "PRD1",
  "name": "8'\''X10'\''",
  "categories": [
    "<string>"
  ],
  "collections": [
    "<string>"
  ],
  "medias": [
    {
      "url": "https://example.com/image1.jpg",
      "order": 1,
      "is_default": true,
      "type": "image"
    }
  ],
  "attributes": [
    {
      "name": "1234567890",
      "value": "red"
    }
  ],
  "product_prices": [
    {
      "price_list_id": "PRC123",
      "price": 100,
      "min_order_quantity": 1,
      "max_order_quantity": 100,
      "step_increment": 1
    }
  ],
  "status": "inactive"
}'
{
  "data": {
    "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
    "reference_id": "SKU123",
    "sku": "SKU123",
    "name": "Product Name",
    "group_code": "PRD1",
    "medias": [
      {
        "is_default": true,
        "type": "image",
        "url": "https://example.com/image1.jpg"
      }
    ],
    "is_primary": true,
    "status": "active",
    "attributes": [
      {
        "id": "1234567890",
        "name": "color",
        "value": "red"
      }
    ],
    "created_at": "<string>",
    "updated_at": "<string>",
    "price_lists": [
      {
        "created_at": "<string>",
        "id": "<string>",
        "max_order_quantity": 123,
        "min_order_quantity": 123,
        "price": 123,
        "step_increment": 123,
        "updated_at": "<string>"
      }
    ]
  }
}
The PATCH request is used to partially update an existing entity by the given id. This means:
  • Only the fields provided in the request body will be updated.
  • Fields not provided in the request body will remain unchanged.
  • The request is idempotent, meaning multiple identical PATCH requests will always result in the same final state.

Authorizations

X-API-Key
string
header
required

API Key for authentication

Path Parameters

id
string
required

Product ID

Body

application/json

Product Update Request

The body is of type object.

Response

201
application/json

Created

The response is of type object.