Pickup Request (Express)

Endpoint super kami, gunakan data se valid mungkin untuk menghindari koreksi dari sistem kami

Diclaimer: Terdapat API terpisah untuk layanan Lion Parcel, Pos Indonesia, RPX, dan Paxel. Silahkan hubungi tim teknis kami untuk informasi lebih lanjut.

PHP

KiriminAja::requestPickup(RequestPickupData $data);

Request Section

Field	DataType	Nullable	Desc
`address`	string(max:200)	`false`	Alamat lengkap
`phone`	string(max:15)	`false`	Nomor telepon menggunakan format angka `0`
`name`	string(max:50)	`false`	Nama pengirim paket
`zipcode`	string(max:5)	`true`	Kode pos pengirim
`kecamatan_id`	integer	`false`	Kecamatan id pengirim
`packages`	array(min:1 object)	`false`	Lihat penyusunan list paket berikut
`schedule`	string	`false`	Lihat bagian #Pickup Schedules
`platform_name`	string	`true`	Nama aplikasi anda ketika menerima notifikasi, secara default adalah `mitra`

Packages Section

Field	DataType	Nullable	Desc
`order_id`	string(max:20)	`false`	Order ID, harus memiliki prefix berupa string
`destination_name`	string(max:50)	`false`	Nama penerima
`destination_phone`	string(max:15)	`false`	Nomor telepon diawali dengan angka `0`
`destination_address`	string(max:200,min:10)	`false`	Alamat penerima, kami menggunakan minimal 10 karakter untuk menghindari Bad Address pickup
`destination_kecamatan_id`	int	`false`	Kecamatan penerima
`weight`	int(min:1)	`false`	Berat paket dalam `gram`
`width`	int(min:1)	`false`	`cm`
`length`	int(min:1)	`false`	`cm`
`qty`	int	`true`	Jumlah barang dalam paket, akan terisi 1 jika kosong
`height`	int(min:1)	`false`	`cm`
`item_value`	int	`false`	Nilai barang secara keseluruhan
`shipping_cost`	int	`false`	Biaya pengiriman, see # Shipping Price section
`service`	string	`false`	Lihat shipping price untuk ini
`insurance_amount`	numeric	`true`	Lihat Syarat & Ketentuan
`service_type`	string	`false`	The service type, like `EZ`, `REG`, `CTC`, `OKE`, etc (see shipping price section)
`cod`	int	`false`	COD PRICE NB : Isi 0 untuk paket non COD
`package_type_id`	int	`false`	Tipe paket tersedia untuk sementara `1`
`item_name`	string(max:255)	`false`	Isi paket
`drop`	bool	`true`	DROP-OFF / CASHLESS
`note`	string(max:50)	`true`	Special instructions

Package Insurance & COD NB

Nilai add_cost dan insurance_amount dihitung berdasarkan kesepakatan sebelum proses integrasi API dengan kami.

Untuk mempercepat request pickup, kami hanya melakukan pengecekan ulang biaya pengiriman barang ketika divalidasi oleh driver, bukan melalui API.

COD Fee Calculation

Param	Amount
`item_value`	20000
`shipping_cost`	15000
`insurance_amount`	500
`cod_fee` (from T&A)	Lihat Syarat & Ketentuan
--------	+++++++
`total`	35500
`add_cost`	`total` * `cod_fee` and rounded up to 1 (ex : 1000,27 to 1001)
`cod`	`total` + `cod_fee`

Insurance Amount Calculation

Param	Amount
`item_value`	20000
`percentage` (from T&A)	tergantung ekspedisi (Lihat Syarat & Ketentuan)
--------	*******
`insurance_amount`	`item_value` * `percentage` and rounded up to 100

Request Sample

{
    "address" : "Jl. Jodipati No.29 Perum Taman Kencana Sejahtera",
    "phone" : "0813334546789",
    "kecamatan_id" : 5784,
    "packages" : [
        {
          "order_id": "DEV-000000018",
          "destination_name": "Flag Test",
          "destination_phone": "082223323333",
          "destination_address": "Jl. Magelang KM 11",
          "destination_kecamatan_id": 419,
          "destination_zipcode": 55598,
          "weight": 520,
          "width": 8,
          "height": 8,
          "length": 8,
          "item_value": 275000,
          "shipping_cost": 65000,
          "service": "sicepat",
          "service_type": "SIUNT",
          "item_name": "TEST Item name",
          "package_type_id": 1,
          "cod": 100000
        }

    ],
    "name" : "Tokotries",
    "zipcode" : "55598",
    "schedule" : "2021-11-30 22:00:00"
}

Response

{
    "status": true,
    "text": "Request pickup berhasil",
    "method": "request_pickup",
    "payment_status": "paid",
    "details": [
        {
            "order_id": "DEV-000000018",
            "kj_order_id": "DEV-000000018",
            "awb": null,
            "service": "SICEPAT",
            "service_type": "SIUNT"
        }
    ],
    "pickup_number": "XID-7850941654"
}

Response Explanation

Param	DataType	Remark
`payment_status`	Enum	pending, paid
`details`	Array of Object	Pickup request packages list
`pickup_number`	String	Pickup Number / Payment ID

Edit this page on GitHub

DocsSchedule (Express)

Pickup RequestPickup Request (Instant)