Cancel Order (🚧 in development)

POST 
/order/cancel

This endpoint cancels an existing order. An order can only be canceled if it in in_progress status, the payments array within the response of the Retrieve Order Details doesn't contain payment item. Refer to the Order Actions and Conditions.

Request

application/json

Body

Order parameters

shopId integerrequired

Unique identifier for the shop where the order is being placed.

orderNumber stringrequired

Unique code identifying the specific order.

Responses

200

Order cancellation successful

application/json

Schema

Schema

data object

orderNumber stringrequired

Unique code identifying the specific order.

operationType stringrequired

Possible values: [cancel]

Operations type

Example (from schema)

{
  "data": {
    "orderNumber": "OREDER-324234",
    "operationType": "cancel"
  }
}

400

Error

application/json

Schema

Schema

code stringrequired

Error code

title stringrequired

Detailed error description

detail string

Additional information about the error

Example (from schema)

{
  "code": "401",
  "title": "Input data validation error",
  "detail": "Parameter AAAA is required"
}

Loading...