Data Types and Object Structure in the E-commerce REST API

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

E-commerce data types describe the identifiers and object structures used in the parameters and responses of the sale.* Methods. This reference shows which objects an order consists of, how they reference each other, and the format in which each field is returned. Basic types such as integer, string, datetime, and others are listed in the article Data Types in REST API.

How an Order Is Structured

The order sale_order is the main e-commerce object. It stores the customer, status, currency, and total amount. Products, delivery, payment, and customer data are stored in separate objects, and each of them references the order through the orderId field:

Object	What It Is	Methods
`sale_basket_item`	Basket item — a product or service in the order with its price and quantity	sale.basketitem.*
`sale_order_shipment`	Shipment — delivery of the order's products: delivery service, cost, and status	sale.shipment.*
`sale_order_payment`	Payment — a payment for the order: payment system, amount, and paid flag	sale.payment.*
`sale_order_property_value`	Order property value, such as the customer's name or phone number	sale.propertyvalue.*

The products included in a shipment are defined by its line items sale_order_shipment_item: each one references a basket item through basketId and specifies how many units to ship. A property value references the property itself, sale_order_property, through orderPropsId. The set of properties depends on the payer type sale_person_type, such as an individual or a legal entity.

Other fields point to the store's reference data: statusId to the statuses sale_status, the shipment's deliveryId to the delivery services sale_delivery_service, and the payment's paySystemId to the payment systems sale_paysystem.

The sale.order.get method returns an order together with its nested objects. A sample response, trimmed down to the linking fields:

{
          "order": {
            "id": 943,
            "personTypeId": 5,
            "statusId": "N",
            "price": 3500,
            "currency": "EUR",
            "payed": "N",
            "basketItems": [
              {
                "id": 1253,
                "orderId": 943,
                "name": "T-shirt, size M",
                "price": 1500,
                "quantity": 2
              }
            ],
            "shipments": [
              {
                "id": 1091,
                "orderId": 943,
                "deliveryId": 1,
                "deliveryName": "Courier Delivery",
                "priceDelivery": 500,
                "shipmentItems": [
                  {
                    "id": 1185,
                    "orderDeliveryId": 1091,
                    "basketId": 1253,
                    "quantity": 2
                  }
                ]
              }
            ],
            "payments": [
              {
                "id": 537,
                "orderId": 943,
                "paySystemId": 11,
                "sum": 3500,
                "paid": "N"
              }
            ],
            "propertyValues": [
              {
                "id": 10607,
                "orderPropsId": 39,
                "code": "FIO",
                "value": "Klaus Weber"
              }
            ]
          }
        }

In this example, basket item 1253 is part of shipment 1091: it is referenced by basketId in shipmentItems. The order total price is 3500: 3000 for two T-shirts and 500 for delivery from priceDelivery.

Data Types

In the field tables, the type is written in one of three ways:

sale_order — the entire object; its fields are described below in the table with the same name
sale_order.id — the object identifier, that is, the value of its id field. For objects with uppercase fields, such as sale_paysystem, this is the ID field
sale_order_payment[] — an array of objects

The tables describe object fields in cloud Bitrix24. In the on-premise version, the set of fields may differ: for example, a basket item has the internal fields fuserId, lid, and module. Which fields are returned in the response also depends on the method and on the select parameter, if the method accepts it.

If a field has no value, the method returns null or an empty string. An empty object, such as a property's settings or an order's requisiteLink, is returned as an empty array []. Methods return empty lists differently:

the order's clients and the basket item's properties and reservations are returned as []
the order's basketItems, payments, shipments, propertyValues, and tradeBindings are omitted from the response

The fields you can pass when creating and updating an object are listed by the getFields methods of each section, such as sale.order.getFields. For properties, there is the sale.property.getFieldsByType method, and for a basket item with a catalog product, there is sale.basketitem.getFieldsCatalogProduct. Their response format is described in the rest_field_description structure.

