openapi: 3.0.3 info: title: Bitrix24 REST BIconnector E-Commerce 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: E-Commerce paths: /sale.basketitem.add: post: summary: Add Item (Position) to the Cart of an Existing Order sale.basketitem.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. This method adds an item to the cart of an existing order. operationId: sale_basketitem_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values for creating an item (position) in the cart of the order ||' orderId: type: string description: '| Order identifier ||' sort: type: integer description: '| Position in the list of order items ||' productid: type: string description: '| Product/variation identifier.' price: type: number format: double description: '| Price including markups and discounts (see the `customPrice` field below).' basePrice: type: number format: double description: '| Original price excluding markups and discounts (see the `customPrice` field below).' discountPrice: type: number format: double description: '| Amount of the final discount or markup (see the `customPrice` field below).' currency: type: string description: '| Currency of the price. Must match the currency of the order ||' customPrice: type: string description: '| Is the price specified manually. Possible values:' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External code of the cart item ||' required: - fields - orderId - productid - currency - quantity application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values for creating an item (position) in the cart of the order ||' orderId: type: string description: '| Order identifier ||' sort: type: integer description: '| Position in the list of order items ||' productid: type: string description: '| Product/variation identifier.' price: type: number format: double description: '| Price including markups and discounts (see the `customPrice` field below).' basePrice: type: number format: double description: '| Original price excluding markups and discounts (see the `customPrice` field below).' discountPrice: type: number format: double description: '| Amount of the final discount or markup (see the `customPrice` field below).' currency: type: string description: '| Currency of the price. Must match the currency of the order ||' customPrice: type: string description: '| Is the price specified manually. Possible values:' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External code of the cart item ||' required: - fields - orderId - productid - currency - quantity 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: - sale /sale.basketitem.addCatalogProduct: post: summary: Add a position with a product or service from the catalog module to the cart of an existing order sale.basketitem.addCatalogProduct 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. This method adds a position (item) with a product or service from the catalog module to the cart of an existing order. operationId: sale_basketitem_addCatalogProduct tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-add-catalog-product.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values for creating an item (position) in the order cart ||' orderId: type: string description: '| Order identifier. Can only be specified when creating a cart position.' sort: type: integer description: '| Position in the order item list ||' productid: type: string description: '| Identifier of the product/variation' price: type: number format: double description: '| Price considering markups and discounts (see the `customPrice` field below). If not specified, it will be calculated based on catalog data.' basePrice: type: number format: double description: '| Original price without considering markups and discounts (see the `customPrice` field below). If not specified, it will be calculated based on catalog data.' discountPrice: type: number format: double description: '| Amount of the final discount or markup (see the `customPrice` field below). If not specified, it will be calculated based on catalog data.' currency: type: string description: '| Currency of the price. Must match the currency of the order ||' customPrice: type: string description: '| Is the price specified manually:' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External code of the cart position ||' name: type: string description: '| Name of the product ||' required: - fields - orderId - productid - currency - quantity - name application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values for creating an item (position) in the order cart ||' orderId: type: string description: '| Order identifier. Can only be specified when creating a cart position.' sort: type: integer description: '| Position in the order item list ||' productid: type: string description: '| Identifier of the product/variation' price: type: number format: double description: '| Price considering markups and discounts (see the `customPrice` field below). If not specified, it will be calculated based on catalog data.' basePrice: type: number format: double description: '| Original price without considering markups and discounts (see the `customPrice` field below). If not specified, it will be calculated based on catalog data.' discountPrice: type: number format: double description: '| Amount of the final discount or markup (see the `customPrice` field below). If not specified, it will be calculated based on catalog data.' currency: type: string description: '| Currency of the price. Must match the currency of the order ||' customPrice: type: string description: '| Is the price specified manually:' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External code of the cart position ||' name: type: string description: '| Name of the product ||' required: - fields - orderId - productid - currency - quantity - name 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: - sale /sale.basketitem.delete: post: summary: Remove item (position) from the cart using sale.basketitem.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. This method removes an item (position) from the cart in the order. operationId: sale_basketitem_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the cart item (position).' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the cart item (position).' required: - 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: - sale /sale.basketitem.get: post: summary: Get Information About a Basket Item (Position) sale.basketitem.get 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. This method retrieves information about a basket item (position). operationId: sale_basketitem_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the basket item (position).' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the basket item (position).' required: - 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: - sale /sale.basketitem.getFields: post: summary: Get Available Fields of the Basket Item (sale.basketitem.getFields) 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 method returns a list of available fields of the basket item. Each field is described as a field settings structure [rest_field_description](../data-types.md). No parameters. operationId: sale_basketitem_getFields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' basketItem: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object sale_basket_item, and `value` is an object of type rest_field_description' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' basketItem: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object sale_basket_item, and `value` is an object of type rest_field_description' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.basketitem.getFieldsCatalogProduct: post: summary: Get Available Fields of a Basket Item (Product from Catalog) sale.basketitem.getFieldsCatalogProduct 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. This method returns a list of available fields for a basket item (position) for the methods [sale.basketitem.addCatalogProduct](./sale-basket-item-add-catalog-product.md) and [sale.basketitem.updateCatalogProduct](./sale-basket-item-update-catalog-product.md) — these methods only work with products from the catalog module in basket items (positions). Unlike [sale.basketitem.getFields](./sale-basket-item-get-fields.md), the method `sale.basketitem.getFieldsCatalogProduct` returns the minimum necessary list of fields for operation. No parameters required. operationId: sale_basketitem_getFieldsCatalogProduct tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-get-catalog-product-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' basketItem: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the field of the sale_basket_item, and `value` is an object of type rest_field_description' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' basketItem: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the field of the sale_basket_item, and `value` is an object of type rest_field_description' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.basketitem.list: post: summary: Get a List of Items (Positions) in the Cart sale.basketitem.list 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. This method returns a set of items (positions) in the cart filtered by the specified criteria. operationId: sale_basketitem_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '|' filter: type: object description: '| An object for filtering the selected records in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '|' start: type: integer description: '| This parameter is used to manage pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '|' filter: type: object description: '| An object for filtering the selected records in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '|' start: type: integer description: '| This parameter is used to manage pagination.' 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: - sale /sale.basketitem.update: post: summary: Change the position of the basket in an existing order sale.basketitem.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. This method modifies the position of the basket in an existing order. operationId: sale_basketitem_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the order item ||' fields: type: object description: '| Values of the fields to be modified ||' sort: type: integer description: '| Position in the list of order items ||' price: type: number format: double description: '| Price including markups and discounts ||' basePrice: type: number format: double description: '| Original price excluding markups and discounts ||' discountPrice: type: number format: double description: '| Amount of the final discount or markup ||' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External code of the basket item ||' name: type: string description: '| Name of the product ||' weight: type: integer description: '| Weight of the product ||' dimensions: type: string description: '| Dimensions of the product (serialized array) ||' measureCode: type: string description: '| Code of the product''s unit of measure ||' measureName: type: string description: '| Name of the unit of measure ||' canBuy: type: string description: '| Availability flag of the product. Possible values:' vatRate: type: number format: double description: '| Tax rate in percentage. To specify the "No VAT" rate, an empty string should be passed ||' vatIncluded: type: string description: '| Flag indicating whether VAT or tax is included in the product price. Possible values:' catalogXmlId: type: string description: '| External code of the product catalog ||' productXmlId: type: string description: '| External code of the product ||' required: - id - fields application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the order item ||' fields: type: object description: '| Values of the fields to be modified ||' sort: type: integer description: '| Position in the list of order items ||' price: type: number format: double description: '| Price including markups and discounts ||' basePrice: type: number format: double description: '| Original price excluding markups and discounts ||' discountPrice: type: number format: double description: '| Amount of the final discount or markup ||' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External code of the basket item ||' name: type: string description: '| Name of the product ||' weight: type: integer description: '| Weight of the product ||' dimensions: type: string description: '| Dimensions of the product (serialized array) ||' measureCode: type: string description: '| Code of the product''s unit of measure ||' measureName: type: string description: '| Name of the unit of measure ||' canBuy: type: string description: '| Availability flag of the product. Possible values:' vatRate: type: number format: double description: '| Tax rate in percentage. To specify the "No VAT" rate, an empty string should be passed ||' vatIncluded: type: string description: '| Flag indicating whether VAT or tax is included in the product price. Possible values:' catalogXmlId: type: string description: '| External code of the product catalog ||' productXmlId: type: string description: '| External code of the product ||' required: - id - fields 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: - sale /sale.basketitem.updateCatalogProduct: post: summary: Change the basket item position (catalog product) of an existing order sale.basketitem.updateCatalogProduct 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. This method changes the basket item position (catalog product) of an existing order. operationId: sale_basketitem_updateCatalogProduct tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/basket-item/sale-basket-item-update-catalog-product.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the basket item. Can be obtained using the methods sale.basketitem.addCatalogProduct and sale.basketitem.list ||' fields: type: object description: '| Object with modifiable fields ||' sort: type: integer description: '| Position in the order item list ||' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External code of the basket item ||' required: - id - fields - quantity application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the basket item. Can be obtained using the methods sale.basketitem.addCatalogProduct and sale.basketitem.list ||' fields: type: object description: '| Object with modifiable fields ||' sort: type: integer description: '| Position in the order item list ||' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External code of the basket item ||' required: - id - fields - quantity 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: - sale /sale.basketproperties.add: post: summary: Create a property for a basket item sale.basketproperties.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. This method adds a property for an item (position) in the basket of an order. operationId: sale_basketproperties_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/basket-properties/sale-basket-properties-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values (detailed description provided below) for creating a property of a basket item (position):' basketId: type: string description: '| Identifier of the basket item (position) in the order.' name: type: string description: '| Property name ||' value: type: string description: '| Property value ||' code: type: string description: '| Symbolic code of the property ||' sort: type: integer description: '| Position in the list of properties.' xmlId: type: string description: '| External code of the property.' required: - fields - basketId - name - value - code application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values (detailed description provided below) for creating a property of a basket item (position):' basketId: type: string description: '| Identifier of the basket item (position) in the order.' name: type: string description: '| Property name ||' value: type: string description: '| Property value ||' code: type: string description: '| Symbolic code of the property ||' sort: type: integer description: '| Position in the list of properties.' xmlId: type: string description: '| External code of the property.' required: - fields - basketId - name - value - code 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: - sale /sale.basketproperties.delete: post: summary: Delete Basket Property sale.basketproperties.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. This method removes a property for an item (position) in the basket of an order. operationId: sale_basketproperties_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/basket-properties/sale-basket-properties-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the basket item (position) property.' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the basket item (position) property.' required: - 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: - sale /sale.basketproperties.get: post: summary: Get the value of the basket property sale.basketproperties.get 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 method returns the property for an item (position) in the basket of an order by its identifier. operationId: sale_basketproperties_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/basket-properties/sale-basket-properties-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the basket item property ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the basket item property ||' required: - 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: - sale /sale.basketproperties.getFields: post: summary: Get Fields of Basket Properties sale.basketproperties.getFields 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 method returns a list of property fields. Each field is described as a settings structure (`rest_field_description`). No parameters. operationId: sale_basketproperties_getFields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/basket-properties/sale-basket-properties-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' basketProperties: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Where `field` is the identifier of the object `sale_basket_item_property`, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' basketProperties: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Where `field` is the identifier of the object `sale_basket_item_property`, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.basketproperties.list: post: summary: Get a List of Basket Properties sale.basketproperties.list 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. This method returns a set of properties for the items (positions) in the basket, selected based on a filter. operationId: sale_basketproperties_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/basket-properties/sale-basket-properties-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to be selected (see fields of the object `sale_basket_item_property`).' filter: type: object description: '| An object for filtering the selected catalog sections in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected groups of properties in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to be selected (see fields of the object `sale_basket_item_property`).' filter: type: object description: '| An object for filtering the selected catalog sections in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected groups of properties in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' 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: - sale /sale.basketproperties.update: post: summary: Change the property of the basket item sale.basketproperties.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. This method modifies the property for an item (position) in the basket of an order. operationId: sale_basketproperties_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/basket-properties/sale-basket-properties-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the order item ||' fields: type: object description: '| Values of the fields to be modified (detailed description is provided below) for the basket item (position) property:' name: type: string description: '| Name of the property ||' value: type: string description: '| Value of the property ||' code: type: string description: '| Symbolic code of the property ||' sort: type: integer description: '| Position in the list of properties ||' xmlId: type: string description: '| External code of the property ||' required: - id - fields application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the order item ||' fields: type: object description: '| Values of the fields to be modified (detailed description is provided below) for the basket item (position) property:' name: type: string description: '| Name of the property ||' value: type: string description: '| Value of the property ||' code: type: string description: '| Symbolic code of the property ||' sort: type: integer description: '| Position in the list of properties ||' xmlId: type: string description: '| External code of the property ||' required: - id - fields 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: - sale /sale.businessValuePersonDomain.add: post: summary: Add Correspondence to a Natural or Legal Person sale.businessValuePersonDomain.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 method `sale.businessValuePersonDomain.add` adds correspondence for the selected payer type to a natural or legal person. This is necessary for the operation of the business meanings mechanism. operationId: sale_businessValuePersonDomain_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values for creating correspondence to a natural or legal person ||' personTypeId: type: string description: '| Identifier for the payer type.' domain: type: string description: '| Value corresponding to the payer type: natural or legal person.' required: - fields - personTypeId - domain application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values for creating correspondence to a natural or legal person ||' personTypeId: type: string description: '| Identifier for the payer type.' domain: type: string description: '| Value corresponding to the payer type: natural or legal person.' required: - fields - personTypeId - domain 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: - sale /sale.businessValuePersonDomain.deleteByFilter: post: summary: Delete the correspondence with a natural or legal person sale.businessValuePersonDomain.deleteByFilter 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 method `sale.businessValuePersonDomain.deleteByFilter` removes the correspondence with a natural or legal person. operationId: sale_businessValuePersonDomain_deleteByFilter tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-delete-by-filter.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values for deleting the correspondence with a natural or legal person ||' personTypeId: type: string description: '| ID of the payer type. Unique parameter.' domain: type: string description: '| Value corresponding to the payer type: natural person or legal entity.' required: - fields - personTypeId - domain application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values for deleting the correspondence with a natural or legal person ||' personTypeId: type: string description: '| ID of the payer type. Unique parameter.' domain: type: string description: '| Value corresponding to the payer type: natural person or legal entity.' required: - fields - personTypeId - domain 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: - sale /sale.businessValuePersonDomain.getFields: post: summary: Get Fields Corresponding to a Natural or Legal Person sale.businessValuePersonDomain.getFields 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 method `sale.businessValuePersonDomain.getFields` returns fields corresponding to a natural or legal person. No parameters. operationId: sale_businessValuePersonDomain_getFields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' businessValuePersonDomain: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object `sale_business_value_person_domain`, and `value` is an object of type `rest_field_description` ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' businessValuePersonDomain: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object `sale_business_value_person_domain`, and `value` is an object of type `rest_field_description` ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.businessValuePersonDomain.list: post: summary: Get a list of matches for a natural or legal person sale.businessValuePersonDomain.list 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 method `sale.businessValuePersonDomain.list` retrieves a list of matches for a natural or legal person. operationId: sale_businessValuePersonDomain_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/business-value-person-domain/sale-business-value-person-domain-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| The array contains a list of fields to select.' filter: type: object description: '| An object for filtering the selected matches for a natural or legal person in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected matches for a natural or legal person in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| The parameter is used to manage pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| The array contains a list of fields to select.' filter: type: object description: '| An object for filtering the selected matches for a natural or legal person in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected matches for a natural or legal person in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| The parameter is used to manage pagination.' 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: - sale /sale.cashbox.add: post: summary: Add Cash Register sale.cashbox.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. This method adds a cash register. operationId: sale_cashbox_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: NAME: type: string description: '| Name of the cash register ||' REST_CODE: type: string description: '| REST handler code for the cash register. Specified when adding the handler in the method sale.cashbox.handler.add in the `CODE` parameter ||' EMAIL: type: string description: '| Email address to which notifications will be sent in case of errors during receipt printing ||' OFD: type: string description: '| OFD handler code. Available OFD handlers:' OFD_SETTINGS: type: object description: '| OFD settings (detailed description provided below).' NUMBER_KKM: type: string description: '| External identifier of the cash register.' ACTIVE: type: string description: '| Activity status of the cash register. Possible values:' SORT: type: integer description: '| Sorting. Default `100` ||' USE_OFFLINE: type: string description: '| Whether the cash register is used offline. Possible values:' SETTINGS: type: array items: {} description: '| Cash register settings according to the settings structure passed in the `CONFIG` key of the `SETTINGS` field of the method sale.cashbox.handler.add.' OFD_MODE: type: object description: '| Settings related to the OFD operation mode. The `IS_TEST` parameter is passed (`string` with values `Y/N`) — OFD operation mode:' SELLER_INFO: type: object description: '| Settings for the "Seller Information" section. The required parameter `INN` (`string`) — seller''s INN is passed' AUTH: type: object description: '| Authorization settings. The `INN` parameter is passed (`string`) — security key' required: - NAME - REST_CODE - EMAIL application/x-www-form-urlencoded: schema: type: object properties: NAME: type: string description: '| Name of the cash register ||' REST_CODE: type: string description: '| REST handler code for the cash register. Specified when adding the handler in the method sale.cashbox.handler.add in the `CODE` parameter ||' EMAIL: type: string description: '| Email address to which notifications will be sent in case of errors during receipt printing ||' OFD: type: string description: '| OFD handler code. Available OFD handlers:' OFD_SETTINGS: type: object description: '| OFD settings (detailed description provided below).' NUMBER_KKM: type: string description: '| External identifier of the cash register.' ACTIVE: type: string description: '| Activity status of the cash register. Possible values:' SORT: type: integer description: '| Sorting. Default `100` ||' USE_OFFLINE: type: string description: '| Whether the cash register is used offline. Possible values:' SETTINGS: type: array items: {} description: '| Cash register settings according to the settings structure passed in the `CONFIG` key of the `SETTINGS` field of the method sale.cashbox.handler.add.' OFD_MODE: type: object description: '| Settings related to the OFD operation mode. The `IS_TEST` parameter is passed (`string` with values `Y/N`) — OFD operation mode:' SELLER_INFO: type: object description: '| Settings for the "Seller Information" section. The required parameter `INN` (`string`) — seller''s INN is passed' AUTH: type: object description: '| Authorization settings. The `INN` parameter is passed (`string`) — security key' required: - NAME - REST_CODE - EMAIL 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: - sale, cashbox /sale.cashbox.check.apply: post: summary: Save the result of printing the receipt sale.cashbox.check.apply 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 method saves the result of printing a receipt that was printed on a REST cash register. The UUID of the receipt is saved when it is printed from the `PRINT_URL` response specified when adding the handler (see [example of implementing a simple cash register on REST API](../../../tutorials/sale/cashbox-add-example.md)). operationId: sale_cashbox_check_apply tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-check-apply.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: UUID: type: string description: '| UUID of the receipt ||' PRINT_END_TIME: type: string description: '| Time when the receipt printing ended ||' REG_NUMBER_KKT: type: string description: '| Registration number of the cash register ||' FISCAL_DOC_ATTR: type: string description: '| Fiscal attribute of the document ||' FISCAL_DOC_NUMBER: type: string description: '| Fiscal document number ||' FISCAL_RECEIPT_NUMBER: type: string description: '| Fiscal receipt number ||' FN_NUMBER: type: string description: '| Fiscal storage number ||' SHIFT_NUMBER: type: string description: '| Shift number ||' required: - UUID application/x-www-form-urlencoded: schema: type: object properties: UUID: type: string description: '| UUID of the receipt ||' PRINT_END_TIME: type: string description: '| Time when the receipt printing ended ||' REG_NUMBER_KKT: type: string description: '| Registration number of the cash register ||' FISCAL_DOC_ATTR: type: string description: '| Fiscal attribute of the document ||' FISCAL_DOC_NUMBER: type: string description: '| Fiscal document number ||' FISCAL_RECEIPT_NUMBER: type: string description: '| Fiscal receipt number ||' FN_NUMBER: type: string description: '| Fiscal storage number ||' SHIFT_NUMBER: type: string description: '| Shift number ||' required: - UUID 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: - sale, cashbox /sale.cashbox.delete: post: summary: Delete cash register sale.cashbox.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. This method deletes a cash register. operationId: sale_cashbox_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: ID: type: string description: '| Identifier of the cash register to be deleted ||' required: - ID application/x-www-form-urlencoded: schema: type: object properties: ID: type: string description: '| Identifier of the cash register to be deleted ||' required: - 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: - sale, cashbox /sale.cashbox.handler.add: post: summary: Add Cashbox Handler sale.cashbox.handler.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. This method adds a REST cashbox handler. operationId: sale_cashbox_handler_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-handler-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: CODE: type: string description: '| Code of the REST handler. Must be unique among all handlers ||' NAME: type: string description: '| Name of the REST handler ||' SORT: type: integer description: '| Sorting. Default value: `100` ||' SUPPORTS_FFD105: type: string description: '| Indicates whether the cashbox supports fiscal data format version 1.05. Possible values:' SETTINGS: type: object description: '| Handler settings (detailed description provided below) ||' PRINT_URL: type: string description: '| Address to which data for printing the receipt is sent ||' CHECK_URL: type: string description: '| Address for checking the status of the receipt ||' HTTP_VERSION: type: string description: '| Version of the HTTP protocol used for requests. Possible values: `1.0`, `1.1`.' CONFIG: type: object description: '| Structure of settings (detailed description provided below), which the user can set and modify on the cashbox editing page, as well as when adding or updating the cashbox via REST.' LABEL: type: string description: '| Section header ||' ITEMS: type: object description: '| List of settings in the section (detailed description provided below).' TYPE: type: string description: '| Type of setting. Possible values:' REQUIRED: type: string description: '| Indicates whether the setting is required. Possible values:' DISABLED: type: string description: '| Indicates whether editing of the setting is disabled. Possible values:' MULTIPLE: type: string description: '| Indicates whether the setting is multiple. Possible values:' MULTILINE: type: string description: '| Indicates whether the field is multiline. Used for `STRING` type. Possible values:' OPTIONS: type: object description: '| List of possible values for the property. Used for `ENUM` type.' TIME: type: string description: '| Indicates whether time selection is possible. Used for `DATE` type. Possible values:' required: - CODE - NAME - SETTINGS - PRINT_URL - CHECK_URL - CONFIG - LABEL - ITEMS - TYPE - REQUIRED - OPTIONS application/x-www-form-urlencoded: schema: type: object properties: CODE: type: string description: '| Code of the REST handler. Must be unique among all handlers ||' NAME: type: string description: '| Name of the REST handler ||' SORT: type: integer description: '| Sorting. Default value: `100` ||' SUPPORTS_FFD105: type: string description: '| Indicates whether the cashbox supports fiscal data format version 1.05. Possible values:' SETTINGS: type: object description: '| Handler settings (detailed description provided below) ||' PRINT_URL: type: string description: '| Address to which data for printing the receipt is sent ||' CHECK_URL: type: string description: '| Address for checking the status of the receipt ||' HTTP_VERSION: type: string description: '| Version of the HTTP protocol used for requests. Possible values: `1.0`, `1.1`.' CONFIG: type: object description: '| Structure of settings (detailed description provided below), which the user can set and modify on the cashbox editing page, as well as when adding or updating the cashbox via REST.' LABEL: type: string description: '| Section header ||' ITEMS: type: object description: '| List of settings in the section (detailed description provided below).' TYPE: type: string description: '| Type of setting. Possible values:' REQUIRED: type: string description: '| Indicates whether the setting is required. Possible values:' DISABLED: type: string description: '| Indicates whether editing of the setting is disabled. Possible values:' MULTIPLE: type: string description: '| Indicates whether the setting is multiple. Possible values:' MULTILINE: type: string description: '| Indicates whether the field is multiline. Used for `STRING` type. Possible values:' OPTIONS: type: object description: '| List of possible values for the property. Used for `ENUM` type.' TIME: type: string description: '| Indicates whether time selection is possible. Used for `DATE` type. Possible values:' required: - CODE - NAME - SETTINGS - PRINT_URL - CHECK_URL - CONFIG - LABEL - ITEMS - TYPE - REQUIRED - OPTIONS 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: - sale, cashbox /sale.cashbox.handler.delete: post: summary: Delete Cashbox Handler sale.cashbox.handler.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. This method deletes the REST cashbox handler. If there are cashboxes linked to the handler, it will not be deleted — you must first remove the cashboxes. operationId: sale_cashbox_handler_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-handler-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: ID: type: string description: '| Identifier of the cashbox handler to be deleted ||' required: - ID application/x-www-form-urlencoded: schema: type: object properties: ID: type: string description: '| Identifier of the cashbox handler to be deleted ||' required: - 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: - sale, cashbox /sale.cashbox.handler.list: post: summary: Get a list of available cash register handlers sale.cashbox.handler.list 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 method returns a list of available REST cash register handlers. No parameters. operationId: sale_cashbox_handler_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-handler-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: string description: '| List of handlers registered in the system ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description | Status ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: string description: '| List of handlers registered in the system ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description | Status ||' 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: - sale, cashbox /sale.cashbox.handler.update: post: summary: Update Cash Register Handler sale.cashbox.handler.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. This method updates the data of the REST cash register handler. operationId: sale_cashbox_handler_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-handler-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: ID: type: string description: '| Identifier of the handler being updated ||' FIELDS: type: object description: '| Values of the fields to be updated.' required: - ID - FIELDS application/x-www-form-urlencoded: schema: type: object properties: ID: type: string description: '| Identifier of the handler being updated ||' FIELDS: type: object description: '| Values of the fields to be updated.' required: - ID - FIELDS 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: - sale, cashbox /sale.cashbox.list: post: summary: Get a list of configured cash registers sale.cashbox.list 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 method returns a list of configured cash registers. operationId: sale_cashbox_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: SELECT: type: array items: {} description: '| An array with the list of fields to select (see fields of the sale_cashbox object) ||' FILTER: type: object description: '| An object for filtering selected cash registers in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' ORDER: type: object description: '| An object for sorting selected records in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' application/x-www-form-urlencoded: schema: type: object properties: SELECT: type: array items: {} description: '| An array with the list of fields to select (see fields of the sale_cashbox object) ||' FILTER: type: object description: '| An object for filtering selected cash registers in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' ORDER: type: object description: '| An object for sorting selected records in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' 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: - sale, cashbox /sale.cashbox.update: post: summary: Update Existing Cash Register sale.cashbox.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. This method updates an existing cash register. operationId: sale_cashbox_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/cashbox/sale-cashbox-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: ID: type: string description: '| Identifier of the cash register being updated ||' FIELDS: type: object description: '| Values of the fields to be updated (detailed description provided below) ||' NAME: type: string description: '| Name of the cash register ||' EMAIL: type: string description: '| Email address to which notifications will be sent in case of errors during receipt printing ||' OFD: type: string description: '| OFD handler code. Available OFD handlers:' OFD_SETTINGS: type: object description: '| OFD settings (detailed description provided below)' NUMBER_KKM: type: string description: '| External identifier of the cash register ||' ACTIVE: type: string description: 'with value `Y/N` | Activity status of the cash register. Possible values:' SORT: type: integer description: '| Sorting ||' USE_OFFLINE: type: string description: '| Whether the cash register is used offline. Possible values:' SETTINGS: type: object description: '| Cash register settings according to the structure of settings passed in the `CONFIG` key of the `SETTINGS` field of the sale.cashbox.handler.add method ||' OFD_MODE: type: object description: '| Settings related to the OFD operation mode. The `IS_TEST` parameter (`string` with values `Y/N`) is passed — OFD operation mode:' SELLER_INFO: type: object description: '| Settings for the "Seller Information" section. The required parameter `INN` (`string`) is passed — seller''s INN' AUTH: type: object description: '| Authorization settings. The `INN` parameter (`string`) is passed — security key' required: - ID - FIELDS application/x-www-form-urlencoded: schema: type: object properties: ID: type: string description: '| Identifier of the cash register being updated ||' FIELDS: type: object description: '| Values of the fields to be updated (detailed description provided below) ||' NAME: type: string description: '| Name of the cash register ||' EMAIL: type: string description: '| Email address to which notifications will be sent in case of errors during receipt printing ||' OFD: type: string description: '| OFD handler code. Available OFD handlers:' OFD_SETTINGS: type: object description: '| OFD settings (detailed description provided below)' NUMBER_KKM: type: string description: '| External identifier of the cash register ||' ACTIVE: type: string description: 'with value `Y/N` | Activity status of the cash register. Possible values:' SORT: type: integer description: '| Sorting ||' USE_OFFLINE: type: string description: '| Whether the cash register is used offline. Possible values:' SETTINGS: type: object description: '| Cash register settings according to the structure of settings passed in the `CONFIG` key of the `SETTINGS` field of the sale.cashbox.handler.add method ||' OFD_MODE: type: object description: '| Settings related to the OFD operation mode. The `IS_TEST` parameter (`string` with values `Y/N`) is passed — OFD operation mode:' SELLER_INFO: type: object description: '| Settings for the "Seller Information" section. The required parameter `INN` (`string`) is passed — seller''s INN' AUTH: type: object description: '| Authorization settings. The `INN` parameter (`string`) is passed — security key' required: - ID - FIELDS 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: - sale, cashbox /sale.delivery.add: post: summary: Add Delivery Service sale.delivery.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. This method adds a delivery service. operationId: sale_delivery_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery/sale-delivery-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: REST_CODE: type: string description: '| Symbolic code of the delivery service handler (see the `CODE` field of the `sale_delivery_handler` object). ||' NAME: type: string description: '| Name of the delivery service ||' CURRENCY: type: string description: '| Symbolic code of the delivery service currency ||' DESCRIPTION: type: string description: '| Description of the delivery service ||' SORT: type: integer description: '| Sorting ||' ACTIVE: type: string description: '| Indicator of the delivery service''s activity.' CONFIG: type: string description: '| Values of the delivery service settings (detailed description provided below).' LOGOTYPE: type: string description: '| Logo of the delivery service (base64-encoded string) ||' CODE: type: string description: '| Symbolic code of the setting ||' VALUE: type: string description: '| Value of the setting ||' required: - REST_CODE - NAME - CURRENCY - CODE - VALUE application/x-www-form-urlencoded: schema: type: object properties: REST_CODE: type: string description: '| Symbolic code of the delivery service handler (see the `CODE` field of the `sale_delivery_handler` object). ||' NAME: type: string description: '| Name of the delivery service ||' CURRENCY: type: string description: '| Symbolic code of the delivery service currency ||' DESCRIPTION: type: string description: '| Description of the delivery service ||' SORT: type: integer description: '| Sorting ||' ACTIVE: type: string description: '| Indicator of the delivery service''s activity.' CONFIG: type: string description: '| Values of the delivery service settings (detailed description provided below).' LOGOTYPE: type: string description: '| Logo of the delivery service (base64-encoded string) ||' CODE: type: string description: '| Symbolic code of the setting ||' VALUE: type: string description: '| Value of the setting ||' required: - REST_CODE - NAME - CURRENCY - CODE - VALUE 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: - sale /sale.delivery.config.get: post: summary: Get Delivery Service Settings sale.delivery.config.get 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. This method retrieves the settings of the delivery service. operationId: sale_delivery_config_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery/sale-delivery-config-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: ID: type: string description: '| Identifier of the delivery service.' required: - ID application/x-www-form-urlencoded: schema: type: object properties: ID: type: string description: '| Identifier of the delivery service.' required: - 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: - sale /sale.delivery.config.update: post: summary: Update Delivery Service Settings sale.delivery.config.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. This method updates the delivery service settings. operationId: sale_delivery_config_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery/sale-delivery-config-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: ID: type: string description: '| Identifier of the delivery service.' CONFIG: type: string description: '| Values of the delivery service settings (detailed description provided below).' CODE: type: string description: '| Symbolic code of the setting ||' VALUE: type: string description: '| Value of the setting ||' required: - ID - CODE - VALUE application/x-www-form-urlencoded: schema: type: object properties: ID: type: string description: '| Identifier of the delivery service.' CONFIG: type: string description: '| Values of the delivery service settings (detailed description provided below).' CODE: type: string description: '| Symbolic code of the setting ||' VALUE: type: string description: '| Value of the setting ||' required: - ID - CODE - VALUE 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: - sale /sale.delivery.delete: post: summary: Delete Delivery Service sale.delivery.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. This method deletes a delivery service. operationId: sale_delivery_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery/sale-delivery-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: ID: type: string description: '| Identifier of the delivery service ||' required: - ID application/x-www-form-urlencoded: schema: type: object properties: ID: type: string description: '| Identifier of the delivery service ||' required: - 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: - sale /sale.delivery.extra.service.add: post: summary: Add Delivery Service sale.delivery.extra.service.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. This method adds a delivery service. operationId: sale_delivery_extra_service_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: DELIVERY_ID: type: string description: '| Identifier of the delivery service to which the created service will be linked.' TYPE: type: string description: '| Type of service. Possible values:' NAME: type: string description: '| Name of the service ||' ACTIVE: type: string description: '| Indicator of service activity. Possible values:' CODE: type: string description: '| Symbolic code of the service ||' SORT: type: integer description: '| Sorting ||' DESCRIPTION: type: string description: '| Description of the service ||' PRICE: type: number format: double description: '| Cost of the service in the currency of the delivery service.' ITEMS: type: string description: '| List of available options for selection (detailed description provided below).' TITLE: type: string description: '| Name of the list option ||' required: - DELIVERY_ID - TYPE - NAME - ITEMS - TITLE application/x-www-form-urlencoded: schema: type: object properties: DELIVERY_ID: type: string description: '| Identifier of the delivery service to which the created service will be linked.' TYPE: type: string description: '| Type of service. Possible values:' NAME: type: string description: '| Name of the service ||' ACTIVE: type: string description: '| Indicator of service activity. Possible values:' CODE: type: string description: '| Symbolic code of the service ||' SORT: type: integer description: '| Sorting ||' DESCRIPTION: type: string description: '| Description of the service ||' PRICE: type: number format: double description: '| Cost of the service in the currency of the delivery service.' ITEMS: type: string description: '| List of available options for selection (detailed description provided below).' TITLE: type: string description: '| Name of the list option ||' required: - DELIVERY_ID - TYPE - NAME - ITEMS - TITLE 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: - sale, delivery /sale.delivery.extra.service.delete: post: summary: Delete the delivery service sale.delivery.extra.service.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. This method deletes a delivery service. operationId: sale_delivery_extra_service_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: ID: type: string description: '| Identifier of the service.' required: - ID application/x-www-form-urlencoded: schema: type: object properties: ID: type: string description: '| Identifier of the service.' required: - 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: - sale, delivery /sale.delivery.extra.service.get: post: summary: Get Information About All Services of a Specific Delivery Service sale.delivery.extra.service.get 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. This method retrieves information about all services of a specific delivery service. operationId: sale_delivery_extra_service_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: DELIVERY_ID: type: string description: '| Identifier of the delivery service ||' required: - DELIVERY_ID application/x-www-form-urlencoded: schema: type: object properties: DELIVERY_ID: type: string description: '| Identifier of the delivery service ||' required: - DELIVERY_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: - sale, delivery /sale.delivery.extra.service.update: post: summary: Update Delivery Service sale.delivery.extra.service.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. This method updates the delivery service. operationId: sale_delivery_extra_service_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/extra-service/sale-delivery-extra-service-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: ID: type: string description: '| Identifier of the service.' NAME: type: string description: '| Name of the service ||' ACTIVE: type: string description: '| Indicator of the service''s activity. Possible values:' CODE: type: string description: '| Symbolic code of the service ||' SORT: type: integer description: '| Sorting ||' DESCRIPTION: type: string description: '| Description of the service ||' PRICE: type: number format: double description: '| Cost of the service in the delivery service''s currency.' ITEMS: type: string description: '| List of available options for selection (detailed description provided below).' TITLE: type: string description: '| Name of the list option ||' required: - ID - TITLE application/x-www-form-urlencoded: schema: type: object properties: ID: type: string description: '| Identifier of the service.' NAME: type: string description: '| Name of the service ||' ACTIVE: type: string description: '| Indicator of the service''s activity. Possible values:' CODE: type: string description: '| Symbolic code of the service ||' SORT: type: integer description: '| Sorting ||' DESCRIPTION: type: string description: '| Description of the service ||' PRICE: type: number format: double description: '| Cost of the service in the delivery service''s currency.' ITEMS: type: string description: '| List of available options for selection (detailed description provided below).' TITLE: type: string description: '| Name of the list option ||' required: - ID - TITLE 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: - sale, delivery /sale.delivery.getlist: post: summary: Get a list of delivery services sale.delivery.getlist 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. This method retrieves a list of delivery services. operationId: sale_delivery_getlist tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery/sale-delivery-get-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: SELECT: type: array items: {} description: '| An array containing the list of fields to select (see fields of the object `sale_delivery_service`).' FILTER: type: object description: '| An object for filtering the selected delivery services in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' ORDER: type: object description: '| An object for sorting the selected delivery services in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' application/x-www-form-urlencoded: schema: type: object properties: SELECT: type: array items: {} description: '| An array containing the list of fields to select (see fields of the object `sale_delivery_service`).' FILTER: type: object description: '| An object for filtering the selected delivery services in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' ORDER: type: object description: '| An object for sorting the selected delivery services in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' 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: - sale /sale.delivery.handler.add: post: summary: Add Delivery Service Handler sale.delivery.handler.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. This method adds a delivery service handler. operationId: sale_delivery_handler_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/handler/sale-delivery-handler-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: NAME: type: string description: '| Name of the delivery service handler ||' CODE: type: string description: '| Symbolic code of the delivery service handler ||' SORT: type: integer description: '| Sorting ||' DESCRIPTION: type: integer description: '| Description of the delivery service handler ||' SETTINGS: type: object description: '| Object containing information about the settings of the delivery service handler (detailed description provided below) ||' PROFILES: type: string description: '| Array containing a list of delivery profile objects (detailed description provided below).' CALCULATE_URL: type: string description: '| URL for calculating delivery cost.' CREATE_DELIVERY_REQUEST_URL: type: string description: '| URL for creating a delivery order.' CANCEL_DELIVERY_REQUEST_URL: type: string description: '| URL for canceling a delivery order.' HAS_CALLBACK_TRACKING_SUPPORT: type: string description: '| Indicator of whether the delivery service will send notifications about the status of the delivery order (see method `sale.delivery.request.sendmessage`).' TYPE: type: string description: '| Type of the setting field' OPTIONS: type: object description: '| List of options for selection. Object in the format `key=value`. Where key is the option code, and value is the option.' required: - NAME - CODE - SETTINGS - PROFILES - CALCULATE_URL - TYPE application/x-www-form-urlencoded: schema: type: object properties: NAME: type: string description: '| Name of the delivery service handler ||' CODE: type: string description: '| Symbolic code of the delivery service handler ||' SORT: type: integer description: '| Sorting ||' DESCRIPTION: type: integer description: '| Description of the delivery service handler ||' SETTINGS: type: object description: '| Object containing information about the settings of the delivery service handler (detailed description provided below) ||' PROFILES: type: string description: '| Array containing a list of delivery profile objects (detailed description provided below).' CALCULATE_URL: type: string description: '| URL for calculating delivery cost.' CREATE_DELIVERY_REQUEST_URL: type: string description: '| URL for creating a delivery order.' CANCEL_DELIVERY_REQUEST_URL: type: string description: '| URL for canceling a delivery order.' HAS_CALLBACK_TRACKING_SUPPORT: type: string description: '| Indicator of whether the delivery service will send notifications about the status of the delivery order (see method `sale.delivery.request.sendmessage`).' TYPE: type: string description: '| Type of the setting field' OPTIONS: type: object description: '| List of options for selection. Object in the format `key=value`. Where key is the option code, and value is the option.' required: - NAME - CODE - SETTINGS - PROFILES - CALCULATE_URL - TYPE 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: - sale /sale.delivery.handler.delete: post: summary: Delete Delivery Service Handler sale.delivery.handler.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. This method deletes the delivery service handler. operationId: sale_delivery_handler_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/handler/sale-delivery-handler-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: ID: type: string description: '| Identifier of the delivery service handler ||' required: - ID application/x-www-form-urlencoded: schema: type: object properties: ID: type: string description: '| Identifier of the delivery service handler ||' required: - 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: - sale /sale.delivery.handler.list: post: summary: Get a list of delivery service handlers sale.delivery.handler.list 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. This method retrieves a list of delivery service handlers. No parameters. operationId: sale_delivery_handler_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/handler/sale-delivery-handler-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: string description: '| Array of objects with information about the selected delivery service handlers ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description | Status ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: string description: '| Array of objects with information about the selected delivery service handlers ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description | Status ||' 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: - sale /sale.delivery.handler.update: post: summary: Update Delivery Service Handler sale.delivery.handler.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. This method updates the delivery service handler. operationId: sale_delivery_handler_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/handler/sale-delivery-handler-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: ID: type: string description: '| Identifier of the delivery service handler.' NAME: type: string description: '| Name of the delivery service handler ||' CODE: type: string description: '| Symbolic code of the delivery service handler ||' SORT: type: integer description: '| Sorting ||' DESCRIPTION: type: string description: '| Description of the delivery service handler ||' SETTINGS: type: object description: '| An object containing information about the settings of the delivery service handler (detailed description provided below) ||' PROFILES: type: string description: '| An array containing a list of delivery profile objects (detailed description provided below).' CALCULATE_URL: type: string description: '| URL for calculating delivery cost.' CREATE_DELIVERY_REQUEST_URL: type: string description: '| URL for creating a delivery order.' CANCEL_DELIVERY_REQUEST_URL: type: string description: '| URL for canceling a delivery order.' HAS_CALLBACK_TRACKING_SUPPORT: type: string description: '| Indicator of whether the delivery service will send notifications about the status of the delivery order (see method `sale.delivery.request.sendmessage`).' TYPE: type: string description: '| Type of the setting field' OPTIONS: type: object description: '| List of options for selection. An object in the format `key=value`. Where the key is the option code, and the value is the option.' required: - ID - CALCULATE_URL - TYPE application/x-www-form-urlencoded: schema: type: object properties: ID: type: string description: '| Identifier of the delivery service handler.' NAME: type: string description: '| Name of the delivery service handler ||' CODE: type: string description: '| Symbolic code of the delivery service handler ||' SORT: type: integer description: '| Sorting ||' DESCRIPTION: type: string description: '| Description of the delivery service handler ||' SETTINGS: type: object description: '| An object containing information about the settings of the delivery service handler (detailed description provided below) ||' PROFILES: type: string description: '| An array containing a list of delivery profile objects (detailed description provided below).' CALCULATE_URL: type: string description: '| URL for calculating delivery cost.' CREATE_DELIVERY_REQUEST_URL: type: string description: '| URL for creating a delivery order.' CANCEL_DELIVERY_REQUEST_URL: type: string description: '| URL for canceling a delivery order.' HAS_CALLBACK_TRACKING_SUPPORT: type: string description: '| Indicator of whether the delivery service will send notifications about the status of the delivery order (see method `sale.delivery.request.sendmessage`).' TYPE: type: string description: '| Type of the setting field' OPTIONS: type: object description: '| List of options for selection. An object in the format `key=value`. Where the key is the option code, and the value is the option.' required: - ID - CALCULATE_URL - TYPE 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: - sale /sale.delivery.request.delete: post: summary: Delete Delivery Request sale.delivery.request.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. This method deletes a delivery request. operationId: sale_delivery_request_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery-request/sale-delivery-request-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: DELIVERY_ID: type: string description: '| Identifier of the delivery service to which the delivery request belongs.' REQUEST_ID: type: string description: '| Identifier of the delivery request.' required: - DELIVERY_ID - REQUEST_ID application/x-www-form-urlencoded: schema: type: object properties: DELIVERY_ID: type: string description: '| Identifier of the delivery service to which the delivery request belongs.' REQUEST_ID: type: string description: '| Identifier of the delivery request.' required: - DELIVERY_ID - REQUEST_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: - sale, delivery /sale.delivery.request.sendmessage: post: summary: Create Notifications for Delivery Request sale.delivery.request.sendmessage 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. This method creates notifications for a delivery request. operationId: sale_delivery_request_sendmessage tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery-request/sale-delivery-request-send-message.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: DELIVERY_ID: type: string description: '| Identifier of the delivery service related to the delivery request.' REQUEST_ID: type: string description: '| Identifier of the delivery request.' ADDRESSEE: type: string description: '| Recipient of the message.' MESSAGE: type: object description: '| Message (detailed description provided below)' SUBJECT: type: string description: '| Subject of the message.' BODY: type: string description: '| Body of the message.' STATUS: type: object description: '| Status of the message (detailed description provided below)' MONEY_VALUES: type: object description: '| Object in the format `key => value`.' SEMANTIC: type: string description: '| Value of the status semantics.' required: - DELIVERY_ID - REQUEST_ID - ADDRESSEE - MESSAGE - SUBJECT - BODY - SEMANTIC application/x-www-form-urlencoded: schema: type: object properties: DELIVERY_ID: type: string description: '| Identifier of the delivery service related to the delivery request.' REQUEST_ID: type: string description: '| Identifier of the delivery request.' ADDRESSEE: type: string description: '| Recipient of the message.' MESSAGE: type: object description: '| Message (detailed description provided below)' SUBJECT: type: string description: '| Subject of the message.' BODY: type: string description: '| Body of the message.' STATUS: type: object description: '| Status of the message (detailed description provided below)' MONEY_VALUES: type: object description: '| Object in the format `key => value`.' SEMANTIC: type: string description: '| Value of the status semantics.' required: - DELIVERY_ID - REQUEST_ID - ADDRESSEE - MESSAGE - SUBJECT - BODY - SEMANTIC 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: - sale, delivery /sale.delivery.request.update: post: summary: Update Delivery Request sale.delivery.request.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. This method updates the delivery request. operationId: sale_delivery_request_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery-request/sale-delivery-request-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: DELIVERY_ID: type: string description: '| Identifier of the delivery service to which the delivery request belongs.' REQUEST_ID: type: string description: '| Identifier of the delivery request.' FINALIZE: type: string description: '| Indicator of the need to finalize the delivery request.' STATUS: type: object description: '| Status of the delivery request (detailed description provided below) ||' PROPERTIES: type: string description: '| Properties of the delivery request (detailed description provided below) ||' OVERWRITE_PROPERTIES: type: string description: '| Indicator of the need to completely overwrite the property values of the request during the update.' TEXT: type: string description: '| Text name of the delivery request status ||' SEMANTIC: type: string description: '| Semantic value of the status.' NAME: type: string description: '| Name of the property ||' VALUE: type: string description: '| Value of the property ||' TAGS: type: string description: '| List of tags.' required: - DELIVERY_ID - REQUEST_ID - TEXT - SEMANTIC - NAME - VALUE application/x-www-form-urlencoded: schema: type: object properties: DELIVERY_ID: type: string description: '| Identifier of the delivery service to which the delivery request belongs.' REQUEST_ID: type: string description: '| Identifier of the delivery request.' FINALIZE: type: string description: '| Indicator of the need to finalize the delivery request.' STATUS: type: object description: '| Status of the delivery request (detailed description provided below) ||' PROPERTIES: type: string description: '| Properties of the delivery request (detailed description provided below) ||' OVERWRITE_PROPERTIES: type: string description: '| Indicator of the need to completely overwrite the property values of the request during the update.' TEXT: type: string description: '| Text name of the delivery request status ||' SEMANTIC: type: string description: '| Semantic value of the status.' NAME: type: string description: '| Name of the property ||' VALUE: type: string description: '| Value of the property ||' TAGS: type: string description: '| List of tags.' required: - DELIVERY_ID - REQUEST_ID - TEXT - SEMANTIC - NAME - VALUE 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: - sale, delivery /sale.delivery.update: post: summary: Update Delivery Service sale.delivery.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. This method updates the delivery service. operationId: sale_delivery_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/delivery/delivery/sale-delivery-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: ID: type: string description: '| Identifier of the delivery service.' NAME: type: string description: '| Name of the delivery service ||' CURRENCY: type: string description: '| Currency symbol code of the delivery service ||' DESCRIPTION: type: string description: '| Description of the delivery service ||' SORT: type: integer description: '| Sorting ||' ACTIVE: type: string description: '| Indicator of the delivery service''s activity.' LOGOTYPE: type: string description: '| Logo of the delivery service (base64-encoded string) ||' required: - ID application/x-www-form-urlencoded: schema: type: object properties: ID: type: string description: '| Identifier of the delivery service.' NAME: type: string description: '| Name of the delivery service ||' CURRENCY: type: string description: '| Currency symbol code of the delivery service ||' DESCRIPTION: type: string description: '| Description of the delivery service ||' SORT: type: integer description: '| Sorting ||' ACTIVE: type: string description: '| Indicator of the delivery service''s activity.' LOGOTYPE: type: string description: '| Logo of the delivery service (base64-encoded string) ||' required: - 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: - sale /sale.order.add: post: summary: Add Order sale.order.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 method `sale.order.add` is designed for adding an order. operationId: sale_order_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/order/sale-order-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values for creating an order ||' lid: type: string description: '| Identifier of the site where this payer type will be used. Has a constant value ''s1'' ||' personTypeId: type: string description: '| Identifier of the payer type ||' currency: type: string description: '| Currency. The list of currencies can be obtained via the method crm.currency.list ||' price: type: number format: double description: '| Price ||' discountValue: type: number format: double description: '| Discount value ||' statusId: type: string description: '| Identifier of the order status ||' empStatusId: type: string description: '| Identifier of the user who changed the order status ||' dateInsert: type: string format: date-time description: '| Order creation date ||' marked: type: string description: '| Marking flag. Indicates whether the shipment is marked as problematic. The value `Y` is set automatically if an error occurred during saving.' empMarkedId: type: string description: '| Identifier of the user who set the marking ||' reasonMarked: type: string description: '| Reason for marking the order ||' userDescription: type: string description: '| Customer''s comment on the order ||' additionalInfo: type: string description: '| Deprecated.' comments: type: string description: '| Manager''s comment on the order ||' responsibleId: type: string description: '| Identifier of the user responsible for the order ||' recurringId: type: integer description: '| Identifier for subscription renewal ||' lockedBy: type: string description: '| Relevant only for on-premise.' recountFlag: type: string description: '| Deprecated.' affiliateId: type: integer description: '| Relevant only for on-premise.' updated1c: type: string description: '| Updated via QuickBooks and other similar platforms.' orderTopic: type: string description: '| Deprecated.' xmlId: type: string description: '| External identifier ||' id1c: type: string description: '| Identifier in QuickBooks and other similar platforms ||' version1c: type: string description: '| Version in QuickBooks and other similar platforms ||' externalOrder: type: string description: '| Whether the order is from an external system.' canceled: type: string description: '| Whether the order was canceled.' empCanceledId: type: string description: '| Identifier of the user who canceled the order ||' reasonCanceled: type: string description: '| Reason for cancellation ||' userId: type: string description: '| Identifier of the client ||' required: - fields - lid - personTypeId - currency application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values for creating an order ||' lid: type: string description: '| Identifier of the site where this payer type will be used. Has a constant value ''s1'' ||' personTypeId: type: string description: '| Identifier of the payer type ||' currency: type: string description: '| Currency. The list of currencies can be obtained via the method crm.currency.list ||' price: type: number format: double description: '| Price ||' discountValue: type: number format: double description: '| Discount value ||' statusId: type: string description: '| Identifier of the order status ||' empStatusId: type: string description: '| Identifier of the user who changed the order status ||' dateInsert: type: string format: date-time description: '| Order creation date ||' marked: type: string description: '| Marking flag. Indicates whether the shipment is marked as problematic. The value `Y` is set automatically if an error occurred during saving.' empMarkedId: type: string description: '| Identifier of the user who set the marking ||' reasonMarked: type: string description: '| Reason for marking the order ||' userDescription: type: string description: '| Customer''s comment on the order ||' additionalInfo: type: string description: '| Deprecated.' comments: type: string description: '| Manager''s comment on the order ||' responsibleId: type: string description: '| Identifier of the user responsible for the order ||' recurringId: type: integer description: '| Identifier for subscription renewal ||' lockedBy: type: string description: '| Relevant only for on-premise.' recountFlag: type: string description: '| Deprecated.' affiliateId: type: integer description: '| Relevant only for on-premise.' updated1c: type: string description: '| Updated via QuickBooks and other similar platforms.' orderTopic: type: string description: '| Deprecated.' xmlId: type: string description: '| External identifier ||' id1c: type: string description: '| Identifier in QuickBooks and other similar platforms ||' version1c: type: string description: '| Version in QuickBooks and other similar platforms ||' externalOrder: type: string description: '| Whether the order is from an external system.' canceled: type: string description: '| Whether the order was canceled.' empCanceledId: type: string description: '| Identifier of the user who canceled the order ||' reasonCanceled: type: string description: '| Reason for cancellation ||' userId: type: string description: '| Identifier of the client ||' required: - fields - lid - personTypeId - currency 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: - sale /sale.order.delete: post: summary: Delete Order and Related Objects sale.order.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 `sale.order.delete` method is designed to delete an order and its related objects. operationId: sale_order_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/order/sale-order-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Order identifier ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Order identifier ||' required: - 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: - sale /sale.order.get: post: summary: Get Order Field Values and Related Objects sale.order.get 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 method `sale.order.get` is designed to retrieve values for all fields of an order and related objects. operationId: sale_order_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/order/sale-order-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Order identifier ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Order identifier ||' required: - 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: - sale /sale.order.getfields: post: summary: Get Order Fields sale.order.getfields 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 method `sale.order.getfields` retrieves the available fields of an order. No parameters. operationId: sale_order_getfields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/order/sale-order-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' order: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Where `field` is the identifier of the sale_order object, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' order: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Where `field` is the identifier of the sale_order object, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.order.list: post: summary: Get the list of orders sale.order.list 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 method `sale.order.list` retrieves a list of orders. operationId: sale_order_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/order/sale-order-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to be selected (see fields of the sale_order object).' filter: type: object description: '| An object for filtering the selected orders in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected orders in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to be selected (see fields of the sale_order object).' filter: type: object description: '| An object for filtering the selected orders in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected orders in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' 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: - sale /sale.order.update: post: summary: Update Order sale.order.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 method `sale.order.update` updates the fields of an order. operationId: sale_order_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/order/sale-order-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Order identifier ||' fields: type: object description: '| Field values for updating the order ||' required: - id - fields application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Order identifier ||' fields: type: object description: '| Field values for updating the order ||' required: - id - fields 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: - sale /sale.payment.add: post: summary: Add Payment sale.payment.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. This method adds a new payment. operationId: sale_payment_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment/sale-payment-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values (detailed description provided below) for creating a payment in the form of a structure:' orderId: type: string description: '| Order identifier ||' paySystemId: type: string description: '| Payment system identifier ||' paid: type: string description: '| Payment status:' datePaid: type: string format: date-time description: '| Payment date ||' empPaidId: type: string description: '| Identifier of the user who made the payment ||' psStatus: type: string description: '| Payment system status flag — whether the payment was successful. Options:' psStatusCode: type: string description: '| Payment system status code ||' psStatusDescription: type: string description: '| Description of the payment system''s result ||' psStatusMessage: type: string description: '| Message from the payment system ||' psSum: type: number format: double description: '| Payment system amount ||' psCurrency: type: string description: '| Payment system currency ||' psResponseDate: type: string format: date-time description: '| Payment system response date ||' payVoucherNum: type: string description: '| Payment document number ||' payVoucherDate: type: string format: date-time description: '| Payment document date ||' datePayBefore: type: string format: date-time description: '| Deprecated.' dateBill: type: string format: date-time description: '| Invoice date ||' xmlId: type: string description: '| External identifier ||' sum: type: number format: double description: '| Payment amount ||' companyId: type: integer description: '| Identifier of the company that will receive the payment' payReturnNum: type: string description: '| Return document number ||' priceCod: type: number format: double description: '| Relevant only for on-premise version' payReturnDate: type: string format: date description: '| Return document date ||' empReturnId: type: string description: '| Identifier of the user who processed the return ||' payReturnComment: type: string description: '| Return comment ||' responsibleId: type: string description: '| Identifier of the user responsible for the payment ||' empResponsibleId: type: string description: '| Identifier of the user who assigned the responsible person ||' isReturn: type: string description: '| Was the return processed:' comments: type: string description: '| Payment comments ||' updated1c: type: string description: '| Payment updated via QuickBooks and other similar platforms:' id1c: type: string description: '| Identifier in QuickBooks and other similar platforms ||' version1c: type: string description: '| Payment document version from QuickBooks and other similar platforms ||' externalPayment: type: string description: '| Relevant only for on-premise version' psInvoiceId: type: string description: '| Payment identifier in the payment system ||' marked: type: string description: '| Marking flag. Indicates whether the payment is marked as problematic:' reasonMarked: type: string description: '| Reason for marking ||' empMarkedId: type: string description: '| Identifier of the user who marked the payment ||' required: - fields - orderId - paySystemId application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values (detailed description provided below) for creating a payment in the form of a structure:' orderId: type: string description: '| Order identifier ||' paySystemId: type: string description: '| Payment system identifier ||' paid: type: string description: '| Payment status:' datePaid: type: string format: date-time description: '| Payment date ||' empPaidId: type: string description: '| Identifier of the user who made the payment ||' psStatus: type: string description: '| Payment system status flag — whether the payment was successful. Options:' psStatusCode: type: string description: '| Payment system status code ||' psStatusDescription: type: string description: '| Description of the payment system''s result ||' psStatusMessage: type: string description: '| Message from the payment system ||' psSum: type: number format: double description: '| Payment system amount ||' psCurrency: type: string description: '| Payment system currency ||' psResponseDate: type: string format: date-time description: '| Payment system response date ||' payVoucherNum: type: string description: '| Payment document number ||' payVoucherDate: type: string format: date-time description: '| Payment document date ||' datePayBefore: type: string format: date-time description: '| Deprecated.' dateBill: type: string format: date-time description: '| Invoice date ||' xmlId: type: string description: '| External identifier ||' sum: type: number format: double description: '| Payment amount ||' companyId: type: integer description: '| Identifier of the company that will receive the payment' payReturnNum: type: string description: '| Return document number ||' priceCod: type: number format: double description: '| Relevant only for on-premise version' payReturnDate: type: string format: date description: '| Return document date ||' empReturnId: type: string description: '| Identifier of the user who processed the return ||' payReturnComment: type: string description: '| Return comment ||' responsibleId: type: string description: '| Identifier of the user responsible for the payment ||' empResponsibleId: type: string description: '| Identifier of the user who assigned the responsible person ||' isReturn: type: string description: '| Was the return processed:' comments: type: string description: '| Payment comments ||' updated1c: type: string description: '| Payment updated via QuickBooks and other similar platforms:' id1c: type: string description: '| Identifier in QuickBooks and other similar platforms ||' version1c: type: string description: '| Payment document version from QuickBooks and other similar platforms ||' externalPayment: type: string description: '| Relevant only for on-premise version' psInvoiceId: type: string description: '| Payment identifier in the payment system ||' marked: type: string description: '| Marking flag. Indicates whether the payment is marked as problematic:' reasonMarked: type: string description: '| Reason for marking ||' empMarkedId: type: string description: '| Identifier of the user who marked the payment ||' required: - fields - orderId - paySystemId 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: - sale /sale.payment.delete: post: summary: Delete Payment sale.payment.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. This method deletes a payment. operationId: sale_payment_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment/sale-payment-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object application/x-www-form-urlencoded: schema: type: object 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: - sale /sale.payment.get: post: summary: Get Payment by Id sale.payment.get 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. This method retrieves the values of all payment fields by `Id`. operationId: sale_payment_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment/sale-payment-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Payment identifier ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Payment identifier ||' required: - 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: - sale /sale.payment.getFields: post: summary: Get Payment Fields sale.payment.getFields 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. This method retrieves the available payment fields. No parameters. operationId: sale_payment_getFields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment/sale-payment-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' payment: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Where `field` is the identifier of the object sale_order_payment, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' payment: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Where `field` is the identifier of the object sale_order_payment, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.payment.list: post: summary: Get the list of payments sale.payment.list 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. This method retrieves a list of payments. operationId: sale_payment_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment/sale-payment-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select.' filter: type: object description: '| An object for filtering the selected payments in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected payments in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' result: type: object description: '| The root element of the response ||' payments: type: string description: '| An array of objects containing information about the selected payments ||' total: type: integer description: '| The total number of records found ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select.' filter: type: object description: '| An object for filtering the selected payments in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected payments in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' result: type: object description: '| The root element of the response ||' payments: type: string description: '| An array of objects containing information about the selected payments ||' total: type: integer description: '| The total number of records found ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.payment.update: post: summary: Update Payment sale.payment.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 method `sale.payment.update` is used to update fields of the payment collection item. operationId: sale_payment_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment/sale-payment-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Payment identifier ||' fields: type: object description: '| Field values (detailed description provided below) for creating a payment in the form of a structure:' required: - id - fields application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Payment identifier ||' fields: type: object description: '| Field values (detailed description provided below) for creating a payment in the form of a structure:' required: - id - fields 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: - sale /sale.paymentItemShipment.add: post: summary: Add Payment Binding to Shipment sale.paymentItemShipment.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. This method adds a payment binding to a shipment. operationId: sale_paymentItemShipment_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values (detailed description provided below) for creating a payment binding to a shipment in the form of a structure:' shipmentId: type: string description: '| Shipment identifier ||' paymentId: type: string description: '| Payment identifier ||' xmlId: type: string description: '| External identifier of the record ||' required: - fields - shipmentId - paymentId application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values (detailed description provided below) for creating a payment binding to a shipment in the form of a structure:' shipmentId: type: string description: '| Shipment identifier ||' paymentId: type: string description: '| Payment identifier ||' xmlId: type: string description: '| External identifier of the record ||' required: - fields - shipmentId - paymentId 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: - sale /sale.paymentItemShipment.delete: post: summary: Remove the binding sale.paymentItemShipment.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 method `sale.paymentItemShipment.delete` removes the payment binding to the shipment. operationId: sale_paymentItemShipment_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the payment binding to the shipment ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the payment binding to the shipment ||' required: - 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: - sale /sale.paymentItemShipment.get: post: summary: Get Payment Binding by Id sale.paymentItemShipment.get 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. This method retrieves the payment binding to the shipment by `ID`. operationId: sale_paymentItemShipment_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the payment binding to the shipment ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the payment binding to the shipment ||' required: - 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: - sale /sale.paymentItemShipment.getFields: post: summary: Get Fields for sale.paymentItemShipment.getFields 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. This method retrieves the available fields of the payment item shipment binding table. No parameters. operationId: sale_paymentItemShipment_getFields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' paymentItemShipment: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Where `field` is the identifier of the sale_payment_item_shipment object, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' paymentItemShipment: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Where `field` is the identifier of the sale_payment_item_shipment object, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.paymentItemShipment.list: post: summary: Get a list of bindings sale.paymentItemShipment.list 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. This method retrieves a list of payment bindings to shipments based on a filter. operationId: sale_paymentItemShipment_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to be selected (see fields of the sale_payment_item_shipment object).' filter: type: object description: '| An object for filtering the selected payment bindings to shipments in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected payment bindings to shipments in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to be selected (see fields of the sale_payment_item_shipment object).' filter: type: object description: '| An object for filtering the selected payment bindings to shipments in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected payment bindings to shipments in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' 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: - sale /sale.paymentItemShipment.update: post: summary: Change Payment Binding to Shipment sale.paymentItemShipment.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. This method changes the binding of payment to shipment. operationId: sale_paymentItemShipment_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment-item-shipment/sale-payment-item-shipment-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the payment binding to the shipment ||' fields: type: object description: '| Field values (detailed description provided below) for creating the payment binding to the shipment in the form of a structure:' xmlId: type: string description: '| External identifier of the record ||' required: - id - fields application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the payment binding to the shipment ||' fields: type: object description: '| Field values (detailed description provided below) for creating the payment binding to the shipment in the form of a structure:' xmlId: type: string description: '| External identifier of the record ||' required: - id - fields 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: - sale /sale.paymentitembasket.add: post: summary: Add Basket Item Binding to Payment sale.paymentitembasket.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. This method adds a binding of a basket item to a payment. operationId: sale_paymentitembasket_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment-item-basket/sale-payment-item-basket-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values for creating a binding of a basket item to a payment ||' paymentId: type: string description: '| Payment identifier ||' basketId: type: string description: '| Basket item identifier ||' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External record identifier ||' required: - fields - paymentId - basketId application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values for creating a binding of a basket item to a payment ||' paymentId: type: string description: '| Payment identifier ||' basketId: type: string description: '| Basket item identifier ||' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External record identifier ||' required: - fields - paymentId - basketId 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: - sale /sale.paymentitembasket.delete: post: summary: Delete the binding of the cart item to the payment sale.paymentitembasket.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. This method removes the binding of a cart item to a payment. operationId: sale_paymentitembasket_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment-item-basket/sale-payment-item-basket-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the binding of the cart item to the payment' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the binding of the cart item to the payment' required: - 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: - sale /sale.paymentitembasket.get: post: summary: Get Values of All Fields for the Basket Item Binding to Payment sale.paymentitembasket.get 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. This method retrieves the values of all fields for the basket item binding to payment. operationId: sale_paymentitembasket_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment-item-basket/sale-payment-item-basket-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the basket item binding to payment ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the basket item binding to payment ||' required: - 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: - sale /sale.paymentitembasket.getfields: post: summary: Get Available Fields for Payment Item Basket Bindings sale.paymentitembasket.getfields 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. This method retrieves the available fields for payment item basket bindings. No parameters. operationId: sale_paymentitembasket_getfields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment-item-basket/sale-payment-item-basket-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' paymentItemBasket: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the sale_payment_item_basket object, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' paymentItemBasket: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the sale_payment_item_basket object, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.paymentitembasket.list: post: summary: Get a list of basket item bindings to payments sale.paymentitembasket.list 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. This method retrieves a list of bindings of basket items to payments. operationId: sale_paymentitembasket_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment-item-basket/sale-payment-item-basket-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array with the list of fields to be selected (see fields of the sale_payment_item_basket object).' filter: type: object description: '| An object for filtering the selected bindings of basket items to payments in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected bindings of basket items to payments in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used for managing pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array with the list of fields to be selected (see fields of the sale_payment_item_basket object).' filter: type: object description: '| An object for filtering the selected bindings of basket items to payments in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected bindings of basket items to payments in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used for managing pagination.' 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: - sale /sale.paymentitembasket.update: post: summary: Update the binding of the cart item to the payment sale.paymentitembasket.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. This method updates the binding of the cart item to the payment. operationId: sale_paymentitembasket_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/payment-item-basket/sale-payment-item-basket-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the binding of the cart item to the payment ||' fields: type: object description: '| Field values for updating the binding of the cart item to the payment ||' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External identifier of the record ||' required: - id - fields - quantity application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the binding of the cart item to the payment ||' fields: type: object description: '| Field values for updating the binding of the cart item to the payment ||' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External identifier of the record ||' required: - id - fields - quantity 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: - sale /sale.persontype.add: post: summary: Add payer type sale.persontype.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. This method adds a new payer type. operationId: sale_persontype_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/person-type/sale-person-type-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values (detailed description provided below) for creating a new payer type in the form of a structure:' name: type: string description: '| Name of the payer type ||' code: type: string description: '| Code of the payer type. Must be unique ||' sort: type: string description: '| Sorting. Default value is `150` ||' active: type: string description: '| Active flag. Can take values `Y` / `N`. Default is set to `Y` ||' xmlId: type: string description: '| External identifier.' required: - fields - name application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values (detailed description provided below) for creating a new payer type in the form of a structure:' name: type: string description: '| Name of the payer type ||' code: type: string description: '| Code of the payer type. Must be unique ||' sort: type: string description: '| Sorting. Default value is `150` ||' active: type: string description: '| Active flag. Can take values `Y` / `N`. Default is set to `Y` ||' xmlId: type: string description: '| External identifier.' required: - fields - name 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: - sale /sale.persontype.delete: post: summary: Delete payer type sale.persontype.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. This method deletes a payer type. operationId: sale_persontype_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/person-type/sale-person-type-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the payer type ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the payer type ||' required: - 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: - sale /sale.persontype.get: post: summary: Get the payer type by Id sale.persontype.get 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. This method is used to access the fields of the payer type by its `Id`. operationId: sale_persontype_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/person-type/sale-person-type-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| The payer type number ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| The payer type number ||' required: - 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: - sale /sale.persontype.getFields: post: summary: Get Fields of the Payer Type sale.persontype.getFields 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 method returns fields of the payer type. No parameters. operationId: sale_persontype_getFields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/person-type/sale-person-type-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' personType: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value"}`.' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' personType: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value"}`.' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.persontype.list: post: summary: Get a list of payer types sale.persontype.list 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. This method retrieves a list of payer types. Use the `sale.persontype.list` method when creating a payment system **for orders**. In CRM (for old invoices, deals), the list of payer types is retrieved using the [crm.persontype.list](../../crm/outdated/invoice/crm-person-type-list.md) method. operationId: sale_persontype_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/person-type/sale-person-type-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see fields of the sale_person_type object)' filter: type: object description: '| An object for filtering the selected payer types in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected payer types in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to control pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see fields of the sale_person_type object)' filter: type: object description: '| An object for filtering the selected payer types in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected payer types in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to control pagination.' 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: - sale /sale.persontype.update: post: summary: Change the payer type sale.persontype.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. This method modifies the fields of the payer type. operationId: sale_persontype_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/person-type/sale-person-type-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| The ID of the payer type ||' fields: type: object description: '| Field values (detailed description provided below) for updating the payer type field in the form of a structure:' name: type: string description: '| The name of the payer type ||' code: type: string description: '| The code of the payer type. Must be unique ||' sort: type: string description: '| Sorting. Default value is `150` ||' active: type: string description: '| Activity flag. Can take values `Y` / `N`. Default is set to `Y` ||' xmlId: type: string description: '| External identifier.' required: - id - fields - name application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| The ID of the payer type ||' fields: type: object description: '| Field values (detailed description provided below) for updating the payer type field in the form of a structure:' name: type: string description: '| The name of the payer type ||' code: type: string description: '| The code of the payer type. Must be unique ||' sort: type: string description: '| Sorting. Default value is `150` ||' active: type: string description: '| Activity flag. Can take values `Y` / `N`. Default is set to `Y` ||' xmlId: type: string description: '| External identifier.' required: - id - fields - name 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: - sale /sale.property.add: post: summary: Add Order Property sale.property.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. This method adds an order property. operationId: sale_property_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property/sale-property-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values for creating an order property ||' personTypeId: type: string description: '| Identifier of the payer type ||' propsGroupId: type: string description: '| Identifier of the property group ||' name: type: string description: '| Name of the order property ||' type: type: string description: '| Type of the order property.' code: type: string description: '| Symbolic code of the order property ||' active: type: string description: '| Indicator of the order property’s activity.' util: type: string description: '| Indicator of whether the order property is a system property. System properties are not displayed in the public part.' userProps: type: string description: '| Indicator of whether the order property is included in the customer profile.' isFiltered: type: string description: '| Indicator of whether the order property is available in the filter on the order list page.' sort: type: integer description: '| Sorting ||' description: type: string description: '| Description of the order property ||' required: type: string description: '| Indicator of whether the order property value is required.' multiple: type: string description: '| Indicator of whether the order property is multiple. For multiple properties, several values can be specified.' xmlId: type: string description: '| External identifier of the order property ||' defaultValue: type: string description: '| Default value of the order property.' settings: type: object description: '| An object in the format `{"field_1": "value_1", ... "field_N": "value_N"}` for passing additional settings for the order property.' isProfileName: type: string description: '| Indicator of whether to use the value of this order property as the user profile name.' isPayer: type: string description: '| Indicator of whether to use the value of this order property as the payer''s name.' isEmail: type: string description: '| Indicator of whether to use the value of this order property as an e-mail (e.g., when registering a new user during order placement).' isPhone: type: string description: '| Indicator of whether to use the value of this order property as a phone number.' isZip: type: string description: '| Indicator of whether to use the value of this order property as a postal code.' isAddress: type: string description: '| Indicator of whether to use the value of this order property as an address.' isLocation: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s location for calculating shipping costs.' isLocation4tax: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s location for determining tax rates.' inputFieldLocation: type: string description: '| Deprecated field. Not used ||' isAddressFrom: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s address from which the order needs to be picked up for calculating shipping costs.' isAddressTo: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s address to which the order needs to be delivered for calculating shipping costs.' minlength: type: integer description: '| Minimum allowable length (number of characters) of the order property value ||' maxlength: type: integer description: '| Maximum allowable length (number of characters) of the order property value ||' pattern: type: string description: '| Regular expression for validating the order property value.' multiline: type: string description: '| Indicator of whether to display a multiline input field for the property value. Possible values:' cols: type: integer description: '| Deprecated parameter. Not used ||' rows: type: integer description: '| Deprecated parameter. Not used ||' size: type: integer description: '| Deprecated parameter. Not used ||' min: type: integer description: '| Minimum allowable value for this order property ||' max: type: integer description: '| Maximum allowable value for this order property ||' step: type: integer description: '| Step for changing the value. Used in some user interfaces for convenience in changing the order property value ||' multielement: type: string description: '| Indicator of whether to display the order property as a list of checkboxes.' maxsize: type: integer description: '| Maximum allowable size of the uploaded file in bytes ||' accept: type: string description: '| List of file extensions that are allowed to be uploaded for this order property value. Example: png, doc, zip ||' time: type: string description: '| Indicator of whether to add the option to select time when working with the value of this order property. Value is used in some user interfaces.' required: - fields - personTypeId - propsGroupId - name - type application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values for creating an order property ||' personTypeId: type: string description: '| Identifier of the payer type ||' propsGroupId: type: string description: '| Identifier of the property group ||' name: type: string description: '| Name of the order property ||' type: type: string description: '| Type of the order property.' code: type: string description: '| Symbolic code of the order property ||' active: type: string description: '| Indicator of the order property’s activity.' util: type: string description: '| Indicator of whether the order property is a system property. System properties are not displayed in the public part.' userProps: type: string description: '| Indicator of whether the order property is included in the customer profile.' isFiltered: type: string description: '| Indicator of whether the order property is available in the filter on the order list page.' sort: type: integer description: '| Sorting ||' description: type: string description: '| Description of the order property ||' required: type: string description: '| Indicator of whether the order property value is required.' multiple: type: string description: '| Indicator of whether the order property is multiple. For multiple properties, several values can be specified.' xmlId: type: string description: '| External identifier of the order property ||' defaultValue: type: string description: '| Default value of the order property.' settings: type: object description: '| An object in the format `{"field_1": "value_1", ... "field_N": "value_N"}` for passing additional settings for the order property.' isProfileName: type: string description: '| Indicator of whether to use the value of this order property as the user profile name.' isPayer: type: string description: '| Indicator of whether to use the value of this order property as the payer''s name.' isEmail: type: string description: '| Indicator of whether to use the value of this order property as an e-mail (e.g., when registering a new user during order placement).' isPhone: type: string description: '| Indicator of whether to use the value of this order property as a phone number.' isZip: type: string description: '| Indicator of whether to use the value of this order property as a postal code.' isAddress: type: string description: '| Indicator of whether to use the value of this order property as an address.' isLocation: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s location for calculating shipping costs.' isLocation4tax: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s location for determining tax rates.' inputFieldLocation: type: string description: '| Deprecated field. Not used ||' isAddressFrom: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s address from which the order needs to be picked up for calculating shipping costs.' isAddressTo: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s address to which the order needs to be delivered for calculating shipping costs.' minlength: type: integer description: '| Minimum allowable length (number of characters) of the order property value ||' maxlength: type: integer description: '| Maximum allowable length (number of characters) of the order property value ||' pattern: type: string description: '| Regular expression for validating the order property value.' multiline: type: string description: '| Indicator of whether to display a multiline input field for the property value. Possible values:' cols: type: integer description: '| Deprecated parameter. Not used ||' rows: type: integer description: '| Deprecated parameter. Not used ||' size: type: integer description: '| Deprecated parameter. Not used ||' min: type: integer description: '| Minimum allowable value for this order property ||' max: type: integer description: '| Maximum allowable value for this order property ||' step: type: integer description: '| Step for changing the value. Used in some user interfaces for convenience in changing the order property value ||' multielement: type: string description: '| Indicator of whether to display the order property as a list of checkboxes.' maxsize: type: integer description: '| Maximum allowable size of the uploaded file in bytes ||' accept: type: string description: '| List of file extensions that are allowed to be uploaded for this order property value. Example: png, doc, zip ||' time: type: string description: '| Indicator of whether to add the option to select time when working with the value of this order property. Value is used in some user interfaces.' required: - fields - personTypeId - propsGroupId - name - type 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: - sale /sale.property.delete: post: summary: Delete Order Property sale.property.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. This method deletes an order property. operationId: sale_property_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property/sale-property-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the order property ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the order property ||' required: - 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: - sale /sale.property.get: post: summary: Get Order Property sale.property.get 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. This method retrieves the order property. operationId: sale_property_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property/sale-property-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the order property ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the order property ||' required: - 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: - sale /sale.property.getfieldsbytype: post: summary: Get Fields and Settings of Order Properties for a Specific Property Type sale.property.getfieldsbytype 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 the assistant can utilize the official REST documentation. This method retrieves the available fields of order properties by property type. operationId: sale_property_getfieldsbytype tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property/sale-property-get-fields-by-type.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: type: type: string description: '| Order property type' required: - type application/x-www-form-urlencoded: schema: type: object properties: type: type: string description: '| Order property type' required: - type 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: - sale /sale.property.list: post: summary: Get the list of order properties sale.property.list 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. This method retrieves a list of order properties. operationId: sale_property_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property/sale-property-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see the fields of the sale_order_property object).' filter: type: object description: '| An object for filtering the selected payment bindings to shipments in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected items in the shipment table in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see the fields of the sale_order_property object).' filter: type: object description: '| An object for filtering the selected payment bindings to shipments in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected items in the shipment table in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' 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: - sale /sale.property.update: post: summary: Update Order Property sale.property.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. This method updates the order property. operationId: sale_property_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property/sale-property-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the order property ||' fields: type: object description: '| Field values for creating the order property ||' name: type: string description: '| Name of the order property ||' code: type: string description: '| Symbolic code of the order property ||' active: type: string description: '| Indicator of the order property’s activity.' util: type: string description: '| Indicator of whether the order property is a service property. Service properties are not displayed in the public part.' userProps: type: string description: '| Indicator of whether the order property is included in the customer profile.' isFiltered: type: string description: '| Indicator of whether the order property is available in the filter on the order list page.' sort: type: integer description: '| Sorting ||' description: type: string description: '| Description of the order property ||' required: type: string description: '| Indicator of whether filling in the order property value is mandatory.' multiple: type: string description: '| Indicator of whether the order property is multiple. For multiple properties, it is possible to specify several values.' xmlId: type: string description: '| External identifier of the order property ||' defaultValue: type: string description: '| Default value of the order property.' settings: type: object description: '| An object in the format `{"field_1": "value_1", ... "field_N": "value_N"}` for passing additional settings for the order property.' isProfileName: type: string description: '| Indicator of whether to use the value of this order property as the user profile name.' isPayer: type: string description: '| Indicator of whether to use the value of this order property as the payer''s name.' isEmail: type: string description: '| Indicator of whether to use the value of this order property as an e-mail (e.g., when registering a new user during checkout).' isPhone: type: string description: '| Indicator of whether to use the value of this order property as a phone number.' isZip: type: string description: '| Indicator of whether to use the value of this order property as a postal code.' isAddress: type: string description: '| Indicator of whether to use the value of this order property as an address.' isLocation: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s location for calculating delivery costs.' isLocation4tax: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s location for determining tax rates.' inputFieldLocation: type: string description: '| Deprecated field. Not used. ||' isAddressFrom: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s address from where the order needs to be picked up for calculating delivery costs.' isAddressTo: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s address where the order needs to be delivered for calculating delivery costs.' required: - id - fields - name application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the order property ||' fields: type: object description: '| Field values for creating the order property ||' name: type: string description: '| Name of the order property ||' code: type: string description: '| Symbolic code of the order property ||' active: type: string description: '| Indicator of the order property’s activity.' util: type: string description: '| Indicator of whether the order property is a service property. Service properties are not displayed in the public part.' userProps: type: string description: '| Indicator of whether the order property is included in the customer profile.' isFiltered: type: string description: '| Indicator of whether the order property is available in the filter on the order list page.' sort: type: integer description: '| Sorting ||' description: type: string description: '| Description of the order property ||' required: type: string description: '| Indicator of whether filling in the order property value is mandatory.' multiple: type: string description: '| Indicator of whether the order property is multiple. For multiple properties, it is possible to specify several values.' xmlId: type: string description: '| External identifier of the order property ||' defaultValue: type: string description: '| Default value of the order property.' settings: type: object description: '| An object in the format `{"field_1": "value_1", ... "field_N": "value_N"}` for passing additional settings for the order property.' isProfileName: type: string description: '| Indicator of whether to use the value of this order property as the user profile name.' isPayer: type: string description: '| Indicator of whether to use the value of this order property as the payer''s name.' isEmail: type: string description: '| Indicator of whether to use the value of this order property as an e-mail (e.g., when registering a new user during checkout).' isPhone: type: string description: '| Indicator of whether to use the value of this order property as a phone number.' isZip: type: string description: '| Indicator of whether to use the value of this order property as a postal code.' isAddress: type: string description: '| Indicator of whether to use the value of this order property as an address.' isLocation: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s location for calculating delivery costs.' isLocation4tax: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s location for determining tax rates.' inputFieldLocation: type: string description: '| Deprecated field. Not used. ||' isAddressFrom: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s address from where the order needs to be picked up for calculating delivery costs.' isAddressTo: type: string description: '| Indicator of whether to use the value of this order property as the buyer''s address where the order needs to be delivered for calculating delivery costs.' required: - id - fields - name 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: - sale /sale.propertyRelation.add: post: summary: Add Property Binding sale.propertyRelation.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 method `sale.propertyRelation.add` adds a property binding. operationId: sale_propertyRelation_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-relation/sale-property-relation-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values for creating a property binding ||' entityId: type: integer description: '| Identifier of the object ||' entityType: type: string description: '| Type of the object:' propertyId: type: string description: '| Identifier of the property ||' required: - fields - entityId - entityType - propertyId application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values for creating a property binding ||' entityId: type: integer description: '| Identifier of the object ||' entityType: type: string description: '| Type of the object:' propertyId: type: string description: '| Identifier of the property ||' required: - fields - entityId - entityType - propertyId 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: - sale /sale.propertyRelation.deleteByFilter: post: summary: Remove Property Relation with sale.propertyRelation.deleteByFilter 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 method `sale.propertyRelation.deleteByFilter` removes the property relation. operationId: sale_propertyRelation_deleteByFilter tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-relation/sale-property-relation-delete-by-filter.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values for removing the property relation ||' entityId: type: integer description: '| Entity identifier ||' entityType: type: string description: '| Entity type:' propertyId: type: string description: '| Property identifier ||' required: - fields - entityId - entityType - propertyId application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values for removing the property relation ||' entityId: type: integer description: '| Entity identifier ||' entityType: type: string description: '| Entity type:' propertyId: type: string description: '| Property identifier ||' required: - fields - entityId - entityType - propertyId 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: - sale /sale.propertyRelation.getFields: post: summary: Get Fields of Property Binding sale.propertyRelation.getFields 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 method `sale.propertyRelation.getFields` allows access to the available fields of property binding. operationId: sale_propertyRelation_getFields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-relation/sale-property-relation-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object application/x-www-form-urlencoded: schema: type: object 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: - sale /sale.propertyRelation.list: post: summary: Get a list of property bindings sale.propertyRelation.list 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 method `sale.propertyRelation.list` allows you to retrieve a list of property bindings. operationId: sale_propertyRelation_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-relation/sale-property-relation-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| The array contains a list of fields to select (see fields of the object sale_order_property_relation).' filter: type: object description: '| An object for filtering the selected property bindings in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected property bindings in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| The parameter is used to control pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| The array contains a list of fields to select (see fields of the object sale_order_property_relation).' filter: type: object description: '| An object for filtering the selected property bindings in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected property bindings in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| The parameter is used to control pagination.' 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: - sale /sale.propertygroup.add: post: summary: Create Property Group sale.propertygroup.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. This method creates a property group. operationId: sale_propertygroup_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-group/sale-property-group-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values for creating a property group ||' personTypeId: type: string description: '| Identifier of the payer type ||' name: type: string description: '| Name of the property group ||' sort: type: integer description: '| Sorting ||' required: - fields - personTypeId - name application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values for creating a property group ||' personTypeId: type: string description: '| Identifier of the payer type ||' name: type: string description: '| Name of the property group ||' sort: type: integer description: '| Sorting ||' required: - fields - personTypeId - name 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: - sale /sale.propertygroup.delete: post: summary: Delete Property Group sale.propertygroup.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. This method deletes a property group. operationId: sale_propertygroup_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-group/sale-property-group-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the property group ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the property group ||' required: - 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: - sale /sale.propertygroup.get: post: summary: Get Values of All Fields in a Property Group by ID sale.propertygroup.get 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. This method allows you to retrieve the values of all fields in a property group. operationId: sale_propertygroup_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-group/sale-property-group-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the property group ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the property group ||' required: - 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: - sale /sale.propertygroup.getFields: post: summary: Get Available Fields of Property Groups sale.propertygroup.getFields 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. This method is designed to retrieve the available fields of property groups. No parameters. operationId: sale_propertygroup_getFields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-group/sale-property-group-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' propertyGroup: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object sale_order_property_group, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the execution time of the request ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' propertyGroup: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object sale_order_property_group, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the execution time of the request ||' Code: type: string description: '| Description ||' 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: - sale /sale.propertygroup.list: post: summary: Get a list of property groups sale.propertygroup.list 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. This method is designed to retrieve a list of property groups. operationId: sale_propertygroup_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-group/sale-property-group-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array of fields to select (see fields of the sale_order_property_group object).' filter: type: object description: '| An object for filtering the selected property groups in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected property groups in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array of fields to select (see fields of the sale_order_property_group object).' filter: type: object description: '| An object for filtering the selected property groups in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected property groups in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' 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: - sale /sale.propertygroup.update: post: summary: Update Property Group Fields sale.propertygroup.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. This method updates the fields of a property group. operationId: sale_propertygroup_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-group/sale-property-group-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the property group ||' fields: type: object description: '| Field values for updating the property group ||' required: - id - fields application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the property group ||' fields: type: object description: '| Field values for updating the property group ||' required: - id - fields 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: - sale /sale.propertyvalue.delete: post: summary: Delete Order Property Value sale.propertyvalue.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. This method deletes the value of an order property. operationId: sale_propertyvalue_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-value/sale-property-value-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the property value ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the property value ||' required: - 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: - sale /sale.propertyvalue.get: post: summary: Get Property Value with sale.propertyvalue.get 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. This method retrieves the property value by its identifier. operationId: sale_propertyvalue_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-value/sale-property-value-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the order property value ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the order property value ||' required: - 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: - sale /sale.propertyvalue.getfields: post: summary: Get Available Fields of the Property Value sale.propertyvalue.getfields 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 the assistant can utilize the official REST documentation. This method returns the available fields of the order property value options. operationId: sale_propertyvalue_getfields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-value/sale-property-value-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object application/x-www-form-urlencoded: schema: type: object 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: - sale /sale.propertyvalue.list: post: summary: Get a list of property values sale.propertyvalue.list 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. This method retrieves a list of order property value options. operationId: sale_propertyvalue_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-value/sale-property-value-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array of fields to be selected (see fields of the sale_order_property_value object).' filter: type: object description: '| An object for filtering selected property values in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting selected property values in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array of fields to be selected (see fields of the sale_order_property_value object).' filter: type: object description: '| An object for filtering selected property values in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting selected property values in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' 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: - sale /sale.propertyvalue.modify: post: summary: Change the Value of the Property sale.propertyvalue.modify 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. This method updates the property values of an order. **Please note** that this method accepts **all** property values of the order as input. If values for any properties are not provided, their current values will be removed from the order as a result of the request. operationId: sale_propertyvalue_modify tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-value/sale-property-value-modify.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| The root element that transmits the request parameters in the form of a structure:' order: type: object description: '| An object containing the order ID and property values in the form of a structure:' id: type: string description: '| Order identifier ||' propertyValues: type: string description: '| An array of objects (see the description of the `propertyValues` object below), containing the order property identifier and property value ||' orderPropsId: type: string description: '| Order property identifier ||' value: type: string description: '| Order property value.' required: - fields - order - id - propertyValues - orderPropsId - value application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| The root element that transmits the request parameters in the form of a structure:' order: type: object description: '| An object containing the order ID and property values in the form of a structure:' id: type: string description: '| Order identifier ||' propertyValues: type: string description: '| An array of objects (see the description of the `propertyValues` object below), containing the order property identifier and property value ||' orderPropsId: type: string description: '| Order property identifier ||' value: type: string description: '| Order property value.' required: - fields - order - id - propertyValues - orderPropsId - value 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: - sale /sale.propertyvariant.add: post: summary: Add Property Variant sale.propertyvariant.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. This method adds a variant value for a property. It is applicable only for properties of type `ENUM`. operationId: sale_propertyvariant_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-variant/sale-property-variant-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values for creating a property variant ||' orderPropsId: type: string description: '| Property identifier ||' name: type: string description: '| Name of the property variant value ||' value: type: string description: '| Symbolic code of the property variant value ||' sort: type: integer description: '| Sorting ||' description: type: string description: '| Description of the property variant value ||' required: - fields - orderPropsId - name - value application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values for creating a property variant ||' orderPropsId: type: string description: '| Property identifier ||' name: type: string description: '| Name of the property variant value ||' value: type: string description: '| Symbolic code of the property variant value ||' sort: type: integer description: '| Sorting ||' description: type: string description: '| Description of the property variant value ||' required: - fields - orderPropsId - name - value 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: - sale /sale.propertyvariant.delete: post: summary: Delete Property Variant sale.propertyvariant.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. This method deletes a property variant value of an order. It is applicable only for properties of type `ENUM`. operationId: sale_propertyvariant_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-variant/sale-property-variant-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the property variant ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the property variant ||' required: - 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: - sale /sale.propertyvariant.get: post: summary: Get Property Variant Value by ID sale.propertyvariant.get 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. This method retrieves the variant value of an order property. It is applicable only for properties of type `ENUM`. operationId: sale_propertyvariant_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-variant/sale-property-variant-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the property variant ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the property variant ||' required: - 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: - sale /sale.propertyvariant.getFields: post: summary: Get Available Fields of Property Variant sale.propertyvariant.getFields 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 method returns the available fields of property value variants. No parameters. operationId: sale_propertyvariant_getFields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-variant/sale-property-variant-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' propertyVariant: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object sale_order_property_variant, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' propertyVariant: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object sale_order_property_variant, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.propertyvariant.list: post: summary: Get a list of property variants sale.propertyvariant.list 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 method retrieves a list of property value variants. This method is applicable only for properties of type `ENUM`. operationId: sale_propertyvariant_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-variant/sale-property-variant-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array of fields to be selected (see fields of the object sale_order_property_variant).' filter: type: object description: '| An object for filtering the selected property value variants in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected property value variants in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array of fields to be selected (see fields of the object sale_order_property_variant).' filter: type: object description: '| An object for filtering the selected property value variants in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected property value variants in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' 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: - sale /sale.propertyvariant.update: post: summary: Update Property Variant Fields sale.propertyvariant.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. This method updates the value variant of a property. It is applicable only for properties of type `ENUM`. operationId: sale_propertyvariant_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/property-variant/sale-property-variant-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the property value variant ||' fields: type: object description: '| Field values to update the property value variant ||' name: type: string description: '| Name of the property value variant ||' value: type: string description: '| Value (code) of the property value variant ||' sort: type: integer description: '| Sorting ||' description: type: string description: '| Description of the property value variant ||' required: - id - fields - name - value application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the property value variant ||' fields: type: object description: '| Field values to update the property value variant ||' name: type: string description: '| Name of the property value variant ||' value: type: string description: '| Value (code) of the property value variant ||' sort: type: integer description: '| Sorting ||' description: type: string description: '| Description of the property value variant ||' required: - id - fields - name - value 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: - sale /sale.shipment.add: post: summary: Add Shipment sale.shipment.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. This method adds a shipment. operationId: sale_shipment_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment/sale-shipment-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values for creating a shipment ||' orderId: type: string description: '| Order identifier ||' allowDelivery: type: string description: '| Delivery permission indicator' deducted: type: string description: '| Indicator of whether the shipment has been shipped' deliveryId: type: string description: '| Delivery service identifier ||' statusId: type: string description: '| Delivery status identifier' deliveryDocDate: type: string format: date-time description: '| Shipment document date ||' deliveryDocNum: type: string description: '| Shipment document number ||' trackingNumber: type: string description: '| Shipment identifier ||' basePriceDelivery: type: number format: double description: '| Base delivery cost (without discounts / surcharges).' comments: type: string description: '| Manager''s comment ||' companyId: type: integer description: '| Company identifier from the "Online Store" module.' responsibleId: type: string description: '| Identifier of the user responsible for the shipment ||' xmlId: type: string description: '| External shipment identifier.' required: - fields - orderId - allowDelivery - deducted - deliveryId application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values for creating a shipment ||' orderId: type: string description: '| Order identifier ||' allowDelivery: type: string description: '| Delivery permission indicator' deducted: type: string description: '| Indicator of whether the shipment has been shipped' deliveryId: type: string description: '| Delivery service identifier ||' statusId: type: string description: '| Delivery status identifier' deliveryDocDate: type: string format: date-time description: '| Shipment document date ||' deliveryDocNum: type: string description: '| Shipment document number ||' trackingNumber: type: string description: '| Shipment identifier ||' basePriceDelivery: type: number format: double description: '| Base delivery cost (without discounts / surcharges).' comments: type: string description: '| Manager''s comment ||' companyId: type: integer description: '| Company identifier from the "Online Store" module.' responsibleId: type: string description: '| Identifier of the user responsible for the shipment ||' xmlId: type: string description: '| External shipment identifier.' required: - fields - orderId - allowDelivery - deducted - deliveryId 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: - sale /sale.shipment.delete: post: summary: Delete Shipment sale.shipment.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. This method deletes a shipment. operationId: sale_shipment_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment/sale-shipment-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the shipment ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the shipment ||' required: - 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: - sale /sale.shipment.get: post: summary: Get Shipment Fields sale.shipment.get 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. This method retrieves the values of all shipment fields. operationId: sale_shipment_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment/sale-shipment-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Shipment identifier ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Shipment identifier ||' required: - 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: - sale /sale.shipment.getfields: post: summary: Get Available Shipment Fields sale.shipment.getfields 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. This method retrieves the available shipment fields. No parameters. operationId: sale_shipment_getfields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment/sale-shipment-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' shipment: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object `sale_order_shipment`, and `value` is an object of type `rest_field_description` ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' shipment: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object `sale_order_shipment`, and `value` is an object of type `rest_field_description` ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.shipment.list: post: summary: Get the list of shipments sale.shipment.list 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. This method retrieves a list of shipments. operationId: sale_shipment_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment/sale-shipment-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see fields of the sale_order_shipment object).' filter: type: object description: '| An object for filtering the selected payment bindings to shipments in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected payment bindings to shipments in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see fields of the sale_order_shipment object).' filter: type: object description: '| An object for filtering the selected payment bindings to shipments in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected payment bindings to shipments in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' 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: - sale /sale.shipment.update: post: summary: Update Shipment sale.shipment.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. This method updates a shipment. operationId: sale_shipment_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment/sale-shipment-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Shipment identifier ||' fields: type: object description: '| Field values for updating the shipment ||' allowDelivery: type: string description: '| Indicator of delivery permission.' deducted: type: string description: '| Indicator of whether the shipment has been shipped.' deliveryId: type: string description: '| Delivery service identifier ||' statusId: type: string description: '| Delivery status identifier.' deliveryDocDate: type: string format: date-time description: '| Shipment document date ||' deliveryDocNum: type: string description: '| Shipment document number ||' trackingNumber: type: string description: '| Shipment identifier ||' basePriceDelivery: type: number format: double description: '| Base delivery cost (without discounts / surcharges).' priceDelivery: type: number format: double description: '| Delivery cost.' comments: type: string description: '| Manager''s comment ||' companyId: type: integer description: '| Company identifier from the "Online Store" module.' responsibleId: type: string description: '| Identifier of the user responsible for the shipment ||' xmlId: type: string description: '| External shipment identifier.' required: - id - fields - allowDelivery - deducted - deliveryId application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Shipment identifier ||' fields: type: object description: '| Field values for updating the shipment ||' allowDelivery: type: string description: '| Indicator of delivery permission.' deducted: type: string description: '| Indicator of whether the shipment has been shipped.' deliveryId: type: string description: '| Delivery service identifier ||' statusId: type: string description: '| Delivery status identifier.' deliveryDocDate: type: string format: date-time description: '| Shipment document date ||' deliveryDocNum: type: string description: '| Shipment document number ||' trackingNumber: type: string description: '| Shipment identifier ||' basePriceDelivery: type: number format: double description: '| Base delivery cost (without discounts / surcharges).' priceDelivery: type: number format: double description: '| Delivery cost.' comments: type: string description: '| Manager''s comment ||' companyId: type: integer description: '| Company identifier from the "Online Store" module.' responsibleId: type: string description: '| Identifier of the user responsible for the shipment ||' xmlId: type: string description: '| External shipment identifier.' required: - id - fields - allowDelivery - deducted - deliveryId 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: - sale /sale.shipmentitem.add: post: summary: Add an item to the shipment table part sale.shipmentitem.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 method `sale.shipmentitem.add` adds an item to the shipment table part. operationId: sale_shipmentitem_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-item/sale-shipment-item-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values for creating an item in the shipment table part ||' orderDeliveryId: type: string description: '| Shipment identifier ||' basketId: type: string description: '| Basket identifier ||' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External identifier.' required: - fields - orderDeliveryId - basketId - quantity application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values for creating an item in the shipment table part ||' orderDeliveryId: type: string description: '| Shipment identifier ||' basketId: type: string description: '| Basket identifier ||' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External identifier.' required: - fields - orderDeliveryId - basketId - quantity 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: - sale /sale.shipmentitem.delete: post: summary: Delete Shipment Item from Collection sale.shipmentitem.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 method `sale.shipmentitem.delete` removes an item from the shipment's table part. operationId: sale_shipmentitem_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-item/sale-shipment-item-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the shipment table item ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the shipment table item ||' required: - 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: - sale /sale.shipmentitem.get: post: summary: Accessing Fields of the sale.shipmentitem.get Element 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 `sale.shipmentitem.get` method is designed to retrieve the values of all fields of the shipment item table element. operationId: sale_shipmentitem_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-item/sale-shipment-item-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the shipment item table element ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the shipment item table element ||' required: - 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: - sale /sale.shipmentitem.getfields: post: summary: Get Fields of Shipment Item from sale.shipmentitem.getfields 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 method `sale.shipmentitem.getfields` allows you to retrieve a list of available fields for shipment item table entries. No parameters required. operationId: sale_shipmentitem_getfields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-item/sale-shipment-item-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' shipmentItem: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object `sale_order_shipment_item`, and `value` is an object of type `rest_field_description` ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' shipmentItem: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object `sale_order_shipment_item`, and `value` is an object of type `rest_field_description` ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.shipmentitem.list: post: summary: Get a list of shipment item table elements sale.shipmentitem.list 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 method `sale.shipmentitem.list` allows you to retrieve a list of shipment item table elements. operationId: sale_shipmentitem_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-item/sale-shipment-item-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see fields of the object sale_order_shipment_item).' filter: type: object description: '| An object for filtering the selected shipment item table elements in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected shipment item table elements in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to control pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see fields of the object sale_order_shipment_item).' filter: type: object description: '| An object for filtering the selected shipment item table elements in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected shipment item table elements in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to control pagination.' 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: - sale /sale.shipmentitem.update: post: summary: Update an item in the shipment table part sale.shipmentitem.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 method `sale.shipmentitem.update` updates an item in the shipment table part collection. operationId: sale_shipmentitem_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-item/sale-shipment-item-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the shipment table part item ||' fields: type: object description: '| Field values for updating the shipment table part item ||' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External identifier.' required: - id - fields - quantity application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the shipment table part item ||' fields: type: object description: '| Field values for updating the shipment table part item ||' quantity: type: number format: double description: '| Quantity of the product ||' xmlId: type: string description: '| External identifier.' required: - id - fields - quantity 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: - sale /sale.shipmentproperty.add: post: summary: Add Shipment Property sale.shipmentproperty.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. This method adds a shipment property. operationId: sale_shipmentproperty_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-property/sale-shipment-property-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values for creating a shipment property ||' personTypeId: type: string description: '| Identifier of the payer type ||' propsGroupId: type: string description: '| Identifier of the property group ||' name: type: string description: '| Name of the shipment property ||' type: type: string description: '| Type of the shipment property.' code: type: string description: '| Symbolic code of the shipment property ||' active: type: string description: '| Indicator of the activity status of the shipment property.' util: type: string description: '| Indicator of whether the shipment property is a system property. System properties are not displayed in the public part.' userProps: type: string description: '| Indicator of whether the shipment property is included in the customer profile.' isFiltered: type: string description: '| Indicator of whether the shipment property is available in the filter on the shipment list page.' sort: type: integer description: '| Sorting ||' description: type: string description: '| Description of the shipment property ||' required: type: string description: '| Indicator of whether the value of the shipment property is required.' multiple: type: string description: '| Indicator of whether the shipment property is multiple. For multiple properties, it is possible to specify several values.' xmlId: type: string description: '| External identifier of the shipment property ||' defaultValue: type: string description: '| Default value of the shipment property.' settings: type: object description: '| An object in the format `{"field_1": "value_1", ... "field_N": "value_N"}` for passing additional settings for the shipment property.' isProfileName: type: string description: '| Indicator of whether the value of this shipment property should be used as the user profile name.' isPayer: type: string description: '| Indicator of whether the value of this shipment property should be used as the payer''s name.' isEmail: type: string description: '| Indicator of whether the value of this shipment property should be used as an e-mail (e.g., when registering a new user during order placement).' isPhone: type: string description: '| Indicator of whether the value of this shipment property should be used as a phone number.' isZip: type: string description: '| Indicator of whether the value of this shipment property should be used as a postal code.' isAddress: type: string description: '| Indicator of whether the value of this shipment property should be used as an address.' isLocation: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s location for calculating delivery costs.' isLocation4tax: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s location for determining tax rates.' inputFieldLocation: type: string description: '| Deprecated field. Not used ||' isAddressFrom: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s address from which the order needs to be picked up for calculating delivery costs.' isAddressTo: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s address to which the order needs to be delivered for calculating delivery costs.' minlength: type: integer description: '| Minimum allowable length (number of characters) of the shipment property value ||' maxlength: type: integer description: '| Maximum allowable length (number of characters) of the shipment property value ||' pattern: type: string description: '| Regular expression for validating the shipment property value.' multiline: type: string description: '| Indicator of whether to display a multiline input field for the shipment property value. Possible values:' cols: type: integer description: '| Deprecated parameter. Not used ||' rows: type: integer description: '| Deprecated parameter. Not used ||' size: type: integer description: '| Deprecated parameter. Not used ||' min: type: integer description: '| Minimum allowable value for this shipment property ||' max: type: integer description: '| Maximum allowable value for this shipment property ||' step: type: integer description: '| Step for changing the value. Used in some user interfaces for convenience in changing the shipment property value ||' multielement: type: string description: '| Indicator of whether to display the shipment property as a list of checkboxes.' maxsize: type: integer description: '| Maximum allowable size of the uploaded file in bytes ||' accept: type: string description: '| List of file extensions that are allowed to be uploaded as the value of this shipment property. Example: png, doc, zip ||' time: type: string description: '| Indicator of whether to add the option to select time when working with the value of this shipment property. Value is used in some user interfaces.' required: - fields - personTypeId - propsGroupId - name - type application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values for creating a shipment property ||' personTypeId: type: string description: '| Identifier of the payer type ||' propsGroupId: type: string description: '| Identifier of the property group ||' name: type: string description: '| Name of the shipment property ||' type: type: string description: '| Type of the shipment property.' code: type: string description: '| Symbolic code of the shipment property ||' active: type: string description: '| Indicator of the activity status of the shipment property.' util: type: string description: '| Indicator of whether the shipment property is a system property. System properties are not displayed in the public part.' userProps: type: string description: '| Indicator of whether the shipment property is included in the customer profile.' isFiltered: type: string description: '| Indicator of whether the shipment property is available in the filter on the shipment list page.' sort: type: integer description: '| Sorting ||' description: type: string description: '| Description of the shipment property ||' required: type: string description: '| Indicator of whether the value of the shipment property is required.' multiple: type: string description: '| Indicator of whether the shipment property is multiple. For multiple properties, it is possible to specify several values.' xmlId: type: string description: '| External identifier of the shipment property ||' defaultValue: type: string description: '| Default value of the shipment property.' settings: type: object description: '| An object in the format `{"field_1": "value_1", ... "field_N": "value_N"}` for passing additional settings for the shipment property.' isProfileName: type: string description: '| Indicator of whether the value of this shipment property should be used as the user profile name.' isPayer: type: string description: '| Indicator of whether the value of this shipment property should be used as the payer''s name.' isEmail: type: string description: '| Indicator of whether the value of this shipment property should be used as an e-mail (e.g., when registering a new user during order placement).' isPhone: type: string description: '| Indicator of whether the value of this shipment property should be used as a phone number.' isZip: type: string description: '| Indicator of whether the value of this shipment property should be used as a postal code.' isAddress: type: string description: '| Indicator of whether the value of this shipment property should be used as an address.' isLocation: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s location for calculating delivery costs.' isLocation4tax: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s location for determining tax rates.' inputFieldLocation: type: string description: '| Deprecated field. Not used ||' isAddressFrom: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s address from which the order needs to be picked up for calculating delivery costs.' isAddressTo: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s address to which the order needs to be delivered for calculating delivery costs.' minlength: type: integer description: '| Minimum allowable length (number of characters) of the shipment property value ||' maxlength: type: integer description: '| Maximum allowable length (number of characters) of the shipment property value ||' pattern: type: string description: '| Regular expression for validating the shipment property value.' multiline: type: string description: '| Indicator of whether to display a multiline input field for the shipment property value. Possible values:' cols: type: integer description: '| Deprecated parameter. Not used ||' rows: type: integer description: '| Deprecated parameter. Not used ||' size: type: integer description: '| Deprecated parameter. Not used ||' min: type: integer description: '| Minimum allowable value for this shipment property ||' max: type: integer description: '| Maximum allowable value for this shipment property ||' step: type: integer description: '| Step for changing the value. Used in some user interfaces for convenience in changing the shipment property value ||' multielement: type: string description: '| Indicator of whether to display the shipment property as a list of checkboxes.' maxsize: type: integer description: '| Maximum allowable size of the uploaded file in bytes ||' accept: type: string description: '| List of file extensions that are allowed to be uploaded as the value of this shipment property. Example: png, doc, zip ||' time: type: string description: '| Indicator of whether to add the option to select time when working with the value of this shipment property. Value is used in some user interfaces.' required: - fields - personTypeId - propsGroupId - name - type 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: - sale /sale.shipmentproperty.delete: post: summary: Delete Shipment Property sale.shipmentproperty.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. This method deletes a shipment property. operationId: sale_shipmentproperty_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-property/sale-shipment-property-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the shipment property ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the shipment property ||' required: - 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: - sale /sale.shipmentproperty.get: post: summary: Get Shipment Property sale.shipmentproperty.get 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. This method retrieves the shipment property. operationId: sale_shipmentproperty_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-property/sale-shipment-property-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the shipment property ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the shipment property ||' required: - 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: - sale /sale.shipmentproperty.getfieldsbytype: post: summary: Get Fields and Settings of Shipment Property for a Specific Property Type sale.shipmentproperty.getfieldsbytype 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. This method retrieves the available fields of shipment properties by property type. operationId: sale_shipmentproperty_getfieldsbytype tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-property/sale-shipment-property-get-fields-by-type.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: type: type: string description: '| Shipment property type' required: - type application/x-www-form-urlencoded: schema: type: object properties: type: type: string description: '| Shipment property type' required: - type 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: - sale /sale.shipmentproperty.list: post: summary: Get a list of shipment properties sale.shipmentproperty.list 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 method retrieves a list of shipment properties. operationId: sale_shipmentproperty_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-property/sale-shipment-property-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see the fields of the sale_shipment_property object).' filter: type: object description: '| An object for filtering the selected shipment properties in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected shipment properties in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see the fields of the sale_shipment_property object).' filter: type: object description: '| An object for filtering the selected shipment properties in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected shipment properties in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' 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: - sale /sale.shipmentproperty.update: post: summary: Update Shipment Property sale.shipmentproperty.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. This method updates the shipment property. operationId: sale_shipmentproperty_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-property/sale-shipment-property-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the shipment property ||' fields: type: object description: '| Field values for updating the shipment property ||' name: type: string description: '| Name of the shipment property ||' code: type: string description: '| Symbolic code of the shipment property ||' active: type: string description: '| Indicator of whether the shipment property is active.' util: type: string description: '| Indicator of whether the shipment property is a system property. System properties are not displayed in the public part.' userProps: type: string description: '| Indicator of whether the shipment property is included in the customer profile.' isFiltered: type: string description: '| Indicator of whether the shipment property is available in the filter on the shipment list page.' sort: type: integer description: '| Sorting ||' description: type: string description: '| Description of the shipment property ||' required: type: string description: '| Indicator of whether filling in the shipment property value is mandatory.' multiple: type: string description: '| Indicator of whether the order property is multiple. For multiple properties, it is possible to specify several values.' xmlId: type: string description: '| External identifier of the shipment property ||' defaultValue: type: string description: '| Default value of the shipment property.' settings: type: object description: '| An object in the format {"field_1": "value_1", ... "field_N": "value_N"} for passing additional settings for the shipment property.' isProfileName: type: string description: '| Indicator of whether the value of this shipment property should be used as the user''s profile name.' isPayer: type: string description: '| Indicator of whether the value of this shipment property should be used as the payer''s name.' isEmail: type: string description: '| Indicator of whether the value of this shipment property should be used as an e-mail (e.g., when registering a new user during order placement).' isPhone: type: string description: '| Indicator of whether the value of this shipment property should be used as a phone number.' isZip: type: string description: '| Indicator of whether the value of this shipment property should be used as a postal code.' isAddress: type: string description: '| Indicator of whether the value of this shipment property should be used as an address.' isLocation: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s location for calculating delivery costs.' isLocation4tax: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s location for determining tax rates.' inputFieldLocation: type: string description: '| Deprecated field. Not used ||' isAddressFrom: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s address from which the order needs to be picked up for calculating delivery costs.' isAddressTo: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s address to which the order needs to be delivered for calculating delivery costs.' required: - id - fields - name application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the shipment property ||' fields: type: object description: '| Field values for updating the shipment property ||' name: type: string description: '| Name of the shipment property ||' code: type: string description: '| Symbolic code of the shipment property ||' active: type: string description: '| Indicator of whether the shipment property is active.' util: type: string description: '| Indicator of whether the shipment property is a system property. System properties are not displayed in the public part.' userProps: type: string description: '| Indicator of whether the shipment property is included in the customer profile.' isFiltered: type: string description: '| Indicator of whether the shipment property is available in the filter on the shipment list page.' sort: type: integer description: '| Sorting ||' description: type: string description: '| Description of the shipment property ||' required: type: string description: '| Indicator of whether filling in the shipment property value is mandatory.' multiple: type: string description: '| Indicator of whether the order property is multiple. For multiple properties, it is possible to specify several values.' xmlId: type: string description: '| External identifier of the shipment property ||' defaultValue: type: string description: '| Default value of the shipment property.' settings: type: object description: '| An object in the format {"field_1": "value_1", ... "field_N": "value_N"} for passing additional settings for the shipment property.' isProfileName: type: string description: '| Indicator of whether the value of this shipment property should be used as the user''s profile name.' isPayer: type: string description: '| Indicator of whether the value of this shipment property should be used as the payer''s name.' isEmail: type: string description: '| Indicator of whether the value of this shipment property should be used as an e-mail (e.g., when registering a new user during order placement).' isPhone: type: string description: '| Indicator of whether the value of this shipment property should be used as a phone number.' isZip: type: string description: '| Indicator of whether the value of this shipment property should be used as a postal code.' isAddress: type: string description: '| Indicator of whether the value of this shipment property should be used as an address.' isLocation: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s location for calculating delivery costs.' isLocation4tax: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s location for determining tax rates.' inputFieldLocation: type: string description: '| Deprecated field. Not used ||' isAddressFrom: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s address from which the order needs to be picked up for calculating delivery costs.' isAddressTo: type: string description: '| Indicator of whether the value of this shipment property should be used as the customer''s address to which the order needs to be delivered for calculating delivery costs.' required: - id - fields - name 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: - sale /sale.shipmentpropertyvalue.delete: post: summary: Delete Shipment Property Value sale.shipmentpropertyvalue.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. This method deletes the shipment property value. operationId: sale_shipmentpropertyvalue_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-property-value/sale-shipment-propertyvalue-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the shipment property value ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the shipment property value ||' required: - 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: - sale /sale.shipmentpropertyvalue.get: post: summary: Get Shipment Property Value by ID sale.shipmentpropertyvalue.get 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. This method returns the values of the shipment property. operationId: sale_shipmentpropertyvalue_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-property-value/sale-shipment-property-value-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Identifier of the shipment property value ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Identifier of the shipment property value ||' required: - 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: - sale /sale.shipmentpropertyvalue.getfields: post: summary: Get Available Fields of Shipment Property Values sale.shipmentpropertyvalue.getfields 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 method returns the available fields of shipment property values. No parameters. operationId: sale_shipmentpropertyvalue_getfields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-property-value/sale-shipment-property-value-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' propertyValue: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object sale_shipment_property_value, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the execution time of the request ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' propertyValue: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object sale_shipment_property_value, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the execution time of the request ||' Code: type: string description: '| Description ||' 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: - sale /sale.shipmentpropertyvalue.list: post: summary: Get a list of shipment property values sale.shipmentpropertyvalue.list 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 method returns a list of shipment property values. operationId: sale_shipmentpropertyvalue_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-property-value/sale-shipment-property-value-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array of fields to select (see fields of the sale_shipment_property_value object).' filter: type: object description: '| An object for filtering selected property values in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting selected property values in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array of fields to select (see fields of the sale_shipment_property_value object).' filter: type: object description: '| An object for filtering selected property values in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting selected property values in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' 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: - sale /sale.shipmentpropertyvalue.modify: post: summary: Update Shipment Property Values sale.shipmentpropertyvalue.modify 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. This method updates the shipment property values. operationId: sale_shipmentpropertyvalue_modify tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/shipment-property-value/sale-shipment-property-value-modify.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| The root element that carries the request parameters ||' shipment: type: object description: '| The object containing the shipment ID and shipment property values (detailed description provided below) ||' id: type: string description: '| Shipment ID ||' propertyValues: type: string description: '| An array of objects containing the shipment property ID and property value (detailed description provided below) ||' shipmentPropsId: type: string description: '| Shipment property ID ||' value: type: string description: '| Property value ||' required: - fields - shipment - id - propertyValues - shipmentPropsId - value application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| The root element that carries the request parameters ||' shipment: type: object description: '| The object containing the shipment ID and shipment property values (detailed description provided below) ||' id: type: string description: '| Shipment ID ||' propertyValues: type: string description: '| An array of objects containing the shipment property ID and property value (detailed description provided below) ||' shipmentPropsId: type: string description: '| Shipment property ID ||' value: type: string description: '| Property value ||' required: - fields - shipment - id - propertyValues - shipmentPropsId - value 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: - sale /sale.status.add: post: summary: Create status sale.status.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. This method creates a status for an order or delivery. operationId: sale_status_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/status/sale-status-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values for creating the status ||' id: type: string description: '| Symbolic identifier of the status.' type: type: string description: '| Type of status:' notify: type: string description: '| Indicator of whether to send an email notification to the user when the order or delivery transitions to this status.' sort: type: integer description: '| Sorting ||' color: type: string description: '| HEX color code of the status (e.g., `#FF0000`) ||' xmlId: type: string description: '| External code of the status.' required: - fields - id - type application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values for creating the status ||' id: type: string description: '| Symbolic identifier of the status.' type: type: string description: '| Type of status:' notify: type: string description: '| Indicator of whether to send an email notification to the user when the order or delivery transitions to this status.' sort: type: integer description: '| Sorting ||' color: type: string description: '| HEX color code of the status (e.g., `#FF0000`) ||' xmlId: type: string description: '| External code of the status.' required: - fields - id - type 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: - sale /sale.status.delete: post: summary: Delete Status sale.status.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. This method deletes an order or delivery status. operationId: sale_status_delete tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/status/sale-status-delete.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Status identifier ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Status identifier ||' required: - 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: - sale /sale.status.get: post: summary: Get Values of All Status Fields by ID sale.status.get 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. This method retrieves the values of all fields of the status. operationId: sale_status_get tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/status/sale-status-get.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Symbolic identifier of the status ||' required: - id application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Symbolic identifier of the status ||' required: - 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: - sale /sale.status.list: post: summary: Get the list of statuses sale.status.list 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. This method retrieves a list of statuses. operationId: sale_status_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/status/sale-status-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array of fields to select (see fields of the sale_status object).' filter: type: object description: '| An object for filtering selected property groups in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting selected statuses in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array of fields to select (see fields of the sale_status object).' filter: type: object description: '| An object for filtering selected property groups in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting selected statuses in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used to manage pagination.' 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: - sale /sale.status.update: post: summary: Update status sale.status.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. This method updates the status of an order or delivery. operationId: sale_status_update tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/status/sale-status-update.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: id: type: string description: '| Symbolic identifier of the status ||' fields: type: object description: '| Field values for updating the status ||' type: type: string description: '| Status type:' notify: type: string description: '| Indicator of whether to send an email notification to the user when the order or delivery transitions to this status.' sort: type: integer description: '| Sorting ||' color: type: string description: '| HEX color code of the status (e.g., `#FF0000`) ||' xmlId: type: string description: '| External code of the status.' required: - id - fields - type application/x-www-form-urlencoded: schema: type: object properties: id: type: string description: '| Symbolic identifier of the status ||' fields: type: object description: '| Field values for updating the status ||' type: type: string description: '| Status type:' notify: type: string description: '| Indicator of whether to send an email notification to the user when the order or delivery transitions to this status.' sort: type: integer description: '| Sorting ||' color: type: string description: '| HEX color code of the status (e.g., `#FF0000`) ||' xmlId: type: string description: '| External code of the status.' required: - id - fields - type 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: - sale /sale.statusLang.add: post: summary: Add Localization sale.statusLang.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. This method adds localization for the order or delivery status. operationId: sale_statusLang_add tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/status-lang/sale-status-lang-add.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Field values (detailed description provided below) for adding status localization in the form of a structure:' statusId: type: string description: '| Symbolic identifier of the status ||' lid: type: string description: '| Language identifier. Current possible values are listed below:' name: type: string description: '| Name of the status for the created localization ||' description: type: string description: '| Description of the status for the created localization ||' required: - fields - statusId - lid - name application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Field values (detailed description provided below) for adding status localization in the form of a structure:' statusId: type: string description: '| Symbolic identifier of the status ||' lid: type: string description: '| Language identifier. Current possible values are listed below:' name: type: string description: '| Name of the status for the created localization ||' description: type: string description: '| Description of the status for the created localization ||' required: - fields - statusId - lid - name 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: - sale /sale.statusLang.deleteByFilter: post: summary: Delete localization sale.statusLang.deleteByFilter 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. This method deletes the localization records of the order or delivery status by status ID and language. operationId: sale_statusLang_deleteByFilter tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/status-lang/sale-status-lang-delete-by-filter.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: fields: type: object description: '| Values of the filter fields (detailed description provided below) for deleting the localization record in the form of a structure:' statusId: type: string description: '| Symbolic identifier of the status ||' lid: type: string description: '| Language identifier. Current possible values are listed below:' name: type: string description: '|' required: - fields - statusId - lid - name application/x-www-form-urlencoded: schema: type: object properties: fields: type: object description: '| Values of the filter fields (detailed description provided below) for deleting the localization record in the form of a structure:' statusId: type: string description: '| Symbolic identifier of the status ||' lid: type: string description: '| Language identifier. Current possible values are listed below:' name: type: string description: '|' required: - fields - statusId - lid - name 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: - sale /sale.statusLang.getFields: post: summary: Get Localization Fields for Statuses sale.statusLang.getFields 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. This method retrieves the available localization fields for order or delivery statuses. No parameters. operationId: sale_statusLang_getFields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/status-lang/sale-status-lang-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' statusLang: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Where `field` is the identifier of the sale_status_lang object, and value is an object of type rest_field_description ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' statusLang: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Where `field` is the identifier of the sale_status_lang object, and value is an object of type rest_field_description ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.statusLang.getListLangs: post: summary: Get the list of languages for localization sale.statusLang.getListLangs 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. This method retrieves a list of possible languages for localizations. No parameters. operationId: sale_statusLang_getListLangs tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/status-lang/sale-status-lang-get-list-langs.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' langs: type: string description: '| Array of objects with information about selected languages ||' total: type: integer description: '| Total number of records found ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' langs: type: string description: '| Array of objects with information about selected languages ||' total: type: integer description: '| Total number of records found ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.statusLang.list: post: summary: Get a list of localizations for sale.statusLang.list 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. This method retrieves a list of localizations for order or delivery statuses. operationId: sale_statusLang_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/status-lang/sale-status-lang-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see fields of the sale_status_lang object).' filter: type: object description: '| An object for filtering the selected items in the shipment table part in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected statuses in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used for managing pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see fields of the sale_status_lang object).' filter: type: object description: '| An object for filtering the selected items in the shipment table part in the format `{"field_1": "value_1", ... "field_N": "value_N"}`.' order: type: object description: '| An object for sorting the selected statuses in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used for managing pagination.' 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: - sale /sale.tradeBinding.getFields: post: summary: Get Available Order Fields from sale.tradeBinding.getFields 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 method `sale.tradeBinding.getFields` returns the available order fields from sources. No parameters. operationId: sale_tradeBinding_getFields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/trade-binding/sale-trade-binding-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' tradeBinding: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object `sale_order_trade_binding`, and `value` is an object of type `rest_field_description` ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' tradeBinding: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`, where `field` is the identifier of the object `sale_order_trade_binding`, and `value` is an object of type `rest_field_description` ||' time: type: string description: '| Information about the request execution time ||' Code: type: string description: '| Description ||' 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: - sale /sale.tradeBinding.list: post: summary: Get a list of orders from sources sale.tradeBinding.list 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 method `sale.tradeBinding.list` returns a list of orders from sources. operationId: sale_tradeBinding_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/trade-binding/sale-trade-binding-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see fields of the sale_order_trade_binding object).' filter: type: object description: '| An object for filtering the selected orders in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. When multiple fields are specified, AND logic is used.' order: type: object description: '| An object for sorting the selected orders in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used for managing pagination.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see fields of the sale_order_trade_binding object).' filter: type: object description: '| An object for filtering the selected orders in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. When multiple fields are specified, AND logic is used.' order: type: object description: '| An object for sorting the selected orders in the format `{"field_1": "order_1", ... "field_N": "order_N"}`.' start: type: integer description: '| This parameter is used for managing pagination.' 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: - sale /sale.tradePlatform.getFields: post: summary: Get Available Fields of Order Sources sale.tradePlatform.getFields 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 method `sale.tradePlatform.getFields` returns the available fields of order sources. No parameters. operationId: sale_tradePlatform_getFields tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/trade-platform/sale-trade-platform-get-fields.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: result: type: object description: '| Root element of the response ||' tradePlatform: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Where `field` is the identifier of the object sale_order_trade_platform, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the execution time of the request ||' Code: type: string description: '| Description ||' application/x-www-form-urlencoded: schema: type: object properties: result: type: object description: '| Root element of the response ||' tradePlatform: type: object description: '| Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Where `field` is the identifier of the object sale_order_trade_platform, and `value` is an object of type rest_field_description ||' time: type: string description: '| Information about the execution time of the request ||' Code: type: string description: '| Description ||' 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: - sale /sale.tradePlatform.list: post: summary: 'Get a List of Order Sources: sale.tradePlatform.list' 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 method `sale.tradePlatform.list` retrieves a list of order sources. operationId: sale_tradePlatform_list tags: - E-Commerce externalDocs: url: https://apidocs.bitrix24.com/api-reference/sale/trade-platform/sale-trade-platform-list.html description: Official Documentation requestBody: content: application/json: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see fields of the sale_order_trade_platform object) ||' filter: type: object description: '| A list of fields for filtering. When specifying multiple fields, AND logic is applied.' order: type: object description: '| Sorting parameters. Format: `{field: direction (ASC, DESC)}`.' start: type: integer description: '| This parameter is used for pagination control.' application/x-www-form-urlencoded: schema: type: object properties: select: type: array items: {} description: '| An array containing the list of fields to select (see fields of the sale_order_trade_platform object) ||' filter: type: object description: '| A list of fields for filtering. When specifying multiple fields, AND logic is applied.' order: type: object description: '| Sorting parameters. Format: `{field: direction (ASC, DESC)}`.' start: type: integer description: '| This parameter is used for pagination control.' 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: - sale components: schemas: BitrixError: type: object description: Bitrix24 REST API error response required: - error - error_description properties: error: type: string description: Error code example: ACCESS_DENIED error_description: type: string description: Human-readable error description example: Access denied. BitrixTime: type: object description: Request execution time information properties: start: type: number format: double finish: type: number format: double duration: type: number format: double processing: type: number format: double date_start: type: string format: date-time date_finish: type: string format: date-time operating_reset_at: type: integer operating: type: number format: double BitrixResponse: type: object description: Standard Bitrix24 REST API response properties: result: description: Method execution result total: type: integer description: Total number of records (for list methods) next: type: integer description: Next offset for pagination time: $ref: '#/components/schemas/BitrixTime' securitySchemes: AccessToken: type: apiKey in: query name: auth description: OAuth 2.0 access_token or incoming webhook token OAuth2: type: oauth2 description: OAuth 2.0 authorization flows: authorizationCode: authorizationUrl: https://oauth.bitrix.info/oauth/authorize/ tokenUrl: https://oauth.bitrix.info/oauth/token/ scopes: crm: CRM — leads, deals, contacts, companies, smart processes task: Tasks and projects disk: Drive — files and folders im: Chats and notifications imbot: Chatbots imopenlines: Open Lines — messenger connectors telephony: Telephony sale: E-Commerce — orders, shipments catalog: Trade Catalog — products, prices calendar: Calendar bizproc: Business processes and robots user: Users department: Company structure timeman: Time tracking landing: Sites and landing pages pay_system: Payment systems cashbox: Online cash registers delivery: Delivery services documentgenerator: Document generator lists: Universal lists entity: Data storage log: News feed sonet_group: Workgroups and projects mailservice: Mail services messageservice: Message providers (SMS) biconnector: BIconnector — BI analytics ai_admin: CoPilot / AI sign.b2e: Signature — e-document signing vote: Polls and voting booking: Online booking userconsent: User consent agreements userfieldconfig: Custom field settings basic: Basic access placement: Widget placements rpa: Robots process automation sonet: Social network intranet: Intranet socialnetwork: Social network workgroups: Workgroups salescenter: Sales center main: Main module imconnector: IM connector user.userfield: User custom fields user_basic: Basic user access userfieldconfig, module scope: Custom field config externalDocs: description: Official Bitrix24 REST API Documentation url: https://apidocs.bitrix24.com