Return line

Definition

Lines on a return shipment.

ReturnShipmentLine

Constraints

You must provide either an id or a SKU for a trade item. You must provide either an id or a number of a return shipment.

Fields

Id

Unique identification of this return line across areas and subscriptions.

id Long Read only

Customer no.

Number of the customer returning the items.

customerNumber String Read only

Return shipment

Number of the return shipment that this line belongs to.

returnShipmentNumber String ReturnShipment

returnShipmentLine.stockKeepingUnit

returnShipmentLine.stockKeepingUnit.description

stockKeepingUnit String GlobalTradeItem

Variant

Variant that is returned.

productVariantKey ProductVariantKey Read only

Trade item id

Unique identification of the item returned.

globalTradeItemId Long GlobalTradeItem

GTIN

GTIN for the item returned.

globalTradeItemNumber String Read only

Product id

Unique identification of the product returned.

productId Long Read only Product

Area id

Unique identification of the area the line belongs to.

contextId Long Context

Customer id

Unique identification of the customer returning the items.

customerId Long Read only Customer

Return shipment no.

Unique identification of the return shipment this line belongs to.

returnShipmentId Long ReturnShipment

Product no.

Number of the product returned.

productNumber String Read only

Product name

Name of the product being returned.

productName String Read only

Return reason

The reason that these items were returned by the customer.

returnReason ReturnReason

Expected qty.

The number of items that we expect to receive.

numItemsExpected Long

Received qty.

The number of items received.

numItemsReceived Integer Read only

Num. transactions

Number of transactions made toward this return line.

numTransactions Integer Read only

Notes on reception

Notes to be observed on reception of items.

notesOnReception String

Expected status

The status that we expect the items to have when we receive them.

lotStatusOnArrival GlobalTradeItemLotStatus

Refund

Refund to give to customer with regard to this line.

refund BigDecimal

Currency code

Currency code of the return shipment that this line belongs to.

currencyCode CurrencyCode Read only

returnShipmentLine.currencyExchangeRate

returnShipmentLine.currencyExchangeRate.description

currencyExchangeRate BigDecimal Read only

Filter

SKU

Only show lines related to items with SKU matching this expression.

stockKeepingUnitMatch String

No receipt

Only show lines related to return shipments for which no receipt has yet been made.

onlyNoReturnReceipt Boolean