Skip to main content
GET
https://api.chariow.com/v1
/
sales
/
{saleId}
curl -X GET "https://api.chariow.com/v1/sales/sal_abc123xyz" \
  -H "Authorization: Bearer sk_live_your_api_key"
{
  "message": "success",
  "data": {
    "id": "sal_abc123xyz",
    "status": "completed",
    "channel": {
      "value": "store",
      "label": "Store",
      "description": "Sale made through the store checkout"
    },
    "amount": {
      "amount": 7920,
      "currency": "USD",
      "formatted": "$79.20"
    },
    "original_amount": {
      "amount": 9900,
      "currency": "USD",
      "formatted": "$99.00"
    },
    "discount_amount": {
      "amount": 1980,
      "currency": "USD",
      "formatted": "$19.80"
    },
    "settlement": {
      "amount": {
        "amount": 7524,
        "currency": "USD",
        "formatted": "$75.24"
      },
      "due_at": "2025-02-01T00:00:00+00:00",
      "done_at": "2025-02-01T10:15:00+00:00",
      "service_fee": {
        "amount": 396,
        "currency": "USD",
        "formatted": "$3.96"
      }
    },
    "download": {
      "total": 3,
      "last_at": "2025-01-20T14:30:00+00:00"
    },
    "payment": {
      "status": "success",
      "transaction_id": "txn_moneroo_xyz789",
      "gateway": "moneroo",
      "method": {
        "id": "card",
        "name": "Credit/Debit Card",
        "type": "card"
      },
      "amount": {
        "amount": 7920,
        "currency": "USD",
        "formatted": "$79.20"
      },
      "fee": {
        "amount": 237,
        "currency": "USD",
        "formatted": "$2.37"
      },
      "fee_rate": "3.00%",
      "interchange": {
        "rate": "0.50%",
        "fee": {
          "amount": 40,
          "currency": "USD",
          "formatted": "$0.40"
        }
      },
      "exchange_rate": {
        "amount": 1.0,
        "currency": "USD",
        "formatted": "$1.00"
      },
      "failure_error": null
    },
    "shipping": {
      "address": "123 Main Street",
      "city": "New York",
      "state": "NY",
      "country": {
        "code": "US",
        "name": "United States"
      },
      "zip": "10001"
    },
    "context": {
      "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
      "ip_address": "203.0.113.42",
      "country": {
        "code": "US",
        "name": "United States"
      },
      "device_type": "desktop",
      "locale": "en_US"
    },
    "custom_fields_values": {
      "company_name": "Acme Corp",
      "vat_number": "GB123456789"
    },
    "campaign": {
      "id": "cmp_def456",
      "name": "Black Friday Campaign",
      "tracking_code": "BF2025"
    },
    "rating": {
      "id": "rat_ghi789",
      "value": 5,
      "comment": "Excellent product!",
      "created_at": "2025-01-18T09:00:00+00:00"
    },
    "store": {
      "id": "str_xyz789",
      "name": "My Digital Store",
      "slug": "my-digital-store"
    },
    "product": {
      "id": "prd_jkl012",
      "name": "Advanced Laravel Course",
      "slug": "advanced-laravel-course",
      "type": "course"
    },
    "customer": {
      "id": "cus_mno345",
      "email": "[email protected]",
      "name": "John Doe",
      "first_name": "John",
      "last_name": "Doe"
    },
    "discount": {
      "id": "dis_pqr678",
      "code": "SAVE20",
      "type": "percentage",
      "value": 20
    },
    "is_reconciled": true,
    "last_reconciled_at": "2025-01-16T08:00:00+00:00",
    "failed_at": null,
    "awaiting_payment_at": "2025-01-15T10:30:00+00:00",
    "abandoned_at": null,
    "completed_at": "2025-01-15T10:32:00+00:00",
    "created_at": "2025-01-15T10:30:00+00:00",
    "updated_at": "2025-01-15T10:32:00+00:00"
  },
  "errors": []
}
Retrieves comprehensive information about a specific sale by its public ID, including customer details, product information, payment details, applied discounts, marketing campaign, shipping information, and customer rating.

