Skip to content
Guides
ES
API reference
stablecatalog:read

List price history

Returns how a product's price changed over time, with the date of each change.

GET/v1/catalog/price-history

Returns how a product's price changed over time, with the date of each change.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

search?string

Free-text filter. Which fields it covers depends on the resource.

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"
productId?null|string
variantId?null|string
reason?string

Value in

  • "initial"
  • "manualUpdate"
  • "bulkEdit"
  • "promotionStart"
  • "promotionEnd"
  • "costAdjustment"
  • "import"
fromDate?string
Formatdate-time
toDate?string
Formatdate-time

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/catalog/price-history"
{  "data": [    {      "id": "string",      "productId": "string",      "productName": "string",      "variantName": "string",      "sku": "string",      "variantId": "string",      "previousPrice": null,      "previousCompareAtPrice": null,      "newPrice": 0.1,      "newCompareAtPrice": null,      "costPrice": null,      "reason": "string",      "userId": null,      "userEmail": null,      "userName": null,      "timestamp": "2019-08-24T14:15:22Z"    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}