Данный метод позволяет создать/обновить заказ в ЛК Boxberry.

Руководство для корректной работы REST API:

Обращаем Ваше внимание,

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


Требования к маркировке отправления.

Входящие параметры:

Параметр



Обязательно для запол.

Тип

Описание

Пример

ПВЗКД
(РФ)
КД
(НеРФ)

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

Объявленная стоимость посылки

  • Для РФ диапазон от 5 до 300 000. (если <5 или не передана то будет автоматически изменена на 5 + notification в ответе)
  • Для других стран диапазон от 0 до 100 000.

2000.00

payment_sum


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


stringСтоимость доставки объявленная получателю250.00

vid

●●●string

Вид доставки:

1 - Доставка до пункта выдачи (ПВЗ, «Экспорт из РФ»)
2 - Курьерская доставка (КД)

2
supplier_track


stringНомер заказа первичного ИМа для отправки в СМС и получения в ПВЗ. 
Актуален для партнеров-агрегаторов.		PHP109482876

kurdost {1..1}


●
Блок с информацией о курьерской доставке (только для РФ)

index


string

Почтовый индекс адреса получателя
Рекомендуем оставлять поле Индекс пустым,
для автоматического определения индекса.

603034
citi
●
string

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

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

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

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

Адрес получателя (улица, дом, квартира/офис).
Разрешенные символы: ^-0-9а-яёА-ЯЁ.,:;()№/

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

  1. ул Ереванская, д 3, кв (номер квартиры)
  2. ул. Ереванская, д. 3, кв. (номер квартиры)
  3. пр-кт Андропова, д 10 к 3, кв (номер квартиры)
ул. Дружбы, д 5

Следующие значения передаются только для Курьерской доставки по направлениям:

Москва - Москва
Москва - Санкт-Петербург
Санкт-Петербург - Москва
Санкт-Петербург - Санкт-Петербург

Для остальных направлений поля будут игнорироваться.

delivery_date


string

Дата курьерской доставки (формат ГГГГ-ММ-ДД). Может принимать значения +1 - +5 дней от текущей даты.

Значение по умолчанию - текущая дата + 1 день.

По другим направлениям игнорируется.

2019-07-08
timesfrom1


string

Время курьерской доставки ОТ (формат чч:мм).

Значение по умолчанию 09:00

11:00
timesto1


string

Время курьерской доставки ДО (формат чч:мм)

Значение по умолчанию 22:00

Интервал доставки "ОТ-ДО" должен быть одним из перечисленных:
9:00-13:00
9:00-15:00
9:00-18:00
9:00-22:00
12:00-15:00
15:00-18:00
15:00-22:00
18:00-22:00

При проверке корректности временного интервала, он заменяется на наиболее подходящий интервал из списка, либо указывается по умолчанию. 
Если интервал не передан или не соответствует диапазону, то сохраняется по умолчанию с 9:00 до 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}●●●Блок с информацией о пункте приема и пункте выдачи отправления


name●

stringКод пункта выдачи -
name1●●●string

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

Если передан то установленный в настройках ЛК пункт игнорируется, записывается переданный.

010

customer {1..1}


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



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

Номер телефона получателя (только цифры)

Номер мобильного телефона получателя в формате 10 цифр.
Если Cтрана = Казахстан (CountryCode - 398) или Беларусь (112) или Киргизия (417) или Армения (051), то максимальная длина номера телефона - 12 символов.

9001122333
phone2


stringДополнительный номер телефона получателя  (только цифры)9004455666
email


stringE-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


Тип

Значение

НДС не указанполе НЕ передано
Без НДС-1
0%
10%
18%
20%		целое число (от 0 до 20)


20
price●●●stringЦена за единицу товара1750
quantity●●●stringКоличество единиц товара1
marking_crpt


string

Маркировка товара ЦРПТ

Код маркировки состоит из 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>
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

Примечание к заказу.

Текст выводится в печатную форму этикетки.
Если у заказа несколько мест (несколько этикеток), то данные по примечанию выводятся на каждой этикетке.
Количество символов <= 100.

Позвонить в домофон
weights {1..}●●●

Блок с информацией о тарных местах (SOAP - количество элементов 24, JSON - 100)
Каждое место (коробка/пакет) подлежит индивидуальной маркировке.
Места не привязаны к вложениям в заказе. 

Информация о весе ЗП:

  • weight - вес первого или единственного тарного места, в граммах. Минимальное значение 5 г, максимальное – 31000 г.
  • weight2, weight3, … weight24 - вес второго и последующих тарных мест, в граммах. Внимание, данные строки добавляются только в случае, если ЗП отправляется двумя и более тарными местами.

