CHECK N BUY STORE — Developer Portal

A global ecommerce marketplace API for browsing products, categories, and accessing shopping information. All endpoints are public, unauthenticated, and return JSON unless you negotiate markdown.

Base URL

https://checknbuystore.com

API Versioning

The current API version is v1. Every response carries an X-API-Version header. The version is also implied by the path prefix /api. When a breaking change is shipped we will publish a new major version (e.g. /v2) and signal deprecation of the old version with a Deprecation header and a documented sunset timeline of at least 90 days.

Authentication

Public read endpoints require no authentication. Write operations (cart, checkout, account) are out of scope for this public API.

Endpoints

GET/api/products/list
Paginated product listing. Supports category, q (search), page, limit (1-50).
GET/api/products/{slug}
Single product by slug: name, price, description, images, availability, seller.
GET/api/categories
All active categories with product counts.
GET/api/markdown?original={path}
Any page as markdown (home, product, category, policies). Content negotiation via Accept: text/markdown.
GET/api/agent
Machine-readable agent manifest (name, endpoints, whenToUse, policies).
GET/api/openapi
OpenAPI 3.0.3 specification describing all public endpoints.

Example request

curl "https://checknbuystore.com/api/products/list?limit=5" \
  -H "Accept: application/json"

Content negotiation

Send Accept: text/markdown to any site path to receive its content as markdown. The server varies on the Accept header so CDNs cache HTML and markdown variants separately.

Rate limits

Public endpoints return RFC 9205 RateLimit headers plus legacy X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset. On throttling you receive 429 with a Retry-After header.

Error model

Errors use an RFC 9457-style envelope with a machine-readable error.code and a human-readable error.resolution hint:

{
  "error": {
    "code": "PRODUCT_NOT_FOUND",
    "message": "No published product matches the slug \"x\".",
    "resolution": "Verify the product slug at /api/products/list"
  },
  "type": "https://checknbuystore.com/developers#error-product_not_found",
  "title": "No published product matches the slug \"x\".",
  "status": 404,
  "requestId": "…",
  "links": { "docs": "https://checknbuystore.com/developers" }
}

Common codes: RESOURCE_NOT_FOUND (404), INVALID_REQUEST (400), RATE_LIMITED (429), INTERNAL_ERROR (500).

Resources

Status codes

200 OK, 400 INVALID_REQUEST, 404 RESOURCE_NOT_FOUND, 429 RATE_LIMITED (Retry-After), 500 INTERNAL_ERROR.

API Versioning

Endpoints

GET/api/products/list

Paginated product listing. Supports category, q (search), page, limit (1-50).

GET/api/products/{slug}

Single product by slug: name, price, description, images, availability, seller.

GET/api/categories

All active categories with product counts.

GET/api/markdown?original={path}

Any page as markdown (home, product, category, policies). Content negotiation via Accept: text/markdown.

GET/api/agent

Machine-readable agent manifest (name, endpoints, whenToUse, policies).

GET/api/openapi

OpenAPI 3.0.3 specification describing all public endpoints.

Error model

Errors use an RFC 9457-style envelope with a machine-readable error.code and a human-readable error.resolution hint:

{ "error": { "code": "PRODUCT_NOT_FOUND", "message": "No published product matches the slug \"x\".", "resolution": "Verify the product slug at /api/products/list" }, "type": "https://checknbuystore.com/developers#error-product_not_found", "title": "No published product matches the slug \"x\".", "status": 404, "requestId": "…", "links": { "docs": "https://checknbuystore.com/developers" } }

Common codes: RESOURCE_NOT_FOUND (404), INVALID_REQUEST (400), RATE_LIMITED (429), INTERNAL_ERROR (500).