Back

Search

Search

Methods

Inventory

Orders

PostSale /CreateCancellation

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

HTTP Endpoint

Server /PostSale / CreateCancellation

Permissions

GlobalPermissions.OrderBook.OpenOrders.CancellationsNode

Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/PostSale/CreateCancellation HTTP/1.1
Host: eu-ext.linnworks.net
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.linnworks.net
Accept-Language: en
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Referer: https://www.linnworks.net/
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

request={
  "IsChannelCancellation": true,
  "IsChannelCancellationConfirmed": true,
  "IsFreeText": true,
  "FreeTextOrNote": "sample string 4",
  "ReasonTag": "sample string 5",
  "SubReasonTag": "sample string 6",
  "CreateFullRefund": true,
  "HeaderId": 8,
  "OrderId": "c7fe04f6-3704-4ed9-9cab-15c9c4685fe9",
  "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"
      },
      {
        "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 response. Results may vary depending on your data.

null