ReturnRequest
A return request
Fields
25 fieldscursor•String!A unique cursor that can be used for pagination.
The ShippingServiceMethod 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.
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.
completedAt•DateTimeTzWhen the return request was completed.
createdAt•DateTimeTz!When the return request 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.
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.
id•ID!Unique primary key.
cursor•String!A unique cursor that can be used for pagination.
node•ReturnRequestLine!The ReturnRequestLine 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.
locale•StringBCP-47 locale used for communication templates
cursor•String!A unique cursor that can be used for pagination.
node•Order!The Order 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•ReturnReceipt!The ReturnReceipt 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.
reference•StringReference of the return request
cursor•String!A unique cursor that can be used for pagination.
node•ReturnRefund!The ReturnRefund 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.
remarks•StringRemarks about the return request
returnShippingPaymentStatus•ReturnShippingPaymentStatusPayment status for the customer return shipping contribution
FREEPAIDUNPAIDcurrency•String!ISO 4217 currency code
value•String!Amount
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.
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
cursor•String!A unique cursor that can be used for pagination.
node•Shipment!The Shipment 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.
status•ReturnRequestStatusStatus of the return request
ACCEPTEDCANCELEDCOMPLETEDDRAFTEXPIREDPENDINGRECEIVEDREFUNDREJECTEDcode•StringCode of an issued coupon / gift card
createdAt•DateTimeTzWhen the suggested return refund was created.
id•IDUnique primary key.
id•IDUnique primary key.
price•MoneyPrice per unit
quantity•Int!Quantity
returnRequestLine•ReturnRequestLine!Return request line
billingAddress•AddressBilling address of the order
brand•Brand!Brand of the order
canceledAt•DateTimeTzWhen the order was canceled.
createdAt•DateTimeTz!When the order was created.
customer•CustomerCustomer of the order
customsInvoiceNumber•StringInvoice number for customs
customsShipmentType•CustomsShipmentTypeShipment export type for customs
DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLEevents•EventConnection!Events related to this order
exceptions•OrderExceptionConnection!Exceptions related to this order
fulfillmentPreferences•OrderFulfillmentPreferencesFulfillment preferences of the order.
fulfillments•FulfillmentConnection!Fulfillments of the order
id•ID!Unique primary key.
integration•IntegrationIntegration of the order
integrationReference•StringIntegration reference of the order
isUpdatable•Boolean!Whether this order can be updated.
lines•OrderLineConnection!Order lines
locale•StringBCP-47 locale used for communication templates
metafields•MetafieldConnection!Metafields attached to this order
quantityAllocated•Int!Quantity allocated in to fulfillments
quantityOrdered•Int!Quantity ordered
quantityShipped•Int!Quantity (already) shipped
quantityUnallocated•Int!Quantity that is not (yet) allocated to a fulfillment
recipientAddress•AddressRecipient address of the order
reference•StringReference of the order
shipments•ShipmentConnection!Shipments
shippedAt•DateTimeTzWhen the order was shipped.
shippingPrice•MoneyShipping cost paid by the customer
status•OrderStatus!Status of the order
ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATEDtickets•SupportTicketAccessConnection!Support tickets linked to this order
updatedAt•DateTimeTz!When the order was last updated.
currency•String!ISO 4217 currency code
value•String!Amount
remarks•StringRefund remarks
availableShippingMethods•ShippingServiceMethodConnection!Shipping methods available for the reverse return route
brand•BrandBrand that is linked to this request
completedAt•DateTimeTzWhen the return request was completed.
createdAt•DateTimeTz!When the return request was created.
customer•CustomerCustomer that is linked to this request
events•EventConnection!Events related to this return request
id•ID!Unique primary key.
Lines of the return request
locale•StringBCP-47 locale used for communication templates
orders•OrderConnection!Orders that are related to this request
receipts•ReturnReceiptConnection!Receipts for this request
reference•StringReference of the return request
refunds•ReturnRefundConnection!Refunds of the return request
remarks•StringRemarks about the return request
returnShippingPaymentStatus•ReturnShippingPaymentStatusPayment status for the customer return shipping contribution
FREEPAIDUNPAIDreturnShippingPrice•MoneyCustomer contribution for return shipment
returnShippingServiceMethod•ShippingServiceMethodRequested return shipping service method
senderAddress•AddressSender address for this return
shipments•ShipmentConnection!Shipments related to this return request
status•ReturnRequestStatusStatus of the return request
ACCEPTEDCANCELEDCOMPLETEDDRAFTEXPIREDPENDINGRECEIVEDREFUNDREJECTEDsuggestedRefunds•[SuggestedReturnRefund!]!Refunds suggested for this return request
tickets•SupportTicketAccessConnection!Support tickets linked to this return request
updatedAt•DateTimeTz!When the return request was last updated.
currency•String!ISO 4217 currency code
value•String!Amount
updatedAt•DateTimeTzWhen the suggested return refund was last updated.
cursor•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.
updatedAt•DateTimeTz!When the return request was last updated.