Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Тэг/Атрибут

Описание

Тип поля

Обяз. для заполн.

1

DeliveryRequest

Заголовок документа


да

1.1

Number

Номер акта приема-передачи/ТТН (сопроводительного документа при передаче груза СДЭК, формируется в системе ИМ).  Идентификатор реестра грузов в ИС клиента СДЭК. По умолчанию можно использовать 1.

string(30)

да

1.2

Date

Дата документа (дата заказа)

Date time/date

да

1.3

Account

Идентификатор ИМ (логин)

string(255)

да

1.4

Secure

Ключ

string(255)

да

1.5

OrderCount

Общее количество заказов в документе

integer

да

1.6

Order

Отправление (заказ)


да

1.6.1

Number

Номер отправления клиента (уникален в пределах заказов одного клиента). Идентификатор заказа в ИС Клиента.

string(40)

да

1.6.2

SendCityCode1

Код города отправителя из базы СДЭК (Список городов)

integer

да

1.6.3

RecCityCode1

Код города получателя из базы СДЭК (Список городов)

integer

да

1.6.4

SendCityPostCode1

Почтовый индекс города отправителя

string(6)

да

1.6.5

RecCityPostCode1

Почтовый индекс города получателя

string(6)

да

1.6.6

SendCountryCode1

Код страны отправителя для идентификации страны в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”). По умолчанию - RU.

string(2)

нет

1.6.7

RecCountryCode1

Код страны получателя для идентификации страны в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”). По умолчанию - RU.

string(2)

нет

1.6.8

SendCityName1

Наименование города отправителя

string(255)

нет

1.6.9

RecCityName1

Наименование города получателя

string(255)

нет

1.6.10RecipientINNИНН получателя. Используется для международных заказовstring(12)нет
1.6.11DateInvoiceДата инвойса. Используется для международных заказовDate time/dateда, если заказ - международный
1.6.12ShipperName

Грузоотправитель. Используется при печати накладной. Используется для международных заказов

string (255)да, если заказ - международный
1.6.13ShipperAddressАдрес грузоотправителя. Используется при печати накладной. Используется для международных заказовstring (255)да, если заказ - международный
1.6.14PassportДанные паспорта получателя. Используется для международных заказов
нет
1.6.14.1SeriesСерия паспорта получателяstring (255)нет
1.6.14.2NumberНомер паспорта получателяstring (255)нет
1.6.14.3IssueDateДата выдачи паспорта получателяDate time/dateнет
1.6.14.4IssuedByКем выдан паспорт получателяstring (255)нет
1.6.14.5DateBirthДата рождения получателяDate time/dateнет

1.6.15

Sender

Отправитель. Обязательно указывать, если отличается от Клиента ИМ. Если ИМ является отправителем, тэг Sender - отсутствует.


нет

1.6.15.1

Company

Наименование компании отправителя

string(128)

нет

1.6.15.2

Name

Контактное лицо отправителя

string(128)

нет

1.6.15.3

Address1

Адрес отправителя


нет

1.6.15.3.1

Street

Улица

string(50)

да

1.6.15.3.2

House

Дом

string(30)

нет

1.6.15.3.3

Flat

Квартира/офис

string(10)

нет

1.6.15.4

Phone

Телефон отправителя (передается отдельным тегом)

phone

нет

1.6.16

RecipientName

Получатель (ФИО). Минимум 3 символа.

string(128)

да

1.6.17

RecipientEmail

E-mail получателя для рассылки уведомлений о движении заказа, для связи в случае недозвона.

еmail

нет

1.6.18

Phone

Телефон получателя

phone

да

1.6.19

TariffTypeCode7

Код типа тарифа (подробнее см. приложение 1)

integer

да

1.6.20

DeliveryRecipientCost2

Доп. сбор за доставку, которую ИМ берет с получателя (в валюте страны получателя).

Если доп. сбор зависит от стоимости заказа, то данную информацию необходимо передавать в блоке DeliveryRecipientCostAdv. В этом случае в данном теге (DeliveryRecipientCost) передается стоимость доставки, когда сумма заказа превысила максимальный порог.

float

нет

1.6.21

DeliveryRecipientVATRateСтавка НДС, включенная в доп. сбор за доставку (подробнее см. приложение 4). Если значение не передано, то берется значение по умолчанию "Без НДС"string(10)нет

1.6.22

