kiolyn-api-specs/specs/gcgroup.yaml

Update

/gcgroup/{merchantid}:
  get:
    tags:
    - gcgroup
    description: Return all giftcard groups belong to given merchant
    operationId: listGcGroups
    security:
    - bearerAuth: []
    parameters:
    - $ref#merchantid: './parameters/merchantid.yaml'
    responses:
      $ref#4xx: './responses/4xx.yaml'
      200:
        description: list of giftcard groups
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/GcGroup'
  post:
    tags:
    - gcgroup
    description: Update/Create giftcard groups
    operationId: saveGcGroup
    security:
    - bearerAuth: []
    parameters:
    - $ref#merchantid: './parameters/merchantid.yaml'
    requestBody:
      required: true
      content:
        application/json: 
          schema: 
            $ref: '#/components/schemas/GcGroup'
    responses:
      $ref#4xx: './responses/4xx.yaml'
      $ref#upsert: './responses/20x-upsert.yaml'

/gcgroup/{merchantid}/{id}:
  get:
    tags:
    - gcgroup
    description: Return the giftcard group with given id
    operationId: loadGcGroup
    security:
    - bearerAuth: []
    parameters:
    - $ref#merchantid: './parameters/merchantid.yaml'
    - $ref#id: './parameters/objectid.yaml'
    responses:
      $ref#4xx: './responses/4xx.yaml'
      200:
        description: giftcard detail
        content:
          application/json:
            schema:
              type: object
              properties: 
                value:
                  $ref: '#/components/schemas/Giftcard'
  delete:
    tags:
    - gcgroup
    description: Delete a giftcard group with given id
    operationId: deleteGcGroup
    security:
    - bearerAuth: []
    parameters:
    - $ref#merchantid: './parameters/merchantid.yaml'
    - $ref#id: './parameters/objectid.yaml'
    responses:
      $ref#4xx: './responses/4xx.yaml'
      $ref#204: './responses/204.yaml'