Информация о штрих-кодах мест, передается в случае собственной маркировки уникальными ШК каждого тарного места:

  • Каждый баркод должен заполняться в соответствующей строке веса
  • Если у заполненных мест указан хотя бы один баркод, то и остальные необходимо указать.
  • Если у мест указан баркод, то "Штрих-код ЗП" заполнять необязательно.





weight●●●string

Вес первого тарного места (гр)

Требования к заполнению:

  • Минимальный вес: 5 грамм
  • Максимальное количество мест: 100 мест (ПВЗ, КД)
  • Вес тарного места не должен превышать лимит веса отделения, на которое оформляется заказ (для вида доставки до ПВЗ)
  • Вес тарного места и общий вес мест не должен превышает допустимый лимит веса для направления.
400
barcode


string

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

Требования к маркировке отправления.

-
x


string

Максимальная длина стороны 120см.

При доставке до ПВЗ в РФ максимальная длина стороны 185см.

Габариты тарного места (см) (в сумме не должны превышать 250см!!!)

20
y


string20
z


string10
weight2


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


string-
x2


string-
y2


string-
z2


string-
.......



-
weight24


string-
barcode24


string-
x24



-
y24



-
z24



-
issue


integer

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

0 - выдача без вскрытия, 
1 - выдача со вскрытием и проверкой комплектности,
2 - выдача части вложения.

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

1
fitting


integer

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

0 - нет примерки
1 - подключена примерка

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

⠀



<div class="tab">
  <button class="tablinks" onclick="openSnippet(event, 'HTTP')" id="defaultOpen">HTTP</button>
  <button class="tablinks" onclick="openSnippet(event, 'cURL')">cURL</button>
  <button class="tablinks" onclick="openSnippet(event, 'PHP-cURL')">PHP-cURL</button>
</div>

<div id="HTTP" class="tabcontent">
  <p>POST /json.php HTTP/1.1<br>Host: api.boxberry.ru<br>Content-Type: application/x-www-form-urlencoded<br>Content-Length: 2266<br><br>token=d6f33e419c16131e5325cbd84d5d6000&method=ParselCreate&sdata=%7B%0A%20%20%22partner_token%22%3A%20%22%22%2C%0A%20%20%22updateByTrack%22%3A%20%22%22%2C%0A%20%20%22order_id%22%3A%20%22%D0%A2%D0%B5%D1%81%D1%82%D0%BE%D0%B2%D1%8B%D0%B9%20%D0%B7%D0%B0%D0%BA%D0%B0%D0%B7%20001%22%2C%0A%20%20%22PalletNumber%22%3A%20%22%22%2C%0A%20%20%22barcode%22%3A%20%22%22%2C%0A%20%20%22price%22%3A%20%222000.00%22%2C%0A%20%20%22payment_sum%22%3A%20%222000.00%22%2C%0A%20%20%22delivery_sum%22%3A%20%22250.00%22%2C%0A%20%20%22vid%22%3A%20%222%22%2C%0A%20%20%22kurdost%22%3A%20%7B%0A%20%20%20%20%22index%22%3A%20%22%22%2C%0A%20%20%20%20%22citi%22%3A%20%22%D0%9D%D0%B8%D0%B6%D0%BD%D0%B8%D0%B9%20%D0%9D%D0%BE%D0%B2%D0%B3%D0%BE%D1%80%D0%BE%D0%B4%22%2C%0A%20%20%20%20%22addressp%22%3A%20%22%D1%83%D0%BB%20%D0%94%D1%80%D1%83%D0%B6%D0%B1%D1%8B%2C%20%D0%B4%205%22%2C%0A%20%20%20%20%22delivery_date%22%3A%20%22%22%2C%0A%20%20%20%20%22timesfrom1%22%3A%20%22%22%2C%0A%20%20%20%20%22timesto1%22%3A%20%22%22%2C%0A%20%20%20%20%22comentk%22%3A%20%22%22%0A%20%20%7D%2C%0A%20%20%22shop%22%3A%20%7B%0A%20%20%20%20%22name%22%3A%20%22%22%2C%0A%20%20%20%20%22name1%22%3A%20%22010%22%0A%20%20%7D%2C%0A%20%20%22customer%22%3A%20%7B%0A%20%20%20%20%22fio%22%3A%20%22%D0%98%D0%B2%D0%B0%D0%BD%D0%BE%D0%B2%20%D0%98%D0%B2%D0%B0%D0%BD%20%D0%98%D0%B2%D0%B0%D0%BD%D0%BE%D0%B2%D0%B8%D1%87%22%2C%0A%20%20%20%20%22phone%22%3A%20%229001122333%22%2C%0A%20%20%20%20%22phone2%22%3A%20%22%22%2C%0A%20%20%20%20%22email%22%3A%20%22%22%0A%20%20%7D%2C%0A%20%20%22items%22%3A%20%5B%7B%0A%20%20%20%20%22id%22%3A%20%22252112-dget%22%2C%0A%20%20%20%20%22name%22%3A%20%22%D0%9A%D1%83%D1%80%D1%82%D0%BA%D0%B0%20%D0%B4%D0%B5%D1%82%D1%81%D0%BA%D0%B0%D1%8F%22%2C%0A%20%20%20%20%22UnitName%22%3A%20%22%D1%88%D1%82.%22%2C%0A%20%20%20%20%22nds%22%3A%20%22%22%2C%0A%20%20%20%20%22price%22%3A%20%221750%22%2C%0A%20%20%20%20%22quantity%22%3A%20%221%22%2C%0A%20%20%20%20%22marking_crpt%22%3A%20%22%22%0A%20%20%7D%5D%2C%0A%20%20%22notice%22%3A%20%22%22%2C%0A%20%20%22weights%22%3A%20%7B%0A%20%20%20%20%22weight%22%3A%20%22400%22%2C%0A%20%20%20%20%22barcode%22%3A%20%22%22%2C%0A%20%20%20%20%22x%22%3A%20%2220%22%2C%0A%20%20%20%20%22y%22%3A%20%2220%22%2C%0A%20%20%20%20%22z%22%3A%20%2210%22%0A%20%20%7D%2C%0A%20%20%22issue%22%3A%20%221%22%0A%7D
