Overview
The J&T Express Singapore API Reference is for guiding developers on how integration with J&T Express Singapore platform can be done via RESTful web services.
Staging - http://staging.jtexpress.sg
Production - https://app.jtexpress.sg
Authentication
Login
POST /api/gateway/v1/auth/login HTTP/1.1
Authorization: Basic THE_LOGIN_TOKEN
To login via API, you need to generate THE_LOGIN_TOKEN
by using your cridential. This sample code window.btoa(your_email + ':' + your_password)
is used to generate login token.
Access token
GET /api/gateway/v1/track/:id HTTP/1.1
Content-Type: application/json
Authorization: JWT ACCESS_TOKEN
After you log in successfully, an access token is returned. You can use that access token to access to the API.
Distribution Points
Get list of distribution points
GET /api/gateway/v1/distribution-points HTTP/1.1
Content-Type: application/json
Authorization: JWT ACCESS_TOKEN
Header
Field | Description |
---|---|
Authorization | Your access token |
Content-Type | application/json |
Success 2xx
Field | Type | Description |
---|---|---|
id | Number | ID of self collection point |
name | String | Name of self collection point |
address | String | Address |
full_address | String | Full address |
zip | String | Postal code |
phone | String | Self collection point’s phone number |
latitude | String | Latitude |
longitude | String | Longitude |
city | String | City |
state | String | State |
Error 4xx
Name | Type | Description |
---|---|---|
Unauthorized | String | Invalid access token |
Create Single Order
Domestic
POST /api/gateway/v1/deliveries HTTP/1.1
Content-Type: application/json
Authorization: JWT ACCESS_TOKEN
Header
Field | Description |
---|---|
Authorization | Your access token |
Content-Type | application/json |
Parameter
Field | Mandatory | Type | Description |
---|---|---|---|
merchant_code | N | String | (For marketplace only) Merchant code is used to identify the order is from which merchant under a marketplace |
reference_number | N | String | Order ID or any reference you need for identifying this shipment, besided the system generated Tracking ID |
order_source | N | String | Used to track which source the order comes from |
service_code | Y | String | Delivery service code Find out more here |
pickup_details | N | Object | Collection details |
contact_name | Y | String | Contact name |
phone_number | Y | String | Phone number |
N | String | ||
address | Y | String | Pickup address |
postcode | Y | String | Postal code of Pickup address |
date | N | String | Pickup date |
time_window | N | String | Time window |
from | Y | Number | From-Time |
to | Y | Number | To-Time |
consignee_details | Y | Object | Consignee details |
contact_name | Y | String | Contact name |
phone_number | Y | String | Phone number |
N | String | ||
address | Y | String | Delivery address |
postcode | Y | String | Postal code of delivery address |
date | N | String | Delivery date |
item_details | Y | Object[] | Array of item details |
length | N | Number | Parcel's length (cm) |
width | N | Number | Parcel's width (cm) |
height | N | Number | Parcel's height (cm) |
weight | Y | Number | Parcel's weight |
weight_unit | Y | String | Parcel's weight unit Default value: "G" Allowed values: "Kg", "G" |
description | N | String | Item description |
cod | N | Object | Cash collection information |
amount | Y | Number | Cash collection amount |
currency | Y | String | Cash collection currency Default value: "SGD" Find out more here |
customs_declaration | N | Object | Customs declaration |
amount | Y | Number | Amount |
currency | Y | String | Currency Default value: "SGD" Find out more here |
Success 2xx
Field | Type | Description |
---|---|---|
tracking_id | String | Tracking ID of the created shipment |
reference_number | String | Reference number |
Error 4xx
Name | Type | Description |
---|---|---|
Unauthorized | String | Invalid access token |
MerchantNotFoundError | String | Merchant not found |
InvalidMerchantError | String | Invalid merchant code |
DeliveryServiceNotFoundError | String | Delivery service not found |
ParcelNotFoundError | String | Parcel not found |
Self Collection
POST /api/gateway/v1/deliveries HTTP/1.1
Content-Type: application/json
Authorization: JWT ACCESS_TOKEN
Header
Field | Description |
---|---|
Authorization | Your access token |
Content-Type | application/json |
Parameter
Field | Mandatory | Type | Description |
---|---|---|---|
merchant_code | N | String | (For marketplace only) Merchant code is used to identify the order is from which merchant under a marketplace |
reference_number | N | String | Order ID or any reference you need for identifying this shipment, besided the system generated Tracking ID |
service_code | Y | String | (SCP) |
distribution_id | Y | Number | Id of distribution point |
pickup_details | N | Object | Collection details |
contact_name | Y | String | Contact name |
phone_number | Y | String | Phone number |
N | String | ||
address | Y | String | Pickup address |
postcode | Y | String | Postal code of Pickup address |
date | N | String | Pickup date |
time_window | N | String | Time window |
from | Y | Number | From-Time |
to | Y | Number | To-Time |
consignee_details | Y | Object | Consignee details |
contact_name | Y | String | Contact name |
phone_number | Y | String | Phone number |
N | String | ||
address | Y | String | Delivery address |
postcode | Y | String | Postal code of delivery address |
item_details | Y | Object[] | Array of item details |
length | N | Number | Parcel's length (cm) |
width | N | Number | Parcel's width (cm) |
height | N | Number | Parcel's height (cm) |
weight | Y | Number | Parcel's weight |
weight_unit | Y | String | Parcel's weight unit Default value: "G" Allowed values: "Kg", "G" |
description | N | String | Item description |
customs_declaration | N | Object | Customs declaration |
amount | Y | Number | Amount |
currency | Y | String | Currency Default value: "SGD" Find out more here |
Success 2xx
Field | Type | Description |
---|---|---|
tracking_id | String | Tracking ID of the created shipment |
reference_number | String | Reference number |
Error 4xx
Name | Type | Description |
---|---|---|
Unauthorized | String | Invalid access token |
MerchantNotFoundError | String | Merchant not found |
InvalidMerchantError | String | Invalid merchant code |
DeliveryServiceNotFoundError | String | Delivery service not found |
ParcelNotFoundError | String | Parcel not found |
International
POST /api/gateway/v1/deliveries HTTP/1.1
Content-Type: application/json
Authorization: JWT ACCESS_TOKEN
Header
Field | Description |
---|---|
Authorization | Your access token |
Content-Type | application/json |
Parameter
Field | Mandatory | Type | Description |
---|---|---|---|
merchant_code | N | String | (For marketplace only) Merchant code is used to identify the order is from which merchant under a marketplace |
reference_number | N | String | Order ID or any reference you need for identifying this shipment, besided the system generated Tracking ID |
order_source | N | String | Used to track which source the order comes from |
service_code | Y | String | Delivery service code Find out more here |
pickup_details | N | Object | Collection details |
contact_name | Y | String | Contact name |
phone_number | Y | String | Phone number |
N | String | ||
address | Y | String | Pickup address |
postcode | Y | String | Postal code of Pickup address |
date | N | String | Pickup date |
time_window | N | String | Time window |
from | Y | Number | From-Time |
to | Y | Number | To-Time |
consignee_details | Y | Object | Consignee details |
country_code | Y | String | Country code Find out more here |
country_name | Y | String | Country name Find out more here |
city | Y | String | City |
state | N | String | For PTL service only |
contact_name | Y | String | Contact name |
phone_number | Y | String | Phone number |
N | String | ||
address | Y | String | Delivery address |
postcode | Y | String | Postal code of delivery address |
date | N | String | Delivery date |
item_details | Y | Object[] | Array of item details |
length | Y | Number | Parcel's length (cm) |
width | Y | Number | Parcel's width (cm) |
height | Y | Number | Parcel's height (cm) |
weight | Y | Number | Parcel's weight |
weight_unit | Y | String | Parcel's weight unit Default value: "G" Allowed values: "Kg", "G" |
description | N | String | Item description |
cod | N | Object | Cash collection information |
amount | Y | Number | Cash collection amount |
currency | Y | String | Cash collection currency Default value: "SGD" Find out more here |
customs_declaration | N | Object | Customs declaration |
amount | Y | Number | Amount |
currency | Y | String | Currency Default value: "SGD" Find out more here |
Success 2xx
Field | Type | Description |
---|---|---|
tracking_id | String | Tracking ID of the created shipment |
reference_number | String | Reference number |
Error 4xx
Name | Type | Description |
---|---|---|
Unauthorized | String | Invalid access token |
MerchantNotFoundError | String | Merchant not found |
InvalidMerchantError | String | Invalid merchant code |
DeliveryServiceNotFoundError | String | Delivery service not found |
ParcelNotFoundError | String | Parcel not found |
Batch Create Orders
Domestic
POST /api/gateway/v1/deliveries/batch HTTP/1.1
Content-Type: application/json
Authorization: JWT ACCESS_TOKEN
Header
Field | Description |
---|---|
Authorization | Your access token |
Content-Type | application/json |
Parameter
Field | Mandatory | Type | Description |
---|---|---|---|
shipments | Y | Object[] | Shipments |
merchant_code | N | String | (For marketplace only) Merchant code is used to identify the order is from which merchant under a marketplace |
reference_number | N | String | Order ID or any reference you need for identifying this shipment, besided the system generated Tracking ID |
order_source | N | String | Used to track which source the order comes from |
service_code | Y | String | Delivery service code Find out more here |
pickup_details | N | Object | Collection details |
contact_name | Y | String | Contact name |
phone_number | Y | String | Phone number |
N | String | ||
address | Y | String | Pickup address |
postcode | Y | String | Postal code of Pickup address |
date | N | String | Pickup date |
time_window | N | String | Time window |
from | Y | Number | From-Time |
to | Y | Number | To-Time |
consignee_details | Y | Object | Consignee details |
contact_name | Y | String | Contact name |
phone_number | Y | String | Phone number |
N | String | ||
address | Y | String | Delivery address |
postcode | Y | String | Postal code of delivery address |
date | N | String | Delivery date |
item_details | Y | Object[] | Array of item details |
length | N | Number | Parcel's length (cm) |
width | N | Number | Parcel's width (cm) |
height | N | Number | Parcel's height (cm) |
weight | Y | Number | Parcel's weight |
weight_unit | Y | String | Parcel's weight unit Default value: "G" Allowed values: "Kg", "G" |
description | N | String | Item description |
cod | N | Object | Cash collection information |
amount | Y | Number | Cash collection amount |
currency | Y | String | Cash collection currency Default value: "SGD" Find out more here |
customs_declaration | N | Object | Customs declaration |
amount | Y | Number | Amount |
currency | Y | String | Currency Default value: "SGD" Find out more here |
Success 2xx
Field | Type | Description |
---|---|---|
success | Object[] | The created shipments |
tracking_id | String | Tracking ID of the created shipment |
reference_number | String | Reference number |
errors | Object[] | The shipment errors |
error | String | Unauthorized, MerchantNotFoundError, InvalidMerchantError, DeliveryServiceNotFoundError, ParcelNotFoundError |
reference_number | String | Reference number |
Self Collection
POST /api/gateway/v1/deliveries/batch HTTP/1.1
Content-Type: application/json
Authorization: JWT ACCESS_TOKEN
Header
Field | Description |
---|---|
Authorization | Your access token |
Content-Type | application/json |
Parameter
Field | Mandatory | Type | Description |
---|---|---|---|
shipments | Y | Object[] | Shipments |
merchant_code | N | String | (For marketplace only) Merchant code is used to identify the order is from which merchant under a marketplace |
reference_number | N | String | Order ID or any reference you need for identifying this shipment, besided the system generated Tracking ID |
service_code | Y | String | SCP |
distribution_id | Y | Number | Id of distribution point |
pickup_details | N | Object | Collection details |
contact_name | Y | String | Contact name |
phone_number | Y | String | Phone number |
N | String | ||
address | Y | String | Pickup address |
postcode | Y | String | Postal code of Pickup address |
date | N | String | Pickup date |
time_window | N | String | Time window |
from | Y | Number | From-Time |
to | Y | Number | To-Time |
consignee_details | Y | Object | Consignee details |
contact_name | Y | String | Contact name |
phone_number | Y | String | Phone number |
N | String | ||
address | Y | String | Delivery address |
postcode | Y | String | Postal code of delivery address |
item_details | Y | Object[] | Array of item details |
length | N | Number | Parcel's length (cm) |
width | N | Number | Parcel's width (cm) |
height | N | Number | Parcel's height (cm) |
weight | Y | Number | Parcel's weight |
weight_unit | Y | String | Parcel's weight unit Default value: "G" Allowed values: "Kg", "G" |
description | N | String | Item description |
customs_declaration | N | Object | Customs declaration |
amount | Y | Number | Amount |
currency | Y | String | Currency Default value: "SGD" Find out more here |
Success 2xx
Field | Type | Description |
---|---|---|
success | Object[] | The created shipments |
tracking_id | String | Tracking ID of the created shipment |
reference_number | String | Reference number |
errors | Object[] | The shipment errors |
error | String | Unauthorized, MerchantNotFoundError, InvalidMerchantError, DeliveryServiceNotFoundError, ParcelNotFoundError |
reference_number | String | Reference number |
International
POST /api/gateway/v1/deliveries/batch HTTP/1.1
Content-Type: application/json
Authorization: JWT ACCESS_TOKEN
Header
Field | Description |
---|---|
Authorization | Your access token |
Content-Type | application/json |
Parameter
Field | Mandatory | Type | Description |
---|---|---|---|
shipments | Y | Object[] | Shipments |
merchant_code | N | String | (For marketplace only) Merchant code is used to identify the order is from which merchant under a marketplace |
reference_number | N | String | Order ID or any reference you need for identifying this shipment, besided the system generated Tracking ID |
order_source | N | String | Used to track which source the order comes from |
service_code | Y | String | Delivery service code Find out more here |
pickup_details | N | Object | Collection details |
contact_name | Y | String | Contact name |
phone_number | Y | String | Phone number |
N | String | ||
address | Y | String | Pickup address |
postcode | Y | String | Postal code of Pickup address |
date | N | String | Pickup date |
time_window | N | String | Time window |
from | Y | Number | From-Time |
to | Y | Number | To-Time |
consignee_details | Y | Object | Consignee details |
country_code | Y | String | Country code Find out more here |
country_name | Y | String | Country name Find out more here |
city | Y | String | City |
contact_name | Y | String | Contact name |
phone_number | Y | String | Phone number |
N | String | ||
address | Y | String | Delivery address |
postcode | Y | String | Postal code of delivery address |
date | N | String | Delivery date |
item_details | Y | Object[] | Array of item details |
length | N | Number | Parcel's length (cm) |
width | N | Number | Parcel's width (cm) |
height | N | Number | Parcel's height (cm) |
weight | Y | Number | Parcel's weight |
weight_unit | Y | String | Parcel's weight unit Default value: "G" Allowed values: "Kg", "G" |
description | N | String | Item description |
cod | N | Object | Cash collection information |
amount | Y | Number | Cash collection amount |
currency | Y | String | Cash collection currency Default value: "SGD" Find out more here |
customs_declaration | N | Object | Customs declaration |
amount | Y | Number | Amount |
currency | Y | String | Currency Default value: "SGD" Find out more here |
Success 2xx
Field | Type | Description |
---|---|---|
success | Object[] | The created shipments |
tracking_id | String | Tracking ID of the created shipment |
reference_number | String | Reference number |
errors | Object[] | The shipment errors |
error | String | Unauthorized, MerchantNotFoundError, InvalidMerchantError, DeliveryServiceNotFoundError, ParcelNotFoundError |
reference_number | String | Reference number |
Schedule Pickups
Schedule pickup for multiple orders
PATCH /api/gateway/v1/deliveries/pickup HTTP/1.1
Content-Type: application/json
Authorization: JWT ACCESS_TOKEN
Header
Field | Description |
---|---|
Authorization | Your access token |
Content-Type | application/json |
Parameter
Field | Mandatory | Type | Description |
---|---|---|---|
ids | Y | String[] | Tracking IDs or Reference numbers |
pickup_details | N | Object | Collection details |
contact_name | Y | String | Contact name |
phone_number | Y | String | Phone number |
N | String | ||
address | Y | String | Pickup address |
postcode | Y | String | Postal code of Pickup address |
date | N | String | Pickup date |
time_window | N | String | Time window |
from | Y | Number | From-Time |
to | Y | Number | To-Time |
Success 2xx
Field | Type | Description |
---|---|---|
success | Object[] | The created shipments |
tracking_id | String | Tracking ID of the created shipment |
reference_number | String | Reference number |
errors | Object[] | The shipment errors |
error | String | Unauthorized, MerchantNotFoundError, InvalidMerchantError, InvalidTimeWindowError, InvalidPickupDateError, InvalidStatusError |
reference_number | String | Reference number |
Cancel Orders
Cancel single/multiple orders
POST /gateway/v1/deliveries/operation HTTP/1.1
Content-Type: application/json
Authorization: JWT ACCESS_TOKEN
Header
Field | Description |
---|---|
Authorization | Your access token |
Content-Type | application/json |
Parameter
Field | Mandatory | Type | Description |
---|---|---|---|
type | Y | String | Type of operation. Allowed values: "CANCEL" |
data | Y | Object | Operation's parameters |
ids | Y | String[] | Tracking IDs or Reference numbers |
reason | N | String | Cancel reason |
Success 2xx
Field | Type | Description |
---|---|---|
success | String[] | Tracking IDs or Reference numbers |
errors | Object[] | The shipment errors |
error | String | Unauthorized |
tracking_id | String | Tracking ID or Reference number |
Service pricing
Get service pricing
GET /api/gateway/v1/services/price HTTP/1.1
Content-Type: application/json
Authorization: JWT LONG_TERM_ACCESS_TOKEN
Header
Field | Description |
---|---|
simplypost-api-token | Your api access token |
Content-Type | application/json |
URL Parameter
Field | Mandatory | Type | Description |
---|---|---|---|
weight | Y | Number | Parcel weight |
weight_unit | N | Number | Parcel’s weight unit Default value: "G" Allowed values: "Kg", "G" |
service_code | Y | String | Delivery service code |
length | N | Number | Parcel's length (cm) |
width | N | Number | Parcel's width (cm) |
height | N | Number | Parcel's height (cm) |
country_code | Y | String | Destination country code |
Success 2xx
Field | Type | Description |
---|---|---|
rate | Number | Shipment rate |
Status Tracking
Get status of a single shipping order
GET /api/gateway/v1/track/:id HTTP/1.1
Content-Type: application/json
Authorization: JWT ACCESS_TOKEN
Header
Field | Description |
---|---|
Authorization | Your access token |
Content-Type | application/json |
Parameter
Field | Type | Description |
---|---|---|
id | String | Tracking ID or Reference number |
Success 2xx
Field | Type | Description |
---|---|---|
tracking_id | String | Tracking ID |
reference_number | String | Reference number |
status | String | Current status |
pod_url | String | POD url |
first_attempt | String | First attempt date |
activities | Object[] | Shipment order's activities |
name | String | Activity name |
reason | String | Activity reason |
created_by | String | Activity created by |
created_at | String | Activity created date |
Error 4xx
Name | Type | Description |
---|---|---|
Unauthorized | String | Invalid access token |
DeliveryNotFoundError | String | Delivery not found |
Get status of multiple shipping orders
POST /api/gateway/v1/track HTTP/1.1
Content-Type: application/json
Authorization: JWT ACCESS_TOKEN
Header
Field | Description |
---|---|
Authorization | Your access token |
Content-Type | application/json |
Parameter
Field | Type | Description |
---|---|---|
ids | String[] | Tracking IDs or Reference numbers |
Success 2xx
Field | Type | Description |
---|---|---|
deliveries | Object[] | Shipments |
tracking_id | String | Tracking ID |
reference_number | String | Reference number |
status | String | Current status |
pod_url | String | POD url |
first_attempt | String | First attempt date |
activities | Object[] | Shipment order's activities |
name | String | Activity name |
reason | String | Activity reason |
created_by | String | Activity created by |
created_at | String | Activity created date |
Error 4xx
Name | Type | Description |
---|---|---|
Unauthorized | String | Invalid access token |
Connote
Get connote label
GET /api/gateway/v1/deliveries/connote/:id/:style HTTP/1.1
Content-Type: application/json
Authorization: JWT ACCESS_TOKEN
Header
Field | Description |
---|---|
Authorization | Your access token |
Content-Type | application/json |
Parameter
Field | Type | Description |
---|---|---|
id | String | Tracking ID or Reference number |
style | String | Connote label style Default value: "a6" Allowed values: "a4", "a6" |
Success 2xx
Field | Type | Description |
---|---|---|
reference_number | String | Reference number |
connote_label_url | String | Connote label URL |
Error 4xx
Name | Type | Description |
---|---|---|
Unauthorized | String | Invalid access token |
DeliveryNotFoundError | String | Delivery not found |
Submerchants
Create multiple submerchants
POST /api/gateway/v1/merchants/batch HTTP/1.1
Content-Type: application/json
Authorization: JWT ACCESS_TOKEN
Header
Field | Description |
---|---|
Authorization | Your access token |
Content-Type | application/json |
Parameter
Field | Mandatory | Type | Description |
---|---|---|---|
merchants | Y | Object[] | Array of submerchants |
name | Y | String | Merchant name |
code | Y | String | Merchant code |
phone_number | N | String | Phone number |
address | N | String | Address |
postcode | N | String | Postal code |
service_codes | N | String[] | Delivery service code Find out more here. By default, all service types of marketplace will be applied for sub-merchant |
login | Y | Object | Login account |
first_name | Y | String | First name |
last_name | Y | String | Last name |
Y | String | ||
password | Y | String | Password |
business_contacts | N | Object | Business contacts |
first_name | Y | String | First name |
last_name | Y | String | Last name |
N | String | ||
position | N | String | Position |
phone_number | N | String | Phone number |
invoice_recipient | N | Boolean | Invoice recipient |
notification_recipient | N | Boolean | Notification recipient |
Success 2xx
Field | Type | Description |
---|---|---|
success | Object[] | The created submerchants |
name | String | Merchant name |
code | String | Merchant code |
errors | Object[] | The errors |
name | String | Merchant name |
code | String | Merchant code |
error | String | Error message |
Webhooks
POST "YOUR_URL_ENDPOINT" HTTP/1.1
X-SimplyPost-Id: 762a562e-53ed-4548-906f-98dea9374711
X-SimplyPost-Event: Confirmed
X-SimplyPost-Signature: 70813b98eaa48ac129a98e58f1cfcdb1d035e58f
Content-Type: application/json
{
"status": "Confirmed",
"tracking_id": "NNA170550008",
"reference_number": "345469003",
"timestamp": "2017-03-16T08:54:18+08:00"
}
Webhooks allow you to build or set up integrations which subscribe to certain events on J&T Express Singapore platform. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL.
Events
When configuring a webhook, you can choose which events you would like to receive payloads for. Only subscribing to the specific events you plan on handling is useful for limiting the number of HTTP requests to your server. You can change the list of subscribed events anytime.
The available events are:
Name | Description |
---|---|
Confirmed | Order has been created |
Canceled | Order has been canceled |
Rescheduled Pickup | Pickup has been rescheduled |
Enroute to Hub | Driver has picked up the item, and on the way to Hub |
Arrived at Hub | Item has been scanned arrived at Hub |
Rescheduled Delivery | Delivery has been rescheduled |
Out for Delivery | Item has been scanned out for delivery by driver |
Failed Delivery | Item has failed to be delivered |
Delivered | Item has been delivered |
Returned to Sender | Item has been returned to sender |
Returned to Hub | Item has been returned to Hub (due to failed delivery) |
Forwarded to Shipping Partner | Item has been forwarded to Shipping Partner |
Payload
POST "YOUR_URL_ENDPOINT" HTTP/1.1
X-SimplyPost-Id: 762a562e-53ed-4548-906f-98dea9374711
X-SimplyPost-Event: Delivered
X-SimplyPost-Signature: 70813b98eaa48ac129a98e58f1cfcdb1d035e58f
Content-Type: application/json
{
"status": "Delivered",
"tracking_id": "NNA170550008",
"reference_number": "345469003",
"timestamp": "2017-03-16T08:54:18+08:00",
"pod_url": "https://58e0d598f.s3.amazonaws.com/500535e8.jpg"
}
POST "YOUR_URL_ENDPOINT" HTTP/1.1
X-SimplyPost-Id: 762a562e-53ed-4548-906f-98dea9374711
X-SimplyPost-Event: Failed Delivery
X-SimplyPost-Signature: 70813b98eaa48ac129a98e58f1cfcdb1d035e58f
Content-Type: application/json
{
"status": "Failed Delivery",
"tracking_id": "NNA170550008",
"reference_number": "345469003",
"timestamp": "2017-03-16T08:54:18+08:00",
"no_of_attempts": 2,
"comments": "Consignee Not Available"
}
Each event type has a specific payload format with the relevant event information.
HTTP requests made to your webhook's configured URL endpoint will contain several special headers:
Header | Description |
---|---|
X-SimplyPost-Id | Unique Id for webhook request |
X-SimplyPost-Event | Name of the event that triggered |
X-SimplyPost-Signature | HMAC hex digest of the X-SimplyPost-Id, using SHA-1 algorithm and webhook's secret as the key (if configured) |
Secret
Each webhook request includes a X-SimplyPost-Signature
header which is generated using your provided secret, along with the data sent in the request.
To verify that the request came from J&T Express Singapore, compute the HMAC digest of X-SimplyPost-Id
using your secret and compare it to the value in the X-SimplyPost-Signature
header. If they match, you can be sure that the webhook was sent from J&T Express Singapore and the data has not been compromised.
References
Delivery service
Code | Name | Service Level |
---|---|---|
DOMN | Domestic Normal | Next working day |
DOME | Domestic Express | Same working day |
DOM123 | Domestic 1-3 days | 1 - 3 working days |
DOE | Domestic Envelope Delivery | 1 - 5 working days |
FMD | Final Mile Delivery | Next working day |
ID | International Delivery | |
EN | Export Non-document | |
ED | Export Document | |
IDP | International Delivery Postal | |
PTL | Parcel International Direct | |
SCP | Self collection |
Country
Code | Name |
---|---|
AD | Andorra |
AE | United Arab Emirates |
AF | Afghanistan |
AG | Antigua |
AI | Anguilla |
AL | Albania |
AM | Armenia |
AN | Netherlands Antilles |
AO | Angola |
AR | Argentina |
AS | American Samoa |
AT | Austria |
AU | Australia |
AW | Aruba |
AZ | Azerbaijan |
BA | Bosnia and Herzegovina |
BB | Barbados |
BD | Bangladesh |
BE | Belgium |
BF | Burkina Faso |
BG | Bulgaria |
BH | Bahrain |
BI | Burundi |
BJ | Benin |
BM | Bermuda |
BN | Brunei |
BO | Bolivia |
BR | Brazil |
BS | Bahamas |
BT | Bhutan |
BW | Botswana |
BY | Belarus |
BZ | Belize |
CA | Canada |
CD | Congo, The Democratic Republic of |
CF | Central African Republic |
CG | Congo |
CH | Switzerland |
CI | Cote d'Ivoire |
CK | Cook Islands |
CL | Chile |
CM | Cameroon |
CN | China, People's Republic |
CO | Colombia |
CR | Costa Rica |
CU | Cuba |
CV | Cape Verde |
CY | Cyprus |
CZ | Czech Republic |
DE | Germany |
DJ | Djibouti |
DK | Denmark |
DM | Dominica |
DO | Dominican Rep. |
DZ | Algeria |
EC | Ecuador |
EE | Estonia |
EG | Egypt |
ER | Eritrea |
ES | Spain |
ET | Ethiopia |
FI | Finland |
FJ | Fiji |
FK | Falkland Islands |
FM | Micronesia, Federated States Of |
FO | Faroe Islands |
FR | France |
GA | Gabon |
GB | United Kingdom |
GD | Grenada |
GE | Georgia |
GF | French Guyana |
GG | Guernsey |
GH | Ghana |
GI | Gibraltar |
GL | Greenland |
GM | Gambia |
GN | Guinea Republic |
GP | Guadeloupe |
GQ | Guinea-Equatorial |
GR | Greece |
GT | Guatemala |
GU | Guam |
GW | Guinea-Bissau |
GY | Guyana (British) |
HK | Hong Kong |
HN | Honduras |
HR | Croatia |
HT | Haiti |
HU | Hungary |
IC | Canary Islands |
ID | Indonesia |
IE | Ireland, Republic Of |
IL | Israel |
IN | India |
IQ | Iraq |
IR | Iran (Islamic Republic of) |
IS | Iceland |
IT | Italy |
JE | Jersey |
JM | Jamaica |
JO | Jordan |
JP | Japan |
KE | Kenya |
KG | Kyrgyzstan |
KH | Cambodia |
KI | Kiribati |
KM | Comoros |
KN | St. Kitts |
KP | Korea, The D.P.R of |
KR | Korea, Republic Of |
KV | Kosovo |
KW | Kuwait |
KY | Cayman Islands |
KZ | Kazakhstan |
LA | Lao People's Democratic Republic |
LB | Lebanon |
LC | St. Lucia |
LI | Liechtenstein |
LK | Sri Lanka |
LR | Liberia |
LS | Lesotho |
LT | Lithuania |
LU | Luxembourg |
LV | Latvia |
LY | Libya |
MA | Morocco |
MC | Monaco |
MD | Moldova, Republic Of |
ME | Montenegro, Republic of |
MG | Madagascar |
MH | Marshall Islands |
MK | Macedonia, Rep. of (FYROM) |
ML | Mali |
MM | Myanmar |
MN | Mongolia |
MO | Macau |
MP | Saipan |
MQ | Martinique |
MR | Mauritania |
MS | Montserrat |
MT | Malta |
MU | Mauritius |
MV | Maldives |
MW | Malawi |
MX | Mexico |
MY | Malaysia |
MZ | Mozambique |
NA | Namibia |
NC | New Caledonia |
NE | Niger |
NG | Nigeria |
NI | Nicaragua |
NL | Netherlands |
NO | Norway |
NP | Nepal |
NR | Nauru, Republic Of |
NU | Niue |
NZ | New Zealand |
OM | Oman |
PA | Panama |
PE | Peru |
PF | Tahiti |
PG | Papua New Guinea |
PH | Philippines |
PK | Pakistan |
PL | Poland |
PR | Puerto Rico |
PT | Portugal |
PW | Palau |
PY | Paraguay |
QA | Qatar |
RE | Reunion, Island Of |
RO | Romania |
RS | Serbia, Republic of |
RU | Russian Federation |
RW | Rwanda |
SA | Saudi Arabia |
SB | Solomon Islands |
SC | Seychelles |
SD | Sudan |
SE | Sweden |
SG | Singapore |
SH | SAINT HELENA |
SI | Slovenia |
SK | Slovakia |
SL | Sierra Leone |
SM | San Marino |
SN | Senegal |
SO | Somalia |
SR | Suriname |
SS | SOUTH SUDAN |
ST | Sao Tome and Principe |
SV | El Salvador |
SY | Syria |
SZ | Swaziland |
TC | Turks and Caicos Islands |
TD | Chad |
TG | Togo |
TH | Thailand |
TJ | Tajikistan |
TL | East Timor |
TN | Tunisia |
TO | Tonga |
TR | Turkey |
TT | Trinidad and Tobago |
TV | Tuvalu |
TW | Taiwan |
TZ | Tanzania |
UA | Ukraine |
UG | Uganda |
US | United States Of America |
UY | Uruguay |
UZ | Uzbekistan |
VC | St. Vincent |
VE | Venezuela |
VG | Virgin Islands (British) |
VI | Virgin Islands (US) |
VN | Vietnam |
VU | Vanuatu |
WS | Samoa |
XB | Bonaire |
XC | Curacao |
XE | St. Eustatius |
XM | St. Maarten |
XN | Nevis |
XS | Somaliland, Rep of (North Somalia) |
XY | St. Barthelemy |
YE | Yemen, Republic of |
YT | Mayotte |
ZA | South Africa |
ZM | Zambia |
ZW | Zimbabwe |
Currency
Code | Name |
---|---|
AED | UAE Dirham |
AFN | Afghan Afghani |
AMD | Armenian Dram |
ANG | Netherlands Antilles Guilder |
AOA | Kwanza |
ARS | Argentine Peso |
AUD | Australian Dollar |
AWG | Aruba Guilder |
AZN | Azerbaijan Manat |
BAM | Convertible Marks |
BBD | Barbadian Dollar |
BDT | Taka |
BGN | Bulgarian Lev |
BHD | Bahraini Dinar |
BIF | Burundese Franc |
BMD | Bermudian Dollar |
BND | Brunei Dollar |
BOB | Boliviano |
BRL | Real |
BSD | Bahamian Dollar |
BTN | Ngultrum |
BWP | Pula |
BYR | Belarusian Ruble |
BZD | Belize Dollar |
CAD | Canadian Dollar |
CDF | Congolese Franc |
CHF | Swiss Franc |
CLP | New Chile Peso |
CNY | Yuan (Ren Min Bi) |
COP | Colombian Peso |
CRC | Costa Rican Colon |
CUC | Cuban Peso |
CVE | Cape Verde Escudo |
CZK | Czech Koruna |
DJF | Djibouti Franc |
DKK | Danish Krone |
DKK | Danish Krone |
DKK | Danish Krone |
DOP | Dominican Republic Peso |
DZD | Algerian Dinar |
EGP | Egyptian Pound |
ERN | Nakfa |
ETB | Birr |
EUR | Euro |
FJD | Fijian Dollar |
GBP | Pound Sterling |
GEL | Georgian Lari |
GHS | Cedi |
GMD | Dalasi |
GNF | Guinea Franc |
GTQ | Quetzal |
GYD | Guyanan Dollar |
HKD | Hong Kong Dollar |
HNL | Lempira |
HRK | Croatian Kuna |
HTG | Gourde |
HUF | Forint |
IDR | Rupiah |
ILS | New Israeli Shekel |
INR | Indian Rupee |
IQD | Iraqi Dinar |
IRR | Iranian Rial |
ISK | Icelandic Krona |
JMD | Jamaican Dollar |
JOD | Jordanian Dinar |
KES | Kenyan Shilling |
KGS | Kyrgyzstanian Som |
KHR | Khmer Rial |
KMF | Comoros Franc |
KPW | North Korean Won |
KRW | Korean Won |
KWD | Kuwaiti Dinar |
KYD | Cayman Islands Dollar |
KZT | Tenge |
LAK | Kip |
LKR | Sri Lankan Rupee |
LRD | Liberian Dollar |
LSL | Loti |
LTL | Lithuanian Litas |
LYD | Libyan Dinar |
MAD | Moroccan Dirham |
MDL | Moldovan Leu |
MGA | Ariary |
MKD | Macedonian Denar |
MNT | Tugrik |
MOP | Pataca |
MRO | Ouguiya |
MUR | Mauritius Rupee |
MVR | Rufiyaa |
MWK | Kwacha |
MXN | Mexican Nuevo Peso |
MYR | Ringgit |
MZN | Mozambique Metical |
NAD | Namibian Dollar |
NGN | Naira |
NIO | Cordoba Oro |
NOK | Norwegian Krone |
NPR | Nepalese Rupee |
NZD | New Zealand Dollar |
OMR | Omani Rial |
PEN | Nuevo Sol |
PGK | Kina |
PHP | Phillipines Peso |
PKR | Pakistani Rupee |
PLN | Zloty |
PYG | Guarani |
QAR | Qatar Rial |
RON | Leu |
RSD | Serbia, Dinars |
RUB | Russian Ruble |
RWF | Rwanda Franc |
SAR | Saudi Riyal |
SBD | Solomon Islands Dollar |
SCR | Seychelles Rupee |
SDG | Sudanese Pound |
SEK | Swedish Krona |
SGD | Singapore Dollar |
SHP | Saint Helenian Pound |
SIS | Somaliland shilling |
SLL | Sierra Leonean Leone |
SOS | Somali Shilling |
SRD | Surinamese Dollar |
SSP | South Sudanese pound |
STD | Sao Tomean Dobra |
SYP | Syrian Pound |
SZL | Swazi Lilangeni |
THB | Baht |
TJS | Tajikistani Somoni |
TND | Tunisian Dinar |
TOP | Pa"anga |
TRY | New Turkish Lira |
TTD | Trinidad and Tobago Dollar |
TWD | New Taiwan Dollar |
TZS | Tanzanian Shilling |
UAH | Hryvna |
USD | US Dollar |
UYU | Peso Uruguayo |
UZS | Uzbekistan Som |
VEF | Bolivar Fuerte |
VND | Dong |
VUV | Vanuatu Vatu |
WST | Samoan Tala |
XCD | East Caribbean Dollar |
YER | Yemeni Riyal |
ZAR | South African Rand |
ZMW | Zambian Kwacha |