API: Cancel Order

POST /api/marketplace/v2/orders/{kogan_order_ref}/cancel/

Specification

Marks the specified items of the specified unshipped order as cancelled.

URL Parameters

Parameter

Required

Description

kogan_order_ref

Yes

The Id of the order to cancel

Request Format

See below a list of the fields and description for the order’s cancellation

Parameter

Required

Description

ID

Yes

Order Id

Quantity

Yes

The number of units to cancel.
The quantity needs to match the order’s line quantity as we do not accept partial cancellation.

Reason

Yes

The reason the item is being cancelled.
See the values allowed below

SellerSku

Yes

The SKU of the ordered line item.

Reasons

This is a list with all the cancellation reason allowed (refer to the field Reason)

  • GeneralAdjustment
  • ItemNotAvailable
  • CustomerReturnedItem
  • CouldNotShip
  • AlternateItemProvided
  • BuyerCanceled
  • CustomerExchange
  • MerchandiseNotReceived
  • ShippingAddressUndeliverable
  • Other

Request Body Example

{
  "OrderID": "123456",
  "Items": [
    {
      "ID": "0",
      "SellerSku": "XX-Valyrian-steel-SWORD-1",
      "Quantity": 1,
      "Reason":"ItemNotAvailable"
    },
    {
      "ID": "1",
      "SellerSku": "XX-DRAGON-STONE",
      "Quantity": 4,
      "Reason": "ShippingAddressUndeliverable"
    }
  ]
}

Did this page help you?