returnRequest
Find a single return request by an identifying attribute.
Arguments
1 argumentid•IDSearch by primary key.
Possible return
cursor•String!A unique cursor that can be used for pagination.
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.
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
cursor•String!A unique cursor that can be used for pagination.
node•BrandPortal!The BrandPortal 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.
The CommunicationTemplate 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 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.
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.
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
cursor•String!A unique cursor that can be used for pagination.
node•ReturnRequest!The ReturnRequest 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.
returnRequestsCount•Int!Customer return requests count
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.
shipmentsCount•Int!Customer shipments count
updatedAt•DateTimeTz!When the customer was last updated.
cursor•String!A unique cursor that can be used for pagination.
code•EventCodeEvent code
fulfillment_internal_label_generatedfulfillment_pickedfulfillment_pickingfulfillment_picklist_createdfulfillment_picklist_deletedfulfillment_shippedintegration_synchronization_failedintegration_updatedorder_address_corrected_consumerorder_address_incorrect_notificationorder_canceledorder_createdorder_exception_ignoredorder_holdorder_hold_releaseorder_shippedproduct_updatedpurchase_order_createdpurchase_order_status_orderedreturn_receipt_completedreturn_refund_deletedreturn_refund_errorreturn_refund_status_completedreturn_refund_status_createdreturn_refund_status_requestedreturn_request_createdreturn_request_status_acceptedreturn_request_status_canceledreturn_request_status_completedreturn_request_status_pendingreturn_request_status_rejectedshipment_canceledshipment_createdshipment_errorshipment_generatedshipment_readyshipment_requestedcreatedAt•DateTimeTz!When the event was created
createdBy•EventCreatorWho created this event
id•ID!Unique primary key
message•StringEvent message
occurredAt•DateTimeTz!When the event occurred
shippingStatus•ShippingStatusShipping status associated with this event
updatedAt•DateTimeTz!When the event was last updated
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.
createdAt•DateTimeTz!When the return request line was created.
id•ID!Unique primary key.
orderLine•OrderLineRelated order line
product•ProductRelated product
quantityExpected•Int!Quantity expected
quantityReceived•Int!Quantity received
quantityRefunded•Int!Quantity refunded of the return request line.
remarks•StringRemarks about the received items
returnReason•ReturnReasonReturn reason
subReturnReason•ReturnReasonSub return reason
updatedAt•DateTimeTz!When the return request line was last updated.
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.
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.
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.
attachments•ReturnReceiptAttachmentConnection!Attachments of the return receipt
completedAt•DateTimeTzWhen the return receipt was completed.
createdAt•DateTimeTz!When the return receipt was created.
id•ID!Unique primary key.
Lines of the return receipt
remarks•StringRemarks about the return receipt
returnRequest•ReturnRequest!Linked return request
undeliverableReturnReason•UndeliverableReturnReasonReason why the return was undeliverable
ADDRESS_INCORRECTDAMAGEDNOT_COLLECTED_AT_PICKUP_POINTNOT_HOMEOTHERREFUSEDupdatedAt•DateTimeTz!When the return receipt was last updated.
warehouse•Warehouse!Warehouse that handled this receipt
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.
adjustments•[ReturnRefundAdjustment!]Adjustment of the return refund
code•StringCode of an issued coupon / gift card
createdAt•DateTimeTz!When the return refund was created.
events•EventConnection!Events related to this return refund
id•ID!Unique primary key.
Lines of the return refund
order•OrderOrder associated with this refund (for integration method)
price•MoneyTotal value of refund
remarks•StringRefund remarks
returnRequest•ReturnRequest!Receipts for this refund
shippingPrice•MoneyShipping cost included to refund
updatedAt•DateTimeTz!When the return refund was last updated.
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
cursor•String!A unique cursor that can be used for pagination.
The ShippingServiceMethodCountry 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 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
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.
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.
barcode•StringBarcode of the shipment
brand•Brand!Brand linked to this shipment
canceledAt•DateTimeWhen the shipment was canceled.
carrier•Carrier!Carrier used for the shipment
contents•ShipmentContentConnection!Contents of the shipment for customs
createdAt•DateTimeTz!When the shipment was created.
customer•CustomerCustomer line linked to shipment
customsInvoiceNumber•StringInvoice number for customs
customsShipmentType•CustomsShipmentTypeShipment export type for customs
DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLEdeliveryAddress•AddressDelivery address of the shipment
events•EventConnection!Events related to this shipment
files•ShipmentFileConnection!Files of the shipment
id•ID!Unique primary key.
insuranceAmount•MoneyAmount for which the shipment is insured
labelType•StringRequested label type of the shipment
pieces•ShipmentPieceConnection!Pieces of the shipment
piecesCount•IntNumber of pieces
recipientAddress•AddressRecipient address of the shipment
reference•StringReference of the shipment
returnAddress•Address!Return address of the shipment
senderAddress•Address!Sender address of the shipment
shippingPhase•ShippingPhaseShipping phase of the shipment.
shippingService•ShippingServiceShipping service
shippingServiceMethod•ShippingServiceMethodShipping service method
shippingStatus•ShippingStatusLatest carrier shipping status of the shipment.
status•ShipmentStatus!Status of the shipment
CANCELEDCREATEDERRORGENERATEDGENERATINGPRINTEDREQUESTEDSHIPPEDtickets•SupportTicketAccessConnection!Support tickets linked to this shipment
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.
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.
currency•String!ISO 4217 currency code
value•String!Amount
quantity•Int!Quantity
createdAt•DateTimeTz!When the return request line was created.
id•ID!Unique primary key.
orderLine•OrderLineRelated order line
product•ProductRelated product
quantityExpected•Int!Quantity expected
quantityReceived•Int!Quantity received
quantityRefunded•Int!Quantity refunded of the return request line.
remarks•StringRemarks about the received items
returnReason•ReturnReasonReturn reason
subReturnReason•ReturnReasonSub return reason
updatedAt•DateTimeTz!When the return request line 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
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•DateTimeTzWhen the order was canceled.
createdAt•DateTimeTz!When the order 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_GOODSSAMPLEedges•[EventEdge!]!A list of Event edges.
pageInfo•PageInfo!Pagination information about the list of edges.
edges•[OrderExceptionEdge!]!A list of OrderException edges.
pageInfo•PageInfo!Pagination information about the list of edges.
allocationStrategy•OrderAllocationStrategyAllocation strategy of the order fulfillment preferences.
BULK_NON_PICKABLEFEFOLEFOfulfillmentMode•FulfillmentModeFulfillment mode of the order fulfillment preferences.
DELIVERYLOCAL_PICKUPprintPackingSlip•BooleanPrint packing slip of the order fulfillment preferences.
returnShippingServiceMethodId•IDID of the return shipping service method.
shippingServiceMethodId•IDID of the shipping service method.
edges•[FulfillmentEdge!]!A list of Fulfillment edges.
pageInfo•PageInfo!Pagination information about the list of edges.
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.
integrationReference•StringIntegration reference of the order
isUpdatable•Boolean!Whether this order can be updated.
edges•[OrderLineEdge!]!A list of OrderLine edges.
pageInfo•PageInfo!Pagination information about the list of edges.
locale•StringBCP-47 locale used for communication templates
edges•[MetafieldEdge!]!A list of Metafield edges.
pageInfo•PageInfo!Pagination information about the list of edges.
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
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 order
edges•[ShipmentEdge!]!A list of Shipment edges.
pageInfo•PageInfo!Pagination information about the list of edges.
shippedAt•DateTimeTzWhen the order was shipped.
currency•String!ISO 4217 currency code
value•String!Amount
status•OrderStatus!Status of the order
ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATEDA list of SupportTicketAccess edges.
pageInfo•PageInfo!Pagination information about the list of edges.
updatedAt•DateTimeTz!When the order was last updated.
currency•String!ISO 4217 currency code
value•String!Amount
remarks•StringRefund remarks
returnRequest•ReturnRequest!Linked return request
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.