customerShipmentLiveLocation

Requires a customer (portal or buyer app) session.

the courier's live position for one of the buyer's shipments (an order shipment this buyer may see, or the company's own return pickup). Null unless CustomerShipment.liveLocationAvailable (always null for an order shipment when the store's customer tracking is below full) — and still null while the carrier has no position. Another company's shipment is not found. Cached 15 s per shipment; poll no faster.

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 CustomerShipmentLiveLocation($shipmentId: ID!) {
  customerShipmentLiveLocation(shipmentId: $shipmentId) {
    carrierName
    latitude
    longitude
    updatedAt
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CustomerShipmentLiveLocation($shipmentId: ID!) {\n  customerShipmentLiveLocation(shipmentId: $shipmentId) {\n    carrierName\n    latitude\n    longitude\n    updatedAt\n  }\n}",
  "variables": {
    "shipmentId": "id"
  }
}
EOF

Variables:

{
  "shipmentId": "id"
}

Response:

{
  "data": {
    "customerShipmentLiveLocation": {
      "carrierName": "string",
      "latitude": 0,
      "longitude": 0,
      "updatedAt": "2025-01-15T00:00:00Z"
    }
  }
}

customerShipmentLiveLocation(
  shipmentId: ID!
): ShipmentLiveLocation

Arguments

customerShipmentLiveLocation.shipmentId ● ID! non-null scalar

The ID of the shipment.

Type

ShipmentLiveLocation object

The courier's last reported position for a shipment on its way (WGS-84 degrees). Read on demand from the carrier and reused for up to 15 seconds.