Bitrix24

Bitrix24 Ecommerce API

The Ecommerce API from Bitrix24 — 139 operation(s) for ecommerce.

GitHub OpenAPI

Operations 139

POST /sale.basketitem.add Add Item (Position) to the Cart of an Existing Order sale.basketitem.add #
POST /sale.basketitem.addCatalogProduct Add a position with a product or service from the catalog module to the cart of… #
POST /sale.basketitem.delete Remove item (position) from the cart using sale.basketitem.delete #
POST /sale.basketitem.get Get Information About a Basket Item (Position) sale.basketitem.get #
POST /sale.basketitem.getFields Get Available Fields of the Basket Item (sale.basketitem.getFields) #
POST /sale.basketitem.getFieldsCatalogProduct Get Available Fields of a Basket Item (Product from Catalog)… #
POST /sale.basketitem.list Get a List of Items (Positions) in the Cart sale.basketitem.list #
POST /sale.basketitem.update Change the position of the basket in an existing order sale.basketitem.update #
POST /sale.basketitem.updateCatalogProduct Change the basket item position (catalog product) of an existing order… #
POST /sale.basketproperties.add Create a property for a basket item sale.basketproperties.add #
POST /sale.basketproperties.delete Delete Basket Property sale.basketproperties.delete #
POST /sale.basketproperties.get Get the value of the basket property sale.basketproperties.get #
POST /sale.basketproperties.getFields Get Fields of Basket Properties sale.basketproperties.getFields #
POST /sale.basketproperties.list Get a List of Basket Properties sale.basketproperties.list #
POST /sale.basketproperties.update Change the property of the basket item sale.basketproperties.update #
POST /sale.businessValuePersonDomain.add Add Correspondence to a Natural or Legal Person… #
POST /sale.businessValuePersonDomain.deleteByFilter Delete the correspondence with a natural or legal person… #
POST /sale.businessValuePersonDomain.getFields Get Fields Corresponding to a Natural or Legal Person… #
POST /sale.businessValuePersonDomain.list Get a list of matches for a natural or legal person… #
POST /sale.cashbox.add Add Cash Register sale.cashbox.add #
POST /sale.cashbox.check.apply Save the result of printing the receipt sale.cashbox.check.apply #
POST /sale.cashbox.delete Delete cash register sale.cashbox.delete #
POST /sale.cashbox.handler.add Add Cashbox Handler sale.cashbox.handler.add #
POST /sale.cashbox.handler.delete Delete Cashbox Handler sale.cashbox.handler.delete #
POST /sale.cashbox.handler.list Get a list of available cash register handlers sale.cashbox.handler.list #
POST /sale.cashbox.handler.update Update Cash Register Handler sale.cashbox.handler.update #
POST /sale.cashbox.list Get a list of configured cash registers sale.cashbox.list #
POST /sale.cashbox.update Update Existing Cash Register sale.cashbox.update #
POST /sale.delivery.add Add Delivery Service sale.delivery.add #
POST /sale.delivery.config.get Get Delivery Service Settings sale.delivery.config.get #
POST /sale.delivery.config.update Update Delivery Service Settings sale.delivery.config.update #
POST /sale.delivery.delete Delete Delivery Service sale.delivery.delete #
POST /sale.delivery.extra.service.add Add Delivery Service sale.delivery.extra.service.add #
POST /sale.delivery.extra.service.delete Delete the delivery service sale.delivery.extra.service.delete #
POST /sale.delivery.extra.service.get Get Information About All Services of a Specific Delivery Service… #
POST /sale.delivery.extra.service.update Update Delivery Service sale.delivery.extra.service.update #
POST /sale.delivery.getlist Get a list of delivery services sale.delivery.getlist #
POST /sale.delivery.handler.add Add Delivery Service Handler sale.delivery.handler.add #
POST /sale.delivery.handler.delete Delete Delivery Service Handler sale.delivery.handler.delete #
POST /sale.delivery.handler.list Get a list of delivery service handlers sale.delivery.handler.list #
POST /sale.delivery.handler.update Update Delivery Service Handler sale.delivery.handler.update #
POST /sale.delivery.request.delete Delete Delivery Request sale.delivery.request.delete #
POST /sale.delivery.request.sendmessage Create Notifications for Delivery Request sale.delivery.request.sendmessage #
POST /sale.delivery.request.update Update Delivery Request sale.delivery.request.update #
POST /sale.delivery.update Update Delivery Service sale.delivery.update #
POST /sale.order.add Add Order sale.order.add #
POST /sale.order.delete Delete Order and Related Objects sale.order.delete #
POST /sale.order.get Get Order Field Values and Related Objects sale.order.get #
POST /sale.order.getfields Get Order Fields sale.order.getfields #
POST /sale.order.list Get the list of orders sale.order.list #
POST /sale.order.update Update Order sale.order.update #
POST /sale.payment.add Add Payment sale.payment.add #
POST /sale.payment.delete Delete Payment sale.payment.delete #
POST /sale.payment.get Get Payment by Id sale.payment.get #
POST /sale.payment.getFields Get Payment Fields sale.payment.getFields #
POST /sale.payment.list Get the list of payments sale.payment.list #
POST /sale.payment.update Update Payment sale.payment.update #
POST /sale.paymentItemShipment.add Add Payment Binding to Shipment sale.paymentItemShipment.add #
POST /sale.paymentItemShipment.delete Remove the binding sale.paymentItemShipment.delete #
POST /sale.paymentItemShipment.get Get Payment Binding by Id sale.paymentItemShipment.get #
POST /sale.paymentItemShipment.getFields Get Fields for sale.paymentItemShipment.getFields #
POST /sale.paymentItemShipment.list Get a list of bindings sale.paymentItemShipment.list #
POST /sale.paymentItemShipment.update Change Payment Binding to Shipment sale.paymentItemShipment.update #
POST /sale.paymentitembasket.add Add Basket Item Binding to Payment sale.paymentitembasket.add #
POST /sale.paymentitembasket.delete Delete the binding of the cart item to the payment sale.paymentitembasket.delete #
POST /sale.paymentitembasket.get Get Values of All Fields for the Basket Item Binding to Payment… #
POST /sale.paymentitembasket.getfields Get Available Fields for Payment Item Basket Bindings… #
POST /sale.paymentitembasket.list Get a list of basket item bindings to payments sale.paymentitembasket.list #
POST /sale.paymentitembasket.update Update the binding of the cart item to the payment sale.paymentitembasket.update #
POST /sale.persontype.add Add payer type sale.persontype.add #
POST /sale.persontype.delete Delete payer type sale.persontype.delete #
POST /sale.persontype.get Get the payer type by Id sale.persontype.get #
POST /sale.persontype.getFields Get Fields of the Payer Type sale.persontype.getFields #
POST /sale.persontype.list Get a list of payer types sale.persontype.list #
POST /sale.persontype.update Change the payer type sale.persontype.update #
POST /sale.property.add Add Order Property sale.property.add #
POST /sale.property.delete Delete Order Property sale.property.delete #
POST /sale.property.get Get Order Property sale.property.get #
POST /sale.property.getfieldsbytype Get Fields and Settings of Order Properties for a Specific Property Type… #
POST /sale.property.list Get the list of order properties sale.property.list #
POST /sale.property.update Update Order Property sale.property.update #
POST /sale.propertyRelation.add Add Property Binding sale.propertyRelation.add #
POST /sale.propertyRelation.deleteByFilter Remove Property Relation with sale.propertyRelation.deleteByFilter #
POST /sale.propertyRelation.getFields Get Fields of Property Binding sale.propertyRelation.getFields #
POST /sale.propertyRelation.list Get a list of property bindings sale.propertyRelation.list #
POST /sale.propertygroup.add Create Property Group sale.propertygroup.add #
POST /sale.propertygroup.delete Delete Property Group sale.propertygroup.delete #
POST /sale.propertygroup.get Get Values of All Fields in a Property Group by ID sale.propertygroup.get #
POST /sale.propertygroup.getFields Get Available Fields of Property Groups sale.propertygroup.getFields #
POST /sale.propertygroup.list Get a list of property groups sale.propertygroup.list #
POST /sale.propertygroup.update Update Property Group Fields sale.propertygroup.update #
POST /sale.propertyvalue.delete Delete Order Property Value sale.propertyvalue.delete #
POST /sale.propertyvalue.get Get Property Value with sale.propertyvalue.get #
POST /sale.propertyvalue.getfields Get Available Fields of the Property Value sale.propertyvalue.getfields #
POST /sale.propertyvalue.list Get a list of property values sale.propertyvalue.list #
POST /sale.propertyvalue.modify Change the Value of the Property sale.propertyvalue.modify #
POST /sale.propertyvariant.add Add Property Variant sale.propertyvariant.add #
POST /sale.propertyvariant.delete Delete Property Variant sale.propertyvariant.delete #
POST /sale.propertyvariant.get Get Property Variant Value by ID sale.propertyvariant.get #
POST /sale.propertyvariant.getFields Get Available Fields of Property Variant sale.propertyvariant.getFields #
POST /sale.propertyvariant.list Get a list of property variants sale.propertyvariant.list #
POST /sale.propertyvariant.update Update Property Variant Fields sale.propertyvariant.update #
POST /sale.shipment.add Add Shipment sale.shipment.add #
POST /sale.shipment.delete Delete Shipment sale.shipment.delete #
POST /sale.shipment.get Get Shipment Fields sale.shipment.get #
POST /sale.shipment.getfields Get Available Shipment Fields sale.shipment.getfields #
POST /sale.shipment.list Get the list of shipments sale.shipment.list #
POST /sale.shipment.update Update Shipment sale.shipment.update #
POST /sale.shipmentitem.add Add an item to the shipment table part sale.shipmentitem.add #
POST /sale.shipmentitem.delete Delete Shipment Item from Collection sale.shipmentitem.delete #
POST /sale.shipmentitem.get Accessing Fields of the sale.shipmentitem.get Element #
POST /sale.shipmentitem.getfields Get Fields of Shipment Item from sale.shipmentitem.getfields #
POST /sale.shipmentitem.list Get a list of shipment item table elements sale.shipmentitem.list #
POST /sale.shipmentitem.update Update an item in the shipment table part sale.shipmentitem.update #
POST /sale.shipmentproperty.add Add Shipment Property sale.shipmentproperty.add #
POST /sale.shipmentproperty.delete Delete Shipment Property sale.shipmentproperty.delete #
POST /sale.shipmentproperty.get Get Shipment Property sale.shipmentproperty.get #
POST /sale.shipmentproperty.getfieldsbytype Get Fields and Settings of Shipment Property for a Specific Property Type… #
POST /sale.shipmentproperty.list Get a list of shipment properties sale.shipmentproperty.list #
POST /sale.shipmentproperty.update Update Shipment Property sale.shipmentproperty.update #
POST /sale.shipmentpropertyvalue.delete Delete Shipment Property Value sale.shipmentpropertyvalue.delete #
POST /sale.shipmentpropertyvalue.get Get Shipment Property Value by ID sale.shipmentpropertyvalue.get #
POST /sale.shipmentpropertyvalue.getfields Get Available Fields of Shipment Property Values… #
POST /sale.shipmentpropertyvalue.list Get a list of shipment property values sale.shipmentpropertyvalue.list #
POST /sale.shipmentpropertyvalue.modify Update Shipment Property Values sale.shipmentpropertyvalue.modify #
POST /sale.status.add Create status sale.status.add #
POST /sale.status.delete Delete Status sale.status.delete #
POST /sale.status.get Get Values of All Status Fields by ID sale.status.get #
POST /sale.status.list Get the list of statuses sale.status.list #
POST /sale.status.update Update status sale.status.update #
POST /sale.statusLang.add Add Localization sale.statusLang.add #
POST /sale.statusLang.deleteByFilter Delete localization sale.statusLang.deleteByFilter #
POST /sale.statusLang.getFields Get Localization Fields for Statuses sale.statusLang.getFields #
POST /sale.statusLang.getListLangs Get the list of languages for localization sale.statusLang.getListLangs #
POST /sale.statusLang.list Get a list of localizations for sale.statusLang.list #
POST /sale.tradeBinding.getFields Get Available Order Fields from sale.tradeBinding.getFields #
POST /sale.tradeBinding.list Get a list of orders from sources sale.tradeBinding.list #
POST /sale.tradePlatform.getFields Get Available Fields of Order Sources sale.tradePlatform.getFields #
POST /sale.tradePlatform.list Get a List of Order Sources: sale.tradePlatform.list #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bitrix24/refs/heads/main/openapi/bitrix24-ecommerce-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/bitrix24-ecommerce-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bitrix24-ecommerce-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Bitrix24 REST 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:


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