Introduction

Api Url http://api.bts.uz:8080/index.php

Version 1.0 End point http://api.bts.uz:8080/index.php

Заявки

Создать заявка

curl
--request POST \
--url "http://api.bts.uz:8080/index.php?r=v1/order/add" \
--header "Authorization: Bearer <token>"
--header 'content-type: application/json'
--data{
         "senderDelivery":1,
         "senderCityId":3,
         "senderAddress":"г.Ташкент,ул.Бобур,5-А",
         "senderReal":"Jurabek Turdiyev",
         "senderPhone":"+998 99 1234567", 
         "weight":2,
         "packageId":4,
         "postTypeId":16,
         "postTypes":[
              {
                  "name": "Kitob",
                  "code": "ZFD21AD",
                  "count": 1
              },
              {
                  "name": "Daftar",
                  "code": "AV2321",
                  "count": 2
              }
         ],
         "receiverDelivery":1,
         "receiver":"Odil Ahkmedov",
         "receiverCityId":3, 
         "receiverAddress":"G'ozovo qish. 41 uy", 
         "volume":0, 
         "urgent":0, 
         "takePhoto":1, 
         "senderSign":null, 
         "receiverSign":null,
         "piece":1, 
         "senderDate":"2018-02-06", 
         "receiverDate":"2018-02-07", 
         "receiverPhone":"+998 99 1234567",
         "receiverPhone1":null,
        }  

SUCCESS

{
    "orderId": 229234,
    "customer": {
        "id": 79,
        "name": "ООО \"JOHD\" "
    },
    "status": {
        "id": 1,
        "info": "В клиенте"
    },
    "senderRegion": {
        "id": 2,
        "name": "Андижанская область"
    },
    "senderCity": {
        "id": 3,
        "name": "Асака туман ",
        "regionId": 2
    },
    "senderAddress": "г.Ташкент,ул.Бабаева,7-А",
    "senderReal": "Jurabek Turdiyev",
    "senderPhone": "+998 99 1234567",
    "receiver": "Odil Ahkmedov",
    "receiverAddress": "G'ozovo qish. 41 uy",
    "receiverRegion": null,
    "receiverCity": {
        "id": 3,
        "name": "Асака туман "
    },
    "receiverPhone": "+998 99 1234568",
    "receiverPhone1": null,
    "senderDelivery": 1,
    "receiverDelivery": 1,
    "package": {
        "id": 8,
        "name": "BTS ПАКЕТИ"
    },
    "postType": {
        "id": 4,
        "name": "ДОКУМЕНТЫ"
    },
    "cost": "12000.00",
    "weight": "2.000",
    "piece": 1,
    "volume": 0,
    "urgent": 0,
    "takePhoto": 0,
    "senderSign": null,
    "receiverSign": null,
    "senderDate": "2018-02-06",
    "receiverDate": "2018-02-07",
    "barcode": "60000006106"
    
}

Failure Validation error

{
"errors": {
    "senderPhone": [
        "Необходимо заполнить «Телефон»."
    ],
    "weight": [
        "Необходимо заполнить «Кг»."
    ]
}
}

HTTP Request

POST /order/add

Query Parameters

Parameter	Type	Description
senderCityId*	integer	Город отправителя. Список городов
senderAddress*	string	Адрес отправителя
senderReal*	string	Ф.И.О отправителя
senderPhone*	string	Телефон номер отправителя
weight*	double	вес отправки
packageId*	integer	вид упаковки. Виды упаковки
postTypeId*	integer	тип отправки Типы отправки
receiver*	string	Ф.И.О получателья
receiverAddress*	string	Адрес получателья
receiverCityId*	integer	Город получателья. Список городов
volume	number	объем (объем = длина*высота*ширина) отправки
urgent	integer	1 - срочно, 0 - не срочно, поумолчание 0. Принимаемые значения
takePhoto	integer	1 - требуется фото получателя, 0 - необизаятелно. поумолчание 0. Принимаемые значения
is_test	integer	1 - для тестирования, 0 - необизаятелно. поумолчание 0. Принимаемые значения
senderSign	string	подпись Отправителя
receiverSign	string	подпись получателя
piece	integer	место отправки, поумолчание 1
senderDate	date	Дата отправки, поумолчанию дата завяки
receiverDate	date	Дата получения, поумолчанию дата завяки
receiverPhone*	string	Телефон получателя
receiverPhone1	string	Дополнительные телефон номер получателя
senderDelivery	integer	1-Вызов курьера, 0-самовывоз в офис БТС.
receiverDelivery	integer	1-Если курьер доставить, 0- если получател сам забирает с офиса БТС.
bringBackMoney	integer	1-надо вернут денги за товарь, 0 - нет наложенные платеж.
back_money	integer	надо указать сумму при bringBackMoney равно 1.
bringBackWaybill	integer	1-надо возврат документ
additionalInfo	string	Комментария (Один экземпляр документа возвращается)

