Codes · min plan: developer · lightweight (0.1u) · scope: read:master · both

Package Codes

Returns package type codes and descriptions used in shipping and customs documents.

GET /v1/master/packages

Required scope

read:master

API credits

0.1 per success

Minimum plan

developer

Rate-limit bucket

lightweight

Sample request

curl "https://getway.clearie.neximprove.com/v1/master/packages" -H "Authorization: Bearer $CLEARIE_API_KEY"

{
  "items": [
    {
      "code": "CT",
      "name": "Carton"
    }
  ],
  "meta": {
    "weighted_units": 0.1
  }
}

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

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

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

root object {

items* array [

item object {

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

name* string// e.g. "Carton"

}

]

meta* object {

weighted_units* number// e.g. 0.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.