Preview Reserve Orders by Tag
GET/api/shopify/:integrationInstance/reserve-by-tag/preview
Returns counts for the Reserve Orders by Tag setting on this Shopify integration instance.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
When Reserve Orders by Tag is on, Shopify orders carrying any configured tag (exact, case-insensitive match on the whole tag) are imported with status reserved instead of open: inventory is allocated, but the order is not sent to the shipping provider until the tag is removed in Shopify or the order is unreserved.
Query parameters:
- tags[]: tags to evaluate instead of the saved setting (optional, max 50)
Response fields:
- matching_open_unsubmitted: open orders carrying a hold tag that have not been sent to a shipping provider (what Reserve Matching Orders by Tag would reserve)
- matching_open_in_flight: open orders carrying a hold tag that were already sent (left alone)
- currently_held: orders currently reserved by a tag hold
- held_by_unconfigured_tags: held orders none of whose matched tags is in the evaluated tag list
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
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.