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

    Interface Quote

    interface Quote {
        billingAddress?: Address;
        businessUnit?: BusinessUnitKeyReference;
        buyerComment?: string;
        country?: string;
        createdAt: string;
        createdBy?: CreatedBy;
        custom?: CustomFields;
        customer?: CustomerReference;
        customerGroup?: CustomerGroupReference;
        customLineItems: CustomLineItem[];
        directDiscounts?: DirectDiscount[];
        id: string;
        inventoryMode?: InventoryMode;
        itemShippingAddresses?: Address[];
        key?: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        lineItems: LineItem[];
        paymentInfo?: PaymentInfo;
        priceRoundingMode: RoundingMode;
        purchaseOrderNumber?: string;
        quoteRequest: QuoteRequestReference;
        quoteState: QuoteState;
        sellerComment?: string;
        shippingAddress?: Address;
        shippingInfo?: ShippingInfo;
        shippingRateInput?: ShippingRateInput;
        stagedQuote: StagedQuoteReference;
        state?: StateReference;
        store?: StoreKeyReference;
        taxCalculationMode: TaxCalculationMode;
        taxedPrice?: TaxedPrice;
        taxMode: TaxMode;
        taxRoundingMode: RoundingMode;
        totalPrice: TypedMoney;
        validTo?: string;
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    billingAddress? businessUnit? buyerComment? country? createdAt createdBy? custom? customer? customerGroup? customLineItems directDiscounts? id inventoryMode? itemShippingAddresses? key? lastModifiedAt lastModifiedBy? lineItems paymentInfo? priceRoundingMode purchaseOrderNumber? quoteRequest quoteState sellerComment? shippingAddress? shippingInfo? shippingRateInput? stagedQuote state? store? taxCalculationMode taxedPrice? taxMode taxRoundingMode totalPrice validTo? version

    Properties

    billingAddress?: Address

    Address used for invoicing.

    businessUnit?: BusinessUnitKeyReference

    The BusinessUnit for the Quote. Only available for B2B-enabled Projects.

    buyerComment?: string

    Message from the Buyer included in the renegotiation request.

    country?: string

    Used for Product Variant price selection.

    createdAt: string

    Date and time (UTC) the Quote was initially created.

    createdBy?: CreatedBy

    IDs and references that created the Quote.

    custom?: CustomFields

    Custom Fields on the Quote.

    customer?: CustomerReference

    The Buyer who owns the Quote.

    customerGroup?: CustomerGroupReference

    Set automatically when customer is set and the Customer is a member of a Customer Group. Not updated if Customer is changed after Quote creation. Used for Product Variant price selection.

    customLineItems: CustomLineItem[]

    The Custom Line Items for which the Quote is requested.

    directDiscounts?: DirectDiscount[]

    Discounts that are only valid for the Quote and cannot be associated to any other Cart or Order.

    id: string

    Unique identifier of the Quote.

    inventoryMode?: InventoryMode

    Inventory mode of the Cart referenced in the QuoteRequestDraft.

    itemShippingAddresses?: Address[]

    Contains addresses for carts with multiple shipping addresses. Line items reference these addresses under their shippingDetails. The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate. Only the cart's shippingAddress is used for this.

    key?: string

    User-defined unique identifier of the Quote.

    lastModifiedAt: string

    Date and time (UTC) the Quote was last updated.

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the Quote.

    lineItems: LineItem[]

    The Line Items for which the Quote is requested.

    paymentInfo?: PaymentInfo

    Log of payment transactions related to the Quote.

    priceRoundingMode: RoundingMode

    When calculating total prices on LineItems and CustomLineItems, the selected mode is used for rounding.

    purchaseOrderNumber?: string

    The Purchase Order Number is typically set by the Buyer on a QuoteRequest to track the purchase order during the quote and order flow.

    quoteRequest: QuoteRequestReference

    Quote Request related to the Quote.

    quoteState: QuoteState

    Predefined states tracking the status of the Quote.

    sellerComment?: string

    Message from the Seller included in the offer.

    shippingAddress?: Address

    Used to determine the eligible ShippingMethods and rates as well as the tax rate of the Line Items.

    shippingInfo?: ShippingInfo

    Set automatically once the ShippingMethod is set.

    shippingRateInput?: ShippingRateInput

    Used to select a ShippingRatePriceTier.

    stagedQuote: StagedQuoteReference

    Staged Quote related to the Quote.

    state?: StateReference

    State of the Quote. This reference can point to a State in a custom workflow.

    store?: StoreKeyReference

    The Store to which the Buyer belongs.

    taxCalculationMode: TaxCalculationMode

    When calculating taxes for taxedPrice, the selected mode is used for calculating the price with LineItemLevel (horizontally) or UnitPriceLevel (vertically) calculation mode.

    taxedPrice?: TaxedPrice

    Not set until the shipping address is set. Will be set automatically in the Platform TaxMode. For the External tax mode it will be set as soon as the external tax rates for all line items, custom line items, and shipping in the cart are set.

    taxMode: TaxMode

    Tax mode of the Cart referenced in the QuoteRequestDraft.

    taxRoundingMode: RoundingMode

    When calculating taxes for taxedPrice, the selected mode is used for rounding.

    totalPrice: TypedMoney

    Sum of all totalPrice fields of the lineItems and customLineItems, as well as the price field of shippingInfo (if it exists). totalPrice may or may not include the taxes: it depends on the taxRate.includedInPrice property of each price.

    validTo?: string

    Expiration date for the Quote. Once a Quote expires, it cannot be ordered.

    version: number

    Current version of the Quote.

    Settings

    Member Visibility

    On This Page

    Properties