Customers
GET
Authentication: Required
/customers
For a single customer
/customers/<id>
For the currently logged in customer
/customers/profile
Query Params
| Field | Description | Example Value |
|---|---|---|
| name | Product Name for filtering | Shafeek |
| route_id | Route of the customer | 5 |
POST
This API can only be used by admins
Authentication: Required
/customers
JSON Example
Values and types can be inferred from the example
{
"first_name": "First Name",
"last_name": "Last Name",
"email": "customer@email.com",
"latitude": 8.454432434,
"longitude": 9.34545657,
"address": "An Address",
"line1": "Address Line 1",
"line2": "Address Line 2",
"line3": "Address Line 3",
"city": "City",
"state": "State",
"country": "Country",
"areacode": "Area Code/Pin Code"
}
When adding additional addresses
/customers/address
{
"address": "An Address",
"line1": "Address Line 1",
"line2": "Address Line 2",
"line3": "Address Line 3",
"city": "City",
"state": "State",
"country": "Country",
"areacode": "Area Code/Pin Code"
}
PATCH
This API can only be used by admins
Authentication: Required
/customers/<id>
JSON Example
Values and types can be inferred from the example
{
"first_name": "First Name",
"last_name": "Last Name",
"email": "customer@email.com"
}
When updating addresses
/customers/address/<id>
{
"latitude": 8.454432434,
"longitude": 9.34545657,
"address": "An Address",
"line1": "Address Line 1",
"line2": "Address Line 2",
"line3": "Address Line 3",
"city": "City",
"state": "State",
"country": "Country",
"areacode": "Area Code/Pin Code"
}
DELETE
This API can only be used by admins
Authentication: Required
/customers/<id>