Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
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

post/api/Orders/ProcessOrderByOrderOrReferenceId

Request body

Example request

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

Response

OK

ProcessedState'PROCESSED' | 'NOT_FOUND' | 'SCAN_REQUIRED' | 'NOT_PROCESSED' | 'NOTE_ACKNOWLEDGEMENT_REQUIRED' | 'NOT_IN_WORKFLOW'

The processed state

Messagestring

A message - Provided if there have been errors

Responseobject

A response object used if further action is required

OrderIdstring uuid

The ID of the order - Guid empty if not found

Example response

{
  "OrderId": "00000000-0000-0000-0000-000000000000",
  "OrderSummary": {
    "OrderId": "00000000-0000-0000-0000-000000000000",
    "FulfillmentLocationId": "00000000-0000-0000-0000-000000000000"
  },
  "BatchInformation": [
    {
      "StockItemId": "00000000-0000-0000-0000-000000000000",
      "Inventory": [
        {
          "StockLocationId": "00000000-0000-0000-0000-000000000000"
        }
      ]
    }
  ]
}