...
Обязательно к ознакомлению: Проверки и условия при загрузке заказов.
Описание передаваемых данныхВходящие параметры:
Параметр |
---|
Тип
Обяз. |
---|
ПВЗ
КД
ПР
Обязательные поля для Почты РФ (vid = 3) | Тип | Описание | Пример | |
---|---|---|---|---|
token | ● | ● |
string | Токен для доступа к |
api-сервисам |
Да
Да
0237b078818a23ae8d765a04405116de | |||||
partner_token | string | Токен партнера интеграции (длина до 24 символов) |
Нет
- |
Нет
updateByTrack | string |
Трек- |
номер посылки для обновления | - |
Нет
Нет
order_id | ● | ● | string |
id - идентификатор (номер) заказа ИМ.
Допустимые символы: a-z(A-Z), 0-9, а-я(А-Я), ёЁ, тире(-), прямой слеш(/),
точка(.), запятая(,), нижнее подчеркивание(_), №, пробел.
Да
Да
Номер заказа в интернет-магазине | test-001 |
PalletNumber | string | Номер |
Нет
Нет
паллеты | - |
barcode | string | Штрих-код посылки |
См. Требования к этикетке.
RTES4545S | |||
price | ● |
Нет
Нет
Нет
string | Объявленная стоимость |
Нет
Нет
Нет
посылки | 2000.00 | ||||
payment_sum | string | Сумма к оплате |
с получателя |
2000.00 |
Нет
Нет
delivery_sum | string | Стоимость доставки |
Нет
Нет
Нет
объявленная получателю | 250.00 | ||
vid | ● |
string | Вид доставки |
: 1 |
- Доставка до пункта выдачи (ПВЗ) |
2 |
- Курьерская доставка |
(КД) |
3 |
1 – самовывоз (доставка до ПВЗ).
- доставка Почтой России (ПР) | 2 | ||
kurdost [1..1] | ● |
Да
Да
Да
kurdost
Блок с информацией о курьерской доставке |
и доставке Почтой России |
Нет
Да
Да
index | string | Почтовый индекс адреса получателя |
Нет
Нет
603034 | |||
citi | string |
Населенный пункт получателя. Для небольших населенных пунктов указывать дополнительно Область, Район, Город, адрес проверяется сторонним сервисом и должен определяться однозначно. Допустимы варианты:
|
|
Нижний Новгород | ||
addressp | ● |
Нет
Да
Да
string | Адрес получателя |
Разрешенные символы: ^-0-9а-яёА-ЯЁ.,:;()№/
Допустимые варианты:
- ул Ереванская, д 3, кв (номер квартиры)
- ул. Ереванская, д. 3, кв. (номер квартиры)
- пр-кт Андропова, д 10 к 3, кв (номер квартиры)
Дружбы, 5 |
Нет
Да
Следующие значения передаются только для Курьерской доставки по направлениям: |
Москва - Москва |
Москва - Санкт-Петербург |
Москва |
Санкт-Петербург |
Нет
Нет
delivery_date | string | Дата курьерской доставки (формат ГГГГ-ММ-ДД). Может принимать значения +1 +5 дней от текущей даты. Значение по умолчанию - текущая дата + 1 день. По другим направлениям игнорируется. |
Нет
Нет
Нет
2019-07-08 | ||||
timesfrom1 | string | Время курьерской доставки |
ОТ (формат чч:мм). Значение по умолчанию 10:00 |
Нет
Нет
11:00 | ||||
timesto1 | string | Время курьерской доставки |
ДО (формат чч:мм) Значение по умолчанию 18:00 Интервал доставки "ОТ-ДО" должен быть не менее 3 часов. Если интервал меньше 3 часов, он корректируется без уведомления. |
Нет
Нет
16:00 | ||||
timesfrom2 | string | Альтернативное время, от |
Нет
Нет
17:00 |
timesto2 | string | Альтернативное время, до |
Нет
Нет
20:00 |
timep | string | Время доставки текстовый |
В данный момент этот параметр не обрабатывается.
формат (не используется) | - |
Нет
Нет
Нет
Нет
Нет
comentk | string | Комментарий |
В данный момент этот параметр не обрабатывается.
по доставке (не используется) | - |
Следующие значения передаются только для доставки Почтой России |
Нет
Нет
type | string | Тип отправления, возможные значения: |
0 - Посылка, |
- Курьер Онлайн, |
3 - Посылка Онлайн, |
5 - Посылка 1й класс. Если не передано, значение по умолчанию 0. |
Нет
Нет
- | ||||
fragile | string | Хрупкая посылка, возможные значения 0 и 1. Если не передано, |
значение по умолчанию 0. |
Нет
Нет
- | ||||
strong | string | Строгий тип, возможные значения 0 и 1. Если не передано, значение по умолчанию 0. |
- |
Нет
Нет
optimize | string | Оптимизация тарифа, возможные значения 0 и 1. Если не передано, значение по умолчанию 1. Параметры strong |
и optimize являются взаимоисключающими и не могут одновременно принимать значение 1. |
Нет
- |
Нет
packing_type | ● |
Нет
Нет
Нет
int | Тип упаковки, возможные значения: |
0 – упаковка ИМ, сумма сторон </= 106 см
1 – упаковка ИМ, сумма сторон > 106 см
2 – упаковка Boxberry, сумма сторон </= 106 см
3 – упаковка Boxberry, сумма сторон > 106 см
1 - упаковка ИМ | - |
packing_strict |
● | int | Строгая упаковка, возможные значения: |
1 - изменение упаковки в процессе транспортировки запрещено |
0 - изменение упаковки разрешено |
Нет
Нет
Нет
- | ||
shop [1..1] | ● |
Блок с информацией о пункте приема и пункте выдачи отправления |
Да
Да
name | string | Код пункта выдачи заказа |
Да
Нет
- | ||||
name1 | string | Код пункта поступления |
Да
Да
Да
010 | ||||||
customer [1..1] | ● | ● | Блок с информацией о получателе отправления |
fio |
● |
Да
● | string | ФИО получателя |
Иванов Иван Иванович |
phone |
● |
● | string | Номер |
телефона получателя |
Для РФ: в формате
, Телефон должен содержать 10 цифр |
, |
Для Казахстана (код 398) или Беларуси (код 112): в формате 12 цифр (без тире, скобок и знака "+")
в противном случае, все символы обрезаются и используется 10 цифр с конца. | 9001122333 |
Да
Да
phone2 | string | Дополнительный номер телефона получателя |
Нет
9004455666 |
Нет
Нет
Нет
Нет
string |
получателя для оповещений | test@test.ru |
Следующие значения передаются для получателя юр.лица |
Нет
Нет
name | string | Наименование организации |
Да
Да
Да
ООО "Получатель" | |||
address | string |
Юридический адрес организации
Нет
Нет
Адрес организации | - |
inn | string | ИНН |
Да
Да
- | ||||
kpp | string | КПП |
Нет
Нет
- | ||||
r_s | string | Расчетный счет |
Нет
- |
Нет
bank | string |
Наименование банка |
kor_s
- |
Нет
Нет
bank |
string | Корр. |
счет |
- |
Нет
Нет
bik | string | БИК |
Нет
Нет
Нет
items
Блок с информацией по товарным позициям, включённым в заказ. Проверяется корректность заполнения обязательных и необязательных полей.
Обязательно к ознакомлению: Условия загрузки заказов с товарными позициями:
Нет*
Нет*
- | ||||||
items [0..∞] | массив товарных вложений |
id | string |
Идентификатор/артикул товарной позиции
Нет
Нет
Нет
Артикул товара | 252112-dget | |
name | ● | ● |
string | Наименование товара |
Да
Да
Куртка детская | ||||
UnitName | string | Единица измерения |
шт. |
Нет
Нет
Нет
nds | string | Процент НДС (число от 0 до 20) |
18 |
price |
● |
● | string | Цена за единицу товара |
1750 |
quantity |
● |
● | string | Количество единиц товара |
Да
Да
1 |
marking_crpt | string | Маркировка |
- В формате JSON - специальные символы экранировать.
- В формате SOAP - специальные символы передавать в теге <![CDATA[ ... ]]>, иначе маркировка товара не сохранится.
Пример, <marking_crpt><![CDATA[00000217553+lVfTHoca%>km&]]></marking_crpt>
Нет
Нет
Нет
товара |
04610043040058 |
notice | string | Примечание к заказу |
Если у заказа несколько мест (несколько этикеток), то данные по примечанию выводятся на каждой этикетке.
Количество символов <= 100.
Нет
Нет
Нет
weights
Информация о весе ЗП:
- weight - вес первого или единственного тарного места, в граммах. Минимальное значение 5 г, максимальное – 31000 г.
- weight2, weight3, … weight24 - вес второго и последующих тарных мест, в граммах. Внимание, данные строки добавляются только в случае, если ЗП отправляется двумя и более тарными местами.
Информация о штрих-кодах мест, передается в случае собственной маркировки уникальными ШК каждого тарного места:
- Каждый баркод должен заполняться в соответствующей строке веса
- Если у заполненных мест указан хотя бы один баркод, то и остальные необходимо указать.
- Если у мест указан баркод, то "Штрих-код ЗП" заполнять необязательно.
Позвонить в домофон | ||||||
weights | ● | ● | Блок с информацией о тарных местах ( |
SOAP - количество элементов 24, |
Да
Да
Да
JSON - неограничено) | |||
weight | ● | ● |
string | Вес первого тарного места (гр) |
400 |
Да
Да
barcode | string | Баркод |
первого тарного места |
Передается в случае собственной маркировки посылок.
См.Требования к этикетке.
- | ||
x | ● |
Нет
Нет
Нет
Нет
Нет
Да
y
string
Нет
Нет
Да
z
string
Нет
Нет
Да
string | Габариты тарного места (см) |
Обязательны для доставки Почтой России.
| 20 | |||
y | ● | string | 20 | |
z | ● | string | 10 |
weight2 | string | Вес, баркоды и |
габариты последующих тарных мест |
Нет
- | ||||
barcode2 | string | - | ||
x2 | string |
- |
y2 | string | - |
z2 |
string | - |
....... | - | |||
weight24 | string | - | ||
barcode24 | string |
Нет
- | ||||
x24 | - | |||
y24 | - | |||
z24 |
- |
YFR | string |
Нет
(не используется) | - | ||||
issue | integer | Вид выдачи, возможные значения: |
0 - выдача без вскрытия, 1 |
- выдача со вскрытием и проверкой комплектности, |
2 - выдача части вложения. Если не передается, используется значение по умолчанию, установленное в Профиле магазина - раздел "Услуги". |
Нет
Нет
1 | |||||
sender_name | string | Наименование магазина отправителя для sms/e-mail оповещений. |
Нет
Нет
- | ||||||
gift | boolean | (не используется) | - |
Данные ответа:
Параметр | Обяз. | Тип | Описание | Пример |
---|---|---|---|---|
track | ● | string | Трек-номер посылки для отслеживания | BBR13790374 |
label | string | Ссылка на печать этикетки (генерируется если не передан штрих-код интернет-магазина) | - |