...
- При создании нового заказа автоматически подставляются услуги, которые были выбраны в Личном Кабинете – раздел «Услуги».
- Параметр 'issue' отвечает за изменение типа выдачи каждого отправления.
- На данный момент курьерская доставка возможна только по территории Российской Федерации
Обязательно к ознакомлению: Проверки и условия при загрузке заказов.
...
Входящие параметры:
Параметр | Обязательно для запол. | Тип | Описание | Пример | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ПВЗ | КД(РФ) | КД( | ЕАЭСНеРФ) | ПР||||||||||||||||||||||||||||||
token | ● | ● | ● | ● | string | Токен для доступа к api-сервисам | d6f33e419c16131e5325cbd84d5d6000 | ||||||||||||||||||||||||||
method | ●● | ● | ● | string | Название метода | ParselCreate | |||||||||||||||||||||||||||
sdata {1..1} | ●● | ● | ● | Блок с информацией о посылке | |||||||||||||||||||||||||||||
partner_token | string | Токен партнера интеграции (длина до 24 символов) | - | ||||||||||||||||||||||||||||||
updateByTrack | string | Трек-номер посылки для обновления. Внимание, если параметр updateByTrack будет заполнен, считается что вы хотите обновить ранее созданную посылку.- | AAP149296768 | ||||||||||||||||||||||||||||||
order_id | ● | ● | ● | ● | string | Номер заказа в интернет-магазине | test-001 | ||||||||||||||||||||||||||
PalletNumber | string | Номер паллеты | - | ||||||||||||||||||||||||||||||
barcode | string | Штрих-код посылки. Передается в случае собственной маркировки посылок. Требования к маркировке отправления. | RTES4545S | ||||||||||||||||||||||||||||||
price | ●● | string | Объявленная стоимость посылки | 2000.00 |
| 2000.00 | |||||||||||||||||||||||||||
payment_sum | string | Сумма к оплате (сумма, которую | payment_sum | string | Сумма к оплате (сумма, которую необходимо взять с получателя). Для полностью предоплаченного заказа указывать 0. | 2000.00 | |||||||||||||||||||||||||||
delivery_sum | string | Стоимость доставки объявленная получателю | 250.00 | ||||||||||||||||||||||||||||||
vid | ●● | ● | ● | string | Вид доставки: 1 - Доставка до пункта выдачи (ПВЗ, «Экспорт из РФ») | 2 | |||||||||||||||||||||||||||
supplier_track | string | Номер заказа первичного ИМа для отправки в СМС и получения в ПВЗ. Актуален для партнеров-агрегаторов. | PHP109482876 | ||||||||||||||||||||||||||||||
kurdost {1..1} | ●● | Блок с информацией о курьерской доставке (только для РФ) и доставке Почтой России | |||||||||||||||||||||||||||||||
index | string | Почтовый индекс адреса получателя | 603034 | ||||||||||||||||||||||||||||||
citi | ●● | string | Населенный пункт получателя. Для небольших населенных пунктов указывать дополнительно Область, Район, Город, адрес проверяется сторонним сервисом и должен определяться однозначно. Допустимы варианты:
| Нижний Новгород | |||||||||||||||||||||||||||||
addressp | ● | ● | string | Адрес получателя (улица, дом, квартира/офис). Допустимые варианты:
| ул. Дружбы, д 5 | ||||||||||||||||||||||||||||
Следующие значения передаются только для Курьерской доставки по направлениям: Москва - Москва Для остальных направлений поля будут игнорироваться. | |||||||||||||||||||||||||||||||||
deliverydelivery_date | string | Дата курьерской доставки (формат ГГГГ-ММ-ДД). Может принимать значения +1 - +5 дней от текущей даты. Значение по умолчанию - текущая дата + 1 день. По другим направлениям игнорируется. | 2019-07-08 | ||||||||||||||||||||||||||||||
timesfrom1 | string | Время курьерской доставки ОТ (формат чч:мм). Значение по умолчанию 09:00 | 11:00 | ||||||||||||||||||||||||||||||
timesto1 | string | Время курьерской доставки ДО (формат чч:мм) Значение по умолчанию 22:00
| 16:00 | ||||||||||||||||||||||||||||||
timesfrom2 | string | Альтернативное время, от | 17:00 | ||||||||||||||||||||||||||||||
timesto2 | string | Альтернативное время, до | 20:00 | ||||||||||||||||||||||||||||||
timep | string | Время доставки текстовый формат (не используется) | - | ||||||||||||||||||||||||||||||
comentk | string | Комментарий по доставке (не используется) | - | ||||||||||||||||||||||||||||||
Следующие значения передаются только для доставки Почтой России packing_strict=1, запрещает изменение упаковки при обработке груза на терминале Boxberry:
| 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 | - | packing_strict | ● | int | Строгая упаковка, возможные значения: 1 - изменение упаковки в процессе транспортировки запрещено 0 - изменение упаковки разрешено | - | export {1..1} | ● | Блок с информацией о курьерской доставке (vid = 2) и страна доставки – не РФ | |||||
export {1..1} | ● | Блок с информацией о курьерской доставке в другие страны . Данные заполняются, если тип доставки Курьерская доставка (vid = 2) и страна получения не Россия (643) В случае доставки в отделение не заполняются. | |||||||||||||||||||||||||||||||
index | ● | string | Почтовый индекс получателя | 090014 | |||||||||||||||||||||||||||||
countryCode | ● | string | Код страны | 398 | |||||||||||||||||||||||||||||
cityCode | ● | string | Код города | Н00163821 | |||||||||||||||||||||||||||||
area | ● | string | Наименование области/штата | Западно-Казахстанская | |||||||||||||||||||||||||||||
street | ● | string | Наименование улицы | Акбулакская | |||||||||||||||||||||||||||||
house | ● | string | Номер дома | 14 | |||||||||||||||||||||||||||||
flat | string | Номер квартиры | 255 | ||||||||||||||||||||||||||||||
transporterGuid | ● | string | Идентификатор службы перевозчика, 36 символов (GUID) На данный момент, рекомендуем передавать значение по умолчанию: fd85a8b6-4688-404f-9993-30b9e55d2950 | fd85a8b6-4688-404f-9993-30b9e55d2950 | |||||||||||||||||||||||||||||
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 | Наименование банка | - | ||||||||||||||||||||||||||||||
kor_s | string | Корр. счет | - | ||||||||||||||||||||||||||||||
bik | string | БИК | - | ||||||||||||||||||||||||||||||
items [0..∞] |
| ||||||||||||||||||||||||||||||||
id | string | Артикул товара | 252112-dget | ||||||||||||||||||||||||||||||
name | ● | ● | ● | string | Наименование товара | Куртка детская | |||||||||||||||||||||||||||
UnitName | string | Единица измерения | шт. | ||||||||||||||||||||||||||||||
nds | string |
| 20 | ||||||||||||||||||||||||||||||
price | index | ● | string | Почтовый индекс получателя | 090014 | countryCode | ● | string | Код страны | 398 | cityCode | ● | string | Код города | Н00163821 | area | ● | string | Наименование области/штата | Западно-Казахстанская | street | ● | string | Наименование улицы | Акбулакская | house | ● | string | Номер дома | 14 | flat | string | Номер квартиры | 255 | transporterGuid | ● | string | Идентификатор службы перевозчика, 36 символов (GUID) | fd85a8b6-4688-404f-9993-30b9e55d2950 |
shop {1..1} | ● | ● | ● | ● | Блок с информацией о пункте приема и пункте выдачи отправления | name | ● | string | Код пункта выдачи | - | |||||||||||||||||||||||
name1 | ● | ● | ● | ● | string | Код пункта поступления | 010 | ● | ● | Блок с информацией о получателе отправления | fio | ● | ● | ● | ● | string | ФИО получателя | Иванов Иван Иванович | |||||||||||||||
phone | ● | ● | ● | ● | string | Номер телефона получателя (только цифры) Номер мобильного телефона получателя в формате 10 цифр. | 9001122333 | phone2 | string | Дополнительный номер телефона получателя (только цифры) | 9004455666 | string | E-mail получателя для оповещений | test@test.ru | |||||||||||||||||||
Следующие значения передаются для получателя юр.лица | |||||||||||||||||||||||||||||||||
name | ● | ● | ● | string | Наименование организации | ООО "Получатель" | Цена за единицу товара | 1750 | |||||||||||||||||||||||||
quantity | address | string | Адрес организации | - | inn | ● | ● | ● | string | ИННКоличество единиц товара | -1kpp | ||||||||||||||||||||||
marking_crpt | string | КПП | - | r_s | string | Расчетный счет | - | bank | string | Наименование банка | - | kor_s | string | Корр. счет | - | bik | string | БИК | - | items [0..∞] |
Раскрыть | ||
---|---|---|
| ||
Блок с информацией по товарным позициям, включённым в заказ. Проверяется корректность заполнения обязательных и необязательных полей.
|
Физически | API |
---|---|
НДС не указан | поле НЕ передано |
Без НДС | -1 |
0% 10% 18% 20% | целое число (от 0 до 20) |
Маркировка товара ЦРПТ
Код маркировки состоит из 28 или 127 символов и включает данные:
GTIN (14 символов) + "+" + ISN (13 символов) либо полную маркировку товара.
ИЛИ
01 GTIN (14 символов) 21 ISN (13 символов) 91 Ключ проверки (4 символа) 92 Код проверки (88 символов)
- Спец. символы идентификатора применения типа <GS> или <FNC1> не передаются.
- REST API: необходимо экранировать все специальные символы.
- API в формате SOAP: все специальные символы необходимо передавать в теге <![CDATA[ ... ]]>, иначе маркировка товара не сохранится.
Пример, <marking_crpt><![CDATA[00000217553+lVfTHoca%>km&]]></marking_crpt>
Наименование юр. лица Поставщика.
Ограничение до 255 символов.
Не будет записано если не переданы: supplier_inn + supplier_phone
ИНН Поставщика
Должен состоять только из цифр длиной 10 или 12 символов.
Не будет записано если не переданы: supplier_name + supplier_phone
Номер телефона Поставщика.
Не будет записано если не переданы: supplier_name + supplier_inn
Маркировка товара
Код маркировки состоит из 28 знаков и включает данные: GTIN (14 символов) + "+" + ISN (13 символов) товара.
- REST API: необходимо экранировать все специальные символы.
- API в формате SOAP: все специальные символы необходимо передавать в теге <![CDATA[ ... ]]>, иначе маркировка товара не сохранится.
Пример, <marking_crpt><![CDATA[00000217553+lVfTHoca%>km&]]></marking_crpt>
Примечание к заказу.
Текст выводится в печатную форму этикетки.
Если у заказа несколько мест (несколько этикеток), то данные по примечанию выводятся на каждой этикетке.
Количество символов <= 100.
Блок с информацией о тарных местах (SOAP - количество элементов 24, JSON - 100), JSON - 100)
Каждое место (коробка/пакет) подлежит индивидуальной маркировке.
Места не привязаны к вложениям в заказе.
Раскрыть | ||
---|---|---|
| ||
Информация о весе ЗП:
Информация о штрих-кодах мест, передается в случае собственной маркировки уникальными ШК каждого тарного места:
|
Вес первого тарного места (гр)
Требования к заполнению:
- Минимальный вес: 5 грамм
- Максимальное количество мест: 100 мест (ПВЗ, КД)
- Вес тарного места не должен превышать лимит веса отделения, на которое оформляется заказ (для вида доставки до ПВЗ)
- Вес тарного места и общий вес мест не должен превышает допустимый лимит веса для направления.
Штрих-код первого тарного места, передается в случае собственной маркировке отправлений.
- Если указаны баркоды мест, то баркод посылки игнорируется.
Требования к маркировке отправления.
Баркод первого тарного местаМаксимальная длина стороны 120см.
При доставке до ПВЗ в РФ максимальная длина стороны 185см.
Габариты тарного места (см) (в сумме не должны превышать 250см!!!)
Вид выдачи заказа, возможные значения:
0 - выдача без вскрытия,
1 - выдача со вскрытием и проверкой комплектности,
2 - выдача части вложения.
Если не передается, используется значение по умолчанию, установленное в Профиле магазина - раздел "Услуги".
Возможные значения:
0 - нет примерки
1 - подключена примерка
Наименование магазина отправителя для sms/e-mail оповещений.
Раскрыть | ||
---|---|---|
| ||
Данное наименование будет использовано в информационных уведомлениях для получателя. |
Уникальный код склада.
Актуален для партнеров-агрегаторов, которым необходима отправка возвратов на собственный склад.
Данные ответа:
Параметр | Обяз. | Тип | Описание | Пример |
---|---|---|---|---|
track | ● | string | Трек-номер посылки для отслеживания | BBR13790374 |
notification | string | Сообщение о изменении параметров заказа | Объявленная стоимость заменена на 5 рублей согласно условиям договора | |
label | string | Ссылка на печать этикетки | https://api.boxberry.ru/parcel-files/barcodes?parcel_id=149296768&token=d6f33e419c16131e5325cbd84d5d6000 |
⠀
Раскрыть | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
панель | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Не нашли ответ? |