Kibo Commerce Coupon Sets API

openapi: 3.2.0
info:
  title: Kibo Commerce Coupon Sets API
  version: '1.0'
  description: 'Operations tagged CouponSets across 2 of this provider''s published API definitions: openapi_openapi_catalog_admin.json, kibo-commerce-catalog-admin-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: Kibo Base URL
  url: '{baseUrl}/api'
  variables:
    baseUrl:
      default: https://t1000000.sb.usc1.gcp.kibocommerce.com
      description: Base URL
security:
- bearerAuth: []
tags:
- name: CouponSets
paths:
  /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/remove:
    post:
      description: Deletes coupons from a coupon set.
      parameters:
      - in: path
        name: couponSetCode
        required: true
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              items:
                type: string
              type: array
      responses:
        '200':
          description: OK
      summary: Delete Coupons
      tags:
      - CouponSets
      operationId: postCommerceCatalogAdminCouponsetsByCouponSetCodeCouponcodesRemove
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
  /commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts:
    get:
      description: Retrieves the discountIds of any assigned discounts for the specified coupon set.
      parameters:
      - in: path
        name: couponSetCode
        required: true
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AssignedDiscount'
                type: array
            text/json:
              schema:
                items:
                  $ref: '#/components/schemas/AssignedDiscount'
                type: array
            text/plain:
              schema:
                items:
                  $ref: '#/components/schemas/AssignedDiscount'
                type: array
          description: OK
      summary: Get Assigned Discounts
      tags:
      - CouponSets
      operationId: getCommerceCatalogAdminCouponsetsByCouponSetCodeAssigneddiscounts
      x-operation-id-source: derived
    post:
      description: Assigns or associates an existing discount to a specified coupon set. Use the couponSetCode parameter to specify the coupon set.
      parameters:
      - in: path
        name: couponSetCode
        required: true
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssignedDiscount'
      responses:
        '200':
          description: OK
      summary: Assign Discount to Coupon Set
      tags:
      - CouponSets
      operationId: postCommerceCatalogAdminCouponsetsByCouponSetCodeAssigneddiscounts
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
  /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode}:
    delete:
      description: Deletes a single coupon by its coupon code.
      parameters:
      - in: path
        name: couponSetCode
        required: true
        schema:
          type: string
      - in: path
        name: couponCode
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      summary: Delete Coupon
      tags:
      - CouponSets
      operationId: deleteCommerceCatalogAdminCouponsetsByCouponSetCodeCouponcodesByCouponCode
      x-operation-id-source: derived
    get:
      description: Retrieves a single coupon by its coupon code.
      parameters:
      - in: path
        name: couponSetCode
        required: true
        schema:
          type: string
      - in: path
        name: couponCode
        required: true
        schema:
          type: string
      - in: query
        name: includeCounts
        schema:
          default: false
          type: boolean
      - in: query
        name: responseGroups
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Coupon'
            text/json:
              schema:
                $ref: '#/components/schemas/Coupon'
            text/plain:
              schema:
                $ref: '#/components/schemas/Coupon'
          description: OK
      summary: Get Coupon
      tags:
      - CouponSets
      operationId: getCommerceCatalogAdminCouponsetsByCouponSetCodeCouponcodesByCouponCode
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
  /commerce/catalog/admin/couponsets/{couponSetCode}:
    delete:
      description: Deletes a CouponSet.
      parameters:
      - in: path
        name: couponSetCode
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      summary: Delete Coupon Set
      tags:
      - CouponSets
      operationId: deleteCommerceCatalogAdminCouponsetsByCouponSetCode
      x-operation-id-source: derived
    get:
      description: Returns a single CouponSet
      parameters:
      - description: CouponSetCode for the requested CouponSet
        in: path
        name: couponSetCode
        required: true
        schema:
          type: string
      - description: Include the redemption counts and coupon counts
        in: query
        name: includeCounts
        schema:
          default: false
          type: boolean
      - description: '"counts" includes the number of redemptions, coupon codes, and assigned discounts.'
        in: query
        name: responseGroups
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CouponSet'
            text/json:
              schema:
                $ref: '#/components/schemas/CouponSet'
            text/plain:
              schema:
                $ref: '#/components/schemas/CouponSet'
          description: OK
      summary: Get Coupon Set
      tags:
      - CouponSets
      operationId: getCommerceCatalogAdminCouponsetsByCouponSetCode
      x-operation-id-source: derived
    put:
      description: Update a CouponSet. You can not update the Code or ID once the set is created.
      parameters:
      - description: ''
        in: path
        name: couponSetCode
        required: true
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CouponSet'
        description: ''
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CouponSet'
            text/json:
              schema:
                $ref: '#/components/schemas/CouponSet'
            text/plain:
              schema:
                $ref: '#/components/schemas/CouponSet'
          description: OK
      summary: Update Coupon Set
      tags:
      - CouponSets
      operationId: putCommerceCatalogAdminCouponsetsByCouponSetCode
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
  /commerce/catalog/admin/couponsets:
    get:
      description: Returns a paged collection of CouponSets
      parameters:
      - description: ''
        in: query
        name: startIndex
        schema:
          default: 0
          format: int32
          type: integer
      - description: ''
        in: query
        name: pageSize
        schema:
          default: 0
          format: int32
          type: integer
      - description: ''
        in: query
        name: sortBy
        schema:
          type: string
      - description: ''
        in: query
        name: filter
        schema:
          type: string
      - description: Include coupon and redemption counts
        in: query
        name: includeCounts
        schema:
          default: false
          type: boolean
      - description: '"counts" returns discount and couponCode counts'
        in: query
        name: responseGroups
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CouponSetCollection'
            text/json:
              schema:
                $ref: '#/components/schemas/CouponSetCollection'
            text/plain:
              schema:
                $ref: '#/components/schemas/CouponSetCollection'
          description: OK
      summary: Get Coupon Sets
      tags:
      - CouponSets
      operationId: getCommerceCatalogAdminCouponsets
      x-operation-id-source: derived
    post:
      description: Adds a single CouponSet
      parameters:
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CouponSet'
        description: ''
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CouponSet'
            text/json:
              schema:
                $ref: '#/components/schemas/CouponSet'
            text/plain:
              schema:
                $ref: '#/components/schemas/CouponSet'
          description: OK
      summary: Add Coupon Set
      tags:
      - CouponSets
      operationId: postCommerceCatalogAdminCouponsets
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
  /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes:
    get:
      description: Returns a paged collection of Coupons.
      parameters:
      - description: ''
        in: path
        name: couponSetCode
        required: true
        schema:
          type: string
      - description: ''
        in: query
        name: startIndex
        schema:
          default: 0
          format: int32
          type: integer
      - description: ''
        in: query
        name: pageSize
        schema:
          default: 0
          format: int32
          type: integer
      - description: ''
        in: query
        name: sortBy
        schema:
          type: string
      - description: ''
        in: query
        name: filter
        schema:
          type: string
      - description: Includes coupon redemption counts
        in: query
        name: includeCounts
        schema:
          default: false
          type: boolean
      - description: counts
        in: query
        name: responseGroups
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CouponCollection'
            text/json:
              schema:
                $ref: '#/components/schemas/CouponCollection'
            text/plain:
              schema:
                $ref: '#/components/schemas/CouponCollection'
          description: OK
      summary: Get Coupons
      tags:
      - CouponSets
      operationId: getCommerceCatalogAdminCouponsetsByCouponSetCodeCouponcodes
      x-operation-id-source: derived
    post:
      description: Adds coupon codes to a coupon set.
      parameters:
      - in: path
        name: couponSetCode
        required: true
        schema:
          type: string
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/Coupon'
              type: array
      responses:
        '200':
          description: OK
      summary: Add Coupons
      tags:
      - CouponSets
      operationId: postCommerceCatalogAdminCouponsetsByCouponSetCodeCouponcodes
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
  /commerce/catalog/admin/couponsets/unique-code:
    get:
      description: Returns a random 4 character code that is unique as a coupon set code.
      parameters:
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
            text/plain:
              schema:
                type: string
          description: OK
      summary: Get Unique Coupon Set Code
      tags:
      - CouponSets
      operationId: getCommerceCatalogAdminCouponsetsUniqueCode
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
  /commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts/{discountId}:
    delete:
      description: Unassigns or disassociates the specified discount with the specified coupon set.
      parameters:
      - in: path
        name: couponSetCode
        required: true
        schema:
          type: string
      - in: path
        name: discountId
        required: true
        schema:
          format: int32
          type: integer
      responses:
        '200':
          description: OK
      summary: Unassign Discount from Coupon Set
      tags:
      - CouponSets
      operationId: deleteCommerceCatalogAdminCouponsetsByCouponSetCodeAssigneddiscountsByDiscountId
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
  /commerce/catalog/admin/couponsets/validate-unique-code:
    post:
      description: Tests a coupone set code for uniqueness and validity.
      parameters:
      - description: limits which fields are returned in the response body
        in: query
        name: responseFields
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
        description: ''
      responses:
        '200':
          description: OK
      summary: Validate Unique Coupon Set Code
      tags:
      - CouponSets
      operationId: postCommerceCatalogAdminCouponsetsValidateUniqueCode
      x-operation-id-source: derived
    servers:
    - description: Kibo Base URL
      url: '{baseUrl}/api'
      variables:
        baseUrl:
          default: https://t1000000.sb.usc1.gcp.kibocommerce.com
          description: Base URL
