GraphQL API
Warehouse API
Warehouse / Types/ object

ShipmentConnection

A paginated list of Shipment edges.

Fields

2 fields
cursor•String!

A unique cursor that can be used for pagination.

barcode•String

Barcode of the shipment

canceledAt•DateTime

When the shipment was canceled.

carrier•Carrier!

Carrier used for the shipment

contents•ShipmentContentConnection!

Contents of the shipment for customs

createdAt•DateTimeTz!

When the shipment was created.

customsInvoiceNumber•String

Invoice number for customs

customsShipmentType•CustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
deliveryAddress•Address

Delivery address of the shipment

events•EventConnection!

Events related to this shipment

files•ShipmentFileConnection!

Files of the shipment

id•ID!

Unique primary key.

labelType•String

Requested label type of the shipment

pieces•ShipmentPieceConnection!

Pieces of the shipment

piecesCount•Int

Number of pieces

recipientAddress•Address

Recipient address of the shipment

reference•String

Reference of the shipment

returnAddress•Address!

Return address of the shipment

senderAddress•Address!

Sender address of the shipment

shippingPhase•ShippingPhase

Shipping phase of the shipment.

shippingServiceMethod•ShippingServiceMethod

Shipping service method

shippingStatus•ShippingStatus

Latest carrier shipping status of the shipment.

status•ShipmentStatus!

Status of the shipment

CANCELEDCREATEDERRORGENERATEDGENERATINGPRINTEDREQUESTEDSHIPPED
trackingCode•String

Tracking code of the shipment

trackingUrl•String

Tracking url of the shipment

type•String!

Type of the shipment

updatedAt•DateTimeTz!

When the shipment was last updated.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.