Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

Orders /ProcessOrderByOrderOrReferenceId

Allows 150 calls per minute

Response: ProcessOrderByOrderIdOrReferenceResponse


Parameters

NameTypeDescription
requestProcessOrderByOrderIdOrReferenceRequest

Permissions

GlobalPermissions.OrderBook.DespatchConsoleNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/Orders/ProcessOrderByOrderOrReferenceId

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={
  "OrderOrReferenceId": "sample string 1",
  "LocationId": "189aeaed-eb79-40a5-863f-376298c47f24",
  "ScansPerformed": true,
  "OrderProcessingNotesAcknowledged": true,
  "WorkflowJobId": 1
}

Response

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

{
  "ProcessedState": 0,
  "Message": "sample string 1",
  "Response": {
  },
  "OrderId": "93c5729a-0b7c-4fd2-91f0-f4b70df827f1",
  "OrderSummary": {
    "OrderId": "d51be19d-3709-4d34-9e56-37f5d01ce14e",
    "NumOrderId": 2,
    "ReceivedDate": "2021-07-29T09:24:51.7368563+01:00",
    "ProcessDate": "2021-07-29T09:24:51.7368563+01:00",
    "Source": "sample string 5",
    "CustomerName": "sample string 6",
    "NumProducts": 7
  },
  "Items": [
    {
      "ItemId": "91af88c9-6c66-4af3-a9d6-666009525ac5",
      "ItemNumber": "sample string 2",
      "SKU": "sample string 3",
      "ItemSource": "sample string 4",
      "Title": "sample string 5",
      "Quantity": 6,
      "CategoryName": "sample string 8",
      "CompositeAvailablity": 1,
      "StockLevelsSpecified": true,
      "OnOrder": 10,
      "OnPurchaseOrder": {
        "pkPurchaseItemId": "73ca0e57-22e7-454b-a3ff-18d5c5516d01",
        "Rowid": "c7137b3c-51d4-43ed-9bc3-4012581bcc48",
        "pkPurchaseId": "a7833486-5a35-435c-b962-4167d076118e",
        "ExternalInvoiceNumber": "sample string 4",
        "fkSupplierId": "7facbe97-5e74-4058-a85f-afe232182fea",
        "DateOfDelivery": "2021-07-29T09:24:51.7368563+01:00",
        "QuotedDeliveryDate": "2021-07-29T09:24:51.7368563+01:00",
        "SupplierName": "sample string 8",
        "fkLocationId": "b3f541af-6375-4f8e-a074-54bdb2b6b96f"
      },
      "InOrderBook": 1,
      "Level": 11,
      "MinimumLevel": 1,
      "AvailableStock": 12,
      "PricePerUnit": 13.1,
      "UnitCost": 14.1,
      "DespatchStockUnitCost": 15.1,
      "Discount": 16.1,
      "Tax": 21.1,
      "TaxRate": 17.1,
      "Cost": 18.1,
      "CostIncTax": 19.1,
      "CompositeSubItems": [
        {
        }
      ],
      "IsService": true,
      "SalesTax": 21.1,
      "TaxCostInclusive": true,
      "PartShipped": true,
      "Weight": 24.1,
      "BarcodeNumber": "sample string 25",
      "Market": 26,
      "ChannelSKU": "sample string 27",
      "ChannelTitle": "sample string 28",
      "DiscountValue": 10.806660973526899,
      "HasImage": true,
      "ImageId": "bb1350a5-2dd8-45dc-a14d-560a2f2db2d9",
      "AdditionalInfo": [
        {
          "pkOptionId": "6ac58b85-2e62-438f-9c2d-3cc7eb7d056b",
          "Property": "sample string 2",
          "Value": "sample string 3"
        }
      ],
      "StockLevelIndicator": 29,
      "ShippingCost": 30.1,
      "PartShippedQty": 31,
      "ItemName": "sample string 32",
      "BatchNumberScanRequired": true,
      "SerialNumberScanRequired": true,
      "BinRack": "sample string 35",
      "BinRacks": [
        {
          "Quantity": 1,
          "BinRack": "sample string 2",
          "Location": "eef44a24-28ed-4b8c-87b5-246972fdebe6",
          "BatchId": 1,
          "OrderItemBatchId": 1
        }
      ],
      "InventoryTrackingType": 36,
      "isBatchedStockItem": false,
      "IsWarehouseManaged": true,
      "IsUnlinked": false,
      "StockItemIntId": 39,
      "Boxes": [
        {
          "BoxId": 1,
          "StockItemIntId": 2,
          "BoxName": "sample string 3",
          "Width": 4.0,
          "Height": 5.0,
          "Length": 6.0,
          "Weight": 7.0,
          "ValuePercentage": 8.0,
          "Barcode": "sample string 9",
          "PackagingTypeId": "117c34c9-70d4-4dcc-875b-f13b0c513ad4",
          "LogicalDelete": true
        }
      ],
      "RowId": "dd36f718-1d29-4866-be35-8bc215cbc94c",
      "OrderId": "4432edf4-7836-4c58-93c1-d2bc46edc789",
      "StockItemId": "2e297152-12b5-4ca3-9e0c-fd212277e286"
    }
  ],
  "BatchInformation": [
    {
      "BatchId": 1,
      "SKU": "sample string 2",
      "InventoryTrackingType": 3,
      "StockItemId": "209e4ae1-2081-432c-8e41-7a40a8d28a0e",
      "BatchNumber": "sample string 5",
      "ExpiresOn": "2021-07-29T09:24:51.7368563+01:00",
      "SellBy": "2021-07-29T09:24:51.7368563+01:00",
      "Inventory": [
        {
          "BatchInventoryId": 0,
          "BatchId": 0,
          "StockLocationId": "00000000-0000-0000-0000-000000000000",
          "BinRack": "Available",
          "PrioritySequence": 0,
          "Quantity": 0,
          "StockValue": 0.0,
          "StartQuantity": 0,
          "PickedQuantity": 0,
          "BatchStatus": "Available",
          "IsDeleted": false,
          "WarehouseBinrackStandardType": null,
          "WarehouseBinrackTypeName": "Available",
          "InTransfer": null,
          "BinRackId": null,
          "WarehouseBinrackTypeId": null
        }
      ],
      "IsDeleted": true
    }
  ]
}