Create Shipment (Pick Up & Drop Off Collection)

Halaman ini menjelaskan parameter body yang wajib dikirim untuk melakukan pembuatan shipment dan request pickup dengan metode pickup maupun drop-off, termasuk fungsi setiap parameter.

Deskripsi

API ini digunakan untuk membuat shipment order dari berbagai lokasi pickup. Umumnya digunakan oleh marketplace, aggregator, atau partner yang telah melakukan integrasi dengan Lion Parcel.

Penjelasan Parameter Utama :

1. Shipment_type : Menentukan metode pengiriman yang digunakan oleh seller.

• "dropoff" : Seller mengantarkan paket langsung ke gerai/agen Lion Parcel tanpa memanggil kurir. Alur proses:

  • Client membuat shipment.

  • Seller membawa paket ke agen Lion Parcel.

  • Agen memverifikasi paket dan menerbitkan nomor resi (STT).

• "pickup : Paket akan diambil oleh kurir dari lokasi seller. Persyaratan:

  • Wajib mengisi geolocation (lat/lng) pada data pengirim sebagai titik pickup.

  • Setelah shipment berhasil dibuat, client harus memanggil Request Pickup API untuk mengirim kurir ke lokasi tersebut.

2. Asuransi : Menentukan apakah paket menggunakan layanan asuransi.

• Value dari parameter asuransi :

  • true, paket akan diberikan asuransi dan dikenakan biaya asuransi tambahan

    • Biaya asuransi dihitung berdasarkan : nilai barang (price) × persentase asuransi sesuai kesepakatan dengan Lion Parcel.

  • false : paket tidak menggunakan asuransi tambahan.

• Catatan: Pastikan field price diisi dengan benar karena menjadi dasar perhitungan premi.

1. Commodity : Digunakan untuk mengidentifikasi jenis komoditas barang yang dikirim.

• Nilai komoditas harus sesuai daftar komoditas resmi Lion Parcel.

• Setiap komoditas memiliki konfigurasi tarif, perlakuan, dan aturan operasional berbeda (mis.: elektronik, fragile, dokumen, food, dsb.).

• Pengisian komoditas yang tidak sesuai dapat menyebabkan perbedaan tarif atau penolakan shipment.

1. COD : Mengaktifkan layanan Cash on Delivery (COD).

   • Jika paket merupakan paket COD, maka :

     • cod = true

     • cod_value : nilai COD yang akan ditagihkan kepada pembeli.

   • Nilai COD akan diproses sesuai skema kerja sama COD antara Client dan Lion Parcel.

   • Catatan: Jika cod = true namun cod_value tidak diisi, shipment dianggap tidak valid.

Endpoint

POST	https://api-stg-middleware.thelionparcel.com/v2/client/shipment/create
URL	[BASE_URL]/v2/client/shipment/create

Header

Name	Value
Content-Type	application/json
Authorization	Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjIzNTMyOTIyNTQsImlhdCI6MTcyMjU3MjI1NCwidXNlcm5hbWUiOiJib29raW5nYXBpX2NvcnBjZ2siLCJjbGllbnRfY29kZSI6IkNHSy0wMDAxLUMtMjgiLCJjbGllbnRfY29kZV9nZW5lc2lzIjoiQ0dLLTI5MTIifQ.gCw7DSepAyzPjlcjMUCPZqn9B7ai2ChiD8zOvJ33R3gNI7hMXofQviIStTQY5aEuF9Qe_YdYjjEpgeeYRg6qIxalJaMqsUNJNo8pxnuySK5AOBHsdgMgC9_A0A9tt0VTLnYIwKpNlIFBIDZvgb69h5PkM-NPX3XAv_aRqkQRLrkSQo8zzwQt29pG3cIwCAF9Xvt-QuG3TIl_5qtlfWyF4UPOKCawPlgXXAHwgaiGvgGH4fZKVMyAA10a1FxmNNMYzUSiG126Q_w93Kl435BrPdqx1oNIbSpq2SnngodKFKNIZpwQ715RNFMg0Gb1R19BK4Ew39yWSiARftotMVJ6kw
Timezone	+07:00

Request Body

Key	Data Type	Required	Sample Value	Description
shipment_type	STRING	TRUE	PICKUP	DROPOFF or PICKUP
service_code	STRING	TRUE	REGPACK	Layanan pengiriman yang digunakan contoh : JAGOPACK, REGPACK, dll
sender	OBJECT	TRUE	(details, below)	(details, below)
receiver	OBJECT	TRUE	(details, below)	(details, below)
detail	OBJECT	TRUE	(details, below)	(details, below)
items	OBJECT		(details, below)	(details, below)

[Sender / Receiver] Structure

name	STRING	TRUE	Liona	-
phone	STRING	TRUE	081181371273
address	STRING	TRUE	Gasaribu, Laguboti	-
post_code	STRING	TRUE	22381	-
origin	STRING	TRUE	KEBON JERUK, JAKARTA BARAT	-
destination	STRING	TRUE	TANJUNG PRIOK, JAKARTA UTARA
email	STRING	FALSE	[email protected]"	-
geoloc	STRING	FALSE	-6.189520861209956, 106.76485425293782	format: <latitude>,<longitude>

[Detail] Structure

Key	Data Type	Required	Sample Value	Description
use_insurance	BOOLEAN	TRUE	false	true/false
invoice_no	STRING	TRUE	1654-7415-48-1645	-
commodity	STRING	TRUE	ABR036	-
is_cod	BOOLEAN	TRUE	true	-
cod_value	INTEGER	TRUE	50000	if is_cod = true, cod_value = sum off price on items
items	ARRAY OF OBJECT	TRUE	link	-

[item] structure

Key	Data Type	Required	Sample Value	Description
weight	INT64	TRUE	1000	gram
name	STRING	TRUE	Barang testing	nama barang
price	FLOAT64	TRUE	10000	harga barang
height	FLOAT64	TRUE	10	default value 10
width	FLOAT64	TRUE	10	default value 10
length	FLOAT64	TRUE	10	default value 10

Request Example

{
    "shipment_type": "DROPOFF",
    "service_code": "REGPACK",
    "sender": {
        "name": "Liona",
        "phone": "087777112295",
        "address": "Jl. Kedoya Raya No 89, Kebon Jeruk, Jakarta Barat",
        "post_code": "11520",
        "origin": "KEBON JERUK, JAKARTA BARAT",
        "email": "[email protected]",
        "geoloc": "-6.189520861209956, 106.76485425293782"
    },
    "receiver": {
        "name": "Lio lio",
        "phone": "0881082327979",
        "address": "Jl. Palmerah No 5, Kebon Jeruk, Jakarta Barat",
        "post_code": "11520",
        "destination": "KEBON JERUK, JAKARTA BARAT",
        "email": "",
        "geoloc": ""
    },
    "detail": {
        "use_insurance": false,
        "invoice_no": "INVTES2111031",
        "commodity": "ABR036",
        "is_cod": false,
        "is_dfod": false,
        "cod_value": 10000,
        "items": [
            {
                "weight": 1000,
                "name": "Barang Hello, World!",
                "currency": "IDR",
                "price": 10000,
                "height": 30,
                "width": 10,
                "length": 20
            }
        ]
    }
}

Response

200

{
  "success": true,
  "code": 200,
  "message": "Success create shipment",
  "data": {
    "shipment_id": "C1FVNCTU"
  }
}

400