Orders

Cancel Order

Cancel an Order for a Customer

patch/v2/customers/{customer-id}/orders/{order-id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v2/customers/{customer-id}/orders/{order-id}
  • Auth: one of:
    • API key in header authorization
    • API key in header x-api-key

Path parameters

customer-idstring required

customer-id

order-idstring required

order-id

Request body

creationDatestring date-time
currencyCodestring required
customerIdstring
externalReferenceIdstring
orderIdstring
orderSource'MARKETPLACE' | 'NO_DISCOUNT' | 'SUBSCRIPTION_SERVICE'
orderType'NEW' | 'PREVIEW' | 'PREVIEW_RENEWAL' | 'RENEWAL' | 'RETURN' | 'TRANSFER'
reasonstring
referenceOrderIdstring
statusstring

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.