Test Shipping
curl --request POST \
--url https://api.bolt.com/v1/shipments/mock_bolt_shipping \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"delivery_estimate": "<string>",
"tracking_detail": [
{
"city": "New York",
"country": "USA",
"datetime": "2017-07-21T17:32:28Z",
"message": "BILLING INFORMATION RECEIVED",
"state": "New York",
"status": "in_transit",
"zip": "10044"
}
],
"tracking_number": "MockBolt1234"
}
'import requests
url = "https://api.bolt.com/v1/shipments/mock_bolt_shipping"
payload = {
"delivery_estimate": "<string>",
"tracking_detail": [
{
"city": "New York",
"country": "USA",
"datetime": "2017-07-21T17:32:28Z",
"message": "BILLING INFORMATION RECEIVED",
"state": "New York",
"status": "in_transit",
"zip": "10044"
}
],
"tracking_number": "MockBolt1234"
}
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({
delivery_estimate: '<string>',
tracking_detail: [
{
city: 'New York',
country: 'USA',
datetime: '2017-07-21T17:32:28Z',
message: 'BILLING INFORMATION RECEIVED',
state: 'New York',
status: 'in_transit',
zip: '10044'
}
],
tracking_number: 'MockBolt1234'
})
};
fetch('https://api.bolt.com/v1/shipments/mock_bolt_shipping', 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/shipments/mock_bolt_shipping",
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([
'delivery_estimate' => '<string>',
'tracking_detail' => [
[
'city' => 'New York',
'country' => 'USA',
'datetime' => '2017-07-21T17:32:28Z',
'message' => 'BILLING INFORMATION RECEIVED',
'state' => 'New York',
'status' => 'in_transit',
'zip' => '10044'
]
],
'tracking_number' => 'MockBolt1234'
]),
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/shipments/mock_bolt_shipping"
payload := strings.NewReader("{\n \"delivery_estimate\": \"<string>\",\n \"tracking_detail\": [\n {\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"datetime\": \"2017-07-21T17:32:28Z\",\n \"message\": \"BILLING INFORMATION RECEIVED\",\n \"state\": \"New York\",\n \"status\": \"in_transit\",\n \"zip\": \"10044\"\n }\n ],\n \"tracking_number\": \"MockBolt1234\"\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/shipments/mock_bolt_shipping")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"delivery_estimate\": \"<string>\",\n \"tracking_detail\": [\n {\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"datetime\": \"2017-07-21T17:32:28Z\",\n \"message\": \"BILLING INFORMATION RECEIVED\",\n \"state\": \"New York\",\n \"status\": \"in_transit\",\n \"zip\": \"10044\"\n }\n ],\n \"tracking_number\": \"MockBolt1234\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bolt.com/v1/shipments/mock_bolt_shipping")
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 \"delivery_estimate\": \"<string>\",\n \"tracking_detail\": [\n {\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"datetime\": \"2017-07-21T17:32:28Z\",\n \"message\": \"BILLING INFORMATION RECEIVED\",\n \"state\": \"New York\",\n \"status\": \"in_transit\",\n \"zip\": \"10044\"\n }\n ],\n \"tracking_number\": \"MockBolt1234\"\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
}
}Testing
Test Shipping
This endpoint simulates tracking an order’s shipment and is for testing purposes only.
POST
/
v1
/
shipments
/
mock_bolt_shipping
Test Shipping
curl --request POST \
--url https://api.bolt.com/v1/shipments/mock_bolt_shipping \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"delivery_estimate": "<string>",
"tracking_detail": [
{
"city": "New York",
"country": "USA",
"datetime": "2017-07-21T17:32:28Z",
"message": "BILLING INFORMATION RECEIVED",
"state": "New York",
"status": "in_transit",
"zip": "10044"
}
],
"tracking_number": "MockBolt1234"
}
'import requests
url = "https://api.bolt.com/v1/shipments/mock_bolt_shipping"
payload = {
"delivery_estimate": "<string>",
"tracking_detail": [
{
"city": "New York",
"country": "USA",
"datetime": "2017-07-21T17:32:28Z",
"message": "BILLING INFORMATION RECEIVED",
"state": "New York",
"status": "in_transit",
"zip": "10044"
}
],
"tracking_number": "MockBolt1234"
}
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({
delivery_estimate: '<string>',
tracking_detail: [
{
city: 'New York',
country: 'USA',
datetime: '2017-07-21T17:32:28Z',
message: 'BILLING INFORMATION RECEIVED',
state: 'New York',
status: 'in_transit',
zip: '10044'
}
],
tracking_number: 'MockBolt1234'
})
};
fetch('https://api.bolt.com/v1/shipments/mock_bolt_shipping', 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/shipments/mock_bolt_shipping",
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([
'delivery_estimate' => '<string>',
'tracking_detail' => [
[
'city' => 'New York',
'country' => 'USA',
'datetime' => '2017-07-21T17:32:28Z',
'message' => 'BILLING INFORMATION RECEIVED',
'state' => 'New York',
'status' => 'in_transit',
'zip' => '10044'
]
],
'tracking_number' => 'MockBolt1234'
]),
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/shipments/mock_bolt_shipping"
payload := strings.NewReader("{\n \"delivery_estimate\": \"<string>\",\n \"tracking_detail\": [\n {\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"datetime\": \"2017-07-21T17:32:28Z\",\n \"message\": \"BILLING INFORMATION RECEIVED\",\n \"state\": \"New York\",\n \"status\": \"in_transit\",\n \"zip\": \"10044\"\n }\n ],\n \"tracking_number\": \"MockBolt1234\"\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/shipments/mock_bolt_shipping")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"delivery_estimate\": \"<string>\",\n \"tracking_detail\": [\n {\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"datetime\": \"2017-07-21T17:32:28Z\",\n \"message\": \"BILLING INFORMATION RECEIVED\",\n \"state\": \"New York\",\n \"status\": \"in_transit\",\n \"zip\": \"10044\"\n }\n ],\n \"tracking_number\": \"MockBolt1234\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bolt.com/v1/shipments/mock_bolt_shipping")
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 \"delivery_estimate\": \"<string>\",\n \"tracking_detail\": [\n {\n \"city\": \"New York\",\n \"country\": \"USA\",\n \"datetime\": \"2017-07-21T17:32:28Z\",\n \"message\": \"BILLING INFORMATION RECEIVED\",\n \"state\": \"New York\",\n \"status\": \"in_transit\",\n \"zip\": \"10044\"\n }\n ],\n \"tracking_number\": \"MockBolt1234\"\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
The shipment status of a simulated order.
Available options:
in_transit, cancelled, failure, delivered A list of tracking updates that contain the shipment's status, location, and any unique messages.
Show child attributes
Show child attributes
The carrier's tracking number for the shipment (Order Tracking Testing). Must begin with MockBolt.
Example:
"MockBolt1234"
Response
Success - No Details
⌘I