Введение
Api Url http://wms.bts.uz:8040
Version 1.0 End point http://wms.bts.uz:8040
Fulfillment WMS
Http request
POST /auth
curl \
--request POST \
--url "http://wms.bts.uz:8040/v1/auth/login" \
--header "accept: "application/json"
--header "Content-Type: "application/json"
--data '{
"login": "login",
"password": "password"
}'
SUCCESS:
{
"access_token": "string",
"refresh_token": "string"
}
Parameter | Type | Description |
---|---|---|
login | string | Требуется имя пользователя |
password | string | Необходимо ввести пароль |
Поставщик покупатель
Http request
GET v1/purveyor/index
curl \
--request GET \
--url "http://wms.bts.uz:8040/v1/purveyor/index" \
--header "Authorization: "Bearer token"
--header "accept: "application/json"
--header "Content-Type: "application/json"
SUCCESS:
{
"message": "Data successfully retrieved.",
"data": {
"items": [
{
"id": 12,
"group": "string",
"code": "string",
"name": "string",
"full_name": "string",
"name_eng": "string",
"contractBankDetail": {
"id": 9,
"supplier_buyer_id": 12,
"contract_number": "string",
"contract_date": "2024-10-10",
"bank_details": "string",
"contact_info": "string",
"additional_details": "string",
"main_delivery_address": "string"
},
"entityType": {
"id": 9,
"stock_percentage": "20.00",
"stock_expiry": 0,
"supplier_buyer_id": 12,
"legal_entity": true
},
"supplierBuyerStatus": {
"id": 9,
"supplier_buyer_id": 12,
"is_supplier": true,
"is_buyer": true,
"depositor": true
},
"taxInfo": {
"id": 9,
"supplier_buyer_id": 12,
"inn": "string",
"kpp": "string",
"okpo": "string"
},
"_links": {
"self": {
"href": "http://wms.bts.uz:8040/v1/purveyor/view?id=12"
}
}
}
],
"_links": {
"self": "/v1/purveyor/index?page=1",
"first": "/v1/purveyor/index?page=1",
"last": "/v1/purveyor/index?page=1"
},
"_meta": {
"totalCount": 11,
"pageCount": 1,
"currentPage": 1,
"perPage": 20
}
}
}
Parameter | Type | Description |
---|---|---|
group | string | Группа товаров обязательна |
code | string | Необходимо ввести код продукта |
name | string | Название товара должно быть заполнено |
full_name | string | Полное наименование товара обязательно. |
name_eng | string | Английское название (название продукта на английском языке) |
stock_percentage | string | Процент резерва доступности |
stock_expiry | string | Действует до |
legal_entity | boolean | Юридическое/физическое лицо (Da/Net) |
inn | integer | Идентификационный номер налогоплательщика (ИНН) |
kpp | integer | Регистрационный код компании |
okpp | integer | Поставщик: |
is_buyer | boolean | Клиент (Да/Сеть) |
main_delivery_address | string | Основной адрес доставки |
depositor | boolean | Кладовщик (кладовщик, ответственный за товар) |
contract_number | integer | Номер контракта |
contract_date | string | Дата контракта |
bank_details | string | Банковские реквизиты |
contact_info | string | Контактная информация |
additional_details | string | Дополнительная информация |
is_supplier | boolean | Поставщик (Да/Сеть) |
Обновить статус товара к получению
Http request
POST v1/purveyor/status
curl \
--request POST \
--url "http://wms.bts.uz:8040/v1/purveyor/status" \
--header "Authorization\: "Bearer token"
--header "accept\: "application/json"
--header "Content-Type\: "application/json"
--data '{
"status" => [
{"id": 1,"status": "ok"},
{"id": 2,"status": "ok"}
]
}'
SUCCESS:
{
"message": "supplier-buyers successfully updated to delivered status"
}
Parameter | Type | Description |
---|---|---|
status | array | Вам нужно отправить ID успешно сохраненных purveyor со статусом OK. |
Продукт
Http request
GET v1/product/index
curl \
--request GET \
--url "http://wms.bts.uz:8040/v1/product/index" \
--header "Authorization: "Bearer token"
--header "accept: "application/json"
--header "Content-Type: "application/json"
SUCCESS:
{
"message": "Data successfully retrieved.",
"data": {
"items": [
{
"id": 39,
"supplier_buyer_id": 5,
"group": "stringcceee",
"code": "stringcccee",
"name": "stringcceee",
"full_name": "string",
"gtin": "112",
"article": "string",
"nomenclature_type": "11",
"unit": "22",
"comment": "string",
"productPackagin": {
"id": 7,
"product_id": 39,
"base_packaging": "string",
"billing_packaging": "string",
"report_packaging": "string"
},
"productShelfLive": {
"id": 10,
"product_id": 39,
"shelf_life_stock": "22.00",
"min_shelf_life_stock": "0.00",
"shelf_life_deviation_days": 2,
"shelf_life_period": 2,
"min_shelf_life_period": 2,
"shelf_life_deviation_period": 2,
"storage_period_days": 2,
"specification": "string",
"temperature_mode": "string"
},
"productTechnical": {
"id": 18,
"product_id": 39,
"weight": "88.000",
"net_weight": "55.000",
"volume": "77.000",
"net_volume": "44.000",
"is_set": true,
"kis_code": "99",
"default_status": "string"
},
"_links": {
"self": {
"href": "http://wms.bts.uz:8040/v1/product/view?id=39"
}
}
}
],
"_links": {
"self": "/v1/product/index?page=1",
"first": "/v1/product/index?page=1",
"last": "/v1/product/index?page=1"
},
"_meta": {
"totalCount": 3,
"pageCount": 1,
"currentPage": 1,
"perPage": 20
}
}
}
Parameter | Type | Description |
---|---|---|
group | string | Группа товаров обязательна |
code | string | Необходимо ввести код продукта |
name | string | Название товара должно быть заполнено |
full_name | string | Полное наименование товара обязательно. |
gtin | integer | GTIN (глобальный номер предмета торговли) . |
article | string | Артикул товара (номер артикула) должен быть заполнен. |
nomenclature_type | string | Тип номенклатуры (вид продукции) должен быть заполнен. |
shelf_life_stock | integer | Резерв годности (максимальный срок годности продукта) должен быть восполнен. |
abc_class | string | Класс ABC (классификация продукции согласно анализу ABC) |
kis_code | string | Код KIS (код компьютерной информационной системы) должен быть заполнен. |
comment | string | Комментарий (дополнительный комментарий или комментарий) |
is_set | boolean | To'plam (komplektmi yoki yo'qmi) 1 yoki 0 |
weight | integer | Вес (вес товара) должен быть указан |
net_weight | integer | Вес нетто (вес нетто в упаковке) должен быть указан. |
min_shelf_life_stock | string | Минимальный срок годности запаса (минимальный срок годности на момент поступления) |
name_eng | string | Английское название (название продукта на английском языке) |
tsd_name | string | Имя ТСД (имя, используемое в терминалах или сканерах) |
volume | integer | Размер (размер изделия) |
net_volume | integer | Чистый объем (объем нетто в упаковке) должен быть заполнен. |
shelf_life_deviation_days | string | Отклонение срока годности в днях (максимальное отклонение) |
min_shelf_life_period | integer | Минимальный срок годности (минимальный срок годности на момент поступления) |
shelf_life_deviation_period | string | Период отклонения срока годности (период максимального отклонения) |
depositor | string | Кладовщик (кладовщик, ответственный за товар) |
seasonal_abc_coefficient | integer | Сезонный коэффициент ABC (коэффициент согласно ABC-анализу сезонных продуктов) |
specification | string | Спецификация (описание товара или технические требования) должна быть заполнена. |
storage_period_days | string | Срок годности в днях (максимальный срок годности продукта) |
default_status | string | Статус по умолчанию (начальный статус продукта) |
temperature_mode | string | Температурный режим (температура хранения продукта) должен быть заполнен. |
base_packaging | string | Обязательно заполнение основной упаковки (основной упаковки товара). |
billing_packaging | string | Биллинговый пакет (пакет, используемый в процессе биллинга) |
report_packaging | string | Обертка отчета (обертка, используемая для отчетов) |
unit | integer | Необходимо указать единицу измерения (например, кг, единицу, литр). |
Обновить статус продуктов, которые будут получены
Http request
POST v1/product/status
curl \
--request POST \
--url "http://wms.bts.uz:8040/v1/product/status" \
--header "Authorization\: "Bearer token"
--header "accept\: "application/json"
--header "Content-Type\: "application/json"
--data '{
"status" => [
{"id": 1,"status": "ok"},
{"id": 2,"status": "ok"}
]
}'
SUCCESS:
{
"message": "products successfully updated to delivered status"
}
Parameter | Type | Description |
---|---|---|
status | array | Вам нужно отправить ID успешно сохраненных product со статусом OK. |
supplier
Http request
GET v1/receiving-goods/index
curl \
--request GET \
--url "http://wms.bts.uz:8040/v1/receiving-goods/index" \
--header "Authorization: "Bearer token"
--header "accept: "application/json"
--header "Content-Type: "application/json"
SUCCESS:
{
"message": "Data successfully retrieved.",
"data": {
"items": [
{
"id": 10,
"number": "string",
"date": "2024-11-11",
"counterparty": "string",
"arrival_date": "2024-11-11",
"comment": "string",
"vehicle_model": "string",
"vehicle_number": "string",
"driver_name": "string",
"driver_document": "string",
"contract_number": "string",
"contract_date": "2024-11-11",
"acceptance_gate": null,
"nomenclature": "string",
"quantity": 20,
"price": "200.00",
"total_amount": "2000.00",
"supplierDetail": {
"id": 7,
"supplier_id": 10,
"kis_number": null,
"kis_date": "2024-11-11",
"accept_by_places": true,
"vehicle_type": null,
"vat_rate": "20.00",
"vat_amount": "30.00",
"price_includes_vat": true,
"discount_amount": "40.00",
"under_delivery_percent": "25.00",
"over_delivery_percent": "50.00"
},
"supplierPackage": {
"id": 1,
"supplier_id": 10,
"nomenclature_package": "string11",
"package_quantity": 0
},
"_links": {
"self": {
"href": "http://wms.bts.uz:8040/v1/receiving-goods/view?id=10"
}
}
}
],
"_links": {
"self": "/v1/receiving-goods/index?page=1",
"first": "/v1/receiving-goods/index?page=1",
"last": "/v1/receiving-goods/index?page=1"
},
"_meta": {
"totalCount": 2,
"pageCount": 1,
"currentPage": 1,
"perPage": 20
}
}
}
Parameter | Type | Description |
---|---|---|
number | integer | Требуется номер доставки |
date | string | Дата доставки обязательна |
counterparty | string | Необходимо заполнить контрагента (организацию доставки груза). |
arrival_date | string | Дата получения посылки |
comment | string | Комментарий (дополнительный комментарий или комментарий) |
vehicle_model | string | Модель автомобиля |
vehicle_number | integer | Регистрационный номер транспортного средства |
driver_name | string | Полное имя водителя |
driver_document | string | Документ, связанный с водителем (паспорт, права и т.д.) |
contract_number | integer | Номер контракта |
contract_date | string | Дата контракта |
nomenclature | string | Номенклатура (вид груза или перечень продукции) должна быть заполнена. |
quantity | integer | Необходимо указать количество товара. |
price | integer | Необходимо заполнить цену за одну штуку или единицу товара. |
total_amount | integer | Общая сумма (цена * количество) должна быть заполнена. |
kis_number | integer | Номер заказа в системе КИС |
kis_date | string | Дата внесения заказа в систему КИС |
accept_by_places | boolean | Принимать по грузовому отсеку (верно/неверно) |
vehicle_type | string | Тип транспортного средства (например, грузовик, автобус) |
vat_rate | integer | Ставка НДС (в процентах) |
vat_amount | integer | сумма НДС |
price_includes_vat | boolean | Включает ли цена НДС (верно/неверно) |
discount_amount | integer | Сумма скидки |
under_delivery_percent | integer | Процент недоставленной продукции |
over_delivery_percent | integer | Процент перепоставленного товара |
nomenclature_package | string | Вид номенклатурной упаковки |
package_quantity | integer | Количество упаковок |
Обновить статус товара к получению
Http request
POST v1/receiving-goods/status
curl \
--request POST \
--url "http://wms.bts.uz:8040/v1/receiving-goods/status" \
--header "Authorization\: "Bearer token"
--header "accept\: "application/json"
--header "Content-Type\: "application/json"
--data '{
"status" => [
{"id": 1,"status": "ok"},
{"id": 2,"status": "ok"}
]
}'
SUCCESS:
{
"message": "supplier successfully updated to delivered status"
}
Parameter | Type | Description |
---|---|---|
status | array | Вам нужно отправить ID успешно сохраненных receiving_goods со статусом OK. |
Ошибки
Код ошибки | Значение |
---|---|
400 | Bad Request -- Your request sucks |
401 | Unauthorized -- Your API key is wrong |
403 | Forbidden -- The kitten requested is hidden for administrators only |
404 | Not Found -- The specified kitten could not be found |
405 | Method Not Allowed -- You tried to access a kitten with an invalid method |
406 | Not Acceptable -- You requested a format that isn't json |
410 | Gone -- The kitten requested has been removed from our servers |
429 | Too Many Requests -- You're requesting too many kittens! Slow down! |
500 | Internal Server Error -- We had a problem with our server. Try again later. |
503 | Service Unavailable -- We're temporarially offline for maintanance. Please try again later. |