Type	Descriptions and Values
`sale_order.id`	Integer identifier of the order (e.g., `1`). Order identifiers can be obtained using the method sale.order.list
`sale_basket_item.id`	Integer identifier of the basket item (e.g., `1`). Basket item identifiers can be obtained using the method sale.basketItem.list
`sale_order_shipment.id`	Integer identifier of the shipment (e.g., `1`). Shipment identifiers can be obtained using the method sale.shipment.list
`sale_order_shipment_item.id`	Integer identifier of the shipment line item (e.g., `1`). Identifiers of shipment line items can be obtained using the method sale.shipmentitem.list
`sale_payment_item_shipment.id`	Integer identifier of the payment binding to the shipment (e.g., `1`). Identifiers of payment bindings to shipments can be obtained using the method sale.paymentitemshipment.list
`sale_payment_item_basket.id`	Integer identifier of the basket item binding to the payment (e.g., `1`). Identifiers of basket item bindings to payments can be obtained using the method sale.paymentitembasket.list
`sale_status.id`	Character identifier of the status (e.g., `DN`). Status identifiers can be obtained using the method sale.status.list
`sale_status_lang`	Object containing information about the localization of the status. A list of status localization objects can be obtained using the method sale.statuslang.list
`sale_lang.lid`	Character identifier of the language (e.g., `de`). Language identifiers can be obtained using the method sale.statuslang.getlistlangs
`sale_person_type.id`	Integer identifier of the payer type (e.g., `1`). Payer type identifiers can be obtained using the method sale.persontype.list
`sale_order_property.id`	Integer identifier of the order property (e.g., `1`). Order property identifiers can be obtained using the method sale.property.list
`sale_shipment_property.id`	Integer identifier of the shipment property (e.g., `1`). Shipment property identifiers can be obtained using the method sale.shipmentproperty.list
`sale_shipment_property_value.id`	Integer identifier of the shipment property value (e.g., `1`). Shipment property value identifiers can be obtained using the method sale.shipmentpropertyvalue.list
`sale_order_property_group.id`	Integer identifier of the property group (e.g., `1`). Property group identifiers can be obtained using the method sale.propertygroup.list
`sale_order_property_value.id`	Integer identifier of the order property value (e.g., `1`). Order property value identifiers can be obtained using the method sale.propertyvalue.list
`sale_order_property_variant.id`	Integer identifier of the property value variant (e.g., `1`). Property value variant identifiers can be obtained using the method sale.propertyvariant.list
`sale_order_property_relation`	Object containing information about the property binding. A list of property binding objects can be obtained using the method sale.propertyRelation.list
`sale_order_trade_platform.id`	Integer identifier of the trading platform (e.g., `1`). Trading platform identifiers can be obtained using the method sale.tradePlatform.list
`sale_order_trade_binding.id`	Integer identifier of the binding of an order to a source (e.g., `1`). Order binding identifiers can be obtained using the method sale.tradeBinding.list
`sale_order_payment.id`	Integer identifier of the payment (e.g., `1`). Payment identifiers can be obtained using the method sale.payment.list
`sale_business_value_person_domain`	Object containing information about the correspondence between the payer type and individual or legal entity. A list of correspondence objects can be obtained using the method sale.businessValuePersonDomain.list
`sale_delivery_handler`	Object of the delivery service handler. The delivery service handler is a template from which specific delivery services are created. Identifiers of delivery service handlers can be obtained using the method sale.delivery.handler.list
`sale_delivery_service`	Object of the delivery service. Delivery service identifiers can be obtained using the method sale.delivery.getlist
`sale_delivery_extra_service`	Object of the additional delivery service. Delivery service identifiers can be obtained using the method sale.delivery.extra.service.get
`sale_paysystem_handler`	Object of the payment system handler. Payment system handler identifiers can be obtained using the method sale.paysystem.handler.list
`sale_paysystem`	Object of the payment system. Payment system identifiers can be obtained using the method sale.paysystem.list

Object Structure

sale_order_shipment_item

Value `type`	Description
id `integer`	Identifier of the shipment line item
orderDeliveryId `sale_order_shipment.id`	Identifier of the shipment
basketId `sale_basket_item.id`	Identifier of the basket item
quantity `double`	Quantity of the product
reservedQuantity `double`	Reserved quantity of the product
xmlId `string`	External identifier. Can be used to synchronize the current product position of the delivery with a similar position in an external system
dateInsert `datetime`	Date of adding the shipment line item

sale_payment_item_shipment

Value `type`	Description
id `integer`	Identifier of the payment binding to the shipment
shipmentId `sale_order_shipment.id`	Identifier of the shipment
paymentId `sale_order_payment.id`	Identifier of the payment
xmlId `string`	External identifier of the record
dateInsert `datetime`	Date of adding the payment binding to the shipment

sale_payment_item_basket

Value `type`	Description
id `integer`	Identifier of the basket item binding to the payment
paymentId `sale_order_payment.id`	Identifier of the payment
basketId `sale_basket_item.id`	Identifier of the basket item
quantity `double`	Quantity of the product
xmlId `string`	External identifier of the record
dateInsert `datetime`	Date of adding the basket item binding to the payment

sale_order_shipment

