v1

latestOpenAPI 3.1.02026-07-14460151.1 KB

Get order quote

Get a quote to know the cost of the shipment based on the provided products and shipping address. This quote will return all costs associated with an order.

post/v2/orders/quote

Request body

first_namestring required

last_namestring required

phone_numberstring required

emailstring required

address1string required

address2string

citystring required

statestring required

zip_codestring required

countrystring required

2 character country code. (eg: US)

notecard_messagestring

notecard_logostring binary

skip_address_validationboolean

Response

201

Example response

{
  "data": {
    "first_name": "firstname",
    "last_name": "lastname",
    "phone_number": "0000000000",
    "email": "email@company.com",
    "address1": "line 1",
    "address2": "line 2",
    "city": "city",
    "state": "state",
    "zip_code": "000000",
    "country": "country",
    "notecard_id": 1,
    "products": [
      {
        "product_id": 1,
        "quantity": 2,
        "variant_id": 4
      }
    ],
    "shipment_cost": {
      "products": "0",
      "notecard": "1.75",
      "shipping": "8",
      "tax": "0",
      "duty": "0",
      "other": "0",
      "sales_tax": "0",
      "total_cost": "9.75"
    }
  }
}