Skip to content
This repository was archived by the owner on Apr 18, 2023. It is now read-only.

API

Jump to bottom
Evgen Kytonin edited this page Apr 5, 2021 · 21 revisions

api

Страница описывает все методы, аргументы для работы с Justin API. Класс Justin

Методы

Настройка подключения.

__construct

function __construct($language = 'UA', $sandbox = false, $version = 'v2', $timeout = 60, $connect_timeout = 60, $timezone = 'Europe/Kiev');
  • return object
  • $sandbox: Песочница. По умолчанию: false
  • $version: Версия API. По умолчанию: v2
  • $timeout: Тайм-аут, на возврат ответа от сервера. По умолчанию: 60 секунд
  • $connect_timeout: Тайм-аут, на подключение к серверу. По умолчанию: 60 секунд
  • $timezone: Часовой пояс. По умолчанию: Europe/Kiev

Режим песочницы

setSandbox

function setSandbox($sandbox, $type = 'justin_pms');
  • return object
  • $sandbox: Включить песочницу.
  • $type: Тип. По умолчанию: justin_pms

Передать язык ответа сервера.

setLanguage

function setLanguage($lang = 'UA');
  • return object
  • $lang: Указываем язык ответа API. По умолчанию: UA - Украинский

Передать логин для авторизации.

setAuthLogin

function setAuthLogin($login);
  • return object
  • $login: Логин для авторизации на сервере. По умолчанию: Exchange

Передать пароль для авторизации.

setAuthPassword

function setAuthPassword($password);
  • return object
  • $password: Пароль для авторизации на сервере. По умолчанию: Exchange

Передать ключ API.

setKey

function setKey($key);
  • return object
  • $key: Ключ API.

Передать логин API.

setLogin

function setLogin($login);
  • return object
  • $login: Логин API.

Передать пароль API.

setPassword

function setPassword($password);
  • return object
  • $password: Пароль API.

Передать новый адрес сервера API.

setAddressApi

function setAddressApi($address_api);
  • return object
  • $address_api: Адрес сервера API.

Получить список областей.

listRegions

function listRegions($filter = [], $limit = 0);
  • return object
  • $filter: Фильтр для более точного поиска. По умолчанию: пустой
  • $limit: Количество первых записей, что будет показано. По умолчанию: 0 записей

Получить список областных районов.

listAreasRegions

function listAreasRegions($filter = [], $limit = 0);
  • return object
  • $filter: Фильтр для более точного поиска. По умолчанию: пустой
  • $limit: Количество первых записей, что будет показано. По умолчанию: 0 записей

Получить список населенных пунктов.

listCities

function listCities($filter = [], $limit = 0);
  • return object
  • $filter: Фильтр для более точного поиска. По умолчанию: пустой
  • $limit: Количество первых записей, что будет показано. По умолчанию: 0 записей

Получить список районов населенных пунктов.

listCityRegion

function listCityRegion($filter = [], $limit = 0);
  • return object
  • $filter: Фильтр для более точного поиска. По умолчанию: пустой
  • $limit: Количество первых записей, что будет показано. По умолчанию: 0 записей

Получить список улиц города.

listStreetsCity

function listStreetsCity($filter = [], $limit = 0);
  • return object
  • $filter: Фильтр для более точного поиска. По умолчанию: пустой
  • $limit: Количество первых записей, что будет показано. По умолчанию: 0 записей

Получить список типов отделений.

branchTypes

function branchTypes($limit = 0);
  • return object
  • $limit: Количество первых записей, что будет показано. По умолчанию: 0 записей

Получить список отделений.

listDepartmentsLang

function listDepartmentsLang($filter = [], $limit = 0);
  • return object
  • $filter: Фильтр для более точного поиска. По умолчанию: пустой
  • $limit: Количество первых записей, что будет показано. По умолчанию: 0 записей

Получить расписание работы отделения.

branchSchedule

function branchSchedule($filter = [], $limit = 0);
  • return object
  • $filter: Фильтр для более точного поиска. По умолчанию: пусто
  • $limit: Количество первых записей, что будет показано. По умолчанию: 0 записей

Получить ближайшее отделение по адресу.

getNeartDepartment

function getNeartDepartment($address);
  • return object
  • $address: Адрес

Создать новый заказ на доставку.

createOrder

function createOrder($data = [], $version = 'v1');
  • return object
  • $data: Массив данных заказа. По умолчанию: пустой
  • $version: Версия API order. По умолчанию: v1

Отмена заказа.

cancelOrder

function cancelOrder($number, $version = 'v1');
  • return object
  • $number: Номер заказа. По умолчанию: v1
  • $version: Версия API

Получить список статусов.

listStatuses

function listStatuses($filter = [], $limit = 0);
  • return object
  • $filter: Фильтр для более точного поиска. По умолчанию: пустой
  • $limit: Количество первых записей, что будет показано. По умолчанию: 0 записей

Получить ключ продавца.

keySeller

function keySeller($filter = []);
  • return object
  • $filter: Поиск senderID по login пользователя. По умолчанию: пустой

Получить список статусов заказа.

getStatusHistoryF

function getStatusHistoryF($fitler = [], $limit = 0, $senderID = '');
  • return object
  • $filter: Фильтр поиска по полю orderNumber историй заказа. По умолчанию: пустой
  • $limit: Количество первых записей, что будет показано. По умолчанию: 0 записей
  • $senderID: ID отправителя. По умолчанию: пустое

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

listOrders

function listOrders($date, $version = 'v1');
  • return object
  • $date: Дата периода заказов
  • $version: Версия API. По умолчанию: v1

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

orderInfo

function orderInfo($number, $version = 'v1');
  • return object
  • $number: Номер заказа
  • $version: Версия API. По умолчанию: v1

Создать новый стикер в формате PDF.

createSticker

function createSticker($orderNumber, $show = false, $path = null, $type = 0, $version = 'v1');

  • return boolean: Статус сохранения PDF

  • $orderNumber: Номер заказа

  • $show: Вывод PDF содержимого на страницу

  • $path: Путь сохранения PDF файла

  • $type: Тип стикера

    0 = Стикер имеет название или ФИО отправителя и получателя.

    1 = Стикер имеет имена отправителя и получателя.

    2 = Стикер имеет адрес получателя, если была оформлена доставка за адресом.

  • version: Версия API. По умолчанию: v1

Clone this wiki locally