β‘List Sales
This endpoint retrieves a list of all sales. You can apply filters to narrow down the results based on date, status, customer, and more.
Endpoint
GET
https://api.keepup.store/v2.0/sales
Headers
Authorization: Bearer API_KEY
Query Parameters
Sample Requests
const axios = require('axios');
const config = {
method: 'get',
url: 'https://api.keepup.store/v2.0/sales',
headers: {
'Authorization': 'Bearer API_KEY' // Replace 'API_KEY' with your actual API key
}
};
axios(config).then(function(response) {
console.log(JSON.stringify(response.data));
}).catch(function(error) {
console.error(error);
});
Sample Response
{
"status": 200,
"message": "Sales found: 51",
"data": {
"meta": {
"total_records": 51,
"amount_paid": "59,092.30",
"balance_due": "87,065.10"
},
"sales": [
{
"sale_id": 46099,
"sale_number": "62",
"customer_name": "Kofi Nti",
"customer_phone_number": "+233201234567",
"customer_email": "[email protected]",
"issued_by": "Jojo",
"total_amount": "500.00",
"amount_paid": "500.00",
"balance_due": "0.00",
"status": "receipt",
"sale_origin": "business",
"viewed": 3,
"feedback": null,
"order_log": null,
"change": "0.00",
"created_at": "2023-06-01 12:06:12",
"updated_at": "2023-06-01 12:10:20"
},
...
]
}
}
Last updated