OPENAPI
 
Версія 1.3 від 26.09.2019 justin.ua
Ласкаво просимо
Готові запропонувати для використання API платформу відкритого типу. На даній платформі Вам доступний наступний функціонал:
Основний спосіб звернення до платформи - це GET запит.
Наприклад:
    http://openapi.justin.ua/branches/220
У відповідь на запит платформа формує відповідь загального вигляду в якому може знаходитись результат обробки або помилка з описом.
Структура успішної відповіді з результатом обробки:
{
  "status": 1,
  "msg": null,
  "result": [
    {
        ...
    }
  ]
}
Приклад відповіді з помилкою:
{
  "status": 0,
  "msg": {
    "code":  10104,
    "ru":  "Отделение с указанным номером не найдено",
    "ua":  "Відділення з вказаним номером не знайдено",
    "en":  "Branch with the specified number not found"
  },
  "result": null
}
Опис структури відповіді:
Ім'я змінноїТип данихОпис
status integer Статус виконання запиту. 0 - помилка, 1 - успіх
msg array Масив з даними про помилку, якщо результат запиту повернув помилку
msg.code integer Числовий код помилки
По замовчуванню платформа віддає відповідь у форматі JSON.
Для отримання відповіді у форматі XML необхідно передати GET-параметр output із значенням xml
Приклад:
    http://openapi.justin.ua/branches/220?output=xml
Для отримання відповіді у форматі JSON, але без кодування символів Unicode, необхідно передати GET-параметр output із значенням compact
Приклад:
    http://openapi.justin.ua/branches/220?output=compact
Інформація про відділення
Метод дозволяє отримати інформацію про відділення
Запит для отримання інформації всіх відділень:
    http://openapi.justin.ua/branches
Запит для отримання інформації про відділення в населеному пункті (підтримує багатомовність):
    http://openapi.justin.ua/branches?locality=Київ
Запит для отримання інформації одного відділення:
    http://openapi.justin.ua/branches/220
Приклад відповіді на запит для отримання інформації одного відділення:
{
  "status": 1,
  "msg": null,
  "result": [
    {
      "number":  "202",
      "adress":  "Київ, Оноре де Бальзака вул., 94  (Фора)",
      "locality":  "Київ",
      "type":  "Відділення",
      "format":  "SMART",
      "delivery_branch_id":  "7100103202",
      "max_weight":  "15",
      "lat":  "50.5303442",
      "lng":  "30.610678",
      "description":  "Відділення 202",
      "shedule_description":  "ПН-НД 08-20",
      "photos": [
        "https://public.justin.ua/img/6400.jpg",
        "https://public.justin.ua/img/6401.jpg"
      ],
      "services": {
        "monobank": 0,
        "insurance": 0,
        "rbc": 0,
        "moneyveo": 0,
        "cardpay": 0,
        "vending": 0,
        "postoffice": 0,
        "remittance": 0,
        ...
        список відповідно до інформації про доступні сервіси
        ...
      },
      "public": {
        "public_description_ru":  "",
        "public_description_ua":  "",
        "public_description_en":  "",
        "navigation_ru":  "\"Фора\", вхід з вул. Оноре де Бальзака, навпроти 3-4 каси",
        "navigation_ua":  "\"Фора\", вхід з вул. Оноре де Бальзака, навпроти 3-4 каси",
        "navigation_en":  "\"Фора\", вхід з вул. Оноре де Бальзака, навпроти 3-4 каси"
      }
    }
  ]
}
Опис структури відповіді:
Ім'я змінноїТип данихОпис
number string Номер відділення
adress string Адреса відділення
locality string Місто
type string Тип філіалу
format string Тип відділення
delivery_branch_id string Ідентифікатор відділення (може бути використано для API JustIn)
max_weight string Максимальна вага одного відправлення на відділенні (кг)
lat string Широта
lng string Довгота
description string Опис відділення
shedule_description string Опис розкладу роботи
photos array Масив із посиланням на публічні зображення філіалу
services array Масив із відміткою про доступні сервіси на філіалі (1 - доступний, 0 - недоступний). Детальніше в пункті "Інформація про доступні сервіси"
public array Масив із публічною інформацією про філіал та навігацією різними мовами
Інформація про типи відділень
Метод дозволяє отримати інформацію про типи відділень
Приклад запиту:
    http://openapi.justin.ua/branch_types
