Sign in

v1

latestOpenAPI 3.0.02026-07-261733191.1 MB
Products

Update a Product

Update a Product

put/products/{id}

Path parameters

idstring required

Unique Product ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

namestring required

Name of the Product, this appears within Sequence's dashboard.

labelstring

The internal description of the product. This can be used to maintain some explanation or comments regarding the product.

taxCategoryIdstring

The internal ID of the tax category associated with this product.

Example request

{
  "name": "Fixed priced product",
  "label": "Fixed priced product - UK",
  "taxCategoryId": "3271ca41-d538-404f-a15f-25856a37fb88"
}

Response

OK

idstring required

Product ID

namestring required

Name of the Product, this appears within Sequence's dashboard.

labelstring

The internal description of the product. This can be used to maintain some explanation or comments regarding the product.

taxCategoryIdstring

The internal ID of the tax category associated with this product.

createdAtstring required

Time at which the Product was first created, in ISO 8601 format (UTC). This is set by the server and cannot be changed. Expect millisecond precision.

updatedAtstring required

Time at which the Product was last updated, in ISO 8601 format (UTC). Expect millisecond precision.

Example response

{
  "id": "994d23f7-47b6-43ee-af6b-cd27181196b6",
  "name": "Fixed priced product",
  "label": "Fixed priced product - UK",
  "taxCategoryId": "3271ca41-d538-404f-a15f-25856a37fb88",
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z"
}