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

# ProcessOrderByOrderOrReferenceId

`POST /api/Orders/ProcessOrderByOrderOrReferenceId`

<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
    - `RowId` string, uuid — Record row ID
    - `StockItemId` string, uuid — Stock Item ID
    - `IsService` boolean — Is the item a service?
    - `IsUnlinked` boolean — Is the item unlinked?
    - `Quantity` integer — Quantity
  - `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.net/linnworks/apis/authenticate-api.md) · [All operations](https://skmtc.net/linnworks/apis/authenticate-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/linnworks/authenticate-api/versions/0123569a22fb/schema)