Skip to main content

CustomerShipment

A shipment as the buyer sees it: status, carrier, tracking and timeline. Never carries the seller's cost, provider ids or provider errors. Under the store's "progress only" tracking the courier, service, logo, tracking number, link and live position are null/false and events holds dated milestones only; under "order status only" no shipment is returned at all.

type CustomerShipment {
  carrierLogoUrl: String
  carrierName: String
  deliveredAt: DateTime
  estimatedDeliveryAt: DateTime
  events: [CustomerShipmentEvent!]!
  id: ID!
  liveLocationAvailable: Boolean!
  serviceLevelName: String
  shipmentNumber: String!
  status: ShipmentStatus!
  trackingNumber: String
  trackingUrl: String
}

Fields​

CustomerShipment.carrierLogoUrl ● String scalar​

The courier's logo (an image URL or PNG data URI), or null — show the carrier name alone.

CustomerShipment.carrierName ● String scalar​

The courier, or null when the store does not show it to customers (progress-only tracking).

CustomerShipment.deliveredAt ● DateTime scalar​

When the shipment was delivered.

CustomerShipment.estimatedDeliveryAt ● DateTime scalar​

When the shipment is expected to arrive.

CustomerShipment.events ● [CustomerShipmentEvent!]! non-null object​

Oldest first.

CustomerShipment.id ● ID! non-null scalar​

The unique ID of this record.

CustomerShipment.liveLocationAvailable ● Boolean! non-null scalar​

True while a courier is carrying this shipment (PICKED_UP / OUT_FOR_DELIVERY) and its carrier reports a live courier position. Read the position with customerShipmentLiveLocation (portal) or mobileShipmentLiveLocation (buyer app); it can still be null when the carrier has none at that moment.

CustomerShipment.serviceLevelName ● String scalar​

The name of the service level.

CustomerShipment.shipmentNumber ● String! non-null scalar​

The shipment number.

CustomerShipment.status ● ShipmentStatus! non-null enum​

The status of the shipment.

CustomerShipment.trackingNumber ● String scalar​

The carrier's tracking number.

CustomerShipment.trackingUrl ● String scalar​

The carrier's public tracking page. https only — any other link is dropped (null).

Member Of​

CustomerOrderDetail object ● CustomerReturnView object ● CustomerShipmentTracking object ● MobileOrder object