REST RPC APIOrders

Cancel

View as Markdown
Cancels an order. If the order is associated with a subscription, the subsequent order will be created based on its set frequency.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

order_idstringRequired
Unique order ID

Response

200
merchantstringOptional
customerstringOptional
paymentstringOptional
shipping_addressstringOptional
public_idstringOptional
sub_totalstringOptional
tax_totalstringOptional
shipping_totalstringOptional
discount_totalstringOptional
totalstringOptional
createdstringOptional
placestringOptional
cancelledstringOptional
triesintegerOptionalDefaults to 0
generic_error_countintegerOptionalDefaults to 0
statusintegerOptionalDefaults to 0
typeintegerOptionalDefaults to 0
order_merchant_idstringOptional
rejected_messagestringOptional
extra_datastringOptional
lockedbooleanOptionalDefaults to true
oos_free_shippingbooleanOptionalDefaults to true

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error