ShipmentListRow

One row of the shipments list.

type ShipmentListRow {
  bookedAt: DateTime
  cancelledAt: DateTime
  carrierLogoUrl: String
  carrierName: String!
  costCurrency: String
  courierCharge: String
  courierPaymentMethod: String
  courierPaymentStatus: ShipmentCourierPaymentStatus
  createdAt: DateTime!
  customerId: ID
  customerName: String
  customerPaid: String
  deliveredAt: DateTime
  direction: ShipmentDirection!
  errorMessage: String
  estimatedDeliveryAt: DateTime
  id: ID!
  lastEventAt: DateTime
  orderNumber: String
  pickedUpAt: DateTime
  pickupMissed: Boolean!
  pickupWindowEnd: DateTime
  pickupWindowStart: DateTime
  productReturnId: ID
  returnNumber: String
  salesOrderId: ID
  sellerPaid: String
  serviceLevelName: String
  shipmentNumber: String!
  status: ShipmentStatus!
  statusGroup: ShipmentStatusGroup!
  trackingNumber: String
  trackingUrl: String
}

Fields

ShipmentListRow.bookedAt ● DateTime scalar

When the shipment was booked.

ShipmentListRow.cancelledAt ● DateTime scalar

When the shipment was cancelled.

ShipmentListRow.carrierLogoUrl ● String scalar

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

ShipmentListRow.carrierName ● String! non-null scalar

The courier carrying the shipment.

ShipmentListRow.costCurrency ● String scalar

The currency of the cost amounts. Only set for staff who may ship.

ShipmentListRow.courierCharge ● String scalar

What the courier charged, as a decimal string. Only set for staff who may ship.

ShipmentListRow.courierPaymentMethod ● String scalar

How the courier was paid. Empty when unpaid or not visible.

ShipmentListRow.courierPaymentStatus ● ShipmentCourierPaymentStatus enum

Whether the courier is PAID, UNPAID or NOT_APPLICABLE. Only set for staff who may ship.

ShipmentListRow.createdAt ● DateTime! non-null scalar

When the record was created.

ShipmentListRow.customerId ● ID scalar

The ID of the customer.

ShipmentListRow.customerName ● String scalar

The customer on the order, or for a return pickup the customer on the return.

ShipmentListRow.customerPaid ● String scalar

What the customer paid towards it. Only set for staff who may ship.

ShipmentListRow.deliveredAt ● DateTime scalar

When the shipment was delivered.

ShipmentListRow.direction ● ShipmentDirection! non-null enum

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

ShipmentListRow.errorMessage ● String scalar

The provider's exact error on a booking problem.

ShipmentListRow.estimatedDeliveryAt ● DateTime scalar

When the shipment is expected to arrive.

ShipmentListRow.id ● ID! non-null scalar

The unique ID of this record.

ShipmentListRow.lastEventAt ● DateTime scalar

When the carrier or staff last reported.

ShipmentListRow.orderNumber ● String scalar

The number of the sales order. For a return pickup, the original order when there is one.

ShipmentListRow.pickedUpAt ● DateTime scalar

When the courier collected the parcel.

ShipmentListRow.pickupMissed ● Boolean! non-null scalar

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

ShipmentListRow.pickupWindowEnd ● DateTime scalar

The end of the pickup window staff booked.

ShipmentListRow.pickupWindowStart ● DateTime scalar

The start of the pickup window staff booked.

ShipmentListRow.productReturnId ● ID scalar

The ID of the return, for a return pickup.

ShipmentListRow.returnNumber ● String scalar

The number of the return, for a return pickup.

ShipmentListRow.salesOrderId ● ID scalar

The ID of the sales order.

ShipmentListRow.sellerPaid ● String scalar

What the seller absorbed. Only set for staff who may ship.

ShipmentListRow.serviceLevelName ● String scalar

The name of the service level.

ShipmentListRow.shipmentNumber ● String! non-null scalar

The shipment number.

ShipmentListRow.status ● ShipmentStatus! non-null enum

The status of the shipment.

ShipmentListRow.statusGroup ● ShipmentStatusGroup! non-null enum

The list tab the shipment falls under.

ShipmentListRow.trackingNumber ● String scalar

The carrier's tracking number.

ShipmentListRow.trackingUrl ● String scalar

A link to track the shipment with the carrier.

Member Of

ShipmentListPage object