GraphQL API
Organization API
Organization / Types/ object

ReturnRequestUpdatePayload

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

Fields

2 fields

A list of ShippingServiceMethod edges.

pageInfoPageInfo!

Pagination information about the list of edges.

avatarAvatar

Avatar of the brand.

brandPortalsBrandPortalConnection!

Brand portals configured for this brand

communicationTemplatesCommunicationTemplateConnection!

Sparse localized overrides configured for this brand.

createdAtDateTimeTz!

When the brand was created.

customsShipmentTypeCustomsShipmentType

Default customs shipment to use for shipments

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE
customsUseReferenceIfInvoiceNumberEmptyBoolean!

Use reference if invoice number is empty

idID!

Unique primary key.

inboundGBEoriString

Import EORI for GB

inboundGBVatString

Import VAT number for GB

logoPrintAvatar

Logo print of the brand.

logoScreenAvatar

Logo screen of the brand.

nameString!

Name of the brand

returnAddressAddress

Return address of the brand.

senderAddressAddress

Sender address of the brand.

updatedAtDateTimeTz!

When the brand was last updated.

completedAtDateTimeTz

When the return request was completed.

createdAtDateTimeTz!

When the return request was created.

billingAddressAddress

Billing address of the customer

createdAtDateTimeTz!

When the customer was created.

idID!

Unique primary key.

Customer orders

ordersCountInt!

Customer orders count

recipientAddressAddress

Recipient address of the customer

referenceString

Reference of the customer

returnRequestsReturnRequestConnection!

Customer return requests

returnRequestsCountInt!

Customer return requests count

Customer shipments

shipmentsCountInt!

Customer shipments count

updatedAtDateTimeTz!

When the customer was last updated.

A list of Event edges.

pageInfoPageInfo!

Pagination information about the list of edges.

idID!

Unique primary key.

A list of ReturnRequestLine edges.

pageInfoPageInfo!

Pagination information about the list of edges.

localeString

BCP-47 locale used for communication templates

A list of Order edges.

pageInfoPageInfo!

Pagination information about the list of edges.

A list of ReturnReceipt edges.

pageInfoPageInfo!

Pagination information about the list of edges.

referenceString

Reference of the return request

refundTypeReturnRefundType

Requested refund type

COUPONEXCHANGEGIFT_CARDMONEY

A list of ReturnRefund edges.

pageInfoPageInfo!

Pagination information about the list of edges.

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
currencyString!

ISO 4217 currency code

valueString!

Amount

carrierCarrier!

Carrier that handles this shipping service method

Supported countries for this shipping method

createdAtDateTimeTz!

When the shipping service was created.

idID!

Unique primary key.

isCancelableBoolean!

Whether or not shipment (labels) are cancelable

isEnabledBoolean!

Enabled

nameString!

Name of the shipping service method

shippingServiceShippingService!

Shipping service that contains this method

typeString!

Type type

updatedAtDateTimeTz!

When the shipping service was last updated.

addressString

Street / first address line

address2String

Second address line

cityString

City

companyNameString

Company name

countryCodeString!

Country code

emailString

Email address

eoriString

EORI

formattedLinesString!

Formatted address

houseNumberString

House number

idID!

Unique primary key.

nameString

Name

ossString

One-Stop Shop (OSS) number

phoneString

Phone number

phoneE164String

Phone number in E.164 format

postalCodeString

Postal code

stateCodeString

State code

vatString

VAT number

A list of Shipment edges.

pageInfoPageInfo!

Pagination information about the list of edges.

Status of the return request

ACCEPTEDCANCELEDCOMPLETEDDRAFTEXPIREDPENDINGRECEIVEDREFUNDREJECTED
codeString

Code of an issued coupon / gift card

createdAtDateTimeTz

When the suggested return refund was created.

idID

Unique primary key.

Lines of the suggested return refund

Method of refund

INTEGRATIONMANUAL
orderOrder

Order associated with this suggested refund

priceMoney

Total value of refund

remarksString

Refund remarks

returnRequestReturnRequest!

Linked return request

shippingPriceMoney

Shipping cost included to refund

Status of the suggested return refund

COMPLETEDCREATEDERRORPENDINGREQUESTED

Type of the refund

COUPONEXCHANGEGIFT_CARDMONEY
updatedAtDateTimeTz

When the suggested return refund was last updated.

A list of SupportTicketAccess edges.

pageInfoPageInfo!

Pagination information about the list of edges.

updatedAtDateTimeTz!

When the return request was last updated.

field[String!]
messageString!