ShipmentGql

A shipment as staff see it. It includes the seller's cost and is never returned to buyers.

type ShipmentGql {
  billedInvoiceNumbers: [String!]
  bookedAt: DateTime
  cancelledAt: DateTime
  carrierLogoUrl: String
  carrierName: String!
  chargedCost: String
  costSplit: ShipmentCostSplit
  courierPayment: ShipmentCourierPayment
  courierPaymentStatus: ShipmentCourierPaymentStatus
  createdAt: DateTime!
  currency: String!
  deliveredAt: DateTime
  deliveryPartnerConfigId: String
  destinationAddress: JSON!
  direction: ShipmentDirection!
  errorMessage: String
  estimatedDeliveryAt: DateTime
  events: [ShipmentEventGql!]!
  hasLabel: Boolean!
  hasProofOfDelivery: Boolean!
  id: ID!
  items: [ShipmentItemGql!]!
  liveLocationAvailable: Boolean!
  manualStatus: Boolean!
  originAddress: JSON!
  originWarehouseId: String
  parcels: [DeliveryParcelGql!]!
  pickedUpAt: DateTime
  pickup: ShipmentPickup
  pickupMissed: Boolean!
  pickupWindowEnd: DateTime
  pickupWindowStart: DateTime
  productReturnId: String
  providerKey: String!
  quotedCost: String
  rawStatus: String
  recipient: JSON!
  salesOrderId: String
  serviceLevelCode: String
  serviceLevelName: String
  shipmentNumber: String!
  status: ShipmentStatus!
  trackingNumber: String
  trackingUrl: String
}

Fields

ShipmentGql.billedInvoiceNumbers ● [String!] list scalar

Staff only: the numbers of the order's live sales invoices (not cancelled or voided) that bill its shipping — the shipment's "Billed on". Null unless the caller holds sales:sales_order:ship, and for a return pickup.

ShipmentGql.bookedAt ● DateTime scalar

When the shipment was booked.

ShipmentGql.cancelledAt ● DateTime scalar

When the shipment was cancelled.

ShipmentGql.carrierLogoUrl ● String scalar

The partner's logo, or empty to show a monogram.

ShipmentGql.carrierName ● String! non-null scalar

The courier carrying the shipment.

ShipmentGql.chargedCost ● String scalar

The seller's final cost, as a decimal string.

ShipmentGql.costSplit ● ShipmentCostSplit object

Staff only: the shipment's cost split (customer paid / courier charge / seller paid). Null unless the caller holds sales:sales_order:ship, or when no split was recorded (the charge was not known at booking).

ShipmentGql.courierPayment ● ShipmentCourierPayment object

Staff only: the recorded courier payment. Null unless the caller holds sales:sales_order:ship, or when none is recorded.

ShipmentGql.courierPaymentStatus ● ShipmentCourierPaymentStatus enum

Staff only: PAID / UNPAID / NOT_APPLICABLE. Null unless the caller holds sales:sales_order:ship.

ShipmentGql.createdAt ● DateTime! non-null scalar

When the record was created.

ShipmentGql.currency ● String! non-null scalar

ISO 4217 currency code.

ShipmentGql.deliveredAt ● DateTime scalar

When the shipment was delivered.

ShipmentGql.deliveryPartnerConfigId ● String scalar

The ID of the delivery partner the shipment is booked with.

ShipmentGql.destinationAddress ● JSON! non-null scalar

The address the shipment is delivered to.

ShipmentGql.direction ● ShipmentDirection! non-null enum

OUTBOUND for an order delivery, RETURN for a return pickup.

ShipmentGql.errorMessage ● String scalar

The provider's exact error, if there was one.

ShipmentGql.estimatedDeliveryAt ● DateTime scalar

When the shipment is expected to arrive.

ShipmentGql.events ● [ShipmentEventGql!]! non-null object

The timeline of the shipment.

ShipmentGql.hasLabel ● Boolean! non-null scalar

True when a shipping label is available.

ShipmentGql.hasProofOfDelivery ● Boolean! non-null scalar

True when proof of delivery is available.

ShipmentGql.id ● ID! non-null scalar

The unique ID of this record.

ShipmentGql.items ● [ShipmentItemGql!]! non-null object

The lines of the shipment.

ShipmentGql.liveLocationAvailable ● Boolean! non-null scalar

True while a courier is carrying the shipment and the carrier reports a live position.

ShipmentGql.manualStatus ● Boolean! non-null scalar

True for a custom courier, whose status staff record by hand.

ShipmentGql.originAddress ● JSON! non-null scalar

The address the shipment is collected from.

ShipmentGql.originWarehouseId ● String scalar

The ID of the warehouse the shipment leaves.

ShipmentGql.parcels ● [DeliveryParcelGql!]! non-null object

The parcels of the shipment.

ShipmentGql.pickedUpAt ● DateTime scalar

When the courier collected the parcel.

ShipmentGql.pickup ● ShipmentPickup object

What the courier reported about the pickup. Empty until it reports.

ShipmentGql.pickupMissed ● Boolean! non-null scalar

True when the pickup window closed and the courier did not collect.

ShipmentGql.pickupWindowEnd ● DateTime scalar

The end of the pickup window staff booked.

ShipmentGql.pickupWindowStart ● DateTime scalar

The start of the pickup window staff booked.

ShipmentGql.productReturnId ● String scalar

The ID of the return, for a return pickup.

ShipmentGql.providerKey ● String! non-null scalar

The provider key of the delivery partner.

ShipmentGql.quotedCost ● String scalar

The seller's cost at booking, as a decimal string.

ShipmentGql.rawStatus ● String scalar

The carrier's own status text.

ShipmentGql.recipient ● JSON! non-null scalar

Who the shipment is delivered to.

ShipmentGql.salesOrderId ● String scalar

The ID of the sales order.

ShipmentGql.serviceLevelCode ● String scalar

The code of the service level.

ShipmentGql.serviceLevelName ● String scalar

The name of the service level.

ShipmentGql.shipmentNumber ● String! non-null scalar

The shipment number.

ShipmentGql.status ● ShipmentStatus! non-null enum

The status of the shipment.

ShipmentGql.trackingNumber ● String scalar

The carrier's tracking number.

ShipmentGql.trackingUrl ● String scalar

A link to track the shipment with the carrier.

Returned By

bookReturnPickup mutation ● bookShipmentForShippedGoods mutation ● cancelShipment mutation ● clearShipmentCourierPayment mutation ● markShipmentCourierPaid mutation ● productReturnShipments query ● recordShipmentStatus mutation ● refreshShipmentTracking mutation ● resolveOrphanedShipment mutation ● salesOrderShipments query ● shipment query

Member Of

ShipmentTracking object