Данный метод позволяет создать/обновить заказ в ЛК Boxberry.
Руководство для корректной работы REST API:
- Кодировка для всех и запросов, и ответов – UTF-8.
- Формат данных – JSON
- Метод – POST
Обращаем Ваше внимание,
- При создании нового заказа автоматически подставляются услуги, которые были выбраны в Личном Кабинете – раздел «Услуги».
- Параметр 'issue' отвечает за изменение типа выдачи каждого отправления.
- На данный момент курьерская доставка возможна только по территории Российской Федерации
Обязательно к ознакомлению: Проверки и условия при загрузке заказов.
Требования к маркировке отправления.
Входящие параметры:
Параметр | Обяз. | Обяз. для Почты РФ (vid = 3) | Тип | Описание | Пример | |
|---|---|---|---|---|---|---|
token | ● | ● | string | Токен для доступа к api-сервисам | 0237b078818a23ae8d765a04405116de | |
| partner_token | string | Токен партнера интеграции (длина до 24 символов) | - | |||
| updateByTrack | string | Трек-номер посылки для обновления. Внимание, если параметр updateByTrack будет заполнен, считается что вы хотите обновить ранее созданную посылку. | - | |||
| order_id | ● | ● | string | Номер заказа в интернет-магазине | test-001 | |
| PalletNumber | string | Номер паллеты | - | |||
| barcode | string | Штрих-код посылки. Передается в случае собственной маркировки посылок. | RTES4545S | |||
| price | ● | string | Объявленная стоимость посылки | 2000.00 | ||
| payment_sum | string | Сумма к оплате (сумма, которую необходимо взять с получателя). Для полностью предоплаченного заказа указывать 0. | 2000.00 | |||
| delivery_sum | string | Стоимость доставки объявленная получателю | 250.00 | |||
vid | ● | ● | string | Вид доставки: 1 - Доставка до пункта выдачи (ПВЗ, «Экспорт из РФ») | 2 | |
kurdost [1..1] | ● | Блок с информацией о курьерской доставке (только для РФ) и доставке Почтой России | ||||
| index | string | Почтовый индекс адреса получателя | 603034 | |||
| citi | string | Населенный пункт получателя. Для небольших населенных пунктов указывать дополнительно Область, Район, Город, адрес проверяется сторонним сервисом и должен определяться однозначно. Допустимы варианты:
| Нижний Новгород | |||
| addressp | ● | string | Адрес получателя (улица, дом, квартира/офис). Допустимые варианты:
| ул. Дружбы, д 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. | - | |||
| fragile | string | Хрупкая посылка, возможные значения 0 и 1. Если не передано, значение по умолчанию 0. | - | |||
| strong | string | Строгий тип, возможные значения 0 и 1. Если не передано, значение по умолчанию 0. | - | |||
| optimize | string | Оптимизация тарифа, возможные значения 0 и 1. Если не передано, значение по умолчанию 1. Параметры strong и optimize являются взаимоисключающими и не могут одновременно принимать значение 1. | - | |||
| packing_type | ● | int | Тип упаковки, возможные значения: 1 - упаковка ИМ | - | ||
| packing_strict | ● | int | Строгая упаковка, возможные значения: 1 - изменение упаковки в процессе транспортировки запрещено 0 - изменение упаковки разрешено | - | ||
| shop [1..1] | ● | Блок с информацией о пункте приема и пункте выдачи отправления | ||||
| name | string | Код пункта выдачи | - | |||
| name1 | ● | string | Код пункта поступления | 010 | ||
| customer [1..1] | ● | ● | Блок с информацией о получателе отправления | |||
| fio | ● | ● | string | ФИО получателя | Иванов Иван Иванович | |
| phone | ● | ● | string | Номер телефона получателя (только цифры) Номер мобильного телефона получателя в формате 10 цифр. | 9001122333 | |
| phone2 | string | Дополнительный номер телефона получателя (только цифры) | 9004455666 | |||
| string | E-mail получателя для оповещений | test@test.ru | ||||
| Следующие значения передаются для получателя юр.лица | ||||||
| name | string | Наименование организации | ООО "Получатель" | |||
| address | string | Адрес организации | - | |||
| inn | string | ИНН | - | |||
| kpp | string | КПП | - | |||
| r_s | string | Расчетный счет | - | |||
| bank | string | Наименование банка | - | |||
| bank | string | Корр. счет | - | |||
| bik | string | БИК | - | |||
| items [0..∞] | ||||||
| id | string | Артикул товара | 252112-dget | |||
| name | ● | ● | string | Наименование товара | Куртка детская | |
| UnitName | string | Единица измерения | шт. | |||
| nds | string | Процент НДС (число от 0 до 20) | 18 | |||
| price | ● | ● | string | Цена за единицу товара | 1750 | |
| quantity | ● | ● | string | Количество единиц товара | 1 | |
| marking_crpt | string | Маркировка товара Код маркировки состоит из 28 знаков и включает данные: GTIN+"+"+ISN товара.
| 04610043040058 | |||
| notice | string | Примечание к заказу. Текст выводится в печатную форму этикетки. | Позвонить в домофон | |||
| weights | ● | ● | Блок с информацией о тарных местах (SOAP - количество элементов 24, JSON - неограничено) | |||
| weight | ● | ● | string | Вес первого тарного места (гр) | 400 | |
| barcode | string | Баркод первого тарного места | - | |||
| x | ● | 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 | - | |||||
| issue | integer | Вид выдачи заказа, возможные значения: 0 - выдача без вскрытия, Если не передается, используется значение по умолчанию, установленное в Профиле магазина - раздел "Услуги". | 1 | |||
| sender_name | string | Наименование магазина отправителя для sms/e-mail оповещений. | - | |||
| gift | boolean | (не используется) | - | |||
| AgregatorPointCargoCode | string | Уникальный код склада. | ||||
Данные ответа:
Параметр | Обяз. | Тип | Описание | Пример |
|---|---|---|---|---|
| track | ● | string | Трек-номер посылки для отслеживания | BBR13790374 |
| label | string | Ссылка на печать этикетки | - |
⠀