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

    Interface OrderAddDeliveryAction

    A Delivery can only be added to an Order if its shippingInfo (for shippingMode = Single), or its shipping (for shippingMode = Multiple) exists.

    Produces the [Delivery Added](ctp:api:type:DeliveryAddedMessage) Message.
    interface OrderAddDeliveryAction {
        action: "addDelivery";
        address?: _BaseAddress;
        custom?: CustomFieldsDraft;
        deliveryKey?: string;
        items?: DeliveryItem[];
        parcels?: ParcelDraft[];
        shippingKey?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    action address? custom? deliveryKey? items? parcels? shippingKey?

    Properties

    action: "addDelivery"
    address?: _BaseAddress

    Address the parcels should be delivered to.

    custom?: CustomFieldsDraft

    Custom Fields for the Delivery.

    deliveryKey?: string

    key of an existing Delivery.

    items?: DeliveryItem[]

    Line Items or Custom Line Items to be included in the Delivery.

    parcels?: ParcelDraft[]

    Parcels of the Delivery.

    If provided, this update action produces the [Parcel Added To Delivery](ctp:api:type:ParcelAddedToDeliveryMessage) Message.
    shippingKey?: string

    key of the ShippingMethod, required for Multiple ShippingMode.

    Settings

    Member Visibility

    On This Page

    Properties