Estimate Order

Using the Estimate Order endpoint you can discover the estimated totals and available shipping methods for any combination of Sku’s and a shipping address. This feature can be useful for estimating an order before creating an order with Direct Order Submission.

When using Estimate Order you do not need to manage the lifecycle of a cart. Violet will handle the creation, modification, and deletion of any external carts that may need to be created while estimating an order.

When the Estimate Order process fails in the external commerce platform, Violet will attempt to parse and surface all error messages from the external system so that you are able to fully understand why the estimation failed. The most common reasons for failure will be Sku unavailability and incorrectly formatted shipping addresses.

Estimate Order

post

Estimates order totals including taxes, shipping, and discounts without creating or persisting an order. Accepts one or more SKUs and a shipping address, then returns estimated totals per merchant along with available shipping methods. SKUs from different merchants are automatically grouped into separate calculated carts. All monetary values are in the smallest currency unit (e.g. cents for USD).

Header parameters

X-Violet-TokenstringRequired

API token for authentication

X-Violet-App-SecretstringRequired

Application secret key

X-Violet-App-Idinteger · int32Required

Application ID

Example: 10000

Body

application/json

Request body for estimating cart totals without creating or persisting a cart. Use this to preview prices, taxes, shipping costs, and discount amounts before committing to a full cart creation flow. The response returns per-merchant breakdowns with available shipping options and estimated totals.

base_currencystring · enum · min: 3 · max: 3Optional

The base currency the cart should be calculated in.

Default: USDPossible values:

Responses

200

success

application/json

Response containing estimated cart totals. The estimated_carts list contains one entry per merchant, each with line item totals, available shipping methods, tax estimates, and discount breakdowns. All monetary values are in the smallest currency unit (e.g. cents for USD).

400

bad request

application/json

401

unauthorized

application/json

404

not found

application/json

500

internal server error

application/json

post

/orders/estimate

HTTPcURLJavaScriptPython

POST /v1/orders/estimate HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 225

{
  "base_currency": "USD",
  "skus": [
    {
      "sku_id": 10000,
      "quantity": 2
    }
  ],
  "shipping_address": {
    "address_1": "2815 Elliott Ave",
    "address_2": "Unit 100",
    "city": "Seattle",
    "state": "WA",
    "country": "US",
    "postal_code": "98121",
    "phone": "1234567890"
  }
}

Single SKU estimationMinimal required fields onlyMultiple SKUs across merchantsSKUs with bag-level discount codesSKUs with price overrides and SKU-level discounts

{
  "estimated_carts": [
    {
      "merchant_id": 10000,
      "platform": "SHOPIFY",
      "base_currency": "USD",
      "totals_in_base_currency": true,
      "sub_total": 19998,
      "shipping_total": 712,
      "tax_total": 2119,
      "discount_total": 0,
      "total": 22829,
      "skus": [
        {
          "sku_id": 10000,
          "quantity": 2,
          "name": "Nintendo Entertainment System",
          "price": 9999,
          "line_price": 19998,
          "compare_at_price": 12999,
          "merchant_id": 10000,
          "external_id": "31516807528534",
          "available": true,
          "inventory": {
            "available_inventory": 50,
            "sufficient_inventory": true
          },
          "requires_shipping": true,
          "product_type": "PHYSICAL",
          "custom": false,
          "offer_id": 55555,
          "weight_in_grams": 850,
          "trade_compliance": {
            "harmonized_system_code": "6109.10.00",
            "country_code_of_origin": "US",
            "province_code_of_origin": "CA"
          }
        }
      ],
      "available_shipping_methods": [
        {
          "label": "Free Shipping",
          "carrier": "OTHER",
          "price": 0,
          "shipping_method_id": "18ff5c0a16d83cb8ba46848e48e06532"
        },
        {
          "label": "Ground Advantage",
          "carrier": "USPS",
          "price": 712,
          "shipping_method_id": "468c823c817c753e850ff6658ef1480f"
        },
        {
          "label": "Priority Mail",
          "carrier": "USPS",
          "price": 934,
          "shipping_method_id": "02ef65ebff687faa10c71830d41144b2"
        }
      ],
      "shipping_address": {
        "address_1": "2815 Elliott Ave",
        "address_2": "Unit 100",
        "city": "Seattle",
        "state": "WA",
        "country": "US",
        "postal_code": "98121"
      },
      "discounts": [],
      "has_shipping_methods": true,
      "tax_inclusive_pricing": false,
      "external_error_messages": []
    }
  ]
}