Extract Shipping Bill Data

Extract a shipping bill PDF. One call returns the summary fields, the full parsed document and a verification report. POST /shipping-bills/platform/extract

Request

file

required

The shipping bill PDF. Maximum 10 MB, one file per request. Must be the PDF downloaded from ICEGATE. A scan or photo has no text layer and is rejected.

Headers

string

required

Your eBRC API key (dev_ or prod_). Extraction has no separate credential. See Authentication.

Example request

curl --location 'https://api.ebrc.in/api/v1/shipping-bills/platform/extract' \
--header 'x-api-key: prod_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--form 'file=@"/path/to/shipping-bill.pdf"'

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

const res = await fetch('https://api.ebrc.in/api/v1/shipping-bills/platform/extract', {
  method: 'POST',
  headers: { 'x-api-key': 'prod_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' },
  body: formData,
});

const { data } = await res.json();
console.log(data.fields.shippingBillNumber, data.verification.passed);

import requests

res = requests.post(
    "https://api.ebrc.in/api/v1/shipping-bills/platform/extract",
    headers={"x-api-key": "prod_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},
    files={"file": open("shipping-bill.pdf", "rb")},
)

data = res.json()["data"]
print(data["fields"]["shippingBillNumber"], data["verification"]["passed"])

Response

{
  "success": true,
  "data": {
    "fields": {
      "shippingBillNumber": "5554056",
      "shippingBillDate": "2020-09-30",
      "portCode": "INCCU1",
      "invoiceNumber": "10814885",
      "currency": "USD",
      "shippingBillValue": 3019368.56,
      "sacCode1": "",
      "sacCode2": "",
      "commission": 54687,
      "commissionInfo": 0,
      "discount": 0,
      "discountInfo": 0,
      "insurance": 1531,
      "insuranceInfo": 0,
      "otherDeductions": 0,
      "otherDeductionsInfo": 0,
      "freight": 41553,
      "freightInfo": 0
    },
    "sections": {
      "section_1": { },
      "section_2": { },
      "section_3": { },
      "section_4": { }
    },
    "verification": {
      "passed": true,
      "score": 1,
      "errors": 0,
      "warnings": 0,
      "failedChecks": []
    },
    "document": {
      "sha256": "d0aa4d7bab4219007a655328f5bec6284257648b8e6d8afcb6086b179f456e83",
      "pageCount": 10,
      "fileName": "shipping-bill.pdf"
    }
  },
  "statusCode": 200,
  "timestamp": "2026-08-07T10:04:11.512Z"
}

fields

The summary most integrations want. Everything here comes from the bill’s page header and PART I, which is why it resolves even when a bill’s later parts are only partly understood.

string

The SB number from the page header.

string

ISO YYYY-MM-DD. A date that could not be parsed is "", never a guess.

string

ICEGATE port code, e.g. INCCU1.

string

The first invoice in the PART I summary.

string

That invoice’s currency.

number

FOB value from the PART I value summary.

string

Always "", not printed on the bill. Present so the key is never silently absent.

string

As above.

number

Commission deducted. The bill prints this column as COM.

number

Discount deducted.

number

Insurance deducted.

number

Freight deducted.

number

Other deductions.

number

The “declared for information only” counterparts DGFT distinguishes from amounts actually deducted. PART I carries only the deducted figures, so these are always 0, emitted rather than omitted so every key is present.

Deductions are top level on fields, not nested under a deductions object. fields.commission, not fields.deductions.commission.

sections

The complete parsed document: PART I to PART IV in the shape ICEGATE prints them, with the original block and column names. Use it when you need more than the summary; ignore it otherwise. Keys appear only for parts actually found in the file. A standard bill yields section_1 through section_4.

document

string

SHA-256 of the uploaded bytes, so a specific upload can be identified later.

number

Pages in the PDF.

string

The filename you sent.

verification

Whether the bill agreed with its own arithmetic. See Verification for every check and what a failure means.

Errors

Every rejection names the fix rather than failing generically.

Status	Message	What to do
400	Upload the shipping bill as a PDF.	Not a PDF. The magic bytes are checked, not the filename
400	This PDF has no text layer, so it is a scan or a photo…	Download the bill again from ICEGATE and upload that file
400	This PDF could not be opened…	Damaged or password protected
400	No shipping bill could be found in this PDF.	It parsed, but carries no recognisable PART banner
401		Missing, revoked or unrecognised API key
402	Your plan includes N shipping bill extractions…	Month’s allowance spent. `errorCode` is `monthly_extraction_limit_reached` (prod) or `sandbox_extraction_limit_reached` (dev). See Allowances
413		Over 10 MB

{
  "statusCode": 400,
  "message": "This PDF has no text layer, so it is a scan or a photo. Download the shipping bill again from ICEGATE and upload that file.",
  "path": "/api/v1/shipping-bills/platform/extract",
  "timestamp": "2026-08-07T10:04:11.512Z"
}

​Request

​Headers

​Example request

​Response

​fields

​sections

​document

​verification

​Errors

Request

Headers

Example request

Response

fields

sections

document

verification

Errors