Interface ReturnItemDraft

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

Properties

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

Properties

Optional Readonlycomment

comment?: string

User-defined description for the return.

Optional Readonlycustom

custom?: CustomFieldsDraft

Custom Fields for the Return Item.

Optional ReadonlycustomLineItemId

customLineItemId?: string

id of the CustomLineItem to return.

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

Optional Readonlykey

key?: string

User-defined unique identifier of the Return Item.

Optional ReadonlylineItemId

lineItemId?: string

id of the LineItem to return.

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

Readonlyquantity

quantity: number

Number of Line Items or Custom Line Items to return.

ReadonlyshipmentState

shipmentState: string

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

Settings

Member Visibility

On This Page

Properties