How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bolt Financial Orders API

Use the Orders API to interact with the customer's cart throughout the checkout process. Pre-checkout, perform actions such as validating inventory, verifying discounts, and calculating taxes. Post-checkout, share shipping information so your customer can track their order. You'll interact with the [Merchant API](https://help.boltapp.com/api-merchant/) to keep the servers in sync with any changes the customer makes to their cart. See our related guide [Create a Bolt Order Token](https://help.boltapp.com/products/checkout/how-to-integrate/create-bolt-order-token-new/).

Bolt Financial Orders API is one of 13 APIs that Bolt Financial publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 130 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 4 base URLs: https://api.boltapp.com, https://api-sandbox.boltapp.com, https://api-staging.boltapp.com, https://{environment}.boltapp.com/v3.

3 operations 3 paths 130 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.boltapp.com
Authentication
OAuth 2.0, API Key, API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 4

Bolt Financial Orders API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth) using the authorizationCode flow, exposing 3 scopes. An API key is passed in the header as X-API-Key (X-API-Key). An API key is passed in the header as X-API-Key (api-key). It supports OAuth 2.0 (oauth) using the authorizationCode flow, exposing 3 scopes.

  • OAuth — Bolt utilizes the OAuth flow that developers can use to attain access to Bolt Account data via APIs. For all APIs that require authorization, please provide yo…
  • X-API-Key — Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 3

Use the Orders API to interact with the customer's cart throughout the checkout process. Pre-checkout, perform actions such as validating inventory, verifying discounts, and calcu…

POST
/v1/merchant/orders
Create Order Token
createOrderToken body → 200400403422
POST
/v1/merchant/track_shipment
Send order tracking details
trackOrder body → 200400422
POST
/orders
Create an order that was prepared outside the Bolt ecosystem.
ordersCreate 2 params body → 2004XXdefault

Schemas 130

The contract defines 130 schemas that model the data the API accepts and returns. The most detailed are i_cart_item_view (39 properties), cart_item (38 properties), item (29 properties), cart_shipment (21 properties). Each schema is shown below with its type and property counts.