Информация об заявки

Http request

GET /order/detail&id=<orderId>

Parameter	Type	Description
orderId	integer	Номер заказа

curl
--request GET \
--url "http://api.bts.uz:8080/index.php?r=v1/order/detail&id=<orderId>" \
--header "Authorization: Bearer <token>"

JSON формат:

{
    "orderId": "<orderId>",
    "customer": {
        "id": 79,
        "name": "ООО \"JOHD\" "
    },
    "status": {
        "id": 1,
        "info": "В клиенте"
    },
    "senderRegion": {
        "id": 2,
        "name": "Андижанская область"
    },
    "senderCity": {
        "id": 3,
        "name": "Асака туман ",
        "regionId": 2
    },
    "senderAddress": "г.Ташкент,ул.Бабаева,7-А",
    "senderPhone": "+998 99 1234567",
    "receiver": "Odil Ahkmedov",
    "receiverRegion": null,
    "receiverCity": {
        "id": 3,
        "name": "Асака туман "
    },
    "receiverPhone": "+998 99 1234568",
    "receiverPhone1": null,
    "senderDelivery": 1,
    "receiverDelivery": 1,
    "package": {
        "id": 8,
        "name": "BTS ПАКЕТИ"
    },
    "postType": {
        "id": 4,
        "name": "ДОКУМЕНТЫ"
    },
    "cost": "12000.00",
    "weight": "2.000",
    "piece": 1,
    "volume": "0",
    "urgent": 0,
    "takePhoto": 0,
    "senderSign": null,
    "receiverSign": null,
    "senderDate": "2018-02-06",
    "receiverDate": "2018-02-07",
    "barcode": "60000006106"

    
}

Удалить заявки

Http request

GET /order/cancel&id=<orderId>

Parameter	Type	Description
orderId	integer	Номер заказа

curl
--request GET \
--url "http://api.bts.uz:8080/index.php?r=v1/order/cancel&id=<orderId>" \
--header "Authorization: Bearer <token>"

JSON формат:

{
    "orderId": "229234",
    "status": {
        "id": 0,
        "name": "Cancelled Order"
    },
}

Калькулятор заявки

Цена заявки.

Http Request

POST /order/calculate

curl
--request POST \
--url "http://api.bts.uz:8080/index.php?r=v1/order/calculate" \
--header "Authorization: Bearer <token>"\
--data 
{
    "senderCityId": 3,
    "receiverCityId": 3,
    "weight": 1,
    "volume": null,
    "senderDate": "2018-02-06",
    "senderDelivery": 1,
    "receiverDelivery": 1
}

SUCCESS

{
    "summaryPrice": 10000,
    "requestData": {
        "weight": 1,
        "volume": null,
        "senderCityId": 3,
        "receiverCityId": 3,
        "senderDate": "2018-02-06",
        "senderDelivery": 1,
        "receiverDelivery": 1
    }
}

FAILURE

{
    "errors": {
        "senderCityId": [
            "Необходимо заполнить «Город от-я»."
        ]
    }
}

Parameter	Type	Description
senderCityId*	integer	Город отправителя. Список городов
weight*	double	вес отправки
receiverCityId*	integer	Город получателья. Список городов
volume	number	объем (объем = длина*высота*ширина) отправки
senderDate	date	Дата отправки, поумолчанию дата завяки
senderDelivery	integer	2-Вызов курьера(с дальнего посёлка), 1-Вызов курьера(город), 0-самовывоз в офис БТС.
receiverDelivery	integer	2-Если курьер доставить(с дальнего посёлка), 1-Если курьер доставить(город), 0- если получател сам забирает с офиса БТС.

Трак

Http request

GET /order/track&id=<orderId>

curl
--request GET \
--url "http://api.bts.uz:8080/index.php?r=v1/order/track&id=<orderId>" \
--header "Authorization: Bearer <token>"

