Create Order Express

The endpoint you can use to request the creation of an order, either for pickup or drop-off, through KiriminAja

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)
Diclaimer: There are separate APIs for Pos Indonesia, RPX, and Paxel services. Please contact our technical team for more information.

Request

Here is the translation of the table to English:

FieldDataTypeNullableDescription
addressstring(min:10,max:200)falseFull address
phonestring(min:9,max:13)falsePhone number using the 08 or 62 digit format is required
namestring(min:1,max:50)falseName of the package sender
zipcodestring(max:5)trueSender's postal code
kecamatan_idintegerfalseSender's district ID
kelurahan_idintegerfalseSender's subdistrict ID (used when you want to use an expedition that supports the sub-district)
latitudenumerictruePickup coordinates, required for Lion and Pos Indonesia services
longitudenumerictruePickup coordinates, required for Lion and Pos Indonesia services
packagesarray(min:1 object)falseSee the following package list structure
schedulestringfalseYour parcel ready estimation time. See Schedule. Fill with any time if your all parcel is drop-off
platform_namestringtrueYour application name when receiving notifications, default is mitra

Packages Object

Here is the translation of the table to English:

FieldDataTypeNullableDescription
order_idstring(max:20)falseOrder ID, must have a string prefix
destination_namestring(max:50)falseRecipient's name
destination_phonestring(min:9,max:13)falsePhone number using the 08 or 62 digit format is required
destination_addressstring(min:10,max:255)falseRecipient's address, minimum 10 characters to avoid Bad Address pickup
destination_kecamatan_idintfalseRecipient's district ID
destination_kelurahan_idintfalseRecipient's subdistrict ID (used when you want to use an expedition that supports the sub-district)
destination_zipcodestring(max:5)trueRecipient's Postal Code
weightint(min:1)falsePackage weight in grams
widthint(min:1)falsecm
lengthint(min:1)falsecm
qtyinttrueNumber of items in the package, defaults to 1 if empty
heightint(min:1)falsecm
item_valueint(min:1000)falseTotal value of the items
shipping_costintfalseShipping cost, see # Shipping Price section
servicestringfalseSee shipping price for this
insurance_amountnumerictrueSee Terms & Conditions
service_typestringfalseThe service type, like EZ, REG, CTC, OKE, etc. (see shipping price section)
codintfalseCOD PRICE NB: Enter 0 for non-COD packages
package_type_idintfalseAvailable package type, currently 7 or can check at this link https://bit.ly/package_type_id
item_namestring(max:255)falsePackage contents
dropbooltrueDROP-OFF / CASHLESS
notestring(max:50)trueSpecial instructions

Example

{
  "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"
}

Response

{
  "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"
}
ParamDataTypeRemark
payment_statusEnumpending, paid
detailsArray of ObjectPickup request packages list
pickup_numberStringPickup Number / Payment ID