Get a Shipment by ID

Example

This example shows how to call the GET /v1/shipments/:shipment_id endpoint successfully.

Request

curl -X GET "https://brdrch.com/api /v1/shipments/:shipment_id" \
-u "cd3b3de84cc1ee040bf06512d233719c" \
-d '{}'

Response

{
  "shipment_reference": "1daa0c22",
  "additional_shipment_reference": "112302152233",
  "process_label": true,
  "service_code": "BRCExp",
  "client_id": "12546254",
  "contents": {
    "items": [
      {
        "sku": "4225-776-3234",
        "quantity": 4,
        "price": 10.99,
        "description": "Mens Polo Shirt Cotton",
        "country_of_origin": "US",
        "harmonized_tariff_code": "4817.20",
        "package_reference": "ABC1234"
      }
    ]
  },
  "ship_to": {
    "name": "James Cameron",
    "phone": "555-555-5555",
    "email": "[email protected]",
    "address_line1": "655 Queen Street West",
    "address_line2": "apt 123",
    "city_locality": "Toronto",
    "state_province": "ON",
    "postal_code": "M6J 1E4",
    "country_code": "CA"
  },
  "packages": [
    {
      "package_reference": "ABC1234",
      "weight": 10,
      "dimensions": {
        "length": 10,
        "height": 10,
        "width": 10
      }
    },
    {
      "package_reference": "4567",
      "weight": 10,
      "dimensions": {
        "length": 10,
        "height": 10,
        "width": 10
      }
    }
  ],
  "metadata": [
    {
      "name": "notes",
      "type": "string",
      "value": "delivery notes"
    }
  ]
}