Update product

PUT/api/products/{id}

Updates mutable fields on an existing product.

Path Parameters

id*string

Resource identifier.

Example"prod_123"

Request Body

application/json

Request payload for Update product.

TypeScript Definitions

Use the request body type in TypeScript.

handle?|

Updated stable product handle used in URLs.

sku?|

Updated product SKU.

title?|

Updated product title shown to users.

description?||

Updated long-form product description.

vendor?|

Updated vendor or manufacturer name.

category?|

Updated category name for the product.

categoryId?||

Updated category identifier for the product.

categoryIds?array<string>|

Updated structured category assignments for the product.

primaryCategoryId?||

Updated primary category mirrored to legacy product fields.

images?array<string>|

Updated absolute image URLs for the product.

baseUnit?|

base unit.

alternativeUnits?array<any>|

Updated alternative unit configurations for the product.

referenceUnits?array<any>|

Updated reference unit configurations for the product.

basePrice?||

Updated base selling price for the product.

baseCost?||

Updated base cost for the product.

customFields?|

Updated custom field values for the product.

Response Body

`application/json`

curl -X PUT "https://example.com/api/products/prod_123" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "prod_123",  "workspaceId": "ws_123",  "handle": "string",  "sku": "string",  "productGroup": "string",  "title": "string",  "description": "string",  "vendor": "string",  "category": "string",  "categoryId": "string",  "lifecycleStatus": "string",  "archivedAt": "string",  "deletedAt": "string",  "searchText": "string",  "basePrice": {    "amount": 0,    "currencyCode": "USD"  },  "baseCost": {    "amount": 0,    "currencyCode": "USD"  },  "data": {},  "customFields": {},  "createdAt": "string",  "updatedAt": "string",  "baseUnit": null,  "alternativeUnits": [],  "referenceUnits": [],  "defaultUnitCode": "string",  "price": {    "amount": 0,    "currencyCode": "USD"  },  "mainImageSrc": "string",  "priceSource": null,  "pricingMetadata": null,  "isFavorite": true,  "calculatedFields": null}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`