catalogapi-com Health API

openapi: 3.2.0
info:
  contact:
    email: support@catalogapi.com
    name: Catalog API Support
    url: https://catalogapi.com
  description: 'Welcome to Catalog API, your gateway to a complete e-commerce experience. This API enables you to browse through extensive product catalogs, search for specific items, and access detailed information about each product including images, pricing, and availability.


    Build and manage shopping carts with ease - add line items with metadata, and prepare orders for checkout. The API handles everything from address validation to stock reservation, ensuring a smooth purchasing experience. Once orders are placed, track their progress through fulfillment and delivery.


    Beyond basic commerce functionality, the API delivers dynamic marketing content tailored to different contexts, whether showcasing featured products, category promotions, or personalized recommendations. With comprehensive multi-language support, real-time stock management, and flexible fulfillment options for both digital and physical products, this API provides all the tools needed for a modern e-commerce platform.'
  title: Catalog Health API
  version: 2.0.0
servers:
- description: Production API - Live environment for production use
  url: https://api.catalogapi.com/api/v2
  variables: {}
- description: Sandbox API - Test environment for development and testing
  url: https://api.catalogapi.com/sandbox/api/v2
  variables: {}
security:
- bearerAuth: []
tags:
- description: Server checks
  name: Health
paths:
  /ping:
    get:
      callbacks: {}
      description: Check if the API server is running and responsive. Can be called with or without authentication.
      operationId: CatalogAPIWeb.Api.Controllers.HealthController.ping
      parameters: []
      responses:
        '200':
          content:
            application/json:
              examples:
                authenticated:
                  description: When authenticated, returns additional customer information
                  summary: Valid Bearer token provided
                  value:
                    authenticated: true
                    customer:
                      id: 550e8400-e29b-41d4-a716-446655440000
                      name: Acme Corporation
                      subdomain: acme
                    status: ok
                    timestamp: '2025-08-01T12:00:00Z'
                    version: 2.0.0
                no_auth:
                  description: The endpoint works without authentication and returns basic health status
                  summary: No Authorization header provided
                  value:
                    authenticated: false
                    customer: null
                    status: ok
                    timestamp: '2025-08-01T12:00:00Z'
                    version: 2.0.0
              schema:
                $ref: '#/components/schemas/PingResponse'
          description: Service is healthy
        '401':
          content:
            application/json:
              examples:
                invalid_token:
                  summary: Invalid or expired Bearer token
                  value:
                    error_code: UNAUTHORIZED
                    message: Invalid Token or Customer
                    success: false
                    timestamp: '2025-08-01T12:00:00Z'
                malformed_auth:
                  summary: Malformed Authorization header
                  value:
                    error_code: UNAUTHORIZED
                    message: Authentication required. Please provide a valid Bearer token.
                    success: false
                    timestamp: '2025-08-01T12:00:00Z'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Invalid authentication token provided
      security: []
      summary: Health check endpoint
      tags:
      - Health
components:
  schemas:
    PingResponse:
      description: Health check response with optional authentication info
      example:
        authenticated: false
        customer: null
        status: ok
        timestamp: '2025-08-01T12:00:00Z'
        version: 2.0.0
      properties:
        authenticated:
          description: Whether the request was authenticated
          example: false
          type: boolean
        customer:
          description: Customer information if authenticated
          nullable: true
          properties:
            id:
              format: uuid
              type: string
            name:
              type: string
            subdomain:
              type: string
          type: object
        status:
          description: Service status
          example: ok
          type: string
        timestamp:
          description: Current server timestamp
          example: '2025-08-01T12:00:00Z'
          format: date-time
          type: string
        version:
          description: API version
          example: 2.0.0
          type: string
      required:
      - status
      - timestamp
      - version
      - authenticated
      title: PingResponse
      type: object
    ErrorResponse:
      description: Standard error response format
      example:
        error_code: ERROR
        message: Search service unavailable
        success: false
        timestamp: '2025-08-02T14:28:41.605Z'
      properties:
        error_code:
          description: Machine-readable error code
          example: ERROR
          type: string
        message:
          description: Human-readable error message
          example: Search service unavailable
          type: string
        success:
          description: Always false for error responses
          example: false
          type: boolean
        timestamp:
          description: When the error occurred
          example: '2025-08-02T14:28:41.605Z'
          format: datetime
          type: string
      required:
      - success
      - message
      - timestamp
      - error_code
      title: ErrorResponse
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: API Key
      scheme: bearer
      type: http