logo
API docs by Redocly

BIO API (1.0.0)

Download OpenAPI specification:Download

E-mail: info@holdingbio.ru URL: https://holdingbio.ru

Общая информация

BIO API (Application Programming Interface – интерфейс программирования приложений) – это интерфейс взаимодействия с учетной системой Компании БИО, который дает возможность с помощью http-запросов получать и обрабатывать бизнес-данные:

  • получение списка актуальных заказов и публикация новых
  • получение данных по номенклатуре (остатки, цены)
  • сверка взаиморасчетов с Компанией БИО
  • управление бонусами
  • и многое-многое другое :-)

Сервис расположен здесь: http://api.bioshop.ru:8030. Примером взаимодействия с API служит Портал. Все данные, выводимые на портале, можно получить через API.

Протокол передачи данных

На текущий момент API поддерживает HTTP протокол. HTTPS протокол будет внедрен в ближайшее время.

Формат запросов

По умолчанию в API используются POST-запросы.

Аутентификация

Все запросы требуют логин и пароль пользователя для аутентификации.

Auth

Аутентификация пользователя

Данные аутентификации пользователя

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

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "fio": "string",
  • "initials": "string",
  • "gender": "string",
  • "birthday": "string",
  • "phone": "string",
  • "client": {
    },
  • "companies": [
    ],
  • "settings": {
    },
  • "rates": [
    ]
}

Bonuses

Бонусы клиента

Ведомость по бонусам

Получение движений по приходу/расходу бонусов

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string"
}

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Categories

Категории товаров

Категории товаров

Получение общего списка категорий товаров (видов номенклатуры)

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
folderCode
string
Enum: "165729" "6077" "6056"

Отбор на группу товаров: Оборудование (165729), Посуда (6077), Запчасти (6056)

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "folderCode": "165729"
}

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Category

Категория товара (основные данные)

Категория товаров

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

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
categoryId
required
string

Уникальный идентификатор категории товара

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "categoryId": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "categoriesFolder": "string",
  • "currentCategory": "string",
  • "categories": [
    ]
}

Client settlements

Расчеты с клиентом

Расчеты с клиентом

Получение информации по взаиморасчетам. Возможно получение данных в XLSX-формате

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
startDate
required
string <yyyy-MM-dd | yyyyMMdd>

Начало периода

endDate
required
string <yyyy-MM-dd | yyyyMMdd>

Окончание периода

download
boolean

Признак формирования отчета в XLSX-формате

companyFilter
string <uuid>

уникальный идентификатор юридического лица

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "download": true,
  • "companyFilter": "6aae5aec-91a0-45cf-a299-e001625d5fa5"
}

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Finance

Финансовые показатели (итоги)

Финансовые показатели

Получение итоговых финансовых показателей в рамках взаимодействия клиента с Компанией БИО

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "bonuses": 0,
  • "creditLimit": 0,
  • "creditDays": 0,
  • "debt": 0,
  • "overdueDebt": 0,
  • "prepay": 0
}

Order

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

Данные по заказу

Получение данных по выбранному заказу

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
link
required
string

Ссылка на заказ клиента

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "link": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "number": "string",
  • "date": "string",
  • "firm": "string",
  • "company": "string",
  • "sum": 0,
  • "currency": "string",
  • "manager": "string",
  • "storage": "string",
  • "contactPerson": "string",
  • "paymentSum": 0,
  • "paymentPercent": 0,
  • "shipmentSum": 0,
  • "shipmentPercent": 0,
  • "completeSum": 0,
  • "completePercent": 0,
  • "isDraft": true,
  • "activeShipmentDoc": {
    },
  • "comment": "string",
  • "products": [
    ],
  • "upd": [
    ]
}

Печатные формы заказа

Получение печатных форм заказа

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
link
required
string

Ссылка на заказ клиента

print
required
string
Enum: "ORDER" "KP" "UPD"

Имя печатной формы

ext
required
string
Enum: "PDF" "XLSX"

Расширение файла

number
string

Номер реализации (необходим дял печать УПД)

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "link": "string",
  • "print": "ORDER",
  • "ext": "PDF",
  • "number": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "file": "string"
}

Комментарий заказа

Установка комментария пользователя к заказу

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
link
required
string

Ссылка на заказ клиента

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "link": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "result": null
}

Состояние заказа

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

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
link
required
string

