Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/bolt-financial-orders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Bolt Financial Orders API
version: '1.0'
description: 'Operations tagged Orders across 2 of this provider''s published API definitions: bolt-financial-bolt-api-openapi.yml, bolt-financial-embeddable-checkout-v3-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.boltapp.com
description: The Production URL (Live Data).
- url: https://api-sandbox.boltapp.com
description: The Sandbox URL (Test Data).
- url: https://api-staging.boltapp.com
description: The Staging URL (Staged Data).
- url: https://{environment}.boltapp.com/v3
variables:
environment:
enum:
- api
- api-sandbox
default: api-sandbox
tags:
- name: Orders
description: '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/).
'
paths:
/v1/merchant/orders:
post:
description: Make a request to this endpoint to create a Bolt order, generate a Bolt order token, and initiate the checkout process. A Bolt order token is required for Bolt orders; see Non-Bolt orders for alternative use cases.
operationId: createOrderToken
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/order_create'
description: Generate Order Token
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/i_order_view'
description: Token Generation Successful
'400':
$ref: '#/components/responses/order_generate_error_400'
'403':
$ref: '#/components/responses/order_generate_error_403'
'422':
$ref: '#/components/responses/order_generate_error_422'
security:
- X-API-Key: []
summary: Create Order Token
tags:
- Orders
servers:
- url: https://api.boltapp.com
description: The Production URL (Live Data).
- url: https://api-sandbox.boltapp.com
description: The Sandbox URL (Test Data).
- url: https://api-staging.boltapp.com
description: The Staging URL (Staged Data).
/v1/merchant/track_shipment:
post:
description: 'Send the carrier and order tracking number to Bolt (after a label has been printed). Bolt then uses EasyPost to forward ongoing tracking event updates to the shopper. This request must include **all** items included in the shipment; their references must also match those found in the original cart generation.
'
operationId: trackOrder
requestBody:
$ref: '#/components/requestBodies/order_track'
responses:
'200':
$ref: '#/components/responses/order_track'
'400':
$ref: '#/components/responses/order_track_error_400'
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/errors_bolt_api_response'
description: Generic Error Schema
security:
- X-API-Key:
- X-API-Key
summary: Send order tracking details
tags:
- Orders
servers:
- url: https://api.boltapp.com
description: The Production URL (Live Data).
- url: https://api-sandbox.boltapp.com
description: The Sandbox URL (Test Data).
- url: https://api-staging.boltapp.com
description: The Staging URL (Staged Data).
/orders:
post:
summary: Create an order that was prepared outside the Bolt ecosystem.
operationId: ordersCreate
description: Create an order that was prepared outside the Bolt ecosystem. Some Bolt-powered flows automatically manage order creation - in those flows the order ID will be provided separately and not through this API.
tags:
- Orders
security:
- api-key: []
parameters:
- $ref: '#/components/parameters/x-publishable-key'
- $ref: '#/components/parameters/x-merchant-client-id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/order'
examples:
reference:
$ref: '#/components/examples/order'
responses:
'200':
description: The order was successfuly created
content:
application/json:
schema:
$ref: '#/components/schemas/order-response'
examples:
finalized:
$ref: '#/components/examples/order-response'
4XX:
$ref: '#/components/responses/response-4xx'
default:
$ref: '#/components/responses/response-default'
servers:
- url: https://{environment}.boltapp.com/v3
variables:
environment:
enum:
- api
- api-sandbox
default: api-sandbox
components:
schemas:
cost:
description: The cost in cents.
example: 770
type: integer
merchant_product_id:
description: The merchant's unique ID for the product.
example: '881'
type: string
item_property:
properties:
name:
example: a-name
type: string
value:
example: a-value
type: string
type: object
depth:
description: The depth.
example: 90
type: integer
cart_shipment:
description: A cart that is being prepared for shipment
properties:
carrier:
$ref: '#/components/schemas/carrier'
cost:
$ref: '#/components/schemas/cost'
discounted_by_membership:
$ref: '#/components/schemas/discount_membership'
estimated_delivery_date:
$ref: '#/components/schemas/estimated_delivery_date'
expedited:
$ref: '#/components/schemas/expedited'
package_depth:
$ref: '#/components/schemas/depth'
package_dimension_unit:
$ref: '#/components/schemas/dimension_unit'
package_height:
$ref: '#/components/schemas/height'
package_type:
$ref: '#/components/schemas/package_type'
package_weight_unit:
$ref: '#/components/schemas/weight_unit'
package_width:
$ref: '#/components/schemas/width'
service:
$ref: '#/components/schemas/service'
shipping_address:
$ref: '#/components/schemas/address'
shipping_address_id:
$ref: '#/components/schemas/shipping_address_id'
shipping_method:
$ref: '#/components/schemas/shipping_method'
signature:
$ref: '#/components/schemas/signature'
tax_amount:
$ref: '#/components/schemas/tax_amount'
tax_code:
$ref: '#/components/schemas/tax_code'
total_weight:
description: The total weight.
example: 55
type: integer
total_weight_unit:
$ref: '#/components/schemas/weight_unit'
type:
$ref: '#/components/schemas/cart_shipment_type'
type: object
options:
example: string option
type: string
cart_discount:
properties:
amount:
example: 100
type: number
code:
example: SUMMER10DISCOUNT
maxLength: 1024
type: string
description:
description: Used to define the discount offering.
example: 10% off our summer collection
maxLength: 1024
type: string
details_url:
description: Used to provide a link to additional details, such as a landing page, associated with the discount offering.
example: https://boltswagstore.com/SUMMERSALE
maxLength: 8192
type: string
discount_category:
enum:
- coupon
- giftcard
- managed_giftcard
- store_credit
- automatic_promotion
- membership_discount
- membership_giftcard
- subscription_discount
- rewards_discount
- shipping_discount
- unknown
type: string
reference:
description: Used to define the reference ID associated with the discount available.
example: DISC-1234
maxLength: 1024
type: string
type:
description: The type of discount.
enum:
- fixed_amount
- percentage
- free_shipping
example: percentage
type: string
type: object
gift_option_view:
description: Defines which gift options are hidden.
properties:
hide_gift_message:
example: false
type: boolean
hide_gift_wrap:
example: false
type: boolean
type: object
type:
description: Determines if item is a physical, digital, or bundled good, or if the good type is unknown.
enum:
- bundled
- digital
- physical
- unknown
example: physical
type: string
item_properties:
items:
$ref: '#/components/schemas/item_property'
type: array
metadata_component:
properties:
key1:
example: value1
type: string
key2:
example: value2
type: string
type: object
carrier:
description: The name of the carrier selected.
example: FedEx
type: string
cart_loyalty_rewards:
properties:
amount:
description: The reward amount in cents (1/100).
format: int64
type: number
coupon_code:
description: The loyalty reward's coupon code.
type: string
description:
description: A description of the loyalty reward that will be shown to the shopper.
type: string
example: $5 off (100 Points)
details:
description: Internal-facing metadata for the Loyalty Rewards. Ideal for adding any other identifying information about the reward, including a duplication of the original loyalty reward json response from the loyalty provider as shown in the example provided. If you choose to use this field to hold json, enclose the content in single quotes to force a string value.
type: string
example: '{"id": 123456, "icon": "fa-dollar", "name": "$15.00 Off", "type": "Coupon", "amount": 100, "duration": "single_use", "cost_text": "150 Points", "description": "Get $15 off your next purchase for 150 points", "discount_type": "fixed_amount", "unrendered_name": "$15.00 Off", "discount_percentage": null, "discount_rate_cents": null, "discount_value_cents": null, "discount_amount_cents": 1500, "unrendered_description": "Get $15 off your next purchase for 150 points", "applies_to_product_type": "ALL"}'
points:
description: The number of points needed for this reward.
format: int64
type: number
source:
description: The loyalty rewards provider.
type: string
type:
description: The type of loyalty reward.
type: string
type: object
items:
description: A list of items.
items:
$ref: '#/components/schemas/item'
type: array
estimated_delivery_date:
description: The estimated delivery date.
example: 08-30-2022
type: string
digital_delivery:
properties:
email:
type: string
phone:
type: string
type: object
i_weight:
properties:
unit:
type: string
weight:
format: int64
type: number
type: object
size:
description: The size.
example: XXL
type: string
quantity:
description: The quantity of this item.
example: 3
type: integer
taxable:
description: Determines if item is taxable.
example: true
type: boolean
i_cart_view:
description: This is the cart object returned in a successful response.
properties:
billing_address:
$ref: '#/components/schemas/address_view'
cart_url:
description: Used to provide a link to the cart ID.
example: https://boltswagstore.com/orders/123456765432
maxLength: 8192
type: string
currency:
$ref: '#/components/schemas/i_currency'
discount_amount:
$ref: '#/components/schemas/amount_view'
discounts:
items:
$ref: '#/components/schemas/i_cart_discount_view'
type: array
display_id:
example: displayid_100
type: string
fee_amount:
$ref: '#/components/schemas/amount_view'
fees:
items:
$ref: '#/components/schemas/i_cart_fee_view'
type: array
items:
items:
$ref: '#/components/schemas/i_cart_item_view'
type: array
merchant_order_url:
type: string
order_description:
description: Used optionally to pass additional information like order numbers or other IDs as needed.
example: 'Order #1234567890'
maxLength: 1024
type: string
order_reference:
description: This value is used by Bolt as an external reference to a given order. This reference must be unique per successful transaction.
example: order_100
type: string
shipments:
items:
$ref: '#/components/schemas/i_cart_shipment_view'
type: array
shipping_amount:
$ref: '#/components/schemas/amount_view'
subtotal_amount:
$ref: '#/components/schemas/amount_view'
tax_amount:
$ref: '#/components/schemas/amount_view'
total_amount:
$ref: '#/components/schemas/amount_view'
transaction_reference:
description: The 12 digit reference ID associated to a given transaction webhook for an order.
example: 6CEA-ZME1-DACE
maxLength: 12
minLength: 12
type: string
type: object
request_result:
description: Custom-defined Bolt result object.
properties:
success:
$ref: '#/components/schemas/request_failed'
type: object
cart_item_property:
properties:
color:
maxLength: 1024
type: string
display:
type: boolean
name:
maxLength: 1024
type: string
name_id:
format: int64
type: number
value:
maxLength: 1024
type: string
value_id:
format: int64
type: number
type: object
customizations_name:
description: The name of the customization.
example: Bedazzled
type: string
door_code:
description: The building door code or community gate code.
example: '123456'
maxLength: 1024
type:
- string
- 'null'
expedited:
description: True if shipment is expedited.
example: false
type: boolean
cart_item_property_view:
properties:
color:
type: string
display:
type: boolean
name:
type: string
value:
type: string
type: object
cart_item:
properties:
brand:
example: Bolt
maxLength: 1024
type:
- string
- 'null'
category:
description: Used to define a product category associated with the item.
example: bags
maxLength: 1024
type:
- string
- 'null'
collections:
$ref: '#/components/schemas/collections'
color:
description: Used to define the color of the item.
example: Bolt Blue
maxLength: 1024
type:
- string
- 'null'
customizations:
items:
$ref: '#/components/schemas/cart_item_customization'
type: array
description:
example: Large tote with Bolt logo.
type:
- string
- 'null'
details_url:
description: Used to provide a link to the item's product page.
example: https://boltswagstore.com/products/123456
maxLength: 8192
type: string
external_inputs:
$ref: '#/components/schemas/i_cart_item_external_inputs'
gift_option:
$ref: '#/components/schemas/cart_item_gift_option'
image_url:
description: Used to provide a link to the image associated with the item.
example: https://boltswagstore.com/products/123456/images/1.png
maxLength: 8192
type: string
isbn:
description: Used to define the International Standard Book Number associated with the book.
example: '9780091347314'
maxLength: 1024
type:
- string
- 'null'
item_group:
type:
- string
- 'null'
manufacturer:
description: Used to define the organization that manufactured the item.
example: Bolt Textiles USA
maxLength: 1024
type:
- string
- 'null'
merchant_product_id:
$ref: '#/components/schemas/merchant_product_id'
merchant_variant_id:
$ref: '#/components/schemas/merchant_variant_id'
msrp:
format: int64
type:
- number
- 'null'
name:
example: Bolt Swag Bag
maxLength: 1024
minLength: 1
type: string
options:
example: Special Edition
maxLength: 1024
type:
- string
- 'null'
properties:
items:
$ref: '#/components/schemas/cart_item_property'
type: array
quantity:
example: 1
format: int64
maximum: 15000
type: number
reference:
example: item_100
maxLength: 1024
type: string
shipment:
$ref: '#/components/schemas/cart_shipment'
shipment_type:
enum:
- unknown
- door_delivery
- ship_to_store
- in_store_pickup
type: string
size:
description: Used to define the size of the item.
example: Large
maxLength: 1024
type:
- string
- 'null'
sku:
description: Used to define the alpha-numberic Stock Keeping Unit associated with the item as it is mapped to your internal product catalogue.
example: BOLT-SKU_100
maxLength: 1024
type:
- string
- 'null'
source:
type:
- string
- 'null'
seller_id:
description: The unique identifier for the seller within the marketplace ecosystem. This field ensures deterministic multi-party payout calculations.
example: seller-1234
maxLength: 1024
type:
- string
- 'null'
tags:
description: Used to define a comma-separated list of tags associated with the item.
example: tote, blue, linen, eco-friendly
maxLength: 1024
type:
- string
- 'null'
tax_amount:
description: The tax amount for the item; this value should scale with the quantity of units selected.
example: 0
format: int64
type:
- number
- 'null'
tax_code:
maxLength: 32
type:
- string
- 'null'
taxable:
type:
- boolean
- 'null'
total_amount:
description: The total amount, in cents, of the item including its taxes if applicable.
example: 1000
format: int64
type: number
type:
enum:
- unknown
- digital
- physical
- bundled
type: string
unit_price:
description: The price of one unit of the item; for example, the price of one pack of socks.
example: 1000
format: int64
type: number
uom:
description: Used to define the unit of measure used to describe the item.
example: inches
maxLength: 1024
type:
- string
- 'null'
upc:
description: Used to define the 12-digit Universal Product Code (a barcode) associated with the item worldwide.
example: 0825764603119
maxLength: 1024
type:
- string
- 'null'
weight:
example: 10
format: int64
maximum: 10000
type:
- number
- 'null'
weight_unit:
example: pounds
maxLength: 1024
type:
- string
- 'null'
required:
- reference
- name
- total_amount
- unit_price
- quantity
type: object
i_order_dynamic_content:
properties:
custom_fields:
items:
$ref: '#/components/schemas/i_custom_field_view'
type: array
eligible_payment_methods:
items:
$ref: '#/components/schemas/eligible_payment_method'
type: array
gift_option_view:
$ref: '#/components/schemas/i_gift_option_view'
hide_apm:
items:
enum:
- PAYPAL
- AFFIRM
- AFTERPAY
- AMAZONPAY
- KLARNA
- RADIALPAYPAL
- SEZZLE
- RADIALKLARNA
- CREDOVA
- GOOGLEPAY
type: string
type: array
order_notice:
type: string
payment_notice:
type: string
shipping_info_notice:
type: string
shipping_notice:
type: string
type: object
currency_iso:
description: The 3-digit ISO code for the currency. **Nullable** for Transactions Details.
example: USD
type: string
item_shipment_type:
description: The shipment type selected by the shopper.
enum:
- unknown
- door delivery
- in_store_pickup
- ship_to_store
type: string
message:
description: Human-readable description of the error for developers. Should not be shown to users and is not localized.
example: The input is missing a required parameter.
type: string
base_cart:
description: The base_cart object contains the core details typically found in most cart objects, including items, discounts, amount totals, shipments, and in-store pickups.
properties:
add_ons:
items:
$ref: '#/components/schemas/cart_add_on'
type: array
billing_address:
$ref: '#/components/schemas/address'
discounts:
items:
$ref: '#/components/schemas/cart_discount'
type: array
fees:
items:
$ref: '#/components/schemas/cart_fee'
type: array
fulfillments:
items:
$ref: '#/components/schemas/fulfillment'
type: array
in_store_cart_shipments:
items:
$ref: '#/components/schemas/in_store_cart_shipment'
type: array
items:
description: The list of items associated with the cart.
items:
$ref: '#/components/schemas/cart_item'
type: array
loyalty_rewards:
items:
$ref: '#/components/schemas/cart_loyalty_rewards'
type: array
shipments:
items:
$ref: '#/components/schemas/cart_shipment'
type: array
tax_amount:
description: The total tax amount for all of the items associated with the cart.
format: int64
type: number
total_amount:
description: The total amount, in cents, of the cart including its items and taxes (if applicable), e.g. $9.00 is 900. This total must match the sum of all other amounts.
example: 900
format: int64
type: number
required:
- total_amount
type: object
i_free_shipping_discount_view:
properties:
is_free_shipping:
type: boolean
maximum_cost_allowed:
format: int64
type: number
type: object
transaction_reference:
description: The transaction's 12-digit Bolt reference ID. **Nullable** for Transactions Details.
example: LBLJ-TWW7-R9VC
maxLength: 12
minLength: 12
type: string
code:
description: Custom-defined Bolt error code. This can be used to programmatically react to specific errors.
example: 2001005
format: int64
type: integer
i_currency:
properties:
currency:
example: USD
type: string
currency_symbol:
example: $
type: string
type: object
order_create:
properties:
cart:
allOf:
- $ref: '#/components/schemas/cart_create'
- description: The cart_create object is a composite of the base_cart object and additional order details.
- required:
- order_reference
channel:
description: Used to determine the channel from which the order was created.
enum:
- browser
- mobile_app
type: string
create_cart_on_merchant_backend:
description: Used to determine whether the order is created on your backend platform. This should almost always be `false`.
example: false
type:
- boolean
- 'null'
metadata:
$ref: '#/components/schemas/i_order_metadata'
user_note:
description: Optionally used by shoppers to make extra requests or provide details for gift messages.
example: Happy Birthday to my best friend in the whole world. Enjoy!
maxLength: 1024
type: string
seller_splits:
description: Array of seller splits for marketplace orders. This enables marketplaces to dynamically configure commission fees and payment splits per seller. Each split contains seller identification, scoped line items and shipments, and declarative amount breakdowns.
items:
$ref: '#/components/schemas/seller_split'
type:
- array
- 'null'
required:
- cart
- channel
type: object
gift_options_wrap:
description: Defines whether gift wrapping was requested.
example: false
type: boolean
i_order_external_data:
properties:
steam_id:
type: string
type: object
address:
description: The Address object is used for billing, shipping, and physical store address use cases.
properties:
company:
description: The company name associated with this address.
example: Bolt
maxLength: 1024
type: string
country:
description: The name of the country associated with this address.
example: United States
maxLength: 1024
type: string
country_code:
description: The ISO 3166-1 alpha-2 country code associated with this address.
example: US
maxLength: 2
minLength: 2
type: string
default:
description: Whether the added address is now the default address.
example: true
type: boolean
door_code:
$ref: '#/components/schemas/door_code'
email:
description: The email address associated with this address.
$ref: '#/components/schemas/email'
first_name:
description: The given name of the person associated with this address.
example: Alan
maxLength: 1024
type: string
last_name:
description: The surname of the person associated with this address.
example: Watts
maxLength: 1024
type: string
locality:
description: The city name details associated with this address.
example: Brooklyn
maxLength: 1024
type: string
name:
description: The given and surname of the person associated with this address.
example: Alan Watts
maxLength: 1024
type: string
phone:
description: The phone number associated with this address.
$ref: '#/components/schemas/phone'
postal_code:
description: The the postal or zip code associated with this address.
example: '10044'
maxLength: 32
type: string
region:
description: '**Not Required for NON US addresses**. The region details such as state or province associated with this address.'
example: NY
maxLength: 1024
type: string
region_code:
description: "The ISO 3166-2 region code associated with this address.\n - * If specified, value must be valid for the `country`.\n - * If null, value is inferred from the `region`.\n"
example: NY
maxLength: 1024
type:
- string
- 'null'
street_address1:
description: The street number and street name of the address.
example: 888 main street
maxLength: 1024
type: string
street_address2:
description: Any apartment, floor, or unit details.
example: apt 3021
maxLength: 1024
type: string
street_address3:
description: Any additional street address details.
example: c/o Alicia Watts
maxLength: 1024
type:
- string
- 'null'
street_address4:
description: Any additional street address details.
example: Bridge Street Apartment Building B
maxLength: 1024
type:
- string
- 'null'
required:
- street_address1
- locality
- region
- country_code
- postal_code
- email
- first_name
- last_name
type: object
shipping_method:
description: The name of the shipping method.
example: unknown
type: string
height:
description: The height.
example: 103
type: integer
in_store_cart_shipment:
properties:
cart_shipment:
$ref: '#/components/schemas/cart_shipment'
description:
description: Shipment option description.
example: Pick up in-store at 123 Main St.
type: string
distance:
example: 3
format: float64
type: number
distance_unit:
enum:
- km
- mile
example: mile
type: string
in_store_pickup_address:
$ref: '#/components/schemas/address'
pickup_window_close:
format: date
type: integer
pickup_window_open:
format: date
type: integer
store_name:
description: The local store's name where the item can be picked up.
example: Bolt Collective
type: string
type: object
amount_view:
properties:
amount:
format: int64
example: 754
type: number
currency:
example: USD
type: string
currency_symbol:
example: $
type: string
type: object
error_bolt_api:
properties:
code:
$ref: '#/components/schemas/code'
message:
$ref: '#/components/schemas/message'
type: object
description: Error object containing
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bolt-financial/refs/heads/main/openapi/bolt-financial-orders-api-openapi.yml