Skip to main content
Anchor to FulfillmentEvent

FulfillmentEvent

object

Requires read_orders access scope.

A tracking event that records the status and location of a fulfillment at a specific point in time. Each event captures details such as the status (for example, in transit, out for delivery, delivered) and any messages associated with the event.

Fulfillment events provide a chronological history of a package's journey from shipment to delivery. They include timestamps, geographic coordinates, and estimated delivery dates to track fulfillment progress.

Anchor to FieldsFields

Anchor to address1address1
•String

The street address where this fulfillment event occurred.

Anchor to citycity
•String

The city where this fulfillment event occurred.

Anchor to countrycountry
•String

The country where this fulfillment event occurred.

Anchor to createdAtcreatedAt
•DateTime!
non-null

The date and time when the fulfillment event was created.

Anchor to estimatedDeliveryAtestimatedDeliveryAt
•DateTime

The estimated delivery date and time of the fulfillment.

Anchor to happenedAthappenedAt
•DateTime!
non-null

The time at which this fulfillment event happened.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to latitudelatitude
•Float

The latitude where this fulfillment event occurred.

Anchor to longitudelongitude
•Float

The longitude where this fulfillment event occurred.

Anchor to messagemessage
•String

A message associated with this fulfillment event.

Anchor to provinceprovince
•String

The province where this fulfillment event occurred.

Anchor to statusstatus
•FulfillmentEventStatus!
non-null

The status of this fulfillment event.

Anchor to zipzip
•String

The zip code of the location where this fulfillment event occurred.

Was this section helpful?

Anchor to MutationsMutations

Anchor to fulfillmentEventCreatefulfillmentEventCreate
•mutation

Creates a FulfillmentEvent to track the shipment status and location of items that have shipped. Events capture status updates like carrier pickup, in transit, out for delivery, or delivered.

Each event records the timestamp and current status of the Fulfillment. You can include optional details such as the location where the event occurred, estimated arrival time, and messages for tracking purposes.

Arguments

Anchor to fulfillmentEventfulfillmentEvent
•FulfillmentEventInput!
required

The input fields used to create a fulfillment event for a fulfillment.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to NodeNode
•interface
Was this section helpful?