Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

Обязательно к ознакомлению: Проверки и условия при загрузке заказов.

Описание передаваемых данныхВходящие параметры:

Параметр

Тип

Описание

Обяз.

для запол.

ПВЗ

КД

ПР

Обязательные поля для Почты РФ
(vid = 3)

Тип

Описание

Пример

token ●
token
stringТокен для доступа к
API
api-сервисам
.

Да

Да

Да
0237b078818a23ae8d765a04405116de
partner_token

stringТокен партнера интеграции (длина до 24 символов)
.Нет

Нет

-

Нет

updateByTrack

string
Трекинг
Трек-
код ранее созданной посылки. Внимание, если параметр updateByTrack будет заполнен, считается что вы хотите обновить ранее созданную посылку.
номер посылки для обновления-

Нет

Нет

Нет
order_id ●string

id - идентификатор (номер) заказа ИМ.
Допустимые символы: a-z(A-Z), 0-9, а-я(А-Я), ёЁ, тире(-), прямой слеш(/),
точка(.), запятая(,), нижнее подчеркивание(_), №, пробел.

Да

Да

Номер заказа в интернет-магазинеtest-001
Да
PalletNumber

stringНомер
палеты, передается в том случае если отправляете посылки в палетах.

Нет

Нет

паллеты-
Нет
barcode

stringШтрих-код посылки
. Передается в случае собственной маркировки посылок.

См. Требования к этикетке.

RTES4545S
price

Нет

Нет

Нет

price
stringОбъявленная стоимость
- общая (оценочная) стоимость ЗП, в руб.

Нет

Нет

Нет

посылки

2000.00

payment_sum

stringСумма к оплате
(сумма, которую необходимо взять
с получателя
), руб. Для полностью предоплаченного заказа указывать 0.
2000.00

Нет

Нет

Нет
delivery_sum

stringСтоимость доставки
, которую ИМ объявил получателю, руб.

Нет

Нет

Нет

объявленная получателю250.00
vid
vid
string

Вид доставки

.Для России (код 643) возможные значения

:

1