</p>
</div>

<div id="cURL" class="tabcontent">
  <p>curl --location --request POST 'https://api.boxberry.ru/json.php' \<br>--header 'Content-Type: application/x-www-form-urlencoded' \<br>--data-urlencode 'token=d6f33e419c16131e5325cbd84d5d6000' \<br>--data-urlencode 'method=ParselCreate' \<br>--data-urlencode 'sdata={<br>  "partner_token": "",<br>  "updateByTrack": "",<br>  "order_id": "Тестовый заказ 001",<br>  "PalletNumber": "",<br>  "barcode": "",<br>  "price": "2000.00",<br>  "payment_sum": "2000.00",<br>  "delivery_sum": "250.00",<br>  "vid": "2",<br>  "kurdost": {<br>    "index": "",<br>    "citi": "Нижний Новгород",<br>    "addressp": "ул Дружбы, д 5",<br>    "delivery_date": "",<br>    "timesfrom1": "",<br>    "timesto1": "",<br>    "comentk": ""<br>  },<br>  "shop": {<br>    "name": "",<br>    "name1": "010"<br>  },<br>  "customer": {<br>    "fio": "Иванов Иван Иванович",<br>    "phone": "9001122333",<br>    "phone2": "",<br>    "email": ""<br>  },<br>  "items": [{<br>    "id": "252112-dget",<br>    "name": "Куртка детская",<br>    "UnitName": "шт.",<br>    "nds": "",<br>    "price": "1750",<br>    "quantity": "1",<br>    "marking_crpt": ""<br>  }],<br>  "notice": "",<br>  "weights": {<br>    "weight": "400",<br>    "barcode": "",<br>    "x": "20",<br>    "y": "20",<br>    "z": "10"<br>  },<br>  "issue": "1"<br>}'</p> 
</div>

