Sign in
Products V5

Update active status

Returns a process-id to query results. The limit for the number of product active statuses in one request is 500.

post/v5/products/active-status

Headers

X-Request-Timestampstring yyyy-MM-dd'T'HH:mm:ss.SSSXXX

Holds the optional client side update request timestamp, in ISO DateTime format

Request body

Example request

{
  "status": [
    {
      "sku": "82388894-5883-488",
      "active": true,
      "lastModified": "2019-06-18T06:12:36Z"
    }
  ]
}

Response

The request for a modification of the active status of the specified product variation was accepted and will be executed

state'pending' | 'done'

the current state of the process

messagestring

a human-readable message describing the current state of the process

totalinteger

the total work to complete for this process

progressinteger

the fraction of work that is already completed, as compared to the total work

succeededinteger

the number of successfully processed variations

failedinteger

the number of failed processed variations

unchangedinteger

the number of unchanged and not processed variations

pingAfterstring date-time

recommendation when to poll this resource again to receive a meaningful update - ISO8601 date

Example response

{
  "total": 7,
  "progress": 7,
  "succeeded": 4,
  "failed": 2,
  "unchanged": 1,
  "pingAfter": "2020-05-13T10:40:01.815Z",
  "links": [
    {
      "rel": "self",
      "href": "/v5/products/update-tasks/11111111-0003-4444-9999-bbbbbbbbbbbbb"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.