Getting Started
Catalog Update
Order Management
Total Sales
Suppliers Details
Buyers Details
Orders Data by Supplier
1. Get Buyer's Suplliers list
Get sales update sorted by items
Any buyer that belongs to the user will be valid, such as in case of chain searching for suppliers list of a specific branch
Method: Get
URL: api/v1/BuyerApi/Suppliers
URL PARAMS: buyerId={{BuyerId}}
Header Parameters: Authorization – TOKEN BEARER
Sample Response:
200
2. Get Payments Report & items number by supllier
Get buyer’s orders list by supllier
Method: Get
URL: api/v1/BuyerApi/PaymentsReport
URL Params: FromDate={{fromDate}} // iso format – yyyy-MM-ddTHH:mm:ss.zzz
&ToDate={{toDate} // iso format – yyyy-MM-ddTHH:mm:ss.zzz
Header Parameters: Authorization – TOKEN BEARER
Sample Response:
[
{
“Name”: “Supplier’s name”,
“Nickname”: null,
“SupplierId”: 22187,
“Count”: 25,
“TotalWithVAT”: 56916.7200,
“TotalWithoutVAT”: 48652.0000
}
]
Success Response:
200
3. Products Comparison Report
Get most ordered products details
Method: Get
URL: {{base_url}}api/v1/BuyerApi/ProductsComparisonReport
URL Parameters: From={{fromDate}} // iso format – yyyy-MM-ddTHH:mm:ss.zzz &To={{toDate} // iso format – yyyy-MM-ddTHH:mm:ss.zzz }&CurrentOperatorId={{BuyerId}}
Header Parameters: Authorization – TOKEN BEARER
Sample Response:
{ { “branchId”: “השומר 1”, “zNum”: “1”, “itemCode”: “1”, “itemName”: “1”, “itemCount”: 1, “itemTotal”: 1.25, “itemLine”: 1, “itemKind”: “1”, “itemClass”: “1” } ] }
[
{
“ProductId”: 77404,
“ProductName”: “product’s name”,
“ProductData”: [
{
“ProductId”: 77404,
“total”: 0.0000,
“month”: 2,
“year”: 2022
},
{
“ProductId”: 77404,
“total”: 0.0,
“month”: 1,
“year”: 2022
},
{
“ProductId”: 77404,
“total”: 0.0,
“month”: 3,
“year”: 2022
},
{
“ProductId”: 77404,
“total”: 0.0,
“month”: 4,
“year”: 2022
}
],
“LowSuspectValue”: 0.0,
“HighSuspectValue”: 0.0,
“Total”: 0.0000,
“ProductSku”: “112”
}
]
Success Response: 200
4. Order Quantity By Branch
Get the Chain’s list of orders sorted by buyers and suppliers. you can sort them by date or get delta only.
Method: Get
URL: {{base_url}}api/v1/BuyerApi/BranchesPaymentsDetailsReport
URL Parameters:
FromDate={{fromDate}} // iso format – yyyy-MM-ddTHH:mm:ss.zzz // not required is default value if not send
&ToDate={{toDate} // iso format – yyyy-MM-ddTHH:mm:ss.zzz// not required
&ToCreatedDate={{toCreatedDate}} // iso format – yyyy-MM-ddTHH:mm:ss.zzz// not required
&FromCreatedDate={{fromCreatedDate}} // iso format – yyyy-MM-ddTHH:mm:ss.zzz// not required
&SupplierId={{supplierId}} //
&CurrentOperatorId={{BuyerId}}
Header Parameters: Authorization – TOKEN BEARER
Sample Response:
{
“allBranchSale”: [
{
“branchId”: “השומר 1”,
“zNum”: “1”,
“itemCode”: “1”,
“itemName”: “1”,
“itemCount”: 1,
“itemTotal”: 1.25,
“itemLine”: 1,
“itemKind”: “1”,
“itemClass”: “1”
}
]
}
Success Response:
200