Path Parameters

saleId
string
required
The unique sale public identifier (e.g., sal_abc123xyz)

Response

data
object
curl -X GET "https://api.chariow.com/v1/sales/sal_abc123xyz" \
  -H "Authorization: Bearer sk_live_your_api_key"
{
  "message": "success",
  "data": {
    "id": "sal_abc123xyz",
    "status": "completed",
    "channel": {
      "value": "store",
      "label": "Store",
      "description": "Sale made through the store checkout"
    },
    "amount": {
      "amount": 7920,
      "currency": "USD",
      "formatted": "$79.20"
    },
    "original_amount": {
      "amount": 9900,
      "currency": "USD",
      "formatted": "$99.00"
    },
    "discount_amount": {
      "amount": 1980,
      "currency": "USD",
      "formatted": "$19.80"
    },
    "settlement": {
      "amount": {
        "amount": 7524,
        "currency": "USD",
        "formatted": "$75.24"
      },
      "due_at": "2025-02-01T00:00:00+00:00",
      "done_at": "2025-02-01T10:15:00+00:00",
      "service_fee": {
        "amount": 396,
        "currency": "USD",
        "formatted": "$3.96"
      }
    },
    "download": {
      "total": 3,
      "last_at": "2025-01-20T14:30:00+00:00"
    },
    "payment": {
      "status": "success",
      "transaction_id": "txn_moneroo_xyz789",
      "gateway": "moneroo",
      "method": {
        "id": "card",
        "name": "Credit/Debit Card",
        "type": "card"
      },
      "amount": {
        "amount": 7920,
        "currency": "USD",
        "formatted": "$79.20"
      },
      "fee": {
        "amount": 237,
        "currency": "USD",
        "formatted": "$2.37"
      },
      "fee_rate": "3.00%",
      "interchange": {
        "rate": "0.50%",
        "fee": {
          "amount": 40,
          "currency": "USD",
          "formatted": "$0.40"
        }
      },
      "exchange_rate": {
        "amount": 1.0,
        "currency": "USD",
        "formatted": "$1.00"
      },
      "failure_error": null
    },
    "shipping": {
      "address": "123 Main Street",
      "city": "New York",
      "state": "NY",
      "country": {
        "code": "US",
        "name": "United States"
      },
      "zip": "10001"
    },
    "context": {
      "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
      "ip_address": "203.0.113.42",
      "country": {
        "code": "US",
        "name": "United States"
      },
      "device_type": "desktop",
      "locale": "en_US"
    },
    "custom_fields_values": {
      "company_name": "Acme Corp",
      "vat_number": "GB123456789"
    },
    "campaign": {
      "id": "cmp_def456",
      "name": "Black Friday Campaign",
      "tracking_code": "BF2025"
    },
    "rating": {
      "id": "rat_ghi789",
      "value": 5,
      "comment": "Excellent product!",
      "created_at": "2025-01-18T09:00:00+00:00"
    },
    "store": {
      "id": "str_xyz789",
      "name": "My Digital Store",
      "slug": "my-digital-store"
    },
    "product": {
      "id": "prd_jkl012",
      "name": "Advanced Laravel Course",
      "slug": "advanced-laravel-course",
      "type": "course"
    },
    "customer": {
      "id": "cus_mno345",
      "email": "[email protected]",
      "name": "John Doe",
      "first_name": "John",
      "last_name": "Doe"
    },
    "discount": {
      "id": "dis_pqr678",
      "code": "SAVE20",
      "type": "percentage",
      "value": 20
    },
    "is_reconciled": true,
    "last_reconciled_at": "2025-01-16T08:00:00+00:00",
    "failed_at": null,
    "awaiting_payment_at": "2025-01-15T10:30:00+00:00",
    "abandoned_at": null,
    "completed_at": "2025-01-15T10:32:00+00:00",
    "created_at": "2025-01-15T10:30:00+00:00",
    "updated_at": "2025-01-15T10:32:00+00:00"
  },
  "errors": []
}