DeliveryRecipientVATSumСумма НДС, включенная в доп. сбор за доставку.floatнет
1.6.23SellerРеквизиты истинного продавца
нет
1.6.23.1AddressАдрес истинного продавца. Используется при печати инвойсов для отображения адреса настоящего продавца товара, либо торгового названия. Используется для международных заказовstring (255)да, если заказ - международный
1.6.23.2NameНаименование истинного продавцаstring (255)да, если указан ИНН
1.6.23.3INNИНН истинного продавцаstring (20)нет
1.6.23.4PhoneТелефон истинного продавцаphoneда, если указан ИНН
1.6.23.5OwnershipFormКод формы собственности (подробнее см. приложение 10)integerда, если указан ИНН

1.6.24

Comment3

Комментарий особые отметки по заказу

string(255)

нет

1.6.25

Address1

Адрес доставки. В зависимости от режима доставки необходимо указывать либо атрибуты «Street», «House», «Flat» - доставка до адресата получателя, либо «PvzCode» - самозабор


да

1.6.25.1

Street

Улица получателя. Рекомендуем по возможности не указывать префиксы значений, вроде «ул.»

string(50)

да

1.6.25.2

House

Дом, корпус, строение получателя.  Рекомендуем по возможности не указывать префиксы значений, вроде «дом»

string(30)

нет

1.6.25.3

Flat

Квартира/Офис получателя. Рекомендуем по возможности не указывать префиксы значений, вроде «кв.»

string(10)

нет

1.6.25.4

PvzCode

Код ПВЗ. Атрибут необходим для заказов с режимом доставки «до склада» и при условии, что не заказана дополнительная услуга "Доставка в городе получателе"(AddService="17", подробнее см. приложение 2), и для заказов с режимом "до постамата" 
Если указанный ПВЗ в момент создания заказа закрыт, то заказ будет принят на другой открытый ПВЗ, находящийся рядом с выбранным. Если указанный постамат в момент создания заказа закрыт, то заказ будет принят на другой открытый постамат или ПВЗ, находящийся рядом с выбранным. Получателю при этом уйдет СМС оповещение о замене ПВЗ/постамата. Если в городе все ПВЗ/постаматы в соответствии с выбранной услугой и тарифом закрыты, то регистрация заказа невозможна, будет возвращено соответствующее сообщение об ошибке.

string(10)

да, если режим доставки "до склада" или "до постамата"

1.6.26

Package

Упаковка (все упаковки передаются в разных тэгах Package)


да

1.6.26.1

Number

Номер упаковки (можно использовать порядковый номер упаковки заказа или номер заказа), уникален в пределах заказа. Идентификатор заказа в ИС Клиента.

string(20)

нет

1.6.26.2

BarCode

Штрих-код упаковки, идентификатор грузоместа (если есть, иначе передавать значение номера упаковки Packege.Number). Параметр используется для оперирования грузом на складах СДЭК), уникален в пределах заказа. Идентификатор грузоместа в ИС Клиента.

string(20)

да

1.6.26.3

Weight7

Общий вес (в граммах)

integer

да

1.6.26.4

SizeA4  

Габариты упаковки. Длина (в сантиметрах)

integer

да, если указаны остальные габариты, в пределах от 1 до 1500
или
если заказ до постамата
или
Общий вес >= 100 гр

1.6.26.5

SizeB4  

Габариты упаковки. Ширина (в сантиметрах)

integer

да, если указаны остальные габариты, в пределах от 1 до 1500
или
если заказ до постамата
или
Общий вес >= 100 гр

1.6.26.6

SizeC4  

Габариты упаковки. Высота (в сантиметрах)

integer

да, если указаны остальные габариты, в пределах от 1 до 1500
или
если заказ до постамата
или
Общий вес >= 100 гр

1.6.26.7

Item9

Вложение (товар). Максимум 126 позиций.


да

1.6.26.7.1AmountКоличество единиц одноименного товара (в штуках).
Максимальное количество - 999.
integerда
1.6.26.7.2

WareKey

Идентификатор/артикул товара/вложения.

string(50)

да

1.6.26.7.3Marking8

Маркировка товара/вложения.
Если для товара/вложения указана маркировка, Amount не может быть больше 1.

Для корректного отображения маркировки товара в чеке требуется передавать РАЗОБРАННЫЙ тип маркировки, который может выглядеть следующим образом: 

1) Массив байт закодированный в формате base64 

Пример: RE0DSU3xvJVMTFdHY3FUbVdSQkZI

2) Массив в виде строки, с пробелами или без:

Пример 1: 44 4D 04 3D 02 64 1E D1 3E 69 55 72 54 54 4E 2B 65 54 4D 63 74

Пример 2: 444D043D02641ED13E69557254544E2B65544D6374

stringнет
1.6.26.7.4

Cost

Объявленная стоимость товара (за единицу товара в валюте взаиморасчетов, значение >=0). С данного значения рассчитывается страховка.

