Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

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

GET | 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": "cdcf16ae-4a44-40b1-a13f-62c2f0faf544",
  "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": "3a39c975-897a-4fc9-928f-ef9e2660ea0f",
  "OrderSummary": {
    "OrderId": "bdcff4a6-4975-48de-9746-c74730ed17b1",
    "NumOrderId": 2,
    "ReceivedDate": "2023-01-10T13:49:54.4659484+00:00",
    "ProcessDate": "2023-01-10T13:49:54.4659484+00:00",
    "Source": "sample string 5",
    "CustomerName": "sample string 6",
    "NumProducts": 7
  },
  "Items": [
    {
      "ItemId": "6b6f4d1d-dd70-4383-b816-a38f5d0f7077",
      "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": "1e7e025c-69eb-435a-b070-e1ddc73a3711",
        "Rowid": "d66bccac-a040-46cb-bac6-b03d5816def6",
        "pkPurchaseId": "6087dc97-1bdc-48f0-8ee0-a912797e28c5",
        "ExternalInvoiceNumber": "sample string 4",
        "fkSupplierId": "78211736-4744-41e0-b5ff-2f7e5f8fc35f",
        "DateOfDelivery": "2023-01-10T13:49:54.4669373+00:00",
        "QuotedDeliveryDate": "2023-01-10T13:49:54.4669373+00:00",
        "SupplierName": "sample string 8",
        "fkLocationId": "2265da82-100e-447f-be50-65898b47427e"
      },
      "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": "ce2de797-1e72-4eea-8e18-fa5b01e3f526",
      "AdditionalInfo": [
        {
          "pkOptionId": "4eab01ec-0f0b-4b1a-9a53-66db19b6c829",
          "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": "756f059c-ce32-4c7c-aad6-9f4321fbe4b6",
          "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": "a4307e35-8bd6-4b88-88ff-481ac7377751",
          "LogicalDelete": true
        }
      ],
      "RowId": "ca0cbd6b-3b2d-4597-be7f-518fb3a41606",
      "OrderId": "f9ff7f87-6e1d-463b-8be1-cd13b914300c",
      "StockItemId": "941d8116-fee2-4b98-b447-80d797c7f634"
    }
  ],
  "BatchInformation": [
    {
      "BatchId": 1,
      "SKU": "sample string 2",
      "InventoryTrackingType": 3,
      "StockItemId": "892ea884-e770-47ae-ac86-4f01e88d836b",
      "BatchNumber": "sample string 5",
      "ExpiresOn": "2023-01-10T13:49:54.4669373+00:00",
      "SellBy": "2023-01-10T13:49:54.4669373+00:00",
      "Inventory": [
        {
          "BatchInventoryId": 1,
          "BatchId": 2,
          "StockLocationId": "fb3ba4c4-b1b8-4a4e-b7b1-b9084baaa7a9",
          "BinRack": "sample string 4",
          "PrioritySequence": 5,
          "Quantity": 6,
          "StockValue": 7.0,
          "StartQuantity": 8,
          "PickedQuantity": 9,
          "BatchStatus": "Available",
          "IsDeleted": true,
          "WarehouseBinrackStandardType": 1,
          "WarehouseBinrackTypeName": "sample string 12",
          "InTransfer": 1,
          "BinRackId": 1,
          "WarehouseBinrackTypeId": 1
        }
      ],
      "IsDeleted": true
    }
  ]
}