Introduction
OX System представляет собой сервер, клиенты которого передают на сервер запросы в формате JSON по протоколу HTTPS, используя методы GET и POST. Базовым URL сервера является https://{subdomain}.ox-sys.com. Сервер отвечает также в формате JSON, используя коды состояния HTTP как коды ответа сервера.
Authentication
HTTP Request
POST https://{subdomain}.ox-sys.com
Для авторизации используйте этот код:
curl -X POST \
https://{subdomain}.ox-sys.com/security/auth_check \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d '_username={youusername}&_password={yourpswd}&_subdomain={yourcompany}'Query Parameters
| Параметр | Описание |
|---|---|
| _username * | Имя пользователя |
| _password * | Пароль пользователя |
| _subdomain * | Сабдомен компании |
Result
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE1NjE2MjI0NTIsImV4cCI6MTU5MzE1ODQ1Miwicm9sZXMiOltdLCJpZCI6MTE3MTUyfQ.nBcKjBwW-vzKBtnzbnvviB_4uOwNZNeOr63N1UVLP_WKwjP_LBlN7EFbbOS9yX_WL1RLI-T7n3f63R_Z_nqY7844Ras9ZSaRFhafsEnOCmwkIw3SPX_dwU_G2ud5Izc9wjmild9tgE6gwa527afwoPvJSz_stLGus0AW21HEbFWTFX_Uz_6Sea4zSh5AcISAdZ2shcQ5LPNEzmvVmqJPrlvJF2rtOvSWI7Kx12Hnp0deyuOXAvrmFXQ7-ccAlj4KV7brlKcDxQI7xBetnnKGyegHTKjLax6_v8nJENtmbhyUqZ2Z11B4Kdi3x7v8yVzZYPFAUuHJPeLoGe8-SkMX0K7uJtbvZBUjSQVRpJafyiLVYWT2oc5VZA-vkMXo-XVRH_CkxuQAK3FtckHosKBgy-cIQPfaraTFAsh_GYPbtssafqC_-H2ANF0z2NcDWw22sQVLx5Vtia6OcXi6t5kNre2IxeONHEsPMfhqeNVeJpy7PRoSyppm46N6a-HRqJSFcp44uMVCA9Sk8jQu9IhkTTxf8wZNNgYqKILubms3fqzEcfym2bpc1zI3MnZd0LozalYzHRGmtiEMOnGDrIswaoHBmJmxjQ1V98McC8A699IGaPY1u9FaQNvQvAKg3D2JWP56WSOz10GK-g9LW8px5Mht9AlcdBDUWF8s70oevkM",
"lifetime": 1036800
}lifetime in seconds
User
Пользователь - сотрудник компании, которому доступны функции системы исходя из привязанных роли.
Profile
Просмотр профиль пользователя (который залогинился в систему).
Http request
GET https://{subdomin}.ox-sys.com
curl -X GET \
https://{subdomin}.ox-sys.com/profile \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Атрибут | Информация |
|---|---|
| User | User |
View
Просмотр данных пользователей.
Http request
GET https://{subdomin}.ox-sys.com/users/{user}
curl -X GET \
https://{subdomin}.ox-sys.com/users/{user} \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Attribute | Info |
|---|---|
| User | User |
List
Получение списка пользователей.
Http request
GET https://{subdomin}.ox-sys.com/users
curl -X GET \
https://{subdomin}.ox-sys.com/users \
-H "Authorization: Bearer {your_authorization_token_here}"Query request
| Параметр | Описание |
|---|---|
| Email пользователя | |
| profile[fullName] | Полное имя |
| profile[phoneNumber] | Номер телефона |
| profile[gender] | Пол |
| customerBrand | ID бренда Brand |
| group | ID групп Group |
| type | Тип клиент customer или сотрудник employee |
Response
| Атрибут | Информация |
|---|---|
| items |
|
Create
Создание пользователя
Http request
POST https://{subdomin}.ox-sys.com/users
curl -X POST \
https://{subdomin}.ox-sys.com/users \
-H "Authorization: Bearer {your_authorization_token_here}" \
-d '{
"email":"info@ox-sys.com",
"username":"manager",
"password":"somepassword",
"customerBrands":[4],
"roles":[12],
"groups":[5],
"profile":{
"firstName":"Alex",
"lastName":"Watson",
"middleName":"Fred",
"birthDate":"1990-06-15",
"notes":"",
"gender":"male",
"phoneNumbers":["+998908985898"],
"uploadedAvatar":""
},
"kids":[
{
"name": "Sasha",
"birthDate":"2018-01-16",
"notes":"",
"gender":"male"
}
],
"cards":[
{
"code":"10001",
"active":true
}
],
"properties":[],
"active":true,
"addresses":[
{
"countryCode":"UZ",
"administrativeArea":"Tashkent city",
"locality":"Chilonzor",
"dependentLocality":"",
"postalCode":"100001",
"addressLine1":"CHilonzor Tashkent city",
"organization":"OX"
}
]
}'Query params
| Параметр | Информация |
|---|---|
| email * | Email пользователя |
| username * | Имя пользователя |
| password * | Пароль пользователя |
| customerBrands | ID брендов array Brand Ids |
| roles | ID ролей array Role Ids |
| groups | ID груп array Group Ids |
| profile[firstName] * | Имя |
| profile[lastName] * | Фамилия |
| profile[middleName] | Отчество |
| profile[birthDate] | Дата рождения |
| profile[notes] | Заметка |
| profile[gender] * | Пол |
| profile[phoneNumbers] | Номер телефона array string |
| uploadedAvatar | Файл |
| kids[name] | Имя ребенка |
| kids[birthDate] | Дата рождение ребенка |
| kids[notes] | Заметка ребенку |
| cards[code] | Код карты string |
| cards[active] | Статус карты boolean |
| properties | Свойства пользователя array |
Response
Update
Обновление данных пользователя.
Http request
PUT, PATCH https://{subdomin}.ox-sys.com/users/{user}
curl -X PUT \
https://{subdomin}.ox-sys.com/users/{user} \
-H "Authorization: Bearer {your_authorization_token_here}" \
-d '{
"email":"info@ox-sys.com",
"username":"manager",
"password":"somepassword",
"customerBrands":[4],
"roles":[12],
"groups":[5],
"profile":{
"firstName":"Alex",
"lastName":"Watson",
"middleName":"Fred",
"birthDate":"1990-06-15",
"notes":"",
"gender":"male",
"phoneNumbers":["+998908985898"],
"uploadedAvatar":""
},
"kids":[
{
"name": "Sasha",
"birthDate":"2018-01-16",
"notes":"",
"gender":"male"
}
],
"cards":[
{
"code":"10001",
"active":true
}
],
"properties":[],
"active":true,
"addresses":[
{
"countryCode":"UZ",
"administrativeArea":"Tashkent city",
"locality":"Chilonzor",
"dependentLocality":"",
"postalCode":"100001",
"addressLine1":"CHilonzor Tashkent city",
"organization":"OX"
}
]
}'Query params
| Параметр | Информация |
|---|---|
| email * | Email пользователя |
| username * | Имя пользователя |
| password * | Пароль пользователя |
| customerBrands | ID брендов array Brand Ids |
| roles | ID ролей array Role Ids |
| groups | ID груп array Group Ids |
| profile[firstName] * | Имя |
| profile[lastName] * | Фамилия |
| profile[middleName] | Отчество |
| profile[birthDate] | Дата рождения |
| profile[notes] | Заметка |
| profile[gender] * | Пол |
| profile[phoneNumbers] | Номер телефона array string |
| uploadedAvatar | Файл |
| kids[name] | Имя ребенка |
| kids[birthDate] | Дата рождение ребенка |
| kids[notes] | Заметка ребенку |
| cards[code] | Код карты string |
| cards[active] | Статус карты boolean |
| properties | Свойства пользователя array |
Response
Customer
Клиент - пользователи с типом "customer".
View
Просмотр карточки клиента
Http request
GET https://{subdomin}.ox-sys.com/customers/{customer}
curl -X GET \
https://{subdomin}.ox-sys.com/customers/{customer} \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Артибут | Информация |
|---|---|
| customer | User |
List
Список клиентов
Http request
GET https://{subdomin}.ox-sys.com/customers
curl -X GET \
https://{subdomin}.ox-sys.com/customers \
-H "Authorization: Bearer {your_authorization_token_here}"Query request
| Параметр | Описание |
|---|---|
| Email клиента | |
| profile[fullName] | Полное имя |
| profile[phoneNumber] | Номер телефона |
| profile[gender] | Пол |
| customerBrand | ID брендов Brand |
| group | ID групп Group |
| type | customer или employee |
Response
| Атрибут | Информация |
|---|---|
| items | User array |
Create
Http request
POST https://{subdomin}.ox-sys.com/customers
curl -X POST \
https://{subdomin}.ox-sys.com/customers \
-H "Authorization: Bearer {your_authorization_token_here}" \
-d '{
"email":"alisa@yandex.ru",
"customerBrands":[4],
"groups":[5],
"profile":{
"firstName":"Алиса",
"lastName":"Николаева",
"middleName":"",
"birthDate":"1987-02-15",
"notes":"",
"gender":"female",
"phoneNumbers":["+998998010001"],
"uploadedAvatar":""
},
"kids":[
{
"name": "Alex",
"birthDate":"2018-01-16",
"notes":"",
"gender":"male"
}
],
"cards":[
{
"code":"10001",
"active":true
}
],
"active":true,
"addresses":[
{
"countryCode":"UZ",
"administrativeArea":"Tashkent city",
"locality":"Mirabad",
"dependentLocality":"",
"postalCode":"100001",
"addressLine1":"ул. Айбек, 40/2 дом",
"organization":""
}
],
"isSubscribed": true
}'Query params
| Параметр | Информация |
|---|---|
| email * | |
| customerBrands | ID брендов Brand Ids array |
| groups | ID групп Group Ids array |
| profile[firstName] * | Имя |
| profile[lastName] * | Фамилия |
| profile[middleName] | Отчество |
| profile[birthDate] | Дата рождения |
| profile[notes] | Заметка |
| profile[gender] * | Пол |
| profile[phoneNumbers] | Номер телефона array string |
| uploadedAvatar | Файл |
| kids[name] | Имя ребенка |
| kids[birthDate] | Дата рождение ребенка |
| kids[notes] | Заметка ребенку |
| cards[code] | Код карты string |
| cards[active] | Статус карты boolean |
| isSubscribed | Подиска на SMS рассылку boolean |
Response
Update
Http request
PUT, PATCH https://{subdomin}.ox-sys.com/customers/{customer}
curl -X PUT \
https://{subdomin}.ox-sys.com/customers/{customer} \
-H "Authorization: Bearer {your_authorization_token_here}" \
-d '{
"email":"alisa@yandex.ru",
"customerBrands":[4],
"groups":[5],
"profile":{
"firstName":"Алиса",
"lastName":"Николаева",
"middleName":"",
"birthDate":"1987-02-15",
"notes":"",
"gender":"female",
"phoneNumbers":["+998998010001"],
"uploadedAvatar":""
},
"kids":[
{
"name": "Alex",
"birthDate":"2018-01-16",
"notes":"",
"gender":"male"
}
],
"cards":[
{
"code":"10001",
"active":true
}
],
"active":true,
"addresses":[
{
"countryCode":"UZ",
"administrativeArea":"Tashkent city",
"locality":"Chilonzor",
"dependentLocality":"",
"postalCode":"100001",
"addressLine1":"CHilonzor Tashkent city",
"organization":""
}
],
"isSubscribed": true
}'Query params
| Параметр | Информация |
|---|---|
| email * | |
| customerBrands | ID брендов array Brand Ids |
| groups | ID групп array Group Ids |
| profile[firstName] * | Имя |
| profile[lastName] * | Фамилия |
| profile[middleName] | Отчество |
| profile[birthDate] | Дата рождения |
| profile[notes] | Заметка |
| profile[gender] * | Пол |
| profile[phoneNumbers] | Номер телефона array string |
| uploadedAvatar | Файл |
| kids[name] | Имя ребенка |
| kids[birthDate] | Дата рождение ребенка |
| kids[notes] | Заметка ребенку |
| cards[code] | Код карты string |
| cards[active] | Статус карты boolean |
| isSubscribed | Подиска на SMS рассылку boolean |
Response
Zone
Зона - страна деятельности компании.
View
Просмотр зоны
Http request
GET https://{subdomin}.ox-sys.com/zones/{zone}
curl -X GET \
https://{subdomin}.ox-sys.com/zones/{zone} \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Атрибут | Информация |
|---|---|
| zone | Zone |
List
Список зон
Http request
GET https://{subdomin}.ox-sys.com/zones
curl -X GET \
https://{subdomin}.ox-sys.com/zones \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Атрибут | Информация |
|---|---|
| items | zone array |
Brand
Бренды компании - содержат в себе информацию о бренед и иерархию продуктов бренда.
View
Просмотр бренда
Http request
GET https://{subdomin}.ox-sys.com/brands/{brand}
curl -X GET \
https://{subdomin}.ox-sys.com/brands/{brand} \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Атрибут | Информация |
|---|---|
| brand | Brand |
List
Список брендов
Http request
GET https://{subdomin}.ox-sys.com/brands
curl -X GET \
https://{subdomin}.ox-sys.com/brands \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Атрибут | Информация |
|---|---|
| brand | array Brand |
Location
Локация - месторасположения торговых магазинов и складов.
View
Просмотр локации
Http request
GET https://{subdomin}.ox-sys.com/locations/{location}
curl -X GET \
https://{subdomin}.ox-sys.com/locations/{location} \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Атрибут | Информация |
|---|---|
| location | Location |
List
Список локации
Http request
GET https://{subdomin}.ox-sys.com/locations
curl -X GET \
https://{subdomin}.ox-sys.com/locations \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Атрибут | Информация |
|---|---|
| items | array location |
Create location
Http request
POST https://{subdomin}.ox-sys.com/locations
Params
| Name | Type | Information |
|---|---|---|
| name | string | Name of location |
| brand | int | ID brand |
| type | string | warehouse or shop |
| square | int | square of place |
| address[countryCode] | string | Country code |
| address[administrativeArea] | string | Region |
| address[locality] | string | District |
| address[addressLine1] | string | address |
Update location
Http request
PUT https://{subdomin}.ox-sys.com/locations/{locationID}
Params
| Name | Type | Information |
|---|---|---|
| name | string | Name of location |
| brand | int | ID brand |
| type | string | warehouse or shop |
| square | int | square of place |
| address[countryCode] | string | Country code |
| address[administrativeArea] | string | Region |
| address[locality] | string | District |
| address[addressLine1] | string | address |
Variation of stock
Список остатков и информации о продуктов
List
Список остатка продуктов GET https://{subdomin}.ox-sys.com/variations
Query request
| Параметр | Описание |
|---|---|
| q | query name |
| name | Названия вариации продукта |
| names | Несколько названии вариации продукта array |
| barcode | Штрих-код (barcode) |
| barcodes | Несколько штрих-кодов array |
| sku | Артикул (SKU) продукта |
| skus | Несколько артикулов (SKU) array |
| product[id] | ID продукта |
| product[name] | Название продукта |
| product[names] | Несколько названии продуктов array |
| product[sku] | Артикул (SKU) |
| product[skus] | Несколько артикулов (SKU) array |
| product[brand] | ID бренда |
| product[zone] | ID зоны |
| product[supplier] | ID поставщика |
| product[category] | ID категории |
| product[category] | ID of category |
| product[tags] | ID тега |
| hasImage | Имеетли изображение boolean |
| properties | Свойства Property array |
| product_properties | Свойства продукта (характеристика) Property array |
| stock[location] | Location Ids |
| stock[exist] | boolean |
| import | ID прихода |
| stock[properties] | Propertyarray |
| stock[count][min] | мин количество в остатке int |
| stock[count][max] | макс количество в остатке int |
| stock[sellPrice][min] | мин цена продажи за ед. int |
| stock[sellPrice][max] | макс цена продажи за ед. int |
| stock[supplyPrice][min] | мин цена поставщика за ед. int |
| stock[supplyPrice][max] | макс цена поставщика за ед. int |
Response
| Параметр | Описание |
|---|---|
| items | Variations array |
| page | int |
Variations discount
Variation's discount
Query request
Список остатка продуктов GET https://{subdomin}.ox-sys.com/variation-discounts?ids[]=2483807
| Параметр | Описание |
|---|---|
| ids | int [] ID - variation |
| barcodes | string [] barcode - variation |
Response
Response
{
"2483807": {
"barcode": "52090123811",
"variation": 2483807,
"oldPrice": 149900,
"discount": 29980,
"discountPercent": 20,
"newPrice": 119920,
"locations": [
"19",
"251"
],
"count": "4.00"
}
}Create variation
Создание вариация
Http request
curl -X POST \
https://{subdomin}.ox-sys.com/product/{product}/variations \
-H "Authorization: Bearer {your_authorization_token_here}" \
-d '{
"barcode": "1231231",
"name": "test",
"number":"12121",
"properties": [
{
"name": "Size",
"value": "XL"
},
{
"name": "Color",
"value": "black"
}
],
"analogs": [
2
],
"modifiers": [
2
],
"unit":"pcs",
"countable": true,
"vatPercent":5,
"taxable":true
}'Query param
| Атрибут | Информация |
|---|---|
| product | ID продукт |
Post param
| Атрибут | Информация |
|---|---|
| barcode | string unique |
| name | string |
| properties | array of properties |
| analogs | array of variation ID |
| modifiers | array of variation ID |
| unit | string |
| countable | bool |
| taxable | bool |
| vatPercent | float(если taxable = true обязательный) |
Response
{
"sku": "123123123",
"supplier": "Поставщик 1",
"supplierId": 1,
"category": null,
"id": 2351,
"barcode": "1231231",
"stocks": [],
"ingredients": [],
"name": "test",
"shippable": false,
"taxable": true,
"vatPercent": 5,
"cookable": false,
"sellable": false,
"countable": true,
"composite": false,
"scalable": false,
"product": 1,
"images": [],
"unit": "pcs",
"brand": 1,
"zone": 1,
"videos": null,
"properties": [
{
"id": "348798811a05cecc0caef8c3426fb0d2",
"name": "Size",
"value": "XL"
},
{
"id": "135a8d5cde024e755b6d771f77730f66",
"name": "Color",
"value": "black"
}
],
"productProperties": [],
"area": null,
"importRecord": null,
"lastUpdateTime": "2021-10-27 12:25:20",
"showMarket": false,
"uploadedImages": [],
"innerHitIds": null,
"technicalCard": false,
"analogs": [
2
],
"modifiers": [
2
]
}Update variation
Обновить вариация
Http request
curl -X PUT \
https://{subdomin}.ox-sys.com/variations/{variation} \
-H "Authorization: Bearer {your_authorization_token_here}" \
-d '{
"barcode": "1231231",
"name": "test",
"properties": [
{
"name": "Size",
"value": "XL"
},
{
"name": "Color",
"value": "black"
}
],
"analogs": [
2
],
"modifiers": [
2,2346
],
"unit":"pcs",
"countable": true,
"taxable":false
}'Query param
| Атрибут | Информация |
|---|---|
| variation | ID вариация |
PUT param
| Атрибут | Информация |
|---|---|
| barcode | string unique |
| name | string |
| properties | array of properties |
| analogs | array of variation ID |
| modifiers | array of variation ID |
| unit | string |
| countable | bool |
| taxable | bool |
| vatPercent | float(если taxable = true обязательный) |
Response
{
"sku": "123123123",
"supplier": "Поставщик 1",
"supplierId": 1,
"category": null,
"id": 2351,
"barcode": "1231231",
"stocks": [],
"ingredients": [],
"name": "jasur",
"shippable": false,
"taxable": false,
"vatPercent": null,
"cookable": false,
"sellable": false,
"countable": true,
"composite": false,
"scalable": false,
"product": 1,
"images": [],
"unit": "pcs",
"brand": 1,
"zone": 1,
"videos": null,
"properties": [
{
"id": "348798811a05cecc0caef8c3426fb0d2",
"name": "Size",
"value": "XL"
},
{
"id": "135a8d5cde024e755b6d771f77730f66",
"name": "Color",
"value": "black"
}
],
"productProperties": [],
"area": null,
"importRecord": null,
"lastUpdateTime": "2021-10-27 12:26:51",
"showMarket": false,
"uploadedImages": [],
"innerHitIds": null,
"technicalCard": false,
"analogs": [
2
],
"modifiers": [
2,
2346
]
}Directly update stock count
Http request
PUT https://{subdomain}.ox-sys.com/stocks/count-update
Attributes
| Params | Type | Description |
|---|---|---|
| variation | int | ID variation |
| location | int | ID location |
| count | float | last count of variation in above location |
Directly update stock price
Http request
PUT https://{subdomain}.ox-sys.com/stocks/price-update
Attributes
| Params | Type | Description |
|---|---|---|
| variation | int | ID variation |
| location | int | ID location |
| price | int | sell price of variation in above location |
Product
View
Карточка продукт
Http request
GET https://{subdomin}.ox-sys.com/products/{product}/detail
curl -X GET \
https://{subdomin}.ox-sys.com/products/{product}/detail \
-H "Authorization: Bearer {your_authorization_token_here}"Query params
| Param | Description |
|---|---|
| product | ID продукт |
Response
{
"product": {
"id": 2164,
"name": "ESTEE LAUDER НАБОР PLEASURES",
"description": "Набор содержит парфюмерную воду и лосьон для тела с цветочным ароматом. Композиция раскрывается душистым перцем, туберозой и сладковатой фрезией. Аккорд из горьковатой герани, пиона, лилии и ландыша звучит в сердце. В стойком шлейфе ощущаются древесные ноты, дымные пачули и терпкий мускус.",
"brand": 9,
"supplier": 15,
"category": null,
"sku": "1X5RY90000",
"variations": [
2337
],
"zone": 1,
"tags": [],
"active": true,
"marketplaceRecord": null
},
"variations": [
{
"sku": "1X5RY90000",
"supplier": "Elysee",
"id": 2337,
"barcode": "887167477476",
"stocks": [
{
"id": "a3a6952b-f760-4ace-8983-8782aaa2f384",
"location": 7,
"tracking": true,
"countable": true,
"sellPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.523809523809524e-5,
"USD\/UZS": 10500,
"UZS\/EUR": 8.333333333333333e-5,
"EUR\/UZS": 12000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 740000,
"USD": 70.48,
"EUR": 61.67
},
"properties": [
{
"name": "Контракт номер",
"value": "12\/2019"
},
{
"name": "Батч код",
"value": "BA9"
}
],
"expirationDate": null,
"supplier": 15,
"count": 1
},
{
"id": "87b04a13-f74e-444c-94a0-12ae26207cb2",
"location": 8,
"tracking": true,
"countable": true,
"sellPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.523809523809524e-5,
"USD\/UZS": 10500,
"UZS\/EUR": 8.333333333333333e-5,
"EUR\/UZS": 12000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 740000,
"USD": 70.48,
"EUR": 61.67
},
"properties": [
{
"name": "Контракт номер",
"value": "12\/2019"
},
{
"name": "Батч код",
"value": "BA9"
}
],
"expirationDate": null,
"supplier": 15,
"count": 1
}
],
"name": "НАБОР PLEASURES: Pleasures парфюмерная вода 30мл Pleasures Лосьон для тела 75мл",
"product": 2164,
"images": [
{
"id": 1815,
"sort": 0,
"urls": {
"50x_": null,
"100x_": null,
"150x_": null,
"300x_": null,
"800x_": null,
"original": null
}
}
],
"unit": "pcs",
"properties": [
{
"id": "135a8d5cde024e755b6d771f77730f66",
"name": "Цвет",
"value": null
},
{
"id": "9d1804a7de245542870e9cb17964ea8f",
"name": "Объем",
"value": null
}
],
"productProperties": [
{
"id": "15db0c311ef826335a59adadc970707b",
"name": "Бренд",
"value": "ESTEE LAUDER"
},
{
"id": "141146f6421f3d59ae5d77b1beb72efb",
"name": "Пол",
"value": "Ж"
},
{
"id": "ac192a26a6e6e1da12dd36ae0299eafa",
"name": "Подкатегория 1",
"value": "НАБОРЫ"
},
{
"id": "f80a9c333d8947d26bcbcac6b45babd3",
"name": "Подкатегория 2",
"value": ""
}
]
}
]
}Create product
Создание продукт
Http request
POST https://{subdomin}.ox-sys.com/products/{zone}/create
curl -X POST \
https://{subdomin}.ox-sys.com/products/{zone}/create \
-H "Authorization: Bearer {your_authorization_token_here}" \
-d '{
"name": "Брюки",
"description": "Jeans",
"sku": "1228",
"category": 1,
"supplier": 1,
"brand": 1,
"minOrder": 1,
"type": 0,
"tags": ["test"],
"variations": [
{
"barcode": "1227",
"unit": "pcs",
"countable": true,
"supplyPriceCurrency": "UZS",
"name": "test",
"recSupplierPrice": 500,
"recSellPrice": 1500,
"properties": [
{
"name":"Size",
"value":"12"
}
],
"productProperties": [
{
"name":"Size",
"value":"12"
}
]
}
]
}'Query params
| Param | Description |
|---|---|
| zone | ID зона |
Response
{
"shortDescription": "Jeans",
"id": 2291,
"name": "Брюки",
"description": "Jeans",
"brand": 1,
"supplier": 1,
"category": 1,
"sku": "1228",
"variations": [
2483
],
"zone": 1,
"tags": [
{
"id": "686c92cc-329b-4f9f-bddd-76781f2d8366",
"brand": 1,
"location": null,
"name": "test"
}
],
"active": true,
"marketplaceRecord": null,
"minOrder": 1,
"type": 0
}Update product
Обновить продукт
Http request
POST https://{subdomin}.ox-sys.com/products/{product}
curl -X POST \
https://{subdomin}.ox-sys.com/products/{product} \
-H "Authorization: Bearer {your_authorization_token_here}" \
-d '{
"name": "Брюки",
"description": "Jeans",
"sku": "1218",
"category": 1,
"supplier": 1,
"brand": 1,
"minOrder": 1,
"type": 0,
"tagName": ["test"]
}'Query params
| Param | Description |
|---|---|
| product | ID продукт |
Response
{
"shortDescription": "Jeans",
"id": 2277,
"name": "Брюки",
"description": "Jeans",
"brand": 1,
"supplier": 1,
"category": 1,
"sku": "1218",
"variations": [
2469
],
"zone": 1,
"innerHitIds": null,
"tags": [
{
"id": "ea24edb7-f2dc-4c66-a12a-866aa0f138cb",
"zone": 1,
"brand": 1,
"location": null,
"name": "test",
"highlights": null
}
],
"lastUpdateTime": "2021-12-09 11:44:50",
"active": true,
"images": [],
"marketplaceRecord": null,
"uploadedImages": [],
"minOrder": 1,
"type": 0
}Sell
Продажа осуществляется с помощью Кассового терминала . Для осуществление продажи необходимо авторизация с ключом кассового терминала.
View
Карточка продажи
Http request
GET https://{subdomin}.ox-sys.com/sells/{sell}
curl -X GET \
https://{subdomin}.ox-sys.com/sells/{sell} \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Атрибут | Информация |
|---|---|
| sell | Sell |
List
Список продаж
Http request
GET https://{subdomin}.ox-sys.com/sells/list
curl -X GET \
https://{subdomin}.ox-sys.com/sells/list \
-H "Authorization: Bearer {your_authorization_token_here}"Query params
| Param | Description |
|---|---|
| finishedTime[min] | date time |
| finishedTime[max] | date time |
| updatedTime[min] | date time |
| updatedTime[max] | date time |
| type | array in those sell, debit,refund,exchange |
| variation[name] | name of Variation |
| variation[sku] | sku product |
| variation[barcode] | barcode product |
| id | array sell ids |
| count[min] | sell count |
| count[max] | sell count |
| zone | array ids of Zone |
| brand | array ids of Brand |
| location | array ids of Location |
| cashdesk | array ids of Cashdesk |
| assistant | array ids of Assistant |
| customer | array ids of Customer |
Response
| Атрибут | Информация |
|---|---|
| items | array sells |
| page | int |
Create refunds
Создание Возврат/Обмен
Http request
curl -X POST \
https://{subdomin}.ox-sys.com/cashdesks/{cashdesk}/refunds \
-H "Authorization: Bearer {your_authorization_token_here}" \
-d '{
"refundRecords": [
{
"location": 1,
"sellRecord": 215,
"count": 1
}
]
}'Query param
| Атрибут | Информация |
|---|---|
| cashdesk | ID кассового терминала Cashdesk |
Post param
| Атрибут | Информация |
|---|---|
| customer | ID покупатель |
| refundRecords | refundRecords |
Response
Create sell
Создание продажи
Http request
curl -X POST \
https://{subdomin}.ox-sys.com/cashdesks/{cashdesk}/sells \
-H "Authorization: Bearer {your_authorization_token_here}" \
-d '{
"note": "1c"
}'Query param
| Атрибут | Информация |
|---|---|
| cashdesk | ID кассового терминала Cashdesk |
Post param
| Атрибут | Информация |
|---|---|
| note | "" |
Response
{
"isPostpone": false,
"sellRecords": [],
"possiblePickupTime": null,
"shippingService": null,
"cashdesk": {
"id": 233,
"name": "test",
"zone": 13,
"sellKey": "KF",
"fingerprint": "3d00cf5a1a133db0fb8d84a911b80956",
"appId": null,
"active": true,
"type": 1,
"locations": [
97
],
"paymentMethods": [],
"cashAccount": {
"id": 110,
"name": "test0000",
"properties": [
{
"name": "n1",
"value": "12"
}
]
},
"online": false,
"nonCashAccount": {
"id": 110,
"name": "test0000",
"properties": [
{
"name": "n1",
"value": "12"
}
]
},
"lastSyncTime": null,
"logo": null,
"uploadedFile": null,
"referralAccess": false,
"lastPrintId": null,
"postponeExpireDay": 7,
"onlineKKM": true,
"tinNumber": "12",
"device": [],
"config": {
"print": null
},
"vatNumber": "12",
"phoneNumbers": [
"+23"
],
"address": {
"id": 5675,
"type": null,
"countryCode": "UZ",
"administrativeArea": "Ташкентская область",
"locality": "город Ахангаран",
"dependentLocality": null,
"postalCode": "12",
"addressLine1": "54",
"addressLine2": ",,",
"organization": null,
"latitude": null,
"longitude": null,
"houseNumber": null,
"floor": null,
"apartmentNumber": null
}
},
"type": "pos",
"sellSeats": [],
"status": "cart",
"id": 990481,
"note": "1C",
"count": 0,
"time": "2021-10-15 11:36:08",
"zone": 13,
"shift": {
"id": 30196,
"cashdesk": 233,
"openTime": "2021-10-14 15:34:00",
"closeTime": null,
"user": 117937,
"transactions": [],
"desktopApp": null,
"sells": null,
"sellPicks": null,
"total": null,
"allPaymentsByMethod": null,
"debits": null,
"encashment": null,
"cashBalance": null
},
"user": 117937,
"draft": true,
"takeAway": false,
"wasDebit": false,
"updatedTime": "2021-10-15 11:36:08",
"finishedTime": null,
"shippingAddress": null,
"billingAddress": null,
"customer": null,
"mode": "location",
"cardActivated": false,
"refundRecords": [],
"returnRecords": [],
"subtotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"total": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"debit": null,
"sellSubtotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"sellTotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"refundSubtotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"refundTotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"returnSubtotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"returnTotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"discount": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"payments": [],
"assistants": [],
"generatedCoupons": [],
"activatedCoupons": [],
"startTime": null,
"expireTime": null,
"releasedTime": null,
"pickupLocation": null,
"shippingTime": null,
"shippingTimeRange": null,
"shippingPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"recipient": null,
"guestQty": null,
"printKey": null,
"syncTime": "2021-10-15 11:36:08",
"manualDiscount": null,
"debtFinishedTime": null,
"resources": [],
"dynamicStatus": null,
"originalId": null,
"relatedSubdomain": null,
"isDebt": false,
"nextStatus": null
}Create sell record
Добавление продаваемых продуктов в продажу
Http request
POST https://{subdomin}.ox-sys.com/sell/{sell}/sell-records
curl -X POST \
https://{subdomin}.ox-sys.com/sell/{sell}/sell-records \
-H "Authorization: Bearer {your_authorization_token_here}"
-d "{
"stock": "fa9def8d-7fcf-43b7-bf3a-d1ea52f5fe73",
"count": 1
}"Query param
| Атрибут | Информация |
|---|---|
| sell | ID продажи Sell |
Post param
| Атрибут | Информация |
|---|---|
| count | Количество int |
| stock | ID стока Stock |
Response
{
"isPostpone": false,
"sellRecords": [
{
"expirationDate": null,
"variationName": "123123",
"id": 1639144,
"count": 1,
"movedCount": 0,
"price": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 3000,
"USD": 0.28,
"EUR": 0.27
},
"sell": 990481,
"variation": 42975,
"stock": "fa9def8d-7fcf-43b7-bf3a-d1ea52f5fe73",
"subtotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 3000,
"USD": 0.28,
"EUR": 0.27
},
"discount": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"total": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 3000,
"USD": 0.28,
"EUR": 0.27
},
"finalPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 3000,
"USD": 0.28,
"EUR": 0.27
},
"debit": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"offerBindings": [],
"refundRecords": [],
"brand": 49,
"zone": 13,
"location": 97,
"path": "1639144,",
"level": 1,
"parent": null,
"children": [],
"cookies": [],
"deleted": false,
"finishedTime": null,
"cashback": null,
"time": "2021-10-15 11:41:57"
}
],
"possiblePickupTime": null,
"shippingService": null,
"cashdesk": {
"id": 233,
"name": "test",
"zone": 13,
"sellKey": "KF",
"fingerprint": "3d00cf5a1a133db0fb8d84a911b80956",
"appId": null,
"active": true,
"type": 1,
"locations": [
97
],
"paymentMethods": [],
"cashAccount": {
"id": 110,
"name": "test0000",
"properties": [
{
"name": "n1",
"value": "12"
}
]
},
"online": false,
"nonCashAccount": {
"id": 110,
"name": "test0000",
"properties": [
{
"name": "n1",
"value": "12"
}
]
},
"lastSyncTime": null,
"logo": null,
"uploadedFile": null,
"referralAccess": false,
"lastPrintId": null,
"postponeExpireDay": 7,
"onlineKKM": true,
"tinNumber": "12",
"device": [],
"config": {
"print": null
},
"vatNumber": "12",
"phoneNumbers": [
"+23"
],
"address": {
"id": 5675,
"type": null,
"countryCode": "UZ",
"administrativeArea": "Ташкентская область",
"locality": "город Ахангаран",
"dependentLocality": null,
"postalCode": "12",
"addressLine1": "54",
"addressLine2": ",,",
"organization": null,
"latitude": null,
"longitude": null,
"houseNumber": null,
"floor": null,
"apartmentNumber": null
}
},
"type": "pos",
"sellSeats": [],
"status": "cart",
"id": 990481,
"note": "1C",
"count": 1,
"time": "2021-10-15 11:36:08",
"zone": 13,
"shift": {
"id": 30196,
"cashdesk": 233,
"openTime": "2021-10-14 15:34:00",
"closeTime": null,
"user": 117937,
"transactions": [],
"desktopApp": null,
"sells": null,
"sellPicks": null,
"total": null,
"allPaymentsByMethod": null,
"debits": null,
"encashment": null,
"cashBalance": null
},
"user": 117937,
"draft": true,
"takeAway": false,
"wasDebit": false,
"updatedTime": "2021-10-15 11:41:57",
"finishedTime": null,
"shippingAddress": null,
"billingAddress": null,
"customer": null,
"mode": "location",
"cardActivated": false,
"refundRecords": [],
"returnRecords": [],
"subtotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 3000,
"USD": 0.28,
"EUR": 0.27
},
"total": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 3000,
"USD": 0.28,
"EUR": 0.27
},
"debit": null,
"sellSubtotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 3000,
"USD": 0.28,
"EUR": 0.27
},
"sellTotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 3000,
"USD": 0.28,
"EUR": 0.27
},
"refundSubtotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"refundTotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"returnSubtotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"returnTotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"discount": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"payments": [],
"assistants": [],
"generatedCoupons": [],
"activatedCoupons": [],
"startTime": null,
"expireTime": null,
"releasedTime": null,
"pickupLocation": null,
"shippingTime": null,
"shippingTimeRange": null,
"shippingPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"recipient": null,
"guestQty": null,
"printKey": null,
"syncTime": "2021-10-15 11:41:57",
"manualDiscount": [],
"debtFinishedTime": null,
"resources": [],
"dynamicStatus": null,
"originalId": null,
"relatedSubdomain": null,
"isDebt": false,
"nextStatus": null
}Create sell record by variation
Добавление продаваемых продуктов с вариация в продажу
Http request
POST https://{subdomin}.ox-sys.com/sell/{sell}/sell-records-by-variation
curl -X POST \
https://{subdomin}.ox-sys.com/sell/{sell}/sell-records-by-variation \
-H "Authorization: Bearer {your_authorization_token_here}"
-d "{
"variation": 2,
"location": 1,
"count": 1
}"Query param
| Атрибут | Информация |
|---|---|
| sell | ID продажи Sell |
Post param
| Атрибут | Информация |
|---|---|
| variation | ID вариация |
| location | ID локация |
| count | Количество int |
Response
Update sell record
Http request
PATCH https://{subdomin}.ox-sys.com/sell-records/{sell_record}
curl -X PATCH \
https://{subdomin}.ox-sys.com/sell-records/{sell_record} \
-H "Authorization: Bearer {your_authorization_token_here}"
-d "{
count: 2
}"Query param
| Атрибут | Информация |
|---|---|
| sell_record | id Sell record |
Post param
| Атрибут | Информация |
|---|---|
| count | Количество int |
Response
{
"isPostpone": false,
"sellRecords": [
{
"expirationDate": null,
"variationName": "123123",
"id": 1639144,
"count": 2,
"movedCount": 0,
"price": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 3000,
"USD": 0.28,
"EUR": 0.27
},
"sell": 990481,
"variation": 42975,
"stock": "fa9def8d-7fcf-43b7-bf3a-d1ea52f5fe73",
"subtotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 6000,
"USD": 0.56,
"EUR": 0.55
},
"discount": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"total": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 6000,
"USD": 0.56,
"EUR": 0.55
},
"finalPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 3000,
"USD": 0.28,
"EUR": 0.27
},
"debit": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"offerBindings": [],
"refundRecords": [],
"brand": 49,
"zone": 13,
"location": 97,
"path": "1639144,",
"level": 1,
"parent": null,
"children": [],
"cookies": [],
"deleted": false,
"finishedTime": null,
"cashback": null,
"time": "2021-10-15 11:41:57"
}
],
"possiblePickupTime": null,
"shippingService": null,
"cashdesk": {
"id": 233,
"name": "test",
"zone": 13,
"sellKey": "KF",
"fingerprint": "3d00cf5a1a133db0fb8d84a911b80956",
"appId": null,
"active": true,
"type": 1,
"locations": [
97
],
"paymentMethods": [],
"cashAccount": {
"id": 110,
"name": "test0000",
"properties": [
{
"name": "n1",
"value": "12"
}
]
},
"online": false,
"nonCashAccount": {
"id": 110,
"name": "test0000",
"properties": [
{
"name": "n1",
"value": "12"
}
]
},
"lastSyncTime": null,
"logo": null,
"uploadedFile": null,
"referralAccess": false,
"lastPrintId": null,
"postponeExpireDay": 7,
"onlineKKM": true,
"tinNumber": "12",
"device": [],
"config": {
"print": null
},
"vatNumber": "12",
"phoneNumbers": [
"+23"
],
"address": {
"id": 5675,
"type": null,
"countryCode": "UZ",
"administrativeArea": "Ташкентская область",
"locality": "город Ахангаран",
"dependentLocality": null,
"postalCode": "12",
"addressLine1": "54",
"addressLine2": ",,",
"organization": null,
"latitude": null,
"longitude": null,
"houseNumber": null,
"floor": null,
"apartmentNumber": null
}
},
"type": "pos",
"sellSeats": [],
"status": "cart",
"id": 990481,
"note": "1C",
"count": 2,
"time": "2021-10-15 11:36:08",
"zone": 13,
"shift": {
"id": 30196,
"cashdesk": 233,
"openTime": "2021-10-14 15:34:00",
"closeTime": null,
"user": 117937,
"transactions": [],
"desktopApp": null,
"sells": null,
"sellPicks": null,
"total": null,
"allPaymentsByMethod": null,
"debits": null,
"encashment": null,
"cashBalance": null
},
"user": 117937,
"draft": true,
"takeAway": false,
"wasDebit": false,
"updatedTime": "2021-10-15 11:43:57",
"finishedTime": null,
"shippingAddress": null,
"billingAddress": null,
"customer": null,
"mode": "location",
"cardActivated": false,
"refundRecords": [],
"returnRecords": [],
"subtotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 6000,
"USD": 0.56,
"EUR": 0.55
},
"total": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 6000,
"USD": 0.56,
"EUR": 0.55
},
"debit": null,
"sellSubtotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 6000,
"USD": 0.56,
"EUR": 0.55
},
"sellTotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 6000,
"USD": 0.56,
"EUR": 0.55
},
"refundSubtotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"refundTotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"returnSubtotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"returnTotal": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"discount": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"payments": [],
"assistants": [],
"generatedCoupons": [],
"activatedCoupons": [],
"startTime": null,
"expireTime": null,
"releasedTime": null,
"pickupLocation": null,
"shippingTime": null,
"shippingTimeRange": null,
"shippingPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"recipient": null,
"guestQty": null,
"printKey": null,
"syncTime": "2021-10-15 11:43:57",
"manualDiscount": [],
"debtFinishedTime": null,
"resources": [],
"dynamicStatus": null,
"originalId": null,
"relatedSubdomain": null,
"isDebt": false,
"nextStatus": null
}Delete sell record
Удаление открытой продажи
Http request
DELETE https://{subdomin}.ox-sys.com/sell-records/{sell_record}
curl -X DELETE \
https://{subdomin}.ox-sys.com/sell-records/{sell_record} \
-H "Authorization: Bearer {your_authorization_token_here}"Query param
| Атрибут | Информация |
|---|---|
| sell_record | ID продаваемых продуктов Sell record |
Response
Update sell
Обновление открытой продажи, отложки или долга.
Http request
PATCH https://{subdomin}.ox-sys.com/sells/{sell}
curl -X PATCH \
https://{subdomin}.ox-sys.com/sells/{sell} \
-H "Authorization: Bearer {your_authorization_token_here}"
-d "{
payments:[
{
paymentMethod: 3,
price: 120000,
type: 'sell'
}
],
customer: 117890,
assistants:[112,4313]
}"Query param
| Атрибут | Информация |
|---|---|
| sell | ID продажи Sell |
Response
Shipping service sell
Добавление метода доставки и информации о доставке в продажу.
Http request
PATCH https://{subdomin}.ox-sys.com/sells/details/{sell}/details
curl -X PATCH \
https://{subdomin}.ox-sys.com/sells/details/{sell}/details \
-H "Authorization: Bearer {your_authorization_token_here}"
-d '{
isPickup: true,
pickupLocation: 11,
recipient: "Muxiddin Jumaniyazov"
shippingService: 10,
shippingTime: "12:31"
}'Query param
| Атрибут | Информация |
|---|---|
| sell | ID продажи Sell |
Response
Add payment sell
Оплата для продажа.
Http request
POST https://{subdomin}.ox-sys.com/sells/{sell}/payment
curl -X POST \
https://{subdomin}.ox-sys.com/sells/{sell}/payment \
-H "Authorization: Bearer {your_authorization_token_here}"
-d '{
"paymentMethod": 1,
"price": 100000,
"type": "sell"
}'Query param
| Атрибут | Информация |
|---|---|
| sell | ID продажи Sell |
Post param
| Атрибут | Информация |
|---|---|
| paymentMethod | Тип оплата |
| price | сумма int |
| type | sell,refund |
Response
Finish sell
Завершение (закрытые) открытой продажи.
Http request
POST https://{subdomin}.ox-sys.com/sells/{sell}/commit
curl -X POST \
https://{subdomin}.ox-sys.com/sells/{sell}/commit \
-H "Authorization: Bearer {your_authorization_token_here}"
-d '{
"mode": "location"
}'Query param
| Атрибут | Информация |
|---|---|
| sell | ID продажи Sell |
Response
Postpone sell
Отложка продажи
Http request
POST https://{subdomin}.ox-sys.com/sells/{sell}/postpone
curl -X POST \
https://{subdomin}.ox-sys.com/sells/{sell}/postpone \
-H "Authorization: Bearer {your_authorization_token_here}"
-d '{
"mode": "location"
}'Query param
| Атрибут | Информация |
|---|---|
| sell | ID продажи Sell |
Response
Update finished sell
Обновление завершенной продажи
Http request
PATCH https://{subdomin}.ox-sys.com/sells/{sellID}/patch
Patch params
| Атрибут | Информация |
|---|---|
| finishedTime | Datetime finished time |
| assistants | IDs users |
| user | ID cashier |
| customer | ID customer |
| note | string |
| payments | array |
| pickupLocation | ID location |
| shippingAddress | object |
Response
Update sell payment
Обновление оплата продажи
Http request
PATCH https://{subdomin}.ox-sys.com/sell-payments/{paymentID}
Patch params
Response
Role
Роли - это набор доступов пользователя к системе.
View
Просмотр роли
Http request
GET https://{subdomin}.ox-sys.com/roles/{role}
curl -X GET \
https://{subdomin}.ox-sys.com/roles/{role} \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Атрибут | Информация |
|---|---|
| role | Role |
List
Список ролей
Http request
GET https://{subdomin}.ox-sys.com/roles
curl -X GET \
https://{subdomin}.ox-sys.com/roles \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Атрибут | Информация |
|---|---|
| items | array role |
Cashdesk
View
Http request
GET https://{subdomin}.ox-sys.com/cash-desks/{cashdesk}
curl -X GET \
https://{subdomin}.ox-sys.com/cash-desks/{cashdesk} \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Attribute | Info |
|---|---|
| cashdesk | id Cash desk |
List
Http request
GET https://{subdomin}.ox-sys.com/cash-desks
curl -X GET \
https://{subdomin}.ox-sys.com/cash-desks \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Attribute | Info |
|---|---|
| items |
|
Transfer
Transfer list
curl --request GET \
--url https://face.ox-sys.com/transfers \
--header 'authorization: Bearer {TOKEN}'Query request
| Параметр | Описание |
|---|---|
| id | id transfer |
| time[min] | start of time |
| time[max] | end of time |
| approved | 1 or 0 |
| approvedTime[min] | start of approved time |
| approvedTime[max] | end of approved time |
| inLocation | in transfer of location id |
| outLocations |
|
| brand | id brand of variation |
| variation[] | filter params variations |
Response
{
"page": 1,
"items": [
{
"id": 11735,
"note": null,
"count": 2,
"time": "2020-08-27 18:44:51",
"zone": 13,
"user": 118231,
"orderedUser": null,
"sentUser": null,
"acceptedUser": null,
"draft": true,
"inLocation": 42,
"outLocations": [
"68"
],
"outLocation": 68,
"status": "process_inventor",
"ordered": false,
"willReview": true,
"totalSellPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 200000,
"USD": 18.52,
"EUR": 18.18
},
"totalSupplyPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 110000,
"USD": 10.19,
"EUR": 10
},
"totalLandedPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 110000,
"USD": 10.19,
"EUR": 10
},
"approved": false,
"approvedTime": null
}
],
"total_count": 22
}
Transfer create
Transfer product do following steps given bellow
curl --request POST \
--url https://face.ox-sys.com/{zone}/transfers \
--header 'Authorization: Bearer {TOKEN}' \
--data '{
"outLocation": 42,
"inLocation": 293,
"type": 0,
"records": [
{
"variation": 242351,
"count": 3
},
{
"variation": 242352,
"count": 2
},
{
"variation": 242353,
"count": 4
}
]
}'Query request
| Параметр | Описание |
|---|---|
| inLocation | id location |
| outLocation | id location |
| type | '0' (Create transfer operation) or 1 (Order transfer operation) |
| records | array Records |
Response
{
"id": 14,
"note": null,
"count": 0,
"time": "2021-10-12 15:35:04",
"zone": 1,
"user": 117141,
"orderedUser": null,
"sentUser": null,
"acceptedUser": null,
"draft": true,
"inLocation": 11,
"outLocations": [],
"outLocation": 1,
"status": "process",
"ordered": false,
"willReview": false,
"totalSellPrice": null,
"totalSupplyPrice": null,
"totalLandedPrice": null,
"approved": false,
"approvedTime": null
}Transfer approve
curl --request GET \
--url https://face.ox-sys.com/transfers/14/change-status \
--header 'authorization: Bearer {TOKEN}'Query request
Response
{
"id": 14,
"note": null,
"count": 3,
"time": "2021-10-12 15:35:04",
"zone": 1,
"user": 117141,
"orderedUser": null,
"sentUser": null,
"acceptedUser": 117141,
"draft": true,
"inLocation": 11,
"outLocations": [],
"outLocation": 1,
"status": "accepted",
"ordered": false,
"willReview": false,
"totalSellPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.09090909090909e-5,
"USD\/UZS": 11000
},
"order": [
"UZS",
"USD"
],
"UZS": 300000,
"USD": 27.27
},
"totalSupplyPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.09090909090909e-5,
"USD\/UZS": 11000
},
"order": [
"UZS",
"USD"
],
"UZS": 240000,
"USD": 21.82
},
"totalLandedPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.09090909090909e-5,
"USD\/UZS": 11000
},
"order": [
"UZS",
"USD"
],
"UZS": 240000,
"USD": 21.82
},
"approved": true,
"approvedTime": "2021-10-12 15:35:50"
}Transfer records list
curl --request GET \
--url https://face.ox-sys.com/transfer/{transferID}/records \
--header 'authorization: Bearer {TOKEN}'Query request
| Параметр | Описание |
|---|---|
| id | id transfer |
| status | Success, Overage,Created,Shortage,Unknown |
| variation[name] | Variation name |
| variation[names] | array of Variation name |
| variation[sku] | Variation sku |
| variation[skus] | array of Variation sku |
| variation[barcode] | Variation barcode |
| variation[barcodes] | array of Variation barcodes |
Response
{
"page": 1,
"total_count": 2,
"items": [
{
"status": "overage",
"price": null,
"variation": 240450,
"outLocation": 68,
"time": "2020-08-27 18:45:04",
"stock": null,
"inStock": null,
"orderCount": 0,
"sentCount": 1,
"acceptCount": 0,
"decreaseCount": 0,
"id": 221007,
"count": 1
},
{
"status": "overage",
"price": null,
"variation": 240451,
"outLocation": 68,
"time": "2020-08-27 18:45:03",
"stock": null,
"inStock": null,
"orderCount": 0,
"sentCount": 1,
"acceptCount": 0,
"decreaseCount": 0,
"id": 221006,
"count": 1
}
]
}Import
Import list
curl --request GET \
--url https://face.ox-sys.com/imports \
--header 'authorization: Bearer {TOKEN}'Query request
| Параметр | Описание |
|---|---|
| id | id import |
| time[min] | start of time |
| time[max] | end of time |
| finishedTime[min] | start of finished time |
| finishedTime[max] | end of finished time |
| location | in import of location id |
| brand | id brand of variation |
| variation[] | filter params variations |
Response
{
"page": 1,
"items": [
{
"id": 7085,
"note": null,
"count": 3,
"time": "2020-09-04 23:45:30",
"lastApproveTime": null,
"zone": 13,
"brand": 15,
"user": 118231,
"location": 42,
"finished": true,
"willReview": false,
"deleted": false,
"approvals": [
5901
],
"orderProperties": [],
"orderTransactions": [],
"supplyRatio": {
"USD_UZS": 10800,
"EUR_UZS": 11000
},
"scheduled": false,
"landedCosts": [],
"status": "finished"
}
],
"total_count": 109
}
Import records list
curl --request GET \
--url https://face.ox-sys.com/imports/{importID}/records \
--header 'authorization: Bearer {TOKEN}'Query request
| Параметр | Описание |
|---|---|
| id | id import |
| barcodes | array of Variation barcodes |
| skus | array of Variation skus |
| productName | Name of variation product |
Response
{
"page": 1,
"items": [
{
"id": 697332,
"import": 7085,
"variation": 246029,
"initialCount": 0,
"approvals": [
{
"time": "2020-09-04 23:47:50",
"count": 3
}
],
"variationBarcode": "9090909",
"variationName": "Bebe",
"areaNames": null,
"variationShippable": true,
"variationTaxable": false,
"variationSellable": true,
"variationCountable": true,
"variationCookable": false,
"unit": "pcs",
"variationProperties": [
{
"name": "Размер",
"value": "AB"
},
{
"name": "Цвет",
"value": "Color"
}
],
"productProperties": [
{
"name": "Производитель",
"value": "Turkey"
}
],
"productSku": "98983",
"productName": "Bebe",
"productDescription": "Bebe",
"supplierName": "AVA",
"categoryNames": [
"Bebe"
],
"count": 3,
"stockTracking": true,
"stockSellPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 9.259259259259259e-5,
"USD\/UZS": 10800,
"UZS\/EUR": 9.09090909090909e-5,
"EUR\/UZS": 11000
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 10000,
"USD": 0.93,
"EUR": 0.91
},
"stockSupplyPrice": {
"first": "USD",
"ratio": {
"USD\/UZS": 10800,
"UZS\/USD": 9.259259259259259e-5,
"EUR\/UZS": 11000,
"UZS\/EUR": 9.09090909090909e-5
},
"order": [
"USD",
"UZS",
"EUR"
],
"USD": 1,
"UZS": 10800,
"EUR": 0.98
},
"stockProperties": [
{
"name": "Груз номер",
"value": "1"
}
],
"applied": false,
"diffs": null,
"ingredients": null,
"productTags": null,
"orderPropertyPrices": null,
"landedCostPrice": {
"first": "USD",
"ratio": {
"USD\/UZS": 10800,
"UZS\/USD": 9.259259259259259e-5,
"EUR\/UZS": 11000,
"UZS\/EUR": 9.09090909090909e-5
},
"order": [
"USD",
"UZS",
"EUR"
],
"USD": 1,
"UZS": 10800,
"EUR": 0.98
},
"stockExpirationDate": null,
"stock": "15662050-e1d3-4380-a973-02fe5c35f7e8",
"landedCosts": null,
"images": [],
"uploadedImages": []
}
],
"total_count": 1
}Import create
Import products do following steps bellow
curl --request POST \
--url https://{subdomain}.ox-sys.com/zones/{zoneID}/imports \
--header 'Authorization: Bearer {TOKEN}' \
--header 'Content-Type: application/json' \
--data '{
"location": 42,
"willReview": false,
"note": "Notessss",
"supplyRatio": {
"USD_UZS": 0
}
}'Post attributes
| Параметр | Тип | Описание |
|---|---|---|
| location | int | ID location |
| willReview | bool | if need review before import true |
| note | string | description |
| supplyRatio | array | currency combination main currency with secondary currencies |
{
"id": 3777,
"note": "Notessss",
"count": 0,
"time": "2022-10-18 11:44:11",
"lastApproveTime": null,
"zone": 13,
"brand": 15,
"user": 117937,
"location": 42,
"finished": false,
"willReview": false,
"deleted": false,
"approvals": [],
"orderProperties": [],
"orderTransactions": [],
"supplyRatio": {
"USD_UZS": 12000
},
"scheduled": false,
"finishedTime": null,
"system": false,
"landedCosts": [],
"status": "not_finished"
}Add import record
add record to import
curl --request POST \
--url https://{subdomain}.ox-sys.com/imports/{importID}/import-records/multiple \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {TOKEN}' \
--header 'Content-Type: multipart/form-data' \
--form 'records[0][productSku]=8DG5UX6QIH' \
--form 'records[0][productName]=Nike sneakers' \
--form 'records[0][supplierName]=Nike' \
--form 'records[0][categoryNames]=Boots' \
--form 'records[0][variationCountable]=1' \
--form 'records[0][variationShippable]=1' \
--form 'records[0][variationSellable]=1' \
--form 'records[0][variationScalable]=0' \
--form 'records[0][uploadedImages][]=@/home/muxiddin/Pictures/iphone-12-pro-family-hero.jpeg' \
--form 'records[0][variationBarcode]=4788645796881' \
--form 'records[0][unit]=pcs' \
--form 'records[0][stockSupplyPrice]=4 USD' \
--form 'records[0][stockSellPrice]=172800 UZS' \
--form 'records[0][count]=10' \
--form 'records[0][variationProperties][0][name]=Размер' \
--form 'records[0][variationProperties][0][value]=XXS' \
--form 'records[0][variationProperties][0][name]=Цвет' \
--form 'records[0][variationProperties][0][value]=Blue' \
--form 'records[0][variationName]=Nike sneakers Blue' \
--form forceValidate=trueResponse
array of [Records]
Records
Approve
after then all records insert should approve impport for including variation to product list
curl --request POST \
--url https://{subdomain}.ox-sys.com/imports/{importID}/finish \
--header 'Authorization: Bearer {TOKEN}'Correction
Correction list
curl --request GET \
--url https://face.ox-sys.com/corrections \
--header 'authorization: Bearer {TOKEN}'Query request
| Параметр | Описание |
|---|---|
| id | id correction |
| time[min] | start of time, default today |
| time[max] | end of time, default today |
| location | in correction of location id |
| brand | id brand of variation |
| user | id of created user |
| variation[] | filter params variations exp: variation[name]=Shirt |
Response
{
"page": 1,
"items": [
{
"id": 50869,
"note": "",
"count": "-21.00",
"time": "2020-09-18 12:12:00",
"zone": 13,
"brand": 15,
"user": 117937,
"summary": {
"sum": -21,
"negative": -21,
"positive": 0
},
"location": 68,
"reason": "review",
"approved": true,
"approvedTime": "2020-09-18 12:12:00"
}
],
"total_count": 4
}Correction records list
curl --request GET \
--url https://face.ox-sys.com/correction/{correctionID} \
--header 'authorization: Bearer {TOKEN}'Query request
| Параметр | Описание |
|---|---|
| id | id correction |
| barcodes | array of Variation barcodes |
| skus | array of Variation skus |
| productName | Name of variation product |
Response
{
"page": 1,
"items": [
{
"variation_price": {
"first": "UZS",
"ratio": {
"USD\/UZS": 11000,
"UZS\/USD": 9.09090909090909e-5,
"EUR\/UZS": 11000,
"UZS\/EUR": 9.09090909090909e-5
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 70900,
"USD": 6,
"EUR": 6
},
"id": 124168,
"count": -6,
"variation": 19986,
"stock": {
"imported": "2019-03-20 17:10:37",
"id": "624f86e6-57a3-4b58-a4e6-750540cf07c8",
"location": 68,
"import": null,
"originalImport": 446,
"transfer": 4246,
"transferCount": 6,
"importCount": null,
"originalImportCount": 0,
"tracking": true,
"countable": true,
"composite": false,
"sellPrice": {
"first": "UZS",
"ratio": {
"USD\/UZS": 11000,
"UZS\/USD": 9.09090909090909e-5,
"EUR\/UZS": 11000,
"UZS\/EUR": 9.09090909090909e-5
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 70900,
"USD": 6,
"EUR": 6
},
"supplyPrice": {
"first": "USD",
"ratio": {
"USD\/UZS": 8600,
"UZS\/USD": 0.00011627906976744187
},
"order": [
"USD",
"UZS"
],
"USD": 4.55,
"UZS": 39130
},
"properties": [
{
"name": "Цена продажи в $",
"value": "6.37"
}
],
"expirationDate": null,
"count": 0
},
"price": {
"first": "UZS",
"ratio": {
"USD\/UZS": 11000,
"UZS\/USD": 9.09090909090909e-5,
"EUR\/UZS": 11000,
"UZS\/EUR": 9.09090909090909e-5
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 70900,
"USD": 6,
"EUR": 6
}
}
],
"total_count": 1
}Correction create draft
curl --request POST \
--url https://face.ox-sys.com/corrections \
--header 'authorization: Bearer {TOKEN}' \
--data '{
"location": 42,
"reason": "manual",
"records": [
{
"variation": 242351,
"count": -5
},
{
"variation": 242352,
"count": 5
}
]
}'Query request
| Параметр | Описание |
|---|---|
| location | id location |
| records | array Records |
| reason | text |
Response
{
"id": 5,
"note": null,
"count": -2,
"time": "2021-10-12 11:25:00",
"zone": 1,
"brand": 1,
"user": 117141,
"summary": {
"sum": -2,
"negative": -5,
"positive": 3
},
"location": 1,
"reason": "manual",
"approved": false,
"approvedTime": null
}Correction create approve
curl --request POST \
--url https://face.ox-sys.com/corrections/{correction}/approve \
--header 'authorization: Bearer {TOKEN}'Query request
Response
Supplier
Поставщик - поставщик продуктов.
View
Просмотр поставщика
Http request
GET https://{subdomin}.ox-sys.com/suppliers/{supplier}
curl -X GET \
https://{subdomin}.ox-sys.com/suppliers/{supplier} \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Attribute | Info |
|---|---|
| supplier | Supplier |
List
Список поставщиков
Http request
GET https://{subdomin}.ox-sys.com/suppliers
curl -X GET \
https://{subdomin}.ox-sys.com/suppliers \
-H "Authorization: Bearer {your_authorization_token_here}"Attribute
| Attribute | Info |
|---|---|
| items | arraysuppliers |
Coupon
Coupon - coupon need working promotion
Beeline club
Generate coupon code
Http request
POST https://{subdomin}.ox-sys.com/coupons/beeline/code-generate
curl --request POST \
--url https://{subdomin}.ox-sys.com/coupons/beeline/code-generate \
--header 'authorization: Bearer {your_authorization_token_here}' \
--header 'content-type: application/json' \
--data '{
"phone": "+998998921025",
"firstName": "Muxiddin",
"lastName": "Jumaniyazov",
"collection": "Beeline club 1"
}'Params
| Атрибут | Информация |
|---|---|
| phone * | phone number of customer |
| firstName * | first name of customer |
| lastName | last name of customer |
| collection | name of collection coupon |
Response
Response
"bee0081644"Promotion
List
Http request
GET https://{subdomin}.ox-sys.com/promotions
curl -X GET \
https://{subdomin}.ox-sys.com/promotions \
-H "Authorization: Bearer {your_authorization_token_here}"Query params
| Name | Info |
|---|---|
| name | name of promotion |
| active | 1 - active, 0 - inactive |
| location[] | IDS of location |
| rule[type][] | types of rule from this list coupon_collection,payment_method,time,variation_field,customer,customer_group,group_with_points,total_count,total_price |
Response
| Attribute | Info |
|---|---|
| items |
|
Others
Send sms
Http request
POST https://{subdomin}.ox-sys.com/sms-records
curl --request POST \
--url https://{subdomin}.ox-sys.com/sms-records \
--header 'authorization: Bearer {TOKEN}' \
--header 'content-type: application/json' \
--data '{
"alphaName": 3700,
"number": "+998991001010",
"message": "Hello test!"
}'Response
Response 200
"success"Objects
Company object
Attributes
| Attribute | Description |
|---|---|
| id | ID компании |
| name | Название компании |
| companyCode | Код компании |
| subdomain | сабдомен компании (нужен для авторизации) |
| owner | Основатель компании Owner |
| domains | Привязанные домены компании (для интернет-магазина) |
| expireTime | Дата истечения срока OX плана |
| trialExpireTime | Дата истичения срока пробной версии системы OX |
| plan | ID OX плана |
| cashdeskPlan | ID плана кассового терминала |
| cashdeskCount | Количество позволенных кассовых терминалов |
| trusted | Доверенный клиент или нет boolean |
| setup | Настроено или нет boolean |
Response
Response
{
"id": 23,
"name": "Demo",
"userPropertyPatterns": [],
"kidPropertyPatterns": [],
"manufacturerCode": null,
"companyCode": "llc",
"subdomain": "demo",
"verified": true,
"owner": null,
"domains": [
"myeshop.com",
"modernclothes.uz"
],
"expireTime": "2019-07-01 04:59:00",
"trialExpireTime": "2018-06-06 16:07:02",
"plan": 6,
"cashdeskPlan": 1,
"cashdeskCount": 10,
"trusted": false,
"setup": true,
"trialExpireDate": null
}User object
Attributes
| Attribute | Description |
|---|---|
| id | ID пользователя |
| username | логин пользователя |
| Email пользователя | |
| active | Активный или нет boolean |
| owner | Основатель компании или нет boolean |
| roles | Роли пользователя |
| kids | Дети пользователя |
| groups | Группа пользователя |
| type | Тип пользователя сотрудник employee или клиент customer |
| customerBrandIds | Клиент в брендах brand Ids |
| roleBrandIds | Привязанные бренды в ролях brand Ids |
| roleLocationIds | Привязанные локации в ролях location ids |
| cards | Карта пользователя card |
| profile | Профиль пользователя Profile |
| setting | Настройка профиля пользователя settings |
| wallet | Кошелек пользователя wallet |
| registeredTime | Дата и время регистрации datetime |
| lastActiveTime | Дата и время последной активности datetime |
| lastUpdateTime | Дата и время последной обновлений datetime |
| addresses | Адреса пользователя array Address |
| salaries | Заработная плана пользователя array salaries |
| latenesses | Опоздание пользователя array |
| overtimes | Сверхурочные пользователя array |
| penalties | Штрафы пользователя array |
| rewards | Вознограждения пользователя array |
| userSchedules | График работы пользователя array |
| userDepartments | Отдел пользователя array |
| properties | Свойства пользователя array |
| fired | Работает или уволенный boolean |
| isSubscribed | boolean |
| invitedUser | Приглашенные пользователи Invited user |
| phoneVerified | Номер телефона подвержден boolean |
| emailVerified | E-mail адрес подвержден boolean |
| referralUsers | boolean |
Response
Result
{
"id": 117152,
"username": "demo",
"email": "admin@ox-sys.com",
"active": true,
"owner": true,
"roles": [],
"kids": [],
"company": {
"id": 23,
"name": "Demo",
"userPropertyPatterns": [],
"kidPropertyPatterns": [],
"manufacturerCode": null,
"companyCode": "llc",
"subdomain": "demo",
"verified": true,
"owner": null,
"domains": [
"myeshop.com",
"modernclothes.uz"
],
"expireTime": "2019-07-01 04:59:00",
"trialExpireTime": "2018-06-06 16:07:02",
"plan": 6,
"cashdeskPlan": 1,
"cashdeskCount": 10,
"trusted": false,
"setup": true,
"trialExpireDate": null
},
"groups": [],
"type": "employee",
"customerBrandIds": [],
"roleBrandIds": [],
"roleLocationIds": [],
"cards": [],
"profile": {
"fullName": "John Doe",
"id": 126344,
"firstName": "John",
"lastName": "Doe",
"middleName": null,
"phoneNumbers": [
"+998 90 999 99 99"
],
"birthDate": "1976-07-10",
"notes": null,
"gender": "male",
"photos": [
{
"id": 131,
"originalName": "blog-img-10",
"createdAt": "2019-04-10 17:39:39",
"updatedAt": "2019-04-10 17:39:39",
"urls": {
"50x_": "http://demo.ox-sys.com/cache/50x_/image/b2/3e/1a/b23e1a4b724645608d6a9d4e272b10ca725c9ac82f33fd1305c41914644e80c9.jpg",
"100x_": "http://demo.ox-sys.com/cache/100x_/image/b2/3e/1a/b23e1a4b724645608d6a9d4e272b10ca725c9ac82f33fd1305c41914644e80c9.jpg",
"150x_": "http://demo.ox-sys.com/cache/150x_/image/b2/3e/1a/b23e1a4b724645608d6a9d4e272b10ca725c9ac82f33fd1305c41914644e80c9.jpg",
"300x_": "http://demo.ox-sys.com/cache/300x_/image/b2/3e/1a/b23e1a4b724645608d6a9d4e272b10ca725c9ac82f33fd1305c41914644e80c9.jpg",
"original": "http://demo.ox-sys.com/cache/original/image/b2/3e/1a/b23e1a4b724645608d6a9d4e272b10ca725c9ac82f33fd1305c41914644e80c9.jpg"
}
},
{
"id": 101,
"originalName": "Снимок экрана 2018-05-30 в 19.13.20",
"createdAt": "2018-07-02 19:27:14",
"updatedAt": "2018-07-02 19:27:14",
"urls": []
}
],
"backgroundImage": {
"id": 132,
"originalName": "apple-touch-icon",
"createdAt": "2019-04-10 17:39:39",
"updatedAt": "2019-04-10 17:39:39",
"urls": {
"50x_": "http://demo.ox-sys.com/cache/50x_/image/cb/b6/62/cbb6626e5e09dac858fbbf69055ea23b9036faabfb5a356bfdbf30c2e730d828.png",
"100x_": "http://demo.ox-sys.com/cache/100x_/image/cb/b6/62/cbb6626e5e09dac858fbbf69055ea23b9036faabfb5a356bfdbf30c2e730d828.png",
"150x_": "http://demo.ox-sys.com/cache/150x_/image/cb/b6/62/cbb6626e5e09dac858fbbf69055ea23b9036faabfb5a356bfdbf30c2e730d828.png",
"300x_": "http://demo.ox-sys.com/cache/300x_/image/cb/b6/62/cbb6626e5e09dac858fbbf69055ea23b9036faabfb5a356bfdbf30c2e730d828.png",
"original": "http://demo.ox-sys.com/cache/original/image/cb/b6/62/cbb6626e5e09dac858fbbf69055ea23b9036faabfb5a356bfdbf30c2e730d828.png"
}
}
},
"setting": {
"id": 28654,
"timezone": "Asia/Tashkent",
"locale": "ru",
"defaultSellLocation": null
},
"wallet": null,
"registeredTime": "2018-05-23 16:07:02",
"lastActiveTime": "2019-06-27 12:43:06",
"lastUpdateTime": "2019-06-19 15:15:17",
"addresses": [
{
"id": 69,
"type": "billing",
"countryCode": "UZ",
"administrativeArea": "Tashkent city",
"locality": "Akmal Ikromov",
"dependentLocality": null,
"postalCode": "100000",
"addressLine1": "Айбек 40",
"addressLine2": ",,",
"organization": null,
"latitude": "41.2994958",
"longitude": "69.2400734",
"houseNumber": null,
"floor": null,
"apartmentNumber": null
}
],
"salaries": [
{
"id": 6,
"amount": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00012658227848101267,
"USD/UZS": 7899.999999999999,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 1500000,
"USD": 189.87,
"EUR": 164.84
},
"type": "monthly",
"user": null,
"time": "2018-11-28 11:54:50",
"deactivatedTime": null,
"highlights": null
}
],
"latenesses": [],
"overtimes": [],
"penalties": [
{
"id": 1,
"user": null,
"time": "2018-11-28 11:57:30",
"amount": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00012658227848101267,
"USD/UZS": 7899.999999999999,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 50000,
"USD": 6.33,
"EUR": 5.49
},
"comment": null,
"reason": "discipline"
}
],
"rewards": [],
"userSchedules": [
{
"id": 10,
"user": 117152,
"schedule": {
"id": 2,
"name": "Раб график для бренд менеджеров",
"type": "fixed",
"days": [
{
"number": 0,
"schedule": 2,
"workAllowed": true,
"workStartTime": "2018-07-02 11:00:00",
"workFinishTime": "2018-07-02 19:00:00",
"dinnerAllowed": true,
"dinnerStartTime": "2018-07-02 13:00:00",
"dinnerFinishTime": "2018-07-02 14:00:00"
},
{
"number": 1,
"schedule": 2,
"workAllowed": true,
"workStartTime": "2018-07-02 11:00:00",
"workFinishTime": "2018-07-02 19:00:00",
"dinnerAllowed": true,
"dinnerStartTime": "2018-07-02 13:00:00",
"dinnerFinishTime": "2018-07-02 14:00:00"
},
{
"number": 2,
"schedule": 2,
"workAllowed": true,
"workStartTime": "2018-07-02 11:00:00",
"workFinishTime": "2018-07-02 19:00:00",
"dinnerAllowed": true,
"dinnerStartTime": "2018-07-02 13:00:00",
"dinnerFinishTime": "2018-07-02 14:00:00"
},
{
"number": 3,
"schedule": 2,
"workAllowed": true,
"workStartTime": "2018-07-02 11:00:00",
"workFinishTime": "2018-07-02 19:00:00",
"dinnerAllowed": true,
"dinnerStartTime": "2018-07-02 13:00:00",
"dinnerFinishTime": "2018-07-02 14:00:00"
},
{
"number": 4,
"schedule": 2,
"workAllowed": true,
"workStartTime": "2018-07-02 11:00:00",
"workFinishTime": "2018-07-02 19:00:00",
"dinnerAllowed": true,
"dinnerStartTime": "2018-07-02 13:00:00",
"dinnerFinishTime": "2018-07-02 14:00:00"
},
{
"number": 5,
"schedule": 2,
"workAllowed": true,
"workStartTime": "2018-07-02 11:00:00",
"workFinishTime": "2018-07-02 19:00:00",
"dinnerAllowed": true,
"dinnerStartTime": "2018-07-02 13:00:00",
"dinnerFinishTime": "2018-07-02 14:00:00"
},
{
"number": 6,
"schedule": 2,
"workAllowed": true,
"workStartTime": "2018-07-02 11:00:00",
"workFinishTime": "2018-07-02 19:00:00",
"dinnerAllowed": true,
"dinnerStartTime": "2018-07-02 13:00:00",
"dinnerFinishTime": "2018-07-02 14:00:00"
}
],
"dinnerAllowed": false,
"dinnerStartTime": "2018-07-02 13:00:00",
"dinnerFinishTime": "2018-07-02 14:00:00",
"workStartTimeEnabled": true,
"workStartTime": "2018-07-02 09:00:00",
"workFinishTimeEnabled": true,
"workFinishTime": "2018-07-02 18:00:00",
"workTotalTimeEnabled": true,
"workTotalTime": "2018-07-02 09:00:00",
"dinnerTotalTimeEnabled": true,
"dinnerTotalTime": "2018-07-03 01:00:00",
"startDate": "2018-07-01 19:32:35"
},
"time": "2018-11-28 11:55:18",
"deactivatedTime": null
}
],
"userDepartments": [
{
"name": "Отдел по управлению брендом",
"id": 13,
"user": null,
"department": 7,
"time": "2018-07-11 13:28:45",
"deactivatedTime": null
}
],
"properties": [],
"fired": null,
"isSubscribed": true,
"invitedUser": null,
"phoneVerified": true,
"emailVerified": true,
"referralUsers": [],
"loginInfo": {
"ip": "127.0.0.1",
"latitude": "41.3392896",
"longitude": "69.29940479999999"
}
}Profile object
Attributes
| Attribute | Description |
|---|---|
| id | ID профиля |
| fullName | Полное имя |
| firstName | Имя |
| lastName | Фамилия |
| middleName | Отчество |
| phoneNumbers | Номер телефона array |
| birthDate | Дата рождения |
| notes | Заметка |
| gender | Пол male или female |
| photos | Фотографии профиля array Image |
Response
Result
{
"fullName": "John Doe",
"id": 126344,
"firstName": "John",
"lastName": "Doe",
"middleName": null,
"phoneNumbers": [
"+998 90 999 99 99"
],
"birthDate": "1976-07-10",
"notes": null,
"gender": "male",
"photos": [
{
"id": 131,
"originalName": "blog-img-10",
"createdAt": "2019-04-10 17:39:39",
"updatedAt": "2019-04-10 17:39:39",
"urls": {
"50x_": "http://demo.ox-sys.com/cache/50x_/image/b2/3e/1a/b23e1a4b724645608d6a9d4e272b10ca725c9ac82f33fd1305c41914644e80c9.jpg",
"100x_": "http://demo.ox-sys.com/cache/100x_/image/b2/3e/1a/b23e1a4b724645608d6a9d4e272b10ca725c9ac82f33fd1305c41914644e80c9.jpg",
"150x_": "http://demo.ox-sys.com/cache/150x_/image/b2/3e/1a/b23e1a4b724645608d6a9d4e272b10ca725c9ac82f33fd1305c41914644e80c9.jpg",
"300x_": "http://demo.ox-sys.com/cache/300x_/image/b2/3e/1a/b23e1a4b724645608d6a9d4e272b10ca725c9ac82f33fd1305c41914644e80c9.jpg",
"original": "http://demo.ox-sys.com/cache/original/image/b2/3e/1a/b23e1a4b724645608d6a9d4e272b10ca725c9ac82f33fd1305c41914644e80c9.jpg"
}
},
{
"id": 101,
"originalName": "Снимок экрана 2018-05-30 в 19.13.20",
"createdAt": "2018-07-02 19:27:14",
"updatedAt": "2018-07-02 19:27:14",
"urls": []
}
]
}Image object
Attributes
| Attribute | Description |
|---|---|
| id | ID изображения |
| originalName | Название изображения |
| createdAt | Дата и время создание datetime |
| updatedAt | Дата и время обновление datetime |
| urls | Размерная сетка с url адресом array |
Response
Result
{
"id": 131,
"originalName": "blog-img-10",
"createdAt": "2019-04-10 17:39:39",
"updatedAt": "2019-04-10 17:39:39",
"urls": {
"50x_": "http://demo.ox-sys.com/cache/50x_/image/b2/3e/1a/b23e1a4b724645608d6a9d4e272b10ca725c9ac82f33fd1305c41914644e80c9.jpg",
"100x_": "http://demo.ox-sys.com/cache/100x_/image/b2/3e/1a/b23e1a4b724645608d6a9d4e272b10ca725c9ac82f33fd1305c41914644e80c9.jpg",
"150x_": "http://demo.ox-sys.com/cache/150x_/image/b2/3e/1a/b23e1a4b724645608d6a9d4e272b10ca725c9ac82f33fd1305c41914644e80c9.jpg",
"300x_": "http://demo.ox-sys.com/cache/300x_/image/b2/3e/1a/b23e1a4b724645608d6a9d4e272b10ca725c9ac82f33fd1305c41914644e80c9.jpg",
"original": "http://demo.ox-sys.com/cache/original/image/b2/3e/1a/b23e1a4b724645608d6a9d4e272b10ca725c9ac82f33fd1305c41914644e80c9.jpg"
}
}Brand object
Attributes
| Attribute | Description |
|---|---|
| id | ID бренда |
| name | Название бренда |
| zone | Зона Zone |
| logo | Логотип Logo |
| variationPropertyPatterns | Список свойств вариации array |
| productPropertyPatterns | Список свойств продукта (характеристика) array |
| importPropertyPatterns | Список свойств прихода array |
| requiredFields | array |
| options | array |
| active | boolean |
Response
Result
{
"id": 4,
"zone": {
"currencies": [
"UZS",
"USD",
"EUR"
],
"id": 2,
"name": "Uzbekistan",
"primaryCurrency": "UZS",
"secondaryCurrencies": [
"USD",
"EUR"
],
"locationPropertyPatterns": [],
"roundingMode": "1",
"roundingTarget": "500",
"highlights": null,
"active": true
},
"name": "ANTIQUE Jewelery",
"uploadedFile": null,
"highlights": null,
"variationPropertyPatterns": [
{
"name": "Размер",
"type": "text",
"values": [],
"required": false
}
],
"productPropertyPatterns": [
{
"name": "Вес",
"type": "text",
"values": [],
"required": false
},
{
"name": "Производитель",
"type": "text",
"values": [],
"required": false
}
],
"importPropertyPatterns": [
{
"name": "номер прихода",
"type": "text",
"values": [],
"required": false
},
{
"name": "номер груза",
"type": "text",
"values": [],
"required": false
}
],
"requiredFields": [
"product_name",
"variation_name",
"category"
],
"options": {
"labelConfig": {
"sku": false,
"name": false,
"image": false,
"price": false,
"width": null,
"height": null,
"imageH": null,
"imageW": null,
"rotate": false,
"barcode": false,
"currency": false,
"discount": false,
"supplier": false,
"printStock": false,
"properties": false,
"labelFontSize": null,
"priceFontSize": null,
"discountPercent": null,
"discountFontSize": null
},
"postponeTimeout": null
},
"active": true
}Zone object
Response
Result
{
"currencies": [
"UZS",
"USD",
"EUR"
],
"id": 2,
"name": "Uzbekistan",
"primaryCurrency": "UZS",
"secondaryCurrencies": [
"USD",
"EUR"
],
"locationPropertyPatterns": [],
"roundingMode": "1",
"roundingTarget": "500",
"highlights": null,
"active": true
}Location object
Attributes
| Attribute | Description |
|---|---|
| id | location id |
| name | name |
| zone | Zone |
| brand | Brand |
| type | warehouse or shop |
| square | int |
| options |
|
| active | boolean |
| address | Address |
Response
Result
{
"id": 4,
"type": "warehouse",
"name": "Antique Склад 1",
"square": 9,
"oldAddress": [],
"brand": {
"id": 4,
"zone": {
"currencies": [
"UZS",
"USD",
"EUR"
],
"id": 2,
"name": "Uzbekistan",
"primaryCurrency": "UZS",
"secondaryCurrencies": [
"USD",
"EUR"
],
"locationPropertyPatterns": [],
"roundingMode": "1",
"roundingTarget": "500",
"highlights": null,
"active": true
},
"name": "ANTIQUE Jewelery",
"uploadedFile": null,
"highlights": null,
"variationPropertyPatterns": [
{
"name": "Размер",
"type": "text",
"values": [],
"required": false
}
],
"productPropertyPatterns": [
{
"name": "Вес",
"type": "text",
"values": [],
"required": false
},
{
"name": "Производитель",
"type": "text",
"values": [],
"required": false
}
],
"importPropertyPatterns": [
{
"name": "номер прихода",
"type": "text",
"values": [],
"required": false
},
{
"name": "номер груза",
"type": "text",
"values": [],
"required": false
}
],
"requiredFields": [
"product_name",
"variation_name",
"category"
],
"options": {
"labelConfig": {
"sku": false,
"name": false,
"image": false,
"price": false,
"width": null,
"height": null,
"imageH": null,
"imageW": null,
"rotate": false,
"barcode": false,
"currency": false,
"discount": false,
"supplier": false,
"printStock": false,
"properties": false,
"labelFontSize": null,
"priceFontSize": null,
"discountPercent": null,
"discountFontSize": null
},
"postponeTimeout": null
},
"active": true
},
"active": true,
"useDisplay": false,
"zone": {
"currencies": [
"UZS",
"USD",
"EUR"
],
"id": 2,
"name": "Uzbekistan",
"primaryCurrency": "UZS",
"secondaryCurrencies": [
"USD",
"EUR"
],
"locationPropertyPatterns": [],
"roundingMode": "1",
"roundingTarget": "500",
"highlights": null,
"active": true
},
"checkTemplate": null,
"highlights": null,
"options": {
"labelConfig": {
"sku": false,
"name": false,
"image": false,
"price": false,
"width": null,
"height": null,
"imageH": null,
"imageW": null,
"rotate": false,
"barcode": false,
"currency": false,
"discount": false,
"supplier": false,
"printStock": false,
"properties": false,
"labelFontSize": null,
"priceFontSize": null,
"discountPercent": null,
"discountFontSize": null
},
"postponeTimeout": null
},
"properties": [],
"accountCorrection": null,
"address": {
"id": 64,
"type": null,
"countryCode": "UZ",
"administrativeArea": "Tashkent city",
"locality": "Sirgali",
"dependentLocality": null,
"postalCode": "100000000",
"addressLine1": "ул. Бэвруел 93#",
"addressLine2": ",,",
"organization": null,
"latitude": null,
"longitude": null,
"houseNumber": null,
"floor": null,
"apartmentNumber": null
}
}Address object
Response
Result
{
"id": 64,
"type": null,
"countryCode": "UZ",
"administrativeArea": "Tashkent city",
"locality": "Sirgali",
"dependentLocality": null,
"postalCode": "100000000",
"addressLine1": "ул. Бэвруел 93#",
"addressLine2": ",,",
"organization": null,
"latitude": null,
"longitude": null,
"houseNumber": null,
"floor": null,
"apartmentNumber": null
}Settings object
Response
Response
{
"id": 28654,
"timezone": "Asia/Tashkent",
"locale": "ru",
"defaultSellLocation": null
}Variation object
Attributes
| Attribute | description |
|---|---|
| id | id variation |
| sku | sku product |
| barcode | of variation |
| supplier | code supplier |
| stocks |
|
| "ingredients" | [], |
| "name" | name |
| "shippable" | boolean |
| "taxable" | boolean |
| "cookable" | boolean |
| "sellable" | boolean |
| "countable" | boolean |
| "composite" | boolean |
| "product" | id of product |
| images |
|
| "unit" | "pcs","kg", "box", "meter" |
| "brand" | id Brand |
| "zone" | id Zone |
| "videos" |
|
| productProperties |
|
| lastUpdateTime | datetime |
| importProperties |
|
Response
Response
{
"sku": "13308",
"supplier": "ст9-21",
"category": 10,
"id": 1035,
"barcode": "764315038",
"stocks": [
{
"imported": "2018-08-17 17:14:53",
"id": "07fd85f4-345d-489d-9eb8-898d3bde35d0",
"location": 11,
"import": 39,
"originalImport": 39,
"transfer": null,
"transferCount": 0,
"importCount": 14,
"originalImportCount": 0,
"tracking": true,
"countable": true,
"composite": false,
"sellPrice": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00012658227848101267,
"USD/UZS": 7899.999999999999,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 220000,
"USD": 27.85,
"EUR": 24.18
},
"supplyPrice": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00012658227848101267,
"USD/UZS": 7899.999999999999,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 100000,
"USD": 12.66,
"EUR": 10.99
},
"properties": [
{
"name": "Приходной номер",
"value": "74561566"
}
],
"count": 0
},
{
"imported": "2018-08-17 17:14:53",
"id": "c5516755-1a94-4e74-a4a2-5732c77f3e07",
"location": 10,
"import": null,
"originalImport": 39,
"transfer": 69,
"transferCount": 2,
"importCount": null,
"originalImportCount": 0,
"tracking": true,
"countable": true,
"composite": false,
"sellPrice": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00012658227848101267,
"USD/UZS": 7899.999999999999,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 220000,
"USD": 27.85,
"EUR": 24.18
},
"supplyPrice": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00012658227848101267,
"USD/UZS": 7899.999999999999,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 100000,
"USD": 12.66,
"EUR": 10.99
},
"properties": [
{
"name": "Приходной номер",
"value": "74561566"
}
],
"count": 0
}
],
"ingredients": [],
"name": "Спортивный костюм",
"shippable": true,
"taxable": false,
"cookable": false,
"sellable": true,
"countable": true,
"composite": false,
"product": 1131,
"images": [
{
"id": 19,
"originalName": "BQ5864_02",
"createdAt": "2018-08-19 19:24:35",
"updatedAt": "2018-08-19 19:24:35",
"group": "",
"brand": 2,
"zone": 2,
"sort": 0,
"urls": []
}
],
"unit": "pcs",
"brand": 2,
"zone": 2,
"videos": [],
"properties": [
{
"name": "Цвет",
"value": "Оранжевый"
},
{
"name": "Размер",
"value": "46 48 50 52 54"
}
],
"productProperties": [
{
"id": "141146f6421f3d59ae5d77b1beb72efb",
"name": "Пол",
"value": "Мужской"
},
{
"id": "12ae2a12586001e30745cb0457586ae3",
"name": "Тип",
"value": "Костюм"
},
{
"id": "c134ef445d675a6cd7a6d86ebfc9cfbb",
"name": "Сезон",
"value": "SS18"
}
],
"area": null,
"importRecord": {
"id": 2134,
"import": 39,
"variation": 1035,
"initialCount": 0,
"approvals": [
{
"time": "2018-08-17 17:15:58",
"count": 14
}
],
"variationBarcode": "764315038",
"variationName": "Спортивный костюм",
"areaNames": [],
"variationShippable": true,
"variationTaxable": false,
"variationSellable": true,
"variationCountable": true,
"variationCookable": false,
"unit": "pcs",
"variationProperties": [
{
"name": "Цвет",
"value": "Оранжевый"
},
{
"name": "Размер",
"value": "46 48 50 52 54"
}
],
"productProperties": [
{
"name": "Пол",
"value": "Мужской"
},
{
"name": "Тип",
"value": "Костюм"
},
{
"name": "Сезон",
"value": "Зима"
}
],
"productSku": "13308",
"productName": "Спортивный костюм ТКАНЬ 100% ХЛОПОК",
"productDescription": null,
"supplierName": "ст9-21",
"categoryNames": [
"Мужская одежда",
"Спортивные костюмы"
],
"count": 14,
"stockTracking": true,
"stockSellPrice": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00012658227848101267,
"USD/UZS": 7899.999999999999,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 220000,
"USD": 27.85,
"EUR": 24.18
},
"stockSupplyPrice": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00012658227848101267,
"USD/UZS": 7899.999999999999,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 100000,
"USD": 12.66,
"EUR": 10.99
},
"stockProperties": [
{
"name": "Приходной номер",
"value": "74561566"
}
],
"applied": false,
"diffs": [],
"ingredients": [],
"productTags": [],
"orderPropertyPrices": [],
"landedCostPrice": null,
"landedCosts": null
},
"lastUpdateTime": "2018-08-19 19:24:35",
"uploadedImages": [],
"innerHitIds": null,
"importProperties": [
{
"name": "Приходной номер",
"value": "74561566"
}
]
}Stock object
Response
Response
{
"imported": "2018-08-17 17:14:53",
"id": "c5516755-1a94-4e74-a4a2-5732c77f3e07",
"location": 10,
"import": null,
"originalImport": 39,
"transfer": 69,
"transferCount": 2,
"importCount": null,
"originalImportCount": 0,
"tracking": true,
"countable": true,
"composite": false,
"sellPrice": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00012658227848101267,
"USD/UZS": 7899.999999999999,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 220000,
"USD": 27.85,
"EUR": 24.18
},
"supplyPrice": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00012658227848101267,
"USD/UZS": 7899.999999999999,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 100000,
"USD": 12.66,
"EUR": 10.99
},
"properties": [
{
"name": "Приходной номер",
"value": "74561566"
}
],
"count": 0
}Price object
Response
Response
{
"first": "UZS",
"ratio": {
"UZS/USD": 0.00012658227848101267,
"USD/UZS": 7899.999999999999,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 100000,
"USD": 12.66,
"EUR": 10.99
}Property object
Response
Response
{
"name": "Приходной номер",
"value": "74561566"
}Supplier object
Response
Response
"id": 19,
"name": "Supplier",
"logo": null,
"brand": 2,
"zone": 2,
"highlights": nullCategory object
Response
Response
"children": [],
"highlights": null,
"icon": null,
"id": 10,
"images": [],
"level": 1,
"name": "Спортивные костюмы",
"parent": null,
"path": "10,",
"tags": [],
"zone": 2Sell object
Response
| Attribute | Description |
|---|---|
| id | id sell |
| type | pos or shop |
| possiblePickupTime | |
| status | |
| note | |
| count | total count items |
| time | datetime |
| zone | id of zone |
| casdesk | Cashdeks |
| user | id of cashier |
| "draft" | boolean |
| "takeAway" | boolean |
| "wasDebit" | boolean |
| "updatedTime" | datetime |
| "finishedTime" | datetime |
| "shippingAddress" | |
| "billingAddress" | |
| "customer" | Customer |
| "mode" | |
| "cardActivated" | boolean |
| sellRecords | array of sell records |
| refundRecords | array of sell refund records |
{
"isPostpone": false,
"sellRecords": [
{
"id": 9360,
"count": 1,
"movedCount": 1,
"price": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00012658227848101267,
"USD/UZS": 7899.999999999999,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 220000,
"USD": 27.85,
"EUR": 24.18
},
"sell": 6534,
"variation": 1043,
"stock": "4b962f30-cd30-451f-981f-578ace72d834",
"subtotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 220000,
"USD": 26.04,
"EUR": 24.18
},
"discount": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 100000,
"USD": 11.83,
"EUR": 10.99
},
"total": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 120000,
"USD": 14.2,
"EUR": 13.19
},
"finalPrice": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 120000,
"USD": 14.2,
"EUR": 13.19
},
"debit": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"offerBindings": [
{
"id": 9135,
"applied": true,
"offer": {
"id": 53,
"type": "total_fixed_discount",
"config": {
"fixedDiscount": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 100000,
"USD": 11.83,
"EUR": 10.99
},
"sell": 6534
},
"promotion": 36,
"autoApplicable": true,
"level": 1
},
"discount": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 100000,
"USD": 11.83,
"EUR": 10.99
},
"count": 1,
"enabled": true,
"errors": null,
"hash": null
}
],
"refundRecords": [
{
"sellRecordSell": 6534,
"id": 883,
"count": 1,
"sell": {
"isPostpone": false,
"sellRecords": [],
"possiblePickupTime": null,
"type": "pos",
"sellSeats": [],
"status": "pending",
"id": 6535,
"note": null,
"count": 0,
"time": "2019-06-19 18:05:36",
"zone": 2,
"cashdesk": {
"id": 12,
"name": "Тестовая касса",
"sellKey": "WN",
"fingerprint": "4ec7fd5991853d4050d543572389ce89",
"appId": null,
"active": true,
"type": 1,
"paymentMethods": [
{
"id": 3,
"name": "Наличные",
"icon": "/domains/payment/images/icons/CASH.png",
"description": null,
"active": true,
"config": [],
"gatewayConfig": {
"id": null,
"key": null,
"testKey": null,
"testMode": false,
"apiVersion": null
},
"cash": true,
"wallet": false,
"weight": 0,
"zone": 2,
"company": 23,
"highlights": null
}
],
"cashAccount": {
"id": 4,
"name": "Главный сейф",
"properties": [
{
"name": "1",
"value": "1"
}
]
},
"online": false,
"nonCashAccount": {
"id": 3,
"name": "ЧП \"GOOLEAR\"",
"properties": [
{
"name": "МФО",
"value": "3244"
},
{
"name": "РС",
"value": "1009930084842"
}
]
},
"lastSyncTime": "2019-06-19 18:03:28",
"uploadedFile": null,
"referralAccess": false,
"markets": [],
"address": {
"id": 213,
"type": null,
"countryCode": "UZ",
"administrativeArea": "Tashkent city",
"locality": "Bektemir",
"dependentLocality": null,
"postalCode": null,
"addressLine1": "1",
"addressLine2": ",,",
"organization": null,
"latitude": null,
"longitude": null,
"houseNumber": null,
"floor": null,
"apartmentNumber": null
}
},
"shift": {
"id": 160,
"cashdesk": 12,
"openTime": "2018-12-03 16:57:13",
"closeTime": null,
"user": 117152,
"transactions": [],
"desktopApp": null,
"sells": null,
"sellPicks": null,
"total": null,
"allPaymentsByMethod": [],
"debits": [],
"encashment": null,
"cashBalance": null
},
"user": 117152,
"draft": true,
"takeAway": false,
"wasDebit": false,
"updatedTime": "2019-06-19 18:14:19",
"finishedTime": null,
"shippingAddress": null,
"billingAddress": null,
"customer": null,
"mode": "location",
"cardActivated": false,
"refundRecords": [
null
],
"subtotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": -220000,
"USD": -26.04,
"EUR": -24.18
},
"total": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": -120000,
"USD": -14.2,
"EUR": -13.19
},
"debit": null,
"sellSubtotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"sellTotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"refundSubtotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": -220000,
"USD": -26.04,
"EUR": -24.18
},
"refundTotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 120000,
"USD": 14.2,
"EUR": 13.19
},
"discount": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"payments": [
{
"id": 4768,
"status": "finished",
"paymentMethod": 3,
"price": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 120000,
"USD": 14.2,
"EUR": 13.19
},
"type": "refund",
"time": null,
"paymentDetails": [],
"totalLeftToPay": null,
"subtotalLeftToPay": null
}
],
"assistants": [],
"generatedCoupons": [],
"activatedCoupons": [],
"startTime": null,
"expireTime": null,
"releasedTime": null,
"shippingService": null,
"pickupLocation": null,
"shippingTime": null,
"shippingPrice": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"recipient": null,
"guestQty": 0,
"printKey": null,
"syncTime": "2019-06-19 18:14:19",
"manualDiscount": [],
"isDebt": false
},
"sellRecord": 9360,
"variation": 1043,
"stock": null,
"price": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 120000,
"USD": 14.2,
"EUR": 13.19
},
"originalPrice": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00012658227848101267,
"USD/UZS": 7899.999999999999,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 220000,
"USD": 27.85,
"EUR": 24.18
},
"total": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 120000,
"USD": 14.2,
"EUR": 13.19
},
"subtotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 220000,
"USD": 26.04,
"EUR": 24.18
},
"note": null,
"movedCount": 0,
"location": 11,
"brand": 2,
"zone": 2
}
],
"brand": 2,
"zone": 2,
"location": 11,
"path": "9360,",
"level": 1,
"parent": null,
"children": [],
"cookies": []
}
],
"possiblePickupTime": null,
"type": "pos",
"sellSeats": [],
"status": "cart",
"id": 6534,
"note": null,
"count": 1,
"time": "2019-06-19 18:00:52",
"zone": 2,
"cashdesk": {
"id": 12,
"name": "Тестовая касса",
"sellKey": "WN",
"fingerprint": "4ec7fd5991853d4050d543572389ce89",
"appId": null,
"active": true,
"type": 1,
"paymentMethods": [
{
"id": 3,
"name": "Наличные",
"icon": "/domains/payment/images/icons/CASH.png",
"description": null,
"active": true,
"config": [],
"gatewayConfig": {
"id": null,
"key": null,
"testKey": null,
"testMode": false,
"apiVersion": null
},
"cash": true,
"wallet": false,
"weight": 0,
"zone": 2,
"company": 23,
"highlights": null
}
],
"cashAccount": {
"id": 4,
"name": "Главный сейф",
"properties": [
{
"name": "1",
"value": "1"
}
]
},
"online": false,
"nonCashAccount": {
"id": 3,
"name": "ЧП \"GOOLEAR\"",
"properties": [
{
"name": "МФО",
"value": "3244"
},
{
"name": "РС",
"value": "1009930084842"
}
]
},
"lastSyncTime": "2019-06-19 18:03:28",
"uploadedFile": null,
"referralAccess": false,
"markets": [],
"address": {
"id": 213,
"type": null,
"countryCode": "UZ",
"administrativeArea": "Tashkent city",
"locality": "Bektemir",
"dependentLocality": null,
"postalCode": null,
"addressLine1": "1",
"addressLine2": ",,",
"organization": null,
"latitude": null,
"longitude": null,
"houseNumber": null,
"floor": null,
"apartmentNumber": null
}
},
"shift": {
"id": 160,
"cashdesk": 12,
"openTime": "2018-12-03 16:57:13",
"closeTime": null,
"user": 117152,
"transactions": [],
"desktopApp": null,
"sells": null,
"sellPicks": null,
"total": null,
"allPaymentsByMethod": [],
"debits": [],
"encashment": null,
"cashBalance": null
},
"user": 117152,
"draft": false,
"takeAway": false,
"wasDebit": false,
"updatedTime": "2019-06-19 18:03:29",
"finishedTime": "2019-06-19 18:03:28",
"shippingAddress": null,
"billingAddress": null,
"customer": null,
"mode": "location",
"cardActivated": false,
"refundRecords": [],
"subtotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 220000,
"USD": 26.04,
"EUR": 24.18
},
"total": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 120000,
"USD": 14.2,
"EUR": 13.19
},
"debit": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"sellSubtotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 220000,
"USD": 26.04,
"EUR": 24.18
},
"sellTotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 120000,
"USD": 14.2,
"EUR": 13.19
},
"refundSubtotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"refundTotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"discount": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 100000,
"USD": 11.83,
"EUR": 10.99
},
"payments": [
{
"id": 4767,
"status": "finished",
"paymentMethod": 3,
"price": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 120000,
"USD": 14.2,
"EUR": 13.19
},
"type": "sell",
"time": "2019-06-19 18:03:28",
"paymentDetails": [],
"totalLeftToPay": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"subtotalLeftToPay": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 100000,
"USD": 11.83,
"EUR": 10.99
}
}
],
"assistants": [],
"generatedCoupons": [],
"activatedCoupons": [],
"startTime": null,
"expireTime": null,
"releasedTime": null,
"shippingService": null,
"pickupLocation": null,
"shippingTime": null,
"shippingPrice": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"recipient": null,
"guestQty": null,
"printKey": null,
"syncTime": "2019-06-19 18:03:29",
"manualDiscount": {
"discount": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 100000,
"USD": 11.83,
"EUR": 10.99
},
"type": "amount",
"sum": true
},
"isDebt": false
}Sell record object
Response
Response
{
"id": 9360,
"count": 1,
"movedCount": 1,
"deleted": false,
"price": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00012658227848101267,
"USD/UZS": 7899.999999999999,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 220000,
"USD": 27.85,
"EUR": 24.18
},
"sell": 6534,
"variation": 1043,
"stock": "4b962f30-cd30-451f-981f-578ace72d834",
"subtotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 220000,
"USD": 26.04,
"EUR": 24.18
},
"discount": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 100000,
"USD": 11.83,
"EUR": 10.99
},
"total": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 120000,
"USD": 14.2,
"EUR": 13.19
},
"finalPrice": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 120000,
"USD": 14.2,
"EUR": 13.19
},
"debit": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"offerBindings": [
{
"id": 9135,
"applied": true,
"offer": {
"id": 53,
"type": "total_fixed_discount",
"config": {
"fixedDiscount": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 100000,
"USD": 11.83,
"EUR": 10.99
},
"sell": 6534
},
"promotion": 36,
"autoApplicable": true,
"level": 1
},
"discount": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 100000,
"USD": 11.83,
"EUR": 10.99
},
"count": 1,
"enabled": true,
"errors": null,
"hash": null
}
],
"refundRecords": [
{
"sellRecordSell": 6534,
"id": 883,
"count": 1,
"sell": {
"isPostpone": false,
"sellRecords": [],
"possiblePickupTime": null,
"type": "pos",
"sellSeats": [],
"status": "pending",
"id": 6535,
"note": null,
"count": 0,
"time": "2019-06-19 18:05:36",
"zone": 2,
"cashdesk": {
"id": 12,
"name": "Тестовая касса",
"sellKey": "WN",
"fingerprint": "4ec7fd5991853d4050d543572389ce89",
"appId": null,
"active": true,
"type": 1,
"paymentMethods": [
{
"id": 3,
"name": "Наличные",
"icon": "/domains/payment/images/icons/CASH.png",
"description": null,
"active": true,
"config": [],
"gatewayConfig": {
"id": null,
"key": null,
"testKey": null,
"testMode": false,
"apiVersion": null
},
"cash": true,
"wallet": false,
"weight": 0,
"zone": 2,
"company": 23,
"highlights": null
}
],
"cashAccount": {
"id": 4,
"name": "Главный сейф",
"properties": [
{
"name": "1",
"value": "1"
}
]
},
"online": false,
"nonCashAccount": {
"id": 3,
"name": "ЧП \"GOOLEAR\"",
"properties": [
{
"name": "МФО",
"value": "3244"
},
{
"name": "РС",
"value": "1009930084842"
}
]
},
"lastSyncTime": "2019-06-19 18:03:28",
"uploadedFile": null,
"referralAccess": false,
"markets": [],
"address": {
"id": 213,
"type": null,
"countryCode": "UZ",
"administrativeArea": "Tashkent city",
"locality": "Bektemir",
"dependentLocality": null,
"postalCode": null,
"addressLine1": "1",
"addressLine2": ",,",
"organization": null,
"latitude": null,
"longitude": null,
"houseNumber": null,
"floor": null,
"apartmentNumber": null
}
},
"shift": {
"id": 160,
"cashdesk": 12,
"openTime": "2018-12-03 16:57:13",
"closeTime": null,
"user": 117152,
"transactions": [],
"desktopApp": null,
"sells": null,
"sellPicks": null,
"total": null,
"allPaymentsByMethod": [],
"debits": [],
"encashment": null,
"cashBalance": null
},
"user": 117152,
"draft": true,
"takeAway": false,
"wasDebit": false,
"updatedTime": "2019-06-19 18:14:19",
"finishedTime": null,
"shippingAddress": null,
"billingAddress": null,
"customer": null,
"mode": "location",
"cardActivated": false,
"refundRecords": [
null
],
"subtotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": -220000,
"USD": -26.04,
"EUR": -24.18
},
"total": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": -120000,
"USD": -14.2,
"EUR": -13.19
},
"debit": null,
"sellSubtotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"sellTotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"refundSubtotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": -220000,
"USD": -26.04,
"EUR": -24.18
},
"refundTotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 120000,
"USD": 14.2,
"EUR": 13.19
},
"discount": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"payments": [
{
"id": 4768,
"status": "finished",
"paymentMethod": 3,
"price": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 120000,
"USD": 14.2,
"EUR": 13.19
},
"type": "refund",
"time": null,
"paymentDetails": [],
"totalLeftToPay": null,
"subtotalLeftToPay": null
}
],
"assistants": [],
"generatedCoupons": [],
"activatedCoupons": [],
"startTime": null,
"expireTime": null,
"releasedTime": null,
"shippingService": null,
"pickupLocation": null,
"shippingTime": null,
"shippingPrice": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 0,
"USD": 0,
"EUR": 0
},
"recipient": null,
"guestQty": 0,
"printKey": null,
"syncTime": "2019-06-19 18:14:19",
"manualDiscount": [],
"isDebt": false
},
"sellRecord": 9360,
"variation": 1043,
"stock": null,
"price": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 120000,
"USD": 14.2,
"EUR": 13.19
},
"originalPrice": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00012658227848101267,
"USD/UZS": 7899.999999999999,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 220000,
"USD": 27.85,
"EUR": 24.18
},
"total": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 120000,
"USD": 14.2,
"EUR": 13.19
},
"subtotal": {
"first": "UZS",
"ratio": {
"UZS/USD": 0.00011834319526627219,
"USD/UZS": 8450,
"UZS/EUR": 0.00010989010989010989,
"EUR/UZS": 9100
},
"order": [
"UZS",
"USD",
"EUR"
],
"UZS": 220000,
"USD": 26.04,
"EUR": 24.18
},
"note": null,
"movedCount": 0,
"location": 11,
"brand": 2,
"zone": 2
}
],
"brand": 2,
"zone": 2,
"location": 11,
"path": "9360,",
"level": 1,
"parent": null,
"children": [],
"cookies": []
}Supplier object
Response
{
"page": 1,
"items": [
{
"id": 1564,
"name": "Base supplier",
"logo": null,
"brand": 15,
"zone": 13,
"highlights": null
},
{
"id": 1301,
"name": "Neo_007",
"logo": {
"id": 142,
"originalName": "car_007",
"createdAt": "2020-02-03 16:37:55",
"updatedAt": "2020-02-03 16:37:55",
"urls": {
"50x_": "https:\/\/files.ox-sys.com\/cache\/50x_\/image\/47\/67\/a1\/4767a1a9559010d85899433d76170377ff40f94eeebe5fb130ad3d55f262a882.png",
"100x_": "https:\/\/files.ox-sys.com\/cache\/100x_\/image\/47\/67\/a1\/4767a1a9559010d85899433d76170377ff40f94eeebe5fb130ad3d55f262a882.png",
"150x_": "https:\/\/files.ox-sys.com\/cache\/150x_\/image\/47\/67\/a1\/4767a1a9559010d85899433d76170377ff40f94eeebe5fb130ad3d55f262a882.png",
"300x_": "https:\/\/files.ox-sys.com\/cache\/300x_\/image\/47\/67\/a1\/4767a1a9559010d85899433d76170377ff40f94eeebe5fb130ad3d55f262a882.png",
"original": "https:\/\/files.ox-sys.com\/cache\/original\/image\/47\/67\/a1\/4767a1a9559010d85899433d76170377ff40f94eeebe5fb130ad3d55f262a882.png"
}
},
"brand": 48,
"zone": 13,
"highlights": null
},
{
"id": 143,
"name": "Fruits&Passion",
"logo": null,
"brand": 15,
"zone": 13,
"highlights": null
}
],
"total_count": 32
}Correction record object
Attributes
| Attribute | Type |
|---|---|
| variation | int |
| count | float |
Example
{
"variation": 2,
"count": 3
}Transfer record object
Attributes
| Attribute | Type |
|---|---|
| variation | int |
| count | float |
Example
{
"variation": 2,
"count": 3
}Refunds record object
Attributes
| Attribute | Type |
|---|---|
| variation | int |
| location | int |
| count | float |
Example
{
"location": 1,
"sellRecord": 215,
"count": 1
}Variation properties object
Attributes
| Attribute | Type |
|---|---|
| name | string |
| value | string |
Example
{
"name": "Size",
"value": "XL"
}Import record object
{
"id": 70628,
"import": 3777,
"variation": null,
"initialCount": 0,
"approvals": [],
"variationBarcode": "4788645796881",
"variationName": "Nike sneakers Blue",
"areaNames": [],
"variationShippable": true,
"variationTaxable": false,
"variationSellable": true,
"variationCountable": true,
"variationCookable": false,
"variationScalable": false,
"unit": "pcs",
"variationProperties": [
{
"name": "Цвет",
"value": "Blue"
}
],
"productProperties": [],
"productSku": "8DG5UX6QIH",
"productName": "Nike sneakers",
"productDescription": "",
"supplierName": "Nike",
"categoryNames": "Boots",
"count": 10,
"stockTracking": false,
"stockSellPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 8.333333333333333e-5,
"USD\/UZS": 12000
},
"order": [
"UZS",
"USD"
],
"UZS": 172800,
"USD": 14.4
},
"stockSupplyPrice": {
"first": "USD",
"ratio": {
"USD\/UZS": 12000,
"UZS\/USD": 8.333333333333333e-5
},
"order": [
"USD",
"UZS"
],
"USD": 4,
"UZS": 48000
},
"stockProperties": [],
"applied": false,
"diffs": null,
"ingredients": [],
"productTags": [],
"orderPropertyPrices": null,
"landedCostPrice": {
"first": "USD",
"ratio": {
"USD\/UZS": 12000,
"UZS\/USD": 8.333333333333333e-5
},
"order": [
"USD",
"UZS"
],
"USD": 4,
"UZS": 48000
},
"stockExpirationDate": null,
"stock": null,
"landedCosts": null,
"images": [],
"uploadedImages": []
}Update payment object
Attributes
| Attribute | Type |
|---|---|
| paymentMethod | int |
| price | number |
| type | string sell or refund |
| time | datetime |
Sell payment response
{
"id": 1452291,
"status": "finished",
"paymentMethod": 114,
"price": {
"first": "UZS",
"ratio": {
"UZS\/USD": 8.333333333333333e-5,
"USD\/UZS": 12000
},
"order": [
"UZS",
"USD"
],
"UZS": 82000,
"USD": 6.83
},
"type": "sell",
"time": "2023-01-10 14:23:00",
"paymentDetails": [],
"totalLeftToPay": {
"first": "UZS",
"UZS": 0,
"USD": 0
},
"subtotalLeftToPay": {
"first": "UZS",
"ratio": {
"UZS\/USD": 8.333333333333333e-5,
"USD\/UZS": 12000
},
"order": [
"UZS",
"USD"
],
"UZS": 0,
"USD": 0
},
"transaction": null,
"shift": 1919
}Promotion object
{
"time": "2023-06-06 17:09:55",
"id": 178,
"name": "Payment NonCash",
"description": null,
"active": true,
"approved": true,
"actualRevision": null,
"rules": [
{
"id": 184,
"type": "payment_method",
"config": {
"paymentMethods": [
82,
88
]
},
"promotion": null
},
{
"id": 185,
"type": "time",
"config": {
"time": {
"min": "2023-06-04 17:10:11",
"max": "2023-06-30 17:10:20"
}
},
"promotion": null
}
],
"offers": [
{
"id": 398,
"type": "fixed_price",
"config": {
"name": [],
"name_exclude": false,
"barcode": [],
"barcode_exclude": false,
"sku": [],
"sku_exclude": false,
"category": [],
"category_exclude": false,
"supplier": [],
"exclude_supplier": false,
"expireTime": {
"number": null,
"time": null
},
"exirationDateRange": {
"min": null,
"max": null
},
"price": {
"min": null,
"max": null
},
"properties": [],
"excludeProperties": false,
"product_properties": [],
"excludeProductProperties": false,
"import_properties": [],
"exclude_import_properties": false,
"fixedPrice": {
"first": "UZS",
"ratio": {
"UZS\/USD": 8.333333333333333e-5,
"USD\/UZS": 12000
},
"order": [
"UZS",
"USD"
],
"UZS": 1000,
"USD": 0.08
},
"sum": true,
"count": 1,
"each": true
},
"promotion": 178,
"autoApplicable": true,
"level": 1
}
],
"cashdesks": [
47,
65
],
"markets": [],
"marketIds": null,
"locations": [
68,
96,
79,
42
],
"brands": [
15
],
"zone": 13,
"highlights": null,
"system": false,
"originalId": null
}Errors
The Kittn API uses the following error codes:
| 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 |
| 418 | I'm a teapot |
| 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. |