Sign in

v1

latestOpenAPI 3.0.22026-07-223907721.1 MB
Order

Request Order Cancellation

Request cancallation for a Order or OrderItem

post/v1/channel/order/cancellation

Request body

channelstring required

This is the unique Channel name.

orderCancellationRequestIdstring uuid required

A unique identifier for the order cancellation request. This ID should by used by Seller to identify the cancellation response from the Channel.

sellerIdstring required

A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process.

orderIdstring required
cancelReason'BUYER_CANCELLED' | 'UNDELIVERABLE_TO_SHIPPING_ADDRESS' | 'UNDELIVERABLE_BY_CARRIER' | 'OUT_OF_STOCK' | 'DELAYED_INVENTORY' | 'PRICING_ERROR' | 'OTHER'
  • BUYER_CANCELLED: the buyer cancelled the order.
  • UNDELIVERABLE_TO_SHIPPING_ADDRESS: Could not deliver to the address given by the buyer.
  • UNDELIVERABLE_BY_CARRIER: Carrier do not ship to the buyerss location.
  • OUT_OF_STOCK: The item is out of stock, for example because you are temporarily or permenantly sold out.
  • DELAYED_INVENTORY: The item is not in your inventory and there is a delay in delivery by the supplier.
  • PRICING_ERROR: The price on the connected marketplace was incorrect.
  • OTHER: Well, objvoiusly there is some reason missing in this list.
messagestring

Example request

{
  "channel": "MYBESTDEALCOMDE",
  "orderCancellationRequestId": "82992d3a-b153-4422-b539-f4d1f1b4aecb",
  "sellerId": "4711",
  "orderId": "43523-43432-43532",
  "orderItem": [
    {
      "orderItemId": "5437233",
      "quantity": "2.0"
    }
  ]
}

Response

Order Cancellation received.