---
title: "ProcessOrderByOrderOrReferenceId"
method: POST
path: "/api/Orders/ProcessOrderByOrderOrReferenceId"
tags: ["Orders"]
---

# ProcessOrderByOrderOrReferenceId

`POST /api/Orders/ProcessOrderByOrderOrReferenceId`

## Request

- Base URL: `https://eu-ext.linnworks.net`
- URL: `https://eu-ext.linnworks.net/api/Orders/ProcessOrderByOrderOrReferenceId`
- Auth: API key in header `Authorization`

<b>Permissions Required: </b> GlobalPermissions.OrderBook.DespatchConsoleNode
<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

## Request body

- OrdersProcessOrderByOrderOrReferenceIdRequest
  - `request` ProcessOrderByOrderIdOrReferenceRequest: A request used to process an order by id or reference
    - `OrderOrReferenceId` string: The order id or reference id
    - `LocationId` string, uuid: The location to process the order from
    - `ScansPerformed` boolean: Defines if the batches have been scanned
    - `OrderProcessingNotesAcknowledged` boolean: Have the processing notes been acknowledged
    - `WorkflowJobId` integer: Workflow job id that the order is supposed to belong to

## Response `200`

OK

- ProcessOrderByOrderIdOrReferenceResponse: A response class used when processing an order by order id or reference
  - `ProcessedState` 'PROCESSED' | 'NOT_FOUND' | 'SCAN_REQUIRED' | 'NOT_PROCESSED' | 'NOTE_ACKNOWLEDGEMENT_REQUIRED' | 'NOT_IN_WORKFLOW': The processed state
  - `Message` string: A message - Provided if there have been errors
  - `Response` object: A response object used if further action is required
  - `OrderId` string, uuid: The ID of the order - Guid empty if not found
  - `OrderSummary` OrderSummary
    - `OrderId` string, uuid: Order ID (pkOrderId)
    - `NumOrderId` integer: Linnworks order number
    - `ReceivedDate` string, date-time: Date when order was received on a channel
    - `ProcessDate` string, date-time: Date when order was processed
    - `Source` string: Channel name / source (e.g. EBAY)
    - `CustomerName` string: Customer name
    - `NumProducts` integer: Quantity of products on an Order
    - `FulfillmentLocationId` string, uuid: Order location ID
  - `Items` OrderItem[]: The items that need to be scanned - If any
    - `ItemId` string, uuid: Stock Item ID
    - `ItemNumber` string: Item number as on channel
    - `SKU` string: Product SKU
    - `ItemSource` string: Item source / channel name
    - `Title` string: Item title
    - `Quantity` integer: Quantity
    - `CategoryName` string: Product category
    - `CompositeAvailablity` integer: Composite availability
    - `StockLevelsSpecified` boolean: If stock level specified
    - `OnOrder` integer: Level due in purchase orders
    - `OnPurchaseOrder` OrderItemOnOrder
      - `pkPurchaseItemId` string, uuid: Primary key of the bound
      - `Rowid` string, uuid
      - `pkPurchaseId` string, uuid
      - `ExternalInvoiceNumber` string
      - `fkSupplierId` string, uuid
      - `DateOfDelivery` string, date-time
      - `QuotedDeliveryDate` string, date-time
      - `SupplierName` string
      - `fkLocationId` string, uuid
    - `InOrderBook` integer: Quantity currently in open orders
    - `Level` integer: Current stock level
    - `MinimumLevel` integer: Minimum level
    - `AvailableStock` integer: Currently available stock level (Level-InOrderBook)
    - `PricePerUnit` number, double: Unit price
    - `UnitCost` number, double: Unit cost
    - `DespatchStockUnitCost` number, double: Despatch stock unit cost
    - `Discount` number, double: Percentage (0%, 10%, 20%, etc...)
    - `Tax` number, double: Actual tax value on an item
    - `TaxRate` number, double: Tax rate
    - `Cost` number, double: Total item cost (exc tax)
    - `CostIncTax` number, double: Total item cost (inc tax)
    - `CompositeSubItems` OrderItem[]: List of order items
    - `IsService` boolean: if item is a service
    - `SalesTax` number, double: Sales Tax
    - `TaxCostInclusive` boolean: If tax is included in a cost
    - `PartShipped` boolean: If order is partly shipped
    - `Weight` number, double: Order weight
    - `BarcodeNumber` string: Product barcode
    - `Market` integer: Market
    - `ChannelSKU` string: Channel product SKU
    - `ChannelTitle` string: Channel product title
    - `DiscountValue` number, double
    - `HasImage` boolean: If item got an image
    - `ImageId` string, uuid: Image ID
    - `AdditionalInfo` OrderItemOption[]: List of order item options
      - `pkOptionId` string, uuid: Option ID
      - `Property` string: Option property
      - `Value` string: Value of the option
    - `StockLevelIndicator` integer: Stock level indicator
    - `ShippingCost` number, double: If batch number scan required
    - `PartShippedQty` integer: ShippingCost
    - `ItemName` string: PartShippedQty
    - `BatchNumberScanRequired` boolean: ItemName
    - `SerialNumberScanRequired` boolean: If serial number scan required
    - `BinRack` string: Binrack location
    - `BinRacks` OrderItemBinRack[]: List of BinRacks used for OrderItem
      - `Quantity` integer: Quantity for BinRack per Location
      - `BinRack` string: BinRack
      - `Location` string, uuid: LocationId of the BinRack
      - `BatchId` integer: If the item is batched, identifies the batch number
      - `OrderItemBatchId` integer: If the item is batched, identifies the unique order item batch row
    - `InventoryTrackingType` integer: Identifies whether the item has a sell by date or other defined order in which inventory is to be sold
    - `isBatchedStockItem` boolean: If item has batches
    - `IsWarehouseManaged` boolean
    - `IsUnlinked` boolean
    - `StockItemIntId` integer
    - `Boxes` StockItemBoxConfiguration[]
      - `BoxId` integer: Unique box id.
      - `StockItemIntId` integer
      - `BoxName` string: Box name max 16 characters
      - `Width` number, double: Width of the box
      - `Height` number, double: Height of the box
      - `Length` number, double: Depth of the box
      - `Weight` number, double: Total weight of the box.
      - `ValuePercentage` number, double: Value break down percentage
      - `Barcode` string: Box barcode, max 64 characters.
      - `PackagingTypeId` string, uuid: Packaging type id
      - `LogicalDelete` boolean: IsDeleted flag.
    - `AddedDate` string, date-time
    - `RowId` string, uuid: Record row ID
    - `OrderId` string, uuid: Order ID (pkOrderID)
    - `StockItemId` string, uuid: Stock Item ID
  - `BatchInformation` StockItemBatch[]: The batched items
    - `BatchId` integer: Batch ID
    - `SKU` string: Product SKU
    - `InventoryTrackingType` integer: 0 - None, 1 - Order by sell by date, 2 - Ordered by priority sequence
    - `StockItemId` string, uuid: Product ID
    - `BatchNumber` string: Batch number
    - `ExpiresOn` string, date-time: Batch expiry date
    - `SellBy` string, date-time: Batch sell by date
    - `Inventory` StockItemBatchInventory[]: Batch records
      - `BatchInventoryId` integer: Stock item batch record ID
      - `BatchId` integer: Batch ID
      - `StockLocationId` string, uuid: Location ID
      - `BinRack` string: BinRack
      - `PrioritySequence` integer: Pick order
      - `Quantity` integer: Quantity
      - `StockValue` number, double: Current stock value
      - `StartQuantity` integer: Quantity originally booked in
      - `PickedQuantity` integer: Indicate how many units are now allocated in open orders
      - `BatchStatus` string: Batch Status
      - `IsDeleted` boolean: Is BatchInventory deleted
      - `WarehouseBinrackStandardType` integer: Warehouse binrack standard type
      - `WarehouseBinrackTypeName` string: Warehouse binrack type friendly name
      - `InTransfer` integer: Number of items in Transfer phase.
      - `BinRackId` integer: Binrack Id (Use for WMS)
      - `WarehouseBinrackTypeId` integer: Warehouse binrack type unique id.
    - `IsDeleted` boolean: Is the batch deleted

---

[API](https://skmtc.dev/linnworks/apis/orders-api.md) - [All operations](https://skmtc.dev/linnworks/apis/orders-api/llms.txt) - [OpenAPI document](https://skmtc.dev/linnworks/apis/orders-api/revisions/99d0cb3e4c9d?raw)