Export Sales

export sale

This endpoint retrieves the sales of a shop in a period in a json format

GET ledger/export-sales/json?shop=<shop_uuid>&start=<start_date>&end=<end_date>

Authentication

• add in the header

Authorization : Basic <encoded_username_password_string>

kenzup will encode a username and a password which will be securely transmitted/communicated to the partner. eg Authorization : "Basic aGFja2VyOnRyeWluZ3RvZGVjb2Rl"

Request Parameters:

Parameter	Type	Description
shop	string	used for specifying the uuid of the shop
start	string	used for specifying the starting date of the sales in the format YYYY-MM-DD
end	string	used for specifying the ending date of the sales in the format YYYY-MM-DD

Sample Request:

    https://app.kenzup.com/api/v1/ledger/export-sales/json?shop=<shop_uuid>&start=<start_date>&end=<end_date>
    
    "shop_uuid": b5f6e9e3-6848-49cd-bcc0-726cbe99bf68,
    "start_date_": 2023-08-27,
    "end_date": 2023-08-30

Response Parameters:

Parameter	Type	Description
earn_burn	string	the type of sale
amount	string	the amount earned by customer of the sale depending on the sale type
sale_amount	string	the original amount of the sale
payment_type	string	the payment type used eg card, out of app, points
points_pending_approval	boolean	if customer has points from the sale that must be manually assigned to him
shop_commercial_name	string	name of shop
shop_id	string	uuid of the shop
type	string	type of the shop
brand	string	brand of the shop
order_id	string	the order id of the sale
terminal_id	string	the id of the terminale used for the sale
agent_id	string	id of the agent who proceesed the sale
sale_timestamp	string	time the sale was created
mobile_number	string	mobile_number of customer who did the sale

Sample Response:

[{
  "earn_burn": "earn",
  "amount": 0.9,
  "sale_amount": 100.0,
  "payment_type": "out_of_app",
  "points_pending_approval": false,
  "shop_commercial_name": "SOUK SEBT",
  "shop_id": "2157d5d9-103e-4947-a5e1-dd605e5e245b",
  "type": "auto",
  "brand": "Afriquia",
  "order_id": "b06ed2dc-0683-4f6b-b763-e1c3e8ad5c80",
  "terminal_id": "c36051db-dcfa-4eb1-a109-3ecb2575ebf0",
  "agent_id": null,
  "sale_timestamp": "2022-01-18T11:33:52.998214+00:00",
  "mobile_number": "+212620481025"
}]