returnRefund
Find a single return refund by an identifying attribute.
Arguments
1 argumentid•IDSearch by primary key.
Possible return
description•String!Description of the adjustment
id•ID!Unique primary key.
currency•String!ISO 4217 currency code
value•String!Amount
code•StringCode of an issued coupon / gift card
createdAt•DateTimeTz!When the return refund was created.
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.
id•ID!Unique primary key.
price•MoneyPrice per unit
quantity•Int!Quantity
returnRequestLine•ReturnRequestLine!Return request line
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.
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
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•DateTimeTzWhen the order was canceled.
createdAt•DateTimeTz!When the order 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_GOODSSAMPLEcursor•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•OrderException!The OrderException 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.
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.
cursor•String!A unique cursor that can be used for pagination.
node•Fulfillment!The Fulfillment 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.
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
integrationReference•String!Reference provided by the integration
name•String!Profile name
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.
cursor•String!A unique cursor that can be used for pagination.
node•OrderLine!The OrderLine 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•Metafield!The Metafield 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.
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
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.
shippedAt•DateTimeTzWhen the order was shipped.
currency•String!ISO 4217 currency code
value•String!Amount
status•OrderStatus!Status of the order
ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATEDcursor•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 order was last updated.
currency•String!ISO 4217 currency code
value•String!Amount
remarks•StringRefund remarks
cursor•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
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.
currency•String!ISO 4217 currency code
value•String!Amount
updatedAt•DateTimeTz!When the return refund was last updated.