Get Product

curl -X GET "https://api.chariow.com/v1/products/prd_abc123" \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY"

curl -X GET "https://api.chariow.com/v1/products/premium-course" \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY"

const response = await fetch('https://api.chariow.com/v1/products/prd_abc123', {
  headers: {
    'Authorization': 'Bearer sk_live_YOUR_API_KEY'
  }
});
const { data } = await response.json();
console.log(data);

$ch = curl_init('https://api.chariow.com/v1/products/prd_abc123');
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/products/prd_abc123',
    headers={'Authorization': 'Bearer sk_live_YOUR_API_KEY'}
)
data = response.json()

{
  "data": {
    "id": "prd_abc123",
    "name": "Premium Web Development Course",
    "slug": "premium-web-dev-course",
    "description": "<p>A comprehensive course covering advanced web development techniques and best practices.</p>",
    "type": "course",
    "category": {
      "value": "education_and_learning",
      "label": "Education and Learning"
    },
    "status": "published",
    "is_free": false,
    "pictures": {
      "thumbnail": "https://cdn.chariow.com/products/abc123/thumb.jpg",
      "cover": "https://cdn.chariow.com/products/abc123/cover.jpg"
    },
    "pricing": {
      "type": "one_time",
      "current_price": {
        "value": 99,
        "formatted": "$99.00",
        "short": "99",
        "currency": "USD"
      },
      "price": {
        "value": 149,
        "formatted": "$149.00",
        "short": "149",
        "currency": "USD"
      },
      "effective": {
        "value": 99,
        "formatted": "$99.00",
        "short": "99",
        "currency": "USD"
      },
      "sale_price": {
        "value": 99,
        "formatted": "$99.00",
        "short": "99",
        "currency": "USD"
      },
      "minimum_price": {
        "value": 0,
        "formatted": "$0.00",
        "short": "0",
        "currency": "USD"
      },
      "suggested_price": {
        "value": 0,
        "formatted": "$0.00",
        "short": "0",
        "currency": "USD"
      },
      "price_off": "34%",
      "tracking": {
        "currency": "USD",
        "value": 99
      }
    },
    "has_variant_pricing": false,
    "quantity": null,
    "settings": {
      "is_shipping_address_required": false
    },
    "rating": {
      "total_ratings": {
        "value": 245,
        "formatted": "245",
        "short": "245",
        "short_plus": "245+"
      },
      "thumbs_up_count": 236,
      "thumbs_up_percentage": "96%"
    },
    "on_sale_until": "2025-02-28T23:59:59.000000Z",
    "sales_count": {
      "value": 1250,
      "formatted": "1,250",
      "short": "1K",
      "short_plus": "1K+"
    },
    "seo": null,
    "custom_cta_text": {
      "value": null,
      "label": null
    },
    "fields": null,
    "store": null,
    "bundle": null,
    "coaching": null
  }
}

