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

Type

Descriptions and Values

sale_order

Integer identifier of the order (e.g., 1). Order identifiers can be obtained using the method sale.order.list

sale_basket_item

Integer identifier of the basket (e.g., 1). Basket identifiers can be obtained using the method sale.basketItem.list

sale_order_shipment

Integer identifier of the shipment (e.g., 1). Shipment identifiers can be obtained using the method sale.shipment.list

sale_order_shipment_item

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

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

Integer identifier of the basket item binding to the payment (e.g., 1). Identifiers of payment bindings to baskets can be obtained using the method sale.paymentitembasket.list

sale_status

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

Character identifier of the language (e.g., de). Language identifiers can be obtained using the method sale.statuslang.getlistlangs

sale_person_type

Integer identifier of the payer type (e.g., 1). Payer type identifiers can be obtained using the method sale.persontype.list

sale_order_property

Integer identifier of the order property (e.g., 1). Order property identifiers can be obtained using the method sale.property.list

sale_shipment_property

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

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

Integer identifier of the property group (e.g., 1). Property group type identifiers can be obtained using the method sale.propertygroup.list

sale_order_property_value

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

Integer identifier of the property value variant (e.g., 1). Property group type 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

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

Integer identifier of the binding to the order from an external source (e.g., 1). Order binding identifiers can be obtained using the method sale.tradeBinding.list

sale_order_payment

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

Value
type

Description

id
string

Identifier of the shipment line item

orderDeliveryId
sale_order_shipment.id

Identifier of the shipment

basketId
sale_basket_item.id

Identifier of the basket

quantity
float

Quantity of the product

reservedQuantity
float

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

Value
type

Description

id
integer

Identifier of the shipment payment item

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

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

Value
type

Description

id
string

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.

The value is always N. System shipments are not visible through REST and are not intended for direct interaction.

Possible values:

• Y — yes
• N — no

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
datetime

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., 1C)

Possible values:

• Y — yes
• N — no

id1c
string

Identifier of the shipment in 1C

updated1c
string

Indicator of whether this shipment has been synchronized (updated) with 1C

version1c
string

Version of 1C (if the shipment was updated from 1C)

shipmentItems
sale_order_shipment_item[]

Array containing the shipment line items

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 entity (order or delivery) 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

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

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

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
string|number|string[]|number[]

Default value of the order property.

For multiple order properties (multiple), an array of values is supported

settings
object

See the description of 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

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
sale_order_property_value_file_value

Value of the property

shipmentPropsId
sale_shipment_property.id

Identifier of the property

shipmentPropsXmlId
string

External identifier of the shipment property

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
string
sale_order_property_value_file_value

Value of the property

orderPropsId
sale_order_property.id

Identifier of the property

orderPropsXmlId
string

External identifier of the order property

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
integer

Size of the file in bytes

moduleId
string

Module affiliation

originalName
string

Original name of the file

src
string

Full path to the file on the server

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)

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

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

Value
type

Description

entityId
integer

Identifier of the entity

entityType
string

Type of the entity:

• P — payment system
• D — delivery
• L — landing
• T — trading platform

propertyId
sale_order_property.id

Identifier of the property

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

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

Value
type

Description

id
integer

Identifier of the order

lid
string

Identifier of the site where this payer type will be used. Has a constant value of 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 of whether the shipment is marked as problematic. The value Y is automatically set if an error occurred during saving.

• 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

Price

discountValue
double

Value of the discount

taxValue
double

Tax rate on the order

userDescription
string

Customer's comment on the order

additionalInfo
string

Deprecated. Additional information

comments
string

Manager's comment on the order

responsibleId
user.id

Identifier of the user responsible for the order

recurringId
integer

Identifier of the subscription renewal

lockedBy
user.id

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 1C:

• Y — yes
• N — no

orderTopic
string

Deprecated. Order topic

xmlId
string

External identifier

statusXmlId
string

External identifier of the status

id1c
string

Identifier in 1C

version
integer

Document version

version1c
string

Version in 1C

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[]
Array of contacts and companies of the order from the CRM module

Array of objects containing information about the bindings of the order to clients from the CRM module

payments
sale_order_payment[]

Payments of the order

shipments
sale_order_shipment[]

Shipments of the order

propertyValues
sale_order_property[]

Properties of the order

requisiteLink
Array of links to requisites from the CRM module

Links of requisites to the order. The list of links to requisites with CRM entities can be obtained through the method crm.requisite.link.list, where for the order entity_type_id = 14

tradeBindings
sale_order_trade_binding[]

Trading platforms of the order

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

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

Whether the payment system is cash:

• Y — yes
• N — no

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
date

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:

• Y — yes
• N — no

comments
string

Comments on the payment

updated1c
string

Whether the payment was updated through 1C:

• Y — yes
• N — no

id1c
string

Identifier in 1C

version1c
string

Version of the payment document from 1C

externalPayment
string

Whether the payment is external:

• Y — yes
• 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 order

empMarkedId
user.id

Identifier of the user who marked the payment

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 products not available on the site, it is zero

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., 1C)

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 change 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

Amount of tax in percentage. 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

Makes sense only for enabled inventory accounting. 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., 1C)

productXmlId
string

External identifier of the product.

Used for synchronization with external systems (e.g., 1C)

reservations
sale_basket_item_reservation[]

Reservations of the basket item

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

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

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
sale_order_trade_platform.id

Identifier of the trading platform

tradingPlatformXmlId
string

External identifier of the trading platform

params
string

Parameters in serialized form

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

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

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.

Data about the parcel (what to deliver, where, and how) is sent to this URL, and the order needs to be canceled with the delivery service.

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

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

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

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

Value
type

Description

CODE
string

Character code of the setting

VALUE
any

Value of the setting

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)

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

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

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 1C". 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

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 entity, 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 entity, 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