Skip to content
Guides
API reference
stablecatalog:read

List product activity

Returns the audit trail of a product: what changed, when and who changed it.

GET/v1/catalog/products/{productId}/activity

Returns the audit trail of a product: what changed, when and who changed it.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Path Parameters

productId*string

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"
variantId?null|string
locationId?null|string
source?string

Value in

  • "product"
  • "price"
  • "inventory"

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/products/string/activity"
{  "data": [    {      "id": "string",      "source": "product",      "action": "string",      "timestamp": "2019-08-24T14:15:22Z",      "userId": null,      "userEmail": null,      "userName": null,      "entityName": null,      "productId": null,      "variantId": null,      "variantName": null,      "sku": null,      "locationId": null,      "locationName": null,      "reason": null,      "referenceId": null,      "changes": [        {          "field": "string",          "before": null,          "after": null        }      ]    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}