shipmentsSummary

Requires permission sales:shipment:list.

The Shipments page summary strip under the list's filter (direction, search, created window; never the status tab or courier-payment filter): how many shipments each status group holds, and — only for staff with sales:sales_order:ship, else null — how many couriers are unpaid and the courier money per currency from shipments booked with cost tracking (courier charges, customer paid, seller paid, owed to and paid to couriers, recovery %). Amounts are decimal strings, never summed across currencies. Rep-scoped like the list.

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 ShipmentsSummary {
  shipmentsSummary {
    awaitingPickupCount
    pickupMissedCount
    total
    unpaidCount
    money {
      courierCharges
      currency
      customerPaid
      owedCount
      owedToCouriers
      paidCount
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ShipmentsSummary {\n  shipmentsSummary {\n    awaitingPickupCount\n    pickupMissedCount\n    total\n    unpaidCount\n    money {\n      courierCharges\n      currency\n      customerPaid\n      owedCount\n      owedToCouriers\n      paidCount\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "shipmentsSummary": {
      "awaitingPickupCount": 0,
      "pickupMissedCount": 0,
      "total": 0,
      "unpaidCount": 0,
      "money": [
        {
          "courierCharges": "string",
          "currency": "string",
          "customerPaid": "string",
          "owedCount": 0,
          "owedToCouriers": "string",
          "paidCount": 0
        }
      ]
    }
  }
}

shipmentsSummary(
  filter: ShipmentsSummaryFilterInput
): ShipmentsSummary!

Arguments

shipmentsSummary.filter ● ShipmentsSummaryFilterInput input

Filter criteria for shipments summary records. Omit to match all.

Type

ShipmentsSummary object

The summary strip of the shipments page.