shipment
Find a single shipment
Arguments
1 argumentid•IDSearch by primary key.
Possible return
barcode•StringBarcode of the shipment
createdAt•DateTimeTz!When the brand was created.
customsShipmentType•CustomsShipmentTypeDefault customs shipment to use for shipments
DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLEcustomsUseReferenceIfInvoiceNumberEmpty•Boolean!Use reference if invoice number is empty
id•ID!Unique primary key.
inboundGBEori•StringImport EORI for GB
inboundGBVat•StringImport VAT number for GB
name•String!Name of the brand
updatedAt•DateTimeTz!When the brand was last updated.
canceledAt•DateTimeWhen the shipment was canceled.
code•String!Code of the carrier
logoUrl•StringLogo URL
name•String!Name
trackingUrl•StringRegular tracking URL
createdAt•DateTimeTz!When the shipment was created.
createdAt•DateTimeTz!When the customer was created.
id•ID!Unique primary key.
ordersCount•Int!Customer orders count
reference•StringReference of the customer
returnRequestsCount•Int!Customer return requests count
shipmentsCount•Int!Customer shipments count
updatedAt•DateTimeTz!When the customer was last updated.
customsInvoiceNumber•StringInvoice number for customs
customsShipmentType•CustomsShipmentTypeShipment export type for customs
DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLEaddress•StringStreet / first address line
address2•StringSecond address line
city•StringCity
companyName•StringCompany name
countryCode•String!Country code
email•StringEmail address
eori•StringEORI
formattedLines•String!Formatted address
houseNumber•StringHouse number
id•ID!Unique primary key.
name•StringName
oss•StringOne-Stop Shop (OSS) number
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
postalCode•StringPostal code
stateCode•StringState code
vat•StringVAT number
id•ID!Unique primary key.
currency•String!ISO 4217 currency code
value•String!Amount
labelType•StringRequested label type of the shipment
piecesCount•IntNumber of pieces
address•StringStreet / first address line
address2•StringSecond address line
city•StringCity
companyName•StringCompany name
countryCode•String!Country code
email•StringEmail address
eori•StringEORI
formattedLines•String!Formatted address
houseNumber•StringHouse number
id•ID!Unique primary key.
name•StringName
oss•StringOne-Stop Shop (OSS) number
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
postalCode•StringPostal code
stateCode•StringState code
vat•StringVAT number
reference•StringReference of the shipment
address•StringStreet / first address line
address2•StringSecond address line
city•StringCity
companyName•StringCompany name
countryCode•String!Country code
email•StringEmail address
eori•StringEORI
formattedLines•String!Formatted address
houseNumber•StringHouse number
id•ID!Unique primary key.
name•StringName
oss•StringOne-Stop Shop (OSS) number
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
postalCode•StringPostal code
stateCode•StringState code
vat•StringVAT number
address•StringStreet / first address line
address2•StringSecond address line
city•StringCity
companyName•StringCompany name
countryCode•String!Country code
email•StringEmail address
eori•StringEORI
formattedLines•String!Formatted address
houseNumber•StringHouse number
id•ID!Unique primary key.
name•StringName
oss•StringOne-Stop Shop (OSS) number
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
postalCode•StringPostal code
stateCode•StringState code
vat•StringVAT number
code•String!Phase code
createdAt•DateTimeTz!When the phase was created
description•StringPhase description
name•String!Phase name
updatedAt•DateTimeTz!When the phase was last updated
createdAt•DateTimeTz!When the shipping service was created.
id•ID!Unique primary key.
isEnabled•Boolean!Enabled
name•String!Name of the shipping service
type•String!Type of shipping service
updatedAt•DateTimeTz!When the shipping service was last updated.
createdAt•DateTimeTz!When the shipping service was created.
id•ID!Unique primary key.
isCancelable•Boolean!Whether or not shipment (labels) are cancelable
isEnabled•Boolean!Enabled
name•String!Name of the shipping service method
type•String!Type type
updatedAt•DateTimeTz!When the shipping service was last updated.
code•String!Status code
createdAt•DateTimeTz!When the status was created
description•StringStatus description
name•String!Status name
updatedAt•DateTimeTz!When the status was last updated
status•ShipmentStatus!Status of the shipment
CANCELEDCREATEDERRORGENERATEDGENERATINGPRINTEDREQUESTEDSHIPPEDtrackingCode•StringTracking code of the shipment
trackingUrl•StringTracking url of the shipment
type•String!Type of the shipment
updatedAt•DateTimeTz!When the shipment was last updated.