float

да

1.6.26.7.5

Payment

Оплата за товар при получении (за единицу товара в валюте страны получателя, значение >=0) — наложенный платеж, в случае предоплаты значение = 0.

float

да

1.6.26.7.6PaymentVATRateСтавка НДС, включенная в стоимость товара (подробнее см. приложение 4). Если значение не передано, то берется значение по умолчанию "Без НДС"string(10)нет
1.6.26.7.7PaymentVATSumСумма НДС, включенного в стоимость (payment) товара.floatнет
1.6.26.7.8WeightВес (за единицу товара, в граммах)integerда
1.6.26.7.9CommentНаименование товара (может также содержать описание товара: размер, цвет)string(255)да
1.6.26.7.10WeightBrutto

Вес брутто (за единицу товара, в граммах). Используется для международных заказов

integerда, если заказ - международный
1.6.26.7.11CommentExНаименование товара  на английском (может также содержать описание товара: размер, цвет). Используется для международных заказовstring(255)нет
1.6.26.7.12Link

Ссылка на сайт интернет-магазина с описанием товара. Используется для международных заказов

string(255)нет
1.6.27DeliveryRecipientCostAdvДоп. сбор за доставку (которую ИМ берет с получателя), в зависимости от суммы заказа
нет
1.6.27.1ThresholdПорог стоимости товара (действует по условию меньше или равно), в целых единицах валютыintegerда
1.6.27.2SumДоп. сбор за доставку товаров, общая стоимость которых попадает в интервалfloatда
1.6.27.3VATRateСтавка НДС, включенная в доп. сбор за доставку (подробнее см. приложение 4). Если значение не передано, то берется значение по умолчанию "Без НДС"string(10)нет
1.6.27.4VATSumСумма НДС, включенная в доп. сбор за доставку.floatнет
1.6.28AddServiceДополнительные услуги
нет
1.6.28.1

ServiceCode

Тип дополнительной услуги (подробнее см. приложение 2)integerда
1.6.28.2CountКоличество упаковок. Используется и является обязательным только для дополнительной услуги дополнительных услуг "Упаковка 1".", "Пакет курьерский А2", "Сейф пакет А2", "Сейф пакет А3", "Сейф пакет А4", "Сейф пакет А5"integerнет
1.6.29Schedule5Расписание времени доставки (deprecated, рекомендуется использовать отдельный метод new_schedule)
нет

1.6.29.1

Attempt

Время доставки (в один день возможен один временной интервал не менее 3 часов)


да

1.6.29.1.1

ID

Идентификационный номер расписания по базе ИМ. По умолчанию можно использовать 1

integer

да

1.6.29.1.2

Date

Дата доставки (только дата, в формате «YYYY-MM-DD», без времени) согласованная с получателем

date

да

1.6.29.1.3

Comment

Комментарий

string(255)

нет

1.6.29.1.4

TimeBeg

Начало временного диапазона доставки (время получателя)

time

да

1.6.29.1.5

TimeEnd

Окончание временного диапазона доставки (время получателя)

time

да

1.6.29.1.6

Address

Новый адрес доставки (если требуется изменить). В зависимости от режима доставки необходимо указывать либо атрибуты «Street», «House», «Flat» - доставка до адресата получателя, либо «PvzCode» - самозабор


нет

1.6.29.1.6.1

Street

Улица получателя. Рекомендуем по возможности не указывать префиксы значений вроде «ул.»

string(50)

да

1.6.29.1.6.2

House

Дом, корпус, строение получателя.  Рекомендуем по возможности не указывать префиксы значений вроде «дом»

string(30)

да

1.6.29.1.6.3

Flat

Квартира/Офис получателя.  Рекомендуем по возможности не указывать префиксы значений вроде «кв.»

string(10)

нет

1.6.29.1.6.4

PvzCode

Код ПВЗ, необходим только для заказов с режимом доставки «до склада» и при условии, что не заказана дополнительная услуга "Доставка в городе получателе".

string(10)

да

1.7CallCourier6Вызов курьера
нет

1.7.1

Call

Ожидание курьера


да

1.7.1.1

Date

Дата ожидания курьера

date

да

1.7.1.2

TimeBeg

Время начала ожидания курьера

time

да

1.7.1.3

TimeEnd

Время окончания ожидания курьера

time

да

1.7.1.4

LunchBeg

Время начала обеда, если входит во временной диапазон [TimeBeg; TimeEnd]

time

нет

1.7.1.5

LunchEnd

Время окончания обеда, если входит во временной диапазон [TimeBeg; TimeEnd]

time

нет

1.7.1.6

SendCityCode1