Приклад відповіді на запит:
{
  "status": 1,
  "msg": null,
  "result": [
    {
      "short_name":  "SMART",
      "description":  "SMART – відділення, у якому здійснюється приймання/видача відправлення вагою не більше ніж 15 кг та з
        максимальною довжиною однієї зі сторін не більше ніж 90 см."
    }
  ]
}
Опис структури відповіді:
Ім'я змінноїТип данихОпис
short_name string Коротка назва типу відділення
description string Опис типу відділення
Пошук найближчого відділення
Метод дозволяє отримати інформацію про найближчі відділення до вказаної адреси
Приклад запиту:
    http://openapi.justin.ua/branches_locator/Київ,Шевченка,30
Приклад відповіді на запит:
{
  "status": 1,
  "msg": null,
  "result": [
    {
      "number":  "258",
      "adress":  "Київ, Січових Стрільців вул. , 37/41 (Сільпо)",
      "locality":  "Київ",
      "type":  "Відділення",
      "format":  "SMART",
      "delivery_branch_id":  "7100110258",
      "max_weight":  "15",
      "lat":  "50.456107",
      "lng":  "30.496798",
      "description":  "Відділення №258",
      "shedule_description":  "ПН-НД 08-20",
      "distance":  1.33
    },
    {
      "number":  "380",
      "adress":  "Київ, Майдан Незалежності, 1А",
      "locality":  "Київ",
      "type":  "Відділення",
      "format":  "SMART",
      "delivery_branch_id":  "7100110380",
      "max_weight":  "15",
      "lat":  "50.449457",
      "lng":  "30.5260605",
      "description":  "Відділення №380",
      "shedule_description":  "ПН-НД 08-20",
      "distance":  1.57
    },
    ...
  ]
}
Опис структури відповіді:
Ім'я змінноїТип данихОпис
number string Номер відділення
adress string Адреса відділення
locality string Місто
type string Тип філіалу
format string Тип відділення
delivery_branch_id string Ідентифікатор відділення (може бути використано для API JustIn)
max_weight string Максимальна вага одного відправлення на відділенні (кг)
lat string Широта
lng string Довгота
description string Опис відділення
shedule_description string Опис розкладу роботи
distance float Відстань до відділення на карті (км)
Відслідковування відправлення
Метод дозволяє отримати інформацію про відправлення
Приклад запиту:
    http://openapi.justin.ua/tracking/201810165
Пошук може проводитись по номеру замовлення, номеру ТТН або номеру замовлення клієнта
Приклад відповіді на запит:
{
  "status": 1,
  "msg": null,
  "result": [
    {
      "orderNumber":  "201810165",
      "orderDescription":  "Замовлення клієнта 201810165 від 25.07.2018",
      "date":  "2019-02-27",
      "time":  "10:20:51",
      "status":  "Одержано",
      "departmentNumber":  "",
      "departmentAdress":  ""
    }
  ]
}
Опис структури відповіді:
Ім'я змінноїТип данихОпис
orderNumber string Номер відправлення
orderDescription string Опис відправлення
date string Дата
time string Час
status string Статус відправлення
departmentNumber string Відділення (вказано, якщо відправлення знаходиться на відділенні)
departmentAdress string Адреса відділення (вказано, якщо відправлення знаходиться на відділенні)
Історія руху відправлення
Метод дозволяє отримати історію руху відправлення
Приклад запиту:
    http://openapi.justin.ua/tracking_history/201810165
