Master Data · min plan: developer · standard (1u) · scope: read:master · both

Customs EDI Locations

Returns active EDI customs locations with station, port, type, and state metadata.

GET /v1/master/customs-edi

Required scope

read:master

API credits

1 per success

Minimum plan

developer

Rate-limit bucket

standard

Parameters

Name	In	Type	Required	Description
state	query	string	—	Indian state code.
page	query	integer	—	One-indexed page.
page_size	query	integer	—	Rows per page, from 1 to 1000.

Sample request

curl "https://getway.clearie.neximprove.com/v1/master/customs-edi?state=GJ" -H "Authorization: Bearer $CLEARIE_API_KEY"

Sample response

{
  "items": [
    {
      "code": "INMUN1",
      "name": "Mundra Sea",
      "port_code": "INMUN",
      "state": "GJ",
      "edi_enabled": true
    }
  ],
  "meta": {
    "weighted_units": 1
  },
  "page": 1,
  "page_size": 200,
  "total": 1
}

Live response contract

Live calls require API-key authentication, read:master scope, plan access, and available quota. Successful calls consume 1 API credits.

Sandbox sample response

Workspace try-it calls use isolated representative sandbox records. They are for integration validation, not production filing.

Error examples

401 invalid key · 403 missing scope or plan · 429 quota/rate limit · 404 no verified data where applicable.

Response schema

root object {

items* array [

item object {

code* string// e.g. "INMUN1"

name* string// e.g. "Mundra Sea"

port_code* string// e.g. "INMUN"

state* string// e.g. "GJ"

edi_enabled* boolean// e.g. true

}

]

meta* object {

weighted_units* integer// e.g. 1

}

page* integer// e.g. 1

page_size* integer// e.g. 200

total* integer// e.g. 1

}

Try this API live in the workspace

The in-app try-it console runs against the isolated deterministic sandbox repository. It never reads live customer or reference records.

Open in workspace Create account