Documentation
Home

Create Order International V2

Suggest Edits

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/international

Request Data

ParameterTypeDescription
coverage (required)stringAlways fill "international"
payment_type (required)stringAlways fill "postpay"
courier.cod (required)boolean
(false / true)
default value : false		COD "Flag to determine whether order are Cash on Delivery or not (false/true)"
courier. international_rate_id (required)integerInternational rates ID from get pricing domestic international
courier. domestic_rate_idintegerDomestic rates ID from get international domestic international (pricings.domestic)
courier.use_insurance (required)boolean
(false / true)
default value : false		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)integerThe ID of the country from LocationAPI
destination.address (required)stringDestination address of international package
origin.area_id (required)integerThe area ID of the origin obtained from Location API
origin.suburb_id (required)vintegerThe suburb ID of the origin obtained from Location API
origin.address (required)stringAddress of the Origin (No Symbol Allowed Except # & ' . - = + , ( ) )
consignee.name (required)stringConsignee name
consignee.phone_number (required)stringConsignee phone number
consignee.email (required)stringConsignee email
consigner.name (required)stringConsignee name
consigner.phone_number (required)stringConsigner phone number
consigner.email (required)stringConsigner email
package.weight (required)integerPackage weight in kg
package.height (required)integerPackage height in cm
package.length (required)integerPackage length in cm
package.width (required)integerPackage with in cm
package.package_type (required)integer
Package Type:
1 for document (default)
2 for small package
3 for medium package		Package type category
package.price (required)integerThe total value of the order
(item value x quantity)
package.items.name (required)stringThe name of the item
package.items.price (required)integerThe value of that single item
package.items.qty (required)integerThe quantity of the item
package.international.unit (required)stringBoxes/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)stringGift/Commercial/Personal, Not for Resale/Sample/Return for Repair/Return after Repair
package.international.quantity (required)integerPackage international quantity
package.international.made_in (required)stringPackage made in
package.international.item_type (required)stringPackage item type
package.international.destination_packet (required)stringPackage international destination
package.international.description_item (required)stringPackage item description
package.international.custom_declaration.tax_document (required)stringDocument tax type of package custom declaration
package.international.custom_declaration.document_number (required)stringDocument number of package custom declaration
package.international.custom_declaration.additional_document.documentstringAdditional document of package custom declaration
package.international.custom_declaration.additional_document.document_numberstringNumber of additional document of package custom declaration
package.international.custom_declaration.additional_document.media_urlstringMedia 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

ParameterDescription
metadataMetadata information
metadata.pathAPI endpoint path
metadata.http_status_codeHTTP status code
metadata.http_statusHTTP status
metadata.timestampTimestamp
dataAll important information about order creation placed on this param
data.coverageOrder creation type: domestic/international
data.order_idShipper Order ID. To be use for pickup request
data.payment_typeMerchant payment type: cash/postpay
courierAll important information about courier (3PL) placed on this param
courier.rate_idRateID of courier
courier.amountShipment fee
courier.user_insuranceInsurance flag of the order
courier.insurance_amountInsurance fee
courier.codCash on delivery flag of the order
consigneeAll important information about consignee placed on this param
consignee.nameConsignee name (pengirim)
consignee.phone_numberConsignee phone number
consignerAll important information about consigner placed on this param
consigner.nameConsigner name (penerima)
consigner.phone_numberConsigner phone number
destinationAll important information about destination of the package placed on this param
destination.addressPackage destination address
destination.area_idArea ID of package destination
destination.area_nameArea name of package destination
destination.city_idCity ID of package destination
destination.city_nameCity name of package destination
destination.country_idCountry ID of package destination
destination.country_nameCountry name of package destination
destination.latLatitude of package destination
destination.lngLongitude of package destination
destination.postcodePostcode of package destination
destination.province_idProvince ID of package destination
destination.province_nameProvince name of package destinationa
destination.suburb_idSuburb id of package destination
destination.suburb_nameSuburb name of package destination
originAll important information about origin package placed on this param
origin.addressAddress of package origin
origin.area_idArea ID of package origin
origin.area_nameArea name of package origin
origin.city_idCity ID of package origin
origin.city_nameCity name of package origin
origin.country_idCountry ID of package origin
origin.country_nameCountry name of package origin
origin.latLatitude of package origin
origin.lngLongitude of package origin
origin.postcodePostcode of package origin
origin.province_idProvince ID of package origin
origin.province_nameProvince name of package origin
origin.suburb_idSuburb id of package origin
origin.suburb_nameSuburb name of package origin
packageAll important information about package placed on this param
package.package_typeType of package: 1) document 2) small package 3) medium package
package.weightWeight of package (kg)
package.lengthLength of package (cm)
package.widthWidth of package (cm)
package.heightHeight of package (cm)
package.pricePrice of package (IDR)
package.price.itemsArray of package items
package.price.items.idPackage item ID
package.price.items.namePackage item name
package.price.items.qtyPackage item quantity
package.price.items.pricePackage Item price

Updated 4 months ago