Bitrix24 Trade Catalog API

openapi: 3.0.3
info:
  title: Bitrix24 REST BIconnector Trade Catalog API
  version: 1.0.0
  description: 'Bitrix24 REST API provides access to CRM, tasks, drive, chats, telephony, e-commerce, automation, and other modules. Documentation: https://apidocs.bitrix24.com'
  contact:
    name: Bitrix24 Developer Support
    url: https://apidocs.bitrix24.com/support.html
  license:
    name: MIT
    url: https://github.com/bitrix-tools/b24-rest-docs/blob/main/LICENSE
  x-logo:
    url: https://apidocs.bitrix24.com/_images/bitrix24logo.svg
servers:
- url: https://{portal}.bitrix24.com/rest
  description: Your Bitrix24 portal (cloud)
  variables:
    portal:
      default: your-portal
      description: Subdomain of your Bitrix24 portal
- url: https://{host}/rest
  description: On-Premise Bitrix24 installation
  variables:
    host:
      default: your-bitrix24.example.com
      description: Host of your on-premise installation
security:
- AccessToken: []
tags:
- name: Trade Catalog
paths:
  /CATALOG.MEASURE.ON.ADD:
    post:
      summary: Event on Adding a Measurement Unit CATALOG.MEASURE.ON.ADD
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a measurement unit is added. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)
      operationId: CATALOG_MEASURE_ON_ADD
      tags:
      - Trade Catalog
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/catalog/measure/events/catalog-measure-on-add.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic event code ||'
                event_handler_id:
                  type: integer
                  description: '| Event handler identifier ||'
                data:
                  type: object
                  description: '| Object with event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with properties of the measurement unit.'
                ID:
                  type: string
                  description: '| Identifier of the measurement unit. You can retrieve all fields of the measurement unit by its identifier using the method catalog.measure.get ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic event code ||'
                event_handler_id:
                  type: integer
                  description: '| Event handler identifier ||'
                data:
                  type: object
                  description: '| Object with event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with properties of the measurement unit.'
                ID:
                  type: string
                  description: '| Identifier of the measurement unit. You can retrieve all fields of the measurement unit by its identifier using the method catalog.measure.get ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - catalog
  /CATALOG.MEASURE.ON.DELETE:
    post:
      summary: Event on Deleting Measurement Unit CATALOG.MEASURE.ON.DELETE
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a measurement unit is deleted. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)
      operationId: CATALOG_MEASURE_ON_DELETE
      tags:
      - Trade Catalog
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/catalog/measure/events/catalog-measure-on-delete.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic event code ||'
                event_handler_id:
                  type: integer
                  description: '| Event handler identifier ||'
                data:
                  type: object
                  description: '| Object with event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with properties of the measurement unit.'
                ID:
                  type: string
                  description: '| Identifier of the measurement unit. You can get all fields of the measurement unit by its identifier using the method catalog.measure.get ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic event code ||'
                event_handler_id:
                  type: integer
                  description: '| Event handler identifier ||'
                data:
                  type: object
                  description: '| Object with event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with properties of the measurement unit.'
                ID:
                  type: string
                  description: '| Identifier of the measurement unit. You can get all fields of the measurement unit by its identifier using the method catalog.measure.get ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - catalog
  /CATALOG.MEASURE.ON.UPDATE:
    post:
      summary: Event on Measurement Unit Change CATALOG.MEASURE.ON.UPDATE
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a measurement unit is updated. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)
      operationId: CATALOG_MEASURE_ON_UPDATE
      tags:
      - Trade Catalog
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/catalog/measure/events/catalog-measure-on-update.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic event code ||'
                event_handler_id:
                  type: integer
                  description: '| Event handler identifier ||'
                data:
                  type: object
                  description: '| Object with event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with properties of the measurement unit.'
                ID:
                  type: string
                  description: '| Identifier of the measurement unit. You can retrieve all fields of the measurement unit by its identifier using the catalog.measure.get method ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic event code ||'
                event_handler_id:
                  type: integer
                  description: '| Event handler identifier ||'
                data:
                  type: object
                  description: '| Object with event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with properties of the measurement unit.'
                ID:
                  type: string
                  description: '| Identifier of the measurement unit. You can retrieve all fields of the measurement unit by its identifier using the catalog.measure.get method ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - catalog
  /CATALOG.PRICE.ON.ADD:
    post:
      summary: Event on Adding Price CATALOG.PRICE.ON.ADD
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a price is added. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)
      operationId: CATALOG_PRICE_ON_ADD
      tags:
      - Trade Catalog
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/catalog/price/events/catalog-price-on-add.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic event code ||'
                event_handler_id:
                  type: integer
                  description: '| Event handler identifier ||'
                data:
                  type: object
                  description: '| Object with event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with price properties.'
                ID:
                  type: string
                  description: '| Price identifier. You can retrieve all price fields by its identifier using the catalog.price.get method ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic event code ||'
                event_handler_id:
                  type: integer
                  description: '| Event handler identifier ||'
                data:
                  type: object
                  description: '| Object with event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with price properties.'
                ID:
                  type: string
                  description: '| Price identifier. You can retrieve all price fields by its identifier using the catalog.price.get method ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - catalog
  /CATALOG.PRICE.ON.DELETE:
    post:
      summary: Event on Price Deletion CATALOG.PRICE.ON.DELETE
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a price is deleted. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)
      operationId: CATALOG_PRICE_ON_DELETE
      tags:
      - Trade Catalog
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/catalog/price/events/catalog-price-on-delete.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic event code ||'
                event_handler_id:
                  type: integer
                  description: '| Event handler identifier ||'
                data:
                  type: object
                  description: '| Object with event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with price properties.'
                ID:
                  type: string
                  description: '| Price identifier. You can retrieve all fields of the price by its identifier using the catalog.price.get method ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic event code ||'
                event_handler_id:
                  type: integer
                  description: '| Event handler identifier ||'
                data:
                  type: object
                  description: '| Object with event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with price properties.'
                ID:
                  type: string
                  description: '| Price identifier. You can retrieve all fields of the price by its identifier using the catalog.price.get method ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - catalog
  /CATALOG.PRICE.ON.UPDATE:
    post:
      summary: Event on Price Change CATALOG.PRICE.ON.UPDATE
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when the price is updated. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)
      operationId: CATALOG_PRICE_ON_UPDATE
      tags:
      - Trade Catalog
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/catalog/price/events/catalog-price-on-update.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic event code ||'
                event_handler_id:
                  type: integer
                  description: '| Event handler identifier ||'
                data:
                  type: object
                  description: '| Object with event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with price properties.'
                ID:
                  type: string
                  description: '| Price identifier. All fields of the price can be retrieved by its identifier using the method catalog.price.get ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic event code ||'
                event_handler_id:
                  type: integer
                  description: '| Event handler identifier ||'
                data:
                  type: object
                  description: '| Object with event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with price properties.'
                ID:
                  type: string
                  description: '| Price identifier. All fields of the price can be retrieved by its identifier using the method catalog.price.get ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - catalog
  /CATALOG.PRICE.TYPE.ON.ADD:
    post:
      summary: Event on Adding Price Type CATALOG.PRICE.TYPE.ON.ADD
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a price type is added. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)
      operationId: CATALOG_PRICE_TYPE_ON_ADD
      tags:
      - Trade Catalog
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/catalog/price-type/events/catalog-price-type-on-add.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic code of the event ||'
                event_handler_id:
                  type: integer
                  description: '| Identifier of the event handler ||'
                data:
                  type: object
                  description: '| Object containing event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with properties of the price type.'
                ID:
                  type: string
                  description: '| Identifier of the price type. You can retrieve all fields of the price type by its identifier using the method catalog.priceType.get ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic code of the event ||'
                event_handler_id:
                  type: integer
                  description: '| Identifier of the event handler ||'
                data:
                  type: object
                  description: '| Object containing event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with properties of the price type.'
                ID:
                  type: string
                  description: '| Identifier of the price type. You can retrieve all fields of the price type by its identifier using the method catalog.priceType.get ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - catalog
  /CATALOG.PRICE.TYPE.ON.DELETE:
    post:
      summary: Event on Deletion of Price Type CATALOG.PRICE.TYPE.ON.DELETE
      description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The event occurs when a price type is deleted. Events will not be sent to the application until the installation is complete. [Check the application installation](../../../../settings/app-installation/installation-finish.md)
      operationId: CATALOG_PRICE_TYPE_ON_DELETE
      tags:
      - Trade Catalog
      externalDocs:
        url: https://apidocs.bitrix24.com/api-reference/catalog/price-type/events/catalog-price-type-on-delete.html
        description: Official Documentation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic code of the event ||'
                event_handler_id:
                  type: integer
                  description: '| Identifier of the event handler ||'
                data:
                  type: object
                  description: '| Object containing event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with properties of the price type.'
                ID:
                  type: string
                  description: '| Identifier of the price type. You can retrieve all fields of the price type by its identifier using the method catalog.priceType.get ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                event:
                  type: string
                  description: '| Symbolic code of the event ||'
                event_handler_id:
                  type: integer
                  description: '| Identifier of the event handler ||'
                data:
                  type: object
                  description: '| Object containing event data.'
                ts:
                  type: integer
                  description: '| Timestamp of the event sent from the event queue ||'
                auth:
                  type: object
                  description: '| Object with authorization parameters and information about the account where the event occurred ||'
                FIELDS:
                  type: object
                  description: '| Object with properties of the price type.'
                ID:
                  type: string
                  description: '| Identifier of the price type. You can retrieve all fields of the price type by its identifier using the method catalog.priceType.get ||'
              required:
              - event
              - event_handler_id
              - data
              - ts
              - auth
              - FIELDS
              - ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixResponse'
        4XX:
          description: Request error (400, 401, 403)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BitrixError'
      security:
      - AccessToken: []
      - OAuth2:
        - 

# --- truncated at 32 KB (509 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitrix24/refs/heads/main/openapi/bitrix24-trade-catalog-api-openapi.yml