Catalog API Documentation

Browse endpoints, parameters, and live request examples.

GET /redemption_active

Check if redemption is active

Determines whether the redemption system is currently active and accepting orders for your account. This can be used by frontend applications to enable/disable checkout functionality.

Order

Parameters

X-Session-ID header (string)

Session identifier

X-User-ID header (string)

User identifier

X-Trace-ID header (string)

Trace identifier for distributed tracing

X-Correlation-ID header (string)

Correlation identifier for request tracking

Responses

200 Redemption status
Example Response
{
  "is_redemption_active": true,
  "success": true,
  "timestamp": "2025-08-02T14:28:41.605Z"
}
Response Schema
Schema Reference:

Status of redemption on the account

Type: object
Required fields:
success timestamp is_redemption_active

Properties:

is_redemption_active required
success required
timestamp required
401 Authentication failed
Example Response
{
  "error_code": "AUTHENTICATION_FAILED",
  "message": "Invalid or expired API token",
  "success": false,
  "timestamp": "2025-01-15T14:30:00Z"
}
Response Schema
Schema Reference:

Standard error response format

Type: object
Required fields:
success message timestamp error_code

Properties:

error_code required
message required
success required
timestamp required