v1

latestOpenAPI 3.1.02026-07-2418049.3 KB

Sales Report

Retrieve detailed sales data and related store activity. This API allows merchants to integrate their ERP or inventory systems (e.g., SAP, Oracle, etc.) for automated reporting, reconciliation, and operational processing.

get/reports/sales

Query parameters

fromDatestring

Start date of the report (YYYY-MM-DD).

toDatestring

End date of the report (YYYY-MM-DD).

keywordstring

Search term applied to invoice_code, mobile_number, first_name, last_name, or email.

pageinteger

Page number for pagination (default: 1).

perPageinteger

Number of records per page (default: 10).

Headers

Authorizationstring

Response

201

statusboolean

messagestring

Example response

{
  "status": true,
  "message": "Response received successfully",
  "data": {
    "pagination": {
      "current_page": 1,
      "last_page": 1,
      "per_page": 10,
      "from": 1,
      "to": 5,
      "total": 5,
      "path": "http://apiv2api.upayments.com/api/v1/reports/sales",
      "links": [
        {
          "label": "&laquo; Previous"
        }
      ]
    },
    "report": [
      {
        "order_id": "0198f00c2966e30a7c7f33edc6ec4370",
        "track_id": "0198f00c2966e30a7c7f33edc6ec436fv2",
        "transaction_id": "fcb601cd-f9b4-4e19-9ab8-002be06d8a9e",
        "date": "2025-08-28T09:39:45.000000Z",
        "customer": {
          "name": "Prajna Rai ",
          "mobile": "+96566336537",
          "email": "prajna.rai@upayments.com"
        },
        "products": [
          {
            "name": "Logitech K380 / Easy-Switch for Upto 3 Devices, Slim Bluetooth Tablet Keyboar",
            "quantity": 1,
            "price": 10,
            "total": "10.000"
          }
        ],
        "sub_total": "0.010",
        "delivery_charges": "0.000",
        "discount": "0.000",
        "discount_code_amount": "0.000",
        "grand_total": "0.010",
        "currency": "KWD",
        "amount_paid": "0.010",
        "charges": "0.000"
      }
    ]
  }
}