ReturnRefundCreatePayload
The response for the mutation containing the result and user errors.
Fields
2 fieldsdescription•String!Description of the adjustment
id•ID!Unique primary key.
price•MoneyPrice / value of adjustment
code•StringCode of an issued coupon / gift card
createdAt•DateTimeTz!When the return refund was created.
edges•[EventEdge!]!A list of Event edges.
pageInfo•PageInfo!Pagination information about the list of edges.
id•ID!Unique primary key.
edges•[ReturnRefundLineEdge!]!A list of ReturnRefundLine edges.
pageInfo•PageInfo!Pagination information about the list of edges.
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•DateTimeTz!When the return refund was last updated.
field•[String!]message•String!