ShipmentPiece
A piece of a shipment
Fields
barcodeStringBarcode of the piece
createdAtDateTimeTz!When the shipment was created.
idID!Unique primary key.
barcodeStringBarcode of the shipment
canceledAtDateTimeWhen the shipment was canceled.
codeString!Code of the carrier
logoUrlStringLogo URL
nameString!Name
trackingUrlStringRegular tracking URL
A list of ShipmentContent edges.
pageInfoPageInfo!Pagination information about the list of edges.
createdAtDateTimeTz!When the shipment was created.
customsInvoiceNumberStringInvoice number for customs
customsShipmentTypeCustomsShipmentTypeShipment export type for customs
DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLEaddressStringStreet / first address line
address2StringSecond address line
cityStringCity
companyNameStringCompany name
countryCodeString!Country code
emailStringEmail address
eoriStringEORI
formattedLinesString!Formatted address
houseNumberStringHouse number
idID!Unique primary key.
nameStringName
phoneStringPhone number
phoneE164StringPhone number in E.164 format
postalCodeStringPostal code
stateCodeStringState code
vatStringVAT number
edges[EventEdge!]!A list of Event edges.
pageInfoPageInfo!Pagination information about the list of edges.
edges[ShipmentFileEdge!]!A list of ShipmentFile edges.
pageInfoPageInfo!Pagination information about the list of edges.
idID!Unique primary key.
labelTypeStringRequested label type of the shipment
A list of ShipmentPiece edges.
pageInfoPageInfo!Pagination information about the list of edges.
piecesCountIntNumber of pieces
addressStringStreet / first address line
address2StringSecond address line
cityStringCity
companyNameStringCompany name
countryCodeString!Country code
emailStringEmail address
eoriStringEORI
formattedLinesString!Formatted address
houseNumberStringHouse number
idID!Unique primary key.
nameStringName
phoneStringPhone number
phoneE164StringPhone number in E.164 format
postalCodeStringPostal code
stateCodeStringState code
vatStringVAT number
referenceStringReference of the shipment
addressStringStreet / first address line
address2StringSecond address line
cityStringCity
companyNameStringCompany name
countryCodeString!Country code
emailStringEmail address
eoriStringEORI
formattedLinesString!Formatted address
houseNumberStringHouse number
idID!Unique primary key.
nameStringName
phoneStringPhone number
phoneE164StringPhone number in E.164 format
postalCodeStringPostal code
stateCodeStringState code
vatStringVAT number
addressStringStreet / first address line
address2StringSecond address line
cityStringCity
companyNameStringCompany name
countryCodeString!Country code
emailStringEmail address
eoriStringEORI
formattedLinesString!Formatted address
houseNumberStringHouse number
idID!Unique primary key.
nameStringName
phoneStringPhone number
phoneE164StringPhone number in E.164 format
postalCodeStringPostal code
stateCodeStringState code
vatStringVAT number
codeString!Phase code
createdAtDateTimeTz!When the phase was created
descriptionStringPhase 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.
featuresShippingServiceMethodFeatures!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
descriptionStringStatus description
nameString!Status name
shippingPhaseShippingPhaseShipping phase this status belongs to
updatedAtDateTimeTz!When the status was last updated
statusShipmentStatus!Status of the shipment
CANCELEDCREATEDERRORGENERATEDGENERATINGPRINTEDREQUESTEDSHIPPEDtrackingCodeStringTracking code of the shipment
trackingUrlStringTracking 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.
closedAtDateTimeTzWhen the container was closed.
codeString!Code printed on the label and scanned to address the container.
createdAtDateTimeTz!When the collector was created.
destinationsShippingDestinationConnection!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.
pickupExceptionsShippingPickupExceptionConnection!Exceptions to the weekly pickup moments.
pickupMoments[DateTimeTz!]!Pickup moments of the next days, today included, after exceptions and in the warehouse timezone.
pickupSchedulesShippingPickupScheduleConnection!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.
departedAtDateTimeTzWhen the container left the warehouse.
departureRemarksStringRemarks entered at departure.
collectorShippingCollector!Collector that picks up this destination.
createdAtDateTimeTz!When the destination was created.
idID!Unique primary key.
instructionStringInstruction printed on the container label.
isActiveBoolean!Whether pieces can be sorted to this destination.
logoAvatarLogo printed on the container label.
nameString!Name of the destination.
updatedAtDateTimeTz!When the destination was last updated.
idID!Unique primary key.
parentShippingContainerCollection 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.
updatedAtDateTimeTz!When the container was last updated.
trackingUrlStringTracking url of the piece
updatedAtDateTimeTz!When the shipment was last updated.
valueFloat!Weight value