Код города отправителя из базы СДЭК (Список городов)

integer

да

1.7.1.7

SendCityPostCode1

Почтовый индекс города отправителя

string(6)

да

1.7.1.8

SendCountryCode1

Код страны отправителя для идентификации страны в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”)

string(2)

нет

1.7.1.9

SendCityName1

Наименование города отправителя

string(255)

нет

1.7.1.10

SendPhone

Контактный телефон отправителя

phone

да

1.7.1.11

SenderName

Отправитель (ФИО)

string(255)

да

1.7.1.12

Comment

Комментарий для курьера

string(255)

нет

1.7.1.13

SendAddress1

Адрес отправителя


да

1.7.1.13.1

Street

Улица отправителя. Рекомендуем по возможности не указывать префиксы значений, вроде «ул.»

string(50)

да

1.7.1.13.2

House

Дом, корпус, строение отправителя.  Рекомендуем по возможности не указывать префиксы значений, вроде «дом»

string(30)

да

1.7.1.13.3

Flat

Квартира/Офис отправителя.  Рекомендуем по возможности не указывать префиксы значений, вроде «кв.»

string(10)

да

...

Тэг/Атрибут

Описание

Тип поля

Обяз. для заполн.

1

DeliveryRequest

Заголовок документа


да

1.1

Number

Номер акта приема-передачи/ТТН.  Идентификатор реестра грузов в ИС клиента СДЭК. По умолчанию можно использовать 1.

string(30)

да

1.2

Date

Дата документа (дата заказа)

Date time/date

да

1.3

Account

Идентификатор Клиента (логин)

string(255)

да

1.4

Secure

Ключ

string(255)

да

1.5

OrderCount

Общее количество заказов в документе

integer

да

1.6

Order

Отправление (заказ)


да

1.6.1

SendCityCode1

Код города отправителя из базы СДЭК (Список городов)

integer

да

1.6.2

RecCityCode1

Код города получателя из базы СДЭК (Список городов)

integer

да

1.6.3

SendCityPostCode1

Почтовый индекс города отправителя

string(6)

да

1.6.4

RecCityPostCode1

Почтовый индекс города получателя

string(6)

да

1.6.5

SendCountryCode1

Код страны отправителя для идентификации страны в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”). По умолчанию - RU.

string(2)

нет

1.6.6

RecCountryCode1

Код страны получателя для идентификации страны в формате ISO_3166-1_alpha-2 (см. “Общероссийский классификатор стран мира”). По умолчанию - RU.

string(2)

нет

1.6.7

SendCityName1

Наименование города отправителя

string(255)

нет

1.6.8

RecCityName1

Наименование города получателя

string(255)

нет

1.6.9

Sender

Отправитель


да

1.6.91

Company

Наименование компании отправителя

string(128)

нет

1.6.9.2

Name

Контактное лицо отправителя

string(128)

да

1.6.9.3

Address1

Адрес забора груза


да

1.6.9.3.1

Street

Улица

string(50)

да

1.6.9.3.2

House

Дом

string(30)

нет

1.6.9.3.3

Flat

Квартира/офис

string(10)

нет

1.6.9.4

Phone

Телефон отправителя (передается отдельным тегом)

phone

да

1.6.10RecipientCompanyНаименование компании получателяstring(128)да

1.6.11

RecipientName

Получатель (ФИО). Минимум 3 символа.

string(128)

да

1.6.12

RecipientEmail

E-mail получателя для рассылки уведомлений о движении заказа, для связи в случае недозвона.

еmail

нет

1.6.13

Phone

Телефон получателя

phone

да

1.6.14

TariffTypeCode7

Код типа тарифа (подробнее см. приложение 1)

integer

да

1.6.15

Comment3

Комментарий особые отметки по заказу

string(255)

нет

1.6.16

Address1

Адрес доставки. В зависимости от режима доставки необходимо указывать либо атрибуты «Street», «House», «Flat» - доставка до адресата получателя, либо «PvzCode» - самозабор


да

1.6.16.1

Street

Улица получателя. Рекомендуем по возможности не указывать префиксы значений, вроде «ул.»

string(50)

да

1.6.16.2

House

Дом, корпус, строение получателя.  Рекомендуем по возможности не указывать префиксы значений, вроде «дом»

string(30)

нет

1.6.16.3

Flat

Квартира/Офис получателя. Рекомендуем по возможности не указывать префиксы значений, вроде «кв.»

string(10)

нет

1.6.16.4

PvzCode

