QUICKSTART
API Quick Start
Authentication
SignString
OAuth
Overview
Getting Started
Scope List
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
REFERENCE
API Overview
v3
Rates
Get rates
get
Calculate rates
post
Get a rate
get
Labels
Get labels
get
Create a label
post
Get a label
get
Manifests
Get manifests
get
Create a manifest
post
Get a manifest
get
Couriers
Get all couriers
get
Shipper Accounts
Get shipper accounts
get
Create a shipper account
post
Get a shipper account
get
Delete a shipper account
delete
Update a shipper account's information
put
Update a shipper account's credentials
patch
Cancel Labels
Get the canceled labels
get
Cancel a label
post
Get a canceled label
get
Address Validations (Beta)
Create an address validation
post
MODEL
Envelope
Meta
v3
Error
v3
Primitive
Billing
v3
Customs
v3
Shipment
v3
Address
v3
Parcel
v3
Item
v3
Courier
v3
Files
v3
Reference
v3
Money
v3
PaymentMethodAccount
v3
Dimension
v3
Weight
v3
Aes
v3
NoEei
v3
Resource
Rate
v3
RateRecord
v3
Label
v3
Manifest
v3
ShipperAccount
v3
CancelLabel
v3
AddressValidation (Beta)
v3
ENUM
Shipper Accounts Credentials
Service Types and Service Options List
All Service Options
Webhook
Webhook Overview
Webhook Specifications
Webhook Signature
Webhook Outgoing IPs
OTHERS
Supported Couriers
SDK
Java SDK
Node.js SDK
Open Source
phone
email-verifier
Support
Contact Support

Rate

Rate object: the description of rate information

charge_weight
Weight

Weight object: unit weight of the item

unit
string
required

weight unit

Allowed values:
lbkgozg
value
number
required

value of Weight

total_charge
Money

Money object: unit price of the item

currency
string

Currency of Money

Allowed values:
AFNEURALLDZDUSDAOAXCDARSAMDAWGAUDAZNBSDBHDBDTBBDBYNBZDXOFBMDINRBTNBOBBOVBAMBWPNOKBRLBNDBGNBIFCVEKHRXAFCADKYDCLPCLFCNYCOPCOUKMFCDFNZDCRCHRKCUPCUCANGCZKDKKDJFDOPEGPSVCERNETBFKPFJDXPFGMDGELGHSGIPGTQGBPGNFGYDHTGHNLHKDHUFISKIDRXDRIRRIQDILSJMDJPYJODKZTKESKPWKRWKWDKGSLAKLBPLSLZARLRDLYDCHFMOPMKDMGAMWKMYRMVRMRUMURXUAMXNMXVMDLMNTMADMZNMMKNADNPRNIONGNOMRPKRPABPGKPYGPENPHPPLNQARRONRUBRWFSHPWSTSTNSARRSDSCRSLLSGDXSUSBDSOSSSPLKRSDGSRDSZLSEKCHECHWSYPTWDTJSTZSTHBTOPTTDTNDTRYTMTUGXUAHAEDUSNUYUUYIUYWUZSVUVVESVNDYERZMWZWLXBAXBBXBCXBDXTSXXXXAUXPDXPT
amount
number

Amount of Money

shipper_account
object
required

Shipper Account (brief information for rate and manifest responses)

id
string
required
slug
string
required
description
string
service_type
string
required

Service Types

service_name
string
required

name of service

pickup_deadline
string or null

A formatted date.

booking_cut_off
string or null

A formatted date.

delivery_date
string or null

A formatted date.

transit_time
integer or null

transit time

detailed_charges
array[object]

Courier charges, it may be different for different couriers

type
string

detailed charges type

charge
Money

Money object: unit price of the item

error_message
string or null

error information

info_message
string or null

other information of request/response

Example
preparing...