List Sales - Chariow Developers

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": [
    {
      "id": "sal_abc123xyz",
      "status": "completed",
      "original_amount": {
        "value": 99,
        "formatted": "$99.00",
        "short": "99",
        "currency": "USD"
      },
      "amount": {
        "value": 79.20,
        "formatted": "$79.20",
        "short": "79",
        "currency": "USD"
      },
      "discount_amount": {
        "value": 19.80,
        "formatted": "$19.80",
        "short": "20",
        "currency": "USD"
      },
      "payment": {
        "amount": {
          "value": 79.20,
          "formatted": "$79.20",
          "short": "79",
          "currency": "USD"
        },
        "status": "success",
        "exchange_rate": {
          "value": 1.0,
          "formatted": "$1.00",
          "short": "1",
          "currency": "USD"
        }
      },
      "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": "customer@example.com",
        "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": []
}

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": [
    {
      "id": "sal_abc123xyz",
      "status": "completed",
      "original_amount": {
        "value": 99,
        "formatted": "$99.00",
        "short": "99",
        "currency": "USD"
      },
      "amount": {
        "value": 79.20,
        "formatted": "$79.20",
        "short": "79",
        "currency": "USD"
      },
      "discount_amount": {
        "value": 19.80,
        "formatted": "$19.80",
        "short": "20",
        "currency": "USD"
      },
      "payment": {
        "amount": {
          "value": 79.20,
          "formatted": "$79.20",
          "short": "79",
          "currency": "USD"
        },
        "status": "success",
        "exchange_rate": {
          "value": 1.0,
          "formatted": "$1.00",
          "short": "1",
          "currency": "USD"
        }
      },
      "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": "customer@example.com",
        "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)

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

array

Array of sale objects

Show sale object

string

Unique sale identifier (e.g., sal_abc123xyz)

status

string

Sale status (awaiting_payment, completed, failed, abandoned, settled)

original_amount

object

Original amount before discount

Show amount object

value

integer

Amount value (e.g., 99 for $99.00)

formatted

string

Formatted amount with currency symbol (e.g., $99.00)

short

string

Short formatted amount (e.g., $99)

currency

string

Three-letter ISO currency code (e.g., USD, EUR)

amount

object

Final amount charged after discount

discount_amount

object

Discount amount applied

payment

object

Payment details

Show payment object

amount

object

Amount paid in payment currency

status

string

Payment status (initiated, pending, cancelled, failed, success)

exchange_rate

object

Exchange rate if multi-currency

shipping

object

Shipping address details (if provided)

Show shipping object

address

string

Street address

city

string

City name

state

string

State or province

country

string

Country code

zip

string

Postal/ZIP code

store

object

Store information

product

object

Product information

customer

object

Customer information

discount

object

Applied discount (if any)

rate

object

Customer rating (if provided)

post_purchase

object

Post-purchase access data (files, licences, instructions)

pagination

object

Pagination metadata

Show pagination object

next_cursor

string

Cursor for next page (null if no more pages)

prev_cursor

string

Cursor for previous page (null if first page)

has_more

boolean

Whether more results are available

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": [
    {
      "id": "sal_abc123xyz",
      "status": "completed",
      "original_amount": {
        "value": 99,
        "formatted": "$99.00",
        "short": "99",
        "currency": "USD"
      },
      "amount": {
        "value": 79.20,
        "formatted": "$79.20",
        "short": "79",
        "currency": "USD"
      },
      "discount_amount": {
        "value": 19.80,
        "formatted": "$19.80",
        "short": "20",
        "currency": "USD"
      },
      "payment": {
        "amount": {
          "value": 79.20,
          "formatted": "$79.20",
          "short": "79",
          "currency": "USD"
        },
        "status": "success",
        "exchange_rate": {
          "value": 1.0,
          "formatted": "$1.00",
          "short": "1",
          "currency": "USD"
        }
      },
      "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": "customer@example.com",
        "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": []
}

Initiate Checkout Get Sale

​Query Parameters

​Response

Query Parameters

Response