⚡Add Sale
This endpoint allows you to add a new sale record.
Last updated
This endpoint allows you to add a new sale record.
Last updated
POST
https://api.keepup.store/v2.0/sales/add
Authorization: Bearer API_KEY
sale_type
is set automatically when amount_received
is more than 0 (zero)
. To learn more checkout the sale cycle.
customer_name
date
optional
Customer's full name. Example: "Kojo Owusu"
phone_number
string
optional
Customer's phone number. Example: "233201234567"
customer_email
string
optional
Customer's email address. Example: "[email protected]"
items
json
required
List of items being sold in JSON format. Example: [{ "item_id": "123", "quantity": 2, "price": 70.00 }]
fulfillment_type
string
optional
Type of fulfillment (e.g., pick_up, delivery)
.
location_name
string
optional
Location name for the sale. Example: "Main Street Store"
location
string
optional
Detailed address for delivery. Example: "123 Main St, Anytown"
lat
string
optional
Latitude for delivery location. Example: 34.0522
lng
string
optional
Longitude for delivery location. Example: -118.2437
fulfillment_cost
string
optional
Cost associated with the fulfillment method. Example: 25.00
discount_type
string
optional
Type of discount (fixed or percentage).
discount_amount
string
optional
Amount of discount given. Example: 10.00
tax_profile
string
optional
Tax profile ID applicable to the sale. Example: "123"
note
string
optional
Any additional notes about the sale.
issue_date
string
optional
Date the sale was issued (format: YYYY-MM-DD HH:mm:ss).
due_date
string
optional
Date by which the sale should be settled (format: YYYY-MM-DD HH:mm:ss).
payment_type
string
optional
Type of payment received. Example: "mobile_money"
amount_received
string
optional
Amount received for the sale.
alert_customer
string
optional
Whether to alert the customer (yes
, no
).
sale_type
string
optional
Type of sale document (quote or invoice).