International Pricing V2
This endpoint is used for getting the rates for International Shipping Version 2
Get Pricing International
This endpoint will display all logistics available by Shipper on the chosen International route.
Authorizations : X-API-Key_Header
Request Body Schema : application/json
POST Pricing Domestic International
POST /v3/pricing/domestic-international
Request Data
| Parameter | Type | Description |
|---|---|---|
| destination.country_id (required) | integer | Country id of the origin (Ex. Indonesia 228) |
| origin.area_id (required) | integer | Area id of the destination obtained from Get Location |
| height (required) | integer | Height in cm |
| item_price (required) | integer | Value of the item in IDR |
| length (required) | integer | Length in cm |
| weight (required) | integer | Weight in kg |
| width (required) | integer | Width in cm |
Sample Request and Response for Order From Jabodetabek
{
"destination": {
"country_id": 180
},
"origin": {
"area_id": 4728
},
"height": 10,
"item_price": 100000,
"length": 10,
"weight": 1,
"width": 10
}
{
"metadata": {
"path": "/v3/pricing/domestic-international",
"http_status_code": 200,
"http_status": "OK",
"timestamp": 1659942580
},
"data": {
"origin": {
"area_id": 4728,
"area_name": "Kalibata",
"suburb_id": 485,
"suburb_name": "Pancoran",
"city_id": 41,
"city_name": "Jakarta Selatan",
"province_id": 6,
"province_name": "DKI Jakarta",
"country_id": 228,
"country_name": "INDONESIA",
"lat": -6.2641406,
"lng": 106.8370122
},
"destination": {
"area_id": 0,
"area_name": "",
"suburb_id": 0,
"suburb_name": "",
"city_id": 0,
"city_name": "",
"province_id": 0,
"province_name": "",
"country_id": 180,
"country_name": "SINGAPORE",
"lat": 0,
"lng": 0
},
"pricings": {
"international": [
{
"logistic": {
"id": 43,
"name": "Janio",
"logo_url": "https://janio.asia/wp-content/themes/janio/images/logo-header.png",
"code": "Janio",
"company_name": "Janio Asia "
},
"rate": {
"id": 580,
"name": "Janio",
"type": "International",
"description": "Janio",
"full_description": "set max kg",
"is_hubless": false
},
"weight": 1,
"volume": 1000,
"volume_weight": 0.2,
"final_weight": 1,
"min_day": 3,
"max_day": 7,
"unit_price": 223627,
"total_price": 223627,
"discount": 0,
"discount_value": 0,
"discounted_price": 223627,
"insurance_fee": 2500,
"must_use_insurance": false,
"liability_value": 0,
"final_price": 0,
"currency": "",
"insurance_applied": false,
"base_price": 223627,
"surcharge_fee": 0
},
{
"logistic": {
"id": 45,
"name": "Aramex",
"logo_url": "https://logovectorseek.com/wp-content/uploads/2019/08/aramex-logo-vector.png",
"code": "Aramex",
"company_name": "Aramex"
},
"rate": {
"id": 578,
"name": "Priority Parcel Express",
"type": "International",
"description": "Priority Parcel Express",
"full_description": "set max kg",
"is_hubless": false
},
"weight": 1,
"volume": 1000,
"volume_weight": 0.2,
"final_weight": 1,
"min_day": 3,
"max_day": 7,
"unit_price": 301656,
"total_price": 301656,
"discount": 0,
"discount_value": 0,
"discounted_price": 301656,
"insurance_fee": 1500,
"must_use_insurance": false,
"liability_value": 0,
"final_price": 0,
"currency": "",
"insurance_applied": false,
"base_price": 301656,
"surcharge_fee": 0
},
{
"logistic": {
"id": 24,
"name": "DPEX",
"logo_url": "https://global-cdn.shipper.id/images/png/logistic/dpex.240x90.png",
"code": "DPX",
"company_name": "DPEX Internasional"
},
"rate": {
"id": 327,
"name": "EXPRESS PARCEL",
"type": "International",
"description": "EXPRESS PARCEL",
"full_description": "set max kg",
"is_hubless": false
},
"weight": 1,
"volume": 1000,
"volume_weight": 0.2,
"final_weight": 1,
"min_day": 4,
"max_day": 10,
"unit_price": 321112,
"total_price": 321112,
"discount": 0,
"discount_value": 0,
"discounted_price": 321112,
"insurance_fee": 200,
"must_use_insurance": false,
"liability_value": 0,
"final_price": 0,
"currency": "",
"insurance_applied": false,
"base_price": 321112,
"surcharge_fee": 0
}
]
},
"pricing_error": []
},
"pagination": {
"current_page": 1,
"current_elements": 3,
"total_pages": 1,
"total_elements": 3
}
}
Sample Request and Response for Order Outside Jabodetabek
{
"destination": {
"country_id": 180
},
"origin": {
"area_id": 11484
},
"height": 10,
"item_price": 100000,
"length": 10,
"weight": 1,
"width": 10
}
{
"metadata": {
"path": "/v3/pricing/domestic-international",
"http_status_code": 200,
"http_status": "OK",
"timestamp": 1659943969
},
"data": {
"origin": {
"area_id": 11484,
"area_name": "Wanawali",
"suburb_id": 1160,
"suburb_name": "Cibatu",
"city_id": 74,
"city_name": "Purwakarta",
"province_id": 9,
"province_name": "Jawa Barat",
"country_id": 228,
"country_name": "INDONESIA",
"lat": -6.5660236,
"lng": 107.544598
},
"destination": {
"area_id": 0,
"area_name": "",
"suburb_id": 0,
"suburb_name": "",
"city_id": 0,
"city_name": "",
"province_id": 0,
"province_name": "",
"country_id": 180,
"country_name": "SINGAPORE",
"lat": 0,
"lng": 0
},
"pricings": {
"domestic": [
{
"logistic": {
"id": 9,
"name": "J&T",
"logo_url": "https://global-cdn.shipper.id/images/png/logistic/jnt.240x90.png",
"code": "JNT",
"company_name": "PT Global Jet Express"
},
"rate": {
"id": 57,
"name": "Express",
"type": "Regular",
"description": "Express Rate",
"full_description": "",
"is_hubless": true
},
"weight": 1,
"volume": 1000,
"volume_weight": 0.16666666666666666,
"final_weight": 1,
"min_day": 1,
"max_day": 3,
"unit_price": 15000,
"total_price": 15000,
"discount": 0,
"discount_value": 0,
"discounted_price": 15000,
"insurance_fee": 250,
"must_use_insurance": false,
"liability_value": 100000,
"final_price": 15000,
"currency": "IDR",
"insurance_applied": false,
"base_price": 0,
"surcharge_fee": 0
}...
],
"international": [
{
"logistic": {
"id": 43,
"name": "Janio",
"logo_url": "https://janio.asia/wp-content/themes/janio/images/logo-header.png",
"code": "Janio",
"company_name": "Janio Asia "
},
"rate": {
"id": 580,
"name": "Janio",
"type": "International",
"description": "Janio",
"full_description": "set max kg",
"is_hubless": false
},
"weight": 1,
"volume": 1000,
"volume_weight": 0.2,
"final_weight": 1,
"min_day": 3,
"max_day": 7,
"unit_price": 223627,
"total_price": 223627,
"discount": 0,
"discount_value": 0,
"discounted_price": 223627,
"insurance_fee": 2500,
"must_use_insurance": false,
"liability_value": 0,
"final_price": 0,
"currency": "",
"insurance_applied": false,
"base_price": 223627,
"surcharge_fee": 0
}...
]
},
"pricing_error": [
{
"code": 3001,
"message": "Pricing not available",
"logistic_id": 5,
"logistic_name": "SiCepat",
"rate_id": 58,
"rate_name": "REG"
}...
]
},
"pagination": {
"current_page": 1,
"current_elements": 7,
"total_pages": 1,
"total_elements": 7
}
}
Response List
| Parameter | Description |
|---|---|
| metadata | Metadata information |
| metadata.path | API endpoint path |
| metadata.http_status_code | HTTP status code |
| metadata.http_status | HTTP status |
| metadata.timestamp | Timestamp |
| pagination | Paging information |
| pagination.current_page | Current page |
| pagination.current_elements | Total item per page |
| pagination.total_pages | Total pages |
| pagination.total_elements | Total datas |
| data | All important information about the 3PL pricing |
| data.origin | All important information about the origin that have been sent |
| data.origin.area_id | Area ID of the origin |
| data.origin.area_name | Area name of the origin |
| data.origin.suburb_id | Suburb ID of the origin |
| data.origin.suburb_name | Suburb name of the origin |
| data.origin.city_id | City ID of the origin |
| data.origin.city_name | City name of the origin |
| data.origin.province_id | Province ID of the origin |
| data.origin.province_name | Province name of the origin |
| data.origin.country_id | Country ID of the origin |
| data.origin.country_name | Country name of the origin |
| data.destination.lat | Latitude of the destination |
| data.destination.lng | Longitude of the destination |
| data.pricings | All important information about the available 3PLs based on the request |
| data.pricings.domestic | All important information about the available domestic 3PLs based on the request. This parameter only appear for order from outside Jabodetabek. When this param appear, you need to use pricings.domestic[].rate.id for order creation process because it required. |
| data.pricings.domestic[].logistic | All important information about logistic |
| data.pricings.domestic[].logistic.id | Logistic ID |
| data.pricings.domestic[].name | Logistic name |
| data.pricings.domestic[].logo_url | Logistic URL logo |
| data.pricings.domestic[].code | Logistic code |
| data.pricings.domestic[].company_name | Logistic company name |
| data.pricings.domestic[].rate | All important information about the available rate service of the logistic |
| data.pricings.domestic[].rate.id | Rate service ID. Required to use when Create Order |
| data.pricings.domestic[].rate.name | Rate service name |
| data.pricings.domestic[].rate.type | Rate service type |
| data.pricings.domestic[].rate.description | Rate service description |
| data.pricings.domestic[].rate.full_description | Rate service full description |
| data.pricings.domestic[].weight | Weight of the package (kg) |
| data.pricings.domestic[].volume | Volume of the package based on the length, width, and height |
| data.pricings.domestic[].volume_weight | Volumetric weight of the package |
| data.pricings.domestic[].final_weight | Final weight that have been chosen between "weight" and "volume_weight". Will choose which one is heavier. |
| data.pricings.domestic[].min_day | Minimum day of delivery estimation |
| data.pricings.domestic[].max_day | Maximum day of delivery estimation |
| data.pricings.domestic[].unit_price | Shipment fee for 1 kg |
| data.pricings.domestic[].total_price | Total shipment fee |
| data.pricings.domestic[].discount | Discount percentage |
| data.pricings.domestic[].discount_value | Discount value (IDR) |
| data.pricings.domestic[].discounted_price | Shipment fee after discount |
| data.pricings.domestic[].insurance_fee | Insurance fee for the package |
| data.pricings.domestic[].must_use_insurance | Information about whether required to use insurance or not. If ""must_use_insurance"" true, then final_price will be total_price + insurance_fee If ""must_use_insurance"" false, then final_price will be total_price only. If ""must_use_insurance"" true, then use_insurance on Create Order must be true. |
| data.pricings.domestic[].lialibility_value | Package value |
| data.pricings.domestic[].final_price | Total shipment fee with discount and insurance fee |
| data.pricings.domestic[].currency | Currency that Shipper used |
| data.pricings.domestic[].insurance_applied | Information about whether the insurance fee already applied in the price |
Important Return Parameters
rate.id - Required to be use when Create Order
must_use_insurance - Determine whether it is required to use insurance or not
insurance_fee - The cost of insurance
final_price - Price of the Shipment
If "must_use_insurance" true, final_price will be total_price + insurance_fee
If "must_use_insurance" false, final_price will be total_price only.rate.is_hubless - If is_hubless is true, the order will be pick up by the 3PL courier directly.
Updated 8 months ago