Update a Product Specification

PUT /api/v2/products/{productId}/specifications/{id}.json

Update an existing Product Specification object by its ID.

Allows you to change the assigned specification value against a Product. This operates much the same as Adding a single Product Specification.

Scope

Requires the products OAuth scope.

Parameters

Your request must provide the following URL parameters:

id required
The ID of your Product Specification object.
productId required
The ID of your Product.


Request body

Your request body must contain an object including:

data required
Containing updates to your Product Specification object.
This operates much the same as Adding a single Product Specification.


Example JSON requests

For examples see Adding a single Product Specification.

Success responses

If the Product Specification was updated successfully you should receive a response with a 200 status code:

success
A boolean where a value of true means the object was saved successfully.
status
The HTTP status code e.g. 200 means the object was updated successfully.
data
Contains the Product Specification object including the complete spec and value objects.


Error responses

If the object 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 object could not be updated.
status
  • 400 may indicate that the ID was not provided.
  • 404 means the Specification or Specification Value could not be found by the IDs provided.
  • 422 means the object could not be updated due to errors in the data.
context
  • parameters means the error is with the required id URL parameter.
  • data indicates an error within the object data.
  • data.spec indicates an error within the spec object data.
  • data.value indicates an error within the value object data.
errors

Contains an array of error objects, each will have the following properties:

  • name - The property name that encountered an error.
  • message - A human readable error message.
  • ref - An error reference string.