v2

latestOpenAPI 3.0.02026-07-3139594346.4 KB

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

Request body

carrierstring required

the name of the carrier used for shipment.

is_non_bolt_orderboolean

Designates if the order was placed outside of Bolt checkout.

tracking_numberstring required

The carrier's tracking number for the shipment.

transaction_referencestring required

The transaction's 12-digit Bolt reference ID. Nullable for Transactions Details.

Example request

{
  "carrier": "UPS",
  "items": [
    {
      "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",
      "name": "Blue Hat",
      "options": "string option",
      "properties": [
        {
          "name": "a-name",
          "value": "a-value"
        }
      ],
      "quantity": 3,
      "reference": "1123",
      "size": "XXL",
      "sku": "SKU-11021",
      "tags": "red",
      "tax_amount": {
        "amount": 754,
        "currency": "USD",
        "currency_symbol": "$"
      },
      "taxable": true,
      "total_amount": {
        "amount": 754,
        "currency": "USD",
        "currency_symbol": "$"
      },
      "type": "physical",
      "unit_price": {
        "amount": 754,
        "currency": "USD",
        "currency_symbol": "$"
      },
      "uom": "string",
      "upc": "string",
      "weight": {
        "unit": "kg",
        "weight": 22
      }
    }
  ],
  "tracking_number": "EZ1000000001",
  "transaction_reference": "LBLJ-TWW7-R9VC"
}

Response

Order Tracking Successful

object required