Value `type`	Description
id `integer`	Identifier of the shipment
dateInsert `datetime`	Date of creating the shipment
orderId `sale_order.id`	Identifier of the order
accountNumber `string`	System number of the shipment
allowDelivery `string`	Indicator of delivery permission. Possible values: `Y` — yes (delivery allowed) `N` — no (delivery not allowed)
dateAllowDelivery `datetime`	Date of changing the delivery permission flag
empAllowDeliveryId `user.id`	User who changed the delivery permission flag
deducted `string`	Indicator of whether the shipment has been shipped. Possible values: `Y` — yes (shipped) `N` — no (not shipped)
dateDeducted `datetime`	Date of changing the shipment shipped flag
empDeductedId `user.id`	User who changed the shipped flag
reasonUndoDeducted `string`	Deprecated property
system `string`	Indicator of whether the shipment is system-generated. REST methods do not return system shipments, so the value is always `N`
deliveryId `sale_delivery_service.id`	Identifier of the delivery service
deliveryName `string`	Name of the delivery service
deliveryXmlId `string`	External identifier of the delivery service
statusId `sale_status.id`	Identifier of the delivery status
statusXmlId `string`	External identifier of the delivery status
canceled `string`	Deprecated. Use the shipment status. Indicator of whether the shipment is canceled. Possible values: `Y` — yes `N` — no
dateCanceled `datetime`	Deprecated. Date and time of shipment cancellation
empCanceledId `user.id`	Deprecated. User who changed the canceled flag of the shipment (`canceled`)
marked `string`	Flag of marking. Indicator of whether the shipment is marked as problematic. Possible values: `Y` — yes `N` — no
dateMarked `datetime`	Date of changing the marking flag
reasonMarked `string`	Reason for marking the shipment
empMarkedId `user.id`	User who set the marking flag to `Y`
deliveryDocDate `datetime`	Date of the shipment document
deliveryDocNum `string`	Number of the shipment document
trackingNumber `string`	Identifier of the shipment
trackingDescription `string`	Description of the shipment status
trackingLastCheck `string`	Time of the last status check
trackingStatus `string`	Status of the shipment
currency `string`	Currency of the shipment
customPriceDelivery `string`	Indicator of custom delivery cost. For example, if the delivery service automatically calculated the cost at 500 dollars, but the manager manually set the cost at 200 dollars, then the custom delivery cost indicator will be automatically set to `Y`. Possible values: `Y` — yes `N` — no
basePriceDelivery `double`	Base delivery cost (without discounts/markups)
priceDelivery `double`	Delivery cost
discountPrice `double`	Discount on delivery
comments `string`	Manager's comment
companyId `integer`	Identifier of the company from the e-commerce module. Not used in the cloud version
responsibleId `user.id`	Identifier of the user responsible for the shipment
dateResponsibleId `datetime`	Date of changing the responsible person for the shipment
empResponsibleId `user.id`	User who assigned the responsible person
xmlId `string`	External identifier of the shipment. Can be used to synchronize the shipment with an external system
externalDelivery `string`	Indicator of whether the shipment was uploaded from an external system (e.g., an ERP) Possible values: `Y` — yes `N` — no
id1c `string`	Identifier of the shipment in the ERP
updated1c `string`	Indicator of whether this shipment has been synchronized (updated) with the ERP
version1c `string`	Version of the shipment document in the ERP, if the shipment was updated from the ERP
shipmentItems `sale_order_shipment_item[]`	Array containing the shipment line items

sale_status

Value `type`	Description
id `string`	Character identifier of the status
type `string`	Type of status: `O` — order status `D` — delivery status
notify `string`	Indicator of the need to send an email notification to the user when the order or shipment transitions to this status: `Y` — notify `N` — do not notify
color `string`	HEX color code of the status (e.g., `#FF0000`)
sort `integer`	Sorting
xmlId `string`	External identifier of the status

sale_status_lang

Value `type`	Description
statusId `sale_status.id`	Character identifier of the status
lid `sale_lang.lid`	Identifier of the language
name `string`	Name of the status
description `string`	Description of the status

sale_lang

Value `type`	Description
active `string`	Indicator of the language's activity `Y` — active `N` — inactive
lid `string`	Character identifier of the language
name `string`	Name of the language

sale_order_property

Value `type`	Description
id `integer`	Identifier of the order property
personTypeId `sale_person_type.id`	Identifier of the payer type
propsGroupId `sale_order_property_group.id`	Identifier of the property group
name `string`	Name of the order property
type `string`	Type of the order property. Possible values: `STRING` `Y/N` `NUMBER` `ENUM` `FILE` `DATE` `LOCATION` `ADDRESS`
code `string`	Character code of the order property
active `string`	Indicator of the order property's activity. Possible values: `Y` — yes `N` — no
util `string`	Indicator of whether the order property is a service property. Service properties are not displayed in the public part. Possible values: `Y` — yes `N` — no
userProps `string`	Indicator of whether the order property is included in the customer profile. Possible values: `Y` — yes `N` — no
isFiltered `string`	Indicator of whether the order property is available in the filter on the order list page. Possible values: `Y` — yes `N` — no
sort `integer`	Sorting
description `string`	Description of the order property
required `string`	Indicator of whether filling in the order property value is mandatory. Possible values: `Y` — yes `N` — no
multiple `string`	Indicator of whether the order property is multiple. For multiple properties, it is possible to specify multiple values. Possible values: `Y` — yes `N` — no
xmlId `string`	External identifier of the order property
defaultValue `any`	Default value of the order property: a string or a number. For multiple order properties (`multiple`), an array of values is supported
settings `object`	Settings of the property. Their structure is described in the `settings` parameter of the method sale.property.add
isProfileName `string`	Indicator of whether to use the value of this order property as the user's profile name. Possible values: `Y` — yes `N` — no Relevant only for order properties of type `STRING`
isPayer `string`	Indicator of whether to use the value of this order property as the payer's name. Possible values: `Y` — yes `N` — no Relevant only for order properties of type `STRING`
isEmail `string`	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). Possible values: `Y` — yes `N` — no Relevant only for order properties of type `STRING`
isPhone `string`	Indicator of whether to use the value of this order property as a phone number. Possible values: `Y` — yes `N` — no Relevant only for order properties of type `STRING`
isZip `string`	Indicator of whether to use the value of this order property as a postal code. Possible values: `Y` — yes `N` — no Relevant only for order properties of type `STRING`
isAddress `string`	Indicator of whether to use the value of this order property as an address. Possible values: `Y` — yes `N` — no Relevant only for order properties of type `STRING`
isLocation `string`	Indicator of whether to use the value of this order property as the buyer's location for calculating delivery costs. Possible values: `Y` — yes `N` — no Relevant only for order properties of type `LOCATION`
isLocation4tax `string`	Indicator of whether to use the value of this order property as the buyer's location for determining tax rates. Possible values: `Y` — yes `N` — no Relevant only for order properties of type `LOCATION`
inputFieldLocation `string`	Deprecated field. Not used. Relevant only for order properties of type `LOCATION`
isAddressFrom `string`	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. Possible values: `Y` — yes `N` — no Relevant only for order properties of type `ADDRESS`
isAddressTo `string`	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 delivery costs. Possible values: `Y` — yes `N` — no Relevant only for order properties of type `ADDRESS`

