Anteraja - API Documentation v2.1.0
This API documentation describes API specification to build integration between your system with Anteraja. You can check service rates, create order and track the order using this API.
To start using these APIs, you will need base path
, access-key-id
and secret-access-key
.
please contact Anteraja to get the base path
, access-key-id
and secret-access-key
.
Character that are allowed for input : Alphanumeric and /()[].,
Please remove all whitespace in front and behind words. For booking_id, we will trim the leading and trailing whitespace, and ignore case.
Weight, Currency, Money or Amount no need decimal value. If you have to send decimal value please consult to us.
Base Path
Base Path: (will be provided by Anteraja)
Authentication
Anteraja API expects for the access-key-id
and secret-access-key
to be included in all API requests to the server in a header that looks like the following:
access-key-id:***
secret-access-key:***
Content-Type:application/json
- access-key-id: (will be provided by Anteraja)
- secret-access-key: (will be provided by Anteraja)
List of API
Service Rates
curl --location --request POST '/serviceRates' \
--header 'Content-Type: application/json' \
--header 'access-key-id: ***' \
--header 'secret-access-key: ***' \
--data-raw '{
"origin": "31.73.06",
"destination": "31.73.06",
"weight": 2000
}'
{
"origin": "31.73.06",
"destination": "31.73.06",
"weight": 2000
}
Success response:
{
"status": 200,
"info": "OK",
"content": {
"origin": "31.73.06",
"destination": "31.73.06",
"services": [{
"product_code": "ND",
"product_name": "Anteraja Next Day",
"etd": "1-2 Day",
"rates": 26000,
"is_cod": false,
"surcharges": null
},
{
"product_code": "REG",
"product_name": "Anteraja Regular",
"etd": "2-3 Day",
"rates": 20000,
"is_cod": true,
"surcharges": null
},
{
"product_code": "SD",
"product_name": "Anteraja Same Day",
"etd": "0 Day",
"rates": 20000,
"is_cod": false,
"surcharges": null
},
{
"product_code": "ICE",
"product_name": "Anteraja Frozen",
"etd": "0 Day",
"rates": 22000,
"is_cod": false,
"surcharges": null
},
{
"product_code": "BIG",
"product_name": "Anteraja Cargo",
"etd": "2-4 Day",
"rates": 45000,
"is_cod": false,
"surcharges": null
}
]
}
}
Failed response:
{
"status": 208,
"info": "District not found : 31.74.013",
"content": null
}
{
"status": 400,
"info": "Unreachable result from ARS: 31.73.06 31.73.06",
"content": null
}
Get Anteraja's delivery services and rates. If using the COD add-on service, this API can be used to get COD Coverages.
HTTP Request
POST {base_path}/serviceRates
Request Body Parameters
Parameter | Required | Max Length | Description |
---|---|---|---|
origin |
Yes | 10 | Anteraja's district id. |
destination |
Yes | 10 | Anteraja's district id. |
weight |
Yes | 5 | Parcel weight in gram(s). Minimum is 1000. Maximum is 50000. |
Response Body Parameters
Parameter | Type | Description |
---|---|---|
status |
number | Response Status. |
info |
string | Response Information. |
content |
object | JSON Object to hold response content detail. |
content.origin |
string | Origin district id. |
content.destination |
string | Destination district id. |
content.services |
array | JSON Array of service JSON objects having the information about different service rates. |
content.services.product_code |
string | Product Code. |
content.services.product_name |
string | Product Name. |
content.services.etd |
string | Services Estimated Time Delivery. |
content.services.rates |
number | Services rates. |
content.services.is_cod |
number | COD Payment Option. |
content.services.surcharges |
number | Additional Surcharges Option. |
Preorder
curl --location --request POST '/preorder' \
--header 'Content-Type: application/json' \
--header 'access-key-id: ***' \
--header 'secret-access-key: ***' \
--data-raw '{
"booking_id": "PREFIX-2019100818150102",
"invoice_no": "INV/RJ/2019090403",
"service_code": "REG",
"parcel_total_weight": 1000,
"shipper": {
"name": "JuliShop",
"phone": "081234324283",
"email": "julishop@gmail.com",
"district": "31.75.08",
"address": "Jl Kampung Pulo Pinang Ranti",
"postcode": "13510",
"geoloc": ""
},
"receiver": {
"name": "JuliBuyer",
"phone": "012931232139819",
"email": "julibuyer@gmail.com",
"district": "31.75.08",
"address": "Jalan Halim Perdanakusuma, RT.3/RW.4, Halim Perdana Kusumah",
"postcode": "13610",
"geoloc": ""
},
"items": [{
"item_name": "Laptop 2",
"item_desc": "Laptop ROG",
"item_category": "ELECTRONIC",
"item_quantity": 1,
"declared_value": 15000000,
"weight": 1000
}],
"use_insurance": true,
"declared_value": 15000000,
"cod": {
"is_cod": true,
"total_cod": 15000000
}
}'
{
"booking_id": "PREFIX-2019100818150102",
"invoice_no": "INV/RJ/2019090403",
"service_code": "REG",
"parcel_total_weight": 1000,
"shipper": {
"name": "JuliShop",
"phone": "081234324283",
"email": "julishop@gmail.com",
"district": "31.75.08",
"address": "Jl Kampung Pulo Pinang Ranti",
"postcode": "13510",
"geoloc": ""
},
"receiver": {
"name": "JuliBuyer",
"phone": "012931232139819",
"email": "julibuyer@gmail.com",
"district": "31.75.08",
"address": "Jalan Halim Perdanakusuma, RT.3/RW.4, Halim Perdana Kusumah",
"postcode": "13610",
"geoloc": ""
},
"items": [{
"item_name": "Laptop 2",
"item_desc": "Laptop ROG",
"item_category": "ELECTRONIC",
"item_quantity": 1,
"declared_value": 15000000,
"weight": 1000
}],
"use_insurance": true,
"declared_value": 15000000,
"cod": {
"is_cod": true,
"total_cod": 15000000
}
}
Success response:
{
"status": 200,
"info": "OK",
"content": {
"waybill_no": "10000001088274"
}
}
Failed response:
{
"status": 110,
"info": "Required parameters should not be null: booking_id",
"content": null
}
Create a pre-order. Anteraja will automate create the order when pickup service requested. Maximum items array is 30 items.
Before calling this API please call the Service Rates API to ensure the availability of provided service.
To Enable COD Payment Method, please coordinate with our Business Integration Team first.
HTTP Request
POST {base_path}/preorder
Request Body Parameters
Parameter | Required | Max Length | Description |
---|---|---|---|
booking_id |
Yes | 25 | Customer's System Unique Transaction Id / Booking Id. Format : [PREFIX]-[TRX ID]. Prefix will be given by Anteraja Team. We will trim the leading and trailing whitespace, and ignore case. |
invoice_no |
No | 40 | Customer's System Invoice No. |
service_code |
Yes | 3 | Anteraja Service Type (SD, ND, REG, ICE, BIG). |
parcel_total_weight |
No | 5 | Parcel Total Weight (in grams). Minimum is 1000. Maximum is 50000. |
[shipper/receiver].name |
Yes | 50 | Shipper / Receiver Name info. |
[shipper/receiver].phone |
Yes | 16 | Shipper / Receiver Telephone info. |
[shipper/receiver].email |
No | 50 | Shipper / Receiver Email info. |
[shipper/receiver].district |
Yes | 10 | Shipper / Receiver District Code. |
[shipper/receiver].address |
Yes | 256 | Shipper / Receiver Address detail info. |
[shipper/receiver].postcode |
No | 5 | Shipper / Receiver Postcode info. |
[shipper/receiver].geoloc |
No | 100 | Shipper / Receiver Geolocation (Longitude, Latitude) info. |
items.item_name |
Yes | 50 | Item name info. |
items.item_desc |
No | 32 | Item description info. |
items.item_category |
No | 20 | Item category info. Mandatory if use_insurance = true, value of parameter must match to list item categories provided in API insurance section. |
items.item_quantity |
Yes | 2 | Item quantity info. Minimum is 1. |
items.declared_value |
Yes | 9 | Item value info (per item). Minimum is 1000. |
items.weight |
Yes | 5 | Item weight info (in grams and per item). Minimum is 100. Maximum is 50000. |
use_insurance |
No | 1 | Order covered by insurance or not. (true / false). |
declared_value |
Yes | 9 | Parcel declared value. |
cod.is_cod |
No | 1 | COD Payment Flag. (true / false). |
cod.total_cod |
No | 9 | COD Amount, Mandatory if is_cod is true. |
Response Body Parameters
Parameter | Type | Description |
---|---|---|
status |
number | Response Status. |
info |
string | Response Information. |
content |
object | JSON Object to hold response content detail. |
content.waybill_no |
string | Anteraja's Airway Bill No. |
Order
curl --location --request POST '/order' \
--header 'Content-Type: application/json' \
--header 'access-key-id: ***' \
--header 'secret-access-key: ***' \
--data-raw '{
"booking_id": "PREFIX-2019100818150102",
"invoice_no": "INV/RJ/2019090403",
"service_code": "REG",
"parcel_total_weight": 3000,
"shipper": {
"name": "JuliShop",
"phone": "081234324283",
"email": "julishop@gmail.com",
"district": "31.75.08",
"address": "Jl Kampung Pulo Pinang Ranti",
"postcode": "13510",
"geoloc": ""
},
"receiver": {
"name": "JuliBuyer",
"phone": "012931232139819",
"email": "julibuyer@gmail.com",
"district": "31.75.08",
"address": "Jalan Halim Perdanakusuma, RT.3/RW.4, Halim Perdana Kusumah",
"postcode": "13610",
"geoloc": ""
},
"items": [{
"item_name": "Laptop 2",
"item_desc": "Laptop ROG",
"item_category": "ELECTRONIC",
"item_quantity": 2,
"declared_value": 15000000,
"weight": 2000
},
{
"item_name": "SSD 256GB",
"item_desc": "SSD Samsung 256GB",
"item_category": "ELECTRONIC",
"item_quantity": 1,
"declared_value": 1200000,
"weight": 1000
}
],
"use_insurance": true,
"declared_value": 16200000,
"cod": {
"is_cod": true,
"total_cod": 16200000
},
"expect_time": "2022-05-12 14:00:00"
}'
{
"booking_id": "PREFIX-2019100818150102",
"invoice_no": "INV/RJ/2019090403",
"service_code": "REG",
"parcel_total_weight": 3000,
"shipper": {
"name": "JuliShop",
"phone": "081234324283",
"email": "julishop@gmail.com",
"district": "31.75.08",
"address": "Jl Kampung Pulo Pinang Ranti",
"postcode": "13510",
"geoloc": ""
},
"receiver": {
"name": "JuliBuyer",
"phone": "012931232139819",
"email": "julibuyer@gmail.com",
"district": "31.75.08",
"address": "Jalan Halim Perdanakusuma, RT.3/RW.4, Halim Perdana Kusumah",
"postcode": "13610",
"geoloc": ""
},
"items": [{
"item_name": "Laptop 2",
"item_desc": "Laptop ROG",
"item_category": "ELECTRONIC",
"item_quantity": 2,
"declared_value": 15000000,
"weight": 2000
},
{
"item_name": "SSD 256GB",
"item_desc": "SSD Samsung 256GB",
"item_category": "ELECTRONIC",
"item_quantity": 1,
"declared_value": 1200000,
"weight": 1000
}
],
"use_insurance": true,
"declared_value": 16200000,
"cod": {
"is_cod": true,
"total_cod": 16200000
},
"expect_time": "2022-05-12 14:00:00"
}
Success response:
{
"status": 200,
"info": "OK",
"content": {
"waybill_no": "10000001934076",
"expect_start": "2022-05-12 14:00:00",
"expect_finish": "2022-05-12 16:00:00"
}
}
Failed response:
{
"status": 400,
"info": "waybill_no not exists",
"content": null
}
Create order and automatically trigger request pickup. Maximum items array is 30 items.
Before calling this API please call the Service Rates API to ensure the availability of provided service.
To Enable COD Payment Method, please coordinate with our Business Integration Team first.
HTTP Request
POST {base_path}/order
Request Body Parameters
Parameter | Required | Max Length | Description |
---|---|---|---|
booking_id |
Yes | 25 | Customer's System Unique Transaction Id / Booking Id. Format : [PREFIX]-[TRX ID]. Prefix will be given by Anteraja Team. We will trim the leading and trailing whitespace, and ignore case. |
invoice_no |
No | 40 | Customer's System Invoice No. |
service_code |
Yes | 3 | Anteraja Service Type (SD, ND, REG, ICE, BIG). |
parcel_total_weight |
No | 5 | Parcel Total Weight (in grams). Minimum is 1000. Maximum is 50000. |
[shipper/receiver].name |
Yes | 50 | Shipper / Receiver Name info. |
[shipper/receiver].phone |
Yes | 16 | Shipper / Receiver Telephone info. |
[shipper/receiver].email |
No | 50 | Shipper / Receiver Email info. |
[shipper/receiver].district |
Yes | 10 | Shipper / Receiver District Code. |
[shipper/receiver].address |
Yes | 256 | Shipper / Receiver Address detail info. |
[shipper/receiver].postcode |
No | 5 | Shipper / Receiver Postcode info. |
[shipper/receiver].geoloc |
No | 100 | Shipper / Receiver Geolocation (Longitude, Latitude) info. |
items.item_name |
Yes | 50 | Item name info. |
items.item_desc |
No | 32 | Item description info. |
items.item_category |
No | 20 | Item category info. Mandatory if use_insurance = true, value of parameter must match to list item categories provided in API insurance section. |
items.item_quantity |
Yes | 2 | Item quantity info. Minimum is 1. |
items.declared_value |
Yes | 9 | Item value info (per item). Minimum is 1000. |
items.weight |
Yes | 5 | Item weight info (in grams and per item). Minimum is 100. Maximum is 50000. |
use_insurance |
No | 1 | Order covered by insurance or not. (true / false). |
declared_value |
Yes | 9 | Parcel declared value. |
cod.is_cod |
No | 1 | COD Payment Flag. (true / false). |
cod.total_cod |
No | 9 | COD Amount, Mandatory if is_cod is true. |
expect_time |
No | 19 | Expected pickup time. |
Response Body Parameters
Parameter | Type | Description |
---|---|---|
status |
number | Response Status. |
info |
string | Response Information. |
content |
object | JSON Object to hold response content detail. |
content.waybill_no |
string | Anteraja's Waybill No. |
content.expect_start |
Yes | Pickup schedule time start (estimation). |
content.expect_finish |
Yes | Pickup schedule time end (estimation). |
Request Pickup
curl --location --request POST '/requestPickup' \
--header 'Content-Type: application/json' \
--header 'access-key-id: ***' \
--header 'secret-access-key: ***' \
--data-raw '{
"waybill_no" : "[airway bill from preOrder response]",
"expect_time": "2022-05-12 13:39:00"
}'
{
"waybill_no" : "[airway bill from preOrder response]",
"expect_time": "2022-05-12 13:39:00"
}
Success response:
{
"status": 200,
"info": "OK",
"content": {
"expect_start": "2022-05-12 14:00:00",
"expect_finish": "2022-05-12 16:00:00"
}
}
Failed response:
{
"status": 400,
"info": "waybill_no not exists",
"content": null
}
If an order created by Preorder API, then should be followed by Request Pickup. If an order created by Order API, then no need to call Request Pickup.
HTTP Request
POST {base_path}/requestPickup
Request Body Parameters
Parameter | Required | Max Length | Description |
---|---|---|---|
waybill_no |
Yes | 20 | Anteraja's airway bill no (from preOrder Response). |
expect_time |
No | 19 | Date time to be picked up. |
Response Body Parameters
Parameter | Type | Description |
---|---|---|
status |
number | Response Status. |
info |
string | Response Information. |
content |
object | JSON Object to hold response content detail. |
content.expect_start |
Yes | Pickup schedule time start (estimation). |
content.expect_finish |
Yes | Pickup schedule time end (estimation). |
Cancel Order
curl --location --request POST '/cancelOrder' \
--header 'Content-Type: application/json' \
--header 'access-key-id: ***' \
--header 'secret-access-key: ***' \
--data-raw '{
"waybill_no" : "10000000900874"
}'
{
"waybill_no" : "10000000900874"
}
Success Response:
{
"status": 200,
"info": "OK",
"content": null
}
Failed Response:
{
"status": 400,
"info": "waybill_no not exists",
"content": null
}
Failed Response:
{
"status": 400,
"info": "Order cannot be cancelled before 5 minute(s) after order creation",
"content": null
}
To cancel order after request pickup, but Anteraja will ignore this request if the parcel has been picked up. Value of booking_id
and waybill_no
should be a correct pair. Cancellations can only be done 5 minutes after order creation.
HTTP Request
POST {base_path}/cancelOrder
Request Body Parameters
Parameter | Required | Max Length | Description |
---|---|---|---|
waybill_no |
Yes | 20 | Anteraja's airway bill no. |
Response Body Parameters
Parameter | Type | Description |
---|---|---|
status |
number | Response Status. |
info |
string | Response Information. |
content |
object | JSON Object to hold response content detail. |
Tracking
curl --location --request POST '/tracking' \
--header 'Content-Type: application/json' \
--header 'access-key-id: ***' \
--header 'secret-access-key: ***' \
--data-raw '{
"waybill_no": "10001079472341"
}'
{
"waybill_no": "10001079472341"
}
Success Response:
{
"status": 200,
"info": "OK",
"content": {
"waybill_no": "10001079472341",
"history": [
{
"hub_name": "Hub Halim",
"message": {
"id": "Delivery sukses oleh SATRIA dan paket telah diterima oleh ibu pola(Keluarga). Terima kasih sudah menggunakan jasa AnterAja #PastiBawaHepi."
},
"params": null,
"tracking_code": 250,
"timestamp": "2021-04-06T10:45:03.949+0000"
},
{
"hub_name": "Hub Halim",
"message": {
"id": "SATRIA sudah ditugaskan dan parcel akan segera diantar ke penerima."
},
"params": null,
"tracking_code": 240,
"timestamp": "2021-04-06T10:10:12.936+0000"
},
{
"hub_name": "Hub Halim",
"message": {
"id": "Parcel sudah tiba di SS Kota Jkt Tmr - Kebon Pala untuk proses delivery."
},
"params": null,
"tracking_code": 230,
"timestamp": "2021-04-06T09:51:07.000+0000"
},
{
"hub_name": "LH8 Kota Jkt Tmr - Kebon Pala",
"message": {
"id": "Parcel sedang menuju ke staging."
},
"params": null,
"tracking_code": 330,
"timestamp": "2021-04-06T09:50:08.000+0000"
},
{
"hub_name": "LH8 Kota Jkt Tmr - Kebon Pala",
"message": {
"id": "Parcel sedang diproses di Hub Jakarta Timur-Makasar"
},
"params": null,
"tracking_code": 300,
"timestamp": "2021-04-06T09:47:58.516+0000"
},
{
"hub_name": "LH8 Kota Jkt Tmr - Kebon Pala",
"message": {
"id": "Parcel sudah tiba di Hub Jakarta Timur-Makasar."
},
"params": null,
"tracking_code": 220,
"timestamp": "2021-04-06T09:47:45.000+0000"
},
{
"hub_name": "LH8 Kota Jkt Tmr - Kebon Pala",
"message": {
"id": "Parcel sedang diproses di Hub Jakarta Timur-Makasar"
},
"params": null,
"tracking_code": 300,
"timestamp": "2021-04-06T09:47:38.006+0000"
},
{
"hub_name": "Hub Halim",
"message": {
"id": "Parcel sudah tiba di SS Kota Bekasi - Jatimelati untuk menuju ke hub."
},
"params": null,
"tracking_code": 210,
"timestamp": "2021-04-06T08:28:41.461+0000"
},
{
"hub_name": "Hub Halim",
"message": {
"id": "Parcel sudah di-pickup oleh SATRIA."
},
"params": null,
"tracking_code": 200,
"timestamp": "2021-04-06T07:17:51.756+0000"
},
{
"hub_name": "Hub Halim",
"message": {
"id": "Tugas pickup sudah diambil alih oleh SATRIA dan parcel akan segera pickup."
},
"params": null,
"tracking_code": 160,
"timestamp": "2021-04-06T06:37:07.696+0000"
},
{
"hub_name": "Hub Bekasi",
"message": {
"id": "SATRIA sudah ditugaskan dan parcel akan segera di-pickup."
},
"params": null,
"tracking_code": 150,
"timestamp": "2021-04-06T06:21:04.587+0000"
},
{
"hub_name": null,
"message": {
"id": "Pickup sudah di-request oleh shipper, dan SATRIA akan pickup parcel Selasa 6 April 2021 sekitar jam 13:20 - 15:20."
},
"params": null,
"tracking_code": 100,
"timestamp": "2021-04-06T06:20:22.837+0000"
}
],
"order": {
"booking_id": "TQ04215IYBZC-01",
"shipper": {
"address": "Jl. Wibawa Mukti II No.5, RT.004/RW.8, Jatiasih, Kec. Jatiasih, Kota Bekasi, Jawa Barat 17423",
"phone": "6281290529552",
"name": "Apotek Wibawa Mukti",
"postcode": "17423"
},
"waybill": "10001079472341",
"receiver": {
"address": "Jl. Komodor Halim Perdana Kusuma Blok Mawar No.26, RT.7/RW.8, Halim Perdana Kusumah, Kec. Makasar, Kota Jakarta Timur, Daerah Khusus Ibukota Jakarta 13610, Indonesia",
"phone": "6281311436911",
"name": "Inda Supriyanti",
"postcode": "13610"
},
"service_fee": 15000,
"weight": 1000,
"service_code": "SD",
"invoice": "INV-TQ04215IYBZC-01",
"actual_shipper": {
"proof_images": [],
"name": null,
"proof_images_url": [],
"relationship": null
},
"actual_receiver": {
"proof_images": [],
"name": "ibu pola",
"proof_images_url": [],
"relationship": "Keluarga"
}
}
}
}
Failed Response:
{
"status": 200,
"info": "OK",
"content": {
"waybill_no": "10001079472341",
"history": null,
"order": null
}
}
Get status history for specific order.
Please use scheduler / regularly to check In Progress Parcel (AWB).
HTTP Request
POST {base_path}/tracking
Request Body Parameters
Parameter | Required | Max Length | Description |
---|---|---|---|
waybill_no |
Yes | 20 | Anteraja's airway bill no. |
Response Body Parameters
Parameter | Type | Description |
---|---|---|
status |
number | Response Status. |
info |
string | Response Information. |
content |
object | JSON Object to hold response content detail. |
content.waybill_no |
object | Anteraja Airway Bill no. |
content.history |
array | JSON Array of history JSON objects having the information about tracking update. |
content.history.hub_name |
string | Hub location name. |
content.history.message |
object | JSON objects to hold tracking message. |
content.history.tracking_code |
number | Tracking status code. |
content.history.timestamp |
string | Tracking status timestamp. |
content.order |
object | JSON objects to hold order detail information. |
content.order.booking_id |
string | Customer's System Unique Transaction Id / Booking Id. |
content.order.waybill |
string | Anteraja's Airway Bill no. |
content.order.shipper |
object | JSON objects to hold shipper information i.e. address , phone , name , postcode . |
content.order.receiver |
object | JSON objects to hold receiver information i.e. address , phone , name , postcode . |
content.order.service_fee |
number | Shipping Fee. |
content.order.invoice |
string | Customer's System Invoice No. |
content.order.actual_shipper |
object | JSON objects to hold actual shipper information. |
content.order.actual_receiver |
object | JSON objects to hold actual shipper information i.e. name , relationship . |
Insurance
curl --location --request POST '/insurance' \
--header 'Content-Type: application/json' \
--header 'access-key-id: ***' \
--header 'secret-access-key: ***' \
--data-raw '{
"declared_value": 2000000,
"item_category": "ELECTRONIC"
}'
{
"declared_value": 2000000,
"item_category": "ELECTRONIC"
}
Success Response:
{
"status": 200,
"insurance_fee": 8000
}
Failed Response:
{
"status": 404,
"info": "declared_value failed parse to number type",
"content": null
}
Get insurance fee info.
List Item Category |
---|
BARANG BERHARGA |
DOC |
OTOMOTIF |
FNB |
FASHION |
ELECTRONIC |
HOUSEHOLD |
MAINAN |
ATK |
MEBEL |
KESEHATAN |
LAINNYA |
HTTP Request
POST {base_path}/insurance
Request Body Parameters
Parameter | Required | Max Length | Description |
---|---|---|---|
declared_value |
Yes | 9 | Parcel declared value. |
item_category |
Yes | 20 | Parcel item category. Please refer to List Item Category above. |
Response Body Parameters
Parameter | Type | Description |
---|---|---|
status |
number | Response Status. |
insurance_fee |
number | Insurance fee value. |
info |
string | Response Information. |
Webhook
Tracking
curl --location --request POST '/tracking' \
--header 'Content-Type: application/json' \
--header 'User-Agent: Anteraja-Push-Service' \
--header 'authorization: .W-McU~%7omiByOEZ&|ozdFPhJM5)(' \
--data-raw '{
"waybill" : "10000005222588",
"booking_id" : "TEST0121OYAQQU-01",
"message" : "Pickup sudah di-request oleh shipper, dan SATRIA akan pickup parcel Kamis 21 Januari 2021 sekitar jam 15:00 - 17:00.",
"tracking_code" : 100,
"timestamp" : "2021-01-20 15:56:14.716"
}'
{
"waybill" : "10000005222588",
"booking_id" : "TEST0121OYAQQU-01",
"message" : "Pickup sudah di-request oleh shipper, dan SATRIA akan pickup parcel Kamis 21 Januari 2021 sekitar jam 15:00 - 17:00.",
"tracking_code" : 100,
"timestamp" : "2021-01-20 15:56:14.716"
}
Success Response:
{
"status": 200,
"info": "OK",
"content": {}
}
Failed Response:
{
"status": 400,
"info": "Error",
"content": {}
}
Update Tracking status and shipping information (ex : actual pickup weight and actual shipping fee).
We support API keys (at request header) as Authorization when push tracking status.
Please combine this webhook push tracking method with pull tracking to our API (use scheduler / batch process for awb that have been stuck for certain period).
HTTP Request
POST [customer API Endpoint]
Request Body Parameters
Parameter | Required | Max Length | Description |
---|---|---|---|
waybill |
Yes | 25 | Anteraja's airway bill no. |
booking_id |
Yes | 25 | Customer's System Unique Transaction Id / Booking Id |
message |
Yes | 500 | Tracking status message. |
tracking_code |
Yes | 5 | Tracking status code. |
timestamp |
Yes | 30 | Tracking status timestamp. |
Errors
Anteraja API will return `200' response code for success operation, and all error will uses the following error codes:
Error Code | Meaning |
---|---|
400 | Bad Request -- Your request is invalid. |
401 | Unauthorized -- Your API key is wrong. |
404 | Not Found -- The specified API could not be found. |
500 | Internal Server Error -- We had a problem with our server. Try again later. |