Lodgement

The first step in creating a manifest is determining which labels to include in the manifest and the best way to specify them in your request to Broad Reach.

The page explains how to create a manifest using the /v1/manifests endpoint and the HTTP POST method.

You may explicitly specify the labels you want to include in the manifest using the label_ids property.

Request

POST https://brdrch.com/api/v1/lodgement 

{
  "dispatch_id": "SLCBRDRCH2022050901",
  "processing_location": "LAX",
  "lodgement_type":"domestic",
  "tracking_numbers": [
    {
      "tracking_number": "BR123005",
      "receptacle_number": "LAXBRDRCHS025412",
      "client_id": "2"
    },
    {
      "tracking_number": "BR234234",
      "receptacle_number": "LAXBRDRCHS025413",
      "client_id": "2"
    }
  ],
  "border_trucking": "Bobs Trucking",
  "tracking": "BT12345",
  "third_party_clearance": true,
  "pre_process": true,
  "third_party_clearance_vendor": "livingston",
  "transportation_method": "air",
  "mawb": "ACAD0524"
}

Response

{
  "lodgement_id": "23234",
  "dispatch_id": "SLCBRDRCH2022050901",
  "processing_location": "LAX",
  "lodgement_type":"domestic",
  "tracking_numbers": [
    {
      "tracking_number": "BR123005",
      "receptacle_number": "LAXBRDRCHS025412",
      "client_id": "2"
    },
    {
      "tracking_number": "BR234234",
      "receptacle_number": "LAXBRDRCHS025413",
      "client_id": "2"
    }
  ],
  "border_trucking": "Bobs Trucking",
  "tracking": "BT12345",
  "third_party_clearance": true,
  "pre_process": true,
  "third_party_clearance_vendor": "livingston",
  "transportation_method": "air",
  "mawb": "ACAD0524",
  "label_download": {
     "tracking_number":"BRL23445634532",
     "pdf": "https://api.brdrch.com/v1/downloads/10/XNGDhq7uZ0CAEt5LOnCxIg/label-7764944.pdf",
     "pdf_base64": "1791234h1239412h34-219u349u9128347123984h1234h-912834y12h381234yh123812348"
   }
}