Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

PostSale /CreateCancellation

Allows 150 calls per minute

Response: ValidatedCancellation



This method is used to further validate and create a cancellation in Linnworks, as well as submit it to the channel where this is requested

Parameters

NameTypeDescription
requestCancellationRequestThe requested cancellation settings, including whether or not to submit the cancellation to the channel

Permissions

GlobalPermissions.OrderBook.OpenOrders.CancellationsNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/PostSale/CreateCancellation

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

request={
  "IsChannelCancellation": true,
  "IsChannelInitiated": true,
  "IsChannelCancellationConfirmed": true,
  "IsFreeText": true,
  "FreeTextOrNote": "sample string 5",
  "ReasonTag": "sample string 6",
  "SubReasonTag": "sample string 7",
  "CreateFullRefund": true,
  "RefundAlreadyProcessed": true,
  "RefundStatusTag": "sample string 10",
  "RefundReference": "sample string 11",
  "HeaderId": 12,
  "OrderId": "48cac6f6-db05-47cb-8b2b-676857ec9479",
  "IsRetry": true,
  "ActionForm": {
    "caption": "sample string 1",
    "controls": [
      {
        "id": "sample string 1",
        "caption": "sample string 2",
        "description": "sample string 3",
        "type": "sample string 4",
        "value": "sample string 5",
        "group": "sample string 6"
      }
    ]
  }
}

Response

This is an example of the response JSON. Results will vary depending on your data.

null