List Product Substitutions
GET/api/product-substitutions
Paginated list of all substitution rules.
Authentication: Requires Bearer token.
Filters use the operator syntax filter[column.operator]=value with operators: is, is_not, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty, is_one_of. Filterable columns: product_sku, product_name, substitute_sku, substitute_name, mode, active, priority (numeric operators), created_at, updated_at (date operators).
Allowed sorts: id, mode, priority, active, created_at, updated_at (prefix with - for descending).
Pagination: page, per_page (default 10).
The filter[search] parameter also matches the exact rule ID, alongside product/substitute SKU and name.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.