Conga Categories API

openapi: 3.2.0
info:
  title: Conga Categories API
  version: 1.0.0
  description: 'Operations tagged Categories across 2 of this provider''s published API definitions: conga-administration.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/api/catalog/v1
security:
- Bearer: []
tags:
- name: Categories
paths:
  /categories:
    delete:
      tags:
      - Categories
      summary: Delete categories
      description: 'Deletes one or more categories based on the list of category IDs provided in the request body.



        The API deletes category records and records of association of category with products and price lists.'
      requestBody:
        description: The list of categories to delete
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Category'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Category'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Category'
      responses:
        '200':
          description: OK
    get:
      tags:
      - Categories
      summary: Retrieve categories
      description: Retrieves a list of all categories that exist in the system. The "filter" parameter only supports category name and category id for this API.
      parameters:
      - name: filter
        in: query
        description: The optional array of filter parameters
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: The optional sort parameter
        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 items per page
        schema:
          type: integer
          format: int32
          default: 50
      - name: includes
        in: query
        description: The optional array of 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
    patch:
      tags:
      - Categories
      summary: Update categories
      description: Updates one or more categories based on the details provided in the request body.
      requestBody:
        description: The list of categories to update
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
            example:
            - Name: CategoryName
              DefaultSearchCategory: true
              Description: Category description
              ExpandedByDefault: false
              GuidePage: Guide_Pagetest
              HideAllSearchFilters: false
              ImageURL: https://test.jpeg
              IncludeInTotalsView: false
              IsHidden: false
              IsLeaf: false
              IsPicklist: false
              Label: Label
              LargeImageURL: https://test.jpeg
              LongDescription: Description
              SearchFilterFields:
              - Family
              Ancestor: null
              AncestorPath: null
              Hierarchy: null
              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
    post:
      tags:
      - Categories
      summary: Create categories
      description: 'Creates one or more category based on the input provided in the request body.



        The API returns structure of each category created, with details provided in the request body.'
      requestBody:
        description: "Provide the details of the following fields to create categories:\n     <ul><li>Category Name</li><li>Description</li><li>Default Search Category</li><li>Expanded By Default</li><li>Include In Totals View</li><li>Hide All Search Filters</li><li>Long Description</li><li>Image</li><li>Search Filter Fields</li><li>Parent Category ID</li></ul>\n  If the parent category has products associate with it, the API throws an error."
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Category'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Category'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Category'
      responses:
        '200':
          description: OK
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /categories/{Id}:
    delete:
      tags:
      - Categories
      summary: Delete a category
      description: Deletes a single category based on the category ID provided in the parameter. The API deletes the specific category record and records of association of the specific category with its products.
      parameters:
      - name: Id
        in: path
        description: The ID of the category
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
    get:
      tags:
      - Categories
      summary: Retrieve a category
      description: Retrieves a single category record.
      parameters:
      - name: Id
        in: path
        description: The ID of the category
        required: true
        schema:
          type: string
      - name: includes
        in: query
        description: The optional array of related entities to include
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Category'
            application/json:
              schema:
                $ref: '#/components/schemas/Category'
            text/json:
              schema:
                $ref: '#/components/schemas/Category'
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/RevenueException'
            application/json:
              schema:
                $ref: '#/components/schemas/RevenueException'
            text/json:
              schema:
                $ref: '#/components/schemas/RevenueException'
    patch:
      tags:
      - Categories
      summary: Update a category
      description: Updatess a single category record.
      parameters:
      - name: Id
        in: path
        description: The ID of the category
        required: true
        schema:
          type: string
      requestBody:
        description: The updated state of the category
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: CategoryName
              DefaultSearchCategory: true
              Description: Category description
              ExpandedByDefault: false
              GuidePage: Guide_Pagetest
              HideAllSearchFilters: false
              ImageURL: https://test.jpeg
              IncludeInTotalsView: false
              IsHidden: false
              IsLeaf: false
              IsPicklist: false
              Label: Label
              LargeImageURL: https://test.jpeg
              LongDescription: Description
              SearchFilterFields:
              - Family
              Ancestor: null
              AncestorPath: null
              Hierarchy: null
              Sequence: 1
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /categories/{categoryId}/price-lists:
    get:
      tags:
      - Categories
      summary: Get price lists
      description: 'Gets price list records for a given category. Your request can set

        the number of records returned per page and the total number of pages.'
      parameters:
      - name: categoryId
        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
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /categories/{category}/bulk:
    post:
      tags:
      - Categories
      summary: Add multiple existing categories under another category
      description: Add multiple existing categories under given category id.
      parameters:
      - name: category
        in: path
        description: Destination Category Id
        required: true
        schema:
          type: string
      requestBody:
        description: 'SourceCategories : Existing category ids which should be added under destination category'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkAddExistingCategoryRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/BulkAddExistingCategoryRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/BulkAddExistingCategoryRequest'
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /categories/{id}/add:
    post:
      tags:
      - Categories
      summary: Add an existing category along with child categories and product associations under given destination category id.
      description: Add an existing category along with child categories and product associations under given destination category id.
      parameters:
      - name: id
        in: path
        description: Destination Category Id
        required: true
        schema:
          type: string
      requestBody:
        description: 'SourceCategory : Existing category id which should be added under destination Category'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddExistingCategoryRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/AddExistingCategoryRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AddExistingCategoryRequest'
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
      deprecated: true
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /categories/{id}/products:
    get:
      tags:
      - Categories
      summary: Retrieve a product category
      description: Retrieves a single product category.
      parameters:
      - name: id
        in: path
        description: The ID of the category
        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
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /categories/{parentId}/product-categories:
    delete:
      tags:
      - Categories
      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
    get:
      tags:
      - Categories
      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
    patch:
      tags:
      - Categories
      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
    post:
      tags:
      - Categories
      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
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /categories/{parentId}/product-categories/{id}:
    delete:
      tags:
      - Categories
      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
    get:
      tags:
      - Categories
      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
    patch:
      tags:
      - Categories
      summary: Update a product category
      description: Updates a product category.
      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 update
        required: true
        schema:
          type: string
      requestBody:
        description: The updated fields of the product category
        content:
          application/json:
            schema:
              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
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
    servers:
    - url: https://rls.congacloud.com/api/revenue-admin/v1
  /categories/{categoryId}:
    get:
      tags:
      - Categories
      summary: Get category details
      description: 'Retrieves the details of a category and its child categories by category ID and price list ID. The API returns such category details as category name, description, and hierarchy ID. The API also returns details of a sub-category''s parent and child categories.

        <p> When you pass a category ID, the API retrieves all products associated with it in the price list. When you pass <i>All</i> as the category ID, the API retrieves all products across all categories for the price list.</p>'
      parameters:
      - name: pricelistid
        in: header
        description: The price list ID that is used to filter the records associated with it.
        schema:
          type: string
      - name: categoryId
        in: path
        description: The category ID to retrieve the records associated with it.
        required: true
        schema:
          type: string
      - name: cartId
        in: header
        description: Pass a cart id to filter the data relative to a specific cart
        schema:
          type: string
          default: ''
      - name: depth
        in: query
        description: Enter the depth of the category hierarchy. The API retrieves the details of all sub-categories until that level.
        schema:
          type: string
      - name: configName
        in: query
        description: Config Name that stores the Category search response field list
        schema:
          type: string
          default: ResponseFieldList_Default
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Conga.Revenue.Entities.Category'
    servers:
    - url: https://rls.congacloud.com/api/catalog/v1
  /categories/{categoryId}/products:
    get:
      tags:
      - Categories
      summary: Retrieve all products in a category
      description: 'Retrieves all active products associated with the provided category ID and price list ID. This can be the ID of the leaf category, sub-category, or root category.

        <p>For a leaf category, the API returns all products associated with it. If the ID of the root or sub-category (not a leaf category ID) is provided, the API returns all the products associated with all child categories. By default, the API returns the following fields with results sorted alphabetically by Product Name.</p><ul><li>Product Name</li><li>Product Code</li><li>Product Description</li><li>Product Family</li><li>List Price</li><li>Charge Type</li><li>The image associated with the product.</li></ul>'
      parameters:
      - name: pricelistid
        in: header
        description: Enter the ID of the price list associated with the products to narrow down the search.
        schema:
          type: string
      - name: categoryId
        in: path
        description: Enter the category ID, typically the classification hierarchy ID.
        required: true
        schema:
          type: string
      - name: storeFrontId
        in: header
        description: ''
        schema:
          type: string
      - name: filter
        in: query
        description: Add conditional filters in standard URI format to narrow down the search result.
        schema:
          type: array
          items:
            type: string
      - name: query
        in: query
        description: Enter the name of the product to narrow down the search result. The API can only match a maximum of 20 characters. If the input string is longer than 20 characters, the API retrieves products where the product name matches the first 20 characters of the search string.
        schema:
          type: string
      - name: includes
        in: query
        description: Add the list of related objects that are associated with the product to include them in the search result.
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: Enter the fields and sort order for the result. Add multiple fields to sort the result further. By default, sort order is ascending based on relevance.
        schema:
          type: string
      - name: page
        in: query
        description: Enter the page number of the search result from where to view the result.
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: Enter the number of records to display on each page. By default, the API displays 50 records on each page. A maximum of 500 records are displayed on each page.
        schema:
          type: integer
          format: int32
          default: 50
      - name: cartId
        in: header
        description: Enter the cart Id
        schema:
          type: string
          default: ''
      - name: productSortEmptyFirst
        in: query
        description: Flag to place products with null values in the sorting field at first or last in the list.
        schema:
          type: boolean
          default: false
      - name: disableCurrencyConversion
        in: query
        description: Flag to enable/disable the currency conversion of price list items
        schema:
          type: boolean
          default: false
      - name: configName
        in: query
        description: Product search response field list
        schema:
          type: string
          default: ResponseFieldList_Default
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Conga.Revenue.Entities.Product'
    servers:
    - url: https://rls.congacloud.com/api/catalog/v1
  /categories/{categoryId}/services:
    post:
      tags:
      - Categories
      summary: Retrieve all service products in a category
      description: 'Retrieves all active service products associated with the provided category ID and price list ID. This can be the ID of the leaf category, sub-category, or root category.

        <p>For a leaf category, the API returns all service products associated with it. If the ID of the root or sub-category (not a leaf category ID) is provided, the API returns all the products associated with all child categories. By default, the API returns the following fields with results sorted alphabetically by Product Name.</p><ul><li>Product Name</li><li>Product Code</li><li>Product Description</li><li>Product Family</li><li>List Price</li><li>Charge Type</li><li>The image associated with the product.</li></ul>'
      parameters:
      - name: pricelistid
        in: header
        description: Enter the ID of the price list associated with the products to narrow down the search.
        schema:
          type: string
      - name: categoryId
        in: path
        description: Enter the category ID, typically the classification hierarchy ID.
        required: true
        schema:
          type: string
      - name: filter
        in: query
        description: Add conditional filters in standard URI format to narrow down the search result.
        schema:
          type: array
          items:
            type: string
      - name: query
        in: query
        description: Enter the name of the product to narrow down the search result. The API can only match a maximum of 20 characters. If the input string is longer than 20 characters, the API retrieves products where the product name matches the first 20 characters of the search string.
        schema:
          type: string
      - name: includes
        in: query
        description: Add the list of related objects that are associated with the product to include them in the search result.
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: Enter the fields and sort order for the result. Add multiple fields to sort the result further. By default, sort order is ascending based on relevance.
        schema:
          type: string
      - name: page
        in: query
        description: Enter the page number of the search result from where to view the result.
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: Enter the number of records to display on each page. By default, the API displays 50 records on each page. A maximum of 500 records are displayed on each page.
        schema:
          type: integer
          format: int32
          default: 50
      - name: cartId
        in: header
        description: Enter the cart Id
        schema:
          type: string
          default: ''
      - name: productSortEmptyFirst
        in: query
        description: Flag to place products with null values in the sorting field at first or last in the list.
        schema:
          type: boolean
          default: false
      - name: disableCurrencyConversion
        in: query
        description: Flag to enable/disable the currency conversion of price list items
        schema:
          type: boolean
          default: false
      - name: configName
        in: query
        description: Product search response field list
        schema:
          type: string
          default: ResponseFieldList_Default
      requestBody:
        description: Input needed to list the service products.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Conga.Revenue.Catalog.Manager.Models.SearchServiceProductsInput'
          application/json:
            schema:
              $ref: '#/components/schemas/Conga.Revenue.Catalog.Manager.Models.SearchServiceProductsInput'
          text/json:
            schema:
              $ref: '#/components/schemas/Conga.Revenue.Catalog.Manager.Models.SearchServiceProductsInput'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Conga.Revenue.Catalog.Manager.Models.SearchServiceProductsInput'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Conga.Revenue.Entities.Product'
    servers:
    - url: https://rls.congacloud.com/api/catalog/v1
