Interface IReturnItem

interface IReturnItem {
    comment?: string;
    createdAt: string;
    custom?: CustomFields;
    id: string;
    key?: string;
    lastModifiedAt: string;
    paymentState: string;
    quantity: number;
    shipmentState: string;
    type: string;
}

Hierarchy (View Summary)

Properties

comment? createdAt custom? id key? lastModifiedAt paymentState quantity shipmentState type

Properties

Optional Readonlycomment

comment?: string

User-defined description for the return.

ReadonlycreatedAt

createdAt: string

Date and time (UTC) the Return Item was intitially created.

Optional Readonlycustom

custom?: CustomFields

Custom Fields of the Return Item.

Readonlyid

id: string

Unique identifier of the Return Item.

Optional Readonlykey

key?: string

User-defined unique identifier of the Return Item.

ReadonlylastModifiedAt

lastModifiedAt: string

Date and time (UTC) the Return Item was last updated.

ReadonlypaymentState

paymentState: string

Payment status of the Return Item:

- `NonRefundable`, for items in the `Advised` [ReturnShipmentState](ctp:api:type:ReturnShipmentState)
- `Initial`, for items in the `Returned` [ReturnShipmentState](ctp:api:type:ReturnShipmentState)

Readonlyquantity

quantity: number

Number of Line Items or Custom Line Items returned.

ReadonlyshipmentState

shipmentState: string

Shipment status of the Return Item.

Readonlytype

type: string

Settings

Member Visibility

On This Page

Properties