Skip to main content
POST
/
products
/
:id
Update a product.
curl --request POST \
  --url https://base_url/api/v1/products/:id \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "SunShield Pro UV-Blocking Sunglasses",
  "tax_code": "TPP",
  "description": "<string>"
}
'
{
  "message": "Successfully updated product."
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string

Display name of the product.

Minimum string length: 3
Example:

"SunShield Pro UV-Blocking Sunglasses"

​
tax_code
string
default:TPP

Code passed by the caller to determine taxability for this product. Default value, TPP, will be taxable in every jurisdiction. Additional values are available here.

Example:

"TPP"

​
description
string

Brief description of the product.

Minimum string length: 3

Response

Create product response.

​
message
string
Example:

"Successfully updated product."