Skip to main content

Quote Cart

POST 

/quote

Get a list of quotations for given cart. Stores create quotes for a given cart in order to perform tasks such as

  • Track each item the customer wants to buy, including the quantity and base cost
  • Gather information about the customer, including billing and shipping addresses
  • Determine shipping costs
  • Calculate the subtotal, add costs (shipping fees, taxes, etc.) and apply coupons to determine the grand total
  • Place the order so that the merchant can fulfill it

Request

Body

required

    request_id uuidrequired

    A unique identifier to track this request

    metadata

    object[]

    Custom key-value pairs defined during cart creation

  • Array [

  • key stringrequired
    value stringrequired
  • ]

  • quotation

    object

    required

    items

    object[]

    required

    Line items

  • Array [

  • id stringrequired

    Product ID

    quantity int32required

    attributes

    object

    User selected attributes (e.g. color, size)

    property name* string
  • ]

  • currency currency (string)required

    Possible values: >= 3 characters and <= 3 characters

    The ISO 4217 code of a currency

    ship_to

    object

    Shipping address

    first_name string
    last_name string
    phone string

    Possible values: >= 10 characters and <= 14 characters

    street stringrequired
    city stringrequired
    postcode stringrequired
    state string
    country stringrequired

    Possible values: >= 2 characters and <= 2 characters

    The ISO 3166-1 alpha-2 code of a country

    notes string
    email email

    Shopper's email

    coupon string

    Discount coupon code

Responses

OK

Schema

    request_id uuidrequired

    quotes

    object[]

    required

  • Array [

  • items

    object[]

    required

  • Array [

  • id stringrequired
    quantity integerrequired

    attributes

    object

    property name* string
    subtotal_net_cents int64

    unit's net value multiplied by quantity

    subtotal_tax_cents int64

    unit's tax multiplied by quantity

    subtotal_cents int64

    subtotal (net + tax) multiplied by quantity

    cost_net_cents int64required

    unit's net value (including discounts) multiplied by quantity

    cost_tax_cents int64required

    unit's tax value (including discounts) multiplied by quantity

    cost_cents int64

    total cost (including discounts) multiplied by quantity

  • ]

  • shipping_option

    object

    id stringrequired
    name stringrequired
    type string

    Possible values: [LOCAL_PICKUP, DELIVERY, BOX_NOW]

    net_cents int64required
    tax_cents int64required
    total_cents int64required
    total_cents int64required

    total cart's cost

    discount_cents int64required

    total cart's discount

    fees

    object[]

    Auto applied amounts by the merchant. It could contain positive and/or negative values.

  • Array [

  • title stringrequired
    cost_cents int64required
  • ]

  • payment_methods

    object[]

  • Array [

  • id stringrequired
    name stringrequired
    type stringrequired

    Possible values: [COD]

    net_cents int64required
    tax_cents int64required
    total_cents int64required
  • ]

  • ]

Loading...