Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

PostSale /GetCancellationOptions

Allows 150 calls per minute

Response: CancellationOptions



This method is used to validate whether a channel cancellation can be submitted for a given order

Parameters

NameTypeDescription
orderIdGuidThe relevant order ID

Permissions

GlobalPermissions.OrderBook.OpenOrders.CancellationsNode

Example Request

The following request format is required for this method.

Endpoint URL

GET https://eu-ext.linnworks.net/api/PostSale/GetCancellationOptions

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.

orderId=338d4ad3-e6f5-4df5-afd5-ceda225c1e72

Response

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

{
  "CanCancelInternally": true,
  "AutomaticRefundOnCancel": false,
  "CanCancel": false,
  "CanCancelOrderLines": false,
  "CanCancelPartially": false,
  "CanCancelFreeText": false,
  "CancelFreeTextOrNoteMaxLength": 255,
  "CancellationReasons": [],
  "Order": null,
  "AllowRefundOnCancel": true,
  "Errors": [
    "The ConnectionString property has not been initialized."
  ],
  "OrderIsLockedOnUnhandledError": false
}