Get Sale

curl -X GET "https://api.chariow.com/v1/sales/sal_abc123xyz" \
  -H "Authorization: Bearer sk_live_your_api_key"

const response = await fetch('https://api.chariow.com/v1/sales/sal_abc123xyz', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key'
  }
});
const { data } = await response.json();
console.log(data); // Sale object

$ch = curl_init('https://api.chariow.com/v1/sales/sal_abc123xyz');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer sk_live_your_api_key'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);

import requests

response = requests.get(
    'https://api.chariow.com/v1/sales/sal_abc123xyz',
    headers={'Authorization': 'Bearer sk_live_your_api_key'}
)

sale = response.json()['data']

{
  "message": "success",
  "data": {
    "id": "sal_abc123xyz",
    "status": "completed",
    "channel": {
      "value": "store",
      "label": "Store",
      "description": "Sale made through the store checkout"
    },
    "amount": {
      "value": 79.20,
      "formatted": "$79.20",
      "short": "79",
      "currency": "USD"
    },
    "original_amount": {
      "value": 99,
      "formatted": "$99.00",
      "short": "99",
      "currency": "USD"
    },
    "discount_amount": {
      "value": 19.80,
      "formatted": "$19.80",
      "short": "20",
      "currency": "USD"
    },
    "settlement": {
      "amount": {
        "value": 75.24,
        "formatted": "$75.24",
        "short": "75",
        "currency": "USD"
      },
      "due_at": "2025-02-01T00:00:00+00:00",
      "done_at": "2025-02-01T10:15:00+00:00",
      "service_fee": {
        "value": 3.96,
        "formatted": "$3.96",
        "short": "4",
        "currency": "USD"
      }
    },
    "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": {
        "value": 79.20,
        "formatted": "$79.20",
        "short": "79",
        "currency": "USD"
      },
      "fee": {
        "value": 2.37,
        "formatted": "$2.37",
        "short": "2",
        "currency": "USD"
      },
      "fee_rate": "3.00%",
      "interchange": {
        "rate": "0.50%",
        "fee": {
          "value": 0.40,
          "formatted": "$0.40",
          "short": "0",
          "currency": "USD"
        }
      },
      "exchange_rate": {
        "value": 1.0,
        "formatted": "$1.00",
        "short": "1",
        "currency": "USD"
      },
      "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": "customer@example.com",
      "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": []
}

{
  "message": "Sale not found",
  "data": [],
  "errors": []
}

curl -X GET "https://api.chariow.com/v1/sales/sal_abc123xyz" \
  -H "Authorization: Bearer sk_live_your_api_key"

const response = await fetch('https://api.chariow.com/v1/sales/sal_abc123xyz', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key'
  }
});
const { data } = await response.json();
console.log(data); // Sale object

$ch = curl_init('https://api.chariow.com/v1/sales/sal_abc123xyz');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer sk_live_your_api_key'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);

import requests

response = requests.get(
    'https://api.chariow.com/v1/sales/sal_abc123xyz',
    headers={'Authorization': 'Bearer sk_live_your_api_key'}
)

sale = response.json()['data']

