GPS Tracking API
We currently do not support this API. If you are interested in this API, please request for an integration.
GPS Last Checkpoint API
We currently do not support this API. If you are interested in this API, please request for an integration.
GPS Estimated delivery date API
We currently do not support this API. If you are interested in this API, please request for an integration.
GPS Rate API
Get a rate
Get rate
Parameters
idstring required
Rate id
Returns
metaMetacodeinteger required
Code of Metamessagestring required
Message of Metadetailsarray[Error]
Details of Metaretryableboolean
Whether this request will be retryable or not
dataRateRecord
RateRecord object: the description of rates informationcreated_atstring
the timestamp of created_at, example: 2022-05-18T09:17:38+00:00idstring
rate idupdated_atstring
the timestamp of updated_at, example: 2022-05-18T09:17:38+00:00statusstring
Allowed values:calculatingcalculatedfailedratesarray[Rate]
rates array
Calculate rates
Calculate rates
Parameters
asyncboolean
enable async mode or not (set to false if not provided)is_documentboolean
If the shipment is document type. (set to false if not provided)ship_datestring
Ship Date in YYYY-MM-DD, if not provided, will be today of the shipper account timezoneshipper_accountsarray[object]- id string
shipmentShipment
Shipment object: the description of shipment informationship_fromAddress required
Address object: the description of address informationship_toAddress required
Address object: the description of address informationparcelsarray[Parcel] required
required
Parcels of shipmentreturn_toAddress
Address object: the description of address informationdelivery_instructionsstring
Instructions to aid in prompt delivery of the shipment.
Returns
metaMeta
Meta data object.codeinteger required
Code of Metamessagestring required
Message of Metadetailsarray[Error]
Details of Metaretryableboolean
Whether this request will be retryable or not
dataRateRecord
RateRecord object: the description of rates informationcreated_atstring
the timestamp of created_at, example: 2022-05-18T09:17:38+00:00idstring
rate idupdated_atstring
the timestamp of updated_at, example: 2022-05-18T09:17:38+00:00statusstring
Allowed values:calculatingcalculatedfailedratesarray[Rate]
rates array
GPS Label API
Get a label
Get a label.
Parameters
idstring required
label id
Returns
metaMeta
Meta data object.codeinteger required
Code of Metamessagestring required
Message of Metadetailsarray[Error]
Details of Metaretryableboolean
Whether this request will be retryable or not
dataLabel
Label object: the description of label objectidstring
Label IDstatusstring
Allowed values:creatingcreatedcancellingcancelledmanifestingmanifestedfailed
Create a label
Create a label.
Parameters
billingBilling
Billing object: the description of billing informationpaid_bystring required
Allowed values:shipperthird_partyrecipientmethodPaymentMethodAccount
PaymentMethodAccount object: the description of account information
customsCustoms
Customs object: the description of customs informationpurposestring required
Allowed values:giftmerchandisepersonalsamplereturn
repairnon-merchandiseterms_of_tradestring
Allowed values:datdduddpdapexwfcafobcipcif
cptcfrdpueeione of: AES
AES object: the description of EEI Type - aesbillingBilling
Billing object: the description of billing informationimporter_addressAddress
Address object: the description of address informationpassportobject
Passport Objectadditional_chargesarray[object]
This array contains additional_charges object. Additional charge to be added to the commercial invoice of this shipment. Only applies to FedEx, DHL, UPS currently.
shipmentShipment
Shipment object: the description of shipment informationship_fromAddress required
Address object: the description of address informationship_to Addressrequired
Address object: the description of address informationparcelsarray[Parcel] required
Parcels of shipmentreturn_toAddress
Address object: the description of address informationdelivery_instructionsstring
Instructions to aid in prompt delivery of the shipment.
Return
metaMeta
Meta data object.codeinteger required
Code of Metamessagestring required
Message of Metadetailsarray[Error]
Details of Metaretryableboolean
Whether this request will be retryable or not
dataLabel
Label object: the description of label objectidstring
Label IDstatusstring
Allowed values:creatingcreatedcancellingcancelledmanifestingmanifestedfailed
ship_datestring
tracking_numbersarray[string]
GPS Manifest API
We currently do not support this API. If you are interested in this API, please request for an integration.
GPS Cancel Label API
Cancel a label
Cancel a label.
Parameters
labelobjectidstring
Returns
metaMeta
Meta data object.codeinteger required
Code of Metamessagestring required
Message of Metadetailsarray[Error]
Details of Metaretryableboolean
Whether this request will be retryable or not
dataobjectidstringstatusstring
Allowed values:cancellingcancelledfailedrefund_statusstringlabelobjectcreated_atstringupdated_atstring
GPS Pickup API
We currently do not support this API. If you are interested in this API, please request for an integration.
GPS Cancel Pickup API
We currently do not support this API. If you are interested in this API, please request for an integration.
GPS Shipper Account API
Create a shipper account
This endpoint allows you to create your shipper account via API. You can integrate our API with your system and manage the shipper account according to your needs.
Please ensure that your account credentials are correct. Different carriers have different requirements for account credentials, you can refer to Shipper account's credetials for more details.
Parameters
slugstringgpsdescriptionstringtimezonestringcredentialsobject
Please refer to Shipper account's credetialsaddressAddress
Address object: the description of address informationstreet1string required
address_line1 of addresscountrystring required
Country in ISO 3166-1 alpha 3 codecontact_namestring required
contact_name of address
Returns
metaMeta
Meta data object.codeinteger required
Code of Metamessagestring required
Message of Metadetailsarray[Error]
Details of Metaretryableboolean
Whether this request will be retryable or not
dataShipperAccount
ShipperAccount object: the description of shipper account informationidstring
Shipper Account IDaddressAddress
Address object: the description of address information
Get a shipper account
This endpoint allows you get a specific shipper account details by shipper account id.
Parameters
idstring required
Shipper account id
Returns
metaMeta
Meta data object.codeinteger required
Code of Metamessagestring required
Message of Metadetailsarray[Error]
Details of Metaretryableboolean
Whether this request will be retryable or not
dataShipperAccount
ShipperAccount object: the description of shipper account informationidstring
Shipper Account IDaddressAddress
Address object: the description of address information
GPS Address Validation (Beta) API
Create an address validation
Create an address validation
Parameters
addressAddress
Address object: the description of address informationstreet1string required
address_line1 of addresscountrystring required
Country in ISO 3166-1 alpha 3 codecontact\_namestring required
contact_name of address
Returns
metaMeta
Meta data object.codeinteger required
Code of Metamessagestring required
Message of Metadetailsarray[Error]
Details of Metaretryableboolean
Whether this request will be retryable or not
dataShipperAccount
ShipperAccount object: the description of shipper account informationidstring
Shipper Account IDaddressAddress
Address object: the description of address information