|
Обязательно к ознакомлению (информация о возможных проверках): |
При создании нового заказа автоматически подставляются услуги, которые были выбраны в Личном Кабинете – раздел «Услуги». |
Для POST запроса параметры передаются в теле запроса в формате JSON |
Параметр | Обязательно для запол. | Тип | Описание | Пример | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ПВЗ | КД(РФ) | КД(НеРФ) | ||||||||||||
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 | ||||||||||
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 | ||||||||||
Следующие значения записи kurdost {1..1} передаются только для Курьерской доставки по направлениям: Москва - Москва Для остальных направлений поля будут игнорироваться. | ||||||||||||||
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 И Страна получения ≠ Россия | ||||||||||||
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 | ● | ● | ● | string | Цена за единицу товара Для тип выдачи "без вскрытия" и "со вскрытием" - если создается заказ без товаров то создается одно вложение с price = "сумма к оплате" (payment_sum) минус "стоимость доставки" (delivery_sum) (если вычисленная стоимость товара отрицательная, то приравниваем к 0). | 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 {1..} | ● | ● | ● | Блок с информацией о тарных местах (SOAP - количество элементов 24, JSON - 100)
| ||||||||||
weight | ● | ● | ● | string | Вес первого тарного места (гр) Требования к заполнению:
| 400 | ||||||||
barcode | string | Штрих-код первого тарного места, передается в случае собственной маркировке отправлений.
| - | |||||||||||
x | string | Максимальная длина стороны 120 см. Габариты тарного места (см) (в сумме не должны превышать 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 | Тип выдачи заказа возможные значения: Если отсутствует, используется значение по умолчанию, установленное в Профиле магазина - раздел "Услуги". | 1 | |||||||||||
fitting | integer | Примерка Возможные значения: Если отсутствует, используется значение по умолчанию, установленное в Профиле магазина - раздел "Услуги". | 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" } |
<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/json<br />Content-Length: 1809</p> <p>{<br />"token": "d6f33e419c16131e5325cbd84d5d6000",<br />"method": "ParselCreate",<br />"sdata": {<br />"partner_token": "",<br />"updateByTrack": "",<br />"order_id": "Тестовый заказ 123",<br />"PalletNumber": "",<br />"barcode": "",<br />"price": "1950.00",<br />"payment_sum": "2200.00",<br />"delivery_sum": "250.00",<br />"vid": "2",<br />"issue": "1",<br />"kurdost":<br />{<br />"index": "",<br />"citi": "Нижний Новгород",<br />"addressp": "ул Дружбы, д 5",<br />"delivery_date": "",<br />"timesfrom1": "",<br />"timesto1": "",<br />"comentk": ""<br />},<br />"export":<br />{<br />"index": "",<br />"countryСode": "",<br />"cityCode": "",<br />"area": "",<br />"street": "",<br />"house": "",<br />"flat": "",<br />"transporterGuid": ""<br />},<br />"shop":<br />{<br />"name": "",<br />"name1": "010"<br />},<br />"customer":<br />{<br />"fio": "Иванов Иван Иванович",<br />"phone": "9001122333",<br />"phone2": "",<br />"email": ""<br />},<br />"items":<br />[<br />{<br />"id": "252112-dget",<br />"name": "Куртка детская",<br />"UnitName": "шт.",<br />"nds": "",<br />"price": "1750",<br />"quantity": "1",<br />"marking_crpt": ""<br />},<br />{<br />"id": "252334-gset",<br />"name": "Носки",<br />"UnitName": "шт.",<br />"nds": "",<br />"price": "100",<br />"quantity": "2",<br />"marking_crpt": ""<br />}<br />],<br />"notice": "",<br />"weights":<br />{<br />"weight": "3000",<br />"barcode": "",<br />"x": "20",<br />"y": "20",<br />"z": "10",<br />"weight2": "1500",<br />"barcode2": "",<br />"x2": "10",<br />"y2": "15",<br />"z2": "10"<br />}<br />}<br />}</p> </div> <div id="cURL" class="tabcontent"> <p>curl 'https://api.boxberry.ru/json.php' --header 'Content-Type: application/json' --data '{<br />"token": "d6f33e419c16131e5325cbd84d5d6000",<br />"method": "ParselCreate",<br />"sdata": {<br />"partner_token": "",<br />"updateByTrack": "",<br />"order_id": "Тестовый заказ 123",<br />"PalletNumber": "",<br />"barcode": "",<br />"price": "1950.00",<br />"payment_sum": "2200.00",<br />"delivery_sum": "250.00",<br />"vid": "2",<br />"issue": "1",<br />"kurdost":<br />{<br />"index": "",<br />"citi": "Нижний Новгород",<br />"addressp": "ул Дружбы, д 5",<br />"delivery_date": "",<br />"timesfrom1": "",<br />"timesto1": "",<br />"comentk": ""<br />},<br />"export":<br />{<br />"index": "",<br />"countryСode": "",<br />"cityCode": "",<br />"area": "",<br />"street": "",<br />"house": "",<br />"flat": "",<br />"transporterGuid": ""<br />},<br />"shop":<br />{<br />"name": "",<br />"name1": "010"<br />},<br />"customer":<br />{<br />"fio": "Иванов Иван Иванович",<br />"phone": "9001122333",<br />"phone2": "",<br />"email": ""<br />},<br />"items":<br />[<br />{<br />"id": "252112-dget",<br />"name": "Куртка детская",<br />"UnitName": "шт.",<br />"nds": "",<br />"price": "1750",<br />"quantity": "1",<br />"marking_crpt": ""<br />},<br />{<br />"id": "252334-gset",<br />"name": "Носки",<br />"UnitName": "шт.",<br />"nds": "",<br />"price": "100",<br />"quantity": "2",<br />"marking_crpt": ""<br />}<br />],<br />"notice": "",<br />"weights":<br />{<br />"weight": "3000",<br />"barcode": "",<br />"x": "20",<br />"y": "20",<br />"z": "10",<br />"weight2": "1500",<br />"barcode2": "",<br />"x2": "10",<br />"y2": "15",<br />"z2": "10"<br />}<br />}<br />}<br /><br />'</p> </div> <div id="PHP-cURL" class="tabcontent"> <p><?php</p> <p>$curl = curl_init();</p> <p>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 =>'{<br />"token": "d6f33e419c16131e5325cbd84d5d6000",<br />"method": "ParselCreate",<br />"sdata": {<br />"partner_token": "",<br />"updateByTrack": "",<br />"order_id": "Тестовый заказ 123",<br />"PalletNumber": "",<br />"barcode": "",<br />"price": "1950.00",<br />"payment_sum": "2200.00",<br />"delivery_sum": "250.00",<br />"vid": "2",<br />"issue": "1",<br />"kurdost":<br />{<br />"index": "",<br />"citi": "Нижний Новгород",<br />"addressp": "ул Дружбы, д 5",<br />"delivery_date": "",<br />"timesfrom1": "",<br />"timesto1": "",<br />"comentk": ""<br />},<br />"export":<br />{<br />"index": "",<br />"countryCode": "",<br />"cityCode": "",<br />"area": "",<br />"street": "",<br />"house": "",<br />"flat": "",<br />"transporterGuid": ""<br />},<br />"shop":<br />{<br />"name": "",<br />"name1": "010"<br />},<br />"customer":<br />{<br />"fio": "Иванов Иван Иванович",<br />"phone": "9001122333",<br />"phone2": "",<br />"email": ""<br />},<br />"items":<br />[<br />{<br />"id": "252112-dget",<br />"name": "Куртка детская",<br />"UnitName": "шт.",<br />"nds": "",<br />"price": "1750",<br />"quantity": "1",<br />"marking_crpt": ""<br />},<br />{<br />"id": "252334-gset",<br />"name": "Носки",<br />"UnitName": "шт.",<br />"nds": "",<br />"price": "100",<br />"quantity": "2",<br />"marking_crpt": ""<br />}<br />],<br />"notice": "",<br />"weights":<br />{<br />"weight": "3000",<br />"barcode": "",<br />"x": "20",<br />"y": "20",<br />"z": "10",<br />"weight2": "1500",<br />"barcode2": "",<br />"x2": "10",<br />"y2": "15",<br />"z2": "10"<br />}<br />}<br />}<br /><br />',<br />CURLOPT_HTTPHEADER => array(<br />'Content-Type: application/json'<br />),<br />));</p> <p>$response = curl_exec($curl);</p> <p>curl_close($curl);<br />echo $response;</p> </div> |
Не нашли ответ? |