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
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

400
Bad Request Error
403
Forbidden Error
404
Not Found Error