– самовывоз (доставка до

- Доставка до пункта выдачи (ПВЗ)

,

2

– КД (экспресс

- Курьерская доставка

до получателя

(КД)

,

3

– ПР (Почта России).Для «Экспорт из РФ»:

1 – самовывоз (доставка до ПВЗ).

- доставка Почтой России (ПР)

2
kurdost [1..1]

Да

Да

Да

kurdost

 
Блок с информацией о курьерской доставке
(vid  => 2) 
и доставке Почтой России
(vid  => 3)

Нет

Да

Да

Нет

index

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

Нет

Нет

603034
citi

string
Наименование города получателя ЗП, в котором будет курьерская доставка

Населенный пункт получателя.

Для небольших населенных пунктов указывать дополнительно Область, Район, Город, адрес проверяется сторонним сервисом и должен определяться однозначно. 

Допустимы варианты:

  1. Свердловская, Кушва, Баранчинский
.
  1. Свердловская обл, г Кушва, поселок Баранчинский
.
  • Екатеринбург.
  • г Екатеринбург.
  • Нижний Новгород
    addressp

    Нет

    Да

    Да

    addressp
    stringАдрес получателя
    ЗП (улица, дом, квартира/офис).
    Разрешенные символы: ^-0-9а-яёА-ЯЁ.,:;()№/
    Допустимые варианты:
    1. ул Ереванская, д 3, кв (номер квартиры)
    2. ул. Ереванская, д. 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 –

    0 - Посылка,
    2

    - Курьер Онлайн,

    3 –

    3 - Посылка Онлайн,

    5 – Нет

    5 - Посылка 1й класс.

    Если не передано, значение по умолчанию 0.

    Нет

    Нет

    -
    fragile

    string

    Хрупкая посылка, возможные значения 0 и 1.

    Если не передано,

    значение Нет

    значение по умолчанию 0.

    Нет

    Нет

    -
    strong

    string

    Строгий тип, возможные значения 0 и 1.

    Если не передано, значение по умолчанию 0.

    Нет
    -

    Нет

    Нет

    optimize

    string

    Оптимизация тарифа, возможные значения 0 и 1. Если не передано, значение по умолчанию 1.

    Параметры strong

    и optimize Нет

    и optimize являются взаимоисключающими и не могут одновременно принимать значение 1.

    Нет

    -

    Нет

    packing_type
    integer

    Нет

    Нет

    Нет

    int

    Тип упаковки, возможные значения:

    0 – упаковка ИМ, сумма сторон </= 106 см
    1 – упаковка ИМ, сумма сторон > 106 см
    2 – упаковка Boxberry, сумма сторон </= 106 см
    3 – упаковка Boxberry, сумма сторон > 106 см

    1 - упаковка ИМ
    2 - упаковка Boxberry

    -
    packing_strict
    boolean

    int

    Строгая упаковка, возможные значения:

    true

    1 - изменение упаковки в процессе транспортировки запрещено

    false

    0 - изменение упаковки разрешено

    Нет

    Нет

    Нет

    -
    shop [1..1]
    shop

    Блок с информацией о пункте приема и пункте выдачи отправления

    Да

    Да

    ДаНет


    name

    stringКод пункта выдачи заказа

    Да

    Нет

    -
    name1

    stringКод пункта поступления

    Да

    Да

    Да

    customer
    010
    customer [1..1]Блок с информацией о получателе отправления
    Да



    fio
    Даfio

    Да

    stringФИО получателя
    Да
    Иванов Иван Иванович
    Да
    phone
    Да
    phone
    string

    Номер

    мобильного

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


    Для РФ: в формате

    ,

    Телефон должен содержать 10 цифр

    (без тире

    ,

    скобок и знака "+")
    Для Казахстана (код 398) или Беларуси (код 112): в формате 12 цифр (без тире, скобок и знака "+")

    в противном случае, все символы обрезаются и используется 10 цифр с конца.

    9001122333

    Да

    Да

    Да
    phone2

    stringДополнительный номер телефона получателя
    .Нет

    Нет

    9004455666

    Нет

    Нет

    Нет

    Нет

    email

    stringE-mail
    Получателя. Обязателен, если по заказу подключены опции "Извещение E-Mail" и(или) "Дополнительное E-Mail-Извещение".
    получателя для оповещений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
    nameДа
    stringНаименование товара

    Да

    Да

    Куртка детская
    UnitName

    stringЕдиница измерения
    , по умолчанию используется
    шт.

    Нет

    Нет

    Нет

    nds

    stringПроцент НДС (число от 0 до 20)
    Нет
    18
    Нет
    price
    Нет
    price
    stringЦена за единицу товара
    Да
    1750
    Да
    quantity
    Да
    quantity
    stringКоличество единиц товара
    в товарной позиции

    Да

    Да

    1
    Да
    marking_crpt

    stringМаркировка
    одежды и обуви.Код маркировки состоит из 28 знаков и включает данные: GTIN+"+"+ISN
    • В формате 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 – неограниченно.

    Да

    Да

    Да

    JSON - неограничено)



    weight
    weight
    stringВес первого тарного места (гр)
    . Должно быть заполнено обязательно!
    400

    Да

    Да

    Да
    barcode

    stringБаркод
    1
    первого тарного места
    .
    Передается в случае собственной маркировки посылок.
    См.Требования к этикетке.
    -
    x

    Нет

    Нет

    Нет

    x

    Нет

    Нет

    Да

    y

    string

    Нет

    Нет

    Да

    z

    string

    Нет

    Нет

    Да

    string

    Габариты тарного места (см)

    Обязательны для доставки Почтой России.

     


    20
    y
    string20
    z
    string10
    weight2

    stringВес, баркоды и
    баркоды
    габариты последующих тарных мест

    Нет

    -
    barcode2

    string-
    x2

    string
    Нет
    -
    barcode2
    y2

    string-
    Нет
    z2
    Нет


    string-
    .......


    -
    weight24

    string-
    barcode24

    string

    Нет

    -
    x24


    -
    y24


    -
    z24
    Нет



    -
    barcode24Нет
    YFR

    string

    Нет

    (не используется)-
    issue

    integer

    Вид выдачи, возможные значения:

    0 –

    0 - выдача без вскрытия, 

    1

    - выдача со вскрытием и проверкой комплектности,

    2 – Нет

    2 - выдача части вложения.

    Если не передается, используется значение по умолчанию, установленное в Профиле магазина - раздел "Услуги".

    Нет

    Нет

    1
    sender_name

    stringНаименование магазина отправителя для sms/e-mail оповещений.

    Нет

    Нет

    -
    gift

    boolean(не используется)-
    Нет


    Данные ответа:

    Параметр

    Обяз.

    Тип

    Описание

    Пример

    track ●stringТрек-номер посылки для отслеживанияBBR13790374
    label
    stringСсылка на печать этикетки (генерируется если не передан штрих-код интернет-магазина)-