This endpoint is used when the customer cancels an open order in Linnworks.net.

Request

Post

`OrderCancelRequest`

Field Name	Type	Description
AuthorizationToken	`String`	Authorization Token from the customers integration.
Cancellation	`OrderCancellation`	Information about the order/items to cancel. See OrderCancellation

`OrderCancellation`

Field Name	Type	Description
Items	`OrderCancellationItem`	A collection of order items to cancel on the marketplace. See OrderCancellationItem
ReferenceNumber	`String`	The order reference number within Linnworks.
ExternalReference	`String`	The external reference number within Linnworks. This is usually the marketplace reference.

`OrderCancellationItem`

Field Name	Type	Description
SKU	`String`	The unique Linnworks SKU of the item.
OrderLineNumber	`String`	The order item number for this item. This is usually the marketplace ID for the order item.
CancellationQuantity	`Integer`	The quantity of this item to submit for cancellation.
Reason	`String`	If the marketplace supports tag-based refund reasons, this field will contain the selected tag. Otherwise, it will include the freetext reason submitted by the customer.
SecondaryReason	`String`	If the marketplace supports tag-based refund reasons, this field will contain the selected sub-tag.

Sample

{
  "AuthorizationToken": "0dfdbaf3e4d5434f825e774e31bcc148",
  "Cancellation": {
    "ReferenceNumber": "XYZ-1",
    "ExternalReference": "EXT-XYZ-1",
    "Items": [
      {
        "OrderLineNumber": "010045",
        "SKU": "ITEM-001",
        "CancellationQuantity": 1,
        "Reason": "Mistake",
        "SecondaryReason": ""
      }
    ]
  }
}

Response

`OrderCancelResponse`

Field Name	Type	Description
Error	`String`	Defines if there was an error with the request and returns it.

Sample

{
  "Error": ""
}

{
  "Error": "Could not process cancellation."
}