Cancel

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

🔐

Authentication

✔️ Application API Scope

✔️ Storefront API Scope

Response Body Definitions

NameTypeDescriptionExample
merchantstringMerchant ID"275dbe1d77f34aca968fb75a8dbb4c82"
customerstringCustomer ID"11100-C01"
paymentstringPayment record ID"25e4d2761d294dd48efd96fdf668a2d9"
shipping_addressstringShipping address record ID"03197d2512904301aaed774a256e71c8"
public_idstringOrder ID"f9cb2f93e1c845eb9de9eff46ddb3cbf"
sub_totalstringSubtotal of items in order"285.00"
tax_totalstringTax applied to order"22.44"
shipping_totalstringShipping cost applied to order"0.00"
discount_totalstringDiscount applied to order"15.00"
totalstringTotal price of order"undefined"
createdstringDate created"2017-02-29 00:00:00"
placestringDate for order placement"2017-02-29 00:00:00"
cancelledstringDate of cancellation;

'null' = not cancelled
"null"
triesintegerNumber of order attempts1
generic_error_countinteger0
statusintegerOrder status1
typestringOrder Type1
order_merchant_idstringOrder ID in your system"301617"
rejected_messagestringRejection message from merchant""
extra_datastringRaw JSON string that should be JSON.parse() as key/value store for any extra information"{"some": "extra", "fields": "here"}"
lockedbooleanfalse
oos_free_shippingbooleanfalse
Language