GET /products/:id — samcart-public-api

Products

Retrieve a product

get/products/{id}

Path parameters

idinteger required

The SamCart ID for the product

Query parameters

created_at_minstring date-time

Filter by created at date/time at or after given value. Accepts ISO 8601/RFC 3339 format with timezone (e.g., 2025-01-16T14:30:00Z) or date-only (e.g., 2025-01-16). Date-only values use 00:00:00 UTC.

created_at_maxstring date-time

Filter by created at date/time at or before given value. Accepts ISO 8601/RFC 3339 format with timezone (e.g., 2025-01-16T14:30:00Z) or date-only (e.g., 2025-01-16). Date-only values use 23:59:59 UTC.

status'live' | 'test' | 'archived'

Filter product by status

product_category'physical' | 'digital'

Filter product by category

Filter product by pricing type

Response

Successful operation

idinteger

The SamCart ID of the product

skustring nullable

An optional product SKU displayed on the marketplace dashboard

internal_product_namestring nullable

An optional product name displayed on the marketplace dashboard

product_namestring

The product name displayed to customers

descriptionstring nullable

The optional description of the product

currencystring

The 3 letter identifier for the currency currently configured on the product. This can be changed.

pricenumber float

The price of the product. For subscription products, it is the initial price (in cents)

product_category'physical' | 'digital'

Indicates the type of product being sold

pricing_type'one_time' | 'limited' | 'recurring' | 'pwyw'

Indicates how the product will be priced

status'live' | 'test' | 'archived'

Indicates the current status of the product

taxesboolean

Indicates if the product is currently configured to have taxes. This can be changed.

upsell_funnelstring nullable

The name of the upsell funnel attached to the product

slugstring

The URL slug for the product

custom_domainstring uri nullable

An optional custom domain used for the product

created_atstring date-time

The UTC date and time the product was created

updated_atstring date-time

The UTC date and time the product was updated

archived_datestring date-time nullable

The UTC date and time the product was archived. If the product has not been archive the value will be null.

Example response

{
  "id": 1337,
  "sku": "sku123",
  "internal_product_name": "internal-book-product",
  "product_name": "Book",
  "description": "This is a good book",
  "currency": "USD",
  "price": 1025,
  "product_category": "physical",
  "pricing_type": "one_time",
  "status": "live",
  "taxes": true,
  "upsell_funnel": "Additional Offer",
  "order_bumps": [
    {
      "product_id": 1234,
      "product_name": "Binder"
    }
  ],
  "bundled_products": [
    {
      "product_id": 3423,
      "product_name": "Magazine"
    }
  ],
  "slug": "book",
  "custom_domain": "https://google.com",
  "product_tags": [
    {
      "name": "digital"
    }
  ],
  "created_at": "2021-01-14 18:03:59",
  "updated_at": "2021-01-14 18:03:59",
  "archived_date": "2021-01-14 18:03:59"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.