GraphQL API
Warehouse API
Warehouse / Types/ object

Shipment

A shipment of a company

Fields

26 fields
barcodeString

Barcode of the shipment

canceledAtDateTime

When the shipment was canceled.

codeString!

Code of the carrier

logoUrlString

Logo URL

nameString!

Name

trackingUrlString

Regular tracking URL

cursorString!

A unique cursor that can be used for pagination.

The ShipmentContent node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

createdAtDateTimeTz!

When the shipment was created.

customsInvoiceNumberString

Invoice number for customs

customsShipmentTypeCustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

cursorString!

A unique cursor that can be used for pagination.

nodeEvent!

The Event node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

cursorString!

A unique cursor that can be used for pagination.

The ShipmentFile node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

idID!

Unique primary key.

labelTypeString

Requested label type of the shipment

cursorString!

A unique cursor that can be used for pagination.

The ShipmentPiece node.

endCursorString

The cursor to continue paginating forwards.

hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

The cursor to continue paginating backwards.

piecesCountInt

Number of pieces

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

referenceString

Reference of the shipment

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

codeString!

Phase code

createdAtDateTimeTz!

When the phase was created

descriptionString

Phase description

nameString!

Phase name

updatedAtDateTimeTz!

When the phase was last updated

codeString!

Code of the carrier

logoUrlString

Logo URL

nameString!

Name

trackingUrlString

Regular tracking URL

createdAtDateTimeTz!

When the shipping service was created.

idID!

Unique primary key.

isCancelableBoolean!

Whether this shipping service method can be cancelled.

nameString!

Name of the shipping service method

typeString!

Type type

updatedAtDateTimeTz!

When the shipping service was last updated.

codeString!

Status code

createdAtDateTimeTz!

When the status was created

descriptionString

Status description

nameString!

Status name

codeString!

Phase code

createdAtDateTimeTz!

When the phase was created

descriptionString

Phase description

nameString!

Phase name

updatedAtDateTimeTz!

When the phase was last updated

updatedAtDateTimeTz!

When the status was last updated

Status of the shipment

CANCELEDCREATEDERRORGENERATEDGENERATINGPRINTEDREQUESTEDSHIPPED
trackingCodeString

Tracking code of the shipment

trackingUrlString

Tracking url of the shipment

typeString!

Type of the shipment

updatedAtDateTimeTz!

When the shipment was last updated.