01
Introduction
Transporters API
The Transporters API allows you to manage transporters in the Kao-Order settings module.
🔐
Requires a valid Bearer token in the
Authorization header.
02
List Transporters
Get a list of all transporters
GET
/api/kao-order/settings/transporters/index
List transporters
▶
cURL
curl --request GET \ --url 'https://yourapp.com/api/kao-order/settings/transporters/index' \ --header 'Authorization: Bearer YOUR_TOKEN_HERE' \ --header 'Accept: application/json'
03
Create Transporter
Create a new Transporter
POST
/api/kao-order/settings/transporters/store
Create Transporter
▶
Body Parameters (Raw JSON)
| Field | Type | Status | Description |
|---|---|---|---|
| name | string | required | The name of the Transporter |
| string | required | The email of the Transporter | |
| phone | string | required | The phone of the Transporter |
| address | string | required | The address of the Transporter |
04
Get Transporter
Retrieve a specific Transporter details
GET
/api/kao-order/settings/transporters/show{id}
Get Transporter
▶
URL Parameters
| Field | Type | Status | Description |
|---|---|---|---|
| id | integer | required | Transporter ID |
05
Update Transporter
Update Transporter details
PUT
/api/kao-order/settings/transporters/update/{id}
Update Transporter
▶
Body Parameters (Raw JSON)
| Field | Type | Status | Description |
|---|---|---|---|
| name | string | optional | The name of the Transporter |
| string | optional | The email of the Transporter | |
| phone | string | optional | The phone of the Transporter |
| address | string | optional | The address of the Transporter |
06
Delete Transporter
Permanently delete a Transporter
DELETE
/api/kao-order/settings/transporters/delete/{id}
Delete Transporter
▶
URL Parameters
| Field | Type | Status | Description |
|---|---|---|---|
| id | integer | required | Transporter ID |