ShipmentEdge
An edge that contains a node of type Shipment and a cursor.
Fields
2 fieldsid•ID!Unique primary key.
barcode•StringBarcode of the shipment
trackingCode•StringTracking code of the shipment
trackingUrl•StringTracking url of the shipment
labelType•StringRequested label type of the shipment
piecesCount•IntNumber of pieces
reference•StringReference of the shipment
currency•String!ISO 4217 currency code
value•String!Amount
status•ShipmentStatus!Status of the shipment
CANCELEDCREATEDERRORGENERATINGGENERATEDPRINTEDREQUESTEDSHIPPEDtype•String!Type of the shipment
customsInvoiceNumber•StringInvoice number for customs
customsShipmentType•CustomsShipmentTypeShipment export type for customs
DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLEcreatedAt•DateTimeTz!When the shipment was created.
updatedAt•DateTimeTz!When the shipment was last updated.
canceledAt•DateTimeWhen the shipment was canceled.
id•ID!Unique primary key.
name•String!Name of the brand
customsShipmentType•CustomsShipmentTypeDefault customs shipment to use for shipments
DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLEcustomsUseReferenceIfInvoiceNumberEmpty•Boolean!Use reference if invoice number is empty
inboundGBEori•StringImport EORI for GB
inboundGBVat•StringImport VAT number for GB
createdAt•DateTimeTz!When the brand was created.
updatedAt•DateTimeTz!When the brand was last updated.
avatar•AvatarAvatar of the brand.
logoPrint•AvatarLogo print of the brand.
logoScreen•AvatarLogo screen of the brand.
senderAddress•AddressSender address of the brand.
returnAddress•AddressReturn address of the brand.
brandPortals•BrandPortalConnection!Brand portals configured for this brand
communicationTemplates•CommunicationTemplateConnection!Sparse localized overrides configured for this brand.
id•ID!Unique primary key.
reference•StringReference of the customer
billingAddress•AddressBilling address of the customer
recipientAddress•AddressRecipient address of the customer
createdAt•DateTimeTz!When the customer was created.
updatedAt•DateTimeTz!When the customer was last updated.
ordersCount•Int!Customer orders count
returnRequestsCount•Int!Customer return requests count
shipmentsCount•Int!Customer shipments count
orders•OrderConnection!Customer orders
returnRequests•ReturnRequestConnection!Customer return requests
shipments•ShipmentConnection!Customer shipments
code•String!Code of the carrier
name•String!Name
logoUrl•StringLogo URL
trackingUrl•StringRegular tracking URL
id•ID!Unique primary key.
companyName•StringCompany name
name•StringName
address•StringStreet / first address line
address2•StringSecond address line
houseNumber•StringHouse number
postalCode•StringPostal code
city•StringCity
stateCode•StringState code
countryCode•String!Country code
email•StringEmail address
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
eori•StringEORI
vat•StringVAT number
oss•StringOne-Stop Shop (OSS) number
formattedLines•String!Formatted address
id•ID!Unique primary key.
companyName•StringCompany name
name•StringName
address•StringStreet / first address line
address2•StringSecond address line
houseNumber•StringHouse number
postalCode•StringPostal code
city•StringCity
stateCode•StringState code
countryCode•String!Country code
email•StringEmail address
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
eori•StringEORI
vat•StringVAT number
oss•StringOne-Stop Shop (OSS) number
formattedLines•String!Formatted address
id•ID!Unique primary key.
companyName•StringCompany name
name•StringName
address•StringStreet / first address line
address2•StringSecond address line
houseNumber•StringHouse number
postalCode•StringPostal code
city•StringCity
stateCode•StringState code
countryCode•String!Country code
email•StringEmail address
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
eori•StringEORI
vat•StringVAT number
oss•StringOne-Stop Shop (OSS) number
formattedLines•String!Formatted address
id•ID!Unique primary key.
companyName•StringCompany name
name•StringName
address•StringStreet / first address line
address2•StringSecond address line
houseNumber•StringHouse number
postalCode•StringPostal code
city•StringCity
stateCode•StringState code
countryCode•String!Country code
email•StringEmail address
phone•StringPhone number
phoneE164•StringPhone number in E.164 format
eori•StringEORI
vat•StringVAT number
oss•StringOne-Stop Shop (OSS) number
formattedLines•String!Formatted address
code•String!Phase code
name•String!Phase name
description•StringPhase description
createdAt•DateTimeTz!When the phase was created
updatedAt•DateTimeTz!When the phase was last updated
id•ID!Unique primary key.
name•String!Name of the shipping service
isEnabled•Boolean!Enabled
type•String!Type of shipping service
createdAt•DateTimeTz!When the shipping service was created.
updatedAt•DateTimeTz!When the shipping service was last updated.
carrier•Carrier!Carrier that is linked to the shipping service
integration•IntegrationIntegration that provided this shipping service
methods•ShippingServiceMethodConnection!The methods associated with this shipping service.
id•ID!Unique primary key.
name•String!Name of the shipping service method
isCancelable•Boolean!Whether or not shipment (labels) are cancelable
isEnabled•Boolean!Enabled
type•String!Type type
createdAt•DateTimeTz!When the shipping service was created.
updatedAt•DateTimeTz!When the shipping service was last updated.
shippingService•ShippingService!Shipping service that contains this method
carrier•Carrier!Carrier that handles this shipping service method
countries•ShippingServiceMethodCountryConnection!Supported countries for this shipping method
pageInfo•PageInfo!Pagination information about the list of edges.
edges•[EventEdge!]!A list of Event edges.
pageInfo•PageInfo!Pagination information about the list of edges.
edges•[ShipmentContentEdge!]!A list of ShipmentContent edges.
pageInfo•PageInfo!Pagination information about the list of edges.
edges•[ShipmentFileEdge!]!A list of ShipmentFile edges.
pageInfo•PageInfo!Pagination information about the list of edges.
edges•[ShipmentPieceEdge!]!A list of ShipmentPiece edges.
pageInfo•PageInfo!Pagination information about the list of edges.
A list of SupportTicketAccess edges.
cursor•String!A unique cursor that can be used for pagination.