Reserve Matching Orders by Tag
POST/api/shopify/:integrationInstance/reserve-by-tag/apply
Starts a background job that reserves every existing open order on this instance that carries a hold tag and has not been sent to a shipping provider. Orders already sent are skipped. Each reserved order keeps its inventory allocation.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token and the integrations.update permission.
Request body:
- tags (array of strings, optional, max 50): tags to match; omit to use the saved setting
Returns the tracked job id; poll the tracked jobs endpoints for progress.
Errors:
- 422 when the saved setting is off or has no tags (and no tags were sent)
- 409 when a reserve job is already running for this instance
Request
Responses
- 200
- 401
- 403
- 404
- 409
- 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.
Conflict
Response Headers
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.