appendShipmentEvents

Requires permission sales:shipment:update.

Report tracking events from the app's carrier for a shipment booked through this app. Events are recorded on the shipment's timeline once each and move its status through the normal status rules, oldest first. Needs write_fulfillments.

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

mutation AppendShipmentEvents($input: AppAppendShipmentEventsInput!) {
  appendShipmentEvents(input: $input) {
    id
    orderNumber
    returnNumber
    shipmentNumber
    trackingNumber
    carrierName
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation AppendShipmentEvents($input: AppAppendShipmentEventsInput!) {\n  appendShipmentEvents(input: $input) {\n    id\n    orderNumber\n    returnNumber\n    shipmentNumber\n    trackingNumber\n    carrierName\n  }\n}",
  "variables": {
    "input": {
      "events": [
        {
          "occurredAt": "2025-01-15T00:00:00Z",
          "status": "AWAITING_PICKUP"
        }
      ],
      "shipmentId": "id"
    }
  }
}
EOF

Variables:

{
  "input": {
    "events": [
      {
        "occurredAt": "2025-01-15T00:00:00Z",
        "status": "AWAITING_PICKUP"
      }
    ],
    "shipmentId": "id"
  }
}

Response:

{
  "data": {
    "appendShipmentEvents": {
      "id": "id",
      "orderNumber": "string",
      "returnNumber": "string",
      "shipmentNumber": "string",
      "trackingNumber": "string",
      "carrierName": "string"
    }
  }
}

appendShipmentEvents(
  input: AppAppendShipmentEventsInput!
): ShipmentListRow!

Arguments

appendShipmentEvents.input ● AppAppendShipmentEventsInput! non-null input

The shipment and its events.

Type

ShipmentListRow object

One row of the shipments list.