WinCL Store API

Store Controller

OpenAPI Specification

wincl-store-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Wincl Admin Store API
  version: '1.0'
  description: Admin Controller
servers:
- url: https://api.wincl.io:443
  description: Inferred Url
tags:
- name: Store
  description: Store Controller
paths:
  /api/v1/store/metrics:
    get:
      tags:
      - Store
      summary: 스토어 메트릭스
      operationId: getStoreMetricsUsingGET
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WinclResponseData«StoreMetrics»'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - Bearer 토큰 값:
        - global
components:
  schemas:
    StoreMetrics:
      title: StoreMetrics
      type: object
      properties:
        cumulativeOffsetCreditAmount:
          type: number
          description: 총 상쇄된 탄소배출량
          format: bigdecimal
        cumulativePaidCreditAmount:
          type: number
          description: 총 판매된 탄소배출량
          format: bigdecimal
    WinclResponseData«StoreMetrics»:
      title: WinclResponseData«StoreMetrics»
      type: object
      properties:
        code:
          type: string
        data:
          $ref: '#/components/schemas/StoreMetrics'
        message:
          type: string
  securitySchemes:
    Bearer 토큰 값:
      type: http
      scheme: bearer
      bearerFormat: JWT