CancelItems cancels items in an order.

POST

/v2/storefront/orders/cancel

curl --request POST \
  --url https://api.zentail.com/v2/storefront/orders/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "channelOrderId": "example", "cancelQuantities": { "additionalProperty": "example" } }'

Authorizations

• zentail_oauth

Request Body^required

CancelItemsRequest is the request to cancel items in an order.

Media typeapplication/json

CancelItemsRequest is the request to cancel items in an order.

object

channelOrderId

The order ID used by your channel when creating the order

string

cancelQuantities

A map of line item IDs to quantities to cancel

object

key

additional properties

string format: int64

Example^generated

{
  "channelOrderId": "example",
  "cancelQuantities": {
    "additionalProperty": "example"
  }
}

Responses

200

A successful response.

Media typeapplication/json

CancelItemsResponse is the response to a CancelItems request.

object

Example^generated

{}

default

An unexpected error response.

Media typeapplication/json

object

code

integer format: int32

message

string

details

Array<object>

object

@type

string

key

additional properties

Example^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}