ShipmentCancelPayload
The response for the mutation containing the result and user errors.
Fields
2 fieldsbarcode•StringBarcode of the shipment
avatar•AvatarAvatar of the brand.
brandPortals•BrandPortalConnection!Brand portals configured for this brand
communicationTemplates•CommunicationTemplateConnection!Sparse localized overrides configured for this brand.
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
logoPrint•AvatarLogo print of the brand.
logoScreen•AvatarLogo screen of the brand.
name•String!Name of the brand
returnAddress•AddressReturn address of the brand.
senderAddress•AddressSender address 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
edges•[ShipmentContentEdge!]!A list of ShipmentContent edges.
pageInfo•PageInfo!Pagination information about the list of edges.
createdAt•DateTimeTz!When the shipment was created.
billingAddress•AddressBilling address of the customer
createdAt•DateTimeTz!When the customer was created.
id•ID!Unique primary key.
orders•OrderConnection!Customer orders
ordersCount•Int!Customer orders count
recipientAddress•AddressRecipient address of the customer
reference•StringReference of the customer
returnRequests•ReturnRequestConnection!Customer return requests
returnRequestsCount•Int!Customer return requests count
shipments•ShipmentConnection!Customer shipments
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
edges•[EventEdge!]!A list of Event 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.
id•ID!Unique primary key.
currency•String!ISO 4217 currency code
value•String!Amount
labelType•StringRequested label type of the shipment
edges•[ShipmentPieceEdge!]!A list of ShipmentPiece edges.
pageInfo•PageInfo!Pagination information about the list of edges.
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
carrier•Carrier!Carrier that is linked to the shipping service
createdAt•DateTimeTz!When the shipping service was created.
id•ID!Unique primary key.
integration•IntegrationIntegration that provided this shipping service
isEnabled•Boolean!Enabled
methods•ShippingServiceMethodConnection!The methods associated with this shipping service.
name•String!Name of the shipping service
type•String!Type of shipping service
updatedAt•DateTimeTz!When the shipping service was last updated.
carrier•Carrier!Carrier that handles this shipping service method
countries•ShippingServiceMethodCountryConnection!Supported countries for this shipping method
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
shippingService•ShippingService!Shipping service that contains this 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
shippingPhase•ShippingPhaseShipping phase this status belongs to
updatedAt•DateTimeTz!When the status was last updated
status•ShipmentStatus!Status of the shipment
CANCELEDCREATEDERRORGENERATEDGENERATINGPRINTEDREQUESTEDSHIPPEDA list of SupportTicketAccess edges.
pageInfo•PageInfo!Pagination information about the list of edges.
trackingCode•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.
field•[String!]message•String!