Get Release Schedule
GET/api/v2/reporting/release-schedule
Forward-looking release schedule for held sales orders. Returns held orders (those with a future hold_until_date — a "do not ship before" release date, used for preorders and scheduled holds) grouped by the application-timezone date on which they become shippable.
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Orders are excluded if they have no hold, the hold has already passed, are cancelled (canceled_at set), or are closed. Buckets are ordered by hold_until_date ascending.
This differs from Ship By Schedule: ship_by_date is a deadline ("ship no later than"), whereas hold_until_date is a floor ("do not ship before").
Authentication: Requires Bearer token. Scope: reports (read/write).
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.