GraphQL API
Organization API
Organization / Types/ object

ReturnRefundUpdatePayload

The response for the mutation containing the result and user errors.

Fields

2 fields
descriptionString!

Description of the adjustment

idID!

Unique primary key.

priceMoney

Price / value of adjustment

codeString

Code of an issued coupon / gift card

createdAtDateTimeTz!

When the return refund was created.

A list of Event edges.

pageInfoPageInfo!

Pagination information about the list of edges.

idID!

Unique primary key.

A list of ReturnRefundLine edges.

pageInfoPageInfo!

Pagination information about the list of edges.

Method of refund

INTEGRATIONMANUAL
billingAddressAddress

Billing address of the order

brandBrand!

Brand of the order

canceledAtDateTimeTz

When the order was canceled.

createdAtDateTimeTz!

When the order was created.

customerCustomer

Customer of the order

customsInvoiceNumberString

Invoice number for customs

customsShipmentTypeCustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE

Events related to this order

Exceptions related to this order

fulfillmentPreferencesOrderFulfillmentPreferences

Fulfillment preferences of the order.

fulfillmentsFulfillmentConnection!

Fulfillments of the order

idID!

Unique primary key.

integrationIntegration

Integration of the order

integrationReferenceString

Integration reference of the order

isUpdatableBoolean!

Whether this order can be updated.

Order lines

localeString

BCP-47 locale used for communication templates

Metafields attached to this order

quantityAllocatedInt!

Quantity allocated in to fulfillments

quantityOrderedInt!

Quantity ordered

quantityShippedInt!

Quantity (already) shipped

quantityUnallocatedInt!

Quantity that is not (yet) allocated to a fulfillment

recipientAddressAddress

Recipient address of the order

referenceString

Reference of the order

Shipments

shippedAtDateTimeTz

When the order was shipped.

shippingPriceMoney

Shipping cost paid by the customer

statusOrderStatus!

Status of the order

ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATED

Support tickets linked to this order

updatedAtDateTimeTz!

When the order was last updated.

currencyString!

ISO 4217 currency code

valueString!

Amount

remarksString

Refund remarks

availableShippingMethodsShippingServiceMethodConnection!

Shipping methods available for the reverse return route

brandBrand

Brand that is linked to this request

completedAtDateTimeTz

When the return request was completed.

createdAtDateTimeTz!

When the return request was created.

customerCustomer

Customer that is linked to this request

Events related to this return request

idID!

Unique primary key.

Lines of the return request

localeString

BCP-47 locale used for communication templates

Orders that are related to this request

Receipts for this request

referenceString

Reference of the return request

refundTypeReturnRefundType

Requested refund type

COUPONEXCHANGEGIFT_CARDMONEY

Refunds of the return request

remarksString

Remarks about the return request

returnMethodReturnMethod

Return method of the return request

DROP_OFF_POINTOWN_CARRIERPICKUPSTORE
returnShippingPaymentStatusReturnShippingPaymentStatus

Payment status for the customer return shipping contribution

FREEPAIDUNPAID
returnShippingPriceMoney

Customer contribution for return shipment

returnShippingServiceMethodShippingServiceMethod

Requested return shipping service method

senderAddressAddress

Sender address for this return

Shipments related to this return request

Status of the return request

ACCEPTEDCANCELEDCOMPLETEDDRAFTEXPIREDPENDINGRECEIVEDREFUNDREJECTED
suggestedRefunds[SuggestedReturnRefund!]!

Refunds suggested for this return request

Support tickets linked to this return request

updatedAtDateTimeTz!

When the return request was last updated.

currencyString!

ISO 4217 currency code

valueString!

Amount

Status of the return refund

COMPLETEDCREATEDERRORPENDINGREQUESTED

Type of the refund

COUPONEXCHANGEGIFT_CARDMONEY
updatedAtDateTimeTz!

When the return refund was last updated.

field[String!]
messageString!