⚡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

date_from date	optional	Start date for filtering sales records (format: YYYY-MM-DD).
date_to date	optional	End date for filtering sales records (format: YYYY-MM-DD).
customer string	optional	Filter sales by customer name or customer code.
phone_number string	optional	Filter sales by customer's phone number.
sale_number number	optional	Specific sale number to retrieve.
sale_status string	optional	Filter sales based on the status ( receipt, invoice, quote ).
sale_origin string	optional	Filter sales based on the origin ( business, storefront ).
page number	optional	Specify the page number for pagination (default is 1).

Sample Requests

Node.js

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);
});

PHP

Python

Sample Response

Success

{
    "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": "[phone]",
                "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"
            },
            ...
        ]
    }
}

Error