Код ПВЗ. Атрибут необходим для заказов с режимом доставки «до склада» и при условии, что не заказана дополнительная услуга "Доставка в городе получателе"(AddService="17", подробнее см. приложение 2), и для заказов с режимом "до постамата" 
Если указанный ПВЗ в момент создания заказа закрыт, то заказ будет принят на другой открытый ПВЗ, находящийся рядом с выбранным. Если указанный постамат в момент создания заказа закрыт, то заказ будет принят на другой открытый постамат или ПВЗ, находящийся рядом с выбранным.Получателю при этом уйдет СМС оповещение о замене ПВЗ/постамата. Если в городе все ПВЗ/постаматы в соответствии с выбранной услугой и тарифом закрыты, то регистрация заказа невозможна, будет возвращено соответствующее сообщение об ошибке.

string(10)

да, если режим доставки "до склада" иди "до постамата"

1.6.17

Package

Упаковка (все упаковки передаются в разных тэгах Package)


да

1.6.17.1

Number

Номер упаковки (можно использовать порядковый номер упаковки заказа или номер заказа), уникален в пределах заказа. Идентификатор заказа в ИС Клиента.

string(20)

нет

1.6.17.2

BarCode

Штрих-код упаковки, идентификатор грузоместа (если есть, иначе передавать значение номера упаковки Packege.Number). Параметр используется для оперирования грузом на складах СДЭК), уникален в пределах заказа. Идентификатор грузоместа в ИС Клиента.

string(20)

да

1.6.17.3

Weight7

Общий вес (в граммах)

integer

нет

1.6.17.4

SizeA4  

Габариты упаковки. Длина (в сантиметрах)

integer

да, если указаны остальные габариты, в пределах от 1 до 1500
или
если заказ до постамата
или
Общий вес >= 100 гр

1.6.17.5

SizeB4  

Габариты упаковки. Ширина (в сантиметрах)

integer

да, если указаны остальные габариты, в пределах от 1 до 1500
или
если заказ до постамата
или
Общий вес >= 100 гр

1.6.17.6

SizeC4  

Габариты упаковки. Высота (в сантиметрах)

integer

да, если указаны остальные габариты, в пределах от 1 до 1500
или
если заказ до постамата
или
Общий вес >= 100 гр

1.6.17.7CommentОписаниеstring(255)да
1.6.18AddServiceДополнительные услуги
нет
1.6.18.1

ServiceCode

Тип дополнительной услуги (подробнее см. приложение 2)integerда
1.6.18.2CostОбъявленная стоимость отправления (заказа). Используется и является обязательным только для дополнительной услуги "Страхование".floatнет
1.6.18.3CountКоличество упаковок. Используется и является обязательным только для дополнительной услуги дополнительных услуг "Упаковка 1".", "Пакет курьерский А2", "Сейф пакет А2", "Сейф пакет А3", "Сейф пакет А4", "Сейф пакет А5"integerнет

Идентификация города отправителя и города получателя (в случае режима "до двери") производится по следующему алгоритму в порядке приоритетности:

...

ПараметрОписаниеТип поля
1error

Массив ошибок при их возникновении (подробнее см. приложение 9)


1.1codeКод ошибкиinteger
1.2textТекст ошибкиstring
2priceСумма за доставку в рубляхdouble
3deliveryPeriodMinМинимальное время доставки в рабочих дняхinteger
4deliveryPeriodMaxМаксимальное время доставки в рабочих дняхinteger
5deliveryDateMinУстаревшее поле. Неккоректно Некорректно использовать в качестве планируемой даты доставки.
Минимальная дата доставки, формате 'ГГГГ-ММ-ДД', например “2018-07-29”
string
6deliveryDateMaxУстаревшее поле. Неккоректно Некорректно использовать в качестве планируемой даты доставки.
Максимальная дата доставки, формате 'ГГГГ-ММ-ДД', например “2018-07-30”
string
7tariffIdКод тарифа, по которому рассчитана сумма доставкиinteger
8cashOnDeliveryОграничение оплаты наличными, появляется только если оно естьfloat
9priceByCurrencyЦена в валюте взаиморасчетов. Валюта определяется по authLogin и secure.float
10currencyВалюта интернет-магазина (подробнее см. приложение 3)string
11percentVATРазмер ставки НДС для данного клиента. Появляется в случае, если переданы authLogin и secure, по ним же определяется ставка ИМ. Если ставка НДС не предусмотрена условиями договора, данный параметр не будет отображен.integer
12servicesСписок передаваемых дополнительных услуг (подробнее см. приложение 2)
12.1idИдентификатор переданной услугиinteger
12.2titleЗаголовок услугиstring
12.3priceСтоимость услуги без учета НДС в рубляхfloat
12.4rateПроцент для расчета дополнительной услугиfloat

...