Getting Started - Keystone Commerce API Docs

API release: 2.1.0
Updated: 2026-10-01 Use the dev API while building and testing your integration.

https://dev-api.keystonecommerce.in/api/v1

Response envelope

Successful responses use a consistent envelope. The envelope statusCode is always 200, whatever the HTTP status. Successful requests return HTTP 200, 201 or 204, and most POST requests return 201 even when they create nothing. Treat any 2xx status as success and read the result from data.

{
  "statusCode": 200,
  "message": "Success",
  "data": {}
}

Paginated responses include meta.

{
  "statusCode": 200,
  "message": "Success",
  "data": [],
  "meta": {
    "total": 58,
    "page": 1,
    "limit": 20,
    "totalPages": 3
  }
}

Health checks

Use liveness to check the API process. Use readiness to check the API and its dependencies.

Method	Endpoint	Auth
`GET`	`/health/live`	None
`GET`	`/health/ready`	None
`GET`	`/health`	None

Request:

curl https://dev-api.keystonecommerce.in/api/v1/health/ready

Response:

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "status": "ok",
    "database": "connected",
    "redis": "connected",
    "uptime": 266.203231052
  }
}

Liveness response:

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "status": "ok",
    "uptime": 266.365487836
  }
}

​Response envelope

​Health checks

Response envelope

Health checks