Warehouse / Types/ Objects

ShipmentPiece

A piece of a shipment

Fields

barcodeString

Barcode of the piece

createdAtDateTimeTz!

When the shipment was created.

heightFloat!

Height

lengthFloat!

Length

Unit

CM
widthFloat!

Width

idID!

Unique primary key.

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

A list of ShipmentContent edges.

pageInfoPageInfo!

Pagination information about the list of edges.

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

A list of Event edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of ShipmentFile edges.

pageInfoPageInfo!

Pagination information about the list of edges.

idID!

Unique primary key.

labelTypeString

Requested label type of the shipment

A list of ShipmentPiece edges.

pageInfoPageInfo!

Pagination information about the list of edges.

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

idID!

Unique primary key.

nameString!

Name of the shipping service

carrierCarrier!

Carrier that handles this shipping service method

createdAtDateTimeTz!

When the shipping service was created.

Stored feature values, independent of the currently selected preferences.

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

shippingPhaseShippingPhase

Shipping phase this status belongs to

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.

A list of ShippingContainer edges.

pageInfoPageInfo!

Pagination information about the list of edges.

closedAtDateTimeTz

When the container was closed.

codeString!

Code printed on the label and scanned to address the container.

createdAtDateTimeTz!

When the collector was created.

Destinations this collector picks up for.

idID!

Unique primary key.

isActiveBoolean!

Whether new containers can be created for this collector.

nameString!

Name of the collector.

Exceptions to the weekly pickup moments.

pickupMoments[DateTimeTz!]!

Pickup moments of the next days, today included, after exceptions and in the warehouse timezone.

Weekly pickup moments.

updatedAtDateTimeTz!

When the collector was last updated.

waitingContainersCountInt!

Top-level open or closed containers with at least one piece, waiting to depart. A pallet counts as one container.

waitingPiecesCountInt!

Pieces in the containers counted by waitingContainersCount, including those in a pallet's child containers.

createdAtDateTimeTz!

When the container was created.

departedAtDateTimeTz

When the container left the warehouse.

departureRemarksString

Remarks entered at departure.

Collector that picks up this destination.

createdAtDateTimeTz!

When the destination was created.

idID!

Unique primary key.

instructionString

Instruction printed on the container label.

isActiveBoolean!

Whether pieces can be sorted to this destination.

logoAvatar

Logo printed on the container label.

nameString!

Name of the destination.

updatedAtDateTimeTz!

When the destination was last updated.

idID!

Unique primary key.

What the container is used for.

COLLECTION_PALLETSORTING

Collection pallet this container is on.

A list of ShipmentPiece edges.

pageInfoPageInfo!

Pagination information about the list of edges.

piecesCountInt!

Number of pieces in this container; a collection pallet counts the pieces of its children.

Where the container is in its life.

CLOSEDDEPARTEDOPEN
updatedAtDateTimeTz!

When the container was last updated.

trackingUrlString

Tracking url of the piece

updatedAtDateTimeTz!

When the shipment was last updated.

Weight unit

GKGLBSOZ
valueFloat!

Weight value