ReturnOrder

Implements

Connections

returnVerifications (ReturnVerificationConnection)

A list of return verifications for this return order.

Argument Type Description
ref [String!]

External reference for Return Order. Must be unique.

type [String!]
verificationDetails [String]

verification details

createdOn DateRange
updatedOn DateRange
first Int

Returns the first n elements from the list

last Int

Returns the last n elements from the list

before String

Returns the elements in the list that come before the specified global ID

after String

Returns the elements in the list that come after the specified global ID

returnOrderItems (ReturnOrderItemConnection)

The list of associated return order items.

Argument Type Description
ref [String!]

External reference for Return Order. Must be unique.

status [String!]

Status of the return order

product ProductLinkInput
orderItem OrderItemLinkInput
returnReasonComment [String]

An optional comment. Required if the reason code required further information such as 'Other'.

returnConditionComment [String]

An optional comment. Required if the condition code required further information such as 'Other'.

createdOn DateRange
updatedOn DateRange
first Int

Returns the first n elements from the list

last Int

Returns the last n elements from the list

before String

Returns the elements in the list that come before the specified global ID

after String

Returns the elements in the list that come after the specified global ID

returnOrderFulfilments (ReturnFulfilmentConnection)

The list of associated return fulfilments.

Argument Type Description
ref [String!]

External reference for Return Fulfilment. Must be unique.

workflow WorkflowLinkInput
type [String!]

Type of the return fulfilment

status [String!]

Status of the Return Fulfilment

lodgedLocation LocationLinkInput
destinationLocation LocationLinkInput
workflowRef [String]

DEPRECATED, please use the field workflow instead - The reference of the workflow.

workflowVersion [Int]

DEPRECATED, please use the field workflow instead - The version of the workflow.

createdOn DateRange
updatedOn DateRange
first Int

Returns the first n elements from the list

last Int

Returns the last n elements from the list

before String

Returns the elements in the list that come before the specified global ID

after String

Returns the elements in the list that come after the specified global ID

Fields

id (ID!)

ID of the object

createdOn (DateTime)

Date and time of creation

updatedOn (DateTime)

Date and time of last update

ref (String!)

External reference for ReturnOrder. Must be unique.

retailer (RetailerLink)

The associated retailer for this return order

workflow (WorkflowLink)

Workflow version of the return order

type (String!)

Type of the return order

status (String!)

Status of the Return Order

attributes ([Attribute])

List of attributes.

customer (CustomerLink)

The associated customer for this return order.

order (OrderLink)

The associated order for this return order.

returnAuthorisationKey (String)

The generated key representing an authorised return order which the customer can use to progress through the return order process.

returnAuthorisationDisposition (SettingValueType)

The authorised disposition for this return order. This can be different to the return disposition action which reflects the actual action once an item has been inspected.

returnAuthorisationKeyExpiry (DateTime)

The time at which the return authorisation expires.

pickupAddress (StreetAddress)

The pickup address in the cases of return orders that are being picked up by a carrier.

lodgedLocation (LocationLink)

The lodged location in cases where the return order was directly returned to a store or DC.

destinationLocation (LocationLink)

The destination of the return order items.

exchangeOrder (OrderLink)

The associated exchange order managed the exchange item.

creditMemo (CreditMemoLink)

The associated credit memo for this return order.

currency (CurrencyLink)

Reference to the currency type. Generally, the standard ISO-4217 is used.

defaultTaxType (TaxType)

The default Tax Type for this return order. Individual return order items can override.

subTotalAmount (AmountType)

The total amount of this return order excluding tax.

totalTax (AmountType)

The total amount of tax for this return order.

totalAmount (AmountType)

The total amount of this return order including tax

workflowRef (String)
Deprecation notice

No longer supported

DEPRECATED, please use the field workflow instead - The reference of the workflow.

workflowVersion (Int)
Deprecation notice

No longer supported

DEPRECATED, please use the field workflow instead - The version of the workflow.