createReturnOrder

Creates a 'Return order'

Input fields

input (CreateReturnOrderInput)

Return 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.