<div id="PHP-cURL" class="tabcontent">
  <p>&lt;?php<br><br>$curl = curl_init();<br><br>curl_setopt_array($curl, array(<br>  CURLOPT_URL => 'https://api.boxberry.ru/json.php',<br>  CURLOPT_RETURNTRANSFER => true,<br>  CURLOPT_ENCODING => '',<br>  CURLOPT_MAXREDIRS => 10,<br>  CURLOPT_TIMEOUT => 0,<br>  CURLOPT_FOLLOWLOCATION => true,<br>  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,<br>  CURLOPT_CUSTOMREQUEST => 'POST',<br>  CURLOPT_POSTFIELDS => 'token=d6f33e419c16131e5325cbd84d5d6000&method=ParselCreate&sdata=%7B%0A%20%20%22partner_token%22%3A%20%22%22%2C%0A%20%20%22updateByTrack%22%3A%20%22%22%2C%0A%20%20%22order_id%22%3A%20%22%D0%A2%D0%B5%D1%81%D1%82%D0%BE%D0%B2%D1%8B%D0%B9%20%D0%B7%D0%B0%D0%BA%D0%B0%D0%B7%20001%22%2C%0A%20%20%22PalletNumber%22%3A%20%22%22%2C%0A%20%20%22barcode%22%3A%20%22%22%2C%0A%20%20%22price%22%3A%20%222000.00%22%2C%0A%20%20%22payment_sum%22%3A%20%222000.00%22%2C%0A%20%20%22delivery_sum%22%3A%20%22250.00%22%2C%0A%20%20%22vid%22%3A%20%222%22%2C%0A%20%20%22kurdost%22%3A%20%7B%0A%20%20%20%20%22index%22%3A%20%22%22%2C%0A%20%20%20%20%22citi%22%3A%20%22%D0%9D%D0%B8%D0%B6%D0%BD%D0%B8%D0%B9%20%D0%9D%D0%BE%D0%B2%D0%B3%D0%BE%D1%80%D0%BE%D0%B4%22%2C%0A%20%20%20%20%22addressp%22%3A%20%22%D1%83%D0%BB%20%D0%94%D1%80%D1%83%D0%B6%D0%B1%D1%8B%2C%20%D0%B4%205%22%2C%0A%20%20%20%20%22delivery_date%22%3A%20%22%22%2C%0A%20%20%20%20%22timesfrom1%22%3A%20%22%22%2C%0A%20%20%20%20%22timesto1%22%3A%20%22%22%2C%0A%20%20%20%20%22comentk%22%3A%20%22%22%0A%20%20%7D%2C%0A%20%20%22shop%22%3A%20%7B%0A%20%20%20%20%22name%22%3A%20%22%22%2C%0A%20%20%20%20%22name1%22%3A%20%22010%22%0A%20%20%7D%2C%0A%20%20%22customer%22%3A%20%7B%0A%20%20%20%20%22fio%22%3A%20%22%D0%98%D0%B2%D0%B0%D0%BD%D0%BE%D0%B2%20%D0%98%D0%B2%D0%B0%D0%BD%20%D0%98%D0%B2%D0%B0%D0%BD%D0%BE%D0%B2%D0%B8%D1%87%22%2C%0A%20%20%20%20%22phone%22%3A%20%229001122333%22%2C%0A%20%20%20%20%22phone2%22%3A%20%22%22%2C%0A%20%20%20%20%22email%22%3A%20%22%22%0A%20%20%7D%2C%0A%20%20%22items%22%3A%20%5B%7B%0A%20%20%20%20%22id%22%3A%20%22252112-dget%22%2C%0A%20%20%20%20%22name%22%3A%20%22%D0%9A%D1%83%D1%80%D1%82%D0%BA%D0%B0%20%D0%B4%D0%B5%D1%82%D1%81%D0%BA%D0%B0%D1%8F%22%2C%0A%20%20%20%20%22UnitName%22%3A%20%22%D1%88%D1%82.%22%2C%0A%20%20%20%20%22nds%22%3A%20%22%22%2C%0A%20%20%20%20%22price%22%3A%20%221750%22%2C%0A%20%20%20%20%22quantity%22%3A%20%221%22%2C%0A%20%20%20%20%22marking_crpt%22%3A%20%22%22%0A%20%20%7D%5D%2C%0A%20%20%22notice%22%3A%20%22%22%2C%0A%20%20%22weights%22%3A%20%7B%0A%20%20%20%20%22weight%22%3A%20%22400%22%2C%0A%20%20%20%20%22barcode%22%3A%20%22%22%2C%0A%20%20%20%20%22x%22%3A%20%2220%22%2C%0A%20%20%20%20%22y%22%3A%20%2220%22%2C%0A%20%20%20%20%22z%22%3A%20%2210%22%0A%20%20%7D%2C%0A%20%20%22issue%22%3A%20%221%22%0A%7D',<br>  CURLOPT_HTTPHEADER => array(<br>    'Content-Type: application/x-www-form-urlencoded'<br>  ),<br>));<br><br>$response = curl_exec($curl);<br><br>curl_close($curl);<br>echo $response;
</p>
</div>



{
    "track": "AAP127020243",
    "label": "http://api.boxberry.ru/parcel-files/barcodes?parcel_id=127020243&token=d6f33e419c16131e5325cbd84d5d6000"
}



Не нашли ответ?
Обратитесь к нам на портал Service Desk
Краткую справку по нему можно найти в этой статье.