API
API 01 Permintaan Informasi Ketersediaan Layanan
POST
{DOMAIN PLATFORM}/{END POINT REQUEST VESSEL}
Headers
Content-Type
object
application / json
Request Body
token
string
Token Pengaman
id_request
string
Kode Request Booking
portAsalId
number
Kode Pelabuhan Asal
portAsalName
string
Pelabuhan Asal
portTujuanId
number
Kode Pelabuhan Tujuan
portTujuanName
string
Pelabuhan Tujuan
kawasanAsalId
number
Kode Kawasan Asal
kawasanAsalName
string
Nama Kawasan Asal
kawasanTujuanId
number
Kode Kawasan Tujuan
kawasanTujuanName
string
Nama Kawasan Tujuan
npwp
string
NPWP User
RAW DATA EXAMPLE
Referensi PORT dapat dilihat di
https://esbbcext01.beacukai.go.id:8090/Port
NLE mengintegrasikan proses pemesanan Vessel (wilayah domestik) dari beberapa platform. Oleh karena itu, platform diharapkan mengirimkan data penawaran (melalui response dari API Pencarian Vessel milik Platform) yang sesuai dengan kebutuhan NLE. Berikut adalah tabel data standar response API-01 yang diberlakukan di NLE.
API-01 Response
Name
Type
id_request
String
Kode request booking yang didapat dari API-01
order_id
String
Kode penawaran yang diberikan oleh AITI-LOG berdasarkan data kapal dan rute pelayarannya
included_cost
Array
Fasilitas yang diberikan dari biaya yang dikeluarkan
expired_date
Date
Tanggal berakhirnya penawaran
Provision
String/null
Ketentuan barang
foto_pelayaran
String
Foto Kapal
arrived_time
Date
Estimasi waktu tiba
departure_time
Date
Estimasi waktu berangkat
ship_name
String
Nama kapal
service_type
String
Jenis service kapal
Price
Numeric
Harga
closing_time
String
Waktu berakhirnya penawaran
Partner
Object
foto_partner
String
URL foto partner
profil_partner
String
URL profil partner
partner_name
String
Nama partner
Rating
Integer
Rating
Container
Object
container_type
String
Jenis container
ukuran_kontainer
Numeric
Ukuran container
kuota
Numeric
Jumlah kuota tersisa
id_platform
String
Identitas platform di NLE
API-02 Booking Vessel dari NLE
POST
{DOMAIN PLATFORM}/{END POINT REQUEST VESSEL}
Headers
Content-Type
String
application/json
Request Body
token
string
Token
id_request
string
Kode Booking dari API-01
id_platform
string
Kode Platform dari NLE
ship_name
string
Nama Kapal
container_type
string
Jenis Container
Partner
string
Partner ekspedisi platform
service_type
string
Jenis layanan
order_id
string
Kode penawaran yang diberikan oleh PLATFORM
paid_date
number
Tanggal pembayaran Format Datetime
nama_pengirim
string
Nama pengirim
hp_pengirim
string
Nomor Telepon / HP Pengirim
alamat_pengirim
string
Alamat Pengirim
nama_penerima
string
Nama Pengirim
hp_penerima
string
Nomor Telepon / HP Penerima
alamat_penerima
string
Alamat Penerima
qty
number
Jumlah Container
deskripsi_umum_barang
string
Deskripsi barang secara umum
tanggal_stuffing
number
Tanggal bongkar muat Format Date
Npwp
string
NPWP Pengirim
string
Email user (pengirim)
vessel_packing
array
id_container
number
Nomor Container berdasarkan jumlah container yang dipesan (1,2,3, dst). Berfungsi untuk menetukan packing termasuk kedalam container yang mana.
jenis_muatan
string
Jenis Muatan
deskripsi_muatan
string
Deskripsi Muatan
kemasan
string
Kemasan yang digunakan
jumlah_barang
number
Jumlah Barang
berat_muatan
string
Berat Muatan dalam Kg
Raw Data Example
*** “id_offer” yang dijadikan response untuk API-01 silakan ubah menjadi “order_id” dan dikirim dari NLE dalam key “order_id” pula
*** untuk jumlah_kontainer akan dikirimkan melalui key “qty” API NLE
API-03 Update Status Pemesanan oleh Platform
PUT
https://api.beacukai.go.id/V3/NLE/DomesticVesselBooking/status/?id_request=ID_REQUEST
Sample URL
https://api.beacukai.go.id/V3/NLE/DomesticVesselBooking/status/?id_request=06d27a57-bf58-4f37-9f80-81ac2958c904
Sebagai sarana bagi Domestic Vessel Platform untuk mengupdate status pemesanan.
Path Parameters
id_request
string
Kode Request Booking yang didapat dari API-01
Headers
Content-Type
string
application / json
beacukai-api-key
string
token authentifikasi API
Request Body
status
string
Status Booking vessel
Raw Data Example
API-04 Update Status Pembayaran dan Pemesanan oleh Platform
PUT
https://api.beacukai.go.id/V3/NLE/DomesticVesselBooking/paidStatus/?id_request=ID_REQUEST
Sample URL
https://api.beacukai.go.id/V3/NLE/DomesticVesselBooking/paidStatus/?id_request=06d27a57-bf58-4f37-9f80-81ac2958c904
Path Parameters
id_request
string
Kode Request booking yang didapat dari API-01
Headers
Content-Type
string
application/json
beacukai-api-key
string
token authentifikasi API
Request Body
paid_date
number
Waktu pembayaran layanan Format Datetime
status
string
Status layanan vessel
payment_url
string
Link ke halaman pembayaran platform
Raw Data Example
Last updated
Was this helpful?