ParselCreate. Создать/обновить заказ

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

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

Кодировка для всех и запросов, и ответов – UTF-8.
Формат запроса: JSON (raw)
Метод – POST

^{postman - POST ParselCreate. Создать/обновить заказ}

Обязательно к ознакомлению (информация о возможных проверках):
Таблица 1. Проверки полей заказа.
Таблица 2. Доставка в другие страны.

При создании нового заказа автоматически подставляются услуги, которые были выбраны в Личном Кабинете – раздел «Услуги».

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

Для POST запроса параметры передаются в теле запроса в формате JSON

Параметр

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

Тип

Описание

Пример

ПВЗ

КД

(РФ)

КД

(НеРФ)

token

●

string

Токен для доступа к api-сервисам.

Как узнать свой token (токен)

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

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

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

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

Свердловская, Кушва, Баранчинский
Свердловская обл, г Кушва, поселок Баранчинский

Нижний Новгород

addressp

●

string

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

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

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

ул. Дружбы, д 5

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

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

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

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 И Страна получения ≠ Россия
В случае доставки в отделение (vid=1)не заполняются.

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

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..∞]

Блок с информацией по товарным позициям, включённым в заказ. Проверяется корректность заполнения обязательных и необязательных полей.
Обязательно к ознакомлению: Условия загрузки заказов с товарными позициями:

Таблица 1. Проверки полей заказа

id

string

Артикул товара

252112-dget

name

●

string

Наименование товара

Куртка детская

UnitName

string

Единица измерения

шт.

nds

string

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

20

price

●

string

Цена за единицу товара

Для тип выдачи "без вскрытия" и "со вскрытием" - если создается заказ без товаров то создается одно вложение с price = "сумма к оплате" (payment_sum) минус "стоимость доставки" (delivery_sum) (если вычисленная стоимость товара отрицательная, то приравниваем к 0).

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

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 - выдача со вскрытием и проверкой комплектности,
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

Ответ

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

CODE

Пример запроса:

POST /json.php HTTP/1.1
Host: api.boxberry.ru
Content-Type: application/json
Content-Length: 1809

{
"token": "d6f33e419c16131e5325cbd84d5d6000",
"method": "ParselCreate",
"sdata": {
"partner_token": "",
"updateByTrack": "",
"order_id": "Тестовый заказ 123",
"PalletNumber": "",
"barcode": "",
"price": "1950.00",
"payment_sum": "2200.00",
"delivery_sum": "250.00",
"vid": "2",
"issue": "1",
"kurdost":
{
"index": "",
"citi": "Нижний Новгород",
"addressp": "ул Дружбы, д 5",
"delivery_date": "",
"timesfrom1": "",
"timesto1": "",
"comentk": ""
},
"export":
{
"index": "",
"countryСode": "",
"cityCode": "",
"area": "",
"street": "",
"house": "",
"flat": "",
"transporterGuid": ""
},
"shop":
{
"name": "",
"name1": "010"
},
"customer":
{
"fio": "Иванов Иван Иванович",
"phone": "9001122333",
"phone2": "",
"email": ""
},
"items":
[
{
"id": "252112-dget",
"name": "Куртка детская",
"UnitName": "шт.",
"nds": "",
"price": "1750",
"quantity": "1",
"marking_crpt": ""
},
{
"id": "252334-gset",
"name": "Носки",
"UnitName": "шт.",
"nds": "",
"price": "100",
"quantity": "2",
"marking_crpt": ""
}
],
"notice": "",
"weights":
{
"weight": "3000",
"barcode": "",
"x": "20",
"y": "20",
"z": "10",
"weight2": "1500",
"barcode2": "",
"x2": "10",
"y2": "15",
"z2": "10"
}
}
}

curl 'https://api.boxberry.ru/json.php' --header 'Content-Type: application/json' --data '{
"token": "d6f33e419c16131e5325cbd84d5d6000",
"method": "ParselCreate",
"sdata": {
"partner_token": "",
"updateByTrack": "",
"order_id": "Тестовый заказ 123",
"PalletNumber": "",
"barcode": "",
"price": "1950.00",
"payment_sum": "2200.00",
"delivery_sum": "250.00",
"vid": "2",
"issue": "1",
"kurdost":
{
"index": "",
"citi": "Нижний Новгород",
"addressp": "ул Дружбы, д 5",
"delivery_date": "",
"timesfrom1": "",
"timesto1": "",
"comentk": ""
},
"export":
{
"index": "",
"countryСode": "",
"cityCode": "",
"area": "",
"street": "",
"house": "",
"flat": "",
"transporterGuid": ""
},
"shop":
{
"name": "",
"name1": "010"
},
"customer":
{
"fio": "Иванов Иван Иванович",
"phone": "9001122333",
"phone2": "",
"email": ""
},
"items":
[
{
"id": "252112-dget",
"name": "Куртка детская",
"UnitName": "шт.",
"nds": "",
"price": "1750",
"quantity": "1",
"marking_crpt": ""
},
{
"id": "252334-gset",
"name": "Носки",
"UnitName": "шт.",
"nds": "",
"price": "100",
"quantity": "2",
"marking_crpt": ""
}
],
"notice": "",
"weights":
{
"weight": "3000",
"barcode": "",
"x": "20",
"y": "20",
"z": "10",
"weight2": "1500",
"barcode2": "",
"x2": "10",
"y2": "15",
"z2": "10"
}
}
}

'

$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.boxberry.ru/json.php',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"token": "d6f33e419c16131e5325cbd84d5d6000",
"method": "ParselCreate",
"sdata": {
"partner_token": "",
"updateByTrack": "",
"order_id": "Тестовый заказ 123",
"PalletNumber": "",
"barcode": "",
"price": "1950.00",
"payment_sum": "2200.00",
"delivery_sum": "250.00",
"vid": "2",
"issue": "1",
"kurdost":
{
"index": "",
"citi": "Нижний Новгород",
"addressp": "ул Дружбы, д 5",
"delivery_date": "",
"timesfrom1": "",
"timesto1": "",
"comentk": ""
},
"export":
{
"index": "",
"countryСode": "",
"cityCode": "",
"area": "",
"street": "",
"house": "",
"flat": "",
"transporterGuid": ""
},
"shop":
{
"name": "",
"name1": "010"
},
"customer":
{
"fio": "Иванов Иван Иванович",
"phone": "9001122333",
"phone2": "",
"email": ""
},
"items":
[
{
"id": "252112-dget",
"name": "Куртка детская",
"UnitName": "шт.",
"nds": "",
"price": "1750",
"quantity": "1",
"marking_crpt": ""
},
{
"id": "252334-gset",
"name": "Носки",
"UnitName": "шт.",
"nds": "",
"price": "100",
"quantity": "2",
"marking_crpt": ""
}
],
"notice": "",
"weights":
{
"weight": "3000",
"barcode": "",
"x": "20",
"y": "20",
"z": "10",
"weight2": "1500",
"barcode2": "",
"x2": "10",
"y2": "15",
"z2": "10"
}
}
}

',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

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