GraphQL API
Organization API
Organization / Types/ object

ShipmentConnection

A paginated list of Shipment edges.

Fields

2 fields
hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

endCursorString

The cursor to continue paginating forwards.

idID!

Unique primary key.

barcodeString

Barcode of the shipment

trackingCodeString

Tracking code of the shipment

trackingUrlString

Tracking url of the shipment

labelTypeString

Requested label type of the shipment

piecesCountInt

Number of pieces

referenceString

Reference of the shipment

insuranceAmountMoney

Amount for which the shipment is insured

Status of the shipment

CANCELEDCREATEDERRORGENERATINGGENERATEDPRINTEDREQUESTEDSHIPPED
typeString!

Type of the shipment

customsInvoiceNumberString

Invoice number for customs

customsShipmentTypeCustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
createdAtDateTimeTz!

When the shipment was created.

updatedAtDateTimeTz!

When the shipment was last updated.

canceledAtDateTime

When the shipment was canceled.

brandBrand!

Brand linked to this shipment

customerCustomer

Customer line linked to shipment

carrierCarrier!

Carrier used for the shipment

deliveryAddressAddress

Delivery address of the shipment

recipientAddressAddress

Recipient address of the shipment

returnAddressAddress!

Return address of the shipment

senderAddressAddress!

Sender address of the shipment

shippingPhaseShippingPhase

Shipping phase of the shipment.

shippingServiceShippingService

Shipping service

shippingServiceMethodShippingServiceMethod

Shipping service method

Events related to this shipment

Contents of the shipment for customs

Files of the shipment

Pieces of the shipment

Support tickets linked to this shipment

cursorString!

A unique cursor that can be used for pagination.