Skip to main content

Update Product in Catalog

Updated

The Update Product in Catalog command allows you to update the details of an existing product in a catalog.   

PUT/product

https://[siteurl]/rest/product/[catalogId]/[productId]

Request Body Parameters

The Update Product in Catalog command requires the URI call with the Catalog ID and Product ID.  The command supports the following optional fields in the Posted JSON:

  • Status : "active": [0,N,n,1,Y,y]
  • Availability : "availability": ["string"]
  • VSKU : "vsku": ["string"]
  • PSKU : "psku": ["string"]
  • Product Type : "productType": ["string > string"]
  • Title : "title": ["string"]
  • Link : "link": ["URL"]
  • Image Link : "imageLink": ["URL"]
  • Price : "price": [float]
  • Currency : "currency": ["string"]
  • Variant Title : "variantTitle": "[string]"
  • Brand: "brand": "[string]"
  • Manufacturer: "manufacturer": "[string]"
  • Quantity: "quantity": [integer]
  • Color: "color": "[string]"
  • Size: "size": "[string]"
  • Gender: "gender": "[string]"

Request Body Example

Using Update Product in Catalog with all arguments, line breaks in JSON for readability:

curl --request PUT \ 
--url 'https://mail.mydomain.com/rest/product/68/2020ABCxyz' \ 
--header 'authorization: Basic bXlBY2NvdW50Onh5enB3ZDEyMw==' \ 
--header 'content-type: application/json' \ 
--header 'accept: application/vnd.whatcounts-v1+json' \ 
'{
  "active": 1,
  "availability": "In Stock",
  "psku": "ABC",
  "vsku": "xyz",
  "productType": "New Paper > Copy Paper",
  "title": "Copy Paper ABC",
  "variantTitle": "Copy Paper xyz",
  "link": "http://www.mydomain.com/ABCxyz",
  "imageLink": "http://www.mydomain.com/ABCxyz.png",
  "price": 8.88,
  "currency": "USD",
  "brand": "2020",
  "manufacturer": "My Brand",
  "quantity": 50,
  "color": "white",
  "size": "8.5x11",
  "gender": "none"
}' \ 
--include

Response Body

The response returns JSON or an HTTP status code.  Based on the example above, the response returns:

HTTP/1.1 200 OK
Server: serverName
Content-Type: application/json
Content-Length: 456
Date: Fri, 16 Mar 2020 12:54:44 GMT
{
  "productId": "2020ABCxyz",
  "catalogId": 68,
  "active": 0,
  "availability": "In stock",
  "psku": "ABC",
  "vsku": "xyz",
  "productType": "New Paper > Copy Paper",
  "title": "Copy Paper ABC",
  "variantTitle": "Copy Paper xyz",
  "link": "http://www.mydomain.com/ABCxyz",
  "imageLink": "http://www.mydomain.com/ABCxyz.png",
  "price": 8.88,
  "currency": "USD",
  "brand": "2020",
  "manufacturer": "My Brand",
  "quantity": 50,
  "color": "white",
  "size": "8.5x11",
  "gender": "none"
}

Error Response

Error Response Codes include both Client Errors (4xx) and Server Errors (5xx).  Descriptions of each can be found in Response Codes.  An error will occur if Product ID or Catalog ID are blank, or a Product with the same ID already exists.

For example, if a the Product ID is invalid the error would appear as:

{
"error": "The Product's ID cannot be empty.",
"status": "Internal Server Error",
"statusCode": 500
}

Feature added in v15.14.00