Skip to navigation
REST RPC APIOrders

Rescuable Check

View as Markdown

Checks whether an order can be rescued, without changing it. It runs the same checks as Rescue, and on success returns the order as it would look after a rescue. You don’t need to call it first, because Rescue runs the same checks.

Authentication

x-api-keystring

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

Path parameters

order_idstringRequired
Unique Order ID

Request

This endpoint expects an object.
placedatetimeOptional

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

The order as it would look after a rescue. Nothing is saved.
merchantstringOptional
Public ID of the merchant
customerstringOptional
The customer's ID
paymentstringOptional
Public ID of the payment record the order uses
shipping_addressstringOptional
Public ID of the shipping address record the order uses
public_idstringOptional
Public ID of the order
sub_totalstringOptional
Subtotal of the order's items
tax_totalstringOptional
Tax applied to the order
shipping_totalstringOptional
Shipping cost applied to the order
discount_totalstringOptional
Discount applied to the order
totalstringOptional
Total price of the order
createdstringOptional
When the order was created
placestringOptional
When Ordergroove will place the order
cancelledstringOptional

When the order was cancelled, or null if it hasn’t been

triesintegerOptionalDefaults to 0
Number of placement attempts
generic_error_countintegerOptionalDefaults to 0

Number of times placement failed with the generic error code 999

statusintegerOptionalDefaults to 0

Order status code. See Order Status Codes.

typeintegerOptionalDefaults to 0

Order type: 1 subscription, 2 club, 3 premier, or 4 one-time

order_merchant_idstringOptional
The order's ID in your system, once it's placed
rejected_messagestringOptional

Why the order failed placement. While the order awaits retry instructions, this is a JSON string with the Ordergroove error code, a message, and a category.

extra_datastringOptional

A JSON string of extra key-value data

lockedbooleanOptionalDefaults to true
oos_free_shippingbooleanOptionalDefaults to true

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error