ShipmentEdge
An edge that contains a node of type Shipment and a cursor.
Fields
cursorString!A unique cursor that can be used for pagination.
barcodeStringBarcode of the shipment
avatarAvatarAvatar of the brand.
brandPortalsBrandPortalConnection!Brand portals configured for this brand
communicationTemplatesCommunicationTemplateConnection!Sparse localized overrides configured for this brand.
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
logoPrintAvatarLogo print of the brand.
logoScreenAvatarLogo screen of the brand.
nameString!Name of the brand
replyToEmailAddressStringEmail address customer replies to brand emails go to; none when empty.
returnAddressAddressReturn address of the brand.
senderAddressAddressSender address of the brand.
senderEmailAddressStringEmail address customer emails are sent from once its domain is verified; until then they come from the brand portal domain.
senderEmailDomainEmailDomainThe organization's email domain of the sender email address.
updatedAtDateTimeTz!When the brand was last updated.
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.
billingAddressAddressBilling address of the customer
createdAtDateTimeTz!When the customer was created.
idID!Unique primary key.
ordersOrderConnection!Customer orders
ordersCountInt!Customer orders count
recipientAddressAddressRecipient address of the customer
referenceStringReference of the customer
returnRequestsReturnRequestConnection!Customer return requests
returnRequestsCountInt!Customer return requests count
shipmentsShipmentConnection!Customer shipments
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
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.
currencyString!ISO 4217 currency code
valueString!Amount
existingInvestigationShipmentInvestigationisAvailableBoolean!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
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
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
carrierCarrier!Carrier that is linked to the shipping service
carrierContactCarrierContactcreatedAtDateTimeTz!When the shipping service was created.
idID!Unique primary key.
integrationIntegrationIntegration that provided this shipping service
isCarrierContactAssignableBoolean!isEnabledBoolean!Enabled
The methods associated with this shipping service.
nameString!Name of the shipping service
typeString!Type of shipping service
updatedAtDateTimeTz!When the shipping service was last updated.
carrierCarrier!Carrier that handles this shipping service method
Supported countries for this shipping method
createdAtDateTimeTz!When the shipping service was created.
featuresShippingServiceMethodFeatures!Stored feature values, independent of the currently selected preferences.
idID!Unique primary key.
isCancelableBoolean!Whether or not shipment (labels) are cancelable
isEnabledBoolean!Enabled
nameString!Name of the shipping service method
shippingServiceShippingService!Shipping service that contains this 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
CANCELEDCREATEDERRORGENERATEDGENERATINGPRINTEDREQUESTEDSHIPPEDA list of SupportTicketAccess edges.
pageInfoPageInfo!Pagination information about the list of edges.
trackingCodeStringTracking code of the shipment
trackingUrlStringTracking url of the shipment
typeString!Type of the shipment
updatedAtDateTimeTz!When the shipment was last updated.