sale_shipment_property

See the description of sale_order_property.

sale_shipment_property_value

Value `type`	Description
id `integer`	Identifier of the property value
name `string`	Name of the property
shipmentId `sale_order_shipment.id`	Identifier of the shipment
code `string`	Character code of the property
value `string` or `sale_order_property_value_file_value`	Value of the property. For a property of type `FILE`, it is a file object
shipmentPropsId `sale_shipment_property.id`	Identifier of the property
shipmentPropsXmlId `string`	External identifier of the shipment property

sale_order_property_value

Value `type`	Description
id `integer`	Identifier of the property value
name `string`	Name of the property
orderId `sale_order.id`	Identifier of the order
code `string`	Character code of the property
value `any`	Value of the property. The format depends on the property type: a string, an array of values, or a file object `sale_order_property_value_file_value`
orderPropsId `sale_order_property.id`	Identifier of the property
orderPropsXmlId `string`	External identifier of the order property

sale_order_property_value_file_value

Value `type`	Description
id `string`	Identifier of the file
contentType `string`	MIME type of the file
description `string`	Description of the file
externalId `string`	External identifier of the file
fileName `string`	Name of the file
fileSize `string`	Size of the file in bytes, e.g., `"18"`
handlerId `string`	Internal identifier of the file storage
meta `string`	Internal file metadata
moduleId `string`	Module affiliation
originalName `string`	Original name of the file
src `string`	Address of the file. In cloud Bitrix24, it is a full URL, e.g., `https://cdn-com.bitrix24.com/...`. The address can also be returned as a path from the site root, e.g., `/upload/...`
subdir `string`	Subdirectory where the file is located on disk
timestampX `string`	Date of the file record change
versionOriginalId `string`	Version of the file
width `string`	Width of the image in pixels (relevant only for image files)
height `string`	Height of the image in pixels (relevant only for image files)

sale_order_property_variant

Value `type`	Description
id `integer`	Identifier of the property value variant
name `string`	Name of the property value variant
value `string`	Code of the property value variant
orderPropsId `sale_order_property.id`	Identifier of the property
description `string`	Description of the property value variant
sort `integer`	Sorting

sale_order_property_group

Value `type`	Description
id `integer`	Identifier of the property group
name `string`	Name of the property group
personTypeId `sale_person_type.id`	Identifier of the payer type
sort `integer`	Sorting

sale_order_property_relation

Value `type`	Description
entityId `integer`	Identifier of the object to which the property is bound
entityType `string`	Type of the object: `P` — payment system `D` — delivery `L` — landing `T` — trading platform
propertyId `sale_order_property.id`	Identifier of the property

sale_person_type

Value `type`	Description
id `integer`	Identifier of the payer type
name `string`	Name of the payer type
code `string`	Code of the payer type
sort `string`	Sorting
active `string`	Indicator of the activity of the payer type: `Y` — active `N` — inactive
xmlId `string`	External identifier. Can be used to synchronize the current payer type with a similar position in an external system

sale_business_value_person_domain

Value
type

Description

personTypeId
sale_person_type.id

Identifier of the payer type

domain
string

Value corresponding to the payer type: individual or legal entity.

I — individual
E — legal entity

This option is needed for the operation of the business meanings mechanism

sale_order