components:
  schemas:
    CouponSetCollection:
      description: Paged collection of Mozu.ProductAdmin.Contracts.CouponSet
      properties:
        items:
          items:
            $ref: '#/components/schemas/CouponSet'
          type:
          - array
          - 'null'
        pageCount:
          format: int32
          type: integer
        pageSize:
          format: int32
          type: integer
        startIndex:
          format: int32
          type: integer
        totalCount:
          format: int32
          type: integer
      type: object
    Coupon:
      description: Coupon in a coupon set.
      properties:
        auditInfo:
          $ref: '#/components/schemas/AuditInfo'
        canBeDeleted:
          type: boolean
        couponCode:
          description: The code the customer uses to claim this coupon
          minLength: 1
          type: string
        couponSetCode:
          description: Link to associated coupon
          type:
          - string
          - 'null'
        couponSetId:
          description: ReadOnly system id for releated couponset.
          format: int32
          type: integer
        redemptionCount:
          description: 'Total number of times this code has been redeemed. ReadOnly, calculated.

            Only returned with response group includeCounts'
          format: int32
          type:
          - integer
          - 'null'
      required:
      - couponCode
      type: object
    AuditInfo:
      properties:
        createBy:
          type:
          - string
          - 'null'
        createDate:
          format: date-time
          type:
          - string
          - 'null'
        updateBy:
          type:
          - string
          - 'null'
        updateDate:
          format: date-time
          type:
          - string
          - 'null'
      type: object
    CouponSet:
      description: Represents a claimable item that allows a user to use one or more discounts.
      properties:
        assignedDiscountCount:
          description: 'ReadOnly sum of all redemptions for this coupon.

            Use "counts" response group.'
          format: int32
          type:
          - integer
          - 'null'
        auditInfo:
          $ref: '#/components/schemas/AuditInfo'
        canBeDeleted:
          description: 'Signifies that the coupon has not been exported and can be updated

            ReadOnly'
          type: boolean
        couponCodeCount:
          description: 'Count of associated couponCodes.

            Must use "counts" response group to get this value

            ReadOnly'
          format: int32
          type:
          - integer
          - 'null'
        couponCodeType:
          description: 'Determines if the coupon is a persisted list of codes (static) or a list based on generated specification

            (dynamic).'
          type:
          - string
          - 'null'
        couponSetCode:
          description: 'Unique tenant supplied identifier.

            Used as the prefix for generated sets.

            Required

            System generated if left null.'
          maxLength: 32
          type:
          - string
          - 'null'
        endDate:
          description: Date and time that the coupon codes becomes expired
          format: date-time
          type:
          - string
          - 'null'
        id:
          description: Internal unique identifier of the couponset. System-supplied and read-only.
          format: int32
          type:
          - integer
          - 'null'
        maxRedemptionsPerCouponCode:
          description: 'Maximum number of times any code can de used.

            Must be null or >= 1 (0 is invalid).

            Defaults to 1 on creation if null.'
          format: int32
          type:
          - integer
          - 'null'
        maxRedemptionsPerUser:
          description: 'Maximum number of times any single user can redeem any code.

            Must be null or >= 1 (0 is invalid).

            Defaults to 1 on creation only when legacy tenant behavior is enabled; otherwise null is preserved.'
          format: int32
          type:
          - integer
          - 'null'
        name:
          description: CouponSet Name
          maxLength: 200
          minLength: 1
          type: string
        redemptionCount:
          description: ReadOnly count of all redemptions for this coupon set.
          format: int32
          type:
          - integer
          - 'null'
        setSize:
          description: 'Sets the number of codes to generate for dynamic coupons

            Required when CouponCodeType is "Dynamic"'
          format: int32
          type:
          - integer
          - 'null'
        startDate:
          description: Date and time that the coupon codes becomes active
          format: date-time
          type:
          - string
          - 'null'
        status:
          description: 'CouponSet status which can be: Active, Expired,  Inactive

            System-supplied and read-only.'
          type:
          - string
          - 'null'
      required:
      - name
      type: object
    AssignedDiscount:
      properties:
        auditInfo:
          $ref: '#/components/schemas/AuditInfo'
        couponSetCode:
          description: ReadOnly, CouponSetCode copied from URI
          type:
          - string
          - 'null'
        couponSetId:
          description: ReadOnly, CouponSetId
          format: int32
          type: integer
        discountId:
          description: Discount Id for the associated discount
          format: int32
          type: integer
      required:
      - discountId
      type: object
    CouponCollection:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Coupon'
          type:
          - array
          - 'null'
        pageCount:
          format: int32
          type: integer
        pageSize:
          format: int32
          type: integer
        startIndex:
          format: int32
          type: integer
        totalCount:
          format: int32
          type: integer
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: JWT Authorization header using the Bearer scheme.
      scheme: bearer
      type: http
x-refined-from:
- openapi_openapi_catalog_admin.json
- kibo-commerce-catalog-admin-openapi.yml
x-provenance:
  method: harvested
  publisher: Kibo Commerce
  source: https://docs.kibocommerce.com/openapi/openapi_catalog_admin.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)