{
  "data": {
    "id": "prd_bundle789",
    "name": "Complete Developer Bundle",
    "slug": "developer-bundle",
    "description": "<p>Everything you need to become a professional developer.</p>",
    "type": "bundle",
    "category": {
      "value": "technology",
      "label": "Technology"
    },
    "status": "published",
    "is_free": false,
    "pictures": {
      "thumbnail": "https://cdn.chariow.com/products/bundle789/thumb.jpg",
      "cover": null
    },
    "pricing": {
      "type": "one_time",
      "current_price": {
        "value": 199,
        "formatted": "$199.00",
        "short": "199",
        "currency": "USD"
      },
      "price": {
        "value": 199,
        "formatted": "$199.00",
        "short": "199",
        "currency": "USD"
      },
      "effective": {
        "value": 199,
        "formatted": "$199.00",
        "short": "199",
        "currency": "USD"
      },
      "sale_price": null,
      "minimum_price": {
        "value": 0,
        "formatted": "$0.00",
        "short": "0",
        "currency": "USD"
      },
      "suggested_price": {
        "value": 0,
        "formatted": "$0.00",
        "short": "0",
        "currency": "USD"
      },
      "price_off": null,
      "tracking": {
        "currency": "USD",
        "value": 199
      }
    },
    "has_variant_pricing": false,
    "quantity": {
      "value": 100,
      "remaining": {
        "value": 35,
        "percent": 35
      },
      "sold": {
        "value": 65,
        "percent": 65
      },
      "total": 100
    },
    "settings": {
      "is_shipping_address_required": false
    },
    "rating": {
      "total_ratings": {
        "value": 89,
        "formatted": "89",
        "short": "89",
        "short_plus": "89+"
      },
      "thumbs_up_count": 87,
      "thumbs_up_percentage": "98%"
    },
    "on_sale_until": null,
    "sales_count": null,
    "seo": null,
    "custom_cta_text": {
      "value": null,
      "label": null
    },
    "fields": null,
    "store": null,
    "bundle": {
      "value": {
        "value": 297,
        "formatted": "$297.00",
        "short": "297",
        "currency": "USD"
      },
      "savings": {
        "amount": {
          "value": 98,
          "formatted": "$98.00",
          "short": "98",
          "currency": "USD"
        },
        "percentage": {
          "value": 33,
          "formatted": "33%"
        }
      }
    },
    "coaching": null
  }
}

{
  "message": "No query results for model [App\\Models\\Product].",
  "errors": []
}

{
  "message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
  "errors": []
}

curl -X GET "https://api.chariow.com/v1/products/prd_abc123" \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY"

curl -X GET "https://api.chariow.com/v1/products/premium-course" \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY"

const response = await fetch('https://api.chariow.com/v1/products/prd_abc123', {
  headers: {
    'Authorization': 'Bearer sk_live_YOUR_API_KEY'
  }
});
const { data } = await response.json();
console.log(data);

$ch = curl_init('https://api.chariow.com/v1/products/prd_abc123');
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/products/prd_abc123',
    headers={'Authorization': 'Bearer sk_live_YOUR_API_KEY'}
)
data = response.json()

{
  "data": {
    "id": "prd_abc123",
    "name": "Premium Web Development Course",
    "slug": "premium-web-dev-course",
    "description": "<p>A comprehensive course covering advanced web development techniques and best practices.</p>",
    "type": "course",
    "category": {
      "value": "education_and_learning",
      "label": "Education and Learning"
    },
    "status": "published",
    "is_free": false,
    "pictures": {
      "thumbnail": "https://cdn.chariow.com/products/abc123/thumb.jpg",
      "cover": "https://cdn.chariow.com/products/abc123/cover.jpg"
    },
    "pricing": {
      "type": "one_time",
      "current_price": {
        "value": 99,
        "formatted": "$99.00",
        "short": "99",
        "currency": "USD"
      },
      "price": {
        "value": 149,
        "formatted": "$149.00",
        "short": "149",
        "currency": "USD"
      },
      "effective": {
        "value": 99,
        "formatted": "$99.00",
        "short": "99",
        "currency": "USD"
      },
      "sale_price": {
        "value": 99,
        "formatted": "$99.00",
        "short": "99",
        "currency": "USD"
      },
      "minimum_price": {
        "value": 0,
        "formatted": "$0.00",
        "short": "0",
        "currency": "USD"
      },
      "suggested_price": {
        "value": 0,
        "formatted": "$0.00",
        "short": "0",
        "currency": "USD"
      },
      "price_off": "34%",
      "tracking": {
        "currency": "USD",
        "value": 99
      }
    },
    "has_variant_pricing": false,
    "quantity": null,
    "settings": {
      "is_shipping_address_required": false
    },
    "rating": {
      "total_ratings": {
        "value": 245,
        "formatted": "245",
        "short": "245",
        "short_plus": "245+"
      },
      "thumbs_up_count": 236,
      "thumbs_up_percentage": "96%"
    },
    "on_sale_until": "2025-02-28T23:59:59.000000Z",
    "sales_count": {
      "value": 1250,
      "formatted": "1,250",
      "short": "1K",
      "short_plus": "1K+"
    },
    "seo": null,
    "custom_cta_text": {
      "value": null,
      "label": null
    },
    "fields": null,
    "store": null,
    "bundle": null,
    "coaching": null
  }
}

