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

    Interface ReturnItemDraft

    interface ReturnItemDraft {
        comment?: string;
        custom?: CustomFieldsDraft;
        customLineItemId?: string;
        key?: string;
        lineItemId?: string;
        quantity: number;
        shipmentState: ReturnShipmentState;
    }
    Index

    Properties

    comment? custom? customLineItemId? key? lineItemId? quantity shipmentState

    Properties

    comment?: string

    User-defined description for the return.

    custom?: CustomFieldsDraft

    Custom Fields for the Return Item.

    customLineItemId?: string

    id of the CustomLineItem to return.

     Required if Custom Line Items are returned, to create a [CustomLineItemReturnItem](ctp:api:type:CustomLineItemReturnItem).
    key?: string

    User-defined unique identifier of the Return Item.

    lineItemId?: string

    id of the LineItem to return.

     Required if Line Items are returned, to create a [LineItemReturnItem](ctp:api:type:LineItemReturnItem).
    quantity: number

    Number of Line Items or Custom Line Items to return.

    shipmentState: ReturnShipmentState

    Shipment status of the item to be returned. Can either be Advised or Returned only.

    Settings

    Member Visibility

    On This Page

    Properties