Value `type`	Description
id `integer`	Identifier of the order
lid `string`	Identifier of the site to which the order belongs. In cloud Bitrix24, use `s1`
dateInsert `datetime`	Date of order creation
dateUpdate `datetime`	Date of order update
personTypeId `sale_person_type.id`	Identifier of the payer type
personTypeXmlId `string`	External identifier of the payer type
statusId `sale_status.id`	Identifier of the status
empStatusId `user.id`	Identifier of the user who changed the order status
dateStatus `datetime`	Date of changing the status
marked `string`	Flag of marking. Indicator that the order is marked as problematic. Bitrix24 sets the value `Y` automatically if a warning occurred while saving the order. The reason is recorded in the `reasonMarked` field. `Y` — yes `N` — no
dateMarked `datetime`	Date of marking the order
empMarkedId `user.id`	Identifier of the user who set the marking
reasonMarked `string`	Reason for marking the order
price `double`	Order total, including delivery
discountValue `double`	Value of the discount
taxValue `double`	Tax amount for the order
userDescription `string`	Customer's comment on the order
additionalInfo `string`	Deprecated. Additional information
comments `string`	Manager's comment on the order
companyId `integer`	Identifier of the company from the e-commerce module
responsibleId `user.id`	Identifier of the user responsible for the order
recurringId `string`	Identifier of the subscription renewal
lockedBy `string`	Relevant only for the on-premise version. Identifier of the user who locked the order. The order is locked in the admin panel when the user opens the detail form of the order
dateLock `datetime`	Date of locking
recountFlag `string`	Deprecated. Recount flag: `Y` — yes `N` — no
affiliateId `integer`	Relevant only for the on-premise version. Identifier of the affiliate
updated1c `string`	Whether the order was updated through an ERP: `Y` — yes `N` — no
orderTopic `string`	Deprecated. Order topic
xmlId `string`	External identifier
statusXmlId `string`	External identifier of the status
id1c `string`	Identifier in the ERP
version `integer`	Document version
version1c `string`	Version in the ERP
externalOrder `string`	Whether the order is from an external system or not `Y` — yes `N` — no
canceled `string`	Whether the order was canceled: `Y` — yes `N` — no
dateCanceled `datetime`	Date of cancellation
empCanceledId `user.id`	Identifier of the user who canceled the order
reasonCanceled `string`	Reason for cancellation
userId `user.id`	Identifier of the client
currency `string`	Currency. The list of currencies can be obtained through the method crm.currency.list
accountNumber `string`	Order number
payed `string`	Whether the order is paid: `Y` — yes `N` — no
deducted `string`	Deprecated. Whether the order is shipped: `Y` — yes `N` — no
basketItems `sale_basket_item[]`	Items in the order basket
clients `sale_order_crm_client[]`	CRM contacts and companies linked to the order
payments `sale_order_payment[]`	Payments of the order
shipments `sale_order_shipment[]`	Shipments of the order
propertyValues `sale_order_property_value[]`	Values of the order properties. In the order response, they are returned without the `orderId` field
requisiteLink `object`	Requisites selected for the order: `requisiteId` and `bankDetailId` — the client's requisite and bank requisite `mcRequisiteId` and `mcBankDetailId` — your company's requisite and bank requisite Links of requisites to CRM objects are returned by the method crm.requisite.link.list; for orders, entity_type_id = 14
tradeBindings `sale_order_trade_binding[]`	Trading platforms of the order

sale_order_crm_client

Value `type`	Description
id `integer`	Identifier of the binding
entityId `integer`	Identifier of the CRM object
entityTypeId `integer`	Identifier of the `CRM object type`
isPrimary `string`	Indicator of whether the client is primary. Possible values: `Y` — yes `N` — no
orderId `sale_order.id`	Identifier of the order
roleId `integer`	Deprecated
sort `integer`	Sorting

sale_order_payment

Value `type`	Description
id `integer`	Identifier of the payment
orderId `sale_order.id`	Identifier of the order
paySystemXmlId `string`	External identifier of the payment system
paySystemIsCash `string`	Payment type of the payment system, as in the `IS_CASH` field of the `sale_paysystem` object: `N` — cashless `Y` — cash `A` — acquiring operation
accountNumber `string`	System number of the payment
paid `string`	Whether the payment has been made: `Y` — yes `N` — no
datePaid `datetime`	Date of payment
empPaidId `user.id`	User who made the payment
paySystemId `sale_paysystem.id`	Identifier of the payment system
psStatus `string`	Status of the payment system transaction — whether the order has been successfully paid (for payment systems that allow automatic retrieval of data on orders processed through them): `Y` — yes `N` — no
psStatusCode `string`	Code of the payment system transaction status
psStatusDescription `string`	Description of the payment system transaction status
psStatusMessage `string`	Message of the payment system transaction status
psSum `double`	Amount of the payment system transaction
psCurrency `string`	Currency of the payment system
psResponseDate `datetime`	Date of the payment system response
payVoucherNum `string`	Number of the payment document
payVoucherDate `datetime`	Date of the payment document
datePayBefore `datetime`	Date by which the invoice must be paid (not used in the store)
dateBill `datetime`	Date of invoice issuance
xmlId `string`	External identifier
sum `double`	Amount of the payment
currency `string`	Currency of the payment
paySystemName `string`	Name of the payment system
companyId `integer`	Identifier of the company that will receive the payment
payReturnNum `string`	Number of the return document
priceCod `double`	Cost of payment upon delivery (used, for example, for cash on delivery)
payReturnDate `date`	Date of the return document
empReturnId `user.id`	Identifier of the user who performed the return
payReturnComment `string`	Comment on the return
responsibleId `user.id`	Identifier of the user responsible for the payment
empResponsibleId `user.id`	Identifier of the user who appointed the responsible person
dateResponsibleId `datetime`	Date of appointing the responsible person
isReturn `string`	Whether a return was made: `N` — no `Y` — yes, to the customer's internal account `P` — yes, through the payment system used for the payment
comments `string`	Comments on the payment
updated1c `string`	Whether the payment was updated through an ERP: `Y` — yes `N` — no
id1c `string`	Identifier in the ERP
version1c `string`	Version of the payment document from the ERP
externalPayment `string`	Whether the payment is external: `Y` — yes `F` — yes, the payment was uploaded from the ERP together with the order `N` — no
psInvoiceId `string`	Identifier of the payment in the payment system
marked `string`	Flag of marking. Indicator of whether the payment is marked as problematic: `Y` — yes `N` — no
reasonMarked `string`	Reason for marking
dateMarked `datetime`	Date of marking the payment
empMarkedId `user.id`	Identifier of the user who marked the payment

