Skip to main content

ShipmentEventGql

One step on a shipment's timeline.

type ShipmentEventGql {
  description: String
  id: ID!
  location: String
  occurredAt: DateTime!
  rawStatus: String
  source: String!
  status: ShipmentStatus!
  statusMapped: Boolean
}

Fields​

ShipmentEventGql.description ● String scalar​

What happened.

ShipmentEventGql.id ● ID! non-null scalar​

The unique ID of this record.

ShipmentEventGql.location ● String scalar​

Where it happened.

ShipmentEventGql.occurredAt ● DateTime! non-null scalar​

When it happened.

ShipmentEventGql.rawStatus ● String scalar​

The carrier's own status text.

ShipmentEventGql.source ● String! non-null scalar​

Where the event came from: WEBHOOK, POLL, MANUAL or SYSTEM.

ShipmentEventGql.status ● ShipmentStatus! non-null enum​

The status of the shipment at this point.

ShipmentEventGql.statusMapped ● Boolean scalar​

False when the carrier's status could not be mapped: status is then the shipment's status at that moment, not the carrier's — show rawStatus instead.

Member Of​

ShipmentGql object