Parameter	Type	Description
orderId	integer	ID заявки

SUCCESS

{
    "orderId": 229234,
    "status": {
        "id": 1,
        "name": "new"
    }
}

Справочник

Список городов

1	14	город Шахрисабз
2	3	Папский район
3	2	Асакинский район
4	5	Ташкентский район
5	5	город Янгийуль
6	5	город Ахангаран
7	5	город Нурафшон
8	11	город Нукус
9	11	Тахиаташский район
10	4	город Хива
11	11	Амударьинский район
12	11	Берунийский район
13	11	Кандикульский район
14	11	Караузякский район
15	11	Кегейлийский район
16	11	Кунградский район
17	11	Муйнакский район
18	11	Нукусский район
19	11	Тахтакупырский район
20	11	Турткульский район
21	11	Ходжейлийский район
22	11	Чимбайский район
23	11	Шуманайский район
24	11	Элликкалинский район
25	2	город Андижан
26	2	город Ханабад
27	2	Андижанский район
28	2	Балыкчинский район
29	2	Булакбашинский район
30	2	Бозский район
31	2	Джалалкудукский район
32	2	Избасканский район
33	2	Улугнорский район
34	2	Мархаматский район
35	2	Пахтаабадский район
36	2	Ходжаабадский район
37	2	Алтынкульский район
38	2	Кургантепинский район
39	2	Шахриханский район
40	7	город Бухара
41	7	город Каган
42	7	Бухарский район
43	7	Бабкентский район
44	7	Джандарский район
45	7	Каганский район
46	7	Алатский район
47	7	Пешкунский район
48	7	Ромитанский район
49	7	Шафирканский район
50	7	Каракульский район
51	7	Караулбазарский район
52	7	Гиждуванский район
53	9	Арнасайский район
54	9	Бахмальский район
55	9	Галляаральский район
56	9	Дустликский район
57	9	город Джизак
58	9	Жиззах
59	9	Зарбдорский район
60	9	Зафарабадский район
61	9	Заминский район
62	9	Мирзачульский район
63	9	Пахтакорский район
64	9	Фаришский район
65	9	Янгиабадский район
66	14	город Карши
67	14	Каршинский район
68	14	Мубарекский район
69	14	Гузарский район
70	14	Камашинский район
71	14	Чиракчинский район
72	14	Шахризабский район
73	14	Касбинский район
74	14	Касанский район
75	14	Китабский район
76	14	Нишанский район
77	14	Миришкорский район
78	14	Дехканабадский район
79	14	Яккабагский район
80	10	город Навойи
81	10	город Заравшан
82	10	Карманинский район
83	10	Тамдынский район
84	10	Навбахорский район
85	10	Нуратинский район
86	10	Хатырчинский район
87	10	Кызылтепинский район
88	10	Кенимехский район
89	10	город Учкудук
90	3	город Наманган
91	3	Мингбулакский район
92	3	Касансайский район
93	3	Наманганский район
94	3	Нарынский район
95	3	Туракурганский район
96	3	Уйчинский район
97	3	Учкурганский район
98	3	Чартакский район
99	3	Чустский район
100	3	Янгикурганский район
101	8	город Самарканд
102	8	Ургутсский район
103	8	Пахтаачинский район
104	8	Каттакурганский район
105	8	Самаркандский район
106	8	Булунгурский район
107	8	Джамбайский район
108	8	Кошрабадский район
109	8	Нарпайский район
110	8	Тайлякский район
111	8	Пастдаргомский район
112	8	Нуробадский район
113	8	город Каттакурган
114	8	Пайарыкский район
115	8	Акдарьинский район
116	8	Иштыханский район
117	13	город Термез
118	13	Термезский район
119	13	Музрабадский район
120	13	Алтынсайский район
121	13	Денаусский район
122	13	Сарыассийский район
123	13	Кизирикский район
124	13	Джаркурганский район
125	13	Ангорский район
126	13	Кумкурганский район
127	13	Байсунский район
128	13	Шурчинский район
129	13	Шерабадский район
130	13	Узунский район
131	12	город Гулистан
132	12	город Янгиер
133	12	город Ширин
134	12	Окалтынский район
135	12	Баяутский район
136	12	Гулистанский район
137	12	Мирзаабадский район
138	12	Сайхунабадский район
139	12	Сардобинский район
140	12	Сырдарьинский район
141	12	Хавастский район
142	5	город Ангрен
143	5	город Бекабад
144	5	город Алмалык
145	5	город Чирчик
146	5	Бекабадский район
147	5	Бостанлыкский район
148	5	Кибрайский район
149	5	Зангиатинский район
150	5	Куйи-чирчикский район
151	5	Аккурганский район
152	5	Паркентский район
154	5	Урта-чирчикский район
155	5	Чиназский район
156	5	Юкори чирчикский район
157	5	Букинский район
158	5	Янгийульский район
159	5	Ахангаранский район
160	15	город Фергана
161	15	город Маргилан
162	15	город Кувасай
163	15	город Коканд
164	15	Багдадский район
165	15	Бувайдинский район
166	15	Дангаринский район
167	15	Язьяванский район
168	15	Алтыарыкский район
169	15	Бешарыкский район
170	15	Куштепинский район
171	15	Риштанский район
172	15	Сохский район
173	15	Ташлакский район
174	15	Учкуприкский район
175	15	Ферганский район
176	15	Узбекистанский район
177	15	Кувинский район
178	15	Фуркатский район
179	4	город Ургенч
180	4	Багатский район
181	4	Ургенчский район
182	4	Кушкупырский район
183	4	Ханкинский район
184	4	Янгиарыкский район
185	4	Хивинский район
186	4	Янгибазарский район
187	4	Хазараспский район
188	4	Шаватский район
189	4	Гурленский район
190	6	Бектемирский район
191	6	Мирабадский район
192	6	М.Улугбекский район
193	6	Сергелийсикй район
194	6	Алмазарский район
195	6	Учтепинский район
196	6	Яшнабадский район
197	6	Чилонзарский район
198	6	Шайхантахурский район
199	6	Юнусабадский район
200	6	Яккасарайский район
201	5	Пскентский район

