Commerce · Products

Update a product

Updates a product. Fields you leave out keep their current values. Works with Shopify accounts.

PATCHhttps://api.pozy.ai/v1/accounts/{accountId}/products/{productId}

DeprecatedShopifyupdateProduct

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the commerce resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`accountId`required	string
`productId`required	string	Matches `^\d+$`

Request body

application/json, required

titlestring
descriptionHtmlstring
handlestring
vendorstring
productTypestring
tagsarray of string
statusstring
One of active, draft, archived.
seoobject
- titlestring
- descriptionstring
variantsarray of object
At least 1 item. Up to 100 items.
- idstringrequired
  Matches ^\d+$.
- pricenumber or string
- compareAtPricenumber or string

Example

curl -X PATCH "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/products/659773d34b353e6821202f21" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Launch day",
  "descriptionHtml": "string",
  "handle": "acme",
  "vendor": "string"
}'

const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/products/659773d34b353e6821202f21", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    title: "Launch day",
    descriptionHtml: "string",
    handle: "acme",
    vendor: "string"
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.patch(
    "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/products/659773d34b353e6821202f21",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "title": "Launch day",
        "descriptionHtml": "string",
        "handle": "acme",
        "vendor": "string",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

platformstring
One of shopify.
productobject
19 child fields
- idstring
- platformstring
  One of shopify.
- titlestring
- handlestring
- descriptionHtmlstring
  Can be null.
- vendorstring
  Can be null.
- productTypestring
  Can be null.
- tagsarray of string
- statusstring
  One of active, draft, archived.
- featuredImageobject
  One of:
  Product Image (2 fields)
  urlstring
  altTextstring
  Can be null.
- imagesarray of object
  2 child fields
  urlstring
  altTextstring
  Can be null.
- optionsarray of object
  2 child fields
  namestring
  valuesarray of string
- variantsarray of object
  9 child fields
  idstring
  titlestring
  skustring
  Can be null.
  barcodestring
  Can be null.
  pricestring
  compareAtPricestring
  Can be null.
  inventoryQuantityinteger
  Can be null.
  availableForSaleboolean
  selectedOptionsarray of object
  2 child fields
  namestring
  valuestring
- seoobject
  2 child fields
  titlestring
  Can be null.
  descriptionstring
  Can be null.
- totalInventoryinteger
  Can be null.
- onlineStoreUrlstring
  Can be null.
- createdAtstring (date-time)
  Can be null.
- updatedAtstring (date-time)
  Can be null.
- publishedAtstring (date-time)
  Can be null.

200 response

{
  "platform": "shopify",
  "product": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "shopify",
    "title": "Launch day",
    "handle": "acme",
    "descriptionHtml": "string",
    "vendor": "string",
    "productType": "string",
    "tags": [
      "string"
    ],
    "status": "active",
    "featuredImage": {
      "url": "https://pozy.ai/media/example-1.jpg",
      "altText": "Hello from Pozy"
    },
    "images": [
      {
        "url": "https://pozy.ai/media/example-1.jpg",
        "altText": "Hello from Pozy"
      }
    ],
    "options": [
      {
        "name": "Acme",
        "values": [
          "string"
        ]
      }
    ],
    "variants": [
      {
        "id": "6bfebd43ddc270f6d2c56fc5",
        "title": "Launch day",
        "sku": "string",
        "barcode": "string",
        "price": "string",
        "compareAtPrice": "string",
        "inventoryQuantity": 1,
        "availableForSale": true,
        "selectedOptions": [
          {
            "name": "Acme",
            "value": "string"
          }
        ]
      }
    ],
    "seo": {
      "title": "Launch day",
      "description": "A short description"
    },
    "totalInventory": 42,
    "onlineStoreUrl": "https://pozy.ai/media/example-1.jpg",
    "createdAt": "2026-10-02T09:00:00.000Z",
    "updatedAt": "2026-10-02T09:00:00.000Z",
    "publishedAt": "2026-10-02T09:00:00.000Z"
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is read-only, scoped to other profiles, or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Products

GETList products GETGet a product