Rescuable Check

View as Markdown
Use this endpoint to evaluate whether an order meets the conditions for being rescuable. Note that the Rescue API also performs this validation internally, so using this endpoint is not required. This endpoint allows merchants to validate an order's eligibility for rescue without initiating the rescue process. The endpoint performs a validation check without making any changes to the actual order and returns a JSON response of what the expected result will be.

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

OR
authorizationstring

Storefront API Scope — client-side, scoped to one customer, sent as a signature in the authorization header. See Authentication.

Path parameters

order_idstringRequired
Unique Order ID

Request

This endpoint expects an object.
placedateOptional

Optional parameter that specifies the new order place date time. By default it will use “now”. Use yyyy-mm-ddThh:mm:ss as the format for a date time in CST.

Response

200

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error