REST RPC APIOrders

Retrieve

View as Markdown

Returns a single order by its unique identifier.

This endpoint is accessible with a recognized trust group by setting it as <trust_level: “recognized”> in the authentication string.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

order_idstringRequired
Unique order ID

Query parameters

include_has_planbooleanOptionalDefaults to false

If true, the response includes a has_plan field on the order object indicating whether the order contains at least one product with product_type=plan

Response

200
merchantstring
customerstring
paymentstring
shipping_addressstring
public_idstring
sub_totalstring
tax_totalstring
shipping_totalstring
discount_totalstring
totalstring
createdstring
placestring
cancelledstring
triesintegerDefaults to 0
generic_error_countintegerDefaults to 0
statusintegerDefaults to 0
typeintegerDefaults to 0
order_merchant_idstring
rejected_messagestring
extra_datastring
lockedbooleanDefaults to true
oos_free_shippingbooleanDefaults to true

Errors

403
Forbidden Error
404
Not Found Error