Update or cancel order

Update information about an order, ship it, or cancel it.

⚠️Note:
It is not possible to change the order ID or description after the order has been created.
Use this request to change the status of BNPL orders to Shipped.

How to test

  1. Under Authentication > Query, enter an API key from your TEST account.
  2. Under Path params, enter the order ID of the order you want to update.
  3. Under Body params, select the type of update.
  4. Fill in the required parameters, and then click Try it!

❗️ Never use a live API key!

💬  For support, email [email protected]


Path Params
string
required

The unique identifier of the order.

Max length: 50 characters.

Body Params

Cancel an order

string
required

The order status.

To cancel the order and its underlying session, set to cancelled.

boolean

Sets the outcome of the cancellation.

To cancel the order, set to true.

Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json