Send order tracking details
curl --request POST \
--url https://api.bolt.com/v1/merchant/track_shipment \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"carrier": "UPS",
"items": [
{
"name": "Blue Hat",
"quantity": 3,
"reference": "1123",
"total_amount": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"unit_price": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"bolt_product_id": "e2bb0e7e-5625-536f-8ad7-25a26537ee28",
"brand": "Bolt Swagstore",
"category": "hats",
"collections": [
"summer"
],
"color": "Red",
"customizations": [
{
"attributes": {
"key1": "value1",
"key2": "value2"
},
"name": "Bedazzled",
"price": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
}
}
],
"description": " Large blue satin hat with initials embroidered.",
"details_url": "https://boltswagstore.com/inventory/hats/red-hat.png",
"image_url": "https://boltswagstore.com/inventory/hats/red-hat.png",
"isbn": "12-345-678-90123",
"item_group": "Ships Immediately",
"manufacturer": "Bolt Factory",
"options": "string option",
"properties": [
{
"name": "a-name",
"value": "a-value"
}
],
"size": "XXL",
"sku": "SKU-11021",
"tags": "red",
"taxable": true,
"type": "physical",
"uom": "string",
"upc": "string",
"weight": {
"unit": "kg",
"weight": 22
}
}
],
"tracking_number": "EZ1000000001",
"transaction_reference": "LBLJ-TWW7-R9VC",
"is_non_bolt_order": false
}
'import requests
url = "https://api.bolt.com/v1/merchant/track_shipment"
payload = {
"carrier": "UPS",
"items": [
{
"name": "Blue Hat",
"quantity": 3,
"reference": "1123",
"total_amount": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"unit_price": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"bolt_product_id": "e2bb0e7e-5625-536f-8ad7-25a26537ee28",
"brand": "Bolt Swagstore",
"category": "hats",
"collections": ["summer"],
"color": "Red",
"customizations": [
{
"attributes": {
"key1": "value1",
"key2": "value2"
},
"name": "Bedazzled",
"price": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
}
}
],
"description": " Large blue satin hat with initials embroidered.",
"details_url": "https://boltswagstore.com/inventory/hats/red-hat.png",
"image_url": "https://boltswagstore.com/inventory/hats/red-hat.png",
"isbn": "12-345-678-90123",
"item_group": "Ships Immediately",
"manufacturer": "Bolt Factory",
"options": "string option",
"properties": [
{
"name": "a-name",
"value": "a-value"
}
],
"size": "XXL",
"sku": "SKU-11021",
"tags": "red",
"taxable": True,
"type": "physical",
"uom": "string",
"upc": "string",
"weight": {
"unit": "kg",
"weight": 22
}
}
],
"tracking_number": "EZ1000000001",
"transaction_reference": "LBLJ-TWW7-R9VC",
"is_non_bolt_order": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
carrier: 'UPS',
items: [
{
name: 'Blue Hat',
quantity: 3,
reference: '1123',
total_amount: {amount: 754, currency: 'USD', currency_symbol: '$'},
unit_price: {amount: 754, currency: 'USD', currency_symbol: '$'},
bolt_product_id: 'e2bb0e7e-5625-536f-8ad7-25a26537ee28',
brand: 'Bolt Swagstore',
category: 'hats',
collections: ['summer'],
color: 'Red',
customizations: [
{
attributes: {key1: 'value1', key2: 'value2'},
name: 'Bedazzled',
price: {amount: 754, currency: 'USD', currency_symbol: '$'}
}
],
description: ' Large blue satin hat with initials embroidered.',
details_url: 'https://boltswagstore.com/inventory/hats/red-hat.png',
image_url: 'https://boltswagstore.com/inventory/hats/red-hat.png',
isbn: '12-345-678-90123',
item_group: 'Ships Immediately',
manufacturer: 'Bolt Factory',
options: 'string option',
properties: [{name: 'a-name', value: 'a-value'}],
size: 'XXL',
sku: 'SKU-11021',
tags: 'red',
taxable: true,
type: 'physical',
uom: 'string',
upc: 'string',
weight: {unit: 'kg', weight: 22}
}
],
tracking_number: 'EZ1000000001',
transaction_reference: 'LBLJ-TWW7-R9VC',
is_non_bolt_order: false
})
};
fetch('https://api.bolt.com/v1/merchant/track_shipment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bolt.com/v1/merchant/track_shipment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'carrier' => 'UPS',
'items' => [
[
'name' => 'Blue Hat',
'quantity' => 3,
'reference' => '1123',
'total_amount' => [
'amount' => 754,
'currency' => 'USD',
'currency_symbol' => '$'
],
'unit_price' => [
'amount' => 754,
'currency' => 'USD',
'currency_symbol' => '$'
],
'bolt_product_id' => 'e2bb0e7e-5625-536f-8ad7-25a26537ee28',
'brand' => 'Bolt Swagstore',
'category' => 'hats',
'collections' => [
'summer'
],
'color' => 'Red',
'customizations' => [
[
'attributes' => [
'key1' => 'value1',
'key2' => 'value2'
],
'name' => 'Bedazzled',
'price' => [
'amount' => 754,
'currency' => 'USD',
'currency_symbol' => '$'
]
]
],
'description' => ' Large blue satin hat with initials embroidered.',
'details_url' => 'https://boltswagstore.com/inventory/hats/red-hat.png',
'image_url' => 'https://boltswagstore.com/inventory/hats/red-hat.png',
'isbn' => '12-345-678-90123',
'item_group' => 'Ships Immediately',
'manufacturer' => 'Bolt Factory',
'options' => 'string option',
'properties' => [
[
'name' => 'a-name',
'value' => 'a-value'
]
],
'size' => 'XXL',
'sku' => 'SKU-11021',
'tags' => 'red',
'taxable' => true,
'type' => 'physical',
'uom' => 'string',
'upc' => 'string',
'weight' => [
'unit' => 'kg',
'weight' => 22
]
]
],
'tracking_number' => 'EZ1000000001',
'transaction_reference' => 'LBLJ-TWW7-R9VC',
'is_non_bolt_order' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bolt.com/v1/merchant/track_shipment"
payload := strings.NewReader("{\n \"carrier\": \"UPS\",\n \"items\": [\n {\n \"name\": \"Blue Hat\",\n \"quantity\": 3,\n \"reference\": \"1123\",\n \"total_amount\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n },\n \"unit_price\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n },\n \"bolt_product_id\": \"e2bb0e7e-5625-536f-8ad7-25a26537ee28\",\n \"brand\": \"Bolt Swagstore\",\n \"category\": \"hats\",\n \"collections\": [\n \"summer\"\n ],\n \"color\": \"Red\",\n \"customizations\": [\n {\n \"attributes\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"name\": \"Bedazzled\",\n \"price\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n }\n }\n ],\n \"description\": \" Large blue satin hat with initials embroidered.\",\n \"details_url\": \"https://boltswagstore.com/inventory/hats/red-hat.png\",\n \"image_url\": \"https://boltswagstore.com/inventory/hats/red-hat.png\",\n \"isbn\": \"12-345-678-90123\",\n \"item_group\": \"Ships Immediately\",\n \"manufacturer\": \"Bolt Factory\",\n \"options\": \"string option\",\n \"properties\": [\n {\n \"name\": \"a-name\",\n \"value\": \"a-value\"\n }\n ],\n \"size\": \"XXL\",\n \"sku\": \"SKU-11021\",\n \"tags\": \"red\",\n \"taxable\": true,\n \"type\": \"physical\",\n \"uom\": \"string\",\n \"upc\": \"string\",\n \"weight\": {\n \"unit\": \"kg\",\n \"weight\": 22\n }\n }\n ],\n \"tracking_number\": \"EZ1000000001\",\n \"transaction_reference\": \"LBLJ-TWW7-R9VC\",\n \"is_non_bolt_order\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bolt.com/v1/merchant/track_shipment")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"carrier\": \"UPS\",\n \"items\": [\n {\n \"name\": \"Blue Hat\",\n \"quantity\": 3,\n \"reference\": \"1123\",\n \"total_amount\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n },\n \"unit_price\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n },\n \"bolt_product_id\": \"e2bb0e7e-5625-536f-8ad7-25a26537ee28\",\n \"brand\": \"Bolt Swagstore\",\n \"category\": \"hats\",\n \"collections\": [\n \"summer\"\n ],\n \"color\": \"Red\",\n \"customizations\": [\n {\n \"attributes\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"name\": \"Bedazzled\",\n \"price\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n }\n }\n ],\n \"description\": \" Large blue satin hat with initials embroidered.\",\n \"details_url\": \"https://boltswagstore.com/inventory/hats/red-hat.png\",\n \"image_url\": \"https://boltswagstore.com/inventory/hats/red-hat.png\",\n \"isbn\": \"12-345-678-90123\",\n \"item_group\": \"Ships Immediately\",\n \"manufacturer\": \"Bolt Factory\",\n \"options\": \"string option\",\n \"properties\": [\n {\n \"name\": \"a-name\",\n \"value\": \"a-value\"\n }\n ],\n \"size\": \"XXL\",\n \"sku\": \"SKU-11021\",\n \"tags\": \"red\",\n \"taxable\": true,\n \"type\": \"physical\",\n \"uom\": \"string\",\n \"upc\": \"string\",\n \"weight\": {\n \"unit\": \"kg\",\n \"weight\": 22\n }\n }\n ],\n \"tracking_number\": \"EZ1000000001\",\n \"transaction_reference\": \"LBLJ-TWW7-R9VC\",\n \"is_non_bolt_order\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bolt.com/v1/merchant/track_shipment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"carrier\": \"UPS\",\n \"items\": [\n {\n \"name\": \"Blue Hat\",\n \"quantity\": 3,\n \"reference\": \"1123\",\n \"total_amount\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n },\n \"unit_price\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n },\n \"bolt_product_id\": \"e2bb0e7e-5625-536f-8ad7-25a26537ee28\",\n \"brand\": \"Bolt Swagstore\",\n \"category\": \"hats\",\n \"collections\": [\n \"summer\"\n ],\n \"color\": \"Red\",\n \"customizations\": [\n {\n \"attributes\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"name\": \"Bedazzled\",\n \"price\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n }\n }\n ],\n \"description\": \" Large blue satin hat with initials embroidered.\",\n \"details_url\": \"https://boltswagstore.com/inventory/hats/red-hat.png\",\n \"image_url\": \"https://boltswagstore.com/inventory/hats/red-hat.png\",\n \"isbn\": \"12-345-678-90123\",\n \"item_group\": \"Ships Immediately\",\n \"manufacturer\": \"Bolt Factory\",\n \"options\": \"string option\",\n \"properties\": [\n {\n \"name\": \"a-name\",\n \"value\": \"a-value\"\n }\n ],\n \"size\": \"XXL\",\n \"sku\": \"SKU-11021\",\n \"tags\": \"red\",\n \"taxable\": true,\n \"type\": \"physical\",\n \"uom\": \"string\",\n \"upc\": \"string\",\n \"weight\": {\n \"unit\": \"kg\",\n \"weight\": 22\n }\n }\n ],\n \"tracking_number\": \"EZ1000000001\",\n \"transaction_reference\": \"LBLJ-TWW7-R9VC\",\n \"is_non_bolt_order\": false\n}"
response = http.request(request)
puts response.read_body{}{
"errors": [
{
"code": 2001005,
"message": "The input is missing a required parameter."
}
],
"result": {
"success": false
}
}{
"errors": [
{
"code": 2001005,
"message": "The input is missing a required parameter."
}
],
"result": {
"success": false
}
}Orders
Send order tracking details
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.
POST
/
v1
/
merchant
/
track_shipment
Send order tracking details
curl --request POST \
--url https://api.bolt.com/v1/merchant/track_shipment \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"carrier": "UPS",
"items": [
{
"name": "Blue Hat",
"quantity": 3,
"reference": "1123",
"total_amount": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"unit_price": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"bolt_product_id": "e2bb0e7e-5625-536f-8ad7-25a26537ee28",
"brand": "Bolt Swagstore",
"category": "hats",
"collections": [
"summer"
],
"color": "Red",
"customizations": [
{
"attributes": {
"key1": "value1",
"key2": "value2"
},
"name": "Bedazzled",
"price": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
}
}
],
"description": " Large blue satin hat with initials embroidered.",
"details_url": "https://boltswagstore.com/inventory/hats/red-hat.png",
"image_url": "https://boltswagstore.com/inventory/hats/red-hat.png",
"isbn": "12-345-678-90123",
"item_group": "Ships Immediately",
"manufacturer": "Bolt Factory",
"options": "string option",
"properties": [
{
"name": "a-name",
"value": "a-value"
}
],
"size": "XXL",
"sku": "SKU-11021",
"tags": "red",
"taxable": true,
"type": "physical",
"uom": "string",
"upc": "string",
"weight": {
"unit": "kg",
"weight": 22
}
}
],
"tracking_number": "EZ1000000001",
"transaction_reference": "LBLJ-TWW7-R9VC",
"is_non_bolt_order": false
}
'import requests
url = "https://api.bolt.com/v1/merchant/track_shipment"
payload = {
"carrier": "UPS",
"items": [
{
"name": "Blue Hat",
"quantity": 3,
"reference": "1123",
"total_amount": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"unit_price": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
},
"bolt_product_id": "e2bb0e7e-5625-536f-8ad7-25a26537ee28",
"brand": "Bolt Swagstore",
"category": "hats",
"collections": ["summer"],
"color": "Red",
"customizations": [
{
"attributes": {
"key1": "value1",
"key2": "value2"
},
"name": "Bedazzled",
"price": {
"amount": 754,
"currency": "USD",
"currency_symbol": "$"
}
}
],
"description": " Large blue satin hat with initials embroidered.",
"details_url": "https://boltswagstore.com/inventory/hats/red-hat.png",
"image_url": "https://boltswagstore.com/inventory/hats/red-hat.png",
"isbn": "12-345-678-90123",
"item_group": "Ships Immediately",
"manufacturer": "Bolt Factory",
"options": "string option",
"properties": [
{
"name": "a-name",
"value": "a-value"
}
],
"size": "XXL",
"sku": "SKU-11021",
"tags": "red",
"taxable": True,
"type": "physical",
"uom": "string",
"upc": "string",
"weight": {
"unit": "kg",
"weight": 22
}
}
],
"tracking_number": "EZ1000000001",
"transaction_reference": "LBLJ-TWW7-R9VC",
"is_non_bolt_order": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
carrier: 'UPS',
items: [
{
name: 'Blue Hat',
quantity: 3,
reference: '1123',
total_amount: {amount: 754, currency: 'USD', currency_symbol: '$'},
unit_price: {amount: 754, currency: 'USD', currency_symbol: '$'},
bolt_product_id: 'e2bb0e7e-5625-536f-8ad7-25a26537ee28',
brand: 'Bolt Swagstore',
category: 'hats',
collections: ['summer'],
color: 'Red',
customizations: [
{
attributes: {key1: 'value1', key2: 'value2'},
name: 'Bedazzled',
price: {amount: 754, currency: 'USD', currency_symbol: '$'}
}
],
description: ' Large blue satin hat with initials embroidered.',
details_url: 'https://boltswagstore.com/inventory/hats/red-hat.png',
image_url: 'https://boltswagstore.com/inventory/hats/red-hat.png',
isbn: '12-345-678-90123',
item_group: 'Ships Immediately',
manufacturer: 'Bolt Factory',
options: 'string option',
properties: [{name: 'a-name', value: 'a-value'}],
size: 'XXL',
sku: 'SKU-11021',
tags: 'red',
taxable: true,
type: 'physical',
uom: 'string',
upc: 'string',
weight: {unit: 'kg', weight: 22}
}
],
tracking_number: 'EZ1000000001',
transaction_reference: 'LBLJ-TWW7-R9VC',
is_non_bolt_order: false
})
};
fetch('https://api.bolt.com/v1/merchant/track_shipment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bolt.com/v1/merchant/track_shipment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'carrier' => 'UPS',
'items' => [
[
'name' => 'Blue Hat',
'quantity' => 3,
'reference' => '1123',
'total_amount' => [
'amount' => 754,
'currency' => 'USD',
'currency_symbol' => '$'
],
'unit_price' => [
'amount' => 754,
'currency' => 'USD',
'currency_symbol' => '$'
],
'bolt_product_id' => 'e2bb0e7e-5625-536f-8ad7-25a26537ee28',
'brand' => 'Bolt Swagstore',
'category' => 'hats',
'collections' => [
'summer'
],
'color' => 'Red',
'customizations' => [
[
'attributes' => [
'key1' => 'value1',
'key2' => 'value2'
],
'name' => 'Bedazzled',
'price' => [
'amount' => 754,
'currency' => 'USD',
'currency_symbol' => '$'
]
]
],
'description' => ' Large blue satin hat with initials embroidered.',
'details_url' => 'https://boltswagstore.com/inventory/hats/red-hat.png',
'image_url' => 'https://boltswagstore.com/inventory/hats/red-hat.png',
'isbn' => '12-345-678-90123',
'item_group' => 'Ships Immediately',
'manufacturer' => 'Bolt Factory',
'options' => 'string option',
'properties' => [
[
'name' => 'a-name',
'value' => 'a-value'
]
],
'size' => 'XXL',
'sku' => 'SKU-11021',
'tags' => 'red',
'taxable' => true,
'type' => 'physical',
'uom' => 'string',
'upc' => 'string',
'weight' => [
'unit' => 'kg',
'weight' => 22
]
]
],
'tracking_number' => 'EZ1000000001',
'transaction_reference' => 'LBLJ-TWW7-R9VC',
'is_non_bolt_order' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bolt.com/v1/merchant/track_shipment"
payload := strings.NewReader("{\n \"carrier\": \"UPS\",\n \"items\": [\n {\n \"name\": \"Blue Hat\",\n \"quantity\": 3,\n \"reference\": \"1123\",\n \"total_amount\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n },\n \"unit_price\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n },\n \"bolt_product_id\": \"e2bb0e7e-5625-536f-8ad7-25a26537ee28\",\n \"brand\": \"Bolt Swagstore\",\n \"category\": \"hats\",\n \"collections\": [\n \"summer\"\n ],\n \"color\": \"Red\",\n \"customizations\": [\n {\n \"attributes\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"name\": \"Bedazzled\",\n \"price\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n }\n }\n ],\n \"description\": \" Large blue satin hat with initials embroidered.\",\n \"details_url\": \"https://boltswagstore.com/inventory/hats/red-hat.png\",\n \"image_url\": \"https://boltswagstore.com/inventory/hats/red-hat.png\",\n \"isbn\": \"12-345-678-90123\",\n \"item_group\": \"Ships Immediately\",\n \"manufacturer\": \"Bolt Factory\",\n \"options\": \"string option\",\n \"properties\": [\n {\n \"name\": \"a-name\",\n \"value\": \"a-value\"\n }\n ],\n \"size\": \"XXL\",\n \"sku\": \"SKU-11021\",\n \"tags\": \"red\",\n \"taxable\": true,\n \"type\": \"physical\",\n \"uom\": \"string\",\n \"upc\": \"string\",\n \"weight\": {\n \"unit\": \"kg\",\n \"weight\": 22\n }\n }\n ],\n \"tracking_number\": \"EZ1000000001\",\n \"transaction_reference\": \"LBLJ-TWW7-R9VC\",\n \"is_non_bolt_order\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bolt.com/v1/merchant/track_shipment")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"carrier\": \"UPS\",\n \"items\": [\n {\n \"name\": \"Blue Hat\",\n \"quantity\": 3,\n \"reference\": \"1123\",\n \"total_amount\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n },\n \"unit_price\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n },\n \"bolt_product_id\": \"e2bb0e7e-5625-536f-8ad7-25a26537ee28\",\n \"brand\": \"Bolt Swagstore\",\n \"category\": \"hats\",\n \"collections\": [\n \"summer\"\n ],\n \"color\": \"Red\",\n \"customizations\": [\n {\n \"attributes\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"name\": \"Bedazzled\",\n \"price\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n }\n }\n ],\n \"description\": \" Large blue satin hat with initials embroidered.\",\n \"details_url\": \"https://boltswagstore.com/inventory/hats/red-hat.png\",\n \"image_url\": \"https://boltswagstore.com/inventory/hats/red-hat.png\",\n \"isbn\": \"12-345-678-90123\",\n \"item_group\": \"Ships Immediately\",\n \"manufacturer\": \"Bolt Factory\",\n \"options\": \"string option\",\n \"properties\": [\n {\n \"name\": \"a-name\",\n \"value\": \"a-value\"\n }\n ],\n \"size\": \"XXL\",\n \"sku\": \"SKU-11021\",\n \"tags\": \"red\",\n \"taxable\": true,\n \"type\": \"physical\",\n \"uom\": \"string\",\n \"upc\": \"string\",\n \"weight\": {\n \"unit\": \"kg\",\n \"weight\": 22\n }\n }\n ],\n \"tracking_number\": \"EZ1000000001\",\n \"transaction_reference\": \"LBLJ-TWW7-R9VC\",\n \"is_non_bolt_order\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bolt.com/v1/merchant/track_shipment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"carrier\": \"UPS\",\n \"items\": [\n {\n \"name\": \"Blue Hat\",\n \"quantity\": 3,\n \"reference\": \"1123\",\n \"total_amount\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n },\n \"unit_price\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n },\n \"bolt_product_id\": \"e2bb0e7e-5625-536f-8ad7-25a26537ee28\",\n \"brand\": \"Bolt Swagstore\",\n \"category\": \"hats\",\n \"collections\": [\n \"summer\"\n ],\n \"color\": \"Red\",\n \"customizations\": [\n {\n \"attributes\": {\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n },\n \"name\": \"Bedazzled\",\n \"price\": {\n \"amount\": 754,\n \"currency\": \"USD\",\n \"currency_symbol\": \"$\"\n }\n }\n ],\n \"description\": \" Large blue satin hat with initials embroidered.\",\n \"details_url\": \"https://boltswagstore.com/inventory/hats/red-hat.png\",\n \"image_url\": \"https://boltswagstore.com/inventory/hats/red-hat.png\",\n \"isbn\": \"12-345-678-90123\",\n \"item_group\": \"Ships Immediately\",\n \"manufacturer\": \"Bolt Factory\",\n \"options\": \"string option\",\n \"properties\": [\n {\n \"name\": \"a-name\",\n \"value\": \"a-value\"\n }\n ],\n \"size\": \"XXL\",\n \"sku\": \"SKU-11021\",\n \"tags\": \"red\",\n \"taxable\": true,\n \"type\": \"physical\",\n \"uom\": \"string\",\n \"upc\": \"string\",\n \"weight\": {\n \"unit\": \"kg\",\n \"weight\": 22\n }\n }\n ],\n \"tracking_number\": \"EZ1000000001\",\n \"transaction_reference\": \"LBLJ-TWW7-R9VC\",\n \"is_non_bolt_order\": false\n}"
response = http.request(request)
puts response.read_body{}{
"errors": [
{
"code": 2001005,
"message": "The input is missing a required parameter."
}
],
"result": {
"success": false
}
}{
"errors": [
{
"code": 2001005,
"message": "The input is missing a required parameter."
}
],
"result": {
"success": false
}
}Authorizations
Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard.
Body
application/json
Send order tracking details.
the name of the carrier used for shipment.
Example:
"UPS"
A list of items.
Show child attributes
Show child attributes
The carrier's tracking number for the shipment.
Example:
"EZ1000000001"
The transaction's 12-digit Bolt reference ID. Nullable for Transactions Details.
Required string length:
12Example:
"LBLJ-TWW7-R9VC"
Designates if the order was placed outside of Bolt checkout.
Example:
false
Response
Order Tracking Successful
The response is of type object.
⌘I