{
  "data": {
    "id": "prd_bundle789",
    "name": "Complete Developer Bundle",
    "slug": "developer-bundle",
    "description": "<p>Everything you need to become a professional developer.</p>",
    "type": "bundle",
    "category": {
      "value": "technology",
      "label": "Technology"
    },
    "status": "published",
    "is_free": false,
    "pictures": {
      "thumbnail": "https://cdn.chariow.com/products/bundle789/thumb.jpg",
      "cover": null
    },
    "pricing": {
      "type": "one_time",
      "current_price": {
        "value": 199,
        "formatted": "$199.00",
        "short": "199",
        "currency": "USD"
      },
      "price": {
        "value": 199,
        "formatted": "$199.00",
        "short": "199",
        "currency": "USD"
      },
      "effective": {
        "value": 199,
        "formatted": "$199.00",
        "short": "199",
        "currency": "USD"
      },
      "sale_price": null,
      "minimum_price": {
        "value": 0,
        "formatted": "$0.00",
        "short": "0",
        "currency": "USD"
      },
      "suggested_price": {
        "value": 0,
        "formatted": "$0.00",
        "short": "0",
        "currency": "USD"
      },
      "price_off": null,
      "tracking": {
        "currency": "USD",
        "value": 199
      }
    },
    "has_variant_pricing": false,
    "quantity": {
      "value": 100,
      "remaining": {
        "value": 35,
        "percent": 35
      },
      "sold": {
        "value": 65,
        "percent": 65
      },
      "total": 100
    },
    "settings": {
      "is_shipping_address_required": false
    },
    "rating": {
      "total_ratings": {
        "value": 89,
        "formatted": "89",
        "short": "89",
        "short_plus": "89+"
      },
      "thumbs_up_count": 87,
      "thumbs_up_percentage": "98%"
    },
    "on_sale_until": null,
    "sales_count": null,
    "seo": null,
    "custom_cta_text": {
      "value": null,
      "label": null
    },
    "fields": null,
    "store": null,
    "bundle": {
      "value": {
        "value": 297,
        "formatted": "$297.00",
        "short": "297",
        "currency": "USD"
      },
      "savings": {
        "amount": {
          "value": 98,
          "formatted": "$98.00",
          "short": "98",
          "currency": "USD"
        },
        "percentage": {
          "value": 33,
          "formatted": "33%"
        }
      }
    },
    "coaching": null
  }
}

{
  "message": "No query results for model [App\\Models\\Product].",
  "errors": []
}

{
  "message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
  "errors": []
}

Retrieves comprehensive information about a specific product by its public ID or slug, whatever its status (published, draft or suspended). This endpoint returns detailed pricing information, images, ratings, sales count, stock, and bundle or coaching information (if applicable).

Required scope: products.read. A key without it receives a 403 error. See Authentication.

Path Parameters

string

required

The unique product identifier or slug (e.g., prd_abc123 or premium-course)

Response

object

Show properties

string

Unique product identifier (e.g., prd_abc123)

string

Product name, as plain text

string

URL-friendly product identifier

string | null

Product description as HTML, sanitised by Chariow to strip unsafe markup such as scripts

string

Product type: downloadable, service, course, license, bundle, or coaching

object

Show properties

string

Category value

string

Human-readable category label

string

Publication status: published, draft, or suspended. The API returns products whatever their status.

boolean

Whether the product is free

object

Show properties

string | null

Thumbnail image URL

string | null

Cover image URL

object

Show properties

string

Pricing type: free, one_time, or what_you_want

object

Price a buyer pays now (the sale price while a sale is active)

Show properties

number

Numeric amount

string

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

string

Abbreviated amount (e.g., 99, 5K, 1.25M)

string

ISO 4217 currency code

object

Regular price (same structure as current_price)

object

Effective price (same structure as current_price)

object | null

Sale price while a sale is active, otherwise null (same structure as current_price)

object

