Update a Product
PUT
/api/v2/products/{id}.json
Update a product already within your product catalogue by its ID.
Scope
Requires the products OAuth scope.
Parameters
Your request must provide the following URL parameters:
id
required
The ID of your Product object |
Request body
Your request body must contain an object including:
data
required
Containing updates to your Product object. |
Example JSON request
To update a Product you must PUT JSON to this resource within a data object. You do
not need to supply all properties and may choose to only supply properties that require modifying.
{
"data": {
"sku": "EX-D1",
"title": "Unicorn Tears Gin Liqueur",
"alias": "/product/unicorn-tears-gin-liqueur",
"fullDescription": "...",
"description": "The sweet tears of unicorns, bottled - juicy passion-fruit and tropical mango flavoured"
}
}
Success responses
If the Product was updated successfully you should receive a response with a 200 status
code:
success
A boolean where a value of true means the Product was created successfully.
|
status
The HTTP status code e.g. 200 means the Product was updated successfully. |
data
Contains the Product object you updated. |
Error responses
If the Product could not be updated you will encounter a response with either a 400, 404 or
422status code:
success
A boolean where a value of false means the Product could not be updated.
|
status
|
context
|
errors
Contains an array of error objects, each will have the following properties:
|