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

    Interface CartDraft

    interface CartDraft {
        anonymousId?: string;
        billingAddress?: _BaseAddress;
        businessUnit?: BusinessUnitResourceIdentifier;
        country?: string;
        currency: string;
        custom?: CustomFieldsDraft;
        customerEmail?: string;
        customerGroup?: CustomerGroupResourceIdentifier;
        customerId?: string;
        customLineItems?: CustomLineItemDraft[];
        customShipping?: CustomShippingDraft[];
        deleteDaysAfterLastModification?: number;
        discountCodes?: string[];
        externalTaxRateForShippingMethod?: ExternalTaxRateDraft;
        inventoryMode?: InventoryMode;
        itemShippingAddresses?: BaseAddress[];
        key?: string;
        lineItems?: LineItemDraft[];
        locale?: string;
        origin?: CartOrigin;
        priceRoundingMode?: RoundingMode;
        shipping?: ShippingDraft[];
        shippingAddress?: _BaseAddress;
        shippingMethod?: ShippingMethodResourceIdentifier;
        shippingMode?: ShippingMode;
        shippingRateInput?: ShippingRateInputDraft;
        store?: StoreResourceIdentifier;
        taxCalculationMode?: TaxCalculationMode;
        taxMode?: TaxMode;
        taxRoundingMode?: RoundingMode;
    }
    Index

    Properties

    anonymousId? billingAddress? businessUnit? country? currency custom? customerEmail? customerGroup? customerId? customLineItems? customShipping? deleteDaysAfterLastModification? discountCodes? externalTaxRateForShippingMethod? inventoryMode? itemShippingAddresses? key? lineItems? locale? origin? priceRoundingMode? shipping? shippingAddress? shippingMethod? shippingMode? shippingRateInput? store? taxCalculationMode? taxMode? taxRoundingMode?

    Properties

    anonymousId?: string

    Anonymous session associated with the Cart.

    billingAddress?: _BaseAddress

    Billing address associated with the Cart.

    businessUnit?: BusinessUnitResourceIdentifier

    ResourceIdentifier to the Business Unit the Cart should belong to. When the customerId of the Cart is also set, the Customer must be an Associate of the Business Unit. Only available for B2B-enabled Projects.

    country?: string

    Used for Line Item price selection. If used for Create Cart in Store, the provided country must be one of the Store's countries.

    currency: string

    Currency the Cart uses.

    custom?: CustomFieldsDraft

    Custom Fields for the Cart.

    customerEmail?: string

    Email address of the Customer that the Cart belongs to.

    customerGroup?: CustomerGroupResourceIdentifier

    ResourceIdentifier to the Customer Group of the Customer that the Cart belongs to. Used for Line Item price selection.

    You can set either a `customerId` or a `customerGroup`.
If the Customer referenced in `customerId` belongs to a Customer Group then `customerGroup` is set automatically.
    customerId?: string

    id of the Customer that the Cart belongs to.

    customLineItems?: CustomLineItemDraft[]

    Custom Line Items to add to the Cart.

    customShipping?: CustomShippingDraft[]

    Custom Shipping Methods for a Cart with Multiple ShippingMode.

    deleteDaysAfterLastModification?: number

    Number of days after the last modification before a Cart is deleted. If not provided, the default value for this field configured in Project settings is assigned.

    Create a [ChangeSubscription](ctp:api:type:ChangeSubscription) for Carts to receive a [ResourceDeletedDeliveryPayload](ctp:api:type:ResourceDeletedDeliveryPayload) upon deletion of the Cart.
    discountCodes?: string[]

    code of the existing DiscountCodes to add to the Cart.

    externalTaxRateForShippingMethod?: ExternalTaxRateDraft

    External Tax Rate for the shippingMethod if the Cart has External TaxMode.

    inventoryMode?: InventoryMode

    Determines how stock quantities are tracked for Line Items in the Cart.

    itemShippingAddresses?: BaseAddress[]

    Multiple shipping addresses of the Cart. Each address must contain a key that is unique in this Cart. The keys are used by LineItems to reference these addresses under their shippingDetails.

    For Carts with `Single` [ShippingMode](ctp:api:type:ShippingMode): eligible Shipping Methods or applicable Tax Rates are determined by the address `shippingAddress`, and not `itemShippingAddresses`.
    key?: string

    User-defined unique identifier for the Cart.

    lineItems?: LineItemDraft[]

    Line Items to add to the Cart.

    locale?: string

    Languages of the Cart. Can only contain languages supported by the Project.

    origin?: CartOrigin

    Indicates how the Cart was created.

    priceRoundingMode?: RoundingMode

    Determines how the total prices on LineItems and CustomLineItems are rounded when calculated. If not set, the default value configured in the Project is used.

    shipping?: ShippingDraft[]

    Shipping Methods for a Cart with Multiple ShippingMode.

    shippingAddress?: _BaseAddress

    Shipping address for a Cart with Single ShippingMode. Determines eligible ShippingMethod rates and Tax Rates of Line Items. Must be one of the itemShippingAddresses when that field is also provided.

    shippingMethod?: ShippingMethodResourceIdentifier

    Shipping Method for a Cart with Single ShippingMode. If the referenced ShippingMethod has a predicate that does not match the Cart, an InvalidOperation error is returned when creating a Cart.

    shippingMode?: ShippingMode
    • If set to Single, only a single Shipping Method can be added to the Cart.
      • If set to Multiple, multiple Shipping Methods can be added to the Cart.
    shippingRateInput?: ShippingRateInputDraft

    Used as an input to select a ShippingRatePriceTier. The data type of this field depends on the shippingRateInputType.type configured in the Project:

    - If `CartClassification`, it must be [ClassificationShippingRateInputDraft](ctp:api:type:ClassificationShippingRateInputDraft).
- If `CartScore`, it must be [ScoreShippingRateInputDraft](ctp:api:type:ScoreShippingRateInputDraft).
- If `CartValue`, it cannot be set.
    store?: StoreResourceIdentifier

    ResourceIdentifier to the Store the Cart should belong to. Once set, it cannot be updated.

    taxCalculationMode?: TaxCalculationMode

    Determines how taxes are calculated for taxedPrice.

    taxMode?: TaxMode

    Determines how Tax Rates are set.

    taxRoundingMode?: RoundingMode

    Determines how monetary values are rounded when calculating taxes for taxedPrice. If not set, the default value configured in the Project is used.

    Settings

    Member Visibility

    On This Page

    Properties