{
  "message": "success",
  "data": {
    "id": "sal_abc123xyz",
    "status": "completed",
    "channel": {
      "value": "store",
      "label": "Store",
      "description": "Sale made through the store checkout"
    },
    "amount": {
      "value": 79.20,
      "formatted": "$79.20",
      "short": "79",
      "currency": "USD"
    },
    "original_amount": {
      "value": 99,
      "formatted": "$99.00",
      "short": "99",
      "currency": "USD"
    },
    "discount_amount": {
      "value": 19.80,
      "formatted": "$19.80",
      "short": "20",
      "currency": "USD"
    },
    "settlement": {
      "amount": {
        "value": 75.24,
        "formatted": "$75.24",
        "short": "75",
        "currency": "USD"
      },
      "due_at": "2025-02-01T00:00:00+00:00",
      "done_at": "2025-02-01T10:15:00+00:00",
      "service_fee": {
        "value": 3.96,
        "formatted": "$3.96",
        "short": "4",
        "currency": "USD"
      }
    },
    "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": {
        "value": 79.20,
        "formatted": "$79.20",
        "short": "79",
        "currency": "USD"
      },
      "fee": {
        "value": 2.37,
        "formatted": "$2.37",
        "short": "2",
        "currency": "USD"
      },
      "fee_rate": "3.00%",
      "interchange": {
        "rate": "0.50%",
        "fee": {
          "value": 0.40,
          "formatted": "$0.40",
          "short": "0",
          "currency": "USD"
        }
      },
      "exchange_rate": {
        "value": 1.0,
        "formatted": "$1.00",
        "short": "1",
        "currency": "USD"
      },
      "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": "customer@example.com",
      "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": []
}

{
  "message": "Sale not found",
  "data": [],
  "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

string

required

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

Response

object

Show properties

string

Unique sale identifier (e.g., sal_abc123xyz)

string

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

object

Sales channel information

Show channel object

string

Channel value (store, affiliate, discover, widget, api)

string

Human-readable label

string

Channel description

object

Final amount charged

Show amount object

integer

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

string

Formatted amount with currency symbol

string

Short formatted amount

string

Three-letter ISO currency code

object

Original amount before discount

object

Discount amount applied

object

Settlement details

Show settlement object

object

Amount to be settled to merchant

string

ISO 8601 timestamp when settlement is due

string

ISO 8601 timestamp when settlement was completed

object

Platform service fee amount

object

Download statistics

Show download object

integer

Total number of downloads

string

ISO 8601 timestamp of last download

object

Payment details

Show payment object

string

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

string

Payment gateway transaction ID

string

Payment gateway used

object

Payment method details (card, mobile money, etc.)

object

Amount paid in payment currency

object

Payment processing fee

string

Payment fee rate as percentage

object

Interchange markup details

object

Exchange rate if multi-currency

object

Payment failure error details (if failed)

object

Shipping address (if provided)

Show shipping object

string

Street address

string

City name

string

State or province

object

Country details with code and name

string

Postal/ZIP code

object

Purchase context information

Show context object

string

Browser user agent

string

Customer IP address

object

Country detected from IP

string

Device type (desktop, mobile, tablet)

string

Customer locale

object

Custom field values provided during checkout

object

Marketing campaign (if tracked)

object

Customer rating (if provided)

object

Store information

object

Product information

object

Customer information

object

Applied discount (if any)

boolean

Whether sale has been reconciled

string

ISO 8601 timestamp of last reconciliation

string

ISO 8601 timestamp when sale failed

string

ISO 8601 timestamp when sale entered awaiting payment status

string

ISO 8601 timestamp when sale was abandoned

string

ISO 8601 timestamp when sale was completed

string

ISO 8601 timestamp when sale was created

string

ISO 8601 timestamp when sale was last updated

curl -X GET "https://api.chariow.com/v1/sales/sal_abc123xyz" \
  -H "Authorization: Bearer sk_live_your_api_key"

const response = await fetch('https://api.chariow.com/v1/sales/sal_abc123xyz', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key'
  }
});
const { data } = await response.json();
console.log(data); // Sale object

$ch = curl_init('https://api.chariow.com/v1/sales/sal_abc123xyz');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer sk_live_your_api_key'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);

import requests

response = requests.get(
    'https://api.chariow.com/v1/sales/sal_abc123xyz',
    headers={'Authorization': 'Bearer sk_live_your_api_key'}
)

sale = response.json()['data']

{
  "message": "success",
  "data": {
    "id": "sal_abc123xyz",
    "status": "completed",
    "channel": {
      "value": "store",
      "label": "Store",
      "description": "Sale made through the store checkout"
    },
    "amount": {
      "value": 79.20,
      "formatted": "$79.20",
      "short": "79",
      "currency": "USD"
    },
    "original_amount": {
      "value": 99,
      "formatted": "$99.00",
      "short": "99",
      "currency": "USD"
    },
    "discount_amount": {
      "value": 19.80,
      "formatted": "$19.80",
      "short": "20",
      "currency": "USD"
    },
    "settlement": {
      "amount": {
        "value": 75.24,
        "formatted": "$75.24",
        "short": "75",
        "currency": "USD"
      },
      "due_at": "2025-02-01T00:00:00+00:00",
      "done_at": "2025-02-01T10:15:00+00:00",
      "service_fee": {
        "value": 3.96,
        "formatted": "$3.96",
        "short": "4",
        "currency": "USD"
      }
    },
    "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": {
        "value": 79.20,
        "formatted": "$79.20",
        "short": "79",
        "currency": "USD"
      },
      "fee": {
        "value": 2.37,
        "formatted": "$2.37",
        "short": "2",
        "currency": "USD"
      },
      "fee_rate": "3.00%",
      "interchange": {
        "rate": "0.50%",
        "fee": {
          "value": 0.40,
          "formatted": "$0.40",
          "short": "0",
          "currency": "USD"
        }
      },
      "exchange_rate": {
        "value": 1.0,
        "formatted": "$1.00",
        "short": "1",
        "currency": "USD"
      },
      "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": "customer@example.com",
      "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": []
}

{
  "message": "Sale not found",
  "data": [],
  "errors": []
}

List Sales List Customers

Overview

Store

Products

Checkout

Sales

Customers

Licenses

Discounts

Pulses

Affiliates

Path Parameters

Response

​Path Parameters

​Response

Path Parameters

Response