Skip to main content
GET
https://api.chariow.com/v1
/
sales
curl -X GET "https://api.chariow.com/v1/sales?status=completed&per_page=20&start_date=2025-01-01" \
  -H "Authorization: Bearer sk_live_your_api_key"

{
  "message": "success",
  "data": {
    "data": [
      {
        "id": "sal_abc123xyz",
        "status": "completed",
        "original_amount": {
          "amount": 9900,
          "currency": "USD",
          "formatted": "$99.00"
        },
        "amount": {
          "amount": 7920,
          "currency": "USD",
          "formatted": "$79.20"
        },
        "discount_amount": {
          "amount": 1980,
          "currency": "USD",
          "formatted": "$19.80"
        },
        "payment": {
          "amount": {
            "amount": 7920,
            "currency": "USD",
            "formatted": "$79.20"
          },
          "status": "success",
          "exchange_rate": {
            "amount": 1.0,
            "currency": "USD",
            "formatted": "$1.00"
          }
        },
        "shipping": {
          "address": "123 Main Street",
          "city": "New York",
          "state": "NY",
          "country": "US",
          "zip": "10001"
        },
        "store": {
          "id": "str_xyz789",
          "name": "My Store",
          "slug": "my-store"
        },
        "product": {
          "id": "prd_def456",
          "name": "Premium Course",
          "type": "course"
        },
        "customer": {
          "id": "cus_ghi789",
          "email": "[email protected]",
          "name": "John Doe"
        },
        "discount": {
          "id": "dis_jkl012",
          "code": "SAVE20",
          "type": "percentage"
        },
        "rate": null,
        "post_purchase": {
          "files": [
            {
              "id": "fil_mno345",
              "name": "course-materials.zip",
              "size": 15728640,
              "download_url": "https://cdn.chariow.com/downloads/..."
            }
          ],
          "licences": [],
          "instructions": "Thank you for your purchase!"
        }
      }
    ],
    "pagination": {
      "next_cursor": "eyJpZCI6NTB9",
      "prev_cursor": null,
      "has_more": true
    }
  },
  "errors": []
}
Retrieves a cursor-paginated list of all sales in your store. Sales represent completed, pending, abandoned, failed, or settled transactions. The response includes customer, product, discount, and rating information.

​
Query Parameters

​
per_page
integer
default:"15"
Number of sales to return per page (max 100)
​
cursor
string
Cursor for pagination. Use the next_cursor from the previous response.
​
status
string
Filter by sale status: awaiting_payment, completed, failed, abandoned, or settled
​
customer_id
string
Filter by customer public ID (e.g., cus_abc123xyz)
​
search
string
Search by sale reference or customer email
​
start_date
string
Filter sales from this date onwards (format: Y-m-d, e.g., 2025-01-01)
​
end_date
string
Filter sales until this date (format: Y-m-d, e.g., 2025-01-31)

​
Response

​
data
object
curl -X GET "https://api.chariow.com/v1/sales?status=completed&per_page=20&start_date=2025-01-01" \
  -H "Authorization: Bearer sk_live_your_api_key"

{
  "message": "success",
  "data": {
    "data": [
      {
        "id": "sal_abc123xyz",
        "status": "completed",
        "original_amount": {
          "amount": 9900,
          "currency": "USD",
          "formatted": "$99.00"
        },
        "amount": {
          "amount": 7920,
          "currency": "USD",
          "formatted": "$79.20"
        },
        "discount_amount": {
          "amount": 1980,
          "currency": "USD",
          "formatted": "$19.80"
        },
        "payment": {
          "amount": {
            "amount": 7920,
            "currency": "USD",
            "formatted": "$79.20"
          },
          "status": "success",
          "exchange_rate": {
            "amount": 1.0,
            "currency": "USD",
            "formatted": "$1.00"
          }
        },
        "shipping": {
          "address": "123 Main Street",
          "city": "New York",
          "state": "NY",
          "country": "US",
          "zip": "10001"
        },
        "store": {
          "id": "str_xyz789",
          "name": "My Store",
          "slug": "my-store"
        },
        "product": {
          "id": "prd_def456",
          "name": "Premium Course",
          "type": "course"
        },
        "customer": {
          "id": "cus_ghi789",
          "email": "[email protected]",
          "name": "John Doe"
        },
        "discount": {
          "id": "dis_jkl012",
          "code": "SAVE20",
          "type": "percentage"
        },
        "rate": null,
        "post_purchase": {
          "files": [
            {
              "id": "fil_mno345",
              "name": "course-materials.zip",
              "size": 15728640,
              "download_url": "https://cdn.chariow.com/downloads/..."
            }
          ],
          "licences": [],
          "instructions": "Thank you for your purchase!"
        }
      }
    ],
    "pagination": {
      "next_cursor": "eyJpZCI6NTB9",
      "prev_cursor": null,
      "has_more": true
    }
  },
  "errors": []
}