Create Order International V2
Create Order International V2
By creating an order, the rate of the shipment will be locked and order_id will be generated to identify that order.
Authorizations : X-API-Key_Header
Request Body Schema : application/json
POST Create Order International V2
POST /v3/order/internationalRequest Data
Parameter | Type | Description |
|---|---|---|
coverage (required) | string | Always fill "international" |
payment_type (required) | string | Always fill "postpay" |
courier.cod (required) | boolean | COD "Flag to determine whether order are Cash on Delivery or not (false/true)" |
courier. international_rate_id (required) | integer | International rates ID from get pricing domestic international |
courier. domestic_rate_id | integer | Domestic rates ID from get international domestic international (pricings.domestic) |
courier.use_insurance (required) | boolean | Use true if you want to use insurance otherwise* false*. But if the pricing is flagged compulsory insurance, must use true |
destination.country_id (required) | integer | The ID of the country from LocationAPI |
destination.address (required) | string | Destination address of international package |
origin.area_id (required) | integer | The area ID of the origin obtained from Location API |
origin.suburb_id (required)v | integer | The suburb ID of the origin obtained from Location API |
origin.address (required) | string | Address of the Origin (No Symbol Allowed Except # & ' . - = + , ( ) ) |
consignee.name (required) | string | Consignee name |
consignee.phone_number (required) | string | Consignee phone number |
consignee.email (required) | string | Consignee email |
consigner.name (required) | string | Consignee name |
consigner.phone_number (required) | string | Consigner phone number |
consigner.email (required) | string | Consigner email |
package.weight (required) | integer | Package weight in kg |
package.height (required) | integer | Package height in cm |
package.length (required) | integer | Package length in cm |
package.width (required) | integer | Package with in cm |
package.package_type (required) | integer | Package type category |
package.price (required) | integer | The total value of the order |
package.items.name (required) | string | The name of the item |
package.items.price (required) | integer | The value of that single item |
package.items.qty (required) | integer | The quantity of the item |
package.international.unit (required) | string | Boxes/Centigram/Centimeters/Cubic Centimeters/Cubic Feet/Cubic Meters/Dozen Pairs/Dozen/Pieces/Grams/Gross/Kilograms/Liters/Meters/Number/Ounces/Pairs/Gallons/Pounds/Square Centimeters/Square Feet/Square Inches/Cartons/Feet/Inches/Sachets/Set/Milimeters/Yards/Miligrams/Square Yards/Mililiters/Each/Square Meters |
package.international.reason (required) | string | Gift/Commercial/Personal, Not for Resale/Sample/Return for Repair/Return after Repair |
package.international.quantity (required) | integer | Package international quantity |
package.international.made_in (required) | string | Package made in |
package.international.item_type (required) | string | Package item type |
package.international.destination_packet (required) | string | Package international destination |
package.international.description_item (required) | string | Package item description |
package.international.custom_declaration.tax_document (required) | string | Document tax type of package custom declaration |
package.international.custom_declaration.document_number (required) | string | Document number of package custom declaration |
package.international.custom_declaration.additional_document.document | string | Additional document of package custom declaration |
package.international.custom_declaration.additional_document.document_number | string | Number of additional document of package custom declaration |
package.international.custom_declaration.additional_document.media_url | string | Media URL of additional document of package custom declaration |
Sample Request & Response
{
"coverage": "international",
"payment_type": "postpay",
"courier": {
"cod": false,
"international_rate_id": 580,
"domestic_rate_id":57,
"use_insurance": true
},
"destination": {
"country_id": 180,
"address": "Singapore "
},
"origin": {
"area_id": 11484,
"suburb_id": 1160,
"address": "Indonesiaku"
},
"consignee": {
"name": "Ade",
"phone_number": "6282240650009",
"email": "[email protected]"
},
"consigner": {
"name": "Rifaldi",
"phone_number": "6581511188850",
"email": "[email protected]"
},
"package": {
"international": {
"custom_declaration": {
"additional_document": [
{
"document": "add document 1",
"document_number": "1234",
"media_url": "url 1"
}
],
"document_number": "98765432",
"tax_document": "SIM"
},
"description_item": "item describe",
"destination_packet": "paket destinasi",
"item_type": "tipe item",
"made_in": "indonesia",
"quantity": 1,
"reason": "new goods",
"unit": "KG"
},
"weight": 2,
"height": 17,
"length": 17,
"width": 17,
"package_type": 2,
"price": 9702809,
"items": [
{
"name": "Modicon M241 Controller 24 IO transistor PNP Ethernet - TM241CE24T",
"price": 9602670,
"qty": 1
},
{
"name": "Domae MCB Box - empty enclosure - 4 modules - DOMH12104F",
"price": 100139,
"qty": 1
}
]
}
}{
"metadata": {
"path": "/v3/order/international",
"http_status_code": 201,
"http_status": "Created",
"timestamp": 1659951405
},
"data": {
"domestic": {
"coverage": "domestic",
"order_id": "228N2EXRWRKJ3",
"payment_type": "postpay",
"courier": {
"rate_id": 57,
"amount": 30000,
"use_insurance": true,
"insurance_amount": 24257,
"cod": false
},
"consignee": {
"name": "Ade",
"email": "[email protected]",
"phone_number": "6282240650009"
},
"consigner": {
"name": "Rifaldi",
"email": "[email protected]",
"phone_number": "6581511188850"
},
"destination": {
"address": "Jl. TB Simatupang No.22b, RW.11 / SHIPPER HUB",
"area_id": 4661,
"area_name": "Gedong",
"city_id": 40,
"city_name": "Jakarta Timur",
"country_id": 228,
"country_name": "INDONESIA",
"direction": "SHIPPER HUB",
"lat": "-6.30038810",
"lng": "106.86208910",
"postcode": "13760",
"province_id": 6,
"province_name": "DKI Jakarta",
"suburb_id": 475,
"suburb_name": "Pasar Rebo",
"email_address": "",
"company_name": ""
},
"origin": {
"address": "Indonesiaku",
"area_id": 11484,
"area_name": "Wanawali",
"city_id": 74,
"city_name": "Purwakarta",
"country_id": 228,
"country_name": "INDONESIA",
"lat": "",
"lng": "",
"postcode": "41181",
"province_id": 9,
"province_name": "Jawa Barat",
"suburb_id": 1160,
"suburb_name": "Cibatu",
"email_address": "",
"company_name": ""
},
"package": {
"package_type": 2,
"weight": 2,
"length": 17,
"width": 17,
"height": 17,
"price": 9702809,
"items": [
{
"id": 745629,
"name": "Modicon M241 Controller 24 IO transistor PNP Ethernet - TM241CE24T",
"qty": 1,
"price": 9602670
},
{
"id": 745630,
"name": "Domae MCB Box - empty enclosure - 4 modules - DOMH12104F",
"qty": 1,
"price": 100139
}
],
"international": {
"custom_declaration": {
"additional_document": null,
"document_number": "",
"tax_document": ""
},
"description_item": "",
"destination_packet": "",
"item_type": "",
"made_in": "",
"quantity": 0,
"reason": "",
"unit": ""
}
}
},
"international": {
"coverage": "international",
"order_id": "228WQ6V7M6JRY",
"payment_type": "postpay",
"courier": {
"rate_id": 580,
"amount": 323680,
"use_insurance": true,
"insurance_amount": 242570,
"cod": false
},
"consignee": {
"name": "Ade",
"email": "[email protected]",
"phone_number": "6282240650009"
},
"consigner": {
"name": "Rifaldi",
"email": "[email protected]",
"phone_number": "6581511188850"
},
"destination": {
"address": "Singapore",
"area_id": 0,
"area_name": "",
"city_id": 0,
"city_name": "",
"country_id": 180,
"country_name": "",
"lat": "",
"lng": "",
"postcode": "",
"province_id": 0,
"province_name": "",
"suburb_id": 0,
"suburb_name": "",
"email_address": "",
"company_name": ""
},
"origin": {
"address": "Jl. TB Simatupang No.22b, RW.11 / SHIPPER HUB",
"area_id": 4661,
"area_name": "Gedong",
"city_id": 40,
"city_name": "Jakarta Timur",
"country_id": 228,
"country_name": "INDONESIA",
"direction": "SHIPPER HUB",
"lat": "-6.30038810",
"lng": "106.86208910",
"postcode": "13760",
"province_id": 6,
"province_name": "DKI Jakarta",
"suburb_id": 475,
"suburb_name": "Pasar Rebo",
"email_address": "",
"company_name": ""
},
"package": {
"package_type": 2,
"weight": 2,
"length": 17,
"width": 17,
"height": 17,
"price": 9702809,
"items": [
{
"id": 745629,
"name": "Modicon M241 Controller 24 IO transistor PNP Ethernet - TM241CE24T",
"qty": 1,
"price": 9602670
},
{
"id": 745630,
"name": "Domae MCB Box - empty enclosure - 4 modules - DOMH12104F",
"qty": 1,
"price": 100139
}
],
"international": {
"custom_declaration": {
"additional_document": [
{
"document": "add document 1",
"document_number": "1234",
"media_url": "url 1"
}
],
"document_number": "98765432",
"tax_document": "SIM"
},
"description_item": "item describe",
"destination_packet": "paket destinasi",
"item_type": "tipe item",
"made_in": "indonesia",
"quantity": 1,
"reason": "new goods",
"unit": "KG"
}
},
"order_reference": "228N2EXRWRKJ3"
}
}
}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 |
data | All important information about order creation placed on this param |
data.coverage | Order creation type: domestic/international |
data.order_id | Shipper Order ID. To be use for pickup request |
data.payment_type | Merchant payment type: cash/postpay |
courier | All important information about courier (3PL) placed on this param |
courier.rate_id | RateID of courier |
courier.amount | Shipment fee |
courier.user_insurance | Insurance flag of the order |
courier.insurance_amount | Insurance fee |
courier.cod | Cash on delivery flag of the order |
consignee | All important information about consignee placed on this param |
consignee.name | Consignee name (pengirim) |
consignee.phone_number | Consignee phone number |
consigner | All important information about consigner placed on this param |
consigner.name | Consigner name (penerima) |
consigner.phone_number | Consigner phone number |
destination | All important information about destination of the package placed on this param |
destination.address | Package destination address |
destination.area_id | Area ID of package destination |
destination.area_name | Area name of package destination |
destination.city_id | City ID of package destination |
destination.city_name | City name of package destination |
destination.country_id | Country ID of package destination |
destination.country_name | Country name of package destination |
destination.lat | Latitude of package destination |
destination.lng | Longitude of package destination |
destination.postcode | Postcode of package destination |
destination.province_id | Province ID of package destination |
destination.province_name | Province name of package destinationa |
destination.suburb_id | Suburb id of package destination |
destination.suburb_name | Suburb name of package destination |
origin | All important information about origin package placed on this param |
origin.address | Address of package origin |
origin.area_id | Area ID of package origin |
origin.area_name | Area name of package origin |
origin.city_id | City ID of package origin |
origin.city_name | City name of package origin |
origin.country_id | Country ID of package origin |
origin.country_name | Country name of package origin |
origin.lat | Latitude of package origin |
origin.lng | Longitude of package origin |
origin.postcode | Postcode of package origin |
origin.province_id | Province ID of package origin |
origin.province_name | Province name of package origin |
origin.suburb_id | Suburb id of package origin |
origin.suburb_name | Suburb name of package origin |
package | All important information about package placed on this param |
package.package_type | Type of package: 1) document 2) small package 3) medium package |
package.weight | Weight of package (kg) |
package.length | Length of package (cm) |
package.width | Width of package (cm) |
package.height | Height of package (cm) |
package.price | Price of package (IDR) |
package.price.items | Array of package items |
package.price.items.id | Package item ID |
package.price.items.name | Package item name |
package.price.items.qty | Package item quantity |
package.price.items.price | Package Item price |
Updated 21 days ago