cost
integer
The cost in cents.
merchant_product_id
string
The merchant's unique ID for the product.
item_property
object
2 properties
depth
integer
The depth.
cart_shipment
object
A cart that is being prepared for shipment
21 properties
options
string
cart_discount
object
7 properties
gift_option_view
object
Defines which gift options are hidden.
2 properties
type
string
Determines if item is a physical, digital, or bundled good, or if the good type is unknown.
item_properties
array
metadata_component
object
2 properties
carrier
string
The name of the carrier selected.
cart_loyalty_rewards
object
7 properties
items
array
A list of items.
estimated_delivery_date
string
The estimated delivery date.
digital_delivery
object
2 properties
i_weight
object
2 properties
size
string
The size.
quantity
integer
The quantity of this item.
taxable
boolean
Determines if item is taxable.
i_cart_view
object
This is the cart object returned in a successful response.
18 properties
request_result
object
Custom-defined Bolt result object.
1 property
cart_item_property
object
6 properties
customizations_name
string
The name of the customization.
door_code
stringnull
The building door code or community gate code.
expedited
boolean
True if shipment is expedited.
cart_item_property_view
object
4 properties
cart_item
object
38 properties 5 required
i_order_dynamic_content
object
8 properties
currency_iso
string
The 3-digit ISO code for the currency. Nullable for Transactions Details.
item_shipment_type
string
The shipment type selected by the shopper.
message
string
Human-readable description of the error for developers. Should not be shown to users and is not localized.
base_cart
object
The basecart object contains the core details typically found in most cart objects, including items, discounts, amount totals, shipments, and in-store pickups.
11 properties 1 required
i_free_shipping_discount_view
object
2 properties
transaction_reference
string
The transaction's 12-digit Bolt reference ID. Nullable for Transactions Details.
code
integer
Custom-defined Bolt error code. This can be used to programmatically react to specific errors.
i_currency
object
2 properties
order_create
object
6 properties 2 required
gift_options_wrap
boolean
Defines whether gift wrapping was requested.
i_order_external_data
object
1 property
address
object
The Address object is used for billing, shipping, and physical store address use cases.
18 properties 8 required
shipping_method
string
The name of the shipping method.
height
integer
The height.
in_store_cart_shipment
object
8 properties
amount_view
object
3 properties
error_bolt_api
object
Error object containing custom error information
2 properties
i_cart_shipment_view
object
20 properties
i_cart_item_external_inputs
object
3 properties
fulfillment
object
Defines the shipments associated with the cart items.
5 properties
isbn
string
A 13-digit identifier for a book item.
reference
string
Reference for the object.
category
string
A category.
phone
string
A phone number following E164 standards, in its globalized format, i.e. prepended with a plus sign.
cart_create
payment_service
string
cart_item_customization
object
3 properties
i_gift_option_view
object
2 properties
eligible_payment_method
object
2 properties
signature
string
The signature.
marketplace_commission_fee
object
Configures the marketplace commission fee structure for a seller split, supporting both percentage-based and flat fee models.
3 properties 2 required
i_cart_fee_view
object
6 properties
item_description
string
A description for the item added to the cart/order.
shipping_carrier
string
the name of the carrier used for shipment.
subscription
object
Describes a product added as a recurring subscription.
1 property
service
string
The service name.
cart_fee
object
6 properties 5 required
shipping_address_id
string
ID for billing address
tag
string
A tag
errors_bolt_api
array
item
object
An item with properties.
29 properties 5 required
brand
string
The name of a brand.
order_non_bolt
boolean
Designates if the order was placed outside of Bolt checkout.
weight_unit
string
The unit of measurement for an item's weight.
gift_options_message
string
Includes the gift message written by the shopper.
i_description_tooltip
object
2 properties
manufacturer
string
The name of a manufacturer.
amount
integer
The amount in cents. Nullable for Transactions Details.
tax_code
string
The relevant tax code.
color
string
The color.
i_order_view
object
5 properties
item_group
string
Enables grouping in the checkout UI.
dimension_unit
string
The unit of measurement for an item's dimensions.
width
integer
The width.
amounts
object
The amount. Nullable for Transactions Details.
3 properties 3 required
collections
array
weight
integer
The weight of an item.
i_cart_item_view
object
39 properties
request_failed
boolean
Indicates that the request failed. This value is always false.
package_type
string
The type of package.
collection
string
i_order_metadata
objectnull
1 property
seller_split
object
Defines a seller split configuration for marketplace orders, specifying which items and shipments belong to a seller and how amounts should be calculated and d…
3 properties 3 required
i_custom_field_view
object
11 properties
i_cart_discount_view
object
7 properties
sku
string
The SKU identifier for this item or service.
total_weight
object
2 properties
cart_add_on
object
A list of up to 3 add-ons that are displayed to the shopper.
6 properties 3 required
cart_shipment_type
string
The type corresponding to this shipment, if applicable.
merchant_variant_id
string
A merchant's unique ID for a given product's specific variant.
bolt_product_id
string
Unique ID generated for a product via the products endpoint.
address_view
object
The address object returned in the response.
19 properties
image_url
string
The URL for the item's image.
cart_item_gift_option
object
Contains the gift option settings for wrapping and custom messages.
4 properties
errors_bolt_api_response
object
2 properties
order_tracking_number
string
The carrier's tracking number for the shipment.
i_description_part
object
2 properties
seller_split_amounts
object
Defines the financial breakdown for a seller split, including subtotals, discounts, shipping, taxes, and the final gross amount.
5 properties 5 required
currency_symbol
string
The currency symbol used for the amount. Nullable for Transactions Details.
tax_amount
integer
Tax amount in cents.
discount_membership
boolean
Defines if shopper has a membership discount.
name_item
string
The name of an item.
email
string
An email address.
transaction
object
2 properties
order-response
object
2 properties 2 required
address-reference-explicit
object
13 properties 7 required
country-code
string
The country (in its ISO 3166 alpha-2 format) associated with this address.
profile
object
An account's identifying information.
4 properties 3 required
cart-item
object
9 properties 5 required
address-reference-partial
object
2 properties 2 required
field-error
object
An error that pertains to validation of a specific field in the request.
3 properties 3 required
order
object
2 properties 2 required
transaction-authorization
object
2 properties
address-reference-id
object
2 properties 2 required
cart-shipment
object
3 properties
cart
object
8 properties 3 required
processor-response
object
Raw authorization response from the payment processor
3 properties
amount_2
object
A monetary amount, i.e. a base unit amount and a supported currency.
2 properties 2 required
error
object
2 properties 2 required
cart-discount
object
3 properties 1 required
address-reference

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bolt-financial-orders-api-openapi.yml Raw ↑

Other APIs Bolt Financial publishes across the network.

Bolt MCP Servers
Bolt Financial Account API
Bolt Financial Callbacks API
Bolt Financial Configuration API
Bolt Financial O Auth API
Bolt Financial Payments API
Bolt Financial Statements API
Bolt Financial Subscriptions API
Bolt Financial Testing API
Bolt Financial Tokenizer API
Bolt Financial Transactions API
Bolt Financial Webhooks API
Where this information came from

This is an independent, third-party profile of Bolt Financial Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.