Ссылка на заказ клиента

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "link": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "firm": "string",
  • "company": "string",
  • "docSum": "string",
  • "storage": "string",
  • "paymentSum": "string",
  • "paymentPercent": "string",
  • "shipment": {
    },
  • "products": [
    ]
}

Новый заказ

Создание нового заказа

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
company
required
string <uuid>

Уникальный идентификатор юридического лица

required
Array of objects

Массив заказываемых товаров

comment
string

Комментарий пользователя к заказу

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "company": "87340f10-f684-4b06-8427-5981380bd9a9",
  • "products": [
    ],
  • "comment": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "storeOrder": "string",
  • "waitOrder": "string"
}

Orders

Список заказов клиента

Список заказов клиента

Получение списка заказов

Request Body schema: application/json; charset=utf-8

Может включать параметры отбора, сортировки, поиска

login
required
string
password
required
string
page
number
Default: 1

отображаемая страница списка

state
string
Default: "inwork"
Enum: "all" "inwork" "finished"

состояние заказа

companyFilter
string <uuid>

уникальный идентификатор контрагента

object (Sort)

сортировка строк

search
string

строка поиска

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "page": 1,
  • "state": "all",
  • "companyFilter": "6aae5aec-91a0-45cf-a299-e001625d5fa5",
  • "sort": {
    },
  • "search": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "pagesCount": 0,
  • "totalDocs": 0,
  • "inWorkDocs": 0,
  • "finishedDocs": 0,
  • "orders": [
    ]
}

Product

Информация по выбранному товару

Данные по товару

Получение данных по выбранному товару

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
code
required
string

Код товара

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "code": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "barcode": "string",
  • "code": "string",
  • "name": "string",
  • "fullName": "string",
  • "vendorCode": "string",
  • "category": "string",
  • "brand": "string",
  • "model": "string",
  • "country": "string",
  • "unit": "string",
  • "isOrdered": true,
  • "isSale": true,
  • "isMarkdown": true,
  • "originalCode": "string",
  • "description": "string",
  • "sizeNet": "string",
  • "sizeGross": "string",
  • "weightNet": 0,
  • "weightGross": 0,
  • "weightUnit": "string",
  • "deliveryTime": 0,
  • "warranty": 0,
  • "img": "string",
  • "inStock": 0,
  • "inReserve": 0,
  • "inAccess": 0,
  • "inWait": 0,
  • "receiptDate": "string",
  • "dilerPrice": 0,
  • "dilerCurrency": "string",
  • "dilerUnit": "string",
  • "dilerPriceRUB": 0,
  • "price": 0,
  • "priceCurrency": "string",
  • "priceUnit": "string",
  • "priceRUB": 0,
  • "secondaryProps": [
    ],
  • "files": [
    ]
}

Ожидаемые поставки товара

Получение данных о планируемых поставках по выбранному товару

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
code
required
string

Код товара

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "code": "string"
}

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Файлы товара

Получение дополнительных файлов по выбранному товару (спецификация, взрыв-схема, инструкция и т.п.)

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
ref
string <uuid>

Уникальный идентификатор файла

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "ref": "d0fad5d6-e996-4437-8fb9-5f40bbcfd7cc"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "file": "string"
}

Products

Список товаров

Список товаров

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

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
categoryId
required
string <uuid>

Уникальный идентификатор категории товара

object

Дополнительный отбор

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "filter": {
    }
}

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Список товаров (распродажа)

Получение списка товаров в распродаже

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
download
boolean

Признак формирования списка товаров в XLSX-формате

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "download": true
}

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Список товаров (уценка)

Получение списка товаров в уценке

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
download
boolean

Признак формирования списка товаров в XLSX-формате

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "download": true
}

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Доступные фильтры

Получение фильтров для товаров заданной категории

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
categoryId
required
string <uuid>

Уникальный идентификатор категории товара

brand
boolean

Если необходим список доступных брендов

country
boolean

Если необходим список доступных стран

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "brand": true,
  • "country": true
}

Response samples

Content type
application/json; charset=utf-8
{
  • "brand": [
    ],
  • "country": [
    ]
}

Settings

Настройки пользователя

Настройки пользователя

Установка и чтение настроек

Request Body schema: application/json; charset=utf-8
login
required
string
password
required
string
Array of objects

Необходимый порядок и использование колонок на странице "Заказы"

Array of objects

Корзина для сохранения выбранного товара

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "login": "string",
  • "password": "string",
  • "ordersColumns": [
    ],
  • "basket": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "ordersColumns": [
    ],
  • "basket": [
    ]
}