Classic PMX
Get the daily Classic PMX report data for a restaurant
Endpoint URL
GET
/api/Pmx/getClassicPmx Authentication
This endpoint requires the X-Api-Key header for authentication.
Example: X-Api-Key 12345abcdef
Parameters
| Name | Type | Position | Description |
|---|---|---|---|
storeNumber |
integer (int32) | query | Restaurant number |
countryCode |
string | query | ISO Country code |
businessDay |
string (date) | query | Date with the “yyyy-MM-dd” format |
includeRefundUnits |
boolean | query | Include the refund units in the total units sold value |
usePmxCosts |
boolean | query | Use MasterData price for zero priced items |
Responses
200 — OK
Media type: application/json
json
{
"success": true,
"message": "string",
"warnings": [
{
"title": "string",
"body": "string"
}
],
"items": [
{
"name": "string",
"summary": {
"unitsTotal": 0,
"totalUnitsSold": 0,
"totalUnitsSoldWithDiscounts": 0,
"unitsIn": 0.0,
"unitsOut": 0.0,
"unitsDelivery": 0.0,
"salesShare": 0.0,
"discountIn": 0,
"discountOut": 0,
"discountOther": 0,
"promoUnits": 0,
"promoShare": 0.0,
"wasteUnits": 0,
"wasteShare": 0.0,
"employeeUnits": 0,
"employeeShare": 0.0,
"unitsRefund": 0,
"grpShare": 0.0,
"totShare": 0.0,
"grossSales": 0.0,
"lcGrpShare": 0.0,
"lcTotShare": 0.0,
"salesUnitsPerGuest": 0.0,
"totalUnitsPerGuest": 0.0,
"netSales": 0.0,
"foodCost": 0.0,
"foodCostShare": 0.0,
"unitsGMALCustomerDiscountIn": 0,
"unitsGMALCustomerDiscountOut": 0,
"unitsGMALCustomerDiscountOther": 0,
"unitsRegularPromo": 0,
"unitsRegularPromoIn": 0,
"unitsRegularPromoOut": 0,
"unitsRegularPromoOther": 0,
"unitsGMALPromo": 0,
"unitsGMALPromoIn": 0,
"unitsGMALPromoOut": 0,
"unitsGMALPromoOther": 0,
"unitsManager": 0
},
"items": [
{
"name": "string",
"summary": {
"unitsTotal": 0,
"totalUnitsSold": 0,
"totalUnitsSoldWithDiscounts": 0,
"unitsIn": 0.0,
"unitsOut": 0.0,
"unitsDelivery": 0.0,
"salesShare": 0.0,
"discountIn": 0,
"discountOut": 0,
"discountOther": 0,
"promoUnits": 0,
"promoShare": 0.0,
"wasteUnits": 0,
"wasteShare": 0.0,
"employeeUnits": 0,
"employeeShare": 0.0,
"unitsRefund": 0,
"grpShare": 0.0,
"totShare": 0.0,
"grossSales": 0.0,
"lcGrpShare": 0.0,
"lcTotShare": 0.0,
"salesUnitsPerGuest": 0.0,
"totalUnitsPerGuest": 0.0,
"netSales": 0.0,
"foodCost": 0.0,
"foodCostShare": 0.0,
"unitsGMALCustomerDiscountIn": 0,
"unitsGMALCustomerDiscountOut": 0,
"unitsGMALCustomerDiscountOther": 0,
"unitsRegularPromo": 0,
"unitsRegularPromoIn": 0,
"unitsRegularPromoOut": 0,
"unitsRegularPromoOther": 0,
"unitsGMALPromo": 0,
"unitsGMALPromoIn": 0,
"unitsGMALPromoOut": 0,
"unitsGMALPromoOther": 0,
"unitsManager": 0
},
"items": [
{
"unitsTotal": 0,
"totalUnitsSold": 0,
"totalUnitsSoldWithDiscounts": 0,
"unitsIn": 0.0,
"unitsOut": 0.0,
"unitsDelivery": 0.0,
"salesShare": 0.0,
"discountIn": 0,
"discountOut": 0,
"discountOther": 0,
"promoUnits": 0,
"promoShare": 0.0,
"wasteUnits": 0,
"wasteShare": 0.0,
"employeeUnits": 0,
"employeeShare": 0.0,
"unitsRefund": 0,
"grpShare": 0.0,
"totShare": 0.0,
"grossSales": 0.0,
"lcGrpShare": 0.0,
"lcTotShare": 0.0,
"salesUnitsPerGuest": 0.0,
"totalUnitsPerGuest": 0.0,
"netSales": 0.0,
"foodCost": 0.0,
"foodCostShare": 0.0,
"unitsGMALCustomerDiscountIn": 0,
"unitsGMALCustomerDiscountOut": 0,
"unitsGMALCustomerDiscountOther": 0,
"unitsRegularPromo": 0,
"unitsRegularPromoIn": 0,
"unitsRegularPromoOut": 0,
"unitsRegularPromoOther": 0,
"unitsGMALPromo": 0,
"unitsGMALPromoIn": 0,
"unitsGMALPromoOut": 0,
"unitsGMALPromoOther": 0,
"unitsManager": 0,
"code": 0,
"name": "string",
"priceIn": 0.0,
"priceOut": 0.0,
"priceDelivery": 0.0
}
]
}
]
}
],
"totalSummary": {
"unitsTotal": 0,
"totalUnitsSold": 0,
"totalUnitsSoldWithDiscounts": 0,
"unitsIn": 0.0,
"unitsOut": 0.0,
"unitsDelivery": 0.0,
"salesShare": 0.0,
"discountIn": 0,
"discountOut": 0,
"discountOther": 0,
"promoUnits": 0,
"promoShare": 0.0,
"wasteUnits": 0,
"wasteShare": 0.0,
"employeeUnits": 0,
"employeeShare": 0.0,
"unitsRefund": 0,
"grpShare": 0.0,
"totShare": 0.0,
"grossSales": 0.0,
"lcGrpShare": 0.0,
"lcTotShare": 0.0,
"salesUnitsPerGuest": 0.0,
"totalUnitsPerGuest": 0.0,
"netSales": 0.0,
"foodCost": 0.0,
"foodCostShare": 0.0,
"unitsGMALCustomerDiscountIn": 0,
"unitsGMALCustomerDiscountOut": 0,
"unitsGMALCustomerDiscountOther": 0,
"unitsRegularPromo": 0,
"unitsRegularPromoIn": 0,
"unitsRegularPromoOut": 0,
"unitsRegularPromoOther": 0,
"unitsGMALPromo": 0,
"unitsGMALPromoIn": 0,
"unitsGMALPromoOut": 0,
"unitsGMALPromoOther": 0,
"unitsManager": 0
}
}