Conga Products API

openapi: 3.2.0
info:
  title: Conga Products API
  version: 1.0.0
  description: 'Operations tagged Products across 3 of this provider''s published API definitions: conga-administration.json, conga-asset.json, conga-catalog.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://rls.congacloud.com/api/revenue-admin/v1
- url: https://rls.congacloud.com
- url: https://preview-rls09.congacloud.com
- url: https://rls.congacloud.com/api/catalog/v1
tags:
- name: Products
paths:
  /products:
    delete:
      tags:
      - Products
      summary: Delete multiple products
      description: Deletes multiple products.
      requestBody:
        description: The list of products to delete
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Product'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Product'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Product'
      responses:
        '200':
          description: OK
      security:
      - Bearer: []
      operationId: deleteProducts
      x-operation-id-source: derived
    get:
      tags:
      - Products
      summary: Retrieve the collection of products
      description: Retrieves the collection of all the products.
      parameters:
      - name: filter
        in: query
        description: Optional filter parameters
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: Optional sort parameter
        schema:
          type: string
      - name: page
        in: query
        description: Page number
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: Number of items per page
        schema:
          type: integer
          format: int32
          default: 50
      - name: includes
        in: query
        description: Optional related entities to include
        schema:
          type: array
          items:
            type: string
      - name: field
        in: query
        description: Pass Comma separated mulitple fields
        schema:
          type: array
          items:
            type: string
      - name: filterExpression
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      security:
      - Bearer: []
      operationId: getProducts
      x-operation-id-source: derived
    patch:
      tags:
      - Products
      summary: Update multiple products
      description: Updates multiple products.
      requestBody:
        description: The list of products with updated data
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
            example:
            - Name: Name of the product
              ConfigurationType: Standalone
              Description: Product description
              Family: Product Family
              IsActive: true
              ProductType: Type of the product
              IsCustomizable: true
              Id: Id of the record
          text/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
          application/*+json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
      responses:
        '200':
          description: OK
      security:
      - Bearer: []
      operationId: patchProducts
      x-operation-id-source: derived
    post:
      tags:
      - Products
      summary: Create multiple products
      description: Creates multiple product.
      requestBody:
        description: The list of products to create
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Product'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Product'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Product'
      responses:
        '200':
          description: OK
      security:
      - Bearer: []
      operationId: postProducts
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /products/{Id}:
    delete:
      tags:
      - Products
      summary: Delete a single product by its identifier
      description: Deletes a single product by its identifier.
      parameters:
      - name: Id
        in: path
        description: The identifier of the product to delete
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      security:
      - Bearer: []
      operationId: deleteProductsById
      x-operation-id-source: derived
    get:
      tags:
      - Products
      summary: Retrieve a single product by its identifier
      description: Retrieves a single product by its identifier.
      parameters:
      - name: Id
        in: path
        description: The identifier of the product
        required: true
        schema:
          type: string
      - name: includes
        in: query
        description: Optional related entities to include
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
      security:
      - Bearer: []
      operationId: getProductsById
      x-operation-id-source: derived
    patch:
      tags:
      - Products
      summary: Update a single product
      description: Updates a single product.
      parameters:
      - name: Id
        in: path
        description: The identifier of the product to update
        required: true
        schema:
          type: string
      requestBody:
        description: The updated data of the product
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: Name of the product
              ConfigurationType: Standalone
              Description: Product description
              Family: Product Family
              IsActive: true
              ProductType: Type of the product
              IsCustomizable: true
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
      security:
      - Bearer: []
      operationId: patchProductsById
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /products/{id}/attribute-matrices:
    get:
      tags:
      - Products
      summary: List Attributes
      description: Retrieves the attribute collection.
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      security:
      - Bearer: []
      operationId: getProductsByIdAttributeMatrices
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /products/{id}/attribute-rules:
    get:
      tags:
      - Products
      summary: Retrieve all attribute rules
      description: Retrieves all attributes rules in the system.
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 50
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      security:
      - Bearer: []
      operationId: getProductsByIdAttributeRules
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /products/{id}/categories:
    get:
      tags:
      - Products
      summary: Retrive lookup records
      description: Retrieves the lookup records for a given ID.
      parameters:
      - name: id
        in: path
        description: The ID
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: The page number
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: The number of records per page
        schema:
          type: integer
          format: int32
          default: 50
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      security:
      - Bearer: []
      operationId: getProductsByIdCategories
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /products/{id}/clone:
    post:
      tags:
      - Products
      summary: Clone a product
      description: Clones a product.
      parameters:
      - name: id
        in: path
        description: The identifier of the Product to clone
        required: true
        schema:
          type: string
      - name: isDeepCloneObject
        in: query
        description: Should deep clone object
        schema:
          type: boolean
      - name: excludeObjects
        in: query
        description: Objects to exclude from deep cloning
        schema:
          type: array
          items:
            type: string
      requestBody:
        description: Override fields with field name and value
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '201':
          description: Created
        '202':
          description: Accepted
        '404':
          description: Not Found
      security:
      - Bearer: []
      operationId: postProductsByIdClone
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /products/{id}/constraint-rules:
    get:
      tags:
      - Products
      summary: Retrieve all constraint rules
      description: 'Retrieves all constraint rules with their details. Use query parameters to further narrow the results.


        When executed, this API returns all constraint rules.'
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      security:
      - Bearer: []
      operationId: getProductsByIdConstraintRules
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /products/{id}/price-lists:
    get:
      tags:
      - Products
      summary: Retrieve Price Lists
      description: Retrieves price lists for a specific product.
      parameters:
      - name: id
        in: path
        description: The ID of the product
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: The page number
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: The maximum number of records to retrieve per page
        schema:
          type: integer
          format: int32
          default: 50
      responses:
        '200':
          description: OK
      security:
      - Bearer: []
      operationId: getProductsByIdPriceLists
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /products/{id}/product-groups:
    get:
      tags:
      - Products
      summary: Retrieve product groups for a specific product
      description: Retrieves product groups for a specific product.
      parameters:
      - name: id
        in: path
        description: The ID of the product
        required: true
        schema:
          type: string
      - name: page
        in: query
        description: The page number
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: The maximum number of records to retrieve per page
        schema:
          type: integer
          format: int32
          default: 50
      responses:
        '200':
          description: OK
      security:
      - Bearer: []
      operationId: getProductsByIdProductGroups
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /products/{parentId}/price-list-items:
    delete:
      tags:
      - Products
      summary: Delete price list items
      parameters:
      - name: parentId
        in: path
        description: The ID of the parent entity
        required: true
        schema:
          type: string
      requestBody:
        description: The list of price list items to delete
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceListItem'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceListItem'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceListItem'
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      security:
      - Bearer: []
      operationId: deleteProductsByParentIdPriceListItems
      x-operation-id-source: derived
    get:
      tags:
      - Products
      summary: Retrieve price list items
      description: 'Retrieves all price list items in a price list, with their details. Use query parameters to further narrow the results.


        When executed, this API returns all price list items in a price list.'
      parameters:
      - name: parentId
        in: path
        description: The ID of the parent entity
        required: true
        schema:
          type: string
      - name: filter
        in: query
        description: Optional filter conditions
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: Optional sort expression
        schema:
          type: string
      - name: page
        in: query
        description: The page number
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: The maximum number of records to retrieve per page
        schema:
          type: integer
          format: int32
          default: 50
      - name: includes
        in: query
        description: Optional related entities to include
        schema:
          type: array
          items:
            type: string
      - name: field
        in: query
        description: Pass Comma separated mulitple fields
        schema:
          type: array
          items:
            type: string
      - name: filterExpression
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      security:
      - Bearer: []
      operationId: getProductsByParentIdPriceListItems
      x-operation-id-source: derived
    patch:
      tags:
      - Products
      summary: Update price list items
      description: 'Updates specific fields on one or more price list items. It can update any field except the price list item ID.


        When executed, this API returns the updated price list item or items.'
      parameters:
      - name: parentId
        in: path
        description: The ID of the parent entity
        required: true
        schema:
          type: string
      requestBody:
        description: The list of price list items to update
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
            example:
            - Name: PriceListItemName
              IsActive: true
              AllocateGroupAdjustment: true
              AllowManualAdjustment: true
              AllowPriceRampOverlap: true
              AllowProration: true
              BillingFrequency: Hourly
              BillingRule: Bill In Advance
              ChargeType: Standard Price
              Criteria: The item criteria specification
              Description: Description
              Frequency: Hourly
              PriceList:
                Id: PriceList-Id
                Name: PriceList-Name
              PriceMethod: Per Unit
              PriceType: One Time
              Product:
                Id: Product-Id
                Name: Product-Name
              Id: Id of the record
          text/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
          application/*+json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
      responses:
        '200':
          description: OK
      security:
      - Bearer: []
      operationId: patchProductsByParentIdPriceListItems
      x-operation-id-source: derived
    post:
      tags:
      - Products
      summary: Create price list items
      description: 'creates one or more price list items in a specific price list. It can create a maximum of 1000 price list items. It can create multiple price list items for the same product or multiple products. To create multiple price list items, pass one array for each price list item record in the API request.


        When executed, this API returns a unique price list item ID (string) that CPQ automatically generates.'
      parameters:
      - name: parentId
        in: path
        description: The ID of the parent entity
        required: true
        schema:
          type: string
      requestBody:
        description: The list of price list items to create
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceListItem'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceListItem'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceListItem'
      responses:
        '201':
          description: Created
      security:
      - Bearer: []
      operationId: postProductsByParentIdPriceListItems
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /products/{parentId}/price-list-items/{id}:
    delete:
      tags:
      - Products
      summary: Delete a price list item
      description: 'Deletes a specified price list item in a price list.


        When executed, this API returns the delete status of associated record ID.'
      parameters:
      - name: parentId
        in: path
        description: The ID of the parent entity
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The ID of the price list item to delete
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      security:
      - Bearer: []
      operationId: deleteProductsByParentIdPriceListItemsById
      x-operation-id-source: derived
    get:
      tags:
      - Products
      summary: Retrieve a price list item
      description: 'Retrieves a price list item in a price list, with their details. Use query parameters to further narrow the results.


        When executed, this API returns a price list item in a price list.'
      parameters:
      - name: parentId
        in: path
        description: The ID of the parent entity
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The ID of the price list item
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      security:
      - Bearer: []
      operationId: getProductsByParentIdPriceListItemsById
      x-operation-id-source: derived
    patch:
      tags:
      - Products
      summary: Update a price list item
      description: 'Updates specific fields on specified price list item. It can update any field except the price list item ID.


        When executed, this API returns the updated price list item.'
      parameters:
      - name: parentId
        in: path
        description: The ID of the parent entity
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The ID of the price list item
        required: true
        schema:
          type: string
      requestBody:
        description: The updated price list item
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: PriceListItemName
              IsActive: true
              AllocateGroupAdjustment: true
              AllowManualAdjustment: true
              AllowPriceRampOverlap: true
              AllowProration: true
              BillingFrequency: Hourly
              BillingRule: Bill In Advance
              ChargeType: Standard Price
              Criteria: The item criteria specification
              Description: Description
              Frequency: Hourly
              PriceList:
                Id: PriceList-Id
                Name: PriceList-Name
              PriceMethod: Per Unit
              PriceType: One Time
              Product:
                Id: Product-Id
                Name: Product-Name
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      security:
      - Bearer: []
      operationId: patchProductsByParentIdPriceListItemsById
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /products/{parentId}/price-list-items/{id}/clone:
    post:
      tags:
      - Products
      summary: Clone a price list item
      description: Clones a price list item.
      parameters:
      - name: parentId
        in: path
        description: The ID of the parent entity
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The identifier of the PriceListItem to clone
        required: true
        schema:
          type: string
      - name: isDeepCloneObject
        in: query
        description: Should deep clone object
        schema:
          type: boolean
      - name: excludeObjects
        in: query
        description: Objects to exclude from deep cloning
        schema:
          type: array
          items:
            type: string
      requestBody:
        description: Override fields with field name and value
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '201':
          description: Created
        '202':
          description: Accepted
        '404':
          description: Not Found
      security:
      - Bearer: []
      operationId: postProductsByParentIdPriceListItemsByIdClone
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /products/{parentId}/product-categories:
    delete:
      tags:
      - Products
      summary: Delete product categories
      description: Deletes one or more product categories from a specified product based on the parameters and request body.
      parameters:
      - name: parentId
        in: path
        description: The parent ID
        required: true
        schema:
          type: string
      requestBody:
        description: The list of product categories to delete
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ProductCategory'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ProductCategory'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ProductCategory'
      responses:
        '200':
          description: OK
      security:
      - Bearer: []
      operationId: deleteProductsByParentIdProductCategories
      x-operation-id-source: derived
    get:
      tags:
      - Products
      summary: Retrieve product categories
      description: Retrieves the product category records for a category.
      parameters:
      - name: parentId
        in: path
        description: The parent ID
        required: true
        schema:
          type: string
      - name: filter
        in: query
        description: The filter
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: The sort
        schema:
          type: string
      - name: page
        in: query
        description: The page number
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: The number of records per page
        schema:
          type: integer
          format: int32
          default: 50
      - name: includes
        in: query
        description: The included fields
        schema:
          type: array
          items:
            type: string
      - name: field
        in: query
        description: Pass Comma separated mulitple fields
        schema:
          type: array
          items:
            type: string
      - name: filterExpression
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      security:
      - Bearer: []
      operationId: getProductsByParentIdProductCategories
      x-operation-id-source: derived
    patch:
      tags:
      - Products
      summary: Update product categories
      description: Updates multiple product categories.
      parameters:
      - name: parentId
        in: path
        description: The parent ID
        required: true
        schema:
          type: string
      requestBody:
        description: The list of product categories to update
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
            example:
            - Name: Name of the record
              Product:
                Id: Product-Id
                Name: Product-Name
              Default: true
              DefaultQuantity: 1
              MaxQuantity: 100
              MinQuantity: 1
              Modifiable: true
              Sequence: 1
              Id: Id of the record
          text/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
          application/*+json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
      responses:
        '200':
          description: OK
      security:
      - Bearer: []
      operationId: patchProductsByParentIdProductCategories
      x-operation-id-source: derived
    post:
      tags:
      - Products
      summary: Create product categories
      description: Creates multiple product categories.
      parameters:
      - name: parentId
        in: path
        description: The parent ID
        required: true
        schema:
          type: string
      requestBody:
        description: The list of product categories to create
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ProductCategory'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ProductCategory'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ProductCategory'
      responses:
        '201':
          description: Created
      security:
      - Bearer: []
      operationId: postProductsByParentIdProductCategories
      x-operation-id-source: derived
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /products/{parentId}/product-categories/{id}:
    delete:
      tags:
      - Products
      summary: Delete a product category
      description: Deletes a product category by ID.
      parameters:
      - name: parentId
        in: path
        description: The parent ID
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The ID of the product category to delete
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      security:
      - Bearer: []
      operationId: deleteProductsByParentIdProductCategoriesById
      x-operation-id-source: derived
    get:
      tags:
      - Products
      summary: Retrieve a product category
      description: Retrieves a product category by ID.
      parameters:
      - name: parentId
        in: path
        description: The parent ID
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The ID of the product category to fetch
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      security:
      - Bearer: []
      operationId: getProductsByParentIdProductCategoriesById
      x-operation-id-source: derived
    patch:
      tags:
      - Products
      summary: Update a product category
      description: Updates a product category.
      parameters:
      - name: parentId
        in: path
        des

# --- truncated at 32 KB (133 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-products-api-openapi.yml