@gradientedge/commercetools-utils
    Preparing search index...

    Interface IReturnItem

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    comment?: string

    User-defined description for the return.

    createdAt: string

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

    custom?: CustomFields

    Custom Fields of the Return Item.

    id: string

    Unique identifier of the Return Item.

    key?: string

    User-defined unique identifier of the Return Item.

    lastModifiedAt: string

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

    paymentState: ReturnPaymentState

    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)
    quantity: number

    Number of Line Items or Custom Line Items returned.

    shipmentState: ReturnShipmentState

    Shipment status of the Return Item.

    type: string

    Settings

    Member Visibility

    On This Page

    Properties