Introduction

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	Username is required
password	string	Password must be entered

Supplier buyer

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	Product group is mandatory
code	string	Product code must be entered
name	string	The name of the product
full_name	string	The full name of the product is mandatory
name_eng	string	English name (product name in English)
stock_percentage	string	Availability reserve percentage
stock_expiry	string	Date of Expired
legal_entity	boolean	Legal/Physical Entity (Da/Net)
inn	integer	Taxpayer identification number
kpp	integer	Company registered code
okpp	integer	Supplier:
is_buyer	boolean	Customer (Da/Net)
main_delivery_address	string	Primary delivery address
depositor	boolean	Storekeeper (storekeeper responsible for the product)
contract_number	integer	Contract number
contract_date	string	Contract Date
bank_details	string	Bank details:
contact_info	string	Contact information
additional_details	string	Additional details
is_supplier	boolean	Supplier (Da/Net)

Update the status of goods to be received

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	You need to send the IDs of successfully saved purveyor with an OK status.

product

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	Product group is mandatory
code	string	Product code must be entered
name	string	The name of the product
full_name	string	The full name of the product is mandatory
gtin	integer	GTIN (Global Trade Item Number) in
article	string	The product article (article number)
nomenclature_type	string	Nomenclature type (type of product)
shelf_life_stock	integer	Expiration reserve (maximum shelf life of the product)
abc_class	string	ABC class (product classification according to ABC analysis)
kis_code	string	The KIS code (Computer Information System code)
comment	string	Comment (additional comment or comment)
is_set	boolean	Set (complete or not) 1 or 0
weight	integer	Weight (product weight)
net_weight	integer	The net weight (net weight in the package)
min_shelf_life_stock	string	Minimum shelf life stock (minimum shelf life at the time of receipt)
name_eng	string	English name (product name in English)
tsd_name	string	TSD name (name used in terminals or scanners)
volume	integer	Size (product size)
net_volume	integer	The net volume (net volume in the package)
shelf_life_deviation_days	string	Expiry date deviation in days (maximum deviation)
min_shelf_life_period	integer	Minimum shelf life (minimum shelf life at the time of receipt)
shelf_life_deviation_period	string	Shelf life deviation period (maximum deviation period)
depositor	string	Storekeeper (storekeeper responsible for the product)
seasonal_abc_coefficient	integer	Seasonal ABC coefficient (coefficient according to ABC analysis of seasonal products)
specification	string	The specification (product description or technical requirements)
storage_period_days	string	Shelf life in days (maximum shelf life of the product)
default_status	string	Default status (initial status of the product)
temperature_mode	string	Temperature mode (product storage temperature)
base_packaging	string	It is mandatory to fill the main packaging (main packaging of the product).
billing_packaging	string	Billing package (the package used in the billing process)
report_packaging	string	Report wrapper (wrapper used for reports)
unit	integer	The unit of measurement (for example, kg, unit, liter)

Update the status of products to be received

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	You need to send the IDs of successfully saved product with an OK status.

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	Delivery number is required
date	string	Delivery date is mandatory
counterparty	string	It is necessary to fill in the counterparty (cargo delivery organization).
arrival_date	string	The date the shipment was received
comment	string	Comment (additional comment or comment)
vehicle_model	string	Model of the vehicle
vehicle_number	integer	Registration number of the vehicle
driver_name	string	Full name of the driver
driver_document	string	Document related to the driver (passport, license, etc.)
contract_number	integer	Contract number
contract_date	string	Contract Date
nomenclature	string	Nomenclature (type of cargo or list of products)
quantity	integer	The amount of the product
price	integer	It is necessary to fill in the price of one piece or unit of the product
total_amount	integer	The total amount (price * amount)
kis_number	integer	Order number in the KIS system
kis_date	string	The date the order was entered in the KIS system
accept_by_places	boolean	Accept by cargo area (true/false)
vehicle_type	string	Type of vehicle (eg truck, bus)
vat_rate	integer	VAT rate (in percent)
vat_amount	integer	VAT amount
price_includes_vat	boolean	Does the price include VAT (true/false)
discount_amount	integer	Discount amount
under_delivery_percent	integer	Percentage of products not delivered
over_delivery_percent	integer	Percentage of over-delivered product
nomenclature_package	string	Type of nomenclature packaging
package_quantity	integer	Number of packages

Update the status of goods to be received

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	You need to send the IDs of successfully saved receiving_goods with an OK status.

Errors

Error Code	Meaning
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.

Introduction

Api Url http://wms.bts.uz:8040

Version 1.0 End point http://wms.bts.uz:8040

Fulfillment WMS

Http request

Supplier buyer

Http request

Update the status of goods to be received

Http request

product

Http request

Update the status of products to be received

Http request

Supplier

Http request

Update the status of goods to be received

Http request

Errors

Api Url `http://wms.bts.uz:8040`

Version 1.0 End point `http://wms.bts.uz:8040`