Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceObjects

Shipment

typeShipment

Fields

  1. fields
deliveredAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

deliveryFailedAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

deliveryFee?Float
deliveryStartedAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

lastEvent?String
lastSyncedAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

provider?String
providerOrderId?String
providerStatus?String
providerUpdatedAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

returnInitiatedAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

returnedAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

status*SHIPMENT_STATUS!
Value inAT_DELIVERY_HUBAT_SORTING_HUBCREATEDDELIVEREDDELIVERY_FAILEDEXCHANGEDIN_TRANSITNOT_CREATEDON_HOLDOUT_FOR_DELIVERYPAID_RETURNPARTIALLY_DELIVEREDPICKED_UPPICKUP_PENDINGRETURNEDRETURN_INITIATED
trackingNumber?String
trackingUrl?String

Usages

Field of
Invoice.shipment
SDL
type Shipment {  deliveredAt: DateTime  deliveryFailedAt: DateTime  deliveryFee: Float  deliveryStartedAt: DateTime  lastEvent: String  lastSyncedAt: DateTime  provider: String  providerOrderId: String  providerStatus: String  providerUpdatedAt: DateTime  returnInitiatedAt: DateTime  returnedAt: DateTime  status: SHIPMENT_STATUS!  trackingNumber: String  trackingUrl: String}