returnRefundCreate
Create a new return refund
Arguments
1 argumentdescription•String!Description of the adjustment
price•MoneyInput!Price / value of adjustment
price•MoneyInputPrice per unit
quantity•Int!Quantity
returnRequestLineId•ID!ID of the return request line
orderId•IDID of the order (required for integration method)
currency•String!ISO 4217 currency code
value•String!Amount
remarks•StringRefund remarks
returnRequestId•ID!ID of the return request
currency•String!ISO 4217 currency code
value•String!Amount
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.
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•ReturnRefundLine!The ReturnRefundLine 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.
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
A list of ShippingServiceMethod edges.
pageInfo•PageInfo!Pagination information about the list of edges.
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.
completedAt•DateTimeTzWhen the return request was completed.
createdAt•DateTimeTz!When the return request 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.
edges•[EventEdge!]!A list of Event edges.
pageInfo•PageInfo!Pagination information about the list of edges.
id•ID!Unique primary key.
A list of ReturnRequestLine edges.
pageInfo•PageInfo!Pagination information about the list of edges.
locale•StringBCP-47 locale used for communication templates
edges•[OrderEdge!]!A list of Order edges.
pageInfo•PageInfo!Pagination information about the list of edges.
edges•[ReturnReceiptEdge!]!A list of ReturnReceipt edges.
pageInfo•PageInfo!Pagination information about the list of edges.
reference•StringReference of the return request
edges•[ReturnRefundEdge!]!A list of ReturnRefund edges.
pageInfo•PageInfo!Pagination information about the list of edges.
remarks•StringRemarks about the return request
returnShippingPaymentStatus•ReturnShippingPaymentStatusPayment status for the customer return shipping contribution
FREEPAIDUNPAIDcurrency•String!ISO 4217 currency code
value•String!Amount
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.
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
edges•[ShipmentEdge!]!A list of Shipment edges.
pageInfo•PageInfo!Pagination information about the list of edges.
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.
Lines of the suggested return refund
order•OrderOrder associated with this suggested refund
price•MoneyTotal value of refund
remarks•StringRefund remarks
returnRequest•ReturnRequest!Linked return request
shippingPrice•MoneyShipping cost included to refund
updatedAt•DateTimeTzWhen the suggested return refund was last updated.
A list of SupportTicketAccess edges.
pageInfo•PageInfo!Pagination information about the list of edges.
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.
field•[String!]message•String!