Приклад відповіді на запит:
{
  "status": 1,
  "msg": null,
  "result": [
    ...
    {
      "orderNumber":  "201810165",
      "orderDescription":  "Замовлення клієнта 201810165 від 25.07.2018",
      "date":  "2018-07-31",
      "time":  "09:29:26",
      "status":  "Прямує в місто одержання",
      "departmentNumber":  "",
      "departmentAdress":  ""
    },
    {
      "orderNumber":  "201810165",
      "orderDescription":  "Замовлення клієнта 201810165 від 25.07.2018",
      "date":  "2018-07-31",
      "time":  "16:58:47",
      "status":  "На відділенні в місті одержання",
      "departmentNumber":  "Відділення №105",
      "departmentAdress":  "Киевская, Счастливое, Харьковское ш., дом № 15 (Фора)"
    },
    ...
  ]
}
Опис структури відповіді:
Ім'я змінноїТип данихОпис
orderNumber string Номер відправлення
orderDescription string Опис відправлення
date string Дата
time string Час
status string Статус відправлення
departmentNumber string Відділення (вказано, якщо відправлення знаходиться на відділенні)
departmentAdress string Адреса відділення (вказано, якщо відправлення знаходиться на відділенні)
Інформація про населені пункти
Метод дозволяє отримати інформацію про населені пункти
Запит на отримання інформації про всі населені пункти в мережі:
    http://openapi.justin.ua/localities
або
    http://openapi.justin.ua/localities/all
Запит на отримання інформації про населені пункти в яких на даний момент працюють відділення:
    http://openapi.justin.ua/localities/activity
Приклад відповіді на запит:
{
  "status": 1,
  "msg": null,
  "result": [
    ...
    {
      "uuid":  "3785d6c7-dc04-11e7-80c6-00155dfbfb00",
      "SCOATOU":  "3220255100",
      "parent_uuid":  "acd34def-1d55-11e8-8e88-bc5ff4b8e882",
      "title_ua":  "Баришівка",
      "parent_title_ua":  "Київська",
      "title_ru":  "Барышевка",
      "parent_title_ru":  "Киевская",
      "title_en":  "Barishivka",
      "parent_title_en":  "Kyivska"
    },
    {
      "uuid":  "35b8dfa4-dbfc-11e7-80c6-00155dfbfb00",
      "SCOATOU":  "7420310100",
      "parent_uuid":  "d552f074-dbfb-11e7-80c6-00155dfbfb00",
      "title_ua":  "Бахмач",
      "parent_title_ua":  "Чернігівська",
      "title_ru":  "Бахмач",
      "parent_title_ru":  "Черниговская",
      "title_en":  "Bahmach",
      "parent_title_en":  "Chernihivska"
    },
    ...
  ]
}
Опис структури відповіді:
Ім'я змінноїТип данихОпис
uuid string Внутрішній номер населеного пункту
SCOATOU string Код КОАТУУ
parent_uuid string Внутрішній номер області
title_ua string Назва населеного пункту українською мовою
parent_title_ua string Назва області українською мовою
title_ru string Назва населеного пункту російською мовою
parent_title_ru string Назва області російською мовою
title_en string Назва населеного пункту англійською мовою
parent_title_en string Назва області англійською мовою
Інформація про доступні сервіси
Метод дозволяє отримати інформацію про всі доступні сервіси
Запит на отримання інформації про всі доступні сервіси:
    http://openapi.justin.ua/services
Приклад відповіді на запит:
{
  "status": 1,
  "msg": null,
  "result": [
    ...
    {
      "remittance": {
        "name_ru":  "Денежный перевод",
        "name_ua":  "Грошовий переказ",
        "name_en":  "Wire transfer",
        "description_ru":  "Денежный перевод — это перевод (движение) денежных средств от  ",
        "description_ua":  "Грошови́й пере́каз — поширена форма переказу грошей у  ",
        "description_en":  "Wire transfer ",
        "alias":  "remittance",
        "self_service":  "1"
      }
    },
    ...
  ]
}
Опис структури відповіді:
Ім'я змінноїТип данихОпис
name_ru string Назва сервісу російською мовою
name_ua string Назва сервісу українською мовою
name_en string Назва сервісу англійською мовою
description_ru string Опис сервісу російською мовою
description_ua string Опис сервісу українською мовою
description_en string Опис сервісу англійською мовою
alias string Alias
self_service string Позначення приналежності сервісу