Регионы

id	name
4	Хорезмская область
15	Ферганская область
5	Ташкентская область
6	Ташкент
12	Сырдарьинская область
13	Сурхандарьинская область
8	Самаркандская область
3	Наманганская область
10	Навоийская область
14	Кашкадарьинская область
11	Каракалпакстан
9	Джизакская область
7	Бухарская область
2	Андижанская область

Типы отправки

	id	name
	4	ДОКУМЕНТЫ
	5	ЗАПЧАСТИ
	6	МЕДИКАМЕНТЫ
	7	ОРГТЕХНИКА
	8	КНИГИ
	9	СТЕКЛОИЗДЕЛИЯ
	10	РЕКЛАМНЫЕ ИЗДЕЛИЯ
	11	ОДЕЖДА-ОБУВИ
	12	СОТ.ТЕЛЕФОН
	13	ПАСПОРТ
	14	ПАРФЮМЕРИЯ
	15	ПРОДУКТЫ
	16	ХИМИКАТЫ
	17	ПРОТЕЗЫ ( ТИШ )
	18	СЕМЕНА / УРУГЛАР
	19	ПЛАСТИК КАРТА
	20	ПЕЧАТЬ
	21	САНТЕХНИКА
	22	МЕБЕЛЬ
	23	МЕД.ИНСТРУМЕНТ
	24	ТКАНЬ - МАТЕРИАЛ
	25	ОБОРУДОВАНИЕ
	26	КАНЦТОВАРЫ
	27	ХОЗТОВАРЫ
	28	ИГРУШКИ
	29	БИЖУТЕРИЯ
	30	КОСМЕТИКА
	31	БЫТОВАЯ ТЕХНИКА
	32	СУХОФРУКТЫ
	33	СТРОЙМАТЕРИАЛЫ

Виды упаковки

	id	name
	4	СУМКА
	5	КОНТЕЙНЕР
	6	КОНВЕРТ
	7	КОРОБКА
	8	BTS ПАКЕТИ
	9	БЕЗ УПАКОВКИ
	10	ЗAВОДСКAЯ УПAКОВКA

Да или Нет

значения	описания
1	Yoqilgan
0	Ochirilgan

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

id	info
0	Отказ
1	У отправителя
2	Курьер принял
3	В офисе отправления
4	В офисе доставки
5	Курьер доставляет
6	Доставлен
7	Возврат
8	В промежуточном офисе
31	На складе
32	В мешке
33	В перевозке
34	В РЦ Курьера

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.