Extract eBRC-specific Shipping Bill Data

Extract the eBRC-relevant fields from a shipping bill PDF. Use this variant when you are preparing a bulk eBRC upload; use the full variant when you need the complete document. POST /shipping-bills/extract on the Tradelens host.

Request

file

required

The shipping bill PDF document to process. Must be a valid PDF file under 5 MB.

Headers

string

required

Your Tradelens API key. This is a separate key from your eBRC API key.

string

default:"application/json"

Response content type (application/json)

Example request

curl --location 'https://tradelens-apis.eximfiles.io/platform/shipping-bills/extract' \
--header 'x-api-key: <TRADELENS_API_KEY>' \
--header 'accept: application/json' \
--form 'file=@"/path/to/shipping-bill.pdf"'

const formData = new FormData();
formData.append('file', fileInput.files[0]);

fetch('https://tradelens-apis.eximfiles.io/platform/shipping-bills/extract', {
  method: 'POST',
  headers: {
    'x-api-key': '<TRADELENS_API_KEY>',
    'accept': 'application/json'
  },
  body: formData
})
.then(response => response.json())
.then(data => console.log(data));

import requests

url = "https://tradelens-apis.eximfiles.io/platform/shipping-bills/extract"
headers = {
    "x-api-key": "<TRADELENS_API_KEY>",
    "accept": "application/json"
}
files = {
    "file": open("shipping-bill.pdf", "rb")
}

response = requests.post(url, headers=headers, files=files)
data = response.json()

Response

string

Processing status (success/error)

object

Extracted shipping bill data

Extract complete Shipping Bill Data for the whole document.
Bulk Upload via Excel to file the extracted rows.
Data Extraction overview for auth and limits.

​Request

​Headers

​Example request

​Response

​Related

Request

Headers

Example request

Response

Related