gulp>> boxberry-sdk>> 返回
项目作者： iamwildtuna

项目描述 ：
SDK для работы с API BoxBerry (https://api.boxberry.ru)
高级语言： PHP
项目地址: git://github.com/iamwildtuna/boxberry-sdk.git
创建时间： 2019-05-05T16:00:05Z
项目社区：https://github.com/iamwildtuna/boxberry-sdk
开源协议：MIT License
下载






Latest Stable Version
Total Downloads
License
Telegram Chat

SDK для интеграции с программным комплексом Boxberry.

Посмотреть все проекты или подарить автору кофе можно тут.

База знаний BoxBerry.

Обратите внимание, что теперь у BoxBerry несколько API адресов:

По умолчанию API выбирает api.boxberry.de, для смены адреса необходимо при инициализации клиента вторым параметром передать нужный адрес.

Пример: 

  1. <?php
  2. $bbClient = new \WildTuna\BoxberrySdk\Client(120, 'https://api.boxberry.ru/json.php');
  3. $bbClient->setToken('main', 'bb_api_token');

Содержание

Changelog
Установка
Настройка токенов
Отладка
Создание/Редактирование заказа
Удаление/Отзыв заказа по номеру заказа магазина
Удаление/Отзыв заказа по трекномеру
Статусы заказа
Услуги в заказе
Список ПВЗ
Расчет тарифа
Полная информация о ПВЗ
Этикетка по заказу
Получить файл этикетки
Получить файл по ссылке
Получить список заказов по трек номеру или номеру заказа магазина
Информация о заказе по номеру заказа магазина
Информация о заказе по трекномеру
Список городов
Почтовые индексы с КД
Проверка почтового индекса
Список городов с КД
Список точек приема посылок
Список созданных заказов
Список доставляющихся заказов
Заявка на забор
Список заказов не добавленных в акт
Создание акта передачи посылок
Список созданных актов передачи посылок
Получить файл “Акта приема передачи посылки (АПП)” по номеру АПП
Получить файл акта ТМЦ (если подключена услуга в ЛК) по номеру АПП
Получить печатную форму этикеток по номеру АПП

Changelog

  • 0.8.9 - Добавлено поддержка country_code при получении списка ПВЗ
  • 0.8.8 - Добавлены зависимости guzzle ^7.0 и psr/log ^2.0|^3.0
  • 0.8.7 - Совместимость с Guzzle 7.4;
  • 0.8.6 - Добавлен метод для получения списка заказов по трек номерам или по номерам заказа магазина. Доработкой занимался Maxim Rodionov;
  • 0.8.5 - Добавлены методы для прямого получения печатных форм: акта, акта ТМЦ, этикеток по АПП. Доработкой занимался Maxim Rodionov;
  • 0.8.4 - Добавлен метод получения этикетки. Спасибо Maxim Rodionov за доработку;
  • 0.8.3 - Исправлен вызов методов поулчения информации о заказе. Спасибо Maxim Rodionov за доработку;
  • 0.8.1 - Добавлены новые методы API. Подробнее тут. Спасибо Maxim Rodionov за доработку;
  • 0.8.0 - Добавлена поддержка новый свойства в сущности Order и Place. Спасибо Maxim Rodionov за доработку;
  • 0.7.8 - Совместимость с Guzzle 7.3;
  • 0.7.7 - Совместимость с Guzzle 7.2;
  • 0.7.6 - Совместимость с Guzzle 7.1;
  • 0.7.5 - Совместимость с Guzzle 7;
  • 0.7.4 - Исправлено добавление параметров для заказов Почты России. Спасибо Vasiliy за обнаружение и исправление;
  • 0.7.3 - Обновлена зависимость с Guzzle;
  • 0.7.2 - Исправлены опечатки и доделана совместимость с PHP 5.5/5.6. Спасибо Алексею за внимательность;
  • 0.7.1 - Исправлена поломанная совместимость с PHP 5.5/5.6;
  • 0.7.0 - Описание можно посмотреть тут;
  • 0.6.2 - Поддержка разных адресов API;
  • 0.6.1 - Доработка логирования;
  • 0.6.0 - Добавлено логирование запросов и ответов к API;
  • 0.5.1 - Понижена минимальная требуемая версия PHP до 5.5;
  • 0.5.0 - Реализованы все функции API BoxBerry;
  • 0.4.0 - Реализованы основные функции API справка API;
  • 0.3.0 - Реализованы основные функции API сервисов BoxBerry.

Установка


Для установки можно использовать менеджер пакетов Composer

  1. composer require wildtuna/boxberry-sdk

Настройка токенов


API клиент позволяет использовать несколько токенов и переключатсья между ними.
При добавлении токенов последний добавленный становися выбранным.

Добавление токенов при инициализации:

  1. <?php
  2. $bbClient = new \WildTuna\BoxberrySdk\Client();
  3. $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  4. $bbClient->setToken('another', 'another_bb_api_token');
  5. `

Переключение токенов: 

  1. <?php
  2. $bbClient->setCurrentToken('main');
  3. $bbClient->setCurrentToken('another');
  4. `

Отладка


Для логирования запросов и ответов используется стандартный PSR-3 логгер.
Ниже приведен пример логирования используя Monolog. 

  1. <?php
  2.     use Monolog\Logger;
  3.     use Monolog\Handler\StreamHandler;
  5.     $log = new Logger('name');
  6.     $log->pushHandler(new StreamHandler('log.txt', Logger::INFO));
  8.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  9.     $bbClient->setToken('main', 'token');
  10.     $bbClient->setCurrentToken('main');
  11.     $bbClient->setLogger($log);
  12.     $result = $bbClient->getCityList();

В log.txt будут следующие строки:

  1. [2019-07-19 13:09:58] name.INFO: BoxBerry API request: token=TOKEN&method=ListCities [] []
  2. [2019-07-19 13:09:58] name.INFO: BoxBerry API response: [{"Code":"172","Name":"\u0413\u0435\u043b\u0435\u043d\u0434\u0436\u0438\u043a","ReceptionLaP":"1","DeliveryLaP":"1","Reception":"1","ForeignReceptionReturns":"1","Terminal":"1","Kladr":"2300000300000","Region":"\u041a\u0440\u0430\u0441\u043d\u043e\u0434\u0430\u0440\u0441\u043a\u0438\u0439","CountryCode":"643",.......

Создание / Редактирование заказа


Создание нового заказа в ЛК BB. Заказы бывают двух видов, до ПВЗ и курьерская доставка до двери.
Если заказ в ПВЗ, то адрес доставки заполнять не требуется.
Подробнее можно прочитать тут, функция ParselCreate.

Входные параметры:
Объект \WildTuna\BoxberrySdk\Entity\Order

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  2. $bbClient = new \WildTuna\BoxberrySdk\Client();
  3. $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  4. $bbClient->setCurrentToken('main'); // Указываем клиенту использовать ключ main для запросов
  6. try {
  7.     $order = new \WildTuna\BoxberrySdk\Entity\Order();
  8.     $order->setTrackNum(TRACK_NUM); // Трекномер заказа в системе BB. Заполняется, если нужно изменить данные заказа
  9.     $order->setDeliveryDate('2019-05-10'); // Дата доставки от +1 день до +5 дней от текущий даты (только для доставки по Москве, МО и Санкт-Петербургу)
  10.     $order->setOrderId('9999999'); // ID заказа в ИМ
  11.     $order->setPalletNum(1); // Номер паллета
  12.     $order->setBarcode('12345678'); // ШК заказа
  13.     $order->setValuatedAmount(1000); // Объявленная стоимость
  14.     $order->setPaymentAmount(1300); // Сумма к оплате
  15.     $order->setDeliveryAmount(300); // Стоимость доставки
  16.     $order->setComment('Тестовый заказ'); // Комментарий к заказу
  17.     // $order->setVid(\WildTuna\BoxberrySdk\Entity\Order::PVZ); // Тип доставки (1 - ПВЗ, 2 - КД, 3 - Почта России)
  18.     // $order->setPvzCode(61831); // Код ПВЗ
  19.     // $order->setPointOfEntry('010'); // Код пункта поступления
  20.     $order->setVid(\WildTuna\BoxberrySdk\Entity\Order::COURIER); // Тип доставки (1 - ПВЗ, 2 - КД, 3 - Почта России)
  22.     $customer = new \WildTuna\BoxberrySdk\Entity\Customer();
  23.     $customer->setFio('Иванов Петр Николаевич'); // ФИО получателя
  24.     $customer->setPhone('79995556677'); // Контактный номер телефона
  25.     $customer->setSecondPhone('79995556677'); // Дополнительный номер телефона
  26.     $customer->setEmail('test@test.ru'); // E-mail для оповещений
  28.     $customer->setIndex(115551); // Почтовый индекс получателя (не заполянется, если в ПВЗ)
  29.     $customer->setCity('Москва'); // (не заполянется, если в ПВЗ)
  30.     $customer->setAddress('Москва, ул. Маршала Захарова, д. 3а кв. 1'); // Адрес доставки (не заполянется, если в ПВЗ)
  31.     $customer->setTimeFrom('10:00'); // Время доставки от
  32.     $customer->setTimeTo('18:00'); // Время доставки до
  33.     $customer->setTimeFromSecond('10:00'); // Альтернативное время доставки от
  34.     $customer->setTimeToSecond('18:00'); // Альтернативное время доставки до
  35.     $customer->setDeliveryTime('С 10 до 19, за час позвонить'); // Время доставки текстовый формат
  37.     // Поля ниже заполняются для организации (не обязательные)
  38.     //$customer->setOrgName('ООО Ромашка'); // Наименование организации
  39.     //$customer->setOrgAddress('123456 Москва, Красная площадь дом 1'); // Арес организации
  40.     //$customer->setOrgInn('7731347089'); // ИНН организации
  41.     //$customer->setOrgKpp('773101001'); // КПП организации
  42.     //$customer->setOrgRs('40702810500036265800'); // РС организации
  43.     //$customer->setOrgKs('30101810400000000225'); // КС банка
  44.     //$customer->setOrgBankName('ПАО Сбербанк'); // Наименование банка
  45.     //$customer->setOrgBankBik('044525225'); // БИК банка
  47.     $order->setCustomer($customer);
  49.     // Создаем места в заказе
  50.     $place = new \WildTuna\BoxberrySdk\Entity\Place();
  51.     $place->setWeight(1000); // Вес места в граммах
  52.     $place->setBarcode('1234567890'); // ШК места
  53.     $order->setPlaces($place);
  55.     // Создаем товары
  56.     $item = new \WildTuna\BoxberrySdk\Entity\Item();
  57.     $item->setId('123124BC'); // ID товара в БД ИМ'
  58.     $item->setName('Тестовый товар 1'); // Название товара
  59.     $item->setAmount(100); // Цена единицы товара
  60.     $item->setQuantity(10); // Количество
  61.     $item->setVat(20); // Ставка НДС
  62.     $item->setUnit('шт'); // Единица измерения
  63.     $order->setItems($item);
  64.     $order->setSenderName('ООО Ромашка'); // Наименование отправителя
  65.     $order->setIssue(\WildTuna\BoxberrySdk\Entity\Order::TOI_DELIVERY_WITH_OPENING_AND_VERIFICATION); // вид выдачи (см. константы класса)
  67.     // Для отправления Почтой России необходимо заполнить дополнительные параметры
  68.     $russianPostParams = new \WildTuna\BoxberrySdk\Entity\RussianPostParams();
  69.     $russianPostParams->setType(\WildTuna\BoxberrySdk\Entity\RussianPostParams::PT_POSILKA); // Тип отправления (см. константы класса)
  70.     $russianPostParams->setFragile(true); // Хрупкая посылка
  71.     $russianPostParams->setStrong(true); // Строгий тип
  72.     $russianPostParams->setOptimize(true); // Оптимизация тарифа
  73.     $russianPostParams->setPackingType(\WildTuna\BoxberrySdk\Entity\RussianPostParams::PACKAGE_IM_MORE_160); // Тип упаковки (см. константы класса)
  74.     $russianPostParams->setPackingStrict(false); // Строгая упаковка
  76.     // Габариты тарного места (см) Обязательны для доставки Почтой России.
  77.     $russianPostParams->setLength(10); 
  78.     $russianPostParams->setWidth(10);
  79.     $russianPostParams->setHeight(10);
  81.     $order->setRussianPostParams($russianPostParams);
  82.     $result = $bbClient->createOrder($order);
  84.     /*
  85.      array(
  86.        'track'=>'DUD15224387', // Трек-номер BB
  87.        'label'=>'URI' // Ссылка на скачивание PDF файла с этикетками
  88.      );
  89.      */
  90. }
  92. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  93.     // Обработка ошибки вызова API BB
  94.     // $e->getMessage(); текст ошибки 
  95.     // $e->getCode(); http код ответа сервиса BB
  96.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  97. }
  99. catch (\Exception $e) {
  100.     // Обработка исключения
  101. }
  102. `

Удаление/Отзыв заказа по номеру заказа магазина


Удаление/Отзыв заказа в ЛК BB, если он не проведен в акте.

Входные параметры:

  • order_id (string) - номер ИМ
  • cancelType (integer) - Вариант отмены заказа: 1- удалить посылку, 2- отозвать посылку. Если не передан, то по умолчанию 2 - отменить посылку в ЛК ИМ.

Выходные параметры:
(err) - false запрос успешно выполнен (в ЛК ИМ изменены данные посылки)

  1.   - string сообщение об ошибке, в случае err != false

Примеры вызова:

  1. <?php
  2. $bbClient = new \WildTuna\BoxberrySdk\Client();
  3. $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  4. $bbClient->setCurrentToken('main'); // Указываем клиенту использовать ключ main для запросов
  6. try {
  7.     $order = new \WildTuna\BoxberrySdk\Entity\Order();
  8.     $result = $bbClient->deleteOrderByOrderId('1056', 1); 
  10.     if ($result['err'] === false) {
  11.         // Заказ удален
  12.     } else {
  13.         // Заказ не удален, некорректный ответ сервера BB
  14.     }
  15. }
  17. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  18.     // Обработка ошибки вызова API BB
  19.     // $e->getMessage(); текст ошибки 
  20.     // $e->getCode(); http код ответа сервиса BB
  21.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  22. }
  24. catch (\Exception $e) {
  25.     // Обработка исключения
  26. }
  27. `

Удаление/Отзыв заказа по трекномеру


Удаление/Отзыв заказа в ЛК BB, если он не проведен в акте.

Входные параметры:

  • track (string) - номер ИМ
  • cancelType (integer) - Вариант отмены заказа: 1- удалить посылку, 2- отозвать посылку. Если не передан, то по умолчанию 2 - отменить посылку в ЛК ИМ.

Выходные параметры:
(err) - false запрос успешно выполнен (в ЛК ИМ изменены данные посылки)

  • string сообщение об ошибке, в случае err != false

Примеры вызова:

  1. <?php
  2. $bbClient = new \WildTuna\BoxberrySdk\Client();
  3. $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  4. $bbClient->setCurrentToken('main'); // Указываем клиенту использовать ключ main для запросов
  6. try {
  7.     $order = new \WildTuna\BoxberrySdk\Entity\Order();
  8.     $result = $bbClient->deleteOrderByTrack('DUD15224387', 1); 
  10.     if ($result['err'] === false) {
  11.         // Заказ удален
  12.     } else {
  13.         // Заказ не удален, некорректный ответ сервера BB
  14.     }
  15. }
  17. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  18.     // Обработка ошибки вызова API BB
  19.     // $e->getMessage(); текст ошибки 
  20.     // $e->getCode(); http код ответа сервиса BB
  21.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  22. }
  24. catch (\Exception $e) {
  25.     // Обработка исключения
  26. }
  27. `

Статусы заказа


Возвращает статусы заказа по трек-номеру BB или номеру заказа ИМ.

Входные параметры:

  • order_id (string) - трек-номер / номер ИМ
  • all (boolean) - true - полная информация, false - краткая информация (по умолчанию false)

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  2. $bbClient = new \WildTuna\BoxberrySdk\Client();
  3. $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  4. $bbClient->setCurrentToken('main'); // Указываем клиенту использовать ключ main для запросов
  6. try {
  7.     $bbClient->getOrderStatuses('DUD15086277');
  8.     /*
  9.      Array
  10.      (
  11.          [0] => Array
  12.              (
  13.                  [Date] => 2019-05-01T00:56:12
  14.                  [Name] => Принято к доставке
  15.                  [Comment] =>
  16.              )
  18.          [1] => Array
  19.              (
  20.                  [Date] => 2019-05-01T00:56:13
  21.                  [Name] => Передано на сортировку
  22.                  [Comment] =>
  23.              )
  25.          [2] => Array
  26.              (
  27.                  [Date] => 2019-05-03T08:43:56
  28.                  [Name] => Передан на доставку до пункта выдачи
  29.                  [Comment] =>
  30.              )
  32.          [3] => Array
  33.              (
  34.                  [Date] => 2019-05-04T06:47:48
  35.                  [Name] => Передан на доставку до пункта выдачи
  36.                  [Comment] =>
  37.              )
  39.          [4] => Array
  40.              (
  41.                  [Date] => 2019-05-04T11:48:01
  42.                  [Name] => Поступило в пункт выдачи
  43.                  [Comment] => Москва (115478, Москва г, Каширское ш, д.24, строение 7)
  44.              )
  46.      )
  47.     */
  49.     $bbClient->getOrderStatuses('DUD15086277', true);
  50.     /*
  51.      Array
  52.      (
  53.          [statuses] => Array
  54.              (
  55.                  [0] => Array
  56.                      (
  57.                          [Date] => 30.04.2019 15:35
  58.                          [Name] => Загружен реестр ИМ
  59.                          [Comment] =>
  60.                      )
  62.                  [1] => Array
  63.                      (
  64.                          [Date] => 01.05.2019 00:56
  65.                          [Name] => Принято к доставке
  66.                          [Comment] =>
  67.                      )
  69.                  [2] => Array
  70.                      (
  71.                          [Date] => 01.05.2019 00:56
  72.                          [Name] => Передано на сортировку
  73.                          [Comment] =>
  74.                      )
  76.                  [3] => Array
  77.                      (
  78.                          [Date] => 03.05.2019 08:43
  79.                          [Name] => Передан на доставку до пункта выдачи
  80.                          [Comment] =>
  81.                      )
  83.                  [4] => Array
  84.                      (
  85.                          [Date] => 04.05.2019 06:47
  86.                          [Name] => Передан на доставку до пункта выдачи
  87.                          [Comment] =>
  88.                      )
  90.                  [5] => Array
  91.                      (
  92.                          [Date] => 04.05.2019 11:48
  93.                          [Name] => Поступило в пункт выдачи
  94.                          [Comment] => Москва (115478, Москва г, Каширское ш, д.24, строение 7)
  95.                      )
  97.              )
  99.          [PD] =>
  100.          [sum] => 5843
  101.          [Weight] => 1.58
  102.          [PaymentMethod] => Касса
  103.      )
  104.      */
  105. }
  107. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  108.     // Обработка ошибки вызова API BB
  109.     // $e->getMessage(); текст ошибки 
  110.     // $e->getCode(); http код ответа сервиса BB
  111.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  112. }
  114. catch (\Exception $e) {
  115.     // Обработка исключения
  116. }

Услуги в заказе


Возвращает информацию о услугах по трек-номеру BB или номеру заказа ИМ.

Входные параметры:

  • order_id (string) - трек-номер / номер ИМ

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  2. $bbClient = new \WildTuna\BoxberrySdk\Client();
  3. $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  4. $bbClient->setCurrentToken('main'); // Указываем клиенту использовать ключ main для запросов
  6. try {
  7.     $bbClient->getOrderServices('DUD15086277');
  8.     /*
  9.      Array
  10.      (
  11.          [0] => Array
  12.              (
  13.                  [Name] => Пост_Базовый расчет
  14.                  [Sum] => 150,36
  15.                  [Date] => 2019-05-03T00:00:00
  16.                  [PaymentMethod] => Эквайринг
  17.              )
  19.          [1] => Array
  20.              (
  21.                  [Name] => Пост_Выдача со вскрытием и проверкой комплектности
  22.                  [Sum] => 19
  23.                  [Date] => 2019-05-03T00:00:00
  24.                  [PaymentMethod] => Эквайринг
  25.              )
  27.          [2] => Array
  28.              (
  29.                  [Name] => Пост_Извещение Вайбер и СМС
  30.                  [Sum] => 2
  31.                  [Date] => 2019-05-03T00:00:00
  32.                  [PaymentMethod] => Эквайринг
  33.              )
  35.          [3] => Array
  36.              (
  37.                  [Name] => Пост_Страховой сбор
  38.                  [Sum] => 10,75
  39.                  [Date] => 2019-05-03T00:00:00
  40.                  [PaymentMethod] => Эквайринг
  41.              )
  43.          [4] => Array
  44.              (
  45.                  [Name] => Эквайринг
  46.                  [Sum] => 64,5
  47.                  [Date] => 2019-05-03T00:00:00
  48.                  [PaymentMethod] => Эквайринг
  49.              )
  51.      )
  52.      */
  53. }
  55. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  56.     // Обработка ошибки вызова API BB
  57.     // $e->getMessage(); текст ошибки 
  58.     // $e->getCode(); http код ответа сервиса BB
  59.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  60. }
  62. catch (\Exception $e) {
  63.     // Обработка исключения
  64. }

Список ПВЗ


Для получения списка ПВЗ нужно использовать метод $bbClient->getPvzList.

Входные параметры:

  • $prepaid (boolean) - false с возможностью оплаты при получении, true работающие с любым типом посылок (по умолчанию false)
  • $short (boolean) - краткая информация о ПВЗ с датой последнего изменения (по умолчанию false)
  • $city_code (integer) - позволяет выбрать ПВЗ только в заданном городе BoxBerry (по умолчанию null)
  • $country_code (integer) - позволяет выбрать ПВЗ по странам (по умолчанию null)

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  2. $bbClient = new \WildTuna\BoxberrySdk\Client();
  3. $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  4. $bbClient->setCurrentToken('main'); // Указываем клиенту использовать ключ main для запросов
  6. try {
  7.     $result = $bbClient->getPvzList(); // С возможностью оплаты при получении
  8.     /*Array
  9.       (
  10.           [0] => Array
  11.               (
  12.                   [Code] => 78031
  13.                   [Name] => Санкт-Петербург Комендантский_7803_С
  14.                   [Address] => 197227, Санкт-Петербург г, Комендантская пл, д.8, литер А, оф. 5Н
  15.                   [Phone] => +7(812)930-09-15
  16.                   [WorkSchedule] => пн-вс: 10.00-21.00
  17.                   [TripDescription] => Метро  -  "Комендантский проспект".
  18.       Примерное расстояние от метро до отделения - 400 метров.
  19.       Жилой дом.
  20.       Вход через магазин "Цветы".
  21.       Цокольный этаж.
  22.                   [DeliveryPeriod] => 1
  23.                   [CityCode] => 116
  24.                   [CityName] => Санкт-Петербург
  25.                   [TariffZone] => 2
  26.                   [Settlement] => Санкт-Петербург
  27.                   [Area] => Санкт-Петербург
  28.                   [Country] => РОССИЯ
  29.                   [OnlyPrepaidOrders] => No
  30.                   [AddressReduce] => Комендантская пл, д.8, литер А, оф. 5Н
  31.                   [Acquiring] => Yes
  32.                   [DigitalSignature] => No
  33.                   [TypeOfOffice] => СПВЗ
  34.                   [NalKD] => No
  35.                   [Metro] => Комендантский проспект
  36.                   [VolumeLimit] => 0.48
  37.                   [LoadLimit] => 15
  38.                   [GPS] => 60.005783,30.258888
  39.               )
  41.           [1] => Array
  42.               (
  43.                   [Code] => 78041
  44.     */
  46.     $result = $bbClient->getPvzList(true, true); // Краткая информация о всех ПВЗ с датой последнего изменения
  47.     /*Array
  48.       (
  49.           [0] => Array
  50.               (
  51.                   [CityCode] => 116
  52.                   [Code] => 78031
  53.                   [UpdateDate] => 2019-04-17 13:25:22
  54.               )
  56.           [1] => Array
  57.               (
  58.                   [CityCode] => 116
  59.                   [Code] => 78041
  60.                   [UpdateDate] => 2019-04-24 15:06:46
  61.               )
  63.           [2] => Array
  64.               (
  65.                   [CityCode] => 116
  66.                   [Code] => 78051
  67.                   [UpdateDate] => 2019-04-25 15:37:24
  68.               )
  69.     */
  70. }
  72. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  73.     // Обработка ошибки вызова API BB
  74.     // $e->getMessage(); текст ошибки 
  75.     // $e->getCode(); http код ответа сервиса BB
  76.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  77. }
  79. catch (\Exception $e) {
  80.     // Обработка исключения
  81. }

Расчет тарифа


Для расчета тарифа на доставку нужно использовать метод $bbClient->calcTariff.

Входные параметры:
Объект \WildTuna\BoxberrySdk\Entity\CalculateParams

Выходные параметры:
Объект \WildTuna\BoxberrySdk\Entity\TariffInfo

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $calcParams = new \WildTuna\BoxberrySdk\Entity\CalculateParams();
  9.     $calcParams->setWeight(1000);
  10.     $calcParams->setPvz(61831);
  11.     $calcParams->setAmount(1250.60);
  13.     $result = $bbClient->calcTariff($calcParams);
  15.     /*
  16.        WildTuna\BoxberrySdk\Entity\TariffInfo Object
  17.        (
  18.            [price:WildTuna\BoxberrySdk\Entity\TariffInfo:private] => 176.25
  19.            [price_base:WildTuna\BoxberrySdk\Entity\TariffInfo:private] => 168
  20.            [price_service:WildTuna\BoxberrySdk\Entity\TariffInfo:private] => 8.253
  21.            [delivery_period:WildTuna\BoxberrySdk\Entity\TariffInfo:private] => 2
  22.        )
  23.      */
  24. }
  26. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  27.     // Обработка ошибки вызова API BB
  28.     // $e->getMessage(); текст ошибки 
  29.     // $e->getCode(); http код ответа сервиса BB
  30.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  31. }
  33. catch (\Exception $e) {
  34.     // Обработка исключения
  35. }

Полная информация о ПВЗ


Для получения информации о ПВЗ нужно использовать метод $bbClient->pointDetails.
Если передан $photo=true, то в результирующем массиве будет ключ photos, который содержит массив фотографий в base64.

Входные параметры:

  • $point_id (integer) - код ПВЗ
  • $photo (boolean) - возврат фото ПВЗ (по умолчанию false)

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->pointDetails(61831); // Без фото
  9.     $result = $bbClient->pointDetails(61831, true); // С фото
  11.     /*
  12.      Array
  13.      (
  14.          [CityCode] => 44
  15.          [Reception] => 1
  16.          [IssuanceBoxberry] => 1
  17.          [Name] => Ростов-на-Дону Максима Горького_6183_С
  18.          [Organization] => Общество с ограниченной ответственностью "Атлант"
  19.          [ZipCode] => 344022
  20.          [Country] => РОССИЯ
  21.          [Area] => Ростовская обл
  22.          [CityName] => Ростов-на-Дону
  23.          [Settlement] => Ростов-на-Дону
  24.          [Metro] =>
  25.          [Street] => Максима Горького
  26.          [House] => 285
  27.          [Structure] =>
  28.          [Housing] =>
  29.          [Apartment] =>
  30.          [Address] => 344022, Ростов-на-Дону г, Максима Горького ул, д.285
  31.          [AddressReduce] => Максима Горького ул, д.285
  32.          [GPS] => 47.231912,39.737686
  33.          [TripDescription] => Остановка: Театральный.
  34.      Примерное расстояние от остановки до Отделения  -  200 метров.
  35.      Жилой 9-ти этажный дом.
  36.      Отдельный вход со стороны дороги. 1 этаж.
  37.          [Phone] => 8-800-222-80-00
  38.          [ForeignOnlineStoresOnly] => 0
  39.          [PrepaidOrdersOnly] => 0
  40.          [Acquiring] => 1
  41.          [DigitalSignature] => 0
  42.          [TypeOfOffice] => 2
  43.          [ReceptionLaP] => 1
  44.          [DeliveryLaP] => 1
  45.          [LoadLimit] => 15
  46.          [VolumeLimit] => 0.48
  47.          [EnablePartialDelivery] => 1
  48.          [EnableFitting] => 1
  49.          [fittingType] => 1
  50.          [WorkShedule] => пн-вс: 10.00-19.00
  51.          [WorkMoBegin] => 10:00
  52.          [WorkMoEnd] => 19:00
  53.          [WorkTuBegin] => 10:00
  54.          [WorkTuEnd] => 19:00
  55.          [WorkWeBegin] => 10:00
  56.          [WorkWeEnd] => 19:00
  57.          [WorkThBegin] => 10:00
  58.          [WorkThEnd] => 19:00
  59.          [WorkFrBegin] => 10:00
  60.          [WorkFrEnd] => 19:00
  61.          [WorkSaBegin] => 10:00
  62.          [WorkSaEnd] => 19:00
  63.          [WorkSuBegin] => 10:00
  64.          [WorkSuEnd] => 19:00
  65.          [LunchMoBegin] =>
  66.          [LunchMoEnd] =>
  67.          [LunchTuBegin] =>
  68.          [LunchTuEnd] =>
  69.          [LunchWeBegin] =>
  70.          [LunchWeEnd] =>
  71.          [LunchThBegin] =>
  72.          [LunchThEnd] =>
  73.          [LunchFrBegin] =>
  74.          [LunchFrEnd] =>
  75.          [LunchSaBegin] =>
  76.          [LunchSaEnd] =>
  77.          [LunchSuBegin] =>
  78.          [LunchSuEnd] =>
  79.          [TerminalCode] => 50
  80.          [TerminalName] => Ростов-на-Дону Каширская_6101
  81.          [TerminalOrganization] => ООО "Боксберри Юг"
  82.          [TerminalCityCode] => 44
  83.          [TerminalCityName] => Ростов-на-Дону
  84.          [TerminalAddress] => 344091, Ростов-на-Дону г, Каширская ул, д.9/53а
  85.          [TerminalPhone] => 8-800-222-80-00
  86.          [CourierDelivery] => 0
  87.          [CountryCode] => 643
  88.          [AddressInfo] =>
  89.          [Terminal] => 0
  90.          [TransType] => 1
  91.          [InterRefunds] => 1
  92.          [ExpressReception] => 0
  93.          [extraCode] => 6183
  94.          [TemporaryWorkSchedule] =>
  95.      )
  96.      */
  97. }
  99. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  100.     // Обработка ошибки вызова API BB
  101.     // $e->getMessage(); текст ошибки 
  102.     // $e->getCode(); http код ответа сервиса BB
  103.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  104. }
  106. catch (\Exception $e) {
  107.     // Обработка исключения
  108. }

Этикетка по заказу


Позволяет получить ссылку на файл печати этикеток по определенной посылке.

Входные параметры:

  • track (string) - трек-номер

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->getLabel('DUD15086277');
  9. }
  10. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  11.     // Обработка ошибки вызова API BB
  12.     // $e->getMessage(); текст ошибки 
  13.     // $e->getCode(); http код ответа сервиса BB
  14.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  15. }
  17. catch (\Exception $e) {
  18.     // Обработка исключения
  19. }

Получить файл этикетки


Позволяет сразу получить файл с этикеткой

Входные параметры:

  • track (string) - трек-номер

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->getLabelFile('DUD15086277');
  9. }
  10. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  11.     // Обработка ошибки вызова API BB
  12.     // $e->getMessage(); текст ошибки 
  13.     // $e->getCode(); http код ответа сервиса BB
  14.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  15. }
  17. catch (\Exception $e) {
  18.     // Обработка исключения
  19. }

Получить файл по ссылке


Позволяет получить файл по ссылке. Боксберри отдает файлы этикетки, АПП, печатную форму акта, печатную форму акта ТМЦ в виде ссылок на скачивание.
Прямых методов на получение файлов у Боксберри нет, поэтому данный метод позволит обработать все существующие ссылки на печатные версии документов.

Входные параметры:

  • link (string) - ссылка на документ

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->getLabelFile('http://api.boxberry.ru/parcel-files/act?upload_id=123');
  9. }
  10. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  11.     // Обработка ошибки вызова API BB
  12.     // $e->getMessage(); текст ошибки 
  13.     // $e->getCode(); http код ответа сервиса BB
  14.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  15. }
  17. catch (\Exception $e) {
  18.     // Обработка исключения
  19. }

Информация о заказе по номеру заказа магазина


Позволяет получить информацию о заказе по номеру заказа в магазине.

Входные параметры:

  • order_id (string) - номер заказа в магазине

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->getOrderInfoByOrderId('6277');
  9. }
  10. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  11.     // Обработка ошибки вызова API BB
  12.     // $e->getMessage(); текст ошибки 
  13.     // $e->getCode(); http код ответа сервиса BB
  14.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  15. }
  17. catch (\Exception $e) {
  18.     // Обработка исключения
  19. }

Получить список заказов по трек номеру или номеру заказа магазина


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

Входные параметры:

  • $order_ids (array) - массив трек номеров или номеров заказов магазина
  • $parcel_type (string) - тип выборки (трек номер посылки или номер заказа магазина), принимает значения ‘order_id’ или ‘track’. По умолчанию ‘order_id’

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $orderIds = [26974, 26975, 26980];
  9.     $trackIds = ['A123123121', 'B123123123', 'C123123123'];
  11.     $result = $bbClient->getAllOrdersInfo($orderIds, 'order_id');
  12.     $result = $bbClient->getAllOrdersInfo($trackIds, 'track');
  13. }
  14. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  15.     // Обработка ошибки вызова API BB
  16.     // $e->getMessage(); текст ошибки 
  17.     // $e->getCode(); http код ответа сервиса BB
  18.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  19. }
  21. catch (\Exception $e) {
  22.     // Обработка исключения
  23. }

Информация о заказе по трекномеру


Позволяет получить информацию о заказе по трекномеру.

Входные параметры:

  • track_id (string) - трекномер

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->getOrderInfoByTrack('DUD15086277');
  9. }
  10. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  11.     // Обработка ошибки вызова API BB
  12.     // $e->getMessage(); текст ошибки 
  13.     // $e->getCode(); http код ответа сервиса BB
  14.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  15. }
  17. catch (\Exception $e) {
  18.     // Обработка исключения
  19. }

Список городов


Позволяет получить список городов, в которых есть пункты выдачи и список городов, в которых есть курьерская доставка.

Входные параметры:

  • $all (boolean) - false - список городов, в которых есть ПВЗ, true список городов, в которых осуществляется доставка + в которых есть ПВЗ (по умолчанию false)

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->getCityList();
  9.     /*
  10.      Array
  11.      (
  12.          [0] => Array
  13.              (
  14.                  [Code] => 172
  15.                  [Name] => Геленджик
  16.                  [ReceptionLaP] => 1
  17.                  [DeliveryLaP] => 1
  18.                  [Reception] => 1
  19.                  [ForeignReceptionReturns] => 1
  20.                  [Terminal] => 1
  21.                  [Kladr] => 2300000300000
  22.                  [Region] => Краснодарский
  23.                  [CountryCode] => 643
  24.                  [UniqName] => Геленджик
  25.                  [District] =>
  26.                  [Prefix] => г
  27.              )
  29.          [1] => Array
  30.              (
  31.                  [Code] => 04626
  32.                  [Name] => Долгопрудный
  33.                  [ReceptionLaP] => 1
  34.                  [DeliveryLaP] => 1
  35.                  [Reception] => 1
  36.                  [ForeignReceptionReturns] => 1
  37.                  [Terminal] => 0
  38.                  [Kladr] => 5000002900000
  39.                  [Region] => Московская
  40.                  [CountryCode] => 643
  41.                  [UniqName] => Долгопрудный
  42.                  [District] =>
  43.                  [Prefix] => г
  44.              )
  45.      */
  46. }
  47. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  48.     // Обработка ошибки вызова API BB
  49.     // $e->getMessage(); текст ошибки 
  50.     // $e->getCode(); http код ответа сервиса BB
  51.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  52. }
  54. catch (\Exception $e) {
  55.     // Обработка исключения
  56. }

Почтовые индексы с КД


Возвращает список почтовых индексов, для которых возможна курьерская доставка.

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->getZipList();
  9.     /*
  10.      Array
  11.      (
  12.          [0] => Array
  13.              (
  14.                  [Zip] => 187033
  15.                  [City] =>
  16.                  [Region] =>
  17.                  [Area] =>
  18.                  [ZoneExpressDelivery] => 1
  19.                  [ExpressDelivery] => Да
  20.              )
  22.          [1] => Array
  23.              (
  24.                  [Zip] => 655001
  25.                  [City] => Абакан
  26.                  [Region] =>
  27.                  [Area] => Хакасия
  28.                  [ZoneExpressDelivery] => 1
  29.                  [ExpressDelivery] => Да
  30.              )
  31.      */
  32. }
  33. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  34.     // Обработка ошибки вызова API BB
  35.     // $e->getMessage(); текст ошибки 
  36.     // $e->getCode(); http код ответа сервиса BB
  37.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  38. }
  40. catch (\Exception $e) {
  41.     // Обработка исключения
  42. }

Проверка почтового индекса


Проверка возможности курьерской доставки в заданном индексе.

Входные параметры:

  • $index (integer) - Почтовый индекс

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->checkZip(115551);
  9.     /*
  10.      Array
  11.      (
  12.          [ExpressDelivery] => 1
  13.          [ZoneExpressDelivery] => 2
  14.      )
  15.      */
  16. }
  17. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  18.     // Обработка ошибки вызова API BB
  19.     // $e->getMessage(); текст ошибки 
  20.     // $e->getCode(); http код ответа сервиса BB
  21.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  22. }
  24. catch (\Exception $e) {
  25.     // Обработка исключения
  26. }

Список городов с КД


Список городов, в которых осуществляется курьерская доставка.

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->getCourierCities();
  9.     /*
  10.      Array
  11.      (
  12.          [0] => Array
  13.              (
  14.                  [City] => Абакан
  15.                  [Region] =>
  16.                  [Area] => Хакасия
  17.                  [DeliveryPeriod] => 7.00
  18.              )
  20.          [1] => Array
  21.              (
  22.                  [City] => Авдулово
  23.                  [Region] => Данковский
  24.                  [Area] => Липецкая
  25.                  [DeliveryPeriod] =>
  26.              )
  27.      */
  28. }
  29. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  30.     // Обработка ошибки вызова API BB
  31.     // $e->getMessage(); текст ошибки 
  32.     // $e->getCode(); http код ответа сервиса BB
  33.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  34. }
  36. catch (\Exception $e) {
  37.     // Обработка исключения
  38. }

Список точек приема посылок


Список точек приема посылок.

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->getPointsForParcels();
  9.     /*
  10.      Array
  11.      (
  12.          [0] => Array
  13.              (
  14.                  [Code] => 04854
  15.                  [Name] => Санкт-Петербург Терминал
  16.                  [City] => Санкт-Петербург
  17.              )
  19.          [1] => Array
  20.              (
  21.                  [Code] => 82010
  22.                  [Name] => Симферополь Караимская_8201
  23.                  [City] => Симферополь
  24.              )
  26.      */
  27. }
  28. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  29.     // Обработка ошибки вызова API BB
  30.     // $e->getMessage(); текст ошибки 
  31.     // $e->getCode(); http код ответа сервиса BB
  32.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  33. }
  35. catch (\Exception $e) {
  36.     // Обработка исключения
  37. }

Список созданных заказов


Позволяет получить список созданных через API посылок.
Если не указывать диапазоны дат, то будет возвращен последний созданный заказ.

Выходные параметры:

  • $from (string) - период от (дата в любом формате)
  • $to (string) - период до (дата в любом формате)

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->getOrderList();
  9.     /*
  10.      Array
  11.      (
  12.          [0] => Array
  13.              (
  14.                  [track] => DUD15191668
  15.                  [label] =>
  16.                  [date] => 2019.05.06 15:32:51
  17.                  [send] => 1
  18.                  [barcode] => DUD8133818
  19.                  [imid] => 8133818
  20.              )
  22.      )
  23.      */
  24. }
  25. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  26.     // Обработка ошибки вызова API BB
  27.     // $e->getMessage(); текст ошибки 
  28.     // $e->getCode(); http код ответа сервиса BB
  29.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  30. }
  32. catch (\Exception $e) {
  33.     // Обработка исключения
  34. }

Список доставляющихся заказов


Получает информацию по заказам, которые фактически переданы на доставку в BoxBerry, но они еще не доставлены получателю.

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->getOrdersInProgress();
  9.     /*
  10.      Array
  11.      (
  12.          [0] => Array
  13.              (
  14.                  [ID] => 4194177
  15.                  [Status] => На отделении-получателе
  16.                  [Price] => 0
  17.                  [Delivery_sum] => 0
  18.                  [Payment_sum] => 3289
  19.              )
  21.          [1] => Array
  22.              (
  23.                  [ID] => 1178452
  24.                  [Status] => В пути на терминал
  25.                  [Price] => 0
  26.                  [Delivery_sum] => 0
  27.                  [Payment_sum] => 2600
  28.              )
  30.      */
  31. }
  32. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  33.     // Обработка ошибки вызова API BB
  34.     // $e->getMessage(); текст ошибки 
  35.     // $e->getCode(); http код ответа сервиса BB
  36.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  37. }
  39. catch (\Exception $e) {
  40.     // Обработка исключения
  41. }

Заявка на забор


Создание заявки на забор заказов.

Входные параметры:
Объект \WildTuna\BoxberrySdk\Entity\Intake - параметры заявки

Выходные параметры:
integer - номер заявки в системе BB

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $intake = new \WildTuna\BoxberrySdk\Entity\Intake();
  9.     $intake->setZip(105005);
  10.     $intake->setCity('Москва');
  11.     $intake->setStreet('Бауманская ул.');
  12.     $intake->setHouse(56);
  13.     $intake->setCorpus(5);
  14.     $intake->setBuilding('в');
  15.     $intake->setFlat(4);
  16.     $intake->setContactPerson('Иванов Иван Иванович');
  17.     $intake->setContactPhone('79095556677');
  18.     $intake->setTakingDate('2019-05-07');
  19.     $intake->setPlaces(2);
  20.     $intake->setVolume(5);
  21.     $intake->setWeight(5);
  22.     $intake->setComment('Примечание к заявке');
  24.     $intake_num = $bbClient->createIntake($intake); // $intake_num = 54851
  26. }
  28. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  29.     // Обработка ошибки вызова API BB
  30.     // $e->getMessage(); текст ошибки 
  31.     // $e->getCode(); http код ответа сервиса BB
  32.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  33. }
  35. catch (\Exception $e) {
  36.     // Обработка исключения
  37. }

Список заказов не добавленных в акт


Позволяет получить список всех трекинг кодов посылок которые есть в кабинете но не были сформированы в акт.

Входные параметры:

  • $arr (bool) - true в виде массива, false в виде строки (по умолчанию false)

Выходные параметры:
array|string - массив трек-номеров или строка трек-номеров разделенная запятой

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $tracknums = $bbClient->getOrdersNotAct(); // строкой $tracknums = 'XXXXXX,XXXXXX,XXXXXX';
  10.     $tracknums = $bbClient->getOrdersNotAct(true); // массивом
  11.     /*
  12.      array(
  13.          'XXXXXX',
  14.          'XXXXXX',
  15.          'XXXXXX'
  16.      );
  17.      */
  18. }
  20. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  21.     // Обработка ошибки вызова API BB
  22.     // $e->getMessage(); текст ошибки 
  23.     // $e->getCode(); http код ответа сервиса BB
  24.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  25. }
  27. catch (\Exception $e) {
  28.     // Обработка исключения
  29. }

Создание акта передачи посылок


Создание акта передачи посылок в BoxBerry.
Внимание! сервис работает только с заказами созданными через API ЛК.

Выходные параметры:
Массив трек-номеров заказов

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $tracknums = ['DUD15086277', 'DUD15086278', 'DUD15086279', 'DUD15086280'];
  9.     $result = $bbClient->createOrdersTransferAct($tracknums);
  10.     /*
  11.      Array
  12.      (
  13.         'id' => Номер акта,
  14.         'label' => 'URI',
  15.         'sticker' => 'URI' // Ссылка на этикетки
  16.      )
  17.      */
  18. }
  19. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  20.     // Обработка ошибки вызова API BB
  21.     // $e->getMessage(); текст ошибки 
  22.     // $e->getCode(); http код ответа сервиса BB
  23.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  24. }
  26. catch (\Exception $e) {
  27.     // Обработка исключения
  28. }

Список созданных актов передачи посылок


Позволяет получить список созданных через API актов передачи заказов.
Если не указывать диапазоны дат, то будет возвращен последний созданный акт.
Внимание! сервис работает только с актами созданными через API ЛК.

Выходные параметры:

  • $from (string) - период от (дата в любом формате)
  • $to (string) - период до (дата в любом формате)

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->getActsList();
  9.     /*
  10.      Array
  11.      (
  12.          [0] => Array
  13.              (
  14.                 'track'=>'XXXXXX,XXXXXX,XXXXXX', // список трекинг кодов посылок в акте,
  15.                 'label'=>'URI', // ссылка на скачивание акта, если доступна,
  16.                 'date'=>'2019.05.07' // дата создания посылки в формате YYYY.MM.DD HH:MM:SS.
  17.              )
  19.      )
  20.      */
  21. }
  22. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  23.     // Обработка ошибки вызова API BB
  24.     // $e->getMessage(); текст ошибки 
  25.     // $e->getCode(); http код ответа сервиса BB
  26.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  27. }
  29. catch (\Exception $e) {
  30.     // Обработка исключения
  31. }

Получить файл “Акта приема передачи посылки (АПП)” по номеру АПП


Позволяет получить файл “Акта приема передачи посылки (АПП)” по номеру АПП

Входные параметры:

  • $parcelId - номер АПП

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->getParcelFileActToId('12942207');
  9. }
  10. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  11.     // Обработка ошибки вызова API BB
  12.     // $e->getMessage(); текст ошибки 
  13.     // $e->getCode(); http код ответа сервиса BB
  14.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  15. }
  17. catch (\Exception $e) {
  18.     // Обработка исключения
  19. }

Получить файл акта ТМЦ (если подключена услуга в ЛК) по номеру АПП


Позволяет получить файл акта ТМЦ (если подключена услуга в ЛК) по номеру АПП

Входные параметры:

  • $parcelId - номер АПП

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->getParcelFileActTMCToId('12942207');
  9. }
  10. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  11.     // Обработка ошибки вызова API BB
  12.     // $e->getMessage(); текст ошибки 
  13.     // $e->getCode(); http код ответа сервиса BB
  14.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  15. }
  17. catch (\Exception $e) {
  18.     // Обработка исключения
  19. }

Получить печатную форму этикеток по номеру АПП


Позволяет получить печатную форму этикеток по номеру АПП

Входные параметры:

  • $parcelId - номер АПП

Выходные параметры:
Ассоциативный массив данных

Примеры вызова:

  1. <?php
  3. try {
  4.     $bbClient = new \WildTuna\BoxberrySdk\Client();
  5.     $bbClient->setToken('main', 'bb_api_token'); // Заносим токен BB и присваиваем ему ключ main
  6.     $bbClient->setCurrentToken('main');
  8.     $result = $bbClient->getParcelFileBarcodesToId('12942207');
  9. }
  10. catch (\WildTuna\BoxberrySdk\Exception\BoxBerryException $e) {
  11.     // Обработка ошибки вызова API BB
  12.     // $e->getMessage(); текст ошибки 
  13.     // $e->getCode(); http код ответа сервиса BB
  14.     // $e->getRawResponse(); // ответ сервера BB как есть (http request body)
  15. }
  17. catch (\Exception $e) {
  18.     // Обработка исключения
  19. }