GuidesAPI EndpointsChangelog
Log In
API Endpoints

Update Order Status

This operation will update the status of an Order.

Internal StatusDisplayed to User
DRAFTDraft
PENDINGNew
IN_PROGRESSPreparing
READY_FOR_ATTAINMENTReady for Attainment
COMPLETEComplete
CANCELED_CUSTOMERCanceled
CANCELED_SELLERCanceled
FAILEDFailed

When status is CANCELED_CUSTOMER or CANCELED_SELLER, you may optionally include canceledReason.

Canceled Reasons
OUT_OF_STOCK
CUSTOMER_REQUEST
PAYMENT_FAILURE
FRAUD_DETECTED
POS_CLOSED
DELIVERY_ISSUE
ORDER_TOO_EXPENSIVE
ID_ISSUE
CUSTOMER_NO_SHOW
EXCEEDS_LIMIT
OTHER
Path Params
string
required

The primary identifier for a Listing.

string
required

The primary identifier for an Order.

Body Params
string
enum
string | null
enum

Optional cancellation reason. Should be provided only when status is
CANCELED_CUSTOMER or CANCELED_SELLER.

Responses

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