Membuat Label Pengiriman Bulk
Endpoint
POST /v1/bulk_shipping_labels
Memulai pembuatan label untuk hingga 50 order yang digabung menjadi satu PDF. Proses berjalan di background, sehingga response langsung dikembalikan dengan status: pending. Gunakan Mengambil Label Pengiriman Bulk untuk mendapatkan file_url setelah proses selesai.
Label bulk hanya tersedia untuk order live.
Request Body
| Field | Tipe | Wajib | Deskripsi |
|---|---|---|---|
order_ids | array of string | Ya | 1 hingga 50 ID order Biteship |
settings | object | Tidak | Pengaturan label. Pengaturan yang tidak Anda kirim akan menggunakan pengaturan default Anda dari dashboard Biteship. Lihat Pengaturan Label untuk nilai default-nya |
settings.paper_size | string | Tidak | Ukuran kertas: a4, 8x10cm, atau 10x15cm |
settings.template | string | Tidak | Template label: standard |
settings.insurance_shown | boolean | Tidak | Tampilkan informasi asuransi |
settings.insurance_fee_shown | boolean | Tidak | Tampilkan nilai asuransi |
settings.shipping_fee_shown | boolean | Tidak | Tampilkan ongkos kirim |
settings.items_shown | boolean | Tidak | Tampilkan bagian item |
settings.item_description_shown | boolean | Tidak | Tampilkan deskripsi item |
settings.item_sku_shown | boolean | Tidak | Tampilkan SKU item |
settings.origin_phone_shown | boolean | Tidak | Tampilkan nomor telepon pengirim |
settings.origin_address_shown | boolean | Tidak | Tampilkan alamat pengirim |
settings.receiver_phone_shown | boolean | Tidak | Tampilkan nomor telepon penerima |
settings.receiver_address_shown | boolean | Tidak | Tampilkan alamat penerima |
settings.censor_receiver_name | boolean | Tidak | Sensor nama penerima |
Request
curl --request POST \
--url https://api.biteship.com/v1/bulk_shipping_labels \
--header 'authorization: <<YOUR_API_KEY>>' \
--header 'content-type: application/json' \
--data '{
"order_ids": ["<<ORDER_ID_1>>", "<<ORDER_ID_2>>", "<<ORDER_ID_3>>"],
"settings": {
"paper_size": "10x15cm",
"items_shown": true,
"censor_receiver_name": true
}
}'
Response
Mengembalikan HTTP 202. Jika order yang sama dengan pengaturan yang sama sudah memiliki label bulk yang berstatus pending, processing, atau completed, response yang dikembalikan adalah HTTP 200 dengan message Bulk shipping label already exists beserta label bulk tersebut.
| Field | Tipe | Deskripsi |
|---|---|---|
success | boolean | Menunjukkan apakah request berhasil |
code | number | Kode response |
message | string | Pesan response |
bulk_label.id | string | ID label bulk. Gunakan untuk mengambil label bulk |
bulk_label.user_id | string | ID user |
bulk_label.organization_id | string | ID organisasi |
bulk_label.status | string | pending, processing, completed, atau failed |
bulk_label.order_ids | array of string | ID order, tanpa duplikat dan sudah diurutkan. Urutan halaman pada PDF mengikuti urutan ini |
bulk_label.settings | object | Pengaturan label yang digunakan. Field-nya sama dengan settings pada request |
bulk_label.file_url | string or null | URL PDF gabungan. Bernilai null hingga proses selesai |
bulk_label.error_message | string or null | Order yang labelnya gagal dibuat, beserta alasannya |
bulk_label.processed_count | number | Jumlah label yang sudah dibuat sejauh ini |
bulk_label.order_count | number | Jumlah order dalam proses ini |
bulk_label.created_at | string | Timestamp pembuatan |
bulk_label.updated_at | string | Timestamp pembaruan terakhir |
Response
{
"success": true,
"code": 20200000,
"message": "Bulk shipping labels generation initiated successfully",
"bulk_label": {
"id": "69ae6df7b49b9700925c2229",
"user_id": "5f9a1c2e8b3d4a0012345678",
"organization_id": "5f9a1c2e8b3d4a0012345679",
"status": "pending",
"order_ids": ["69946bae0b2c6f002659f21a", "69946bae0b2c6f002659f21b", "69946bae0b2c6f002659f21c"],
"settings": {
"paper_size": "10x15cm",
"template": "standard",
"insurance_shown": true,
"insurance_fee_shown": true,
"shipping_fee_shown": true,
"items_shown": true,
"item_description_shown": true,
"item_sku_shown": true,
"origin_phone_shown": true,
"origin_address_shown": true,
"receiver_phone_shown": true,
"receiver_address_shown": true,
"censor_receiver_name": true
},
"file_url": null,
"error_message": null,
"processed_count": 0,
"order_count": 3,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}
}
Error
| HTTP | Kode | Kondisi |
|---|---|---|
| 400 | 40000000 | Request body tidak valid. details mencantumkan setiap field yang tidak valid beserta alasannya |
| 422 | 42200002 | Paket Anda tidak mencakup Shipping Label API. Lihat Paket & batasan |
ID order yang tidak ditemukan atau bukan milik Anda tidak membuat request gagal. Order tersebut akan dilewati dan dicantumkan di error_message.