Get Transaction Modifiers Summary

By calling this API, you can retrieve the summary of the transactions' modifiers in the specified MokaPOS outlet.

POST /integrations/mokapos/outlets/{outlet_id}/v1/reporting/modifiers

Path Parameters

Attribute	Description	Type	Required
outlet_id	ID of a MokaPOS business	String	Required

Sample Request

curl -X POST /integrations/mokapos/outlets/{outlet_id}/v1/reporting/modifiers \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  -d $'
  {
    "query": {
      "range": {
        "transaction_time": {
          "gte": "2020-01-01T00:00:00+07:00",
          "lte": "2020-01-30T23:59:59+07:00"
        }
      }
    }
  }
  '

Sample Response - 200 Success

{
  "success": true,
  "data": {
    "total_refunds": 0,
    "total_quantity": 4,
    "total_net_sales": 8000,
    "total_gross_sales": 8000,
    "total_discounts": 0,
    "modifiers": [
      {
        "id": 362774,
        "name": "Topping",
        "refund": 0,
        "quantity": 4,
        "net_sales": 8000,
        "gross_sales": 8000,
        "discount": 0,
        "options": [
          {
            "id": 2482800,
            "name": "Oreo",
            "refund": 0,
            "quantity": 4,
            "net_sales": 8000,
            "gross_sales": 8000,
            "discount": 0
          }
        ]
      }
    ]
  }
}

note

To perform this operation, you must be authenticated using go_auth_client_credentials(mokapos:reporting:read).