sale_basket_item

Value `type`	Description
id `integer`	Identifier of the basket item
orderId `sale_order.id`	Identifier of the order
sort `integer`	Position in the list of order items
productId `integer`	Identifier of the product. For a basket item without a catalog product, it can be zero — such an item is added by the method sale.basketitem.add
price `double`	Price of the product including discounts and markups
customPrice `string`	Whether the price is specified manually: `Y` — yes `N` — no
currency `string`	Currency of the price. Must match the currency of the order. The list of currencies can be obtained using the method crm.currency.list, detailed information about the currency can be obtained using the method crm.currency.get
quantity `double`	Quantity
xmlId `string`	External code of the basket item. If not specified, it will be generated automatically. Used for synchronization with external systems (e.g., an ERP)
dateInsert `datetime`	Date of adding the basket item
dateUpdate `datetime`	Date of updating the basket item
properties `sale_basket_item_property[]`	Properties of the basket item
name `string`	Name of the product
basePrice `double`	Price of the product without discounts and markups The rule must always be followed: `basePrice = price + discountPrice`
discountPrice `double`	Amount of the final discount/markup. For markup, the value is negative
weight `double`	Weight in grams. For on-premise versions, the unit of weight measurement is specified in the settings of the e-commerce module (sale)
dimensions `string`	Dimensions of the product in millimeters. The field is either empty or contains a serialized array with keys: `WIDTH` — width `HEIGHT` — height `LENGTH` — length
measureCode `string`	Unit of measure code
measureName `string`	Name of the unit of measure
canBuy `string`	Is the product available for purchase: `Y` — yes `N` — no
vatRate `double`	Tax rate as a fraction of one: `0.1` means 10 %. Can be equal to `null` (“No VAT” — in case VAT rates are used)
vatIncluded `string`	Is the tax included in the price: `Y` — yes `N` — no
barcodeMulti `string`	Field available only when inventory accounting is enabled. Is the barcode unique: `Y` — yes `N` — no It is strongly not recommended to fill this field manually for catalog products
type `integer`	Type of the item. Does not correspond to the type of product in the catalog. Possible values: `1` — set `2` — service `null` — any other It is strongly not recommended to set this manually
catalogXmlId `string`	External identifier of the catalog. Used for synchronization with external systems (e.g., an ERP)
productXmlId `string`	External identifier of the product. Used for synchronization with external systems (e.g., an ERP)
reservations `sale_basket_item_reservation[]`	Reservations of the basket item

sale_basket_item_property

Value `type`	Description
id `integer`	Identifier of the basket item property
basketId `sale_basket_item.id`	Identifier of the basket item
name `string`	Name of the property
value `string`	Value of the property
code `string`	Code of the property
sort `integer`	Sorting order
xmlId `string`	External identifier

sale_order_trade_platform

Value `type`	Description
id `integer`	Identifier of the trading platform
code `string`	Code of the trading platform
active `string`	Is the trading platform active `Y` — yes `N` — no
name `string`	Name of the trading platform
description `string`	Description of the trading platform
settings `string`	Settings of the trading platform in serialized form
catalogSectionTabClassName `string`	Class for processing the tab in the catalog section settings
class `string`	Class of the trading platform
xmlId `string`	External identifier

sale_order_trade_binding

Value `type`	Description
id `integer`	Identifier of the binding
xmlId `string`	External identifier of the binding
externalOrderId `string`	Order number in the external system
orderId `sale_order.id`	Identifier of the order
tradingPlatformId `string`	Identifier of the trading platform `sale_order_trade_platform`, e.g., `"41"`
tradingPlatformXmlId `string`	External identifier of the trading platform
params `string`	Parameters in serialized form

sale_basket_item_reservation

