Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
PostSale

CreateCancellation

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 <b>Permissions Required: </b> GlobalPermissions.OrderBook.OpenOrders.CancellationsNode <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

post/api/PostSale/CreateCancellation

Request body

Example request

{
  "request": {
    "OrderId": "00000000-0000-0000-0000-000000000000"
  }
}

Response

OK

Status'OPEN' | 'PROCESSED' | 'ERROR' | 'ERROR_ACKED' | 'PENDING'
NeedsConfirmationboolean
RefundReferencestring
Errorsstring[]
AllowRefundOnCancelboolean
OrderIsLockedOnUnhandledErrorboolean

Example response

{
  "Order": {
    "OrderId": "00000000-0000-0000-0000-000000000000",
    "FulfilmentLocationId": "00000000-0000-0000-0000-000000000000"
  },
  "CancellationHeader": {
    "RefundLines": [
      {
        "RefundRowId": "00000000-0000-0000-0000-000000000000",
        "RefundedItem": {
          "OrderItemRowId": "00000000-0000-0000-0000-000000000000"
        },
        "Errors": [
          {
            "RefundRowId": "00000000-0000-0000-0000-000000000000"
          }
        ]
      }
    ],
    "OrderId": "00000000-0000-0000-0000-000000000000"
  }
}