ParselCreate. Создать/обновить заказ.
Данный метод позволяет создать/обновить заказ в ЛК Boxberry.
Руководство для коректной работы REST API:
- Кодировка для всех и запросов, и ответов – UTF-8.
- Формат данных – JSON
- Метод – POST
Обращаем Ваше внимание,
- При создании нового заказа автоматически подставляются услуги, которые были выбраны в Личном Кабинете (https://account.boxberry.ru) – раздел «Услуги».
- Параметр 'issue' отвечает за изменение типа выдачи каждого отправления.
Обязательно к ознакомлению: Проверки и условия при загрузке заказов.
Описание передаваемых данных:
Параметр | Тип | Описание | Обяз. для запол. | ||
ПВЗ | КД | ПР | |||
token | string | Токен для доступа к API-сервисам. | Да | Да | Да |
partner_token | string | Токен партнера интеграции (длина до 24 символов). | Нет | Нет | Нет |
updateByTrack | string | Трекинг-код ранее созданной посылки. Внимание, если параметр updateByTrack будет заполнен, считается что вы хотите обновить ранее созданную посылку. | Нет | Нет | Нет |
order_id | string | id - идентификатор (номер) заказа ИМ. | Да | Да | Да |
PalletNumber | string | Номер палеты, передается в том случае если отправляете посылки в палетах. | Нет | Нет | Нет |
barcode | string | Штрих-код посылки. Передается в случае собственной маркировки посылок. См. Требования к этикетке. | Нет | Нет | Нет |
price | string | Объявленная стоимость - общая (оценочная) стоимость ЗП, в руб. | Нет | Нет | Нет |
payment_sum | string | Сумма к оплате (сумма, которую необходимо взять с получателя), руб. Для полностью предоплаченного заказа указывать 0. | Нет | Нет | Нет |
delivery_sum | string | Стоимость доставки, которую ИМ объявил получателю, руб. | Нет | Нет | Нет |
vid | string | Вид доставки. Для России (код 643) возможные значения: 1 – самовывоз (доставка до ПВЗ),
1 - самовывоз (доставка до ПВЗ). | Да | Да | Да |
kurdost |
| Блок с информацией о курьерской доставке (vid => 2) и доставке Почтой России (vid => 3) | Нет | Да | Да |
index | string | Почтовый индекс получателя | Нет | Нет | Нет |
citi | string | Наименование города получателя ЗП, в котором будет курьерская доставка. Для небольших населенных пунктов указывать дополнительно Область, Район, Город, адрес проверяется сторонним сервисом и должен определяться однозначно. Допустимы варианты:
| Нет | Да | Да |
addressp | string | Адрес получателя ЗП (улица, дом, квартира/офис).
| Нет | Да | Да |
Следующие значения передаются только для Курьерской доставки по направлениям:
| Нет | Нет | Нет | ||
delivery_date | string | Дата курьерской доставки (формат ГГГГ-ММ-ДД). Может принимать значения +1 +5 дней от текущей даты. | Нет | Нет | Нет |
timesfrom1 | string | Время курьерской доставки ОТ (формат чч:мм). Значение по умолчанию 10:00 | Нет | Нет | Нет |
timesto1 | string | Время курьерской доставки ДО (формат чч:мм) Значение по умолчанию 18:00 Интервал доставки "ОТ-ДО" должен быть не менее 3 часов. Если интервал меньше 3 часов, он корректируется без уведомления. | Нет | Нет | Нет |
timesfrom2 | string | Альтернативное время, от. | Нет | Нет | Нет |
timesto2 | string | Альтернативное время, до. | Нет | Нет | Нет |
timep | string | Время доставки текстовый формат. | Нет | Нет | Нет |
comentk | string | Комментарий курьеру. Перед выездом курьера обязательно производится обзвон получателей и согласовываются условия доставки. | Нет | Нет | Нет |
Следующие значения передаются только для доставки Почтой России | Нет | Нет | Нет | ||
type | string | Тип отправления, возможные значения: 0 - Посылка, Если не передано, значение по умолчанию 0. | Нет | Нет | Нет |
fragile | string | Хрупкая посылка, возможные значения 0 и 1. | Нет | Нет | Нет |
strong | string | Строгий тип, возможные значения 0 и 1. Если не передано, значение по умолчанию 0. | Нет | Нет | Нет |
optimize | string | Оптимизация тарифа, возможные значения 0 и 1. Если не передано, значение по умолчанию 1. | Нет | Нет | Нет |
packing_type | integer | Тип упаковки, возможные значения: 0 - упаковка ИМ, сумма сторон </= 106 см 1 - упаковка ИМ, сумма сторон > 106 см 2 - упаковка Boxberry, сумма сторон </= 106 см 3 - упаковка Boxberry, сумма сторон > 106 см | Нет | Нет | Нет |
packing_strict | boolean | Строгая упаковка, возможные значения: true - изменение упаковки в процессе транспортировки запрещено | Нет | Нет | Нет |
shop | Блок с информацией о пункте приема и пункте выдачи отправления | Да | Да | Да | |
name | string | Код пункта выдачи | Да | Нет | Нет |
name1 | string | Код пункта поступления | Да | Да | Да |
customer | Блок с информацией о получателе отправления | Да | Да | Да | |
fio | string | ФИО получателя | Да | Да | Да |
phone | string | Номер мобильного телефона получателя в формате 10 цифр. Если страна = Казахстан (код 398) или Беларусь (код 112), то максимальная длина номера телефона - 12 символов. | Да | Да | Да |
phone2 | string | Дополнительный номер телефона получателя. | Нет | Нет | Нет |
string | E-mail Получателя. Обязателен, если по заказу подключены опции "Извещение E-Mail" и(или) "Дополнительное E-Mail-Извещение". | Нет | Нет | Нет | |
Следующие значения передаются для получателя юр.лица | Нет | Нет | Нет | ||
name | string | Наименование организации | Да | Да | Да |
address | string | Юридический адрес организации | Нет | Нет | Нет |
inn | string | ИНН | Да | Да | Да |
kpp | string | КПП | Нет | Нет | Нет |
r_s | string | Расчетный счет | Нет | Нет | Нет |
bank | string | Банк организации | Нет | Нет | Нет |
kor_s | string | Корр. Счет | Нет | Нет | Нет |
bik | string | БИК | Нет | Нет | Нет |
items |
| Блок с информацией по товарным позициям, включённым в заказ. Проверяется корректность заполнения обязательных и необязательных полей. Обязательно к ознакомлению: Условия загрузки заказов с товарными позициями: | Нет* | Нет* | Да |
id | string | Идентификатор/артикул товарной позиции | Нет | Нет | Нет |
name | string | Наименование товара | Да | Да | Да |
UnitName | string | Единица измерения, по умолчанию используется шт. | Нет | Нет | Нет |
nds | string | НДС (число от 0 до 20) | Нет | Нет | Нет |
price | string | Цена за единицу товара | Да | Да | Да |
quantity | string | Количество единиц товара в товарной позиции | Да | Да | Да |
marking_crpt | string | Маркировка одежды и обуви. Код маркировки состоит из 28 знаков и включает данные: GTIN+"+"+ISN товара. При работе посредством:
| Нет | Нет | Нет |
notice | string | Примечание к заказу. Текст выводится в печатную форму этикетки. | Нет | Нет | Нет |
weights |
| Информация о весе ЗП:
Информация о штрих-кодах мест, передается в случае собственной маркировки уникальными ШК каждого тарного места:
В формате SOAP - количество элементов 24, в JSON – неограниченно. | Да | Да | Да |
weight | string | Вес первого тарного места (гр). Должно быть заполнено обязательно! | Да | Да | Да |
barcode | string | Баркод 1 первого тарного места. | Нет | Нет | Нет |
x | string | Габариты тарного места (см) Обязательны для доставки Почтой России. | Нет | Нет | Да |
y | string | Нет | Нет | Да | |
z | string | Нет | Нет | Да | |
weight2 | string | Вес и баркоды последующих тарных мест | Нет | Нет | - |
barcode2 | string | Нет | Нет | - | |
… | |||||
weight24 | string | Нет | Нет | - | |
barcode24 | string | Нет | Нет | - | |
issue | integer | Вид выдачи, возможные значения: 0 - выдача без вскрытия, Если не передается, используется значение по умолчанию, установленное в Профиле магазина - раздел "Услуги". | Нет | Нет | Нет |
sender_name | string | Наименование магазина отправителя для sms/e-mail оповещений. | Нет | Нет | Нет |
Данные ответа
Параметр | Тип | Описание |
track | string | Трек-номер посылки для отслеживания |
label | string | Ссылка на печать этикетки (генерируется если не передан штрих-код интернет-магазина) |