Value `type`	Description
id `integer`	Identifier of the reservation
basketId `sale_basket_item.id`	Identifier of the basket item reservation
storeId `integer`	Identifier of the warehouse
quantity `double`	Quantity
dateReserve `datetime`	Date of reservation
dateReserveEnd `datetime`	Date of reservation end
reservedBy `user.id`	Identifier of the user who added the reservation

sale_delivery_handler

Value `type`	Description
ID `integer`	Identifier of the delivery service handler. Identifiers of delivery service handlers can be obtained using the method sale.delivery.handler.list
NAME `string`	Name of the delivery service handler
CODE `string`	Character code of the delivery service handler
SORT `integer`	Sorting
DESCRIPTION `string`	Description of the delivery service handler
SETTINGS `sale_delivery_handler_settings`	Object containing information about the delivery service settings
PROFILES `sale_delivery_handler_profile[]`	Array containing the list of delivery profiles

sale_delivery_handler_settings

Value `type`	Description
CALCULATE_URL `string`	URL for calculating delivery costs. Data about the parcel (what to deliver, where, and how) is sent to this URL, and the cost of delivery needs to be calculated in response. The request and response format is detailed in the documentation for the webhook Delivery Cost Calculation
CREATE_DELIVERY_REQUEST_URL `string`	URL for creating a delivery order. Data about the parcel (what to deliver, where, and how) is sent to this URL, and an order needs to be placed with the delivery service. The request and response format is detailed in the documentation for the webhook Creating a Delivery Order
CANCEL_DELIVERY_REQUEST_URL `string`	URL for canceling a delivery order. The identifiers of the delivery service `DELIVERY_ID` and of the transport request `REQUEST_ID` to be canceled are sent to this URL. The request and response format is detailed in the documentation for the webhook Canceling a Delivery Order
HAS_CALLBACK_TRACKING_SUPPORT `string`	Indicator of whether the delivery service will send notifications about the status of the delivery order (see the method sale.delivery.request.sendmessage). If event support is indicated, then in the manager's interface when ordering delivery, a CRM activity will be created for the delivery, into which changes related to the current delivery status can be transmitted. Possible values: `Y` — support exists `N` — no support
CONFIG `sale_delivery_handler_settings_config_item[]`	Array of objects with available settings for the delivery service created using this handler

sale_delivery_handler_settings_config_item

Value `type`	Description
TYPE `string`	Type of the setting field. Possible values: `STRING` — string `Y/N` — checkbox (yes / no) `NUMBER` — number `ENUM` — list `DATE` — date `LOCATION` — location
CODE `string`	Character code of the setting
NAME `string`	Name of the setting
OPTIONS `object`	List of options for selection. An object in the format `key=value`. Where `key` is the option code, and `value` is the options. Example: `{ "Option1Code": "Option1Value", "Option2Code": "Option2Value", "Option3Code": "Option3Value" }` The parameter is relevant only for settings of type `ENUM`

sale_delivery_handler_profile

Value `type`	Description
NAME `string`	Name of the delivery service handler profile
CODE `string`	Character code of the delivery service handler profile
DESCRIPTION `string`	Description of the delivery service handler profile

sale_delivery_service

Value `type`	Description
ID `integer`	Identifier of the delivery service. Identifiers of delivery services can be obtained using the method sale.delivery.getlist
PARENT_ID `integer`	Identifier of the parent delivery service. Identifiers of delivery services can be obtained using the method sale.delivery.getlist
NAME `string`	Name of the delivery service
CURRENCY `string`	Character code of the currency of the delivery service
DESCRIPTION `string`	Description of the delivery service
SORT `integer`	Sorting
ACTIVE `string`	Indicator of the activity of the delivery service. Possible values: `Y` — active `N` — inactive

sale_delivery_config_value_item

Value `type`	Description
CODE `string`	Character code of the setting
VALUE `any`	Value of the setting

sale_delivery_extra_service

Value `type`	Description
ID `integer`	Identifier of the additional delivery service. Identifiers of delivery services can be obtained using the method sale.delivery.extra.service.get
TYPE `string`	Type of the service. Possible values: `enum` — list (selecting an option from a pre-formed list) `checkbox` — single service (e.g., delivery to the door) `quantity` — quantitative service (e.g., required number of loaders)
NAME `string`	Name of the service
ACTIVE `string`	Indicator of the activity of the service. Possible values: `Y` — active `N` — inactive
CODE `string`	Character code of the service
SORT `integer`	Sorting
DESCRIPTION `string`	Description of the service
PRICE `double`	Field relevant only for services of type single service (`checkbox`) and quantitative service (`quantity`)
ITEMS `sale_delivery_extra_service_enum_item[]`	List of options available for selection. Field relevant only for services of type list (`enum`)

sale_delivery_extra_service_enum_item

Value `type`	Description
TITLE `string`	Name of the option in the list
CODE `string`	Character code of the option in the list
PRICE `double`	Cost of the service when selecting this option in the currency of the delivery service

sale_paysystem_handler