Minimum price for pay-what-you-want products (same structure as current_price)

object

Suggested price for pay-what-you-want products (same structure as current_price)

string | null

Sale discount as a percentage string (e.g., 34%), or null when no sale is active

object

Current price converted to USD for ad trackers such as the Meta Pixel, whatever the display currency

Show properties

string

USD, or the product currency when no conversion rate is available

number

Amount rounded to two decimals

boolean

Whether the product has price variants

object | null

Exact stock of a limited-quantity product, or null when the quantity is unlimited

Show properties

integer

Total stock

object

Show properties

integer

Remaining quantity

integer

Remaining share, as a whole number from 0 to 100

object

Show properties

integer

Sold quantity

integer

Sold share, as a whole number from 0 to 100

integer

Total stock (same as value)

object

Show properties

boolean

Whether the buyer must provide a shipping address

object

Buyer ratings (thumbs up or down)

Show properties

object

Number of ratings

Show properties

integer

Exact number

string

Formatted number (e.g., 1,250)

string

Abbreviated number (e.g., 1K)

string

Abbreviated number with a plus sign (e.g., 1K+)

integer

Number of positive ratings

string

Share of positive ratings (e.g., 96%)

string | null

Sale end date (ISO 8601)

object | null

Exact number of successful sales, or null when the product hides its sales count. New products hide it by default; turn it on in the product settings.

Show properties

integer

Exact number

string

Formatted number (e.g., 1,250)

string

Abbreviated number (e.g., 1K)

string

Abbreviated number with a plus sign (e.g., 1K+)

null

Not loaded by the public API: always null

object

Custom call-to-action text

Show properties

string | null

CTA value

string | null

CTA label

null

Not loaded by the public API: always null

null

Not loaded by the public API: always null. Use Get Store instead.

object | null

Bundle value and savings, or null unless the product is a bundle

Show properties

object

Total value of the bundled products bought separately (amount object)

object

Show properties

object

Amount saved (amount object)

object

Share saved, as { "value": 33, "formatted": "33%" }

object | null

Coaching settings, or null unless the product is a coaching product

Show properties

object

Session duration: value in minutes (15, 30, 45, 60, 90 or 120) and a label

object

Where the session takes place: value is video_conference, in_person or custom_link, with a label

string

Time zone of the coach’s availability

object

Break between two sessions: value in minutes (5, 15, 30 or 60) and a label

Error Responses

object

Returned when no product of your store has this public ID or slug

curl -X GET "https://api.chariow.com/v1/products/prd_abc123" \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY"

curl -X GET "https://api.chariow.com/v1/products/premium-course" \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY"

const response = await fetch('https://api.chariow.com/v1/products/prd_abc123', {
  headers: {
    'Authorization': 'Bearer sk_live_YOUR_API_KEY'
  }
});
const { data } = await response.json();
console.log(data);

$ch = curl_init('https://api.chariow.com/v1/products/prd_abc123');
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/products/prd_abc123',
    headers={'Authorization': 'Bearer sk_live_YOUR_API_KEY'}
)
data = response.json()

