Shipment
A shipment of a company
Fields
barcodeStringBarcode of the shipment
urlString!Url of the avatar
edges[BrandPortalEdge!]!A list of BrandPortal edges.
pageInfoPageInfo!Pagination information about the list of edges.
A list of CommunicationTemplate edges.
pageInfoPageInfo!Pagination information about the list of edges.
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
urlString!Url of the avatar
urlString!Url of the avatar
nameString!Name of the brand
replyToEmailAddressStringEmail address customer replies to brand emails go to; none when empty.
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
senderEmailAddressStringEmail address customer emails are sent from once its domain is verified; until then they come from the brand portal domain.
createdAtDateTimeTz!When the email domain was created.
dnsRecords[EmailDomainDnsRecord!]!DNS records to publish at the domain's DNS provider.
domainString!Domain name, e.g. `brand.com`.
idID!Unique primary key.
lastCheckedAtDateTimeTzWhen the DNS records were last checked.
statusEmailDomainStatus!Verified once every DNS record is verified; only then brands send from it.
FAILEDPENDINGVERIFIEDupdatedAtDateTimeTz!When the email domain was last updated.
updatedAtDateTimeTz!When the brand was last updated.
canceledAtDateTimeWhen the shipment was canceled.
codeString!Code of the carrier
logoUrlStringLogo URL
nameString!Name
trackingUrlStringRegular tracking URL
cursorString!A unique cursor that can be used for pagination.
nodeShipmentContent!The ShipmentContent node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
createdAtDateTimeTz!When the shipment was created.
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
createdAtDateTimeTz!When the customer was created.
idID!Unique primary key.
edges[OrderEdge!]!A list of Order edges.
pageInfoPageInfo!Pagination information about the list of edges.
ordersCountInt!Customer orders count
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 customer
A list of ReturnRequest edges.
pageInfoPageInfo!Pagination information about the list of edges.
returnRequestsCountInt!Customer return requests count
edges[ShipmentEdge!]!A list of Shipment edges.
pageInfoPageInfo!Pagination information about the list of edges.
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
cursorString!A unique cursor that can be used for pagination.
nodeEvent!The Event node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
nodeShipmentFile!The ShipmentFile node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
idID!Unique primary key.
currencyString!ISO 4217 currency code
valueString!Amount
carrierReferencesMixedevidenceChecklist[InvestigationEvidenceChecklistEntry!]What is recorded per document type; empty for the requester.
idID!isAutomationPausedBooleanoutcomeMixedpendingActionsMixedpolicySnapshotMixedrequiredDocuments[InvestigationDocumentType!]!CLAIM_FORMDAMAGE_PHOTOSDISPATCHINVOICEMANIFEST_ACCEPTANCENON_RECEIPT_STATEMENTPACKAGING_PHOTOSPACKED_ITEMSPACKING_PHOTOSPROOF_OF_DELIVERYPROOF_OF_VALUEPURCHASE_INVOICERECIPIENT_PHOTOSALES_INVOICETRACKINGWEIGHTshipmentShipment!AWAITING_INFORMATIONREADYRESOLVEDWAITING_CARRIERsubjectGroupString!supportTicketSupportTicketThe ticket of the handler; empty for the requester, who reads it through `tenantSupportTicket`.
tenantSupportTicketTenantSupportTicket!ADDRESS_CHANGECARRIER_LOSTDAMAGEDLATE_DELIVERYRECIPIENT_NOT_RECEIVEDSTUCK_IN_TRANSITUNEXPECTED_RETURNisAvailableBoolean!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
cursorString!A unique cursor that can be used for pagination.
nodeShipmentPiece!The ShipmentPiece node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
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
codeString!Code of the carrier
logoUrlStringLogo URL
nameString!Name
trackingUrlStringRegular tracking URL
emailStringWithout an email the contact is handled by hand: the agent collects the case and evidence but never writes to the carrier.
idID!isEnabledBoolean!localeString!nameString!policyMixed!shippingServicesShippingServiceConnection!The owned shipping services whose investigations go to this contact.
createdAtDateTimeTz!When the shipping service was created.
idID!Unique primary key.
createdAtDateTimeTz!When the integration was created.
idID!Unique primary key.
isEnabledBoolean!Synchronization enabled
isOrderSyncEnabledBoolean!Order sync enabled
isProductSyncEnabledBoolean!Product sync enabled
isStockSyncEnabledBoolean!Stock sync enabled
nameString!Name of the integration
orderSyncUpdatedAtDateTimeTzWhen the last order was updated at the integration while syncing
paymentProfiles[IntegrationPaymentProfile!]!Payment profiles exposed by the integration
productSyncUpdatedAtDateTimeTzWhen the last product was updated at the integration while syncing
productsCountInt!Number of products linked to this integration.
updatedAtDateTimeTz!When the integration was last updated.
isCarrierContactAssignableBoolean!isEnabledBoolean!Enabled
A list of ShippingServiceMethod edges.
pageInfoPageInfo!Pagination information about the list of edges.
nameString!Name of the shipping service
typeString!Type of shipping service
updatedAtDateTimeTz!When the shipping service was last updated.
codeString!Code of the carrier
logoUrlStringLogo URL
nameString!Name
trackingUrlStringRegular tracking URL
A list of ShippingServiceMethodCountry edges.
pageInfoPageInfo!Pagination information about the list of edges.
createdAtDateTimeTz!When the shipping service was created.
ageCheckBooleanb2bBooleanb2cBooleandeliveryTimeShippingDeliveryTimeBEST_EFFORTHOURS_24HOURS_48HOURS_72NEXT_DAYSAME_DAYeveningDeliveryBooleanfirstMileShippingFirstMileDROP_OFF_POINTDROP_OFF_POINT_AND_PICKUPPICKUPinsuranceAmountShippingMethodInsuranceCapabilitylastMileShippingLastMileHOME_DELIVERYPICKUP_POINTmulticolloBooleannoNeighborDeliveryBooleanprinterlessBooleansaturdayDeliveryBooleanserviceLevelShippingServiceLevelECONOMYEXPRESSPRIORITYSTANDARDsignatureBooleansundayDeliveryBooleantrackedBooleanidID!Unique primary key.
isCancelableBoolean!Whether or not shipment (labels) are cancelable
isEnabledBoolean!Enabled
nameString!Name of the shipping service method
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.
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
codeString!Phase code
createdAtDateTimeTz!When the phase was created
descriptionStringPhase description
nameString!Phase name
updatedAtDateTimeTz!When the phase was last updated
updatedAtDateTimeTz!When the status was last updated
statusShipmentStatus!Status of the shipment
CANCELEDCREATEDERRORGENERATEDGENERATINGPRINTEDREQUESTEDSHIPPEDcursorString!A unique cursor that can be used for pagination.
The SupportTicketAccess node.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
trackingCodeStringTracking code of the shipment
trackingUrlStringTracking url of the shipment
typeString!Type of the shipment
updatedAtDateTimeTz!When the shipment was last updated.