Value `type`	Description
ID `string`	Identifier of the payment system handler
NAME `string`	Name of the handler
CODE `string`	Code of the handler
SORT `string`	Sorting
SETTINGS `object`	Settings of the handler. The structure corresponds to that specified when adding the handler through sale.paysystem.handler.add in the `SETTINGS` parameter

sale_paysystem

Value `type`	Description
ID `string`	Identifier of the payment system
NAME `string`	Name of the payment system
DESCRIPTION `string`	Description of the payment system
XML_ID `string`	Character code
PERSON_TYPE_ID `sale_person_type.id`	Identifier of the payer type
ACTION_FILE `string`	For REST payment systems, this is the code of the REST handler specified when adding the handler using the method sale.paysystem.handler.add. For system payment systems, this is the code of the system payment system handler
ACTIVE `string`	Is the payment system active. Available values: `Y` — yes `N` — no
ENTITY_REGISTRY_TYPE `string`	Binding of the payment system: `ORDER` — value for store orders, deals, smart processes `CRM_INVOICE` — value for CRM invoices `CRM_QUOTE` — value for CRM estimates
NEW_WINDOW `string`	Flag for the setting "Open in a new window". Available values: `Y` — yes `N` — no
ALLOW_EDIT_PAYMENT `string`	Flag for the setting "Allow automatic payment recalculation". Available values: `Y` — yes `N` — no
AUTO_CHANGE_1C `string`	Flag for the setting "Allow automatic payment change when importing from an ERP". Available values: `Y` — yes `N` — no
CAN_PRINT_CHECK `string`	Flag for the setting "Allow printing checks". Available values: `Y` — yes `N` — no
ENCODING `string`	Setting "Encoding". Available values: `windows-1251`, `utf-8`, `iso-8859-1`. Not used for REST handlers
IS_CASH `string`	Type of payment. Possible values: `N` — cashless `Y` — cash `A` — acquiring operation
PSA_NAME `string`	Title of the payment system
PS_MODE `string`	Operating mode of the payment system for handlers that support multiple operating modes
SORT `string`	Sorting
TARIFF `string`	Not used

Objects Used in Responses

rest_field_description

Value `type`	Description
isImmutable `boolean`	Indicator of the possibility of changing the field value after creation. If this indicator is set for the field, then when creating the object, a value for the field can be specified, but it cannot be changed during updates
isReadOnly `boolean`	Read-only indicator. If this indicator is set for the field, then in the operations of adding and updating the object, the value of the field does not need to be passed. The value is generated automatically and is intended for read-only access
isRequired `boolean`	Indicator of whether the field is mandatory for add or update operations
type `string`	Data type of the field values. Possible values: `integer` `double` `string` `char` `list` `text` `file` `date` `datetime` `datatype` `productproperty` `any` — the value format depends on other settings, such as the property type
fields `object`	Descriptions of nested fields in the same `rest_field_description` format. Returned for fields of the composite type `datatype`, such as `settings` in the response of sale.property.getFieldsByType

Was the article helpful?

Overview of Sections

Overview of Methods

Data Types and Object Structure in the E-commerce REST API

How an Order Is StructuredHow an Order Is Structured

Data TypesData Types

Object StructureObject Structure

sale_order_shipment_itemsale_order_shipment_item

sale_payment_item_shipmentsale_payment_item_shipment

sale_payment_item_basketsale_payment_item_basket

sale_order_shipmentsale_order_shipment

sale_statussale_status

sale_status_langsale_status_lang

sale_langsale_lang

sale_order_propertysale_order_property

sale_shipment_propertysale_shipment_property

sale_shipment_property_valuesale_shipment_property_value

sale_order_property_valuesale_order_property_value

sale_order_property_value_file_valuesale_order_property_value_file_value

sale_order_property_variantsale_order_property_variant

sale_order_property_groupsale_order_property_group

sale_order_property_relationsale_order_property_relation

sale_person_typesale_person_type

sale_business_value_person_domainsale_business_value_person_domain

sale_ordersale_order

sale_order_crm_clientsale_order_crm_client

sale_order_paymentsale_order_payment

sale_basket_itemsale_basket_item

sale_basket_item_propertysale_basket_item_property

sale_order_trade_platformsale_order_trade_platform

sale_order_trade_bindingsale_order_trade_binding

sale_basket_item_reservationsale_basket_item_reservation

sale_delivery_handlersale_delivery_handler

sale_delivery_handler_settingssale_delivery_handler_settings

sale_delivery_handler_settings_config_itemsale_delivery_handler_settings_config_item

sale_delivery_handler_profilesale_delivery_handler_profile

sale_delivery_servicesale_delivery_service

sale_delivery_config_value_itemsale_delivery_config_value_item

sale_delivery_extra_servicesale_delivery_extra_service

sale_delivery_extra_service_enum_itemsale_delivery_extra_service_enum_item

sale_paysystem_handlersale_paysystem_handler

sale_paysystemsale_paysystem

Objects Used in ResponsesObjects Used in Responses

rest_field_descriptionrest_field_description