Products

Archive a product

Archive one of your products. Once archived, new prices cannot be created for the product.

post/products/{id}/archive

Request

  • Base URL
    https://sandbox.sequencehq.com/api
  • URL
    https://sandbox.sequencehq.com/api/products/{id}/archive
  • Auth
    none declared. Required headers: Authorization

Path parameters

idstring required

Product ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

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.

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.

archivedAtstring

Time at which the Product was archived, 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",
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z",
  "archivedAt": "2023-06-28T16:47:00Z"
}

Changes

No recorded changes to this operation across all 939 revisions of this API.