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"
}
'
{
  "errors": [
    {
      "code": 2001005,
      "message": "The input is missing a required parameter."
    }
  ],
  "result": {
    "success": false
  }
}

Authorizations

​
X-API-Key
string
header
required

Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard.

Body

application/json
​
delivery_estimate
string
required
​
status
enum<string>
required

The shipment status of a simulated order.

Available options:
in_transit,
cancelled,
failure,
delivered
​
tracking_detail
object[]
required

A list of tracking updates that contain the shipment's status, location, and any unique messages.

​
tracking_number
string
required

The carrier's tracking number for the shipment (Order Tracking Testing). Must begin with MockBolt.

Example:

"MockBolt1234"

Response

Success - No Details