Базовые типы данных
В протоколе обмена используются следующие типы данных:
string(n) - текстовая строка, где n - максимальное количество символов.
integer - целочисленное значение из интервала от 0 до 1 000 000.
float - число с плавающей точкой, в качестве разделителя используется точка.
boolean - логическое значение (возможные значения: true или false).
dateTime - дата и время в формате ISO 8601: YYYY-MM-DDThh:mm:ss±hhmm.
date - дата в формате ISO 8601: YYYY-MM-DD.
time - время в формате ISO 8601: hh:mm.
UUID - уникальный идентификатор, представляет собой 16-байтный номер. Например: 8dea00e3-9aab-4d8e-887c-ef2aaa546456.
money - стоимость услуги/товара с учетом налогообложения
Название поля | Описание | Тип поля | Обязательность |
---|---|---|---|
value | Сумма в валюте | float | да |
vat_sum | Сумма НДС | float | нет |
vat_rate | Ставка НДС (значение - 0, 10, 12, 20, null - нет НДС) | integer | нет |
threshold - дополнительный сбор за доставку в зависимости от стоимости товара
Название поля | Описание | Тип поля | Обязательность |
---|---|---|---|
threshold | Порог стоимости товара (действует по условию меньше или равно) в целых единицах валюты | integer | да |
sum | Доп. сбор за доставку товаров, общая стоимость которых попадает в интервал | float | да |
vat_sum | Сумма НДС, включённая в доп. сбор за доставку | float | нет |
vat_rate | Ставка НДС (значение - 0, 10, 12, 20, null - нет НДС) | integer | нет |
contact - данные контрагента (отправителя, получателя)
Название поля | Описание | Тип поля | Обязательность* |
---|---|---|---|
company | Наименование компании | string(255) | нет |
name | Ф.И.О контактного лица | string(255) | да |
Эл. адрес | string(255) | нет | |
phones | Список телефонов | phone[] | да |
passport_series | Серия паспорта | string(255) | нет |
passport_number | Номер паспорта | string(255) | нет |
passport_date_of_issue | Дата выдачи паспорта | date | нет |
passport_organization | Орган выдачи паспорта | string(255) | нет |
passport_date_of_birth | Дата рождения | date | нет |
tin | ИНН | string(255) | нет |
passport_requirements_satisfied | Требования по паспортным данным удовлетворены (актуально для международных заказов): true - паспортные данные собраны или не требуются | boolean | нет |
*Зависит от типа заказа и контрагента
phone - номер телефона (мобильный/городской)
Название поля | Описание | Тип поля | Обязательность |
---|---|---|---|
number | Номер телефона Необходимо передавать в международном формате: код страны (для России +7) и сам номер (10 и более цифр) | string(255) | да |
additional | Дополнительная информация (добавочный номер) | string(255) | нет |
seller - данные истинного продавца
Название поля | Описание | Тип поля | Обязательность |
---|---|---|---|
name | Наименование истинного продавца | string(255) | нет |
inn | ИНН истинного продавца | string(20) | нет |
phone | Телефон истинного продавца | string(255) | нет |
ownership_form | Код формы собственности | integer | нет |
address | Адрес истинного продавца. Используется при печати инвойсов для отображения адреса настоящего продавца товара, либо торгового названия | string(255) | нет |
location - адрес местоположения контрагента (отправителя, получателя), включая геолокационные данные
Название поля | Описание | Тип поля | Обязательность |
---|---|---|---|
code | Код населенного пункта СДЭК (метод "Список населенных пунктов") | integer | нет |
fias_guid | Уникальный идентификатор ФИАС | UUID | нет |
postal_code | Почтовый индекс | string(255) | нет |
longitude | Долгота | float | нет |
latitude | Широта | float | нет |
country_code | Код страны в формате ISO_3166-1_alpha-2 | string(2) | нет |
region | Название региона | string(255) | нет |
sub_region | Название района региона | string(255) | нет |
city | Название города | string(255) | нет |
kladr_code | Код КЛАДР Устаревшее поле | string(255) | нет |
address | Строка адреса | string(255) | да |
service - данные о дополнительных услугах
Название поля | Описание | Тип поля | Обязательность |
---|---|---|---|
code | Код дополнительной услуги | string | да |
parameter | Параметр дополнительной услуги | string | нет |
package - информация о местах заказа
Название поля | Описание | Тип поля | Обязательность |
---|---|---|---|
number | Номер упаковки (можно использовать порядковый номер упаковки заказа или номер заказа), уникален в пределах заказа. Идентификатор заказа в ИС Клиента | string(255) | да |
weight | Общий вес (в граммах) | integer | да |
length | Габариты упаковки. Длина (в сантиметрах) | integer | нет |
width | Габариты упаковки. Ширина (в сантиметрах) | integer | нет |
height | Габариты упаковки. Высота (в сантиметрах) | integer | нет |
comment | Комментарий к упаковке | string(255) | нет |
items | Позиции товаров в упаковке | item[] | нет |
item - информация о товарах места заказа (только для заказа типа "интернет-магазин")
Название поля | Описание | Тип поля | Обязательность |
---|---|---|---|
name | Наименование товара (может также содержать описание товара: размер, цвет) | string(255) | да |
ware_key | Идентификатор/артикул товара | string(20) | да |
payment | Оплата за товар при получении (за единицу товара в указанной валюте, значение >=0) — наложенный платеж, в случае предоплаты значение = 0 | money | да |
cost | Объявленная стоимость товара (за единицу товара в указанной валюте, значение >=0). С данного значения рассчитывается страховка | float | да |
weight | Вес (за единицу товара, в граммах) | integer | да |
weight_gross | Вес брутто | integer | нет |
amount | Количество единиц товара (в штуках) | integer | да |
name_i18n | Наименование на иностранном языке | string(255) | нет |
brand | Бренд на иностранном языке | string(255) | нет |
country_code | Код страны в формате ISO_3166-1_alpha-2 | string(2) | нет |
material | Код материала | string(255) | нет |
wifi_gsm | Содержит wifi/gsm | boolean | нет |
url | Ссылка на сайт интернет-магазина с описанием товара | string(255) | нет |
error - данные об ошибке обработки запроса на стороне ИС СДЭК
Название поля | Описание | Тип поля | Обязательность |
---|---|---|---|
code | Код ошибки | string(255) | да |
message | Описание ошибки | string(255) | да |
status - статус заказа, заявки
Название поля | Описание | Тип поля | Обязательность |
---|---|---|---|
code | Код статуса | string(255) | да |
name | Название статуса | string(255) | да |
date_time | Дата и время установки статуса (формат yyyy-MM-dd'T'HH:mm:ssZ) | datetime | да |
reason_code | Дополнительный код статуса | string(2) | нет |
city | Наименование места возникновения статуса | string(255) | нет |
© 2000—2024, Курьерская компания СДЭК