shipment
Find a single shipment
Arguments
idIDSearch by primary key.
Returns
barcodeStringBarcode of the shipment
createdAtDateTimeTz!When the brand was created.
customsShipmentTypeCustomsShipmentTypeDefault customs shipment to use for shipments
DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLEcustomsUseReferenceIfInvoiceNumberEmptyBoolean!Use reference if invoice number is empty
idID!Unique primary key.
inboundGBEoriStringImport EORI for GB
inboundGBVatStringImport VAT number for GB
nameString!Name of the brand
replyToEmailAddressStringEmail address customer replies to brand emails go to; none when empty.
senderEmailAddressStringEmail address customer emails are sent from once its domain is verified; until then they come from the brand portal domain.
updatedAtDateTimeTz!When the brand was last updated.
canceledAtDateTimeWhen the shipment was canceled.
codeString!Code of the carrier
logoUrlStringLogo URL
nameString!Name
trackingUrlStringRegular tracking URL
createdAtDateTimeTz!When the shipment was created.
createdAtDateTimeTz!When the customer was created.
idID!Unique primary key.
ordersCountInt!Customer orders count
referenceStringReference of the customer
returnRequestsCountInt!Customer return requests count
shipmentsCountInt!Customer shipments count
updatedAtDateTimeTz!When the customer was last updated.
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
ossStringOne-Stop Shop (OSS) number
phoneStringPhone number
phoneE164StringPhone number in E.164 format
postalCodeStringPostal code
stateCodeStringState code
vatStringVAT number
idID!Unique primary key.
currencyString!ISO 4217 currency code
valueString!Amount
isAvailableBoolean!reasonStringrequiredDocuments[InvestigationDocumentType!]!CLAIM_FORMDAMAGE_PHOTOSDISPATCHINVOICEMANIFEST_ACCEPTANCENON_RECEIPT_STATEMENTPACKAGING_PHOTOSPACKED_ITEMSPACKING_PHOTOSPROOF_OF_DELIVERYPROOF_OF_VALUEPURCHASE_INVOICERECIPIENT_PHOTOSALES_INVOICETRACKINGWEIGHTADDRESS_CHANGECARRIER_LOSTDAMAGEDLATE_DELIVERYRECIPIENT_NOT_RECEIVEDSTUCK_IN_TRANSITUNEXPECTED_RETURNlabelTypeStringRequested label type of the shipment
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
ossStringOne-Stop Shop (OSS) number
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
ossStringOne-Stop Shop (OSS) number
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
ossStringOne-Stop Shop (OSS) number
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
createdAtDateTimeTz!When the shipping service was created.
idID!Unique primary key.
isCarrierContactAssignableBoolean!isEnabledBoolean!Enabled
nameString!Name of the shipping service
typeString!Type of shipping service
updatedAtDateTimeTz!When the shipping service was last updated.
createdAtDateTimeTz!When the shipping service was created.
idID!Unique primary key.
isCancelableBoolean!Whether or not shipment (labels) are cancelable
isEnabledBoolean!Enabled
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
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.