Get Rate

This API will return the estimated rate based on the provided parcel information

Environments

Notes

  • Fields marked as Required are essential for certain services. Ensure the correct fields are included by checking the "Required" column in each section.
  • Many field values are provided by the Account Manager. Please consult with them to obtain valid, customer-specific values.

Response Code

CodeCategoryDescription
200SUCCESSSuccess
401ERRORUnauthorized
404ERRORNot found
500ERROROperation error
600ERRORJSON error
601ERRORParameter error
602ERRORAddress error
603ERRORAccount disabled
604ERRORAccount config error
605ERRORSystem config errorWeight error
606ERRORWeight error
607ERRORDimension error
608ERRORAccount balance error
609ERRORNo access
610ERRORLabel status error
611ERRORLabel not found
Body Params
string
required

The designated pickup account for each injection point. Contact Account Manager for account details.

string
required

Product code assigned by Account Manager.

string
required

The IATA airport code.
AUTO -> System automatically select the port of entry by the zip code.

double
required

The weight of the package.
Min: 0.001
Max: 99999.999

string
enum
required

The weight unit.

Allowed:
string
required

The length of the package.
Min: 0.01
Max: 999.99

string
required

The width of the package.
Min: 0.01
Max: 999.99

string
required

The height of the package.
Min: 0.01
Max: 999.99

string
enum
required

The dimensional unit of measurement.

Allowed:
recipient
object
required

Specify the recipient address.
Accepts only [a-zA-Z0-9] and symbols -#.,@&*()_+=/:.
All other characters are replaced with spaces.

string

Package type

string

Valid Values:
01 - Wine
02 - Beer
03 - Spirits
04 - Vape
05 - Smoke & Cigarettes
06 - Cannabis
07 - LIBA
08 - Food Products
10 - LIBA PI 970
11 - LIBA PI 967

This may introduce (Adult) signature confirmation service and ID confirmation service.

boolean

Specify whether validate the recipient address

Headers
string
required

API key

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json