Follow

Update Product Status

The Update Product Status command allows you to activate or deactivate an existing product in a catalog.   

PUT/sms/product

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

Request Body Parameters

The Update Product Status command requires the URI call with the Catalog ID and Product ID and Status.  Status options include: 

  • Status : "active": [0,N,n,1,Y,y]

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/1' \
--header 'authorization: Basic bXlBY2NvdW50Onh5enB3ZDEyMw==' \
--header 'content-type: application/json' \
--header 'accept: application/vnd.whatcounts-v1+json' \ --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": 1,
}

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

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk