Warehouse / Types/ Objects

ShippingSortingScan

The outcome of scanning a piece for sorting.

Fields

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 destination was created.

idID!

Unique primary key.

instructionString

Instruction printed on the container label.

isActiveBoolean!

Whether pieces can be sorted to this destination.

urlString!

URL of the avatar.

nameString!

Name of the destination.

updatedAtDateTimeTz!

When the destination was last updated.

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.

carrierCarrier!

Carrier used for the shipment

Contents of the shipment for customs

createdAtDateTimeTz!

When the shipment was created.

customsInvoiceNumberString

Invoice number for customs

customsShipmentTypeCustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
deliveryAddressAddress

Delivery address of the shipment

Events related to this shipment

Files of the shipment

idID!

Unique primary key.

labelTypeString

Requested label type of the shipment

Pieces of the shipment

piecesCountInt

Number of pieces

recipientAddressAddress

Recipient address of the shipment

referenceString

Reference 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

shippingStatusShippingStatus

Latest carrier shipping status of the shipment.

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.

Sorting containers on this collection pallet.

closedAtDateTimeTz

When the container was closed.

codeString!

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

Collector that picks the container up.

createdAtDateTimeTz!

When the container was created.

departedAtDateTimeTz

When the container left the warehouse.

departureRemarksString

Remarks entered at departure.

Destination of a sorting container; empty for a collection pallet.

idID!

Unique primary key.

What the container is used for.

COLLECTION_PALLETSORTING

Collection pallet this container is on.

Shipment pieces in this container.

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