Bab 13 · Developer API

Referensi Endpoint

Contekan satu halaman: seluruh endpoint v1, parameter yang diterima masing-masing, bentuk respons, dan dukungan paginasi.

Semua endpoint hanya menerima GET dan diawali {BASE} = https://app-anda.lensiro.com/api/v1.

Peta endpoint

/api/v1
├── ping                       cek key & koneksi
├── branches                   daftar cabang
├── sales                      transaksi (item + pembayaran menyatu)
│   ├── {id}
│   │   ├── items              item satu transaksi
│   │   ├── payments           pembayaran satu transaksi
│   │   └── facets             pekerjaan faset satu transaksi
│   ├── payments               ledger pembayaran lintas transaksi
│   └── facets                 pekerjaan faset lintas transaksi
├── members                    pelanggan
│   └── {id}
│       ├── sales              riwayat belanja pelanggan
│       └── point-logs         mutasi poin pelanggan
└── warehouse
    ├── items                  katalog barang
    │   └── {id}
    │       └── stocks         stok satu barang di semua cabang
    ├── stocks                 stok per barang per cabang (snapshot)
    └── stock-movements        riwayat barang masuk/keluar

Tabel ringkas

Endpoint	Isi	Paginasi	`updated_since`	`include_deleted`
`GET /ping`	status key	–	–	–
`GET /branches`	semua cabang aktif	–	–	–
`GET /sales`	transaksi penjualan	ya	ya	ya
`GET /sales/{id}`	satu transaksi	–	–	–
`GET /sales/{id}/items`	item transaksi	–	–	–
`GET /sales/{id}/payments`	pembayaran transaksi	–	–	–
`GET /sales/{id}/facets`	faset transaksi	ya	ya	ya
`GET /sales/payments`	ledger pembayaran	ya	ya	ya
`GET /sales/facets`	pekerjaan faset	ya	ya	ya
`GET /members`	pelanggan	ya	ya	ya
`GET /members/{id}`	satu pelanggan	–	–	–
`GET /members/{id}/sales`	belanja pelanggan	ya	ya	ya
`GET /members/{id}/point-logs`	mutasi poin	ya	ya	ya
`GET /warehouse/items`	katalog barang	ya	ya	ya
`GET /warehouse/items/{id}`	satu barang	–	–	–
`GET /warehouse/items/{id}/stocks`	stok barang per cabang	–	–	–
`GET /warehouse/stocks`	snapshot stok	ya	tidak	tidak
`GET /warehouse/stock-movements`	pergerakan stok	ya	tidak	tidak

limit dan cursor berlaku di semua endpoint yang berpaginasi.

Parameter per endpoint

`/sales` dan `/members/{id}/sales`

Parameter	Tipe	Keterangan
`updated_since`	ISO datetime	perubahan sejak waktu ini (inklusif)
`transaction_date_from`	ISO datetime	tanggal order minimal
`transaction_date_to`	ISO datetime	tanggal order maksimal
`branch_id`	int	batasi ke satu cabang
`include_canceled`	bool	default `true`; isi `false` untuk menyembunyikan transaksi batal
`include_deleted`	bool	default `false`
`cursor`, `limit`		paginasi

`/sales/payments`

Parameter	Tipe	Keterangan
`updated_since`	ISO datetime	perubahan sejak waktu ini
`paid_from` / `paid_to`	ISO datetime	filter pada `paid_at`
`branch_id`	int	cabang transaksi induk
`type`	enum	`CASH`, `DEBIT`, `CREDIT`, `QRIS`, `ASSURANCE`, `POINT`, `REFUND`
`include_deleted`	bool	default `false`
`cursor`, `limit`		paginasi

`/sales/facets` dan `/sales/{id}/facets`

Parameter	Tipe	Keterangan
`updated_since`	ISO datetime	perubahan sejak waktu ini
`order_date_from` / `order_date_to`	ISO datetime	filter pada tanggal transaksi induk
`branch_id`	int	cabang transaksi induk
`status`	enum	`WORKING`, `SUCCESS`, `FAILED`
`include_deleted`	bool	default `false`
`cursor`, `limit`		paginasi

`/members`

Parameter	Tipe	Keterangan
`updated_since`	ISO datetime	perubahan sejak waktu ini
`branch_id`	int	cabang tempat pelanggan terdaftar
`include_deleted`	bool	default `false`
`cursor`, `limit`		paginasi

`/members/{id}/point-logs`

Parameter	Tipe	Keterangan
`updated_since`	ISO datetime	perubahan sejak waktu ini
`include_deleted`	bool	default `false`
`cursor`, `limit`		paginasi

`/warehouse/items`

Parameter	Tipe	Keterangan
`updated_since`	ISO datetime	perubahan sejak waktu ini
`category_id`	int	kategori barang
`brand_id`	int	merek barang
`include_deleted`	bool	default `false`
`cursor`, `limit`		paginasi

`/warehouse/stocks`

Parameter	Tipe	Keterangan
`branch_id`	int	satu cabang
`item_id`	int	satu barang
`category_id`	int	kategori barang
`brand_id`	int	merek barang
`cursor`, `limit`		paginasi

`/warehouse/stock-movements`

Parameter	Tipe	Keterangan
`occurred_from` / `occurred_to`	ISO datetime	filter pada `occurred_at`
`branch_id`	int	cabang
`item_id`	int	barang
`type`	enum	lihat halaman API Gudang
`cursor`, `limit`		paginasi

Endpoint umum

`GET /ping`

Memvalidasi key tanpa menyentuh data. Cocok sebagai health check.

{ "ok": true, "key_name": "Integrasi Google Sheets" }

`GET /branches`

Seluruh cabang aktif, urut id. Tidak berpaginasi dan tidak punya parameter.

{
  "data": [
    { "id": 1, "code": "PST", "name": "Cabang Pusat" },
    { "id": 2, "code": "BDG", "name": "Cabang Bandung" }
  ]
}

Objek branch dengan tiga field yang sama muncul tertanam di hampir semua data lain.

Peta endpoint

Tabel ringkas

Parameter per endpoint

/sales dan /members/{id}/sales

/sales/payments

/sales/facets dan /sales/{id}/facets

/members

/members/{id}/point-logs

/warehouse/items

/warehouse/stocks

/warehouse/stock-movements