v2
latestOpenAPI 3.0.02026-07-3139594346.4 KBOrders
Create Order Token
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.
post/v1/merchant/orders
Request body
Example request
{
"cart": {
"billing_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"region": "NY",
"region_code": "NY",
"street_address1": "888 main street",
"street_address2": "apt 3021",
"street_address3": "c/o Alicia Watts",
"street_address4": "Bridge Street Apartment Building B"
},
"discounts": [
{
"amount": 100,
"code": "SUMMER10DISCOUNT",
"description": "10% off our summer collection",
"details_url": "https://boltswagstore.com/SUMMERSALE",
"reference": "DISC-1234",
"type": "percentage"
}
],
"fees": [
{
"reference": "ItemFee",
"name": "Item Fee",
"description": "Item Fee"
}
],
"fulfillments": [
{
"cart_items": [
{
"brand": "Bolt",
"category": "bags",
"collections": [
"summer"
],
"color": "Bolt Blue",
"customizations": [
{
"attributes": {
"key1": "value1",
"key2": "value2"
},
"price": 754
}
],
"description": "Large tote with Bolt logo.",
"details_url": "https://boltswagstore.com/products/123456",
"gift_option": {
"cost": 770,
"merchant_product_id": "881",
"message": "Happy Anniversary, Smoochy Poo!"
},
"image_url": "https://boltswagstore.com/products/123456/images/1.png",
"isbn": "9780091347314",
"manufacturer": "Bolt Textiles USA",
"merchant_product_id": "881",
"merchant_variant_id": "888",
"name": "Bolt Swag Bag",
"options": "Special Edition",
"quantity": 1,
"reference": "item_100",
"shipment": {
"carrier": "FedEx",
"cost": 770,
"estimated_delivery_date": "08-30-2022",
"package_depth": 90,
"package_dimension_unit": "cm",
"package_height": 103,
"package_type": "A big package.",
"package_weight_unit": "kg",
"package_width": 222,
"service": "Option 1",
"shipping_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"region": "NY",
"region_code": "NY",
"street_address1": "888 main street",
"street_address2": "apt 3021",
"street_address3": "c/o Alicia Watts",
"street_address4": "Bridge Street Apartment Building B"
},
"shipping_address_id": "address1",
"shipping_method": "unknown",
"signature": "a1B2s3dC4f5g5D6hj6E7k8F9l0",
"tax_amount": 230,
"tax_code": "tax-12345",
"total_weight": 55,
"total_weight_unit": "kg",
"type": "door_delivery"
},
"size": "Large",
"sku": "BOLT-SKU_100",
"seller_id": "seller-1234",
"tags": "tote, blue, linen, eco-friendly",
"total_amount": 1000,
"unit_price": 1000,
"uom": "inches",
"upc": "0825764603119",
"weight": 10,
"weight_unit": "pounds"
}
],
"cart_shipment": {
"carrier": "FedEx",
"cost": 770,
"estimated_delivery_date": "08-30-2022",
"package_depth": 90,
"package_dimension_unit": "cm",
"package_height": 103,
"package_type": "A big package.",
"package_weight_unit": "kg",
"package_width": 222,
"service": "Option 1",
"shipping_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"region": "NY",
"region_code": "NY",
"street_address1": "888 main street",
"street_address2": "apt 3021",
"street_address3": "c/o Alicia Watts",
"street_address4": "Bridge Street Apartment Building B"
},
"shipping_address_id": "address1",
"shipping_method": "unknown",
"signature": "a1B2s3dC4f5g5D6hj6E7k8F9l0",
"tax_amount": 230,
"tax_code": "tax-12345",
"total_weight": 55,
"total_weight_unit": "kg",
"type": "door_delivery"
},
"in_store_cart_shipment": {
"cart_shipment": {
"carrier": "FedEx",
"cost": 770,
"estimated_delivery_date": "08-30-2022",
"package_depth": 90,
"package_dimension_unit": "cm",
"package_height": 103,
"package_type": "A big package.",
"package_weight_unit": "kg",
"package_width": 222,
"service": "Option 1",
"shipping_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"region": "NY",
"region_code": "NY",
"street_address1": "888 main street",
"street_address2": "apt 3021",
"street_address3": "c/o Alicia Watts",
"street_address4": "Bridge Street Apartment Building B"
},
"shipping_address_id": "address1",
"shipping_method": "unknown",
"signature": "a1B2s3dC4f5g5D6hj6E7k8F9l0",
"tax_amount": 230,
"tax_code": "tax-12345",
"total_weight": 55,
"total_weight_unit": "kg",
"type": "door_delivery"
},
"description": "Pick up in-store at 123 Main St.",
"distance": 3,
"distance_unit": "mile",
"in_store_pickup_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"region": "NY",
"region_code": "NY",
"street_address1": "888 main street",
"street_address2": "apt 3021",
"street_address3": "c/o Alicia Watts",
"street_address4": "Bridge Street Apartment Building B"
},
"store_name": "Bolt Collective"
}
}
],
"in_store_cart_shipments": [
{
"cart_shipment": {
"carrier": "FedEx",
"cost": 770,
"estimated_delivery_date": "08-30-2022",
"package_depth": 90,
"package_dimension_unit": "cm",
"package_height": 103,
"package_type": "A big package.",
"package_weight_unit": "kg",
"package_width": 222,
"service": "Option 1",
"shipping_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"region": "NY",
"region_code": "NY",
"street_address1": "888 main street",
"street_address2": "apt 3021",
"street_address3": "c/o Alicia Watts",
"street_address4": "Bridge Street Apartment Building B"
},
"shipping_address_id": "address1",
"shipping_method": "unknown",
"signature": "a1B2s3dC4f5g5D6hj6E7k8F9l0",
"tax_amount": 230,
"tax_code": "tax-12345",
"total_weight": 55,
"total_weight_unit": "kg",
"type": "door_delivery"
},
"description": "Pick up in-store at 123 Main St.",
"distance": 3,
"distance_unit": "mile",
"in_store_pickup_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"region": "NY",
"region_code": "NY",
"street_address1": "888 main street",
"street_address2": "apt 3021",
"street_address3": "c/o Alicia Watts",
"street_address4": "Bridge Street Apartment Building B"
},
"store_name": "Bolt Collective"
}
],
"items": [
{
"brand": "Bolt",
"category": "bags",
"collections": [
"summer"
],
"color": "Bolt Blue",
"customizations": [
{
"attributes": {
"key1": "value1",
"key2": "value2"
},
"price": 754
}
],
"description": "Large tote with Bolt logo.",
"details_url": "https://boltswagstore.com/products/123456",
"gift_option": {
"cost": 770,
"merchant_product_id": "881",
"message": "Happy Anniversary, Smoochy Poo!"
},
"image_url": "https://boltswagstore.com/products/123456/images/1.png",
"isbn": "9780091347314",
"manufacturer": "Bolt Textiles USA",
"merchant_product_id": "881",
"merchant_variant_id": "888",
"name": "Bolt Swag Bag",
"options": "Special Edition",
"quantity": 1,
"reference": "item_100",
"shipment": {
"carrier": "FedEx",
"cost": 770,
"estimated_delivery_date": "08-30-2022",
"package_depth": 90,
"package_dimension_unit": "cm",
"package_height": 103,
"package_type": "A big package.",
"package_weight_unit": "kg",
"package_width": 222,
"service": "Option 1",
"shipping_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"region": "NY",
"region_code": "NY",
"street_address1": "888 main street",
"street_address2": "apt 3021",
"street_address3": "c/o Alicia Watts",
"street_address4": "Bridge Street Apartment Building B"
},
"shipping_address_id": "address1",
"shipping_method": "unknown",
"signature": "a1B2s3dC4f5g5D6hj6E7k8F9l0",
"tax_amount": 230,
"tax_code": "tax-12345",
"total_weight": 55,
"total_weight_unit": "kg",
"type": "door_delivery"
},
"size": "Large",
"sku": "BOLT-SKU_100",
"seller_id": "seller-1234",
"tags": "tote, blue, linen, eco-friendly",
"total_amount": 1000,
"unit_price": 1000,
"uom": "inches",
"upc": "0825764603119",
"weight": 10,
"weight_unit": "pounds"
}
],
"loyalty_rewards": [
{
"description": "$5 off (100 Points)",
"details": "{\"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\"}"
}
],
"shipments": [
{
"carrier": "FedEx",
"cost": 770,
"estimated_delivery_date": "08-30-2022",
"package_depth": 90,
"package_dimension_unit": "cm",
"package_height": 103,
"package_type": "A big package.",
"package_weight_unit": "kg",
"package_width": 222,
"service": "Option 1",
"shipping_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"default": true,
"door_code": "123456",
"email": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone": "+12125550199",
"postal_code": "10044",
"region": "NY",
"region_code": "NY",
"street_address1": "888 main street",
"street_address2": "apt 3021",
"street_address3": "c/o Alicia Watts",
"street_address4": "Bridge Street Apartment Building B"
},
"shipping_address_id": "address1",
"shipping_method": "unknown",
"signature": "a1B2s3dC4f5g5D6hj6E7k8F9l0",
"tax_amount": 230,
"tax_code": "tax-12345",
"total_weight": 55,
"total_weight_unit": "kg",
"type": "door_delivery"
}
],
"total_amount": 900,
"cart_url": "https://boltswagstore.com/orders/123456765432",
"currency": "USD",
"display_id": "displayid_100",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"order_description": "Order #1234567890",
"order_reference": "order_100"
},
"metadata": {
"encrypted_user_id": "ID12345678"
},
"user_note": "Happy Birthday to my best friend in the whole world. Enjoy!",
"seller_splits": [
{
"seller_id": "seller-1234",
"amounts": {
"merchant_subtotal": 5000,
"discount_total": 500,
"shipping_total": 1000,
"tax_total": 400,
"gross_total": 5900
},
"marketplace_commission_fee": {
"bps": 250,
"flat_cents": 100,
"metadata": {
"plan_type": "pro",
"tier": "premium"
}
}
}
]
}Response
Token Generation Successful
Example response
{
"cart": {
"billing_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"door_code": "123456",
"email_address": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone_number": "+12125550199",
"postal_code": "10044",
"priority": "primary",
"region": "NY",
"region_code": "NY",
"street_address1": "888 main street",
"street_address2": "apt 3021",
"street_address3": "c/o Alicia Watts",
"street_address4": "Bridge Street Apartment Building B"
},
"cart_url": "https://boltswagstore.com/orders/123456765432",
"currency": {
"currency": "USD",
"currency_symbol": "$"
},
"discount_amount": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"discounts": [
{
"amount": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"code": "SUMMER10",
"description": "10% off our summer collection",
"details_url": "https://boltswagstore.com/SUMMERSALE",
"reference": "DISC-1234"
}
],
"display_id": "displayid_100",
"fee_amount": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"fees": [
{
"reference": "ItemFee",
"name": "Item Fee",
"description": "Item Fee",
"unit_price": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"unit_tax_amount": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
}
}
],
"items": [
{
"category": "bags",
"collections": [
"summer"
],
"color": "Bolt Blue",
"customizations": [
{
"attributes": {
"key1": "value1",
"key2": "value2"
},
"price": 754
}
],
"details_url": "https://boltswagstore.com/products/123456",
"image_url": "https://boltswagstore.com/products/123456/images/1.png",
"manufacturer": "Bolt Textiles USA",
"msrp": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"quantity": 1,
"size": "Large",
"sku": "BOLT-SKU_100",
"subscription": {
"frequency": {
"unit": "month",
"value": 2
}
},
"tags": "tote, blue, linen, eco-friendly",
"tax_amount": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"total_amount": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"unit_price": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"uom": "inches",
"upc": "0825764603119"
}
],
"order_description": "Order #1234567890",
"order_reference": "order_100",
"shipments": [
{
"carrier": "USPS",
"cost": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"estimated_delivery_date": "2022-04-10 16:12:38.386000+00:00",
"shipping_address": {
"company": "Bolt",
"country": "United States",
"country_code": "US",
"door_code": "123456",
"email_address": "alan.watts@example.com",
"first_name": "Alan",
"last_name": "Watts",
"locality": "Brooklyn",
"name": "Alan Watts",
"phone_number": "+12125550199",
"postal_code": "10044",
"priority": "primary",
"region": "NY",
"region_code": "NY",
"street_address1": "888 main street",
"street_address2": "apt 3021",
"street_address3": "c/o Alicia Watts",
"street_address4": "Bridge Street Apartment Building B"
},
"tax_amount": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
}
}
],
"shipping_amount": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"subtotal_amount": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"tax_amount": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"total_amount": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"transaction_reference": "6CEA-ZME1-DACE"
}
}