ParselCreate. Создать/обновить заказ.
Данный метод позволяет создать/обновить заказ в ЛК Boxberry.
Руководство для коректной корректной работы REST API:
- Кодировка для всех и запросов, и ответов – UTF-8.
- Формат данных – JSON
- Метод – POST
...
Обязательно к ознакомлению: Проверки и условия при загрузке заказов.
Отображение дочерних |
---|
Требования к маркировке отправления.
Описание передаваемых данныхВходящие параметры:
Параметр | Обязательно для запол. | Тип | Описание |
---|
Пример | ||
---|---|---|
ПВЗ | КД(РФ) | КД |
(НеРФ) | |||||||
token | ● | ● | ● | string | Токен для доступа к |
api-сервисам | d6f33e419c16131e5325cbd84d5d6000 | |||||||
method | ● | ● | ● | string | Название метода | ParselCreate | ||
sdata {1..1} | ● |
● |
Да
● | Блок с информацией о посылке |
partner_token | string | Токен партнера интеграции (длина до 24 символов) |
Нет
- |
Нет
updateByTrack | string |
Трек- |
номер посылки для обновления. Внимание, если параметр updateByTrack будет заполнен, считается что вы хотите обновить ранее созданную посылку. |
Нет
AAP149296768 |
Нет
order_id | ● | ● | ● | string |
id - идентификатор (номер) заказа ИМ.
Допустимые символы: a-z(A-Z), 0-9, а-я(А-Я), ёЁ, тире(-), прямой слеш(/),
точка(.), запятая(,), нижнее подчеркивание(_), №, пробел.
Да
Да
Номер заказа в интернет-магазине | 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 – КД (экспресс-доставка до получателя),
3 – ПР (Почта России).Для «Экспорт из РФ»:
1 – самовывоз (доставка до ПВЗ).
- Доставка до пункта выдачи (ПВЗ, «Экспорт из РФ») | 2 | ||||||
supplier_track | string | Номер заказа первичного ИМа для отправки в СМС и получения в ПВЗ. Актуален для партнеров-агрегаторов. | PHP109482876 | ||||
kurdost {1..1} | ● |
Да
Да
Да
kurdost
Нет
Да
Да
Блок с информацией о курьерской доставке ( |
только для РФ) | ||
index | string | Почтовый индекс адреса получателя |
Нет
Нет
Рекомендуем оставлять поле Индекс пустым, | 603034 |
citi | ● | string |
Населенный пункт получателя. Для небольших населенных пунктов указывать дополнительно Область, Район, Город, адрес проверяется сторонним сервисом и должен определяться однозначно. Допустимы варианты:
|
|
Нет
Да
Да
Нижний Новгород | ||
addressp | ● |
string | Адрес получателя |
(улица, дом, квартира/офис). |
Допустимые варианты:
|
Нет
Да
Да
ул. Дружбы, д 5 | ||||||
Следующие значения передаются только для Курьерской доставки по направлениям: |
Москва - Москва |
Москва - Санкт-Петербург |
Москва |
Санкт-Петербург |
Нет
Нет
Нет
Для остальных направлений поля будут игнорироваться. | ||||||
delivery_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 | Комментарий |
В данный момент этот параметр не обрабатывается.
по доставке (не используется) | - | ||||||
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} | ● | ● | ● |
Нет
Нет
Нет
Следующие значения передаются только для доставки Почтой России
Нет
Нет
Нет
type
string
Тип отправления, возможные значения:
0 – Посылка,
2 – Курьер Онлайн,
3 – Посылка Онлайн,
5 – Посылка 1й класс.
Если не передано, значение по умолчанию 0.
Нет
Нет
Нет
fragile
string
Хрупкая посылка, возможные значения 0 и 1.
Если не передано, значение по умолчанию 0.
Нет
Нет
Нет
strong
string
Строгий тип, возможные значения 0 и 1.
Если не передано, значение по умолчанию 0.
Нет
Нет
Нет
optimize
string
Оптимизация тарифа, возможные значения 0 и 1. Если не передано, значение по умолчанию 1.
Параметры strong и optimize являются взаимоисключающими и не могут одновременно принимать значение 1.
Нет
Нет
Нет
packing_type
integer
Тип упаковки, возможные значения:
0 – упаковка ИМ, сумма сторон </= 106 см
1 – упаковка ИМ, сумма сторон > 106 см
2 – упаковка Boxberry, сумма сторон </= 106 см
3 – упаковка Boxberry, сумма сторон > 106 см
Нет
Нет
Нет
packing_strict
boolean
Строгая упаковка, возможные значения:
true - изменение упаковки в процессе транспортировки запрещено
false - изменение упаковки разрешено
Нет
Нет
Нет
Блок с информацией о пункте приема и пункте выдачи отправления |
Да
Да
Да
name | ● |
string | Код пункта |
выдачи | - |
name1 |
● |
● |
● | string | Код пункта поступления |
Да
Да
Да
Если передан то установленный в настройках ЛК пункт игнорируется, записывается переданный. | 010 | ||||||
customer {1..1} | ● | ● | ● | Блок с информацией о получателе отправления |
fio |
● |
● |
● | string | ФИО получателя | Иванов Иван Иванович |
phone |
● |
● |
● | string | Номер телефона получателя (только цифры) Номер мобильного телефона получателя |
Для РФ:
в формате 10 цифр |
Для Казахстана (код
. |
Беларусь ( |
112) |
или Киргизия (417) или Армения (051), то максимальная длина номера телефона - 12 символов. | 9001122333 |
Да
Да
phone2 | string | Дополнительный номер телефона |
Нет
Нет
Нет
получателя (только цифры) | 9004455666 | ||||
string |
Нет
Нет
получателя для оповещений | test@test.ru |
Следующие значения передаются для получателя юр.лица |
name |
● |
● |
name
string | Наименование организации |
Да
Да
Да
ООО "Получатель" | ||||
address | string |
Юридический адрес организации
Нет
Нет
Нет
Адрес организации | - | |
inn | ● | ● |
string | ИНН |
Да
Да
- | |||||
kpp | string | КПП |
Нет
Нет
- | |||||
r_s | string | Расчетный счет |
- |
Нет
Нет
bank | string |
Банк организации
Нет
Нет
Наименование банка | - |
kor_s | string | Корр. |
счет |
Нет
- |
Нет
bik | string | БИК |
Нет
Нет
Нет
items
- | |||||||||||
items [0..∞] |
|
|
Нет*
Нет*
Да
| |||||
id | string |
Идентификатор/артикул товарной позиции
Нет
Нет
Нет
Артикул товара | 252112-dget | ||
name | ● | ● | ● |
string | Наименование товара |
Да
Да
Да
Куртка детская | |||||
UnitName | string | Единица измерения |
шт. | |
nds |
string |
|
|
nds
string
|
20 | |
price |
● |
● |
● | string | Цена за единицу товара |
1750 |
quantity |
● |
● |
Да
Да
Да
● | string | Количество единиц товара |
1 |
marking_crpt | string | Маркировка |
товара ЦРПТ Код маркировки состоит из 28 |
или 127 символов и включает данные: GTIN (14 символов) + "+" + ISN (13 символов) либо полную маркировку товара. |
|
0104630098217378217861c0901863491816992ZQj6njADxiVlEcx+rOr5xN1JZuA2AYkT6FWuw3b2/QsysJ0d2BXpBBdX6g76rQz5R9x8Jdf8EZDUGZ9MSfGY+A== | ||||||
supplier_name | string | Наименование юр. лица Поставщика. Ограничение до 255 символов. Не будет записано если не переданы: supplier_inn + supplier_phone | ООО "Боксберри" | |||
supplier_inn | string | ИНН Поставщика Должен состоять только из цифр длиной 10 или 12 символов. Не будет записано если не переданы: supplier_name + supplier_phone | 5029190794 | |||
supplier_phone | string | Номер телефона Поставщика. Не будет записано если не переданы: supplier_name + supplier_inn | +79999999999 |
Нет
Нет
notice | string | Примечание к заказу. Текст выводится в печатную форму этикетки. |
Нет
Нет
Нет
weights
Позвонить в домофон | |||||||||||
weights {1..} | ● | ● | ● | Блок с информацией о тарных местах (SOAP - количество элементов 24, JSON - 100)
|
|
В формате SOAP - количество элементов 24, в JSON – неограниченно.
weight | ● | ● | ● |
Да
Да
Да
string | Вес первого тарного места (гр) |
Требования к заполнению:
| 400 |
Да
Да
barcode | string |
Штрих-код первого тарного места |
Передается
, передается в случае собственной |
маркировке отправлений. |
|
- |
x |
Нет
string | Максимальная длина стороны 120см. |
x
Габариты тарного места (см) |
Обязательны для доставки Почтой России.
Нет
Нет
Да
(в сумме не должны превышать 250см!!!) | 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 - выдача без вскрытия, |
- выдача со вскрытием и проверкой комплектности, |
2 - выдача части вложения. Если не передается, используется значение по умолчанию, установленное в Профиле магазина - раздел "Услуги". |
Нет
Нет
1 | |||||||
fitting | integer | Возможные значения: 0 - нет примерки | 1 |
sender_name | string | Наименование магазина отправителя для sms/e-mail оповещений.
|
Нет
Нет
| - | ||||||
gift | boolean | (не используется) | - | ||||
AgregatorPointCargoCode | string | Уникальный код склада. |
Данные ответа:
Параметр | Обяз. | Тип | Описание | Пример |
---|---|---|---|---|
track | ● | string | Трек-номер посылки для отслеживания | BBR13790374 |
notification | string | Сообщение о изменении параметров заказа | Объявленная стоимость заменена на 5 рублей согласно условиям договора | |
label | string | Ссылка на печать этикетки | https://api.boxberry.ru/parcel-files/barcodes?parcel_id=149296768&token=d6f33e419c16131e5325cbd84d5d6000 |
⠀
Раскрыть | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
панель | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Не нашли ответ? |