Thetis IMS
Datakatalog

Return shipment

Definition

A return shipment is made up of items returned at the same time by a given customer.

ReturnShipment

Constraints

You must supply either an id or a number of a customer. It is not possible to have more than 1000 lines on a return shipment.

Fields

Cancelled

Indicates that this return shipment was cancelled and never will be received.

cancelled

Context id

Unique identification of the context this return shipment is created in.

contextId

CurrencyCode

CurrencyCode.

currencyCode

CurrencyExchangeRate

CurrencyExchangeRate.

currencyExchangeRate
DecimalMax value: 999999.999999
DecimalMin value: 0.000001

Customer address

Adress of the customer returning items.

customerAddress
Read only

Customer id

Unique identification of the customer returning the items.

customerId
NotNull

Customer no.

The number of the customer who returned the items.

customerNumber
NotNull

Data document

JSON document containing additional information about this return shipment.

dataDocument
JSON

Id

Unique identification of the return shipment across subscriptions and contexts.

id
Read only

Notes

Notes related to this return shipment.

notes

On-hold

Indicates that this return shipment is on-hold and not yet ready to be received.

onHold

Receipt id

Unique identification of the receipt made after the reception of the items.

returnReceiptId
Read only

Receipt number

The number of the receipt created after receiving the items.

returnReceiptNumber
Read only

Return receipt time

Time of the creation of the receipt for this return shipment.

returnReceiptTimeCreated
Format pattern: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
Read only

Return lines

Lines describing the items that are or will be returned.

returnShipmentLines

No.

Unique identification of this return shipment within the context.

returnShipmentNumber
Unique
Pattern pattern: ^[^\t\n\x0B\f\r]*$
Size max: 36 min: 1
NotBlank

Shipment id

Unique identification of the shipment that the returned items were part.

shipmentId

Shipment

Number of the shipment that these items were originally included in.

shipmentNumber

Created

The time of creation of this return receipt.

timeCreated
Format pattern: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
Read only

Fields in filter

Created

Only show return shipments created within this time interval.

createdWithinCommonTimeInterval CommonTimeInterval

Kunde

Et udtryk som kundens nummer skal matche.

customerNumberMatch String

Only without receipt

Only show return shipments for which no receipt has yet been issued.

onlyNoReturnReceipt Boolean

Number

An expression that the number of the return shipment must match.

returnShipmentNumberMatch String