components:
  schemas:
    RuntimeTypeHandle:
      type: object
      properties:
        Value:
          $ref: '#/components/schemas/IntPtr'
      additionalProperties: false
    FieldInfo:
      type: object
      properties:
        Name:
          type:
          - string
          - 'null'
          readOnly: true
        DeclaringType:
          $ref: '#/components/schemas/Type'
        ReflectedType:
          $ref: '#/components/schemas/Type'
        Module:
          $ref: '#/components/schemas/Module'
        CustomAttributes:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomAttributeData'
          readOnly: true
        IsCollectible:
          type: boolean
          readOnly: true
        MetadataToken:
          type: integer
          format: int32
          readOnly: true
        MemberType:
          $ref: '#/components/schemas/MemberTypes'
        Attributes:
          $ref: '#/components/schemas/FieldAttributes'
        FieldType:
          $ref: '#/components/schemas/Type'
        IsInitOnly:
          type: boolean
          readOnly: true
        IsLiteral:
          type: boolean
          readOnly: true
        IsNotSerialized:
          type: boolean
          readOnly: true
          deprecated: true
        IsPinvokeImpl:
          type: boolean
          readOnly: true
        IsSpecialName:
          type: boolean
          readOnly: true
        IsStatic:
          type: boolean
          readOnly: true
        IsAssembly:
          type: boolean
          readOnly: true
        IsFamily:
          type: boolean
          readOnly: true
        IsFamilyAndAssemb

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