salesOrderAllocations

Requires at least one of the permissions sales:sales_order:allocate or sales:sales_order:read.

Warehouse allocation rows for one order. Each line can be split across warehouses, with an AUTO or MANUAL source and a RESERVED or BACKORDER status. Needs the sales order read or allocate permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query SalesOrderAllocations($salesOrderId: ID!) {
  salesOrderAllocations(salesOrderId: $salesOrderId) {
    id
    batchNumber
    serialNumber
    createdAt
    baseQuantity
    quantity
    warehouse {
      id
      code
      name
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query SalesOrderAllocations($salesOrderId: ID!) {\n  salesOrderAllocations(salesOrderId: $salesOrderId) {\n    id\n    batchNumber\n    serialNumber\n    createdAt\n    baseQuantity\n    quantity\n    warehouse {\n      id\n      code\n      name\n    }\n  }\n}",
  "variables": {
    "salesOrderId": "id"
  }
}
EOF

Variables:

{
  "salesOrderId": "id"
}

Response:

{
  "data": {
    "salesOrderAllocations": [
      {
        "id": "id",
        "batchNumber": "string",
        "serialNumber": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "baseQuantity": 0,
        "quantity": 0,
        "warehouse": {
          "id": "id",
          "code": "string",
          "name": "string"
        }
      }
    ]
  }
}

salesOrderAllocations(
  salesOrderId: ID!
): [SalesOrderItemAllocation!]!

Arguments

salesOrderAllocations.salesOrderId ● ID! non-null scalar

The ID of the sales order.

Type

SalesOrderItemAllocation object

The part of a sales order line that is filled from one warehouse. The quantities of a line's allocations add up to the line.