Shipment

No description

type Shipment {
  id: ID!
  orderId: String!
  trackingCode: String
  carrierName: String
  carrierService: String
  trackingUrl: String
  cost: Float
  currency: String
  platformShipmentId: String
  shippedAt: Timestamp
  createdAt: Timestamp
}

Fields

Shipment.id ● ID! non-null scalar

Shipment.orderId ● String! non-null scalar

Shipment.trackingCode ● String scalar

Carrier tracking number. Nullable: a shipment can be recorded before a label is purchased (e.g. manual shipments for non-Printify enterprises), so this may be null until tracking is assigned.

Shipment.carrierName ● String scalar

Shipment.carrierService ● String scalar

Shipment.trackingUrl ● String scalar

Direct carrier tracking URL (falls back to an AfterShip link). The cleanest value to surface to a buyer.

Shipment.cost ● Float scalar

Shipping cost charged for this shipment (may be 0 for manual shipments).

Shipment.currency ● String scalar

ISO currency code for cost (e.g. "USD").

Shipment.platformShipmentId ● String scalar

Carrier/platform shipment identifier.

Shipment.shippedAt ● Timestamp object

When the shipment was created/shipped (alias of createdAt).

Shipment.createdAt ● Timestamp object

Returned By

getShipment query ● getShipments query

Member Of

Order object