{
  "data": {
    "id": "prd_abc123",
    "name": "Premium Web Development Course",
    "slug": "premium-web-dev-course",
    "description": "<p>A comprehensive course covering advanced web development techniques and best practices.</p>",
    "type": "course",
    "category": {
      "value": "education_and_learning",
      "label": "Education and Learning"
    },
    "status": "published",
    "is_free": false,
    "pictures": {
      "thumbnail": "https://cdn.chariow.com/products/abc123/thumb.jpg",
      "cover": "https://cdn.chariow.com/products/abc123/cover.jpg"
    },
    "pricing": {
      "type": "one_time",
      "current_price": {
        "value": 99,
        "formatted": "$99.00",
        "short": "99",
        "currency": "USD"
      },
      "price": {
        "value": 149,
        "formatted": "$149.00",
        "short": "149",
        "currency": "USD"
      },
      "effective": {
        "value": 99,
        "formatted": "$99.00",
        "short": "99",
        "currency": "USD"
      },
      "sale_price": {
        "value": 99,
        "formatted": "$99.00",
        "short": "99",
        "currency": "USD"
      },
      "minimum_price": {
        "value": 0,
        "formatted": "$0.00",
        "short": "0",
        "currency": "USD"
      },
      "suggested_price": {
        "value": 0,
        "formatted": "$0.00",
        "short": "0",
        "currency": "USD"
      },
      "price_off": "34%",
      "tracking": {
        "currency": "USD",
        "value": 99
      }
    },
    "has_variant_pricing": false,
    "quantity": null,
    "settings": {
      "is_shipping_address_required": false
    },
    "rating": {
      "total_ratings": {
        "value": 245,
        "formatted": "245",
        "short": "245",
        "short_plus": "245+"
      },
      "thumbs_up_count": 236,
      "thumbs_up_percentage": "96%"
    },
    "on_sale_until": "2025-02-28T23:59:59.000000Z",
    "sales_count": {
      "value": 1250,
      "formatted": "1,250",
      "short": "1K",
      "short_plus": "1K+"
    },
    "seo": null,
    "custom_cta_text": {
      "value": null,
      "label": null
    },
    "fields": null,
    "store": null,
    "bundle": null,
    "coaching": null
  }
}

{
  "data": {
    "id": "prd_bundle789",
    "name": "Complete Developer Bundle",
    "slug": "developer-bundle",
    "description": "<p>Everything you need to become a professional developer.</p>",
    "type": "bundle",
    "category": {
      "value": "technology",
      "label": "Technology"
    },
    "status": "published",
    "is_free": false,
    "pictures": {
      "thumbnail": "https://cdn.chariow.com/products/bundle789/thumb.jpg",
      "cover": null
    },
    "pricing": {
      "type": "one_time",
      "current_price": {
        "value": 199,
        "formatted": "$199.00",
        "short": "199",
        "currency": "USD"
      },
      "price": {
        "value": 199,
        "formatted": "$199.00",
        "short": "199",
        "currency": "USD"
      },
      "effective": {
        "value": 199,
        "formatted": "$199.00",
        "short": "199",
        "currency": "USD"
      },
      "sale_price": null,
      "minimum_price": {
        "value": 0,
        "formatted": "$0.00",
        "short": "0",
        "currency": "USD"
      },
      "suggested_price": {
        "value": 0,
        "formatted": "$0.00",
        "short": "0",
        "currency": "USD"
      },
      "price_off": null,
      "tracking": {
        "currency": "USD",
        "value": 199
      }
    },
    "has_variant_pricing": false,
    "quantity": {
      "value": 100,
      "remaining": {
        "value": 35,
        "percent": 35
      },
      "sold": {
        "value": 65,
        "percent": 65
      },
      "total": 100
    },
    "settings": {
      "is_shipping_address_required": false
    },
    "rating": {
      "total_ratings": {
        "value": 89,
        "formatted": "89",
        "short": "89",
        "short_plus": "89+"
      },
      "thumbs_up_count": 87,
      "thumbs_up_percentage": "98%"
    },
    "on_sale_until": null,
    "sales_count": null,
    "seo": null,
    "custom_cta_text": {
      "value": null,
      "label": null
    },
    "fields": null,
    "store": null,
    "bundle": {
      "value": {
        "value": 297,
        "formatted": "$297.00",
        "short": "297",
        "currency": "USD"
      },
      "savings": {
        "amount": {
          "value": 98,
          "formatted": "$98.00",
          "short": "98",
          "currency": "USD"
        },
        "percentage": {
          "value": 33,
          "formatted": "33%"
        }
      }
    },
    "coaching": null
  }
}

{
  "message": "No query results for model [App\\Models\\Product].",
  "errors": []
}

{
  "message": "Invalid API key. Please check again. Help: https://docs.chariow.com",
  "errors": []
}

Overview

Store

Products

Checkout

Sales

Customers

Licenses

Discounts

Pulses

Affiliates

Path Parameters

Response

Error Responses

​Path Parameters

​Response

​Error Responses

Path Parameters

Response

Error Responses