shipmentCancel
Cancel a shipment
Arguments
1 argumentid•ID!ID of the shipment.
Possible return
barcode•StringBarcode of the shipment
url•String!Url of the avatar
edges•[BrandPortalEdge!]!A list of BrandPortal edges.
pageInfo•PageInfo!Pagination information about the list of edges.
A list of CommunicationTemplate edges.
pageInfo•PageInfo!Pagination information about the list of edges.
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
url•String!Url of the avatar
url•String!Url of the avatar
name•String!Name of the brand
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
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
cursor•String!A unique cursor that can be used for pagination.
node•ShipmentContent!The ShipmentContent node.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
createdAt•DateTimeTz!When the shipment was created.
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
createdAt•DateTimeTz!When the customer was created.
id•ID!Unique primary key.
edges•[OrderEdge!]!A list of Order edges.
pageInfo•PageInfo!Pagination information about the list of edges.
ordersCount•Int!Customer orders count
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 customer
edges•[ReturnRequestEdge!]!A list of ReturnRequest edges.
pageInfo•PageInfo!Pagination information about the list of edges.
returnRequestsCount•Int!Customer return requests count
edges•[ShipmentEdge!]!A list of Shipment edges.
pageInfo•PageInfo!Pagination information about the list of edges.
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
cursor•String!A unique cursor that can be used for pagination.
node•Event!The Event node.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
cursor•String!A unique cursor that can be used for pagination.
node•ShipmentFile!The ShipmentFile node.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
id•ID!Unique primary key.
currency•String!ISO 4217 currency code
value•String!Amount
labelType•StringRequested label type of the shipment
cursor•String!A unique cursor that can be used for pagination.
node•ShipmentPiece!The ShipmentPiece node.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
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
code•String!Code of the carrier
logoUrl•StringLogo URL
name•String!Name
trackingUrl•StringRegular tracking URL
createdAt•DateTimeTz!When the shipping service was created.
id•ID!Unique primary key.
createdAt•DateTimeTz!When the integration was created.
id•ID!Unique primary key.
isEnabled•Boolean!Synchronization enabled
isOrderSyncEnabled•Boolean!Order sync enabled
isProductSyncEnabled•Boolean!Product sync enabled
isStockSyncEnabled•Boolean!Stock sync enabled
name•String!Name of the integration
orderSyncUpdatedAt•DateTimeTzWhen the last order was updated at the integration while syncing
paymentProfiles•[IntegrationPaymentProfile!]!Payment profiles exposed by the integration
productSyncUpdatedAt•DateTimeTzWhen the last product was updated at the integration while syncing
productsCount•Int!Number of products linked to this integration.
updatedAt•DateTimeTz!When the integration was last updated.
isEnabled•Boolean!Enabled
A list of ShippingServiceMethod edges.
pageInfo•PageInfo!Pagination information about the list of edges.
name•String!Name of the shipping service
type•String!Type of shipping service
updatedAt•DateTimeTz!When the shipping service was last updated.
code•String!Code of the carrier
logoUrl•StringLogo URL
name•String!Name
trackingUrl•StringRegular tracking URL
A list of ShippingServiceMethodCountry edges.
pageInfo•PageInfo!Pagination information about the list of edges.
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
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.
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
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
updatedAt•DateTimeTz!When the status was last updated
status•ShipmentStatus!Status of the shipment
CANCELEDCREATEDERRORGENERATEDGENERATINGPRINTEDREQUESTEDSHIPPEDcursor•String!A unique cursor that can be used for pagination.
node•SupportTicketAccess!The SupportTicketAccess node.
endCursor•StringThe cursor to continue paginating forwards.
hasNextPage•Boolean!When paginating forwards, are there more items?
hasPreviousPage•Boolean!When paginating backwards, are there more items?
startCursor•StringThe cursor to continue paginating backwards.
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!