Delivery Date Preview
GET/api/shopify/:integrationInstance/orders/delivery-date-preview
Preview how delivery date configuration rules would apply to existing orders.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Authentication: Requires Bearer token.
Validation:
- deliver_by_date_fields: required, comma-separated field names
- ship_by_date_calculation_method: required, in: shipping_method, match_deliver_by_date, none
- search: nullable, max:255
- per_page: nullable, integer, min:1, max:100
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.