Skip to Content
StoreOSv0.27.1
Storefront GraphQL APIReferenceObjects

Shipment

typeShipment

Fields

  1. fields
provider?String
providerOrderId?String
trackingNumber?String
trackingUrl?String
status*SHIPMENT_STATUS!
Value inNOT_CREATEDCREATEDPICKUP_PENDINGPICKED_UPAT_SORTING_HUBIN_TRANSITAT_DELIVERY_HUBOUT_FOR_DELIVERYON_HOLDPARTIALLY_DELIVEREDDELIVEREDDELIVERY_FAILEDRETURN_INITIATEDRETURNEDPAID_RETURNEXCHANGED
providerStatus?String
lastEvent?String
providerUpdatedAt?DateTime

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

deliveryFee?Float
lastSyncedAt?DateTime

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

deliveredAt?DateTime

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

deliveryStartedAt?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.

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.

Usages

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

ShareChatPixelCredentials

Previous Page

ShippingAddress

Next Page