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

application/json

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

200

OK

application/json

Schema

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

]

loyalty_profile

object

Optional object containing information about loyalty program effects from this quote.

potentialPointsForOrder int64

Points that can be earned by proceeding with this quote

availableDiscounts

object[]

Discounts that can be optionally applied to this quote via the customer's loyalty profile

Array [

code string

Optional code to be applied for this discount

description string

Reward description

expires date

Optional expiry date for the reward

discount_cents int64

Total currency units to be discounted from the total when this discount is applied.

]

addons

object[]

Addons available in the quotation.

Array [

oneOf

gift-wrap-quote

type stringrequired

Possible values: [GIFT_WRAP]

The addon type. Must be GIFT_WRAP for this schema.

options

object[]

required

A list of available gift wrap options.

Array [

id stringrequired

The unique identifier for this gift wrap option.

net_cents int64required

Pre-tax cost in cents.

tax_cents int64required

Tax cost in cents.

total_cents int64required

Total cost in cents.

]

]

]

Example (from schema)

{
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "quotes": [
    {
      "items": [
        {
          "id": "string",
          "quantity": 0,
          "attributes": {
            "Size": "XL",
            "Color": "White"
          },
          "subtotal_net_cents": 0,
          "subtotal_tax_cents": 0,
          "subtotal_cents": 0,
          "cost_net_cents": 0,
          "cost_tax_cents": 0,
          "cost_cents": 0
        }
      ],
      "shipping_option": {
        "id": "string",
        "name": "string",
        "type": "LOCAL_PICKUP",
        "net_cents": 0,
        "tax_cents": 0,
        "total_cents": 0
      },
      "total_cents": 0,
      "discount_cents": 0,
      "fees": [
        {
          "title": "string",
          "cost_cents": 0
        }
      ],
      "payment_methods": [
        {
          "id": "string",
          "name": "string",
          "type": "COD",
          "net_cents": 0,
          "tax_cents": 0,
          "total_cents": 0
        }
      ],
      "loyalty_profile": {
        "potentialPointsForOrder": 0,
        "availableDiscounts": [
          {
            "code": "string",
            "description": "string",
            "expires": "2024-07-29",
            "discount_cents": 0
          }
        ]
      },
      "addons": [
        {}
      ]
    }
  ]
}

Example

{
  "request_id": "af4ebaa6-7f47-4163-85af-d5b82a8cf4b0",
  "quotes": [
    {
      "items": [
        {
          "id": "product-id-1",
          "quantity": 1,
          "subtotal_net_cents": 800,
          "subtotal_tax_cents": 200,
          "subtotal_cents": 1000,
          "cost_net_cents": 700,
          "cost_tax_cents": 200,
          "cost_cents": 900
        }
      ],
      "shipping_option": {
        "id": "ups-courier",
        "type": "DELIVERY",
        "name": "UPS courier (2-3 working days)",
        "net_cents": 400,
        "tax_cents": 100,
        "total_cents": 500
      },
      "fees": [
        {
          "title": "Last pieces",
          "cost_cents": -200
        }
      ],
      "total_cents": 1200,
      "discount_cents": 100,
      "addons": [
        {
          "type": "GIFT_WRAP",
          "options": [
            {
              "id": "fancy",
              "net_cents": 100,
              "tax_cents": 0,
              "total_cents": 100
            },
            {
              "id": "basic",
              "net_cents": 50,
              "tax_cents": 5,
              "total_cents": 55
            }
          ]
        }
      ]
    },
    {
      "items": [
        {
          "id": "product-id-1",
          "quantity": 1,
          "subtotal_net_cents": 800,
          "subtotal_tax_cents": 200,
          "subtotal_cents": 1000,
          "cost_net_cents": 700,
          "cost_tax_cents": 200,
          "cost_cents": 900
        }
      ],
      "shipping_option": {
        "id": "same-day-delivery",
        "type": "DELIVERY",
        "name": "Same day delivery",
        "net_cents": 800,
        "tax_cents": 200,
        "total_cents": 1000
      },
      "fees": [
        {
          "title": "Last pieces",
          "cost_cents": -200
        }
      ],
      "total_cents": 1700,
      "discount_cents": 100,
      "addons": [
        {
          "type": "GIFT_WRAP",
          "options": [
            {
              "id": "fancy",
              "net_cents": 100,
              "tax_cents": 0,
              "total_cents": 100
            },
            {
              "id": "basic",
              "net_cents": 50,
              "tax_cents": 5,
              "total_cents": 55
            }
          ]
        }
      ]
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

request_id string
message string
code stringrequired

Possible values: [INAPPLICABLE_COUPON, INVALID_COUPON, OUT_OF_STOCK_PRODUCT, UNSHIPPABLE_LOCATION, UNSHIPPABLE_CART, INVALID_PRODUCT]

Example (from schema)

{
  "request_id": "string",
  "message": "string",
  "code": "INAPPLICABLE_COUPON"
}

Example

{
  "message": "Product 'product-id-1' is out of stock",
  "code": "OUT_OF_STOCK_PRODUCT"
}

Loading...