Carriers and addresses through the API
Read the carrier catalogue
| Route | Scope |
|---|---|
GET /v1/carrier/list | carrier:read |
GET /v1/carrier/detail/<id> | carrier:read |
The list filters on q (name or code), code, country (two-letter code) and source. The catalogue is read-only; use a carrier's id as carrier_id when you add a parcel.
Manage your address book
| Route | Scope | Does |
|---|---|---|
GET /v1/address/list | address:read | lists your addresses: role, status, country, default, q |
GET /v1/address/detail/<id> | address:read | one address |
POST /v1/address/create | address:write | adds an address (201) |
PATCH /v1/address/detail/<id> | address:write | changes the fields you send |
DELETE /v1/address/detail/<id> | address:write | deletes the address, as the screen does |
An address needs role (sender or recipient), phone, line1, postal_code, city and country (two-letter code); type is individual (default) or company. Set is_default to true to make it the default of its role. The phone and the e-mail are checked as on the screen, and the same contact at the same postal code answers 409 with the id that holds it.