The endpoint you can use to request the creation of an order, either for pickup or drop-off, through KiriminAja.
[POST] /api/mitra/v6.1/request_pickup
sequenceDiagram
participant Client
participant KiriminAja
participant PG
participant 3PL
Client ->> KiriminAja: Request AWB (Both COD & Non-COD)
KiriminAja -->> PG: Create Non-COD Payment (If Necessary)
PG -->> KiriminAja: Confirm Payment (If any of Non-COD)
KiriminAja -->> KiriminAja: Schedule Push AWB
KiriminAja ->> 3PL: Create AWB (Pickup & Drop-Off)
3PL ->> KiriminAja: Confirm AWB Created
KiriminAja --) Client: AWB Confirmed (Webhooks)
Here is the translation of the table to English:
| Field | DataType | Nullable | Description |
|---|---|---|---|
address | string(min:10,max:200) | false | Full address |
phone | string(min:9,max:13) | false | Phone number using the 08 or 62 digit format is required |
name | string(min:1,max:50) | false | Name of the package sender |
zipcode | string(max:5) | true | Sender's postal code |
kecamatan_id | integer | false | Sender's district ID |
kelurahan_id | integer | false | Sender's subdistrict ID (used when you want to use an expedition that supports the sub-district) |
latitude | numeric | true | Pickup coordinates, required for Lion and Pos Indonesia services |
longitude | numeric | true | Pickup coordinates, required for Lion and Pos Indonesia services |
packages | array(min:1 object) | false | See the following package list structure |
schedule | string | false | Your parcel ready estimation time. See Schedule. Fill with any time if your all parcel is drop-off |
platform_name | string | true | Your application name when receiving notifications, default is mitra |
Here is the translation of the table to English:
| Field | DataType | Nullable | Description |
|---|---|---|---|
order_id | string(max:20) | false | Order ID, must have a string prefix |
destination_name | string(max:50) | false | Recipient's name |
destination_phone | string(min:9,max:13) | false | Phone number using the 08 or 62 digit format is required |
destination_address | string(min:10,max:255) | false | Recipient's address, minimum 10 characters to avoid Bad Address pickup |
destination_kecamatan_id | int | false | Recipient's district ID |
destination_kelurahan_id | int | false | Recipient's subdistrict ID (used when you want to use an expedition that supports the sub-district) |
destination_zipcode | string(max:5) | true | Recipient's Postal Code |
weight | int(min:1) | false | Package weight in grams |
width | int(min:1) | false | cm |
length | int(min:1) | false | cm |
qty | int | true | Number of items in the package, defaults to 1 if empty |
height | int(min:1) | false | cm |
item_value | int(min:1000) | false | Total value of the items |
shipping_cost | int | false | Shipping cost, see # Shipping Price section |
service | string | false | See shipping price for this |
insurance_amount | numeric | true | See Terms & Conditions |
service_type | string | false | The service type, like EZ, REG, CTC, OKE, etc. (see shipping price section) |
cod | int | false | COD PRICE NB: Enter 0 for non-COD packages |
package_type_id | int | false | Available package type, currently 7 or can check at this link https://bit.ly/package_type_id |
item_name | string(max:255) | false | Package contents |
drop | bool | true | DROP-OFF / CASHLESS |
note | string(max:50) | true | Special instructions |
{
"address": "Jl. Jodipati No.29 Perum Taman Kencana Sejahtera",
"phone": "0813334546789",
"kecamatan_id": 548,
"kelurahan_id": 31487,
"packages": [
{
"order_id": "YGL-000000019",
"destination_name": "Flag Test",
"destination_phone": "082223323333",
"destination_address": "Jl. Magelang KM 11",
"destination_kecamatan_id": 548,
"destination_kelurahan_id": 31483,
"destination_zipcode": 55598,
"weight": 520,
"width": 8,
"height": 8,
"length": 8,
"item_value": 275000,
"shipping_cost": 65000,
"service": "posindonesia",
"service_type": "901979",
"item_name": "TEST Item name",
"package_type_id": 7,
"cod": 100000
}
],
"name": "Tokotries",
"zipcode": "55598",
"schedule": "2021-11-30 22:00:00"
}
{
"status": true,
"text": "Request pickup berhasil",
"method": "request_pickup",
"qr_url": "QR URL Of Payment",
"payment_status": "unpaid",
"details": [
{
"order_id": "OKAadasdad2awwda",
"kj_order_id": "OKAadasdad2awwda",
"awb": null,
"service": "JNE",
"service_type": "REG23"
}
],
"pickup_number": "EPR-123456789"
}
| Param | DataType | Remark |
|---|---|---|
payment_status | Enum | pending, paid |
details | Array of Object | Pickup request packages list |
pickup_number | String | Pickup Number / Payment ID |
Get Pricing Instant
API pricing for instant delivery services is flexible and scalable, with a tiered structure based on the volume of requests or deliveries
Insurance, COD, Item Price
The values for add_cost and insurance_amount are calculated according to the agreements established before the API integration process with us