SmartSatu Knowledge Base - Вклад участника [ru]

API Counterparties

2024-11-25T14:50:17Z

User: /* Описание */

==Обзор==
Данный документа описывает методы для работы поставщика/дистрибьютора по получению списка Торговых точек из системы Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/counterparties/ Schemes : HTTPS''

==Методы==
'''Получение списка торговых точек'''

GET /counterparties
==Описание==
Для получения списка из 20-ти первых торговых точек из системы Smart Satu, отправьте GET-запрос по следующему URL:
https://food.smartsatu.com/api/counterparties

Для получения последующих записей используйте параметр "page", который указывает номер страницы. Пример:
https://food.smartsatu.com/api/counterparties?page=2

Вы можете отфильтровать список контрагентов, используя параметр "updated_from". Этот параметр возвращает записи, созданные или измененные начиная с указанного времени в формате Y-m-d\TH:i:s. Пример:
https://food.smartsatu.com/api/counterparties?updated_from=2024-11-24T11:05:04

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
===Параметры===
====Ответы====
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Counterparties#Response_Counterparties Response Counterparties]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Counterparties#401 401]
|}

'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Response Counterparties===
'''200'''

'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор
| integer
| 80
|-
| style="font-weight:bold;" | name
| Название торговой точки
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conacts
| Массив
| <contacts> array
|
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| AZ0123456789
|-
| style="font-weight:bold;" | ucs
| Уникальный идентификатор ТТ у поставщика (пр. GUID)
| string
| AZ0123456789
|}
'''Contacts'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| 78000000001
|-
| style="font-weight:bold;" | person
| Персона (Контактное лицо)
| string
| Гайка
|-
| style="font-weight:bold;" | ext
| Дополнительный номер
| string
| 123
|-
| style="font-weight:bold;" | type
| Тип контакта
| string
|
|}
Пример ответа:
{
"Items": [
{
"id": 80,
"name": "ИП \"Чип и Дейл\" | маг. \"Рокфор\"",
"address": "Алматы, Байзакова, 125/185",
"contacts": [
{
"phone": "78000000001",
"person": "Гайка",
"ext": "123",
"type": " "
}
],
"type": "store",
"tin": "AZ0123456789"
"ucs": "AZ0123456789"
}
]
}

===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название торговой точки
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
|
|}
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

API Counterparties

2024-11-25T14:47:24Z

User: /* Описание */

==Обзор==
Данный документа описывает методы для работы поставщика/дистрибьютора по получению списка Торговых точек из системы Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/counterparties/ Schemes : HTTPS''

==Методы==
'''Получение списка торговых точек'''

GET /counterparties
==Описание==
Для получения списка из 20-ти первых торговых точек из системы Smart Satu, отправьте GET-запрос по следующему URL:
https://food.smartsatu.com/api/counterparties

Для получения последующих записей используйте параметр "page", который указывает номер страницы. Пример:
https://food.smartsatu.com/api/counterparties?page=2
Этот запрос вернет 20 следующих контрагентов со второй страницы.

Вы можете отфильтровать список контрагентов, используя параметр "updated_from". Этот параметр возвращает записи, созданные или измененные начиная с указанного времени в формате Y-m-d\TH:i:s. Пример:
https://food.smartsatu.com/api/counterparties?updated_from=2024-11-24T11:05:04

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
===Параметры===
====Ответы====
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Counterparties#Response_Counterparties Response Counterparties]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Counterparties#401 401]
|}

'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Response Counterparties===
'''200'''

'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор
| integer
| 80
|-
| style="font-weight:bold;" | name
| Название торговой точки
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conacts
| Массив
| <contacts> array
|
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| AZ0123456789
|-
| style="font-weight:bold;" | ucs
| Уникальный идентификатор ТТ у поставщика (пр. GUID)
| string
| AZ0123456789
|}
'''Contacts'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| 78000000001
|-
| style="font-weight:bold;" | person
| Персона (Контактное лицо)
| string
| Гайка
|-
| style="font-weight:bold;" | ext
| Дополнительный номер
| string
| 123
|-
| style="font-weight:bold;" | type
| Тип контакта
| string
|
|}
Пример ответа:
{
"Items": [
{
"id": 80,
"name": "ИП \"Чип и Дейл\" | маг. \"Рокфор\"",
"address": "Алматы, Байзакова, 125/185",
"contacts": [
{
"phone": "78000000001",
"person": "Гайка",
"ext": "123",
"type": " "
}
],
"type": "store",
"tin": "AZ0123456789"
"ucs": "AZ0123456789"
}
]
}

===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название торговой точки
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
|
|}
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

API Counterparties

2024-11-25T14:29:56Z

User: /* Описание */

==Обзор==
Данный документа описывает методы для работы поставщика/дистрибьютора по получению списка Торговых точек из системы Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/counterparties/ Schemes : HTTPS''

==Методы==
'''Получение списка торговых точек'''

GET /counterparties
==Описание==
Для получения списка всех торговых точек из системы Smart Satu необходимо отправить GET-запрос:
https://food.smartsatu.com/api/counterparties

Ответом от сервера будет являться массив данных со списком первых 20-ти контрагентов системы. Запрос остальных контрагентов следует выполнять с использованием параметра "page=xx", который вернет еще 20 контрагентов с указанной страницы:
https://food.smartsatu.com/api/counterparties?page=2

Список может быть отфильтрован с использованием параметра "updated_from=Y-m-d\TH:i:s", который вернет созданные/измененные записи за период, указанный в "updated_from":
https://food.smartsatu.com/api/counterparties?updated_from=2024-11-24T11:05:04

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
===Параметры===
====Ответы====
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Counterparties#Response_Counterparties Response Counterparties]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Counterparties#401 401]
|}

'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Response Counterparties===
'''200'''

'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор
| integer
| 80
|-
| style="font-weight:bold;" | name
| Название торговой точки
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conacts
| Массив
| <contacts> array
|
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| AZ0123456789
|-
| style="font-weight:bold;" | ucs
| Уникальный идентификатор ТТ у поставщика (пр. GUID)
| string
| AZ0123456789
|}
'''Contacts'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| 78000000001
|-
| style="font-weight:bold;" | person
| Персона (Контактное лицо)
| string
| Гайка
|-
| style="font-weight:bold;" | ext
| Дополнительный номер
| string
| 123
|-
| style="font-weight:bold;" | type
| Тип контакта
| string
|
|}
Пример ответа:
{
"Items": [
{
"id": 80,
"name": "ИП \"Чип и Дейл\" | маг. \"Рокфор\"",
"address": "Алматы, Байзакова, 125/185",
"contacts": [
{
"phone": "78000000001",
"person": "Гайка",
"ext": "123",
"type": " "
}
],
"type": "store",
"tin": "AZ0123456789"
"ucs": "AZ0123456789"
}
]
}

===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название торговой точки
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
|
|}
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

API Counterparties

2024-11-25T14:24:29Z

User: /* Описание */

==Обзор==
Данный документа описывает методы для работы поставщика/дистрибьютора по получению списка Торговых точек из системы Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/counterparties/ Schemes : HTTPS''

==Методы==
'''Получение списка торговых точек'''

GET /counterparties
==Описание==
Для получения списка всех торговых точек из системы Smart Satu необходимо отправить GET-запрос:
https://food.smartsatu.com/api/counterparties

Ответом от сервера будет являться массив данных со списком первых 20-ти контрагентов системы. Запрос остальных контрагентов следует выполнять с использованием параметра "page=xx", который вернет еще 20 контрагентов с указанной страницы:
https://food.smartsatu.com/api/counterparties?page=2

Список может быть отфильтрован с использованием параметра "updated_from=Y-m-d\TH:i:s", который вернет созданных/измененных контрагентов за период, указанный в "updated_from":
https://food.smartsatu.com/api/counterparties?updated_from=2024-11-24T11:05:04

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
===Параметры===
====Ответы====
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Counterparties#Response_Counterparties Response Counterparties]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Counterparties#401 401]
|}

'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Response Counterparties===
'''200'''

'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор
| integer
| 80
|-
| style="font-weight:bold;" | name
| Название торговой точки
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conacts
| Массив
| <contacts> array
|
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| AZ0123456789
|-
| style="font-weight:bold;" | ucs
| Уникальный идентификатор ТТ у поставщика (пр. GUID)
| string
| AZ0123456789
|}
'''Contacts'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| 78000000001
|-
| style="font-weight:bold;" | person
| Персона (Контактное лицо)
| string
| Гайка
|-
| style="font-weight:bold;" | ext
| Дополнительный номер
| string
| 123
|-
| style="font-weight:bold;" | type
| Тип контакта
| string
|
|}
Пример ответа:
{
"Items": [
{
"id": 80,
"name": "ИП \"Чип и Дейл\" | маг. \"Рокфор\"",
"address": "Алматы, Байзакова, 125/185",
"contacts": [
{
"phone": "78000000001",
"person": "Гайка",
"ext": "123",
"type": " "
}
],
"type": "store",
"tin": "AZ0123456789"
"ucs": "AZ0123456789"
}
]
}

===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название торговой точки
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
|
|}
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

API Counterparties

2024-11-25T14:12:35Z

User: /* Безопасность */

==Обзор==
Данный документа описывает методы для работы поставщика/дистрибьютора по получению списка Торговых точек из системы Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/counterparties/ Schemes : HTTPS''

==Методы==
'''Получение списка торговых точек'''

GET /counterparties
==Описание==
Для получения списка всех торговых точек из системы Smart Satu необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/counterparties.
==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
===Параметры===
====Ответы====
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Counterparties#Response_Counterparties Response Counterparties]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Counterparties#401 401]
|}

'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Response Counterparties===
'''200'''

'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор
| integer
| 80
|-
| style="font-weight:bold;" | name
| Название торговой точки
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conacts
| Массив
| <contacts> array
|
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| AZ0123456789
|-
| style="font-weight:bold;" | ucs
| Уникальный идентификатор ТТ у поставщика (пр. GUID)
| string
| AZ0123456789
|}
'''Contacts'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| 78000000001
|-
| style="font-weight:bold;" | person
| Персона (Контактное лицо)
| string
| Гайка
|-
| style="font-weight:bold;" | ext
| Дополнительный номер
| string
| 123
|-
| style="font-weight:bold;" | type
| Тип контакта
| string
|
|}
Пример ответа:
{
"Items": [
{
"id": 80,
"name": "ИП \"Чип и Дейл\" | маг. \"Рокфор\"",
"address": "Алматы, Байзакова, 125/185",
"contacts": [
{
"phone": "78000000001",
"person": "Гайка",
"ext": "123",
"type": " "
}
],
"type": "store",
"tin": "AZ0123456789"
"ucs": "AZ0123456789"
}
]
}

===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название торговой точки
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
|
|}
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

API Orders

2024-10-27T16:09:52Z

User: /* Изменение и корректировка заказа поставщиком */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /v1/orders

===Получение списка заказов в зависимости от статуса заказа===
GET /v1/orders?status=

===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/v1/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/v1/orders?status=1. В headers запроса обязательно должна передаваться страна пользователя и уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех заказов поставщика в указанном статусе.

Также возможно получение списка заказов за период от времени, указанного в GET-параметре "updated_from", до времени выполнения запроса: "updated_from=2019-11-27T07:03:01".

''Пример: https://food.smartsatu.com/api/v1/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ в статусах "Подтвержден"/"Принят" доставлен в Торговую точку, которая приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id является параметром id в order_items:

[[Файл:Offer id.jpg||350px|offer_id для корректировки заказа]]

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят без изменений",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Изменена дата доставки и количество товара",
"delivery_date": "09.10.2019",
"items":
[
{
"quantity": 50,
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| decimal
| 11340.00
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| array
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| array
| < order_items > array
|
|-
| style="font-weight:bold;" | supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| array
| < store_company > array
|
|-
| style="font-weight:bold;" | service_fee_amount
| Сумма сервисного сбора
| decimal
| 300.00
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| array
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

Файл:Offer id.jpg

2024-10-27T16:08:50Z

User: User откатил Файл:Offer id.jpg к старой версии

где взять offer_id?

API Orders

2024-10-27T16:07:52Z

User: /* Изменение и корректировка заказа поставщиком */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /v1/orders

===Получение списка заказов в зависимости от статуса заказа===
GET /v1/orders?status=

===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/v1/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/v1/orders?status=1. В headers запроса обязательно должна передаваться страна пользователя и уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех заказов поставщика в указанном статусе.

Также возможно получение списка заказов за период от времени, указанного в GET-параметре "updated_from", до времени выполнения запроса: "updated_from=2019-11-27T07:03:01".

''Пример: https://food.smartsatu.com/api/v1/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ в статусах "Подтвержден"/"Принят" доставлен в Торговую точку, которая приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id является параметром id в order_items:

[[Файл:Offer id.jpg|offer_id для корректировки заказа]]

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят без изменений",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Изменена дата доставки и количество товара",
"delivery_date": "09.10.2019",
"items":
[
{
"quantity": 50,
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| decimal
| 11340.00
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| array
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| array
| < order_items > array
|
|-
| style="font-weight:bold;" | supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| array
| < store_company > array
|
|-
| style="font-weight:bold;" | service_fee_amount
| Сумма сервисного сбора
| decimal
| 300.00
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| array
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

API Orders

2024-10-27T16:07:25Z

User: /* Изменение и корректировка заказа поставщиком */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /v1/orders

===Получение списка заказов в зависимости от статуса заказа===
GET /v1/orders?status=

===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/v1/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/v1/orders?status=1. В headers запроса обязательно должна передаваться страна пользователя и уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех заказов поставщика в указанном статусе.

Также возможно получение списка заказов за период от времени, указанного в GET-параметре "updated_from", до времени выполнения запроса: "updated_from=2019-11-27T07:03:01".

''Пример: https://food.smartsatu.com/api/v1/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ в статусах "Подтвержден"/"Принят" доставлен в Торговую точку, которая приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id является параметром id в order_items.

[[Файл:Offer id.jpg|offer_id для корректировки заказа]]

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят без изменений",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Изменена дата доставки и количество товара",
"delivery_date": "09.10.2019",
"items":
[
{
"quantity": 50,
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| decimal
| 11340.00
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| array
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| array
| < order_items > array
|
|-
| style="font-weight:bold;" | supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| array
| < store_company > array
|
|-
| style="font-weight:bold;" | service_fee_amount
| Сумма сервисного сбора
| decimal
| 300.00
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| array
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

API Orders

2024-10-27T16:06:44Z

User: /* Изменение и корректировка заказа поставщиком */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /v1/orders

===Получение списка заказов в зависимости от статуса заказа===
GET /v1/orders?status=

===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/v1/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/v1/orders?status=1. В headers запроса обязательно должна передаваться страна пользователя и уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех заказов поставщика в указанном статусе.

Также возможно получение списка заказов за период от времени, указанного в GET-параметре "updated_from", до времени выполнения запроса: "updated_from=2019-11-27T07:03:01".

''Пример: https://food.smartsatu.com/api/v1/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ в статусах "Подтвержден"/"Принят" доставлен в Торговую точку, которая приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id является параметром id в order_items, а не offer_id - идентификатор предложения. 

[[Файл:Offer id.jpg|offer_id для корректировки заказа]]

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят без изменений",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Изменена дата доставки и количество товара",
"delivery_date": "09.10.2019",
"items":
[
{
"quantity": 50,
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| decimal
| 11340.00
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| array
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| array
| < order_items > array
|
|-
| style="font-weight:bold;" | supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| array
| < store_company > array
|
|-
| style="font-weight:bold;" | service_fee_amount
| Сумма сервисного сбора
| decimal
| 300.00
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| array
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

Файл:Offer id.jpg

2024-10-27T16:06:03Z

User: User загрузил новую версию Файл:Offer id.jpg

где взять offer_id?

Файл:Offer id.jpg

2024-10-27T16:02:28Z

User:

где взять offer_id?

API Product

2024-10-24T14:34:29Z

User: /* Создание заявки на редактирование продуктов */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по созданию товарной карточки в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Просмотр заявки на создание продуктов===
GET /product-change-requests/{id}

===Создание заявки на создание продуктов===
POST /product-change-requests

===Создание заявки на редактирование продуктов===
POST /product-change-request/update

==Описание==
===Просмотр заявки на создание продуктов===
Для того, чтобы получить заявку на создание товара, необходимо отправить GET-запрос c пустым телом на /api/product-change-requests/{id}, где id - это уникальный идентификатор заявки на создание нового товара.
Ответом от сервера будет являться массив данных с данными заявки на создание товара.

===Создание заявки на создание продуктов===
Для того чтобы создать заявку на создание нового товара необходимо отправить POST-запрос c JSON-телом, по URL: https://food.smartsatu.com/api/product-change-requests.
Ответом от сервера будет являться сообщение с id заявки, ее статусом и комментарием.

Measure_id может принимать значения:
*1 - шт;
*9 - кг;
*11 - л.

===Создание заявки на редактирование продуктов===
Для редактирования товара необходимо отправить PUT-запрос на /api/product-change-request/update с телом:
{
"sku":"7290104841590",
"imageFiles":[{"data":"/9j/4AAQS...RPUjogZ2QtanBlZy"}, {"data":"/8k/3gwAS...ONfUjogZ2Qibusdvlkne"}],
"name":"Уголок строительный крепежный (металл)",
"manufacturer":"Надежные конструкции",
"description":"Металлические уголки. Держатели для всех видов и способов навеса. Универсальный в использовании. Качество, проверенное временем."
"search_tags":"уголок крепеж"
}
где
sku – код товара, обязательный параметр. Остальные параметры отправляются при необходимости. Если параметр не указан, значение в товарной карточке перезаписано не будет.

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на создание нового товара
|
|}
==Ответы==
===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 201
| Ok
| [http://docs.smartsatu.com/wiki/API_Product#Product_Change_Request_Response_2 Product Change Request Response]
|-
| style="font-weight:bold;" | 400
| Bad Request
| [http://docs.smartsatu.com/wiki/API_Product#400 400]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Product#401 401]
|-
| style="font-weight:bold;" | 422
| Add error message
| [http://docs.smartsatu.com/wiki/API_Product#422 422]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Product Change Request===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название товара
| string
| test23
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| integer($int64)
| 123321123321
|-
| style="font-weight:bold;" | description
| Описание
| string
| test test test
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int32)
| 2
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| ABCfood
|-
| style="font-weight:bold;" | measure_id
| Единица измерения
| integer($int32)
| 11
|-
| style="font-weight:bold;" | imageFiles
| Массив
| < imageFiles > array
|
|}
imageFiles
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название изображения
| string
| test123442.jpg
|-
| style="font-weight:bold;" | data
| Данные изображения
| string
| /9j/4AAQSkZJRgABAQAAAQABAADk
|}
Пример запроса:

{
"name": "test23",
"sku": 123321123321,
"description": "test test test",
"quantity": 2,
"manufacturer": "ABCfood",
"measure_id": 11,
"imageFiles": [
{
"name": "test123442.jpg",
"data": "/9j/4AAQSkZJRgABAQAAAQABAADk"
}
]
}

===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования
| integer($int32)
| 28576
|-
| style="font-weight:bold;" | status
| Статус запроса
| integer($int32)
| 0
|-
| style="font-weight:bold;" | declined_comment
| Комментарий
| string
| null
|}
Пример ответа:

{
"id": 28576,
"status": 0,
"declined_comment": null
}
===400===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Bad Request
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Invalid JSON data in request body: Syntax error.
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 400
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\BadRequestHttpException
|}
Пример ответа:
{
"name": "Bad Request",
"message": "Invalid JSON data in request body: Syntax error.",
"code": 0,
"status": 400,
"type": "yii\\web\\BadRequestHttpException"
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===422===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | field
| Параметр
| string
| sku
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Штрихкод уже ожидает подтверждения.
|}
Пример ответа:
{
"field": "sku",
"message": "Штрихкод уже ожидает подтверждения."
}

API Product

2024-10-20T08:44:42Z

User: /* Описание */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по созданию товарной карточки в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Просмотр заявки на создание продуктов===
GET /product-change-requests/{id}

===Создание заявки на создание продуктов===
POST /product-change-requests

===Создание заявки на редактирование продуктов===
POST /product-change-request/update

==Описание==
===Просмотр заявки на создание продуктов===
Для того, чтобы получить заявку на создание товара, необходимо отправить GET-запрос c пустым телом на /api/product-change-requests/{id}, где id - это уникальный идентификатор заявки на создание нового товара.
Ответом от сервера будет являться массив данных с данными заявки на создание товара.

===Создание заявки на создание продуктов===
Для того чтобы создать заявку на создание нового товара необходимо отправить POST-запрос c JSON-телом, по URL: https://food.smartsatu.com/api/product-change-requests.
Ответом от сервера будет являться сообщение с id заявки, ее статусом и комментарием.

Measure_id может принимать значения:
*1 - шт;
*9 - кг;
*11 - л.

===Создание заявки на редактирование продуктов===
Для редактирования товара необходимо отправить POST-запрос на /api/product-change-request/update с телом:
{
"sku":"7290104841590",
"imageFiles":[{"data":"/9j/4AAQS...RPUjogZ2QtanBlZy"}, {"data":"/8k/3gwAS...ONfUjogZ2Qibusdvlkne"}],
"name":"Уголок строительный крепежный (металл)",
"manufacturer":"Надежные конструкции",
"description":"Металлические уголки. Держатели для всех видов и способов навеса. Универсальный в использовании. Качество, проверенное временем."
"search_tags":"уголок крепеж"
}
где
sku – код товара, обязательный параметр. Остальные параметры отправляются при необходимости. Если параметр не указан, значение в товарной карточке перезаписано не будет.

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на создание нового товара
|
|}
==Ответы==
===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 201
| Ok
| [http://docs.smartsatu.com/wiki/API_Product#Product_Change_Request_Response_2 Product Change Request Response]
|-
| style="font-weight:bold;" | 400
| Bad Request
| [http://docs.smartsatu.com/wiki/API_Product#400 400]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Product#401 401]
|-
| style="font-weight:bold;" | 422
| Add error message
| [http://docs.smartsatu.com/wiki/API_Product#422 422]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Product Change Request===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название товара
| string
| test23
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| integer($int64)
| 123321123321
|-
| style="font-weight:bold;" | description
| Описание
| string
| test test test
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int32)
| 2
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| ABCfood
|-
| style="font-weight:bold;" | measure_id
| Единица измерения
| integer($int32)
| 11
|-
| style="font-weight:bold;" | imageFiles
| Массив
| < imageFiles > array
|
|}
imageFiles
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название изображения
| string
| test123442.jpg
|-
| style="font-weight:bold;" | data
| Данные изображения
| string
| /9j/4AAQSkZJRgABAQAAAQABAADk
|}
Пример запроса:

{
"name": "test23",
"sku": 123321123321,
"description": "test test test",
"quantity": 2,
"manufacturer": "ABCfood",
"measure_id": 11,
"imageFiles": [
{
"name": "test123442.jpg",
"data": "/9j/4AAQSkZJRgABAQAAAQABAADk"
}
]
}

===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования
| integer($int32)
| 28576
|-
| style="font-weight:bold;" | status
| Статус запроса
| integer($int32)
| 0
|-
| style="font-weight:bold;" | declined_comment
| Комментарий
| string
| null
|}
Пример ответа:

{
"id": 28576,
"status": 0,
"declined_comment": null
}
===400===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Bad Request
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Invalid JSON data in request body: Syntax error.
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 400
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\BadRequestHttpException
|}
Пример ответа:
{
"name": "Bad Request",
"message": "Invalid JSON data in request body: Syntax error.",
"code": 0,
"status": 400,
"type": "yii\\web\\BadRequestHttpException"
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===422===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | field
| Параметр
| string
| sku
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Штрихкод уже ожидает подтверждения.
|}
Пример ответа:
{
"field": "sku",
"message": "Штрихкод уже ожидает подтверждения."
}

API Product

2024-10-20T08:43:14Z

User: /* Отправка заявки на редактирование продуктов */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по созданию товарной карточки в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Просмотр заявки на создание продуктов===
GET /product-change-requests/{id}

===Создание заявки на создание продуктов===
POST /product-change-requests

===Создание заявки на редактирование продуктов===
POST /product-change-request/update

==Описание==
===Просмотр заявки на создание продуктов===
Для того, чтобы получить заявку на создание товара, необходимо отправить GET-запрос c пустым телом на /api/product-change-requests/{id}, где id - это уникальный идентификатор заявки на создание нового товара.
Ответом от сервера будет являться массив данных с данными заявки на создание товара.

===Создание заявки на редактирование продуктов===
Для редактирования товара необходимо отправить POST-запрос на /api/product-change-request/update с телом:
{
"sku":"7290104841590",
"imageFiles":[{"data":"/9j/4AAQS...RPUjogZ2QtanBlZy"}, {"data":"/8k/3gwAS...ONfUjogZ2Qibusdvlkne"}],
"name":"Уголок строительный крепежный (металл)",
"manufacturer":"Надежные конструкции",
"description":"Металлические уголки. Держатели для всех видов и способов навеса. Универсальный в использовании. Качество, проверенное временем."
"search_tags":"уголок крепеж"
}
где
sku – код товара, обязательный параметр
остальные параметры отправляются при необходимости. Если параметр не указан, значение в товарной карточке перезаписано не будет.

===Создание заявки на создание продуктов===
Для того чтобы создать заявку на создание нового товара необходимо отправить POST-запрос c JSON-телом, по URL: https://food.smartsatu.com/api/product-change-requests.
Ответом от сервера будет являться сообщение с id заявки, ее статусом и комментарием.

Measure_id может принимать значения:
*1 - шт;
*9 - кг;
*11 - л.

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на создание нового товара
|
|}
==Ответы==
===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 201
| Ok
| [http://docs.smartsatu.com/wiki/API_Product#Product_Change_Request_Response_2 Product Change Request Response]
|-
| style="font-weight:bold;" | 400
| Bad Request
| [http://docs.smartsatu.com/wiki/API_Product#400 400]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Product#401 401]
|-
| style="font-weight:bold;" | 422
| Add error message
| [http://docs.smartsatu.com/wiki/API_Product#422 422]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Product Change Request===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название товара
| string
| test23
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| integer($int64)
| 123321123321
|-
| style="font-weight:bold;" | description
| Описание
| string
| test test test
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int32)
| 2
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| ABCfood
|-
| style="font-weight:bold;" | measure_id
| Единица измерения
| integer($int32)
| 11
|-
| style="font-weight:bold;" | imageFiles
| Массив
| < imageFiles > array
|
|}
imageFiles
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название изображения
| string
| test123442.jpg
|-
| style="font-weight:bold;" | data
| Данные изображения
| string
| /9j/4AAQSkZJRgABAQAAAQABAADk
|}
Пример запроса:

{
"name": "test23",
"sku": 123321123321,
"description": "test test test",
"quantity": 2,
"manufacturer": "ABCfood",
"measure_id": 11,
"imageFiles": [
{
"name": "test123442.jpg",
"data": "/9j/4AAQSkZJRgABAQAAAQABAADk"
}
]
}

===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования
| integer($int32)
| 28576
|-
| style="font-weight:bold;" | status
| Статус запроса
| integer($int32)
| 0
|-
| style="font-weight:bold;" | declined_comment
| Комментарий
| string
| null
|}
Пример ответа:

{
"id": 28576,
"status": 0,
"declined_comment": null
}
===400===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Bad Request
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Invalid JSON data in request body: Syntax error.
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 400
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\BadRequestHttpException
|}
Пример ответа:
{
"name": "Bad Request",
"message": "Invalid JSON data in request body: Syntax error.",
"code": 0,
"status": 400,
"type": "yii\\web\\BadRequestHttpException"
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===422===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | field
| Параметр
| string
| sku
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Штрихкод уже ожидает подтверждения.
|}
Пример ответа:
{
"field": "sku",
"message": "Штрихкод уже ожидает подтверждения."
}

API Product

2024-10-20T08:42:59Z

User: /* Просмотр заявки на редактирование продуктов */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по созданию товарной карточки в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Просмотр заявки на создание продуктов===
GET /product-change-requests/{id}

===Создание заявки на создание продуктов===
POST /product-change-requests

===Создание заявки на редактирование продуктов===
POST /product-change-request/update

==Описание==
===Просмотр заявки на создание продуктов===
Для того, чтобы получить заявку на создание товара, необходимо отправить GET-запрос c пустым телом на /api/product-change-requests/{id}, где id - это уникальный идентификатор заявки на создание нового товара.
Ответом от сервера будет являться массив данных с данными заявки на создание товара.

===Отправка заявки на редактирование продуктов===
Для редактирования товара необходимо отправить POST-запрос на /api/product-change-request/update с телом:
{
"sku":"7290104841590",
"imageFiles":[{"data":"/9j/4AAQS...RPUjogZ2QtanBlZy"}, {"data":"/8k/3gwAS...ONfUjogZ2Qibusdvlkne"}],
"name":"Уголок строительный крепежный (металл)",
"manufacturer":"Надежные конструкции",
"description":"Металлические уголки. Держатели для всех видов и способов навеса. Универсальный в использовании. Качество, проверенное временем."
"search_tags":"уголок крепеж"
}
где
sku – код товара, обязательный параметр
остальные параметры отправляются при необходимости. Если параметр не указан, значение в товарной карточке перезаписано не будет.

===Создание заявки на создание продуктов===
Для того чтобы создать заявку на создание нового товара необходимо отправить POST-запрос c JSON-телом, по URL: https://food.smartsatu.com/api/product-change-requests.
Ответом от сервера будет являться сообщение с id заявки, ее статусом и комментарием.

Measure_id может принимать значения:
*1 - шт;
*9 - кг;
*11 - л.

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на создание нового товара
|
|}
==Ответы==
===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 201
| Ok
| [http://docs.smartsatu.com/wiki/API_Product#Product_Change_Request_Response_2 Product Change Request Response]
|-
| style="font-weight:bold;" | 400
| Bad Request
| [http://docs.smartsatu.com/wiki/API_Product#400 400]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Product#401 401]
|-
| style="font-weight:bold;" | 422
| Add error message
| [http://docs.smartsatu.com/wiki/API_Product#422 422]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Product Change Request===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название товара
| string
| test23
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| integer($int64)
| 123321123321
|-
| style="font-weight:bold;" | description
| Описание
| string
| test test test
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int32)
| 2
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| ABCfood
|-
| style="font-weight:bold;" | measure_id
| Единица измерения
| integer($int32)
| 11
|-
| style="font-weight:bold;" | imageFiles
| Массив
| < imageFiles > array
|
|}
imageFiles
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название изображения
| string
| test123442.jpg
|-
| style="font-weight:bold;" | data
| Данные изображения
| string
| /9j/4AAQSkZJRgABAQAAAQABAADk
|}
Пример запроса:

{
"name": "test23",
"sku": 123321123321,
"description": "test test test",
"quantity": 2,
"manufacturer": "ABCfood",
"measure_id": 11,
"imageFiles": [
{
"name": "test123442.jpg",
"data": "/9j/4AAQSkZJRgABAQAAAQABAADk"
}
]
}

===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования
| integer($int32)
| 28576
|-
| style="font-weight:bold;" | status
| Статус запроса
| integer($int32)
| 0
|-
| style="font-weight:bold;" | declined_comment
| Комментарий
| string
| null
|}
Пример ответа:

{
"id": 28576,
"status": 0,
"declined_comment": null
}
===400===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Bad Request
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Invalid JSON data in request body: Syntax error.
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 400
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\BadRequestHttpException
|}
Пример ответа:
{
"name": "Bad Request",
"message": "Invalid JSON data in request body: Syntax error.",
"code": 0,
"status": 400,
"type": "yii\\web\\BadRequestHttpException"
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===422===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | field
| Параметр
| string
| sku
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Штрихкод уже ожидает подтверждения.
|}
Пример ответа:
{
"field": "sku",
"message": "Штрихкод уже ожидает подтверждения."
}

API Product

2024-10-20T08:42:15Z

User: /* Просмотр заявки на создание продуктов */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по созданию товарной карточки в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Просмотр заявки на создание продуктов===
GET /product-change-requests/{id}

===Создание заявки на создание продуктов===
POST /product-change-requests

===Создание заявки на редактирование продуктов===
POST /product-change-request/update

==Описание==
===Просмотр заявки на создание продуктов===
Для того, чтобы получить заявку на создание товара, необходимо отправить GET-запрос c пустым телом на /api/product-change-requests/{id}, где id - это уникальный идентификатор заявки на создание нового товара.
Ответом от сервера будет являться массив данных с данными заявки на создание товара.

===Просмотр заявки на редактирование продуктов===
Для редактирования товара необходимо отправить POST-запрос на /api/product-change-request/update с телом:
{
"sku":"7290104841590",
"imageFiles":[{"data":"/9j/4AAQS...RPUjogZ2QtanBlZy"}, {"data":"/8k/3gwAS...ONfUjogZ2Qibusdvlkne"}],
"name":"Уголок строительный крепежный (металл)",
"manufacturer":"Надежные конструкции",
"description":"Металлические уголки. Держатели для всех видов и способов навеса. Универсальный в использовании. Качество, проверенное временем."
"search_tags":"уголок крепеж"
}
где
sku – код товара, обязательный параметр
остальные параметры отправляются при необходимости. Если параметр не указан, значение в товарной карточке перезаписано не будет.

===Создание заявки на создание продуктов===
Для того чтобы создать заявку на создание нового товара необходимо отправить POST-запрос c JSON-телом, по URL: https://food.smartsatu.com/api/product-change-requests.
Ответом от сервера будет являться сообщение с id заявки, ее статусом и комментарием.

Measure_id может принимать значения:
*1 - шт;
*9 - кг;
*11 - л.

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на создание нового товара
|
|}
==Ответы==
===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 201
| Ok
| [http://docs.smartsatu.com/wiki/API_Product#Product_Change_Request_Response_2 Product Change Request Response]
|-
| style="font-weight:bold;" | 400
| Bad Request
| [http://docs.smartsatu.com/wiki/API_Product#400 400]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Product#401 401]
|-
| style="font-weight:bold;" | 422
| Add error message
| [http://docs.smartsatu.com/wiki/API_Product#422 422]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Product Change Request===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название товара
| string
| test23
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| integer($int64)
| 123321123321
|-
| style="font-weight:bold;" | description
| Описание
| string
| test test test
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int32)
| 2
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| ABCfood
|-
| style="font-weight:bold;" | measure_id
| Единица измерения
| integer($int32)
| 11
|-
| style="font-weight:bold;" | imageFiles
| Массив
| < imageFiles > array
|
|}
imageFiles
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название изображения
| string
| test123442.jpg
|-
| style="font-weight:bold;" | data
| Данные изображения
| string
| /9j/4AAQSkZJRgABAQAAAQABAADk
|}
Пример запроса:

{
"name": "test23",
"sku": 123321123321,
"description": "test test test",
"quantity": 2,
"manufacturer": "ABCfood",
"measure_id": 11,
"imageFiles": [
{
"name": "test123442.jpg",
"data": "/9j/4AAQSkZJRgABAQAAAQABAADk"
}
]
}

===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования
| integer($int32)
| 28576
|-
| style="font-weight:bold;" | status
| Статус запроса
| integer($int32)
| 0
|-
| style="font-weight:bold;" | declined_comment
| Комментарий
| string
| null
|}
Пример ответа:

{
"id": 28576,
"status": 0,
"declined_comment": null
}
===400===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Bad Request
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Invalid JSON data in request body: Syntax error.
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 400
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\BadRequestHttpException
|}
Пример ответа:
{
"name": "Bad Request",
"message": "Invalid JSON data in request body: Syntax error.",
"code": 0,
"status": 400,
"type": "yii\\web\\BadRequestHttpException"
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===422===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | field
| Параметр
| string
| sku
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Штрихкод уже ожидает подтверждения.
|}
Пример ответа:
{
"field": "sku",
"message": "Штрихкод уже ожидает подтверждения."
}

API Product

2024-10-20T08:28:52Z

User: /* Методы */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по созданию товарной карточки в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Просмотр заявки на создание продуктов===
GET /product-change-requests/{id}

===Создание заявки на создание продуктов===
POST /product-change-requests

===Создание заявки на редактирование продуктов===
POST /product-change-request/update

==Описание==
===Просмотр заявки на создание продуктов===
Для того чтобы получить заявку на создание товара необходимо отправить GET-запрос c пустым телом, по URL: https://food.smartsatu.com/api/product-change-requests/{id}, где id - это уникальный идентификатор заявки на создание нового товара.
Ответом от сервера будет являться массив данных с данными заявки на создание товара.

===Создание заявки на создание продуктов===
Для того чтобы создать заявку на создание нового товара необходимо отправить POST-запрос c JSON-телом, по URL: https://food.smartsatu.com/api/product-change-requests.
Ответом от сервера будет являться сообщение с id заявки, ее статусом и комментарием.

Measure_id может принимать значения:
*1 - шт;
*9 - кг;
*11 - л.

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на создание нового товара
|
|}
==Ответы==
===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 201
| Ok
| [http://docs.smartsatu.com/wiki/API_Product#Product_Change_Request_Response_2 Product Change Request Response]
|-
| style="font-weight:bold;" | 400
| Bad Request
| [http://docs.smartsatu.com/wiki/API_Product#400 400]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Product#401 401]
|-
| style="font-weight:bold;" | 422
| Add error message
| [http://docs.smartsatu.com/wiki/API_Product#422 422]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Product Change Request===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название товара
| string
| test23
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| integer($int64)
| 123321123321
|-
| style="font-weight:bold;" | description
| Описание
| string
| test test test
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int32)
| 2
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| ABCfood
|-
| style="font-weight:bold;" | measure_id
| Единица измерения
| integer($int32)
| 11
|-
| style="font-weight:bold;" | imageFiles
| Массив
| < imageFiles > array
|
|}
imageFiles
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название изображения
| string
| test123442.jpg
|-
| style="font-weight:bold;" | data
| Данные изображения
| string
| /9j/4AAQSkZJRgABAQAAAQABAADk
|}
Пример запроса:

{
"name": "test23",
"sku": 123321123321,
"description": "test test test",
"quantity": 2,
"manufacturer": "ABCfood",
"measure_id": 11,
"imageFiles": [
{
"name": "test123442.jpg",
"data": "/9j/4AAQSkZJRgABAQAAAQABAADk"
}
]
}

===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования
| integer($int32)
| 28576
|-
| style="font-weight:bold;" | status
| Статус запроса
| integer($int32)
| 0
|-
| style="font-weight:bold;" | declined_comment
| Комментарий
| string
| null
|}
Пример ответа:

{
"id": 28576,
"status": 0,
"declined_comment": null
}
===400===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Bad Request
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Invalid JSON data in request body: Syntax error.
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 400
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\BadRequestHttpException
|}
Пример ответа:
{
"name": "Bad Request",
"message": "Invalid JSON data in request body: Syntax error.",
"code": 0,
"status": 400,
"type": "yii\\web\\BadRequestHttpException"
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===422===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | field
| Параметр
| string
| sku
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Штрихкод уже ожидает подтверждения.
|}
Пример ответа:
{
"field": "sku",
"message": "Штрихкод уже ожидает подтверждения."
}

API Product

2024-08-14T11:32:05Z

User: /* Product Change Request */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по созданию товарной карточки в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Просмотр заявки на создание продуктов===
GET /product-change-requests/{id}

===Создание заявки на создание продуктов===
POST /product-change-requests

==Описание==
===Просмотр заявки на создание продуктов===
Для того чтобы получить заявку на создание товара необходимо отправить GET-запрос c пустым телом, по URL: https://food.smartsatu.com/api/product-change-requests/{id}, где id - это уникальный идентификатор заявки на создание нового товара.
Ответом от сервера будет являться массив данных с данными заявки на создание товара.

===Создание заявки на создание продуктов===
Для того чтобы создать заявку на создание нового товара необходимо отправить POST-запрос c JSON-телом, по URL: https://food.smartsatu.com/api/product-change-requests.
Ответом от сервера будет являться сообщение с id заявки, ее статусом и комментарием.

Measure_id может принимать значения:
*1 - шт;
*9 - кг;
*11 - л.

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на создание нового товара
|
|}
==Ответы==
===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 201
| Ok
| [http://docs.smartsatu.com/wiki/API_Product#Product_Change_Request_Response_2 Product Change Request Response]
|-
| style="font-weight:bold;" | 400
| Bad Request
| [http://docs.smartsatu.com/wiki/API_Product#400 400]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Product#401 401]
|-
| style="font-weight:bold;" | 422
| Add error message
| [http://docs.smartsatu.com/wiki/API_Product#422 422]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Product Change Request===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название товара
| string
| test23
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| integer($int64)
| 123321123321
|-
| style="font-weight:bold;" | description
| Описание
| string
| test test test
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int32)
| 2
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| ABCfood
|-
| style="font-weight:bold;" | measure_id
| Единица измерения
| integer($int32)
| 11
|-
| style="font-weight:bold;" | imageFiles
| Массив
| < imageFiles > array
|
|}
imageFiles
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название изображения
| string
| test123442.jpg
|-
| style="font-weight:bold;" | data
| Данные изображения
| string
| /9j/4AAQSkZJRgABAQAAAQABAADk
|}
Пример запроса:

{
"name": "test23",
"sku": 123321123321,
"description": "test test test",
"quantity": 2,
"manufacturer": "ABCfood",
"measure_id": 11,
"imageFiles": [
{
"name": "test123442.jpg",
"data": "/9j/4AAQSkZJRgABAQAAAQABAADk"
}
]
}

===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования
| integer($int32)
| 28576
|-
| style="font-weight:bold;" | status
| Статус запроса
| integer($int32)
| 0
|-
| style="font-weight:bold;" | declined_comment
| Комментарий
| string
| null
|}
Пример ответа:

{
"id": 28576,
"status": 0,
"declined_comment": null
}
===400===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Bad Request
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Invalid JSON data in request body: Syntax error.
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 400
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\BadRequestHttpException
|}
Пример ответа:
{
"name": "Bad Request",
"message": "Invalid JSON data in request body: Syntax error.",
"code": 0,
"status": 400,
"type": "yii\\web\\BadRequestHttpException"
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===422===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | field
| Параметр
| string
| sku
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Штрихкод уже ожидает подтверждения.
|}
Пример ответа:
{
"field": "sku",
"message": "Штрихкод уже ожидает подтверждения."
}

API Orders

2024-06-07T06:52:18Z

User: /* Response Orders */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /v1/orders

===Получение списка заказов в зависимости от статуса заказа===
GET /v1/orders?status=

===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/v1/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/v1/orders?status=1. В headers запроса обязательно должна передаваться страна пользователя и уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех заказов поставщика в указанном статусе.

Также возможно получение списка заказов за период от времени, указанного в GET-параметре "updated_from", до времени выполнения запроса: "updated_from=2019-11-27T07:03:01".

''Пример: https://food.smartsatu.com/api/v1/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ в статусах "Подтвержден"/"Принят" доставлен в Торговую точку, которая приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id является параметром id в order_items, а не offer_id - идентификатор предложения. 

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят без изменений",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Изменена дата доставки и количество товара",
"delivery_date": "09.10.2019",
"items":
[
{
"quantity": 50,
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| decimal
| 11340.00
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| array
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| array
| < order_items > array
|
|-
| style="font-weight:bold;" | supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| array
| < store_company > array
|
|-
| style="font-weight:bold;" | service_fee_amount
| Сумма сервисного сбора
| decimal
| 300.00
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| array
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

API Orders

2024-02-17T10:01:14Z

User: /* Получение списка заказов в зависимости от статуса заказа */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /v1/orders

===Получение списка заказов в зависимости от статуса заказа===
GET /v1/orders?status=

===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/v1/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/v1/orders?status=1. В headers запроса обязательно должна передаваться страна пользователя и уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех заказов поставщика в указанном статусе.

Также возможно получение списка заказов за период от времени, указанного в GET-параметре "updated_from", до времени выполнения запроса: "updated_from=2019-11-27T07:03:01".

''Пример: https://food.smartsatu.com/api/v1/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ в статусах "Подтвержден"/"Принят" доставлен в Торговую точку, которая приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id является параметром id в order_items, а не offer_id - идентификатор предложения. 

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят без изменений",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Изменена дата доставки и количество товара",
"delivery_date": "09.10.2019",
"items":
[
{
"quantity": 50,
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| decimal
| 11340.00
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| string
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| Массив
| < order_items > array
|
|-
| style="font-weight:bold;" | supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| Массив
| < store_company > array
|
|-
| style="font-weight:bold;" | service_fee_amount
| Сумма сервисного сбора
| decimal
| 300.00
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| Массив
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

API Orders

2024-02-17T09:58:57Z

User: /* Получение списка заказов в зависимости от статуса заказа */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /v1/orders

===Получение списка заказов в зависимости от статуса заказа===
GET /v1/orders?status=

===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/v1/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/v1/orders?status=1. В headers запроса обязательно должна передаваться страна пользователя и уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех заказов поставщика в указанном статусе.

Также возможно получение списка заказов начиная от определенного времени, указав дату и время в GET-параметре "updated_from=2019-11-27T07:03:01".

''Пример: https://food.smartsatu.com/api/v1/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ в статусах "Подтвержден"/"Принят" доставлен в Торговую точку, которая приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id является параметром id в order_items, а не offer_id - идентификатор предложения. 

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят без изменений",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Изменена дата доставки и количество товара",
"delivery_date": "09.10.2019",
"items":
[
{
"quantity": 50,
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| decimal
| 11340.00
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| string
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| Массив
| < order_items > array
|
|-
| style="font-weight:bold;" | supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| Массив
| < store_company > array
|
|-
| style="font-weight:bold;" | service_fee_amount
| Сумма сервисного сбора
| decimal
| 300.00
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| Массив
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

API Orders

2024-02-17T09:58:04Z

User: /* Получение списка заказов в зависимости от статуса заказа */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /v1/orders

===Получение списка заказов в зависимости от статуса заказа===
GET /v1/orders?status=

===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/v1/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/v1/orders?status=1. В headers запроса обязательно должна передаваться страна пользователя и уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех заказов поставщика в указанном статусе.

Также возможно получение списка заказов начиная от определенного времени, указав дату и время в '''GET-параметре "updated_from=2019-11-27T07:03:01"'''.

''Пример: https://food.smartsatu.com/api/v1/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ в статусах "Подтвержден"/"Принят" доставлен в Торговую точку, которая приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id является параметром id в order_items, а не offer_id - идентификатор предложения. 

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят без изменений",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Изменена дата доставки и количество товара",
"delivery_date": "09.10.2019",
"items":
[
{
"quantity": 50,
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| decimal
| 11340.00
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| string
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| Массив
| < order_items > array
|
|-
| style="font-weight:bold;" | supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| Массив
| < store_company > array
|
|-
| style="font-weight:bold;" | service_fee_amount
| Сумма сервисного сбора
| decimal
| 300.00
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| Массив
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

API Orders

2024-02-17T09:54:08Z

User: /* Изменение и корректировка заказа поставщиком */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /v1/orders

===Получение списка заказов в зависимости от статуса заказа===
GET /v1/orders?status=

===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/orders?status=3. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в указанном статусе, а также их данными.

Также возможно получение списка заказов, начиная от определенного времени, указав нужную дату и время в '''GET-параметр "updated_from=2019-11-27T07:03:01"'''.

''Пример: https://food.smartsatu.com/api/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id является параметром id в order_items, а не offer_id - идентификатор предложения. 

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят без изменений",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Изменена дата доставки и количество товара",
"delivery_date": "09.10.2019",
"items":
[
{
"quantity": 50,
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| decimal
| 11340.00
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| string
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| Массив
| < order_items > array
|
|-
| style="font-weight:bold;" | supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| Массив
| < store_company > array
|
|-
| style="font-weight:bold;" | service_fee_amount
| Сумма сервисного сбора
| decimal
| 300.00
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| Массив
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

API Orders

2024-02-17T09:52:51Z

User: /* Получение списка заказов в зависимости от статуса заказа */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /v1/orders

===Получение списка заказов в зависимости от статуса заказа===
GET /v1/orders?status=

===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/orders?status=3. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в указанном статусе, а также их данными.

Также возможно получение списка заказов, начиная от определенного времени, указав нужную дату и время в '''GET-параметр "updated_from=2019-11-27T07:03:01"'''.

''Пример: https://food.smartsatu.com/api/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id на самом деле id в order_items, а не offer_id - идентификатор предложения. 

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят без изменений",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Изменена дата доставки и количество товара",
"delivery_date": "09.10.2019",
"items":
[
{
"quantity": 50,
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| decimal
| 11340.00
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| string
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| Массив
| < order_items > array
|
|-
| style="font-weight:bold;" | supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| Массив
| < store_company > array
|
|-
| style="font-weight:bold;" | service_fee_amount
| Сумма сервисного сбора
| decimal
| 300.00
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| Массив
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

API Orders

2024-02-17T09:52:33Z

User: /* Получение списка заказов */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /v1/orders

===Получение списка заказов в зависимости от статуса заказа===
GET /orders?status=
===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/orders?status=3. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в указанном статусе, а также их данными.

Также возможно получение списка заказов, начиная от определенного времени, указав нужную дату и время в '''GET-параметр "updated_from=2019-11-27T07:03:01"'''.

''Пример: https://food.smartsatu.com/api/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id на самом деле id в order_items, а не offer_id - идентификатор предложения. 

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят без изменений",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Изменена дата доставки и количество товара",
"delivery_date": "09.10.2019",
"items":
[
{
"quantity": 50,
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| decimal
| 11340.00
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| string
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| Массив
| < order_items > array
|
|-
| style="font-weight:bold;" | supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| Массив
| < store_company > array
|
|-
| style="font-weight:bold;" | service_fee_amount
| Сумма сервисного сбора
| decimal
| 300.00
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| Массив
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

API Authorization

2024-02-17T09:51:09Z

User: /* Методы */

API Авторизации

==Обзор==
''Данный документа описывает метод авторизации поставщика/дистрибьютора в системе Smart Satu.''

Авторизация пользователя в систему Smart Satu происходит путем отправки POST-запроса с логином и паролем пользователя в JSON-теле по URL: https://food.smartsatu.com/api/users/login. Headers в данном запросе не могут быть пустыми и должны содержать: "content-type: application/json; charset=utf-8" и "country: ru".

Далее на стороне сервера происходит валидация данных пользователя. В случае корректности данных сервер выдает JSON-тело ответа, которое содержит данные пользователя с уникальным токеном авторизации, который в дальнейшем будет использоваться в каждом последующем запросе к системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //login.smartsatu.com/api/user/login Schemes : HTTPS''

==Методы==
'''Авторизация пользователя'''

POST /api/user/login

===Описание===
Метод для авторизации пользователя в системе Smart Satu.

Для авторизации необходимо воспользоваться выданным логином и паролем для системы заказов Smart Satu. В ответ на запрос авторизации приходит параметр - access_token_expiration_time, который в себе содержит unixtime время, когда токен станет недействителен. Порядок работы с токеном выглядит следующим образом:
# После получения токена необходимо сохранить время его истечения.
# Перед каждым запросом нужно проводить проверку, чтобы текущее время было меньше времени истечения жизни токена.
# В противном случае нужно отправить запрос на авторизацию и следовать пунктам №№ 1 и 2.

===Параметры===
{| class="wikitable"
|-
! scope="col"| Type
! scope="col"| Name
! scope="col"| Description
! scope="col"| Schema
|-
! scope="row"| Body
| '''body''' ''required''
| Авторизация пользователя
| [http://docs.smartsatu.com/wiki/%D0%90%D0%9F%D0%98#Login Login]
|}

===Ответы===

{| class="wikitable"
|-
! scope="col"| HTTP Code
! scope="col"| Description
! scope="col"| Schema
|-
| 200
| Ok
| [http://docs.smartsatu.com/wiki/%D0%90%D0%9F%D0%98#Login_Response Login Response]
|}

'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Login===
Для авторизации необходимо воспользоваться выданным логином и паролем для системы заказов Smart Satu.
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | username
| Логин
| string
| supplier
|-
| style="font-weight:bold;" | password
| Пароль
| string
| qwerty
|-
| style="font-weight:bold;" | direction
| Идентификатор сервера
| string
| food (Запросить у Smart Satu)
|}

Пример запроса:

{
"username" : "supplier",
"password" : "qwerty",
"direction" : "food"
}

===Login Response===
В ответ на запрос придет массив данных зарегистрированного пользователя с уникальным токином авторизации - "access_token".
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор
| string
| 132
|-
| style="font-weight:bold;" | email
| Почта
| string
| daulet@smartsatu.kz
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| null
|-
| style="font-weight:bold;" | username
| Логин
| string
| supplier
|-
| style="font-weight:bold;" | first_name
| Имя
| string
| Иван
|-
| style="font-weight:bold;" | last_name
| Фамилия
| string
| Иванов
|-
| style="font-weight:bold;" | middle_name
| Отчество
| string
| Иванович
|-
| style="font-weight:bold;" | access_token
| Уникальный токен для входа
| string
| bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd
|-
| style="font-weight:bold;" | role
| Роль
| string
| 2
|-
| style="font-weight:bold;" | city_id
| Город
| string
| 1
|-
| style="font-weight:bold;" | is_document
| Лицензия
| boolean
| true
|-
| style="font-weight:bold;" | is_replacement
| Доступность обмена
| boolean
| false
|-
| style="font-weight:bold;" | currency
| Валюта
| string
| тг
|-
| style="font-weight:bold;" | price_decimals
| Количество нолей после разделителя
| string
| 2
|-
| style="font-weight:bold;" | price_radix
| Разделитель разрядов
| string
|
|-
| style="font-weight:bold;" | price_decimals_separator
| Разделитель
| string
| .
|-
| style="font-weight:bold;" | price_before_currency
| Порядок показа валюты/цены
| boolean
| true
|-
| style="font-weight:bold;" | price_pattern
| Паттерн цены
| string
| ### ###.## тг
|-
| style="font-weight:bold;" | cashback_enabled
| Доступность кэшбэка
| boolean
| true
|-
| style="font-weight:bold;" | company_id
| Идентификатор компании
| string
| 84
|-
| style="font-weight:bold;" | access_token_expiration_time
| Время действия токена доступа
| string
| 1579535438
|-
| style="font-weight:bold;" | time_zone_offset
| Часовой пояс пользователя
| string
| 21600
|-
| style="font-weight:bold;" | country
| Страна
| string
| kz
|-
| style="font-weight:bold;" | direction
| Стейджинг
| string
| Food
|-
| style="font-weight:bold;" | url_api
| URL
| string
| https://food.smartsatu.com/api
|}

Пример ответа:

{
"id": 132,
"email": "daulet@smartsatu.kz",
"phone": null,
"username": "vendoralmaty",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"access_token": "bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd",
"role": 2,
"status": 1,
"city_id": 1,
"is_document": true,
"is_replacement": false,
"currency": "тг",
"price_decimals": 2,
"price_radix": " ",
"price_decimals_separator": ".",
"price_before_currency": true,
"price_pattern": "### ###.## тг",
"cashback_enabled": true,
"company_id": 84,
"access_token_expiration_time": 1579535438,
"time_zone_offset": 21600
"country": "kz",
"direction": "Food",
"url_api": "https://food.smartsatu.com/api"
}

API Authorization

2024-02-17T09:50:14Z

User: /* Обзор */

API Авторизации

==Обзор==
''Данный документа описывает метод авторизации поставщика/дистрибьютора в системе Smart Satu.''

Авторизация пользователя в систему Smart Satu происходит путем отправки POST-запроса с логином и паролем пользователя в JSON-теле по URL: https://food.smartsatu.com/api/users/login. Headers в данном запросе не могут быть пустыми и должны содержать: "content-type: application/json; charset=utf-8" и "country: ru".

Далее на стороне сервера происходит валидация данных пользователя. В случае корректности данных сервер выдает JSON-тело ответа, которое содержит данные пользователя с уникальным токеном авторизации, который в дальнейшем будет использоваться в каждом последующем запросе к системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //login.smartsatu.com/api/user/login Schemes : HTTPS''

==Методы==
'''Авторизация пользователя'''

POST /login

===Описание===
Метод для авторизации пользователя в системе Smart Satu.

Для авторизации необходимо воспользоваться выданным логином и паролем для системы заказов Smart Satu. В ответ на запрос авторизации приходит параметр - access_token_expiration_time, который в себе содержит unixtime время, когда токен станет недействителен. Порядок работы с токеном выглядит следующим образом:
# После получения токена необходимо сохранить время его истечения.
# Перед каждым запросом нужно проводить проверку, чтобы текущее время было меньше времени истечения жизни токена.
# В противном случае нужно отправить запрос на авторизацию и следовать пунктам №№ 1 и 2.

===Параметры===
{| class="wikitable"
|-
! scope="col"| Type
! scope="col"| Name
! scope="col"| Description
! scope="col"| Schema
|-
! scope="row"| Body
| '''body''' ''required''
| Авторизация пользователя
| [http://docs.smartsatu.com/wiki/%D0%90%D0%9F%D0%98#Login Login]
|}

===Ответы===

{| class="wikitable"
|-
! scope="col"| HTTP Code
! scope="col"| Description
! scope="col"| Schema
|-
| 200
| Ok
| [http://docs.smartsatu.com/wiki/%D0%90%D0%9F%D0%98#Login_Response Login Response]
|}

'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json
==Определения==
===Login===
Для авторизации необходимо воспользоваться выданным логином и паролем для системы заказов Smart Satu.
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | username
| Логин
| string
| supplier
|-
| style="font-weight:bold;" | password
| Пароль
| string
| qwerty
|-
| style="font-weight:bold;" | direction
| Идентификатор сервера
| string
| food (Запросить у Smart Satu)
|}

Пример запроса:

{
"username" : "supplier",
"password" : "qwerty",
"direction" : "food"
}

===Login Response===
В ответ на запрос придет массив данных зарегистрированного пользователя с уникальным токином авторизации - "access_token".
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор
| string
| 132
|-
| style="font-weight:bold;" | email
| Почта
| string
| daulet@smartsatu.kz
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| null
|-
| style="font-weight:bold;" | username
| Логин
| string
| supplier
|-
| style="font-weight:bold;" | first_name
| Имя
| string
| Иван
|-
| style="font-weight:bold;" | last_name
| Фамилия
| string
| Иванов
|-
| style="font-weight:bold;" | middle_name
| Отчество
| string
| Иванович
|-
| style="font-weight:bold;" | access_token
| Уникальный токен для входа
| string
| bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd
|-
| style="font-weight:bold;" | role
| Роль
| string
| 2
|-
| style="font-weight:bold;" | city_id
| Город
| string
| 1
|-
| style="font-weight:bold;" | is_document
| Лицензия
| boolean
| true
|-
| style="font-weight:bold;" | is_replacement
| Доступность обмена
| boolean
| false
|-
| style="font-weight:bold;" | currency
| Валюта
| string
| тг
|-
| style="font-weight:bold;" | price_decimals
| Количество нолей после разделителя
| string
| 2
|-
| style="font-weight:bold;" | price_radix
| Разделитель разрядов
| string
|
|-
| style="font-weight:bold;" | price_decimals_separator
| Разделитель
| string
| .
|-
| style="font-weight:bold;" | price_before_currency
| Порядок показа валюты/цены
| boolean
| true
|-
| style="font-weight:bold;" | price_pattern
| Паттерн цены
| string
| ### ###.## тг
|-
| style="font-weight:bold;" | cashback_enabled
| Доступность кэшбэка
| boolean
| true
|-
| style="font-weight:bold;" | company_id
| Идентификатор компании
| string
| 84
|-
| style="font-weight:bold;" | access_token_expiration_time
| Время действия токена доступа
| string
| 1579535438
|-
| style="font-weight:bold;" | time_zone_offset
| Часовой пояс пользователя
| string
| 21600
|-
| style="font-weight:bold;" | country
| Страна
| string
| kz
|-
| style="font-weight:bold;" | direction
| Стейджинг
| string
| Food
|-
| style="font-weight:bold;" | url_api
| URL
| string
| https://food.smartsatu.com/api
|}

Пример ответа:

{
"id": 132,
"email": "daulet@smartsatu.kz",
"phone": null,
"username": "vendoralmaty",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"access_token": "bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd",
"role": 2,
"status": 1,
"city_id": 1,
"is_document": true,
"is_replacement": false,
"currency": "тг",
"price_decimals": 2,
"price_radix": " ",
"price_decimals_separator": ".",
"price_before_currency": true,
"price_pattern": "### ###.## тг",
"cashback_enabled": true,
"company_id": 84,
"access_token_expiration_time": 1579535438,
"time_zone_offset": 21600
"country": "kz",
"direction": "Food",
"url_api": "https://food.smartsatu.com/api"
}

API Authorization

2024-02-17T09:48:34Z

User: /* Login */

API Авторизации

==Обзор==
''Данный документа описывает метод авторизации поставщика/дистрибьютора в системе Smart Satu.''

Авторизация пользователя в систему Smart Satu происходит путем отправки POST-запроса с логином и паролем пользователя в JSON-теле по URL: https://food.smartsatu.com/api/users/login. Headers в данном запросе не могут быть пустыми и должны содержать: "content-type: application/json; charset=utf-8" и "country: ru".

Далее на стороне сервера происходит валидация данных пользователя. В случае корректности данных сервер выдает JSON-тело ответа, которое содержит данные пользователя с уникальным токеном авторизации, который в дальнейшем будет использоваться в каждом последующем запросе к системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/users/login/ Schemes : HTTPS''

==Методы==
'''Авторизация пользователя'''

POST /login

===Описание===
Метод для авторизации пользователя в системе Smart Satu.

Для авторизации необходимо воспользоваться выданным логином и паролем для системы заказов Smart Satu. В ответ на запрос авторизации приходит параметр - access_token_expiration_time, который в себе содержит unixtime время, когда токен станет недействителен. Порядок работы с токеном выглядит следующим образом:
# После получения токена необходимо сохранить время его истечения.
# Перед каждым запросом нужно проводить проверку, чтобы текущее время было меньше времени истечения жизни токена.
# В противном случае нужно отправить запрос на авторизацию и следовать пунктам №№ 1 и 2.

===Параметры===
{| class="wikitable"
|-
! scope="col"| Type
! scope="col"| Name
! scope="col"| Description
! scope="col"| Schema
|-
! scope="row"| Body
| '''body''' ''required''
| Авторизация пользователя
| [http://docs.smartsatu.com/wiki/%D0%90%D0%9F%D0%98#Login Login]
|}

===Ответы===

{| class="wikitable"
|-
! scope="col"| HTTP Code
! scope="col"| Description
! scope="col"| Schema
|-
| 200
| Ok
| [http://docs.smartsatu.com/wiki/%D0%90%D0%9F%D0%98#Login_Response Login Response]
|}

'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json
==Определения==
===Login===
Для авторизации необходимо воспользоваться выданным логином и паролем для системы заказов Smart Satu.
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | username
| Логин
| string
| supplier
|-
| style="font-weight:bold;" | password
| Пароль
| string
| qwerty
|-
| style="font-weight:bold;" | direction
| Идентификатор сервера
| string
| food (Запросить у Smart Satu)
|}

Пример запроса:

{
"username" : "supplier",
"password" : "qwerty",
"direction" : "food"
}

===Login Response===
В ответ на запрос придет массив данных зарегистрированного пользователя с уникальным токином авторизации - "access_token".
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор
| string
| 132
|-
| style="font-weight:bold;" | email
| Почта
| string
| daulet@smartsatu.kz
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| null
|-
| style="font-weight:bold;" | username
| Логин
| string
| supplier
|-
| style="font-weight:bold;" | first_name
| Имя
| string
| Иван
|-
| style="font-weight:bold;" | last_name
| Фамилия
| string
| Иванов
|-
| style="font-weight:bold;" | middle_name
| Отчество
| string
| Иванович
|-
| style="font-weight:bold;" | access_token
| Уникальный токен для входа
| string
| bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd
|-
| style="font-weight:bold;" | role
| Роль
| string
| 2
|-
| style="font-weight:bold;" | city_id
| Город
| string
| 1
|-
| style="font-weight:bold;" | is_document
| Лицензия
| boolean
| true
|-
| style="font-weight:bold;" | is_replacement
| Доступность обмена
| boolean
| false
|-
| style="font-weight:bold;" | currency
| Валюта
| string
| тг
|-
| style="font-weight:bold;" | price_decimals
| Количество нолей после разделителя
| string
| 2
|-
| style="font-weight:bold;" | price_radix
| Разделитель разрядов
| string
|
|-
| style="font-weight:bold;" | price_decimals_separator
| Разделитель
| string
| .
|-
| style="font-weight:bold;" | price_before_currency
| Порядок показа валюты/цены
| boolean
| true
|-
| style="font-weight:bold;" | price_pattern
| Паттерн цены
| string
| ### ###.## тг
|-
| style="font-weight:bold;" | cashback_enabled
| Доступность кэшбэка
| boolean
| true
|-
| style="font-weight:bold;" | company_id
| Идентификатор компании
| string
| 84
|-
| style="font-weight:bold;" | access_token_expiration_time
| Время действия токена доступа
| string
| 1579535438
|-
| style="font-weight:bold;" | time_zone_offset
| Часовой пояс пользователя
| string
| 21600
|-
| style="font-weight:bold;" | country
| Страна
| string
| kz
|-
| style="font-weight:bold;" | direction
| Стейджинг
| string
| Food
|-
| style="font-weight:bold;" | url_api
| URL
| string
| https://food.smartsatu.com/api
|}

Пример ответа:

{
"id": 132,
"email": "daulet@smartsatu.kz",
"phone": null,
"username": "vendoralmaty",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"access_token": "bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd",
"role": 2,
"status": 1,
"city_id": 1,
"is_document": true,
"is_replacement": false,
"currency": "тг",
"price_decimals": 2,
"price_radix": " ",
"price_decimals_separator": ".",
"price_before_currency": true,
"price_pattern": "### ###.## тг",
"cashback_enabled": true,
"company_id": 84,
"access_token_expiration_time": 1579535438,
"time_zone_offset": 21600
"country": "kz",
"direction": "Food",
"url_api": "https://food.smartsatu.com/api"
}

API Product

2023-12-15T08:11:36Z

User: /* Создание заявки на создание продуктов */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по созданию товарной карточки в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Просмотр заявки на создание продуктов===
GET /product-change-requests/{id}

===Создание заявки на создание продуктов===
POST /product-change-requests

==Описание==
===Просмотр заявки на создание продуктов===
Для того чтобы получить заявку на создание товара необходимо отправить GET-запрос c пустым телом, по URL: https://food.smartsatu.com/api/product-change-requests/{id}, где id - это уникальный идентификатор заявки на создание нового товара.
Ответом от сервера будет являться массив данных с данными заявки на создание товара.

===Создание заявки на создание продуктов===
Для того чтобы создать заявку на создание нового товара необходимо отправить POST-запрос c JSON-телом, по URL: https://food.smartsatu.com/api/product-change-requests.
Ответом от сервера будет являться сообщение с id заявки, ее статусом и комментарием.

Measure_id может принимать значения:
*1 - шт;
*9 - кг;
*11 - л.

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на создание нового товара
|
|}
==Ответы==
===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 201
| Ok
| [http://docs.smartsatu.com/wiki/API_Product#Product_Change_Request_Response_2 Product Change Request Response]
|-
| style="font-weight:bold;" | 400
| Bad Request
| [http://docs.smartsatu.com/wiki/API_Product#400 400]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Product#401 401]
|-
| style="font-weight:bold;" | 422
| Add error message
| [http://docs.smartsatu.com/wiki/API_Product#422 422]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Product Change Request===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название товара
| string
| test23
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| integer($int64)
| 123321123321
|-
| style="font-weight:bold;" | description
| Описание
| string
| test test test
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int32)
| 2
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| ABCfood
|-
| style="font-weight:bold;" | measure_id
| Единица измерения
| integer($int32)
| 11
|-
| style="font-weight:bold;" | imageFiles
| Массив
| < imageFiles > array
|
|}
imageFiles
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название изображения
| string
| test123442.jpg
|-
| style="font-weight:bold;" | data
| Данные изображения
| string
| /9j/4AAQSkZJRgABAQAAAQABAADk
|}
Пример запроса:

{
"name": "test23",
"sku": 123321123321,
"description": "test test test",
"quantity": 2,
"manufacturer": "ABCfood",
"measure_id": 11,
"imageFiles": [
[
{
"name": "test123442.jpg",
"data": "/9j/4AAQSkZJRgABAQAAAQABAADk"
}
]
]
}
===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования
| integer($int32)
| 28576
|-
| style="font-weight:bold;" | status
| Статус запроса
| integer($int32)
| 0
|-
| style="font-weight:bold;" | declined_comment
| Комментарий
| string
| null
|}
Пример ответа:

{
"id": 28576,
"status": 0,
"declined_comment": null
}
===400===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Bad Request
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Invalid JSON data in request body: Syntax error.
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 400
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\BadRequestHttpException
|}
Пример ответа:
{
"name": "Bad Request",
"message": "Invalid JSON data in request body: Syntax error.",
"code": 0,
"status": 400,
"type": "yii\\web\\BadRequestHttpException"
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===422===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | field
| Параметр
| string
| sku
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Штрихкод уже ожидает подтверждения.
|}
Пример ответа:
{
"field": "sku",
"message": "Штрихкод уже ожидает подтверждения."
}

API Product

2023-12-15T08:11:28Z

User: /* Просмотр заявки на создание продуктов */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по созданию товарной карточки в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Просмотр заявки на создание продуктов===
GET /product-change-requests/{id}

===Создание заявки на создание продуктов===
POST /product-change-requests

==Описание==
===Просмотр заявки на создание продуктов===
Для того чтобы получить заявку на создание товара необходимо отправить GET-запрос c пустым телом, по URL: https://food.smartsatu.com/api/product-change-requests/{id}, где id - это уникальный идентификатор заявки на создание нового товара.
Ответом от сервера будет являться массив данных с данными заявки на создание товара.

===Создание заявки на создание продуктов===
Для того чтобы создать заявку на создание нового товара необходимо отправить POST-запрос c JSON-телом, по URL: https://food.smartsatu.com/supplier/api/product-change-requests.
Ответом от сервера будет являться сообщение с id заявки, ее статусом и комментарием.

Measure_id может принимать значения:
*1 - шт;
*9 - кг;
*11 - л.
==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на создание нового товара
|
|}
==Ответы==
===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 201
| Ok
| [http://docs.smartsatu.com/wiki/API_Product#Product_Change_Request_Response_2 Product Change Request Response]
|-
| style="font-weight:bold;" | 400
| Bad Request
| [http://docs.smartsatu.com/wiki/API_Product#400 400]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Product#401 401]
|-
| style="font-weight:bold;" | 422
| Add error message
| [http://docs.smartsatu.com/wiki/API_Product#422 422]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Product Change Request===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название товара
| string
| test23
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| integer($int64)
| 123321123321
|-
| style="font-weight:bold;" | description
| Описание
| string
| test test test
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int32)
| 2
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| ABCfood
|-
| style="font-weight:bold;" | measure_id
| Единица измерения
| integer($int32)
| 11
|-
| style="font-weight:bold;" | imageFiles
| Массив
| < imageFiles > array
|
|}
imageFiles
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название изображения
| string
| test123442.jpg
|-
| style="font-weight:bold;" | data
| Данные изображения
| string
| /9j/4AAQSkZJRgABAQAAAQABAADk
|}
Пример запроса:

{
"name": "test23",
"sku": 123321123321,
"description": "test test test",
"quantity": 2,
"manufacturer": "ABCfood",
"measure_id": 11,
"imageFiles": [
[
{
"name": "test123442.jpg",
"data": "/9j/4AAQSkZJRgABAQAAAQABAADk"
}
]
]
}
===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования
| integer($int32)
| 28576
|-
| style="font-weight:bold;" | status
| Статус запроса
| integer($int32)
| 0
|-
| style="font-weight:bold;" | declined_comment
| Комментарий
| string
| null
|}
Пример ответа:

{
"id": 28576,
"status": 0,
"declined_comment": null
}
===400===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Bad Request
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Invalid JSON data in request body: Syntax error.
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 400
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\BadRequestHttpException
|}
Пример ответа:
{
"name": "Bad Request",
"message": "Invalid JSON data in request body: Syntax error.",
"code": 0,
"status": 400,
"type": "yii\\web\\BadRequestHttpException"
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===422===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | field
| Параметр
| string
| sku
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Штрихкод уже ожидает подтверждения.
|}
Пример ответа:
{
"field": "sku",
"message": "Штрихкод уже ожидает подтверждения."
}

API Product

2023-12-15T08:10:32Z

User: /* Создание заявки на создание продуктов */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по созданию товарной карточки в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Просмотр заявки на создание продуктов===
GET /product-change-requests/{id}

===Создание заявки на создание продуктов===
POST /product-change-requests

==Описание==
===Просмотр заявки на создание продуктов===
Для того чтобы получить заявку на создание товара необходимо отправить GET-запрос c пустым телом, по URL: https://food.smartsatu.com/supplier/api/product-change-requests/{id}, где id - это уникальный идентификатор заявки на создание нового товара.
Ответом от сервера будет являться массив данных с данными заявки на создание товара.
===Создание заявки на создание продуктов===
Для того чтобы создать заявку на создание нового товара необходимо отправить POST-запрос c JSON-телом, по URL: https://food.smartsatu.com/supplier/api/product-change-requests.
Ответом от сервера будет являться сообщение с id заявки, ее статусом и комментарием.

Measure_id может принимать значения:
*1 - шт;
*9 - кг;
*11 - л.
==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на создание нового товара
|
|}
==Ответы==
===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 201
| Ok
| [http://docs.smartsatu.com/wiki/API_Product#Product_Change_Request_Response_2 Product Change Request Response]
|-
| style="font-weight:bold;" | 400
| Bad Request
| [http://docs.smartsatu.com/wiki/API_Product#400 400]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Product#401 401]
|-
| style="font-weight:bold;" | 422
| Add error message
| [http://docs.smartsatu.com/wiki/API_Product#422 422]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Product Change Request===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название товара
| string
| test23
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| integer($int64)
| 123321123321
|-
| style="font-weight:bold;" | description
| Описание
| string
| test test test
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int32)
| 2
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| ABCfood
|-
| style="font-weight:bold;" | measure_id
| Единица измерения
| integer($int32)
| 11
|-
| style="font-weight:bold;" | imageFiles
| Массив
| < imageFiles > array
|
|}
imageFiles
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название изображения
| string
| test123442.jpg
|-
| style="font-weight:bold;" | data
| Данные изображения
| string
| /9j/4AAQSkZJRgABAQAAAQABAADk
|}
Пример запроса:

{
"name": "test23",
"sku": 123321123321,
"description": "test test test",
"quantity": 2,
"manufacturer": "ABCfood",
"measure_id": 11,
"imageFiles": [
[
{
"name": "test123442.jpg",
"data": "/9j/4AAQSkZJRgABAQAAAQABAADk"
}
]
]
}
===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования
| integer($int32)
| 28576
|-
| style="font-weight:bold;" | status
| Статус запроса
| integer($int32)
| 0
|-
| style="font-weight:bold;" | declined_comment
| Комментарий
| string
| null
|}
Пример ответа:

{
"id": 28576,
"status": 0,
"declined_comment": null
}
===400===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Bad Request
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Invalid JSON data in request body: Syntax error.
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 400
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\BadRequestHttpException
|}
Пример ответа:
{
"name": "Bad Request",
"message": "Invalid JSON data in request body: Syntax error.",
"code": 0,
"status": 400,
"type": "yii\\web\\BadRequestHttpException"
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===422===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | field
| Параметр
| string
| sku
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Штрихкод уже ожидает подтверждения.
|}
Пример ответа:
{
"field": "sku",
"message": "Штрихкод уже ожидает подтверждения."
}

API Product

2023-12-15T08:10:21Z

User: /* Просмотр заявки на создание продуктов */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по созданию товарной карточки в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Просмотр заявки на создание продуктов===
GET /product-change-requests/{id}

===Создание заявки на создание продуктов===
POST /product-change-request
==Описание==
===Просмотр заявки на создание продуктов===
Для того чтобы получить заявку на создание товара необходимо отправить GET-запрос c пустым телом, по URL: https://food.smartsatu.com/supplier/api/product-change-requests/{id}, где id - это уникальный идентификатор заявки на создание нового товара.
Ответом от сервера будет являться массив данных с данными заявки на создание товара.
===Создание заявки на создание продуктов===
Для того чтобы создать заявку на создание нового товара необходимо отправить POST-запрос c JSON-телом, по URL: https://food.smartsatu.com/supplier/api/product-change-requests.
Ответом от сервера будет являться сообщение с id заявки, ее статусом и комментарием.

Measure_id может принимать значения:
*1 - шт;
*9 - кг;
*11 - л.
==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на создание нового товара
|
|}
==Ответы==
===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 201
| Ok
| [http://docs.smartsatu.com/wiki/API_Product#Product_Change_Request_Response_2 Product Change Request Response]
|-
| style="font-weight:bold;" | 400
| Bad Request
| [http://docs.smartsatu.com/wiki/API_Product#400 400]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Product#401 401]
|-
| style="font-weight:bold;" | 422
| Add error message
| [http://docs.smartsatu.com/wiki/API_Product#422 422]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Product Change Request===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название товара
| string
| test23
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| integer($int64)
| 123321123321
|-
| style="font-weight:bold;" | description
| Описание
| string
| test test test
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int32)
| 2
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| ABCfood
|-
| style="font-weight:bold;" | measure_id
| Единица измерения
| integer($int32)
| 11
|-
| style="font-weight:bold;" | imageFiles
| Массив
| < imageFiles > array
|
|}
imageFiles
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название изображения
| string
| test123442.jpg
|-
| style="font-weight:bold;" | data
| Данные изображения
| string
| /9j/4AAQSkZJRgABAQAAAQABAADk
|}
Пример запроса:

{
"name": "test23",
"sku": 123321123321,
"description": "test test test",
"quantity": 2,
"manufacturer": "ABCfood",
"measure_id": 11,
"imageFiles": [
[
{
"name": "test123442.jpg",
"data": "/9j/4AAQSkZJRgABAQAAAQABAADk"
}
]
]
}
===Product Change Request Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования
| integer($int32)
| 28576
|-
| style="font-weight:bold;" | status
| Статус запроса
| integer($int32)
| 0
|-
| style="font-weight:bold;" | declined_comment
| Комментарий
| string
| null
|}
Пример ответа:

{
"id": 28576,
"status": 0,
"declined_comment": null
}
===400===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Bad Request
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Invalid JSON data in request body: Syntax error.
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 400
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\BadRequestHttpException
|}
Пример ответа:
{
"name": "Bad Request",
"message": "Invalid JSON data in request body: Syntax error.",
"code": 0,
"status": 400,
"type": "yii\\web\\BadRequestHttpException"
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===422===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | field
| Параметр
| string
| sku
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Штрихкод уже ожидает подтверждения.
|}
Пример ответа:
{
"field": "sku",
"message": "Штрихкод уже ожидает подтверждения."
}

API Orders

2023-12-06T06:45:42Z

User: /* Response Orders Items */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /orders

===Получение списка заказов в зависимости от статуса заказа===
GET /orders?status=
===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/orders?status=3. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в указанном статусе, а также их данными.

Также возможно получение списка заказов, начиная от определенного времени, указав нужную дату и время в '''GET-параметр "updated_from=2019-11-27T07:03:01"'''.

''Пример: https://food.smartsatu.com/api/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id на самом деле id в order_items, а не offer_id - идентификатор предложения. 

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят без изменений",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Изменена дата доставки и количество товара",
"delivery_date": "09.10.2019",
"items":
[
{
"quantity": 50,
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| decimal
| 11340.00
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| string
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| Массив
| < order_items > array
|
|-
| style="font-weight:bold;" | supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| Массив
| < store_company > array
|
|-
| style="font-weight:bold;" | service_fee_amount
| Сумма сервисного сбора
| decimal
| 300.00
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| Массив
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

API Orders

2023-07-06T10:21:12Z

User: /* Изменение и корректировка заказа поставщиком */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /orders

===Получение списка заказов в зависимости от статуса заказа===
GET /orders?status=
===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/orders?status=3. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в указанном статусе, а также их данными.

Также возможно получение списка заказов, начиная от определенного времени, указав нужную дату и время в '''GET-параметр "updated_from=2019-11-27T07:03:01"'''.

''Пример: https://food.smartsatu.com/api/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id на самом деле id в order_items, а не offer_id - идентификатор предложения. 

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят без изменений",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Изменена дата доставки и количество товара",
"delivery_date": "09.10.2019",
"items":
[
{
"quantity": 50,
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders Items===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| integer
| 11340
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| string
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| Массив
| < order_items > array
|
|-
| style="font-weight:bold;" | Supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| Массив
| < store_company > array
|
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| Массив
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

API Orders

2023-07-06T10:14:24Z

User: /* Request Order Status Change */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /orders

===Получение списка заказов в зависимости от статуса заказа===
GET /orders?status=
===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/orders?status=3. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в указанном статусе, а также их данными.

Также возможно получение списка заказов, начиная от определенного времени, указав нужную дату и время в '''GET-параметр "updated_from=2019-11-27T07:03:01"'''.

''Пример: https://food.smartsatu.com/api/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id на самом деле id в order_items, а не offer_id - идентификатор предложения. 

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят в обработку",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Изменена дата доставки и количество товара",
"delivery_date": "09.10.2019",
"items":
[
{
"quantity": 50,
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders Items===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| integer
| 11340
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| string
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| Массив
| < order_items > array
|
|-
| style="font-weight:bold;" | Supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| Массив
| < store_company > array
|
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| Массив
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

API Orders

2023-07-06T10:13:25Z

User: /* Request Order Status Change */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /orders

===Получение списка заказов в зависимости от статуса заказа===
GET /orders?status=
===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/orders?status=3. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в указанном статусе, а также их данными.

Также возможно получение списка заказов, начиная от определенного времени, указав нужную дату и время в '''GET-параметр "updated_from=2019-11-27T07:03:01"'''.

''Пример: https://food.smartsatu.com/api/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id на самом деле id в order_items, а не offer_id - идентификатор предложения. 

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят в обработку",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Вот такой комментарий ",
"delivery_date": "09.10.2019",
"items":
[
{
"quantity": 50,
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders Items===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| integer
| 11340
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| string
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| Массив
| < order_items > array
|
|-
| style="font-weight:bold;" | Supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| Массив
| < store_company > array
|
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| Массив
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

API Authorization

2023-05-19T12:46:18Z

User: /* Обзор */

API Авторизации

==Обзор==
''Данный документа описывает метод авторизации поставщика/дистрибьютора в системе Smart Satu.''

Авторизация пользователя в систему Smart Satu происходит путем отправки POST-запроса с логином и паролем пользователя в JSON-теле по URL: https://food.smartsatu.com/api/users/login. Headers в данном запросе не могут быть пустыми и должны содержать: "content-type: application/json; charset=utf-8" и "country: ru".

Далее на стороне сервера происходит валидация данных пользователя. В случае корректности данных сервер выдает JSON-тело ответа, которое содержит данные пользователя с уникальным токеном авторизации, который в дальнейшем будет использоваться в каждом последующем запросе к системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/users/login/ Schemes : HTTPS''

==Методы==
'''Авторизация пользователя'''

POST /login

===Описание===
Метод для авторизации пользователя в системе Smart Satu.

Для авторизации необходимо воспользоваться выданным логином и паролем для системы заказов Smart Satu. В ответ на запрос авторизации приходит параметр - access_token_expiration_time, который в себе содержит unixtime время, когда токен станет недействителен. Порядок работы с токеном выглядит следующим образом:
# После получения токена необходимо сохранить время его истечения.
# Перед каждым запросом нужно проводить проверку, чтобы текущее время было меньше времени истечения жизни токена.
# В противном случае нужно отправить запрос на авторизацию и следовать пунктам №№ 1 и 2.

===Параметры===
{| class="wikitable"
|-
! scope="col"| Type
! scope="col"| Name
! scope="col"| Description
! scope="col"| Schema
|-
! scope="row"| Body
| '''body''' ''required''
| Авторизация пользователя
| [http://docs.smartsatu.com/wiki/%D0%90%D0%9F%D0%98#Login Login]
|}

===Ответы===

{| class="wikitable"
|-
! scope="col"| HTTP Code
! scope="col"| Description
! scope="col"| Schema
|-
| 200
| Ok
| [http://docs.smartsatu.com/wiki/%D0%90%D0%9F%D0%98#Login_Response Login Response]
|}

'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json
==Определения==
===Login===
Для авторизации необходимо воспользоваться выданным логином и паролем для системы заказов Smart Satu.
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | login
| Логин
| string
| supplier
|-
| style="font-weight:bold;" | password
| Пароль
| string
| qwerty
|-
| style="font-weight:bold;" | direction
| Идентификатор сервера
| string
| food (Запросить у Smart Satu)
|}

Пример запроса:

{
"username" : "supplier",
"password" : "qwerty",
"direction" : "food"
}

===Login Response===
В ответ на запрос придет массив данных зарегистрированного пользователя с уникальным токином авторизации - "access_token".
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор
| string
| 132
|-
| style="font-weight:bold;" | email
| Почта
| string
| daulet@smartsatu.kz
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| null
|-
| style="font-weight:bold;" | username
| Логин
| string
| supplier
|-
| style="font-weight:bold;" | first_name
| Имя
| string
| Иван
|-
| style="font-weight:bold;" | last_name
| Фамилия
| string
| Иванов
|-
| style="font-weight:bold;" | middle_name
| Отчество
| string
| Иванович
|-
| style="font-weight:bold;" | access_token
| Уникальный токен для входа
| string
| bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd
|-
| style="font-weight:bold;" | role
| Роль
| string
| 2
|-
| style="font-weight:bold;" | city_id
| Город
| string
| 1
|-
| style="font-weight:bold;" | is_document
| Лицензия
| boolean
| true
|-
| style="font-weight:bold;" | is_replacement
| Доступность обмена
| boolean
| false
|-
| style="font-weight:bold;" | currency
| Валюта
| string
| тг
|-
| style="font-weight:bold;" | price_decimals
| Количество нолей после разделителя
| string
| 2
|-
| style="font-weight:bold;" | price_radix
| Разделитель разрядов
| string
|
|-
| style="font-weight:bold;" | price_decimals_separator
| Разделитель
| string
| .
|-
| style="font-weight:bold;" | price_before_currency
| Порядок показа валюты/цены
| boolean
| true
|-
| style="font-weight:bold;" | price_pattern
| Паттерн цены
| string
| ### ###.## тг
|-
| style="font-weight:bold;" | cashback_enabled
| Доступность кэшбэка
| boolean
| true
|-
| style="font-weight:bold;" | company_id
| Идентификатор компании
| string
| 84
|-
| style="font-weight:bold;" | access_token_expiration_time
| Время действия токена доступа
| string
| 1579535438
|-
| style="font-weight:bold;" | time_zone_offset
| Часовой пояс пользователя
| string
| 21600
|-
| style="font-weight:bold;" | country
| Страна
| string
| kz
|-
| style="font-weight:bold;" | direction
| Стейджинг
| string
| Food
|-
| style="font-weight:bold;" | url_api
| URL
| string
| https://food.smartsatu.com/api
|}

Пример ответа:

{
"id": 132,
"email": "daulet@smartsatu.kz",
"phone": null,
"username": "vendoralmaty",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"access_token": "bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd",
"role": 2,
"status": 1,
"city_id": 1,
"is_document": true,
"is_replacement": false,
"currency": "тг",
"price_decimals": 2,
"price_radix": " ",
"price_decimals_separator": ".",
"price_before_currency": true,
"price_pattern": "### ###.## тг",
"cashback_enabled": true,
"company_id": 84,
"access_token_expiration_time": 1579535438,
"time_zone_offset": 21600
"country": "kz",
"direction": "Food",
"url_api": "https://food.smartsatu.com/api"
}

API Authorization

2023-05-19T12:43:01Z

User: /* Login */

API Авторизации

==Обзор==
''Данный документа описывает метод авторизации поставщика/дистрибьютора в системе Smart Satu.''

Авторизация пользователя в систему Smart Satu происходит путем отправки POST-запроса с логином и паролем пользователя в JSON-теле по URL: https://food.smartsatu.com/api/users/login. Headers в данном запросе не могут быть пустыми и должны содержать: "content-type: application/json; charset=utf-8" и "Country: ru".

Далее на стороне сервера происходит валидация данных пользователя. В случае корректности данных сервер выдает JSON-тело ответа, которое содержит данные пользователя с уникальным токеном авторизации, который в дальнейшем будет использоваться в каждом последующем запросе к системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/users/login/ Schemes : HTTPS''

==Методы==
'''Авторизация пользователя'''

POST /login

===Описание===
Метод для авторизации пользователя в системе Smart Satu.

Для авторизации необходимо воспользоваться выданным логином и паролем для системы заказов Smart Satu. В ответ на запрос авторизации приходит параметр - access_token_expiration_time, который в себе содержит unixtime время, когда токен станет недействителен. Порядок работы с токеном выглядит следующим образом:
# После получения токена необходимо сохранить время его истечения.
# Перед каждым запросом нужно проводить проверку, чтобы текущее время было меньше времени истечения жизни токена.
# В противном случае нужно отправить запрос на авторизацию и следовать пунктам №№ 1 и 2.

===Параметры===
{| class="wikitable"
|-
! scope="col"| Type
! scope="col"| Name
! scope="col"| Description
! scope="col"| Schema
|-
! scope="row"| Body
| '''body''' ''required''
| Авторизация пользователя
| [http://docs.smartsatu.com/wiki/%D0%90%D0%9F%D0%98#Login Login]
|}

===Ответы===

{| class="wikitable"
|-
! scope="col"| HTTP Code
! scope="col"| Description
! scope="col"| Schema
|-
| 200
| Ok
| [http://docs.smartsatu.com/wiki/%D0%90%D0%9F%D0%98#Login_Response Login Response]
|}

'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json
==Определения==
===Login===
Для авторизации необходимо воспользоваться выданным логином и паролем для системы заказов Smart Satu.
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | login
| Логин
| string
| supplier
|-
| style="font-weight:bold;" | password
| Пароль
| string
| qwerty
|-
| style="font-weight:bold;" | direction
| Идентификатор сервера
| string
| food (Запросить у Smart Satu)
|}

Пример запроса:

{
"username" : "supplier",
"password" : "qwerty",
"direction" : "food"
}

===Login Response===
В ответ на запрос придет массив данных зарегистрированного пользователя с уникальным токином авторизации - "access_token".
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор
| string
| 132
|-
| style="font-weight:bold;" | email
| Почта
| string
| daulet@smartsatu.kz
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| null
|-
| style="font-weight:bold;" | username
| Логин
| string
| supplier
|-
| style="font-weight:bold;" | first_name
| Имя
| string
| Иван
|-
| style="font-weight:bold;" | last_name
| Фамилия
| string
| Иванов
|-
| style="font-weight:bold;" | middle_name
| Отчество
| string
| Иванович
|-
| style="font-weight:bold;" | access_token
| Уникальный токен для входа
| string
| bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd
|-
| style="font-weight:bold;" | role
| Роль
| string
| 2
|-
| style="font-weight:bold;" | city_id
| Город
| string
| 1
|-
| style="font-weight:bold;" | is_document
| Лицензия
| boolean
| true
|-
| style="font-weight:bold;" | is_replacement
| Доступность обмена
| boolean
| false
|-
| style="font-weight:bold;" | currency
| Валюта
| string
| тг
|-
| style="font-weight:bold;" | price_decimals
| Количество нолей после разделителя
| string
| 2
|-
| style="font-weight:bold;" | price_radix
| Разделитель разрядов
| string
|
|-
| style="font-weight:bold;" | price_decimals_separator
| Разделитель
| string
| .
|-
| style="font-weight:bold;" | price_before_currency
| Порядок показа валюты/цены
| boolean
| true
|-
| style="font-weight:bold;" | price_pattern
| Паттерн цены
| string
| ### ###.## тг
|-
| style="font-weight:bold;" | cashback_enabled
| Доступность кэшбэка
| boolean
| true
|-
| style="font-weight:bold;" | company_id
| Идентификатор компании
| string
| 84
|-
| style="font-weight:bold;" | access_token_expiration_time
| Время действия токена доступа
| string
| 1579535438
|-
| style="font-weight:bold;" | time_zone_offset
| Часовой пояс пользователя
| string
| 21600
|-
| style="font-weight:bold;" | country
| Страна
| string
| kz
|-
| style="font-weight:bold;" | direction
| Стейджинг
| string
| Food
|-
| style="font-weight:bold;" | url_api
| URL
| string
| https://food.smartsatu.com/api
|}

Пример ответа:

{
"id": 132,
"email": "daulet@smartsatu.kz",
"phone": null,
"username": "vendoralmaty",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"access_token": "bkoUdBoAd1_jlIjwcMfttTNlH15y3Rnd",
"role": 2,
"status": 1,
"city_id": 1,
"is_document": true,
"is_replacement": false,
"currency": "тг",
"price_decimals": 2,
"price_radix": " ",
"price_decimals_separator": ".",
"price_before_currency": true,
"price_pattern": "### ###.## тг",
"cashback_enabled": true,
"company_id": 84,
"access_token_expiration_time": 1579535438,
"time_zone_offset": 21600
"country": "kz",
"direction": "Food",
"url_api": "https://food.smartsatu.com/api"
}

API Offers

2022-06-02T12:40:19Z

User: /* Обновление остатков */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению списка предложений, а также изменению, удалению и импорту предложений в системе Smart Satu.

Предложение - это цена, которую предлагает поставщик за определенный товар. Также система Smart Satu позволяет загружать как общие предложения, которые доступны всем торговым точкам, так индивидуальные для конкретных магазинов.

Больше информации по предложениям находится по ссылке: [http://docs.smartsatu.com/wiki/SmartSatuSupplier#.D0.A0.D0.B0.D0.B1.D0.BE.D1.82.D0.B0_.D1.81_.D0.BF.D1.80.D0.B5.D0.B4.D0.BB.D0.BE.D0.B6.D0.B5.D0.BD.D0.B8.D1.8F.D0.BC.D0.B8 Работа с предложениями]

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Импорт предложений===
POST /offers/import?start=1
===Получение списка предложений===
GET /offers
===Изменение предложений===
PUT /offers/{sku}

===Удаление предложений===
DELETE /offers/{sku}

==Описание==
===Батчевый импорт предложений===
Данный метод предназначен для оптового импорта предложений (batch) в систему с ограничением в 1000 предложений в одном запросе.
Первый запрос должен отправляться с параметром <code>start=1</code>
<code>https://food.smartsatu.com/api/offers/import?start=1</code>
В ответ первого запроса вы получите транзакционный идентификатор очереди вида:
{
'id': '98db89147d6cd0018417b71'
}
Для всех последующих запросов на импорт предложений, вам необходимо добавлять транзакционный идентификатор в параметры запроса:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71</code>
Для того чтобы закончить оптовый импорт предложений в систему, необходимо отправить запрос с параметром end=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1</code>
Если вам необходимо удалить все старые предложения, то в последнем запросе необходимо передать параметр delete=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1&delete=1</code>

В атрибуте 'comment' в JSON-ответе описываются причины ошибок.

Для того чтобы осуществить батчевую '''загрузку персональных прайсов (для конкретной торговой точки)''' необходимо указать в get параметрах запроса <code>store_id</code> (id торговой точки):
<code>https://food.smartsatu.com/api/offers/import?start=1&end=1&delete=1&store_id=80</code>

Рекомендации по батчевой загрузке предложений:
Рекомендуем прогружать по 500-1000 предложений в одном запросе. Т.к. если прайс-лист до 1000 предложений, то его можно прогрузить одним запросом. Для этого в запросе на батчевую загрузку устанавливаются флаги старта и окончания очереди: offers/import?start=1&end=1.
Прайс-лист может быть больше чем 1000 штук. Так, если прайс-лист содержит больше 1000 предложений, то открывается очередь с первым запросом с первой 1000 предложений: offers/import?start=1. В ответе вернется id очереди.
С последующими запросами нужно будет слать id очереди в get параметрах offers/import?id=XXXX.
C последним чанком большого прайс-листа нужно будет послать флаг окончания offers/import?id=XXXX&end=1.
'''NB!''' Допустим нужно загрузить 5000 предложений. Мы отправляем первый запрос с 1000 предложений и получаем в ответ идентификатор очереди. Дальше посылаем еще 4 запроса с 1000 предложений в каждом запросе и идентификатором очереди. При этом в последнем запросе нужно отправить параметр end=1, который зыкрывает очередь и является тригером для обработчика на загрузку предложений в систему. Если очередь не будет закрыта, то она не будет обработана и загружена в систему.

Чтобы удалить старый прайс-лист, нужно послать флаг удаления с первым или последним чанком offers/import?id=XXXX&delete=1. Если это прайс загружаемый одним запросом, то в get параметрах указываем все три флага (start, end, delete) offers/import?start=1&end=1&delete=1

В предложениях доступна загрузка '''Акций''' с типом '''"Выгодная цена"''' - фактическая скидка на товар. Для этого в предложении необходимо указать первоначальную цену Price 1 (для магазина), Price 2 (для ХоРеКа) и конечную промо-цену Price 5.
Таким образом для Торговой точки в каталоге товаров предложения с Выгодной ценой отображаются с перечеркнутой старой ценой (Price 1 или Price 2) и итоговая промо-цена (Price 5). Кроме того, предложение дополнительно помечается иконкой акции "%".

Для временно отсутствующего у поставщика товара в поле <code>quantity</code> предложения указывается значение <code>0</code> (ноль). Торговым точкам товар будет отображен с пометкой "нет в наличии". Добавить в корзину и заказать такой товар торговые точки не смогут.

ВАЖНО: значение Quantum (количество товара в фасовке/упаковке) обязательно должно быть кратно значению minQuantity (минимальное количество данного товара, которое ТТ обязано купить для оформления заказа). Если значения не пройдут валидацию, то добавится только значение Quantum.
Например:
Поставщик выставил предложение на товар по цене 1100 руб за единицу. Фасовка (quantum) осуществляется по 10 шт. Минимальное количество в заказе (minQuantity) - 30 шт. Для успешного заказа торговая точка первоначально добавляет в корзину 30 шт товара (сумма заказа составит 1100 * 30), далее добавление в корзину будет происходить с шагом в 10 шт.

===Получение списка предложений===
Для того чтобы получить список всех предложений, необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/offers. Ответом от сервера будет являться массив данных со списком всех ваших предложений в системе Smart Satu с их данными.
===Редактирование предложения===
Для того чтобы отредактировать предложения требуется добавить в запрос SKU данного предложения.
''Пример: https://food.smartsatu.site/api/offers/9876786897623''

Вместе с данным параметром мы отправляем JSON-тело запроса на изменение.

===Обновление остатков===
Для загрузки измененного количества товара (остатков) необходимо использовать API https://food.smartsatu.com/api/offers/import-only-quantity?start=1&end=1, в запросе к которому передается массив товаров ('''sku''' либо '''unique_code''') с актуальными значениями остатков:
[
{
"sku": null,
"unique_code": "48700034204351",
"quantity": 30,
}
]
Для обновления остатков в определенном персональном прайслисте необходимо в параметре '''store_id''' указать идентификатор торговой точки:
https://food.smartsatu.com/api/offers/import-only-quantity?start=1&end=1&store_id=9576

===Удаление предложения===
Для того чтобы изменить предложение, необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}, где sku - это штрих-код предложения, которое необходимо изменить.
Ответом от сервера будет являться массив данных с измененными данными предложения.

Для удаления конкретного предложения из всех прайс-листов (как общих, так и индивидульных) необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}/all, где sku - это штрих-код предложения, которое необходимо изменить. ''Пример: https://food.smartsatu.com/api/offers/5053990106868/all''

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение предложения
|
|}
==Ответы==
'''Offers Import Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Import_Response Offers Import Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|}
'''Offers Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Response Offers Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Offers#401 401]
|}
'''Offers Response (изменение):'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|}
'''Delete Offer:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 204
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|-
| style="font-weight:bold;" | 404
| Not Found
| [http://docs.smartsatu.com/wiki/API_Offers#404 404]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Импорт предложений===
POST /offers/import?start=1

====Offers Import Request====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| varchar(255)
| 9876786897623
|-
| style="font-weight:bold;" | unit
| Единица измерения
| varchar(50)
| шт / кг
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. Пока слать 1 (есть в наличии) или 0 (нет в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_without_vat
| Цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | promotion_price_without_vat
| Промо цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | delivery_days
| Дни доставки* '''На данный момент данный параметр не используется! Вся функциональность по настройке дней доставки регулируется через WEB-интерфейс'''
| varchar(127)
| "1,2,3,4,5,6,0"
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения '''Сервисное поле поставщика. Возвращается в заказе. Например, GUID для 1С.'''
| varchar(255)
| string / null
|-
| style="font-weight:bold;" | quantum
| Квант поставки
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | isImport
| Импортировать предложение (да/нет)
| boolean
| 1 / 0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "product1",
"sku": "9876786897623",
"store_id": null
"unit": "",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 555,
"price_2": null,
"price_3": null,
"price_4": null,
"price_5": null *Указание выгодной цены,
"price_without_vat": null,
"promotion_price_without_vat": null,
"delivery_days": "1,2,3,4,5,6,0",
"unique_code": null, //тут может быть GUID
"quantum": 5.000,
"isImport": "1",
"minQuantity": 5.000,
"status": 1
}
]

====Offers Import Response====
{| class="wikitable"
|-
! Name !! Description !! Schema !! Example
|-
| '''id''' || Идентификатор очереди || string || 5d720cfee9d7c84ad038ff41
|-
| '''count''' || Количество предложений || integer || 2
|-
| '''comment''' || Комментарий || string || null
|}
Пример ответа:
{
"id": "5d720cfee9d7c84ad038ff41",
"count": 2,
"comment": null
}

===Изменение предложений===
PUT /offers/{sku}

====Offers Request (изменение)====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. 0 (нет в наличии), 1 или более (есть в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет)
| string
| 1
|-
| style="font-weight:bold;" | quantum
| Квант
| decimal(19,3)
| 8.0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "Обновленное название предложения",
"manufacturer": "",
"quantity": 100,
"expires_at": null,
"price_1": 333,
"price_2": 500,
"price_3": null,
"price_4": null,
"price_5": null,
"status": 1
"quantum": 8.0,
"minQuantity": null, //нет требования по минимальному количеству в заказе
"status": 1
}
]

====Offers Response====
'''NB!''' Ответ приходит в json и по факту это string. За парсинг и выбор типа значений отвечает сторона поставщика.
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования предложения в системе SmartSatu
| integer
| 4317231
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| 425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA
|-
| style="font-weight:bold;" | sku
| Артикул предложения
| string
| 4870007151458
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 329
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 329
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| null
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения '''Идентификатор предложения у поставщика'''
| string
| 141209
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта (идентификатор товарной карточки в системе SmartSatu)
| string
| 28952
|-
| style="font-weight:bold;" | step
| Квант поставки (quantum)
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| null
|}
Пример ответа:

[
{
"id": 4317231,
"name": "425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA",
"sku": 870007151458,
"unit": "шт",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 329,
"price_2": 329,
"price_3": null,
"price_4": null,
"price_5": null,
"unique_code": "141209",
"product_id": null,
"step": null,
"minQuantity": null
}
]

===Удаление предложений===
DELETE /offers/{sku}
====Delete Offer====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | status
| Код
| integer
| 204
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение удалено
|}
Пример ответа:
{
"status": 204,
"message": "Предложение удалено."
}

===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

===404===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Not Found
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение не существует, удалено либо недоступно
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 404
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:

{
"name": "Not Found",
"message": "Предложение не существует, удалено либо недоступно",
"code": 0,
"status": 404,
"type": "yii\\web\\HttpException"
}

API Offers

2022-06-02T12:38:10Z

User: /* Обновление остатков */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению списка предложений, а также изменению, удалению и импорту предложений в системе Smart Satu.

Предложение - это цена, которую предлагает поставщик за определенный товар. Также система Smart Satu позволяет загружать как общие предложения, которые доступны всем торговым точкам, так индивидуальные для конкретных магазинов.

Больше информации по предложениям находится по ссылке: [http://docs.smartsatu.com/wiki/SmartSatuSupplier#.D0.A0.D0.B0.D0.B1.D0.BE.D1.82.D0.B0_.D1.81_.D0.BF.D1.80.D0.B5.D0.B4.D0.BB.D0.BE.D0.B6.D0.B5.D0.BD.D0.B8.D1.8F.D0.BC.D0.B8 Работа с предложениями]

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Импорт предложений===
POST /offers/import?start=1
===Получение списка предложений===
GET /offers
===Изменение предложений===
PUT /offers/{sku}

===Удаление предложений===
DELETE /offers/{sku}

==Описание==
===Батчевый импорт предложений===
Данный метод предназначен для оптового импорта предложений (batch) в систему с ограничением в 1000 предложений в одном запросе.
Первый запрос должен отправляться с параметром <code>start=1</code>
<code>https://food.smartsatu.com/api/offers/import?start=1</code>
В ответ первого запроса вы получите транзакционный идентификатор очереди вида:
{
'id': '98db89147d6cd0018417b71'
}
Для всех последующих запросов на импорт предложений, вам необходимо добавлять транзакционный идентификатор в параметры запроса:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71</code>
Для того чтобы закончить оптовый импорт предложений в систему, необходимо отправить запрос с параметром end=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1</code>
Если вам необходимо удалить все старые предложения, то в последнем запросе необходимо передать параметр delete=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1&delete=1</code>

В атрибуте 'comment' в JSON-ответе описываются причины ошибок.

Для того чтобы осуществить батчевую '''загрузку персональных прайсов (для конкретной торговой точки)''' необходимо указать в get параметрах запроса <code>store_id</code> (id торговой точки):
<code>https://food.smartsatu.com/api/offers/import?start=1&end=1&delete=1&store_id=80</code>

Рекомендации по батчевой загрузке предложений:
Рекомендуем прогружать по 500-1000 предложений в одном запросе. Т.к. если прайс-лист до 1000 предложений, то его можно прогрузить одним запросом. Для этого в запросе на батчевую загрузку устанавливаются флаги старта и окончания очереди: offers/import?start=1&end=1.
Прайс-лист может быть больше чем 1000 штук. Так, если прайс-лист содержит больше 1000 предложений, то открывается очередь с первым запросом с первой 1000 предложений: offers/import?start=1. В ответе вернется id очереди.
С последующими запросами нужно будет слать id очереди в get параметрах offers/import?id=XXXX.
C последним чанком большого прайс-листа нужно будет послать флаг окончания offers/import?id=XXXX&end=1.
'''NB!''' Допустим нужно загрузить 5000 предложений. Мы отправляем первый запрос с 1000 предложений и получаем в ответ идентификатор очереди. Дальше посылаем еще 4 запроса с 1000 предложений в каждом запросе и идентификатором очереди. При этом в последнем запросе нужно отправить параметр end=1, который зыкрывает очередь и является тригером для обработчика на загрузку предложений в систему. Если очередь не будет закрыта, то она не будет обработана и загружена в систему.

Чтобы удалить старый прайс-лист, нужно послать флаг удаления с первым или последним чанком offers/import?id=XXXX&delete=1. Если это прайс загружаемый одним запросом, то в get параметрах указываем все три флага (start, end, delete) offers/import?start=1&end=1&delete=1

В предложениях доступна загрузка '''Акций''' с типом '''"Выгодная цена"''' - фактическая скидка на товар. Для этого в предложении необходимо указать первоначальную цену Price 1 (для магазина), Price 2 (для ХоРеКа) и конечную промо-цену Price 5.
Таким образом для Торговой точки в каталоге товаров предложения с Выгодной ценой отображаются с перечеркнутой старой ценой (Price 1 или Price 2) и итоговая промо-цена (Price 5). Кроме того, предложение дополнительно помечается иконкой акции "%".

Для временно отсутствующего у поставщика товара в поле <code>quantity</code> предложения указывается значение <code>0</code> (ноль). Торговым точкам товар будет отображен с пометкой "нет в наличии". Добавить в корзину и заказать такой товар торговые точки не смогут.

ВАЖНО: значение Quantum (количество товара в фасовке/упаковке) обязательно должно быть кратно значению minQuantity (минимальное количество данного товара, которое ТТ обязано купить для оформления заказа). Если значения не пройдут валидацию, то добавится только значение Quantum.
Например:
Поставщик выставил предложение на товар по цене 1100 руб за единицу. Фасовка (quantum) осуществляется по 10 шт. Минимальное количество в заказе (minQuantity) - 30 шт. Для успешного заказа торговая точка первоначально добавляет в корзину 30 шт товара (сумма заказа составит 1100 * 30), далее добавление в корзину будет происходить с шагом в 10 шт.

===Получение списка предложений===
Для того чтобы получить список всех предложений, необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/offers. Ответом от сервера будет являться массив данных со списком всех ваших предложений в системе Smart Satu с их данными.
===Редактирование предложения===
Для того чтобы отредактировать предложения требуется добавить в запрос SKU данного предложения.
''Пример: https://food.smartsatu.site/api/offers/9876786897623''

Вместе с данным параметром мы отправляем JSON-тело запроса на изменение.

===Обновление остатков===
Для загрузки измененного количества товара (остатков) необходимо использовать API https://food.smartsatu.com/api/offers/import-only-quantity?start=1&end=1, в запросе к которому передается массив товаров ('''sku''' либо '''unique_code''') с актуальными значениями остатков:
[
{
"sku": null,
"unique_code": "48700034204351",
"quantity": 30,
}
]
Для обновления остатков в определенных персональных прайслистах необходимо в параметре '''store_id''' указать массив идентификаторов торговых точек:
https://food.smartsatu.com/api/offers/import-only-quantity?start=1&end=1&store_id=9576

===Удаление предложения===
Для того чтобы изменить предложение, необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}, где sku - это штрих-код предложения, которое необходимо изменить.
Ответом от сервера будет являться массив данных с измененными данными предложения.

Для удаления конкретного предложения из всех прайс-листов (как общих, так и индивидульных) необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}/all, где sku - это штрих-код предложения, которое необходимо изменить. ''Пример: https://food.smartsatu.com/api/offers/5053990106868/all''

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение предложения
|
|}
==Ответы==
'''Offers Import Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Import_Response Offers Import Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|}
'''Offers Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Response Offers Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Offers#401 401]
|}
'''Offers Response (изменение):'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|}
'''Delete Offer:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 204
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|-
| style="font-weight:bold;" | 404
| Not Found
| [http://docs.smartsatu.com/wiki/API_Offers#404 404]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Импорт предложений===
POST /offers/import?start=1

====Offers Import Request====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| varchar(255)
| 9876786897623
|-
| style="font-weight:bold;" | unit
| Единица измерения
| varchar(50)
| шт / кг
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. Пока слать 1 (есть в наличии) или 0 (нет в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_without_vat
| Цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | promotion_price_without_vat
| Промо цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | delivery_days
| Дни доставки* '''На данный момент данный параметр не используется! Вся функциональность по настройке дней доставки регулируется через WEB-интерфейс'''
| varchar(127)
| "1,2,3,4,5,6,0"
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения '''Сервисное поле поставщика. Возвращается в заказе. Например, GUID для 1С.'''
| varchar(255)
| string / null
|-
| style="font-weight:bold;" | quantum
| Квант поставки
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | isImport
| Импортировать предложение (да/нет)
| boolean
| 1 / 0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "product1",
"sku": "9876786897623",
"store_id": null
"unit": "",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 555,
"price_2": null,
"price_3": null,
"price_4": null,
"price_5": null *Указание выгодной цены,
"price_without_vat": null,
"promotion_price_without_vat": null,
"delivery_days": "1,2,3,4,5,6,0",
"unique_code": null, //тут может быть GUID
"quantum": 5.000,
"isImport": "1",
"minQuantity": 5.000,
"status": 1
}
]

====Offers Import Response====
{| class="wikitable"
|-
! Name !! Description !! Schema !! Example
|-
| '''id''' || Идентификатор очереди || string || 5d720cfee9d7c84ad038ff41
|-
| '''count''' || Количество предложений || integer || 2
|-
| '''comment''' || Комментарий || string || null
|}
Пример ответа:
{
"id": "5d720cfee9d7c84ad038ff41",
"count": 2,
"comment": null
}

===Изменение предложений===
PUT /offers/{sku}

====Offers Request (изменение)====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. 0 (нет в наличии), 1 или более (есть в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет)
| string
| 1
|-
| style="font-weight:bold;" | quantum
| Квант
| decimal(19,3)
| 8.0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "Обновленное название предложения",
"manufacturer": "",
"quantity": 100,
"expires_at": null,
"price_1": 333,
"price_2": 500,
"price_3": null,
"price_4": null,
"price_5": null,
"status": 1
"quantum": 8.0,
"minQuantity": null, //нет требования по минимальному количеству в заказе
"status": 1
}
]

====Offers Response====
'''NB!''' Ответ приходит в json и по факту это string. За парсинг и выбор типа значений отвечает сторона поставщика.
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования предложения в системе SmartSatu
| integer
| 4317231
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| 425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA
|-
| style="font-weight:bold;" | sku
| Артикул предложения
| string
| 4870007151458
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 329
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 329
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| null
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения '''Идентификатор предложения у поставщика'''
| string
| 141209
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта (идентификатор товарной карточки в системе SmartSatu)
| string
| 28952
|-
| style="font-weight:bold;" | step
| Квант поставки (quantum)
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| null
|}
Пример ответа:

[
{
"id": 4317231,
"name": "425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA",
"sku": 870007151458,
"unit": "шт",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 329,
"price_2": 329,
"price_3": null,
"price_4": null,
"price_5": null,
"unique_code": "141209",
"product_id": null,
"step": null,
"minQuantity": null
}
]

===Удаление предложений===
DELETE /offers/{sku}
====Delete Offer====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | status
| Код
| integer
| 204
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение удалено
|}
Пример ответа:
{
"status": 204,
"message": "Предложение удалено."
}

===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

===404===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Not Found
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение не существует, удалено либо недоступно
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 404
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:

{
"name": "Not Found",
"message": "Предложение не существует, удалено либо недоступно",
"code": 0,
"status": 404,
"type": "yii\\web\\HttpException"
}

API Orders

2022-02-17T14:36:00Z

User:

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению полного или отсортированного по статусу списка заказов, а также изменению и корректировке заказа поставщиком в системе Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Получение списка заказов===
GET /orders

===Получение списка заказов в зависимости от статуса заказа===
GET /orders?status=
===Изменение и корректировка заказа поставщиком===
PUT /orders/{id}

==Описание==
===Получение списка заказов===
Для того чтобы получить список всех заказов необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в системе Smart Satu с их данными.
Во всех заказах передается тип оплаты "payment_type", где:
*0 = оплата заказа наличными;
*1 = оплата заказа оборотными средствами;
*2 = оплата заказа по Visa QR;
*3 = оплата заказа по безналичному расчету;
*4 = оплата заказа по Raiffeisen QR;
*5 = оплата заказа корпоративной картой.

===Получение списка заказов в зависимости от статуса заказа===
Для того чтобы получить список заказов имеющих определенный статус необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/orders. В строке запроса необходимо добавить параметр статуса и его значение (?status=1). В итоге получаем запрос вида: https://food.smartsatu.com/api/orders?status=3. В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех ваших заказов в указанном статусе, а также их данными.

Также возможно получение списка заказов, начиная от определенного времени, указав нужную дату и время в '''GET-параметр "updated_from=2019-11-27T07:03:01"'''.

''Пример: https://food.smartsatu.com/api/orders?status=7&updated_from=2019-11-27T07:03:01''

Перечень статусов заказа:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=1
| Новый - заказ создан Торговой точкой
|-
| style="font-weight:bold;" | status=2
| Принят - заказ в статусе "Новый" принят Поставщиком
|-
| style="font-weight:bold;" | status=3
| Отклонен поставщиком - заказ в статусе "Новый" отклонен Поставщиком
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой - заказ в статусе "Новый" принят Поставщиком с изменениями: откорректировано количество товара, изменена дата доставки
|-
| style="font-weight:bold;" | status=5
| Подтвержден - заказ в статусе "Принят с корректировкой" принят Торговой точкой: ТТ согласна с внесенными в заказ изменениями
|-
| style="font-weight:bold;" | status=6
| Отменен магазином - заказ в статусе "Принят с корректировкой" отклонен Торговой точкой: ТТ не принимает внесенные в заказ изменениями
|-
| style="font-weight:bold;" | status=7
| Выполнен - заказ в статусе "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла все товары без изменений и подтвердила доставку
|-
| style="font-weight:bold;" | status=8
| Не доставлен - заказ в статусе "Подтвержден"/"Принят" не доставлен в Торговую точку: ТТ меняет статус не доставленного заказа по прошествии 24 часов с установленной даты доставки
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, изначально принятый Поставщиком, который не будет доставлен ТТ
|-
| style="font-weight:bold;" | status=10
| Выполнен с корректировкой - заказ "Подтвержден"/"Принят" доставлен в Торговую точку: ТТ приняла не все товары (изменила количество) и подтвердила доставку
|}

===Изменение и корректировка заказа поставщиком===
Для того чтобы изменить статус заказа, количество товаров или набор продуктов в заказе необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/orders/{id}, где id - это уникальный идентификатор заказа, который необходимо изменить.
При отправке данного PUT-запроса с id заказа '''{}''' не использовать.
Поставщик может изменять новые заказы (status=1) на статусы, которые представлены в таблице ниже:
{| class="wikitable"
! style="font-weight:bold;" | Status
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | status=2
| Принят: заказы, принятые поставщиком.
|-
| style="font-weight:bold;" | status=3
| Отказ: заказы, отмененные поставщиком.
|-
| style="font-weight:bold;" | status=4
| Принят с корректировкой: заказы, измененные поставщиком (наличие, количество, дата доставки).
|-
| style="font-weight:bold;" | status=9
| Не выполнен - заказ, который был принят поставщиком, но не будет доставлен в торговую точку
|}
Если заказ принят или отклонен, то запрос должен содержать обязательный параметр '''status''' и значение '''2''' (принят) или '''3''' (отклонен).

Если у заказа меняется '''status''' на '''3''' (отклонен), то, помимо обязательного параметра '''status''', запрос должен содержать параметр '''comment'''.

'''Order_items''' в случае отклонения заказа передавать в запросе не нужно.

Если заказ должен быть изменен, то запрос должен содержать параметры '''offer_id''' и '''quantity'''.

Внимание: offer_id на самом деле id в order_items, а не offer_id - идентификатор предложения. 

Если были переданы не все товарные позиции из order_items, то отсутствующие позиции будут удалены системой из заказа.

Дополнительно со статусом заказа пользователю может отображаться статус поставщика. Для этого в теле PUT-запроса на изменение статуса (2, 3, 4 и 9) поставщик добавляет параметр "supplierStatus" с необходимым текстом статуса, например:
{
"status": 2,
"supplierStatus": "Заказ принят в обработку",
}

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение заказа
|
|}
==Ответы==
'''Response Orders Items:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Orders Status Change Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Orders_Status_Change_Response Order Status Change Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Orders#403 403]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Request Order Items===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int64)
| 3463374
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|}
Пример запроса:
{
"offer_id": 3463374,
"quantity": 4
}
===Request Order Status Change===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | comment
| Комментарий
| string
| В наличии есть только 4 бутылки
|-
| style="font-weight:bold;" | items
| Массив
| < items> array
| 4
|-
| style="font-weight:bold;" | status
| Статус заказа
| string
| Принят с корректировкой: заказы измененные поставщиком (наличие, количество)
|}
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | quantity
| Количество
| integer($int64)
| 4
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (строкой DD.MM.YYYY)
| string
| 09.10.2019
|-
| style="font-weight:bold;" | offer_id
| Уникальный номер предложения
| integer($int64)
| 3463374
|}
Пример запроса:
{
"comment": "Вот такой комментарий ",
"items":
[
{
"quantity": 50,
"delivery_date": "09.10.2019",
"offer_id": 4166524
}
],
"status": 4
}

===Response Orders Items===
'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer
| 258941
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer
| 656
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer
| 80
|-
| style="font-weight:bold;" | delivery_date
| Дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | initial_delivery_date
| Первоначальная дата доставки (time stamp с учетом time zone)
| integer
| 1581292800
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| string
| 84
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer
| 1
|-
| style="font-weight:bold;" | created_at
| Дата создания заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | updated_at
| Дата обновления заказа
| integer
| 1532517982
|-
| style="font-weight:bold;" | with_documents
| Наличие документов
| integer
| 0
|-
| style="font-weight:bold;" | sum
| Общая сумма заказа
| integer
| 11340
|-
| style="font-weight:bold;" | comments
| Комментарий к заказу
| string
| Ок
|-
| style="font-weight:bold;" | replacement_id
| Идентификатор заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | replacement_status
| Статус заказа на обмен
| string
| null
|-
| style="font-weight:bold;" | role
| Роль пользователя, который оформил заказ
| string
| Торговый представитель
|-
| style="font-weight:bold;" | full_name
| ФИО пользователя, который оформил заказ
| string
| Иван Иванов
|-
| style="font-weight:bold;" | alcohol_license
| Алкогольная лицензия
| object
|
|-
| style="font-weight:bold;" | number
| Номер алкогольной лицензии
| string
| 213
|-
| style="font-weight:bold;" | expire_at
| Начало действия алкогольной лицензии
| string
| 1522022400
|-
| style="font-weight:bold;" | expire_at_date
| Конец действия алкогольной лицензии
| string
| 26.03.2018
|-
| style="font-weight:bold;" | payment_type
| Тип оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | payment_status
| Статус оплаты заказа
| integer
| 0
|-
| style="font-weight:bold;" | order_items
| Массив
| < order_items > array
|
|-
| style="font-weight:bold;" | Supplier_company_name
| Название поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | store_company
| Массив
| < store_company > array
|
|}
'''Order Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования товара
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | order_id
| Идентификатор заказа
| integer($int32)
| 204533
|-
| style="font-weight:bold;" | offer_id
| Идентификатор предложения
| integer($int32)
| 4134408
|-
| style="font-weight:bold;" | product_id
| Идентификатор товара
| integer($int32)
| 85067
|-
| style="font-weight:bold;" | quantity
| Количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | initial_quantity
| Начальное количество продукта
| integer
| 1
|-
| style="font-weight:bold;" | quantity_decimal
| Дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | initial_quantity_decimal
| Начальное дробное значение продукта
| string
| 1
|-
| style="font-weight:bold;" | amount
| Общая сумма
| string
| 2000
|-
| style="font-weight:bold;" | deleted
| Удален
| boolean
| 0
|-
| style="font-weight:bold;" | offer
| Предложение
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор предложения
| string
| 4345054
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 1260
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 1386
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| 1134
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код
| string
| null
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | step
| Шаг
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| 1.000
|-
| style="font-weight:bold;" | price
| Цена для текущей ТТ
| string
| 1260
|-
| style="font-weight:bold;" | product
| Товар
| object
|
|-
| style="font-weight:bold;" | id
| Идентификатор товара
| string
| 28952
|-
| style="font-weight:bold;" | name
| Название продукта
| string
| Воздух чистый, Алматинский ПЭТ 5л
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| string
| cash12039823407121
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | category_id
| Идентификатор категории товара
| string
| 360
|-
| style="font-weight:bold;" | images
| Массив
| < images > array
|
|-
| style="font-weight:bold;" | status
| Статус товара
| string
| 1
|-
| style="font-weight:bold;" | user_id
| Идентификатор пользователя
| string
| 132
|-
| style="font-weight:bold;" | is_weighted
| Весовой товар
| boolean
| 0
|-
| style="font-weight:bold;" | promotion_type
| Признак бонусного товара
| string
| 0
|}
'''Images'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор изображения
| integer($int32)
| 1631118
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта
| string
| 28952
|-
| style="font-weight:bold;" | scr
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|-
| style="font-weight:bold;" | thumb
| Ссылка на изображение
| string
| https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg
|}
'''Store company'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | route_list
| Идентификатор наименования товара
| string
| null
|-
| style="font-weight:bold;" | name
| Идентификатор заказа
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | min_order_price
| Минимальная сумма заказа
| integer
| 0
|-
| style="font-weight:bold;" | email
| Адрес электронной почты
| string
| shop@me.kz
|-
| style="font-weight:bold;" | description
| Описание
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conact
| Контактные данные
| string
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| 0123456789
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| +78000000001
|-
| style="font-weight:bold;" | supplier_rule
| Правила поставщика
| string
| null
|-
| style="font-weight:bold;" | logo
| Логотип
| string
| https://food.smartsatu.com/images/no_image_130x130.png
|-
| style="font-weight:bold;" | has_replacement_products
| Обмен товаров
| string
| 1
|-
| style="font-weight:bold;" | cashback_percent
| Кэшбэк включен
| string
| true
|-
| style="font-weight:bold;" | has_cashback
| Кэшбэк включен и активен
| string
| false
|-
| style="font-weight:bold;" | position
| Позиция для сортировки
| integer
| 999
|-
| style="font-weight:bold;" | supplier_store_id
| UCS-код торговой точки
| string
| 3214567
|}
Пример ответа:
{
"items": [
{
"id": "258941",
"store_user_id": 656,
"store_company_id": 656,
"delivery_date": "1581292800",
"initial_delivery_date": "1581292800",
"supplier_company_id": "84",
"supplierCompanyName": "ТОО \"Поставщиk-",
"status": "1",
"created_at": 1532517982,
"updated_at": 1532517982,
"with_documents": 0,
"sum": 11340,
"comments": "Ок",
"replacement_id": " ",
"replacement_status": " ",
"role": "Торговый представитель"
"full_name": "Иван Иванов"
"alcohol_license": {
"number": "213",
"expire_at": "1522022400",
"expire_at_date": "26.03.2018"
},
"payment_type": 0,
"payment_status": 0
"order_items": [
{
"id": 1631118,
"order_id": 204533,
"offer_id": 4134408,
"product_id": 85067,
"quantity": 1,
"initial_quantity": 1,
"quantity_decimal": 1,
"initial_quantity_decimal": 1,
"amount": 2000,
"deleted": 0,
"offer": {
"id": "4345054",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "cash12039823407121",
"unit": "шт",
"manufacturer": " ",
"quantity": "1",
"expires_at": " ",
"price_1": "1260",
"price_2": "1386",
"price_3": "1134",
"price_4": " ",
"price_5": " ",
"unique_code": "",
"product_id": "28952",
"step": "",
"minQuantity": "1.000",
"price": "1260"
},
"product": {
"id": "28952",
"name": "Воздух чистый, Алматинский ПЭТ 5л",
"sku": "9890000033839",
"unit": "шт.",
"quantity": "1",
"manufacturer": " ",
"category_id": "360",
"images": [
{
"id": "39236",
"product_id": "28952",
"scr": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg",
"thumb": "https://cdn.smartsatu.com/food/images/products/7238_14752205982FZWw.jpg"
}
],
"status": "1",
"user_id": "132",
"is_weighted": 0
},
"promotion_type": "0"
}
],
"Supplier_company_name": "ТОО \"Поставщиk-",
"store_company": {
"address": "Алматы, Байзакова, 125/185",
"min_order_price": 0,
"description": "Магазин для тестирования\\r\\n",
"cashback_percent": "true",
"supplier_rule": "NULL",
"type": 1,
"has_replacement_products": "1",
"has_cashback": "false",
"phone": "+78000000001",
"route_list": "",
"contact": "Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка",
"name": "маг. \"Рокфор",
"tin": "0123456789",
"logo": "https://food.smartsatu.com/images/no_image_130x130.png",
"id": "80",
"position": 999,
"email": "shop@me.kz"
"supplier_store_id": "3214567"
}
}
]
}

===Orders Status Change Response===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор заказа
| integer($int32)
| null
|-
| style="font-weight:bold;" | store_user_id
| Идентификатор пользователя торговой точки
| integer($int32)
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | store_company_id
| Идентификатор торговой точки
| integer($int32)
| 0
|-
| style="font-weight:bold;" | supplier_company_id
| Идентификатор поставщика
| integer($int32)
| shop@me.kz
|-
| style="font-weight:bold;" | supplierCompanyName
| Идентификатор названия поставщика
| string
| Магазин для тестирования\r\n
|-
| style="font-weight:bold;" | status
| Статус заказа
| integer($int32)
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | created_at
| Время создания заказа
| integer($int32)
| Телефон: +78000000001, Вн.: 123, Контактное лицо: Гайка
|-
| style="font-weight:bold;" | updated_at
| Время обновления заказа
| integer($int32)
| store
|-
| style="font-weight:bold;" | with_documents
| Доставка заказа с документами
| integer($int32)
| 0123456789
|-
| style="font-weight:bold;" | sum
| Сумма заказа
| integer($int32)
| +78000000001
|-
| style="font-weight:bold;" | comments
| Массив
| < comments > array
|
|-
| style="font-weight:bold;" | replacement_id
|
| integer
| null
|-
| style="font-weight:bold;" | replacement_status
|
| integer
| null
|}
'''Comments'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор комментария
| integer
| 75875
|-
| style="font-weight:bold;" | company_id
| Идентификатор поставщика
| integer
| 84
|-
| style="font-weight:bold;" | message
| Текст комментария
| string
| Вот такой комментарий
|-
| style="font-weight:bold;" | type
| Статус заказа
| string
| 4
|-
| style="font-weight:bold;" | order_id
| Уникальный идентификатор заказа
| integer
| 153390
|-
| style="font-weight:bold;" | created_at
| Время создания
| string
| 1540376988
|-
| style="font-weight:bold;" | companyName
| Идентификатор названия поставщика
| string
| ТОО "Поставщиk-"
|-
| style="font-weight:bold;" | is_system
| Системное сообщение
| string
| null
|}
Пример ответа:
{
"id": 153390,
"store_user_id": 656,
"store_company_id": 80,
"supplier_company_id": 84,
"supplierCompanyName": "ТОО \"Поставщиk-\"",
"status": 2,
"created_at": 1497429666,
"updated_at": 1497431046,
"with_documents": 1,
"sum": 8663,
"comments": [
{
"id": 75875,
"company_id": 84,
"message": "Вот такой комментарий",
"type": 4,
"order_id": 153390,
"created_at": 1540376988,
"companyName": "ТОО \"Поставщиk-\"",
"is_system": "Null"
}
],
"replacement_id": null,
"replacement_status": null
}
===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}
===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название поставщика
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\HttpException"
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

API Offers

2022-01-10T15:10:53Z

User: /* Offers Request (изменение) */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению списка предложений, а также изменению, удалению и импорту предложений в системе Smart Satu.

Предложение - это цена, которую предлагает поставщик за определенный товар. Также система Smart Satu позволяет загружать как общие предложения, которые доступны всем торговым точкам, так индивидуальные для конкретных магазинов.

Больше информации по предложениям находится по ссылке: [http://docs.smartsatu.com/wiki/SmartSatuSupplier#.D0.A0.D0.B0.D0.B1.D0.BE.D1.82.D0.B0_.D1.81_.D0.BF.D1.80.D0.B5.D0.B4.D0.BB.D0.BE.D0.B6.D0.B5.D0.BD.D0.B8.D1.8F.D0.BC.D0.B8 Работа с предложениями]

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Импорт предложений===
POST /offers/import?start=1
===Получение списка предложений===
GET /offers
===Изменение предложений===
PUT /offers/{sku}

===Удаление предложений===
DELETE /offers/{sku}

==Описание==
===Батчевый импорт предложений===
Данный метод предназначен для оптового импорта предложений (batch) в систему с ограничением в 1000 предложений в одном запросе.
Первый запрос должен отправляться с параметром <code>start=1</code>
<code>https://food.smartsatu.com/api/offers/import?start=1</code>
В ответ первого запроса вы получите транзакционный идентификатор очереди вида:
{
'id': '98db89147d6cd0018417b71'
}
Для всех последующих запросов на импорт предложений, вам необходимо добавлять транзакционный идентификатор в параметры запроса:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71</code>
Для того чтобы закончить оптовый импорт предложений в систему, необходимо отправить запрос с параметром end=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1</code>
Если вам необходимо удалить все старые предложения, то в последнем запросе необходимо передать параметр delete=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1&delete=1</code>

В атрибуте 'comment' в JSON-ответе описываются причины ошибок.

Для того чтобы осуществить батчевую '''загрузку персональных прайсов (для конкретной торговой точки)''' необходимо указать в get параметрах запроса <code>store_id</code> (id торговой точки):
<code>https://food.smartsatu.com/api/offers/import?start=1&end=1&delete=1&store_id=80</code>

Рекомендации по батчевой загрузке предложений:
Рекомендуем прогружать по 500-1000 предложений в одном запросе. Т.к. если прайс-лист до 1000 предложений, то его можно прогрузить одним запросом. Для этого в запросе на батчевую загрузку устанавливаются флаги старта и окончания очереди: offers/import?start=1&end=1.
Прайс-лист может быть больше чем 1000 штук. Так, если прайс-лист содержит больше 1000 предложений, то открывается очередь с первым запросом с первой 1000 предложений: offers/import?start=1. В ответе вернется id очереди.
С последующими запросами нужно будет слать id очереди в get параметрах offers/import?id=XXXX.
C последним чанком большого прайс-листа нужно будет послать флаг окончания offers/import?id=XXXX&end=1.
'''NB!''' Допустим нужно загрузить 5000 предложений. Мы отправляем первый запрос с 1000 предложений и получаем в ответ идентификатор очереди. Дальше посылаем еще 4 запроса с 1000 предложений в каждом запросе и идентификатором очереди. При этом в последнем запросе нужно отправить параметр end=1, который зыкрывает очередь и является тригером для обработчика на загрузку предложений в систему. Если очередь не будет закрыта, то она не будет обработана и загружена в систему.

Чтобы удалить старый прайс-лист, нужно послать флаг удаления с первым или последним чанком offers/import?id=XXXX&delete=1. Если это прайс загружаемый одним запросом, то в get параметрах указываем все три флага (start, end, delete) offers/import?start=1&end=1&delete=1

В предложениях доступна загрузка '''Акций''' с типом '''"Выгодная цена"''' - фактическая скидка на товар. Для этого в предложении необходимо указать первоначальную цену Price 1 (для магазина), Price 2 (для ХоРеКа) и конечную промо-цену Price 5.
Таким образом для Торговой точки в каталоге товаров предложения с Выгодной ценой отображаются с перечеркнутой старой ценой (Price 1 или Price 2) и итоговая промо-цена (Price 5). Кроме того, предложение дополнительно помечается иконкой акции "%".

Для временно отсутствующего у поставщика товара в поле <code>quantity</code> предложения указывается значение <code>0</code> (ноль). Торговым точкам товар будет отображен с пометкой "нет в наличии". Добавить в корзину и заказать такой товар торговые точки не смогут.

ВАЖНО: значение Quantum (количество товара в фасовке/упаковке) обязательно должно быть кратно значению minQuantity (минимальное количество данного товара, которое ТТ обязано купить для оформления заказа). Если значения не пройдут валидацию, то добавится только значение Quantum.
Например:
Поставщик выставил предложение на товар по цене 1100 руб за единицу. Фасовка (quantum) осуществляется по 10 шт. Минимальное количество в заказе (minQuantity) - 30 шт. Для успешного заказа торговая точка первоначально добавляет в корзину 30 шт товара (сумма заказа составит 1100 * 30), далее добавление в корзину будет происходить с шагом в 10 шт.

===Получение списка предложений===
Для того чтобы получить список всех предложений, необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/offers. Ответом от сервера будет являться массив данных со списком всех ваших предложений в системе Smart Satu с их данными.
===Редактирование предложения===
Для того чтобы отредактировать предложения требуется добавить в запрос SKU данного предложения.
''Пример: https://food.smartsatu.site/api/offers/9876786897623''

Вместе с данным параметром мы отправляем JSON-тело запроса на изменение.

===Обновление остатков===
Для загрузки измененного количества товара (остатков) необходимо использовать API https://food.smartsatu.com/api/offers/import-only-quantity, в запросе к которому передается массив товаров ('''sku''' либо '''unique_code''') с актуальными значениями остатков:
[
{
"store_id": null,
"sku": null,
"unique_code": "48700034204351",
"quantity": 30,
}
]
Для обновления остатков в определенных персональных прайслистах необходимо в параметре '''store_id''' указать массив идентификаторов торговых точек.

===Удаление предложения===
Для того чтобы изменить предложение, необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}, где sku - это штрих-код предложения, которое необходимо изменить.
Ответом от сервера будет являться массив данных с измененными данными предложения.

Для удаления конкретного предложения из всех прайс-листов (как общих, так и индивидульных) необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}/all, где sku - это штрих-код предложения, которое необходимо изменить. ''Пример: https://food.smartsatu.com/api/offers/5053990106868/all''

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение предложения
|
|}
==Ответы==
'''Offers Import Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Import_Response Offers Import Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|}
'''Offers Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Response Offers Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Offers#401 401]
|}
'''Offers Response (изменение):'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|}
'''Delete Offer:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 204
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|-
| style="font-weight:bold;" | 404
| Not Found
| [http://docs.smartsatu.com/wiki/API_Offers#404 404]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Импорт предложений===
POST /offers/import?start=1

====Offers Import Request====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| varchar(255)
| 9876786897623
|-
| style="font-weight:bold;" | unit
| Единица измерения
| varchar(50)
| шт / кг
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. Пока слать 1 (есть в наличии) или 0 (нет в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_without_vat
| Цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | promotion_price_without_vat
| Промо цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | delivery_days
| Дни доставки* '''На данный момент данный параметр не используется! Вся функциональность по настройке дней доставки регулируется через WEB-интерфейс'''
| varchar(127)
| "1,2,3,4,5,6,0"
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения '''Сервисное поле поставщика. Возвращается в заказе. Например, GUID для 1С.'''
| varchar(255)
| string / null
|-
| style="font-weight:bold;" | quantum
| Квант поставки
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | isImport
| Импортировать предложение (да/нет)
| boolean
| 1 / 0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "product1",
"sku": "9876786897623",
"store_id": null
"unit": "",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 555,
"price_2": null,
"price_3": null,
"price_4": null,
"price_5": null *Указание выгодной цены,
"price_without_vat": null,
"promotion_price_without_vat": null,
"delivery_days": "1,2,3,4,5,6,0",
"unique_code": null, //тут может быть GUID
"quantum": 5.000,
"isImport": "1",
"minQuantity": 5.000,
"status": 1
}
]

====Offers Import Response====
{| class="wikitable"
|-
! Name !! Description !! Schema !! Example
|-
| '''id''' || Идентификатор очереди || string || 5d720cfee9d7c84ad038ff41
|-
| '''count''' || Количество предложений || integer || 2
|-
| '''comment''' || Комментарий || string || null
|}
Пример ответа:
{
"id": "5d720cfee9d7c84ad038ff41",
"count": 2,
"comment": null
}

===Изменение предложений===
PUT /offers/{sku}

====Offers Request (изменение)====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. 0 (нет в наличии), 1 или более (есть в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет)
| string
| 1
|-
| style="font-weight:bold;" | quantum
| Квант
| decimal(19,3)
| 8.0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "Обновленное название предложения",
"manufacturer": "",
"quantity": 100,
"expires_at": null,
"price_1": 333,
"price_2": 500,
"price_3": null,
"price_4": null,
"price_5": null,
"status": 1
"quantum": 8.0,
"minQuantity": null, //нет требования по минимальному количеству в заказе
"status": 1
}
]

====Offers Response====
'''NB!''' Ответ приходит в json и по факту это string. За парсинг и выбор типа значений отвечает сторона поставщика.
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования предложения в системе SmartSatu
| integer
| 4317231
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| 425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA
|-
| style="font-weight:bold;" | sku
| Артикул предложения
| string
| 4870007151458
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 329
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 329
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| null
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения '''Идентификатор предложения у поставщика'''
| string
| 141209
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта (идентификатор товарной карточки в системе SmartSatu)
| string
| 28952
|-
| style="font-weight:bold;" | step
| Квант поставки (quantum)
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| null
|}
Пример ответа:

[
{
"id": 4317231,
"name": "425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA",
"sku": 870007151458,
"unit": "шт",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 329,
"price_2": 329,
"price_3": null,
"price_4": null,
"price_5": null,
"unique_code": "141209",
"product_id": null,
"step": null,
"minQuantity": null
}
]

===Удаление предложений===
DELETE /offers/{sku}
====Delete Offer====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | status
| Код
| integer
| 204
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение удалено
|}
Пример ответа:
{
"status": 204,
"message": "Предложение удалено."
}

===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

===404===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Not Found
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение не существует, удалено либо недоступно
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 404
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:

{
"name": "Not Found",
"message": "Предложение не существует, удалено либо недоступно",
"code": 0,
"status": 404,
"type": "yii\\web\\HttpException"
}

API Offers

2022-01-10T15:09:48Z

User: /* Offers Request (изменение) */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению списка предложений, а также изменению, удалению и импорту предложений в системе Smart Satu.

Предложение - это цена, которую предлагает поставщик за определенный товар. Также система Smart Satu позволяет загружать как общие предложения, которые доступны всем торговым точкам, так индивидуальные для конкретных магазинов.

Больше информации по предложениям находится по ссылке: [http://docs.smartsatu.com/wiki/SmartSatuSupplier#.D0.A0.D0.B0.D0.B1.D0.BE.D1.82.D0.B0_.D1.81_.D0.BF.D1.80.D0.B5.D0.B4.D0.BB.D0.BE.D0.B6.D0.B5.D0.BD.D0.B8.D1.8F.D0.BC.D0.B8 Работа с предложениями]

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Импорт предложений===
POST /offers/import?start=1
===Получение списка предложений===
GET /offers
===Изменение предложений===
PUT /offers/{sku}

===Удаление предложений===
DELETE /offers/{sku}

==Описание==
===Батчевый импорт предложений===
Данный метод предназначен для оптового импорта предложений (batch) в систему с ограничением в 1000 предложений в одном запросе.
Первый запрос должен отправляться с параметром <code>start=1</code>
<code>https://food.smartsatu.com/api/offers/import?start=1</code>
В ответ первого запроса вы получите транзакционный идентификатор очереди вида:
{
'id': '98db89147d6cd0018417b71'
}
Для всех последующих запросов на импорт предложений, вам необходимо добавлять транзакционный идентификатор в параметры запроса:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71</code>
Для того чтобы закончить оптовый импорт предложений в систему, необходимо отправить запрос с параметром end=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1</code>
Если вам необходимо удалить все старые предложения, то в последнем запросе необходимо передать параметр delete=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1&delete=1</code>

В атрибуте 'comment' в JSON-ответе описываются причины ошибок.

Для того чтобы осуществить батчевую '''загрузку персональных прайсов (для конкретной торговой точки)''' необходимо указать в get параметрах запроса <code>store_id</code> (id торговой точки):
<code>https://food.smartsatu.com/api/offers/import?start=1&end=1&delete=1&store_id=80</code>

Рекомендации по батчевой загрузке предложений:
Рекомендуем прогружать по 500-1000 предложений в одном запросе. Т.к. если прайс-лист до 1000 предложений, то его можно прогрузить одним запросом. Для этого в запросе на батчевую загрузку устанавливаются флаги старта и окончания очереди: offers/import?start=1&end=1.
Прайс-лист может быть больше чем 1000 штук. Так, если прайс-лист содержит больше 1000 предложений, то открывается очередь с первым запросом с первой 1000 предложений: offers/import?start=1. В ответе вернется id очереди.
С последующими запросами нужно будет слать id очереди в get параметрах offers/import?id=XXXX.
C последним чанком большого прайс-листа нужно будет послать флаг окончания offers/import?id=XXXX&end=1.
'''NB!''' Допустим нужно загрузить 5000 предложений. Мы отправляем первый запрос с 1000 предложений и получаем в ответ идентификатор очереди. Дальше посылаем еще 4 запроса с 1000 предложений в каждом запросе и идентификатором очереди. При этом в последнем запросе нужно отправить параметр end=1, который зыкрывает очередь и является тригером для обработчика на загрузку предложений в систему. Если очередь не будет закрыта, то она не будет обработана и загружена в систему.

Чтобы удалить старый прайс-лист, нужно послать флаг удаления с первым или последним чанком offers/import?id=XXXX&delete=1. Если это прайс загружаемый одним запросом, то в get параметрах указываем все три флага (start, end, delete) offers/import?start=1&end=1&delete=1

В предложениях доступна загрузка '''Акций''' с типом '''"Выгодная цена"''' - фактическая скидка на товар. Для этого в предложении необходимо указать первоначальную цену Price 1 (для магазина), Price 2 (для ХоРеКа) и конечную промо-цену Price 5.
Таким образом для Торговой точки в каталоге товаров предложения с Выгодной ценой отображаются с перечеркнутой старой ценой (Price 1 или Price 2) и итоговая промо-цена (Price 5). Кроме того, предложение дополнительно помечается иконкой акции "%".

Для временно отсутствующего у поставщика товара в поле <code>quantity</code> предложения указывается значение <code>0</code> (ноль). Торговым точкам товар будет отображен с пометкой "нет в наличии". Добавить в корзину и заказать такой товар торговые точки не смогут.

ВАЖНО: значение Quantum (количество товара в фасовке/упаковке) обязательно должно быть кратно значению minQuantity (минимальное количество данного товара, которое ТТ обязано купить для оформления заказа). Если значения не пройдут валидацию, то добавится только значение Quantum.
Например:
Поставщик выставил предложение на товар по цене 1100 руб за единицу. Фасовка (quantum) осуществляется по 10 шт. Минимальное количество в заказе (minQuantity) - 30 шт. Для успешного заказа торговая точка первоначально добавляет в корзину 30 шт товара (сумма заказа составит 1100 * 30), далее добавление в корзину будет происходить с шагом в 10 шт.

===Получение списка предложений===
Для того чтобы получить список всех предложений, необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/offers. Ответом от сервера будет являться массив данных со списком всех ваших предложений в системе Smart Satu с их данными.
===Редактирование предложения===
Для того чтобы отредактировать предложения требуется добавить в запрос SKU данного предложения.
''Пример: https://food.smartsatu.site/api/offers/9876786897623''

Вместе с данным параметром мы отправляем JSON-тело запроса на изменение.

===Обновление остатков===
Для загрузки измененного количества товара (остатков) необходимо использовать API https://food.smartsatu.com/api/offers/import-only-quantity, в запросе к которому передается массив товаров ('''sku''' либо '''unique_code''') с актуальными значениями остатков:
[
{
"store_id": null,
"sku": null,
"unique_code": "48700034204351",
"quantity": 30,
}
]
Для обновления остатков в определенных персональных прайслистах необходимо в параметре '''store_id''' указать массив идентификаторов торговых точек.

===Удаление предложения===
Для того чтобы изменить предложение, необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}, где sku - это штрих-код предложения, которое необходимо изменить.
Ответом от сервера будет являться массив данных с измененными данными предложения.

Для удаления конкретного предложения из всех прайс-листов (как общих, так и индивидульных) необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}/all, где sku - это штрих-код предложения, которое необходимо изменить. ''Пример: https://food.smartsatu.com/api/offers/5053990106868/all''

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение предложения
|
|}
==Ответы==
'''Offers Import Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Import_Response Offers Import Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|}
'''Offers Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Response Offers Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Offers#401 401]
|}
'''Offers Response (изменение):'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|}
'''Delete Offer:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 204
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|-
| style="font-weight:bold;" | 404
| Not Found
| [http://docs.smartsatu.com/wiki/API_Offers#404 404]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Импорт предложений===
POST /offers/import?start=1

====Offers Import Request====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| varchar(255)
| 9876786897623
|-
| style="font-weight:bold;" | unit
| Единица измерения
| varchar(50)
| шт / кг
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. Пока слать 1 (есть в наличии) или 0 (нет в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_without_vat
| Цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | promotion_price_without_vat
| Промо цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | delivery_days
| Дни доставки* '''На данный момент данный параметр не используется! Вся функциональность по настройке дней доставки регулируется через WEB-интерфейс'''
| varchar(127)
| "1,2,3,4,5,6,0"
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения '''Сервисное поле поставщика. Возвращается в заказе. Например, GUID для 1С.'''
| varchar(255)
| string / null
|-
| style="font-weight:bold;" | quantum
| Квант поставки
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | isImport
| Импортировать предложение (да/нет)
| boolean
| 1 / 0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "product1",
"sku": "9876786897623",
"store_id": null
"unit": "",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 555,
"price_2": null,
"price_3": null,
"price_4": null,
"price_5": null *Указание выгодной цены,
"price_without_vat": null,
"promotion_price_without_vat": null,
"delivery_days": "1,2,3,4,5,6,0",
"unique_code": null, //тут может быть GUID
"quantum": 5.000,
"isImport": "1",
"minQuantity": 5.000,
"status": 1
}
]

====Offers Import Response====
{| class="wikitable"
|-
! Name !! Description !! Schema !! Example
|-
| '''id''' || Идентификатор очереди || string || 5d720cfee9d7c84ad038ff41
|-
| '''count''' || Количество предложений || integer || 2
|-
| '''comment''' || Комментарий || string || null
|}
Пример ответа:
{
"id": "5d720cfee9d7c84ad038ff41",
"count": 2,
"comment": null
}

===Изменение предложений===
PUT /offers/{sku}

====Offers Request (изменение)====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. 1 (есть в наличии) или 0 (нет в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет)
| string
| 1
|-
| style="font-weight:bold;" | quantum
| Квант
| decimal(19,3)
| 8.0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "Обновленное название предложения",
"manufacturer": "",
"quantity": 100,
"expires_at": null,
"price_1": 333,
"price_2": 500,
"price_3": null,
"price_4": null,
"price_5": null,
"status": 1
"quantum": 8.0,
"minQuantity": null, //нет требования по минимальному количеству в заказе
"status": 1
}
]

====Offers Response====
'''NB!''' Ответ приходит в json и по факту это string. За парсинг и выбор типа значений отвечает сторона поставщика.
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования предложения в системе SmartSatu
| integer
| 4317231
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| 425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA
|-
| style="font-weight:bold;" | sku
| Артикул предложения
| string
| 4870007151458
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 329
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 329
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| null
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения '''Идентификатор предложения у поставщика'''
| string
| 141209
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта (идентификатор товарной карточки в системе SmartSatu)
| string
| 28952
|-
| style="font-weight:bold;" | step
| Квант поставки (quantum)
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| null
|}
Пример ответа:

[
{
"id": 4317231,
"name": "425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA",
"sku": 870007151458,
"unit": "шт",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 329,
"price_2": 329,
"price_3": null,
"price_4": null,
"price_5": null,
"unique_code": "141209",
"product_id": null,
"step": null,
"minQuantity": null
}
]

===Удаление предложений===
DELETE /offers/{sku}
====Delete Offer====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | status
| Код
| integer
| 204
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение удалено
|}
Пример ответа:
{
"status": 204,
"message": "Предложение удалено."
}

===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

===404===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Not Found
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение не существует, удалено либо недоступно
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 404
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:

{
"name": "Not Found",
"message": "Предложение не существует, удалено либо недоступно",
"code": 0,
"status": 404,
"type": "yii\\web\\HttpException"
}

API Counterparties

2021-08-25T07:38:26Z

User:

==Обзор==
Данный документа описывает методы для работы поставщика/дистрибьютора по получению списка Торговых точек из системы Smart Satu.

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/counterparties/ Schemes : HTTPS''

==Методы==
'''Получение списка торговых точек'''

GET /counterparties
==Описание==
Для получения списка всех торговых точек из системы Smart Satu необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/counterparties.
==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных со списком всех контрагентов системы Smart Satu с их данными.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
===Параметры===
====Ответы====
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Counterparties#Response_Counterparties Response Counterparties]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Counterparties#401 401]
|}

'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Response Counterparties===
'''200'''

'''Items'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Уникальный идентификатор
| integer
| 80
|-
| style="font-weight:bold;" | name
| Название торговой точки
| string
| ИП "Чип и Дейл" | маг. "Рокфор"
|-
| style="font-weight:bold;" | address
| Адрес торговой точки
| string
| Алматы, Байзакова, 125/185
|-
| style="font-weight:bold;" | conacts
| Массив
| <contacts> array
|
|-
| style="font-weight:bold;" | type
| Тип торговой точки
| string
| store
|-
| style="font-weight:bold;" | tin
| ИНН торговой точки
| string
| AZ0123456789
|-
| style="font-weight:bold;" | ucs
| Уникальный идентификатор ТТ у поставщика (пр. GUID)
| string
| AZ0123456789
|}
'''Contacts'''
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | phone
| Номер телефона
| string
| 78000000001
|-
| style="font-weight:bold;" | person
| Персона (Контактное лицо)
| string
| Гайка
|-
| style="font-weight:bold;" | ext
| Дополнительный номер
| string
| 123
|-
| style="font-weight:bold;" | type
| Тип контакта
| string
|
|}
Пример ответа:
{
"Items": [
{
"id": 80,
"name": "ИП \"Чип и Дейл\" | маг. \"Рокфор\"",
"address": "Алматы, Байзакова, 125/185",
"contacts": [
{
"phone": "78000000001",
"person": "Гайка",
"ext": "123",
"type": " "
}
],
"type": "store",
"tin": "AZ0123456789"
"ucs": "AZ0123456789"
}
]
}

===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название торговой точки
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
|
|}
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

API Offers

2021-08-10T08:30:12Z

User: /* Offers Response */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению списка предложений, а также изменению, удалению и импорту предложений в системе Smart Satu.

Предложение - это цена, которую предлагает поставщик за определенный товар. Также система Smart Satu позволяет загружать как общие предложения, которые доступны всем торговым точкам, так индивидуальные для конкретных магазинов.

Больше информации по предложениям находится по ссылке: [http://docs.smartsatu.com/wiki/SmartSatuSupplier#.D0.A0.D0.B0.D0.B1.D0.BE.D1.82.D0.B0_.D1.81_.D0.BF.D1.80.D0.B5.D0.B4.D0.BB.D0.BE.D0.B6.D0.B5.D0.BD.D0.B8.D1.8F.D0.BC.D0.B8 Работа с предложениями]

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Импорт предложений===
POST /offers/import?start=1
===Получение списка предложений===
GET /offers
===Изменение предложений===
PUT /offers/{sku}

===Удаление предложений===
DELETE /offers/{sku}

==Описание==
===Батчевый импорт предложений===
Данный метод предназначен для оптового импорта предложений (batch) в систему с ограничением в 1000 предложений в одном запросе.
Первый запрос должен отправляться с параметром <code>start=1</code>
<code>https://food.smartsatu.com/api/offers/import?start=1</code>
В ответ первого запроса вы получите транзакционный идентификатор очереди вида:
{
'id': '98db89147d6cd0018417b71'
}
Для всех последующих запросов на импорт предложений, вам необходимо добавлять транзакционный идентификатор в параметры запроса:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71</code>
Для того чтобы закончить оптовый импорт предложений в систему, необходимо отправить запрос с параметром end=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1</code>
Если вам необходимо удалить все старые предложения, то в последнем запросе необходимо передать параметр delete=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1&delete=1</code>

В атрибуте 'comment' в JSON-ответе описываются причины ошибок.

Для того чтобы осуществить батчевую '''загрузку персональных прайсов (для конкретной торговой точки)''' необходимо указать в get параметрах запроса <code>store_id</code> (id торговой точки):
<code>https://food.smartsatu.com/api/offers/import?start=1&end=1&delete=1&store_id=80</code>

Рекомендации по батчевой загрузке предложений:
Рекомендуем прогружать по 500-1000 предложений в одном запросе. Т.к. если прайс-лист до 1000 предложений, то его можно прогрузить одним запросом. Для этого в запросе на батчевую загрузку устанавливаются флаги старта и окончания очереди: offers/import?start=1&end=1.
Прайс-лист может быть больше чем 1000 штук. Так, если прайс-лист содержит больше 1000 предложений, то открывается очередь с первым запросом с первой 1000 предложений: offers/import?start=1. В ответе вернется id очереди.
С последующими запросами нужно будет слать id очереди в get параметрах offers/import?id=XXXX.
C последним чанком большого прайс-листа нужно будет послать флаг окончания offers/import?id=XXXX&end=1.
'''NB!''' Допустим нужно загрузить 5000 предложений. Мы отправляем первый запрос с 1000 предложений и получаем в ответ идентификатор очереди. Дальше посылаем еще 4 запроса с 1000 предложений в каждом запросе и идентификатором очереди. При этом в последнем запросе нужно отправить параметр end=1, который зыкрывает очередь и является тригером для обработчика на загрузку предложений в систему. Если очередь не будет закрыта, то она не будет обработана и загружена в систему.

Чтобы удалить старый прайс-лист, нужно послать флаг удаления с первым или последним чанком offers/import?id=XXXX&delete=1. Если это прайс загружаемый одним запросом, то в get параметрах указываем все три флага (start, end, delete) offers/import?start=1&end=1&delete=1

В предложениях доступна загрузка '''Акций''' с типом '''"Выгодная цена"''' - фактическая скидка на товар. Для этого в предложении необходимо указать первоначальную цену Price 1 (для магазина), Price 2 (для ХоРеКа) и конечную промо-цену Price 5.
Таким образом для Торговой точки в каталоге товаров предложения с Выгодной ценой отображаются с перечеркнутой старой ценой (Price 1 или Price 2) и итоговая промо-цена (Price 5). Кроме того, предложение дополнительно помечается иконкой акции "%".

Для временно отсутствующего у поставщика товара в поле <code>quantity</code> предложения указывается значение <code>0</code> (ноль). Торговым точкам товар будет отображен с пометкой "нет в наличии". Добавить в корзину и заказать такой товар торговые точки не смогут.

ВАЖНО: значение Quantum (количество товара в фасовке/упаковке) обязательно должно быть кратно значению minQuantity (минимальное количество данного товара, которое ТТ обязано купить для оформления заказа). Если значения не пройдут валидацию, то добавится только значение Quantum.
Например:
Поставщик выставил предложение на товар по цене 1100 руб за единицу. Фасовка (quantum) осуществляется по 10 шт. Минимальное количество в заказе (minQuantity) - 30 шт. Для успешного заказа торговая точка первоначально добавляет в корзину 30 шт товара (сумма заказа составит 1100 * 30), далее добавление в корзину будет происходить с шагом в 10 шт.

===Получение списка предложений===
Для того чтобы получить список всех предложений, необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/offers. Ответом от сервера будет являться массив данных со списком всех ваших предложений в системе Smart Satu с их данными.
===Редактирование предложения===
Для того чтобы отредактировать предложения требуется добавить в запрос SKU данного предложения.
''Пример: https://food.smartsatu.site/api/offers/9876786897623''

Вместе с данным параметром мы отправляем JSON-тело запроса на изменение.

===Обновление остатков===
Для загрузки измененного количества товара (остатков) необходимо использовать API https://food.smartsatu.com/api/offers/import-only-quantity, в запросе к которому передается массив товаров ('''sku''' либо '''unique_code''') с актуальными значениями остатков:
[
{
"store_id": null,
"sku": null,
"unique_code": "48700034204351",
"quantity": 30,
}
]
Для обновления остатков в определенных персональных прайслистах необходимо в параметре '''store_id''' указать массив идентификаторов торговых точек.

===Удаление предложения===
Для того чтобы изменить предложение, необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}, где sku - это штрих-код предложения, которое необходимо изменить.
Ответом от сервера будет являться массив данных с измененными данными предложения.

Для удаления конкретного предложения из всех прайс-листов (как общих, так и индивидульных) необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}/all, где sku - это штрих-код предложения, которое необходимо изменить. ''Пример: https://food.smartsatu.com/api/offers/5053990106868/all''

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение предложения
|
|}
==Ответы==
'''Offers Import Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Import_Response Offers Import Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|}
'''Offers Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Response Offers Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Offers#401 401]
|}
'''Offers Response (изменение):'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|}
'''Delete Offer:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 204
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|-
| style="font-weight:bold;" | 404
| Not Found
| [http://docs.smartsatu.com/wiki/API_Offers#404 404]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Импорт предложений===
POST /offers/import?start=1

====Offers Import Request====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| varchar(255)
| 9876786897623
|-
| style="font-weight:bold;" | unit
| Единица измерения
| varchar(50)
| шт / кг
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. Пока слать 1 (есть в наличии) или 0 (нет в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_without_vat
| Цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | promotion_price_without_vat
| Промо цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | delivery_days
| Дни доставки* '''На данный момент данный параметр не используется! Вся функциональность по настройке дней доставки регулируется через WEB-интерфейс'''
| varchar(127)
| "1,2,3,4,5,6,0"
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения '''Сервисное поле поставщика. Возвращается в заказе. Например, GUID для 1С.'''
| varchar(255)
| string / null
|-
| style="font-weight:bold;" | quantum
| Квант поставки
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | isImport
| Импортировать предложение (да/нет)
| boolean
| 1 / 0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "product1",
"sku": "9876786897623",
"store_id": null
"unit": "",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 555,
"price_2": null,
"price_3": null,
"price_4": null,
"price_5": null *Указание выгодной цены,
"price_without_vat": null,
"promotion_price_without_vat": null,
"delivery_days": "1,2,3,4,5,6,0",
"unique_code": null, //тут может быть GUID
"quantum": 5.000,
"isImport": "1",
"minQuantity": 5.000,
"status": 1
}
]

====Offers Import Response====
{| class="wikitable"
|-
! Name !! Description !! Schema !! Example
|-
| '''id''' || Идентификатор очереди || string || 5d720cfee9d7c84ad038ff41
|-
| '''count''' || Количество предложений || integer || 2
|-
| '''comment''' || Комментарий || string || null
|}
Пример ответа:
{
"id": "5d720cfee9d7c84ad038ff41",
"count": 2,
"comment": null
}

===Изменение предложений===
PUT /offers/{sku}

====Offers Request (изменение)====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. Пока слать 1 (есть в наличии) или 0 (нет в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет)
| string
| 1
|-
| style="font-weight:bold;" | quantum
| Квант
| decimal(19,3)
| 8.0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "Обновленное название предложения",
"manufacturer": "",
"quantity": 100,
"expires_at": null,
"price_1": 333,
"price_2": 500,
"price_3": null,
"price_4": null,
"price_5": null,
"status": 1
"quantum": 8.0,
"minQuantity": null, //нет требования по минимальному количеству в заказе
"status": 1
}
]

====Offers Response====
'''NB!''' Ответ приходит в json и по факту это string. За парсинг и выбор типа значений отвечает сторона поставщика.
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования предложения в системе SmartSatu
| integer
| 4317231
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| 425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA
|-
| style="font-weight:bold;" | sku
| Артикул предложения
| string
| 4870007151458
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 329
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 329
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| null
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения '''Идентификатор предложения у поставщика'''
| string
| 141209
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта (идентификатор товарной карточки в системе SmartSatu)
| string
| 28952
|-
| style="font-weight:bold;" | step
| Квант поставки (quantum)
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| null
|}
Пример ответа:

[
{
"id": 4317231,
"name": "425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA",
"sku": 870007151458,
"unit": "шт",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 329,
"price_2": 329,
"price_3": null,
"price_4": null,
"price_5": null,
"unique_code": "141209",
"product_id": null,
"step": null,
"minQuantity": null
}
]

===Удаление предложений===
DELETE /offers/{sku}
====Delete Offer====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | status
| Код
| integer
| 204
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение удалено
|}
Пример ответа:
{
"status": 204,
"message": "Предложение удалено."
}

===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

===404===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Not Found
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение не существует, удалено либо недоступно
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 404
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:

{
"name": "Not Found",
"message": "Предложение не существует, удалено либо недоступно",
"code": 0,
"status": 404,
"type": "yii\\web\\HttpException"
}

API Offers

2021-08-10T08:26:38Z

User: /* Offers Response */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению списка предложений, а также изменению, удалению и импорту предложений в системе Smart Satu.

Предложение - это цена, которую предлагает поставщик за определенный товар. Также система Smart Satu позволяет загружать как общие предложения, которые доступны всем торговым точкам, так индивидуальные для конкретных магазинов.

Больше информации по предложениям находится по ссылке: [http://docs.smartsatu.com/wiki/SmartSatuSupplier#.D0.A0.D0.B0.D0.B1.D0.BE.D1.82.D0.B0_.D1.81_.D0.BF.D1.80.D0.B5.D0.B4.D0.BB.D0.BE.D0.B6.D0.B5.D0.BD.D0.B8.D1.8F.D0.BC.D0.B8 Работа с предложениями]

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Импорт предложений===
POST /offers/import?start=1
===Получение списка предложений===
GET /offers
===Изменение предложений===
PUT /offers/{sku}

===Удаление предложений===
DELETE /offers/{sku}

==Описание==
===Батчевый импорт предложений===
Данный метод предназначен для оптового импорта предложений (batch) в систему с ограничением в 1000 предложений в одном запросе.
Первый запрос должен отправляться с параметром <code>start=1</code>
<code>https://food.smartsatu.com/api/offers/import?start=1</code>
В ответ первого запроса вы получите транзакционный идентификатор очереди вида:
{
'id': '98db89147d6cd0018417b71'
}
Для всех последующих запросов на импорт предложений, вам необходимо добавлять транзакционный идентификатор в параметры запроса:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71</code>
Для того чтобы закончить оптовый импорт предложений в систему, необходимо отправить запрос с параметром end=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1</code>
Если вам необходимо удалить все старые предложения, то в последнем запросе необходимо передать параметр delete=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1&delete=1</code>

В атрибуте 'comment' в JSON-ответе описываются причины ошибок.

Для того чтобы осуществить батчевую '''загрузку персональных прайсов (для конкретной торговой точки)''' необходимо указать в get параметрах запроса <code>store_id</code> (id торговой точки):
<code>https://food.smartsatu.com/api/offers/import?start=1&end=1&delete=1&store_id=80</code>

Рекомендации по батчевой загрузке предложений:
Рекомендуем прогружать по 500-1000 предложений в одном запросе. Т.к. если прайс-лист до 1000 предложений, то его можно прогрузить одним запросом. Для этого в запросе на батчевую загрузку устанавливаются флаги старта и окончания очереди: offers/import?start=1&end=1.
Прайс-лист может быть больше чем 1000 штук. Так, если прайс-лист содержит больше 1000 предложений, то открывается очередь с первым запросом с первой 1000 предложений: offers/import?start=1. В ответе вернется id очереди.
С последующими запросами нужно будет слать id очереди в get параметрах offers/import?id=XXXX.
C последним чанком большого прайс-листа нужно будет послать флаг окончания offers/import?id=XXXX&end=1.
'''NB!''' Допустим нужно загрузить 5000 предложений. Мы отправляем первый запрос с 1000 предложений и получаем в ответ идентификатор очереди. Дальше посылаем еще 4 запроса с 1000 предложений в каждом запросе и идентификатором очереди. При этом в последнем запросе нужно отправить параметр end=1, который зыкрывает очередь и является тригером для обработчика на загрузку предложений в систему. Если очередь не будет закрыта, то она не будет обработана и загружена в систему.

Чтобы удалить старый прайс-лист, нужно послать флаг удаления с первым или последним чанком offers/import?id=XXXX&delete=1. Если это прайс загружаемый одним запросом, то в get параметрах указываем все три флага (start, end, delete) offers/import?start=1&end=1&delete=1

В предложениях доступна загрузка '''Акций''' с типом '''"Выгодная цена"''' - фактическая скидка на товар. Для этого в предложении необходимо указать первоначальную цену Price 1 (для магазина), Price 2 (для ХоРеКа) и конечную промо-цену Price 5.
Таким образом для Торговой точки в каталоге товаров предложения с Выгодной ценой отображаются с перечеркнутой старой ценой (Price 1 или Price 2) и итоговая промо-цена (Price 5). Кроме того, предложение дополнительно помечается иконкой акции "%".

Для временно отсутствующего у поставщика товара в поле <code>quantity</code> предложения указывается значение <code>0</code> (ноль). Торговым точкам товар будет отображен с пометкой "нет в наличии". Добавить в корзину и заказать такой товар торговые точки не смогут.

ВАЖНО: значение Quantum (количество товара в фасовке/упаковке) обязательно должно быть кратно значению minQuantity (минимальное количество данного товара, которое ТТ обязано купить для оформления заказа). Если значения не пройдут валидацию, то добавится только значение Quantum.
Например:
Поставщик выставил предложение на товар по цене 1100 руб за единицу. Фасовка (quantum) осуществляется по 10 шт. Минимальное количество в заказе (minQuantity) - 30 шт. Для успешного заказа торговая точка первоначально добавляет в корзину 30 шт товара (сумма заказа составит 1100 * 30), далее добавление в корзину будет происходить с шагом в 10 шт.

===Получение списка предложений===
Для того чтобы получить список всех предложений, необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/offers. Ответом от сервера будет являться массив данных со списком всех ваших предложений в системе Smart Satu с их данными.
===Редактирование предложения===
Для того чтобы отредактировать предложения требуется добавить в запрос SKU данного предложения.
''Пример: https://food.smartsatu.site/api/offers/9876786897623''

Вместе с данным параметром мы отправляем JSON-тело запроса на изменение.

===Обновление остатков===
Для загрузки измененного количества товара (остатков) необходимо использовать API https://food.smartsatu.com/api/offers/import-only-quantity, в запросе к которому передается массив товаров ('''sku''' либо '''unique_code''') с актуальными значениями остатков:
[
{
"store_id": null,
"sku": null,
"unique_code": "48700034204351",
"quantity": 30,
}
]
Для обновления остатков в определенных персональных прайслистах необходимо в параметре '''store_id''' указать массив идентификаторов торговых точек.

===Удаление предложения===
Для того чтобы изменить предложение, необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}, где sku - это штрих-код предложения, которое необходимо изменить.
Ответом от сервера будет являться массив данных с измененными данными предложения.

Для удаления конкретного предложения из всех прайс-листов (как общих, так и индивидульных) необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}/all, где sku - это штрих-код предложения, которое необходимо изменить. ''Пример: https://food.smartsatu.com/api/offers/5053990106868/all''

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение предложения
|
|}
==Ответы==
'''Offers Import Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Import_Response Offers Import Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|}
'''Offers Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Response Offers Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Offers#401 401]
|}
'''Offers Response (изменение):'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|}
'''Delete Offer:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 204
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|-
| style="font-weight:bold;" | 404
| Not Found
| [http://docs.smartsatu.com/wiki/API_Offers#404 404]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Импорт предложений===
POST /offers/import?start=1

====Offers Import Request====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| varchar(255)
| 9876786897623
|-
| style="font-weight:bold;" | unit
| Единица измерения
| varchar(50)
| шт / кг
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. Пока слать 1 (есть в наличии) или 0 (нет в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_without_vat
| Цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | promotion_price_without_vat
| Промо цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | delivery_days
| Дни доставки* '''На данный момент данный параметр не используется! Вся функциональность по настройке дней доставки регулируется через WEB-интерфейс'''
| varchar(127)
| "1,2,3,4,5,6,0"
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения '''Сервисное поле поставщика. Возвращается в заказе. Например, GUID для 1С.'''
| varchar(255)
| string / null
|-
| style="font-weight:bold;" | quantum
| Квант поставки
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | isImport
| Импортировать предложение (да/нет)
| boolean
| 1 / 0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "product1",
"sku": "9876786897623",
"store_id": null
"unit": "",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 555,
"price_2": null,
"price_3": null,
"price_4": null,
"price_5": null *Указание выгодной цены,
"price_without_vat": null,
"promotion_price_without_vat": null,
"delivery_days": "1,2,3,4,5,6,0",
"unique_code": null, //тут может быть GUID
"quantum": 5.000,
"isImport": "1",
"minQuantity": 5.000,
"status": 1
}
]

====Offers Import Response====
{| class="wikitable"
|-
! Name !! Description !! Schema !! Example
|-
| '''id''' || Идентификатор очереди || string || 5d720cfee9d7c84ad038ff41
|-
| '''count''' || Количество предложений || integer || 2
|-
| '''comment''' || Комментарий || string || null
|}
Пример ответа:
{
"id": "5d720cfee9d7c84ad038ff41",
"count": 2,
"comment": null
}

===Изменение предложений===
PUT /offers/{sku}

====Offers Request (изменение)====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. Пока слать 1 (есть в наличии) или 0 (нет в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет)
| string
| 1
|-
| style="font-weight:bold;" | quantum
| Квант
| decimal(19,3)
| 8.0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "Обновленное название предложения",
"manufacturer": "",
"quantity": 100,
"expires_at": null,
"price_1": 333,
"price_2": 500,
"price_3": null,
"price_4": null,
"price_5": null,
"status": 1
"quantum": 8.0,
"minQuantity": null, //нет требования по минимальному количеству в заказе
"status": 1
}
]

====Offers Response====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования предложения в системе SmartSatu
| integer
| 4317231
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| 425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA
|-
| style="font-weight:bold;" | sku
| Артикул предложения
| string
| 4870007151458
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 329
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 329
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| null
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения '''Идентификатор предложения у поставщика'''
| string
| 141209
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта (идентификатор товарной карточки в системе SmartSatu)
| string
| 28952
|-
| style="font-weight:bold;" | step
| Квант поставки (quantum)
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| null
|}
Пример ответа:

[
{
"id": 4317231,
"name": "425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA",
"sku": 870007151458,
"unit": "шт",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 329,
"price_2": 329,
"price_3": null,
"price_4": null,
"price_5": null,
"unique_code": "141209",
"product_id": null,
"step": null,
"minQuantity": null
}
]

===Удаление предложений===
DELETE /offers/{sku}
====Delete Offer====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | status
| Код
| integer
| 204
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение удалено
|}
Пример ответа:
{
"status": 204,
"message": "Предложение удалено."
}

===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

===404===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Not Found
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение не существует, удалено либо недоступно
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 404
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:

{
"name": "Not Found",
"message": "Предложение не существует, удалено либо недоступно",
"code": 0,
"status": 404,
"type": "yii\\web\\HttpException"
}

API Offers

2021-08-10T08:24:37Z

User: /* 404 */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению списка предложений, а также изменению, удалению и импорту предложений в системе Smart Satu.

Предложение - это цена, которую предлагает поставщик за определенный товар. Также система Smart Satu позволяет загружать как общие предложения, которые доступны всем торговым точкам, так индивидуальные для конкретных магазинов.

Больше информации по предложениям находится по ссылке: [http://docs.smartsatu.com/wiki/SmartSatuSupplier#.D0.A0.D0.B0.D0.B1.D0.BE.D1.82.D0.B0_.D1.81_.D0.BF.D1.80.D0.B5.D0.B4.D0.BB.D0.BE.D0.B6.D0.B5.D0.BD.D0.B8.D1.8F.D0.BC.D0.B8 Работа с предложениями]

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Импорт предложений===
POST /offers/import?start=1
===Получение списка предложений===
GET /offers
===Изменение предложений===
PUT /offers/{sku}

===Удаление предложений===
DELETE /offers/{sku}

==Описание==
===Батчевый импорт предложений===
Данный метод предназначен для оптового импорта предложений (batch) в систему с ограничением в 1000 предложений в одном запросе.
Первый запрос должен отправляться с параметром <code>start=1</code>
<code>https://food.smartsatu.com/api/offers/import?start=1</code>
В ответ первого запроса вы получите транзакционный идентификатор очереди вида:
{
'id': '98db89147d6cd0018417b71'
}
Для всех последующих запросов на импорт предложений, вам необходимо добавлять транзакционный идентификатор в параметры запроса:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71</code>
Для того чтобы закончить оптовый импорт предложений в систему, необходимо отправить запрос с параметром end=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1</code>
Если вам необходимо удалить все старые предложения, то в последнем запросе необходимо передать параметр delete=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1&delete=1</code>

В атрибуте 'comment' в JSON-ответе описываются причины ошибок.

Для того чтобы осуществить батчевую '''загрузку персональных прайсов (для конкретной торговой точки)''' необходимо указать в get параметрах запроса <code>store_id</code> (id торговой точки):
<code>https://food.smartsatu.com/api/offers/import?start=1&end=1&delete=1&store_id=80</code>

Рекомендации по батчевой загрузке предложений:
Рекомендуем прогружать по 500-1000 предложений в одном запросе. Т.к. если прайс-лист до 1000 предложений, то его можно прогрузить одним запросом. Для этого в запросе на батчевую загрузку устанавливаются флаги старта и окончания очереди: offers/import?start=1&end=1.
Прайс-лист может быть больше чем 1000 штук. Так, если прайс-лист содержит больше 1000 предложений, то открывается очередь с первым запросом с первой 1000 предложений: offers/import?start=1. В ответе вернется id очереди.
С последующими запросами нужно будет слать id очереди в get параметрах offers/import?id=XXXX.
C последним чанком большого прайс-листа нужно будет послать флаг окончания offers/import?id=XXXX&end=1.
'''NB!''' Допустим нужно загрузить 5000 предложений. Мы отправляем первый запрос с 1000 предложений и получаем в ответ идентификатор очереди. Дальше посылаем еще 4 запроса с 1000 предложений в каждом запросе и идентификатором очереди. При этом в последнем запросе нужно отправить параметр end=1, который зыкрывает очередь и является тригером для обработчика на загрузку предложений в систему. Если очередь не будет закрыта, то она не будет обработана и загружена в систему.

Чтобы удалить старый прайс-лист, нужно послать флаг удаления с первым или последним чанком offers/import?id=XXXX&delete=1. Если это прайс загружаемый одним запросом, то в get параметрах указываем все три флага (start, end, delete) offers/import?start=1&end=1&delete=1

В предложениях доступна загрузка '''Акций''' с типом '''"Выгодная цена"''' - фактическая скидка на товар. Для этого в предложении необходимо указать первоначальную цену Price 1 (для магазина), Price 2 (для ХоРеКа) и конечную промо-цену Price 5.
Таким образом для Торговой точки в каталоге товаров предложения с Выгодной ценой отображаются с перечеркнутой старой ценой (Price 1 или Price 2) и итоговая промо-цена (Price 5). Кроме того, предложение дополнительно помечается иконкой акции "%".

Для временно отсутствующего у поставщика товара в поле <code>quantity</code> предложения указывается значение <code>0</code> (ноль). Торговым точкам товар будет отображен с пометкой "нет в наличии". Добавить в корзину и заказать такой товар торговые точки не смогут.

ВАЖНО: значение Quantum (количество товара в фасовке/упаковке) обязательно должно быть кратно значению minQuantity (минимальное количество данного товара, которое ТТ обязано купить для оформления заказа). Если значения не пройдут валидацию, то добавится только значение Quantum.
Например:
Поставщик выставил предложение на товар по цене 1100 руб за единицу. Фасовка (quantum) осуществляется по 10 шт. Минимальное количество в заказе (minQuantity) - 30 шт. Для успешного заказа торговая точка первоначально добавляет в корзину 30 шт товара (сумма заказа составит 1100 * 30), далее добавление в корзину будет происходить с шагом в 10 шт.

===Получение списка предложений===
Для того чтобы получить список всех предложений, необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/offers. Ответом от сервера будет являться массив данных со списком всех ваших предложений в системе Smart Satu с их данными.
===Редактирование предложения===
Для того чтобы отредактировать предложения требуется добавить в запрос SKU данного предложения.
''Пример: https://food.smartsatu.site/api/offers/9876786897623''

Вместе с данным параметром мы отправляем JSON-тело запроса на изменение.

===Обновление остатков===
Для загрузки измененного количества товара (остатков) необходимо использовать API https://food.smartsatu.com/api/offers/import-only-quantity, в запросе к которому передается массив товаров ('''sku''' либо '''unique_code''') с актуальными значениями остатков:
[
{
"store_id": null,
"sku": null,
"unique_code": "48700034204351",
"quantity": 30,
}
]
Для обновления остатков в определенных персональных прайслистах необходимо в параметре '''store_id''' указать массив идентификаторов торговых точек.

===Удаление предложения===
Для того чтобы изменить предложение, необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}, где sku - это штрих-код предложения, которое необходимо изменить.
Ответом от сервера будет являться массив данных с измененными данными предложения.

Для удаления конкретного предложения из всех прайс-листов (как общих, так и индивидульных) необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}/all, где sku - это штрих-код предложения, которое необходимо изменить. ''Пример: https://food.smartsatu.com/api/offers/5053990106868/all''

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение предложения
|
|}
==Ответы==
'''Offers Import Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Import_Response Offers Import Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|}
'''Offers Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Response Offers Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Offers#401 401]
|}
'''Offers Response (изменение):'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|}
'''Delete Offer:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 204
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|-
| style="font-weight:bold;" | 404
| Not Found
| [http://docs.smartsatu.com/wiki/API_Offers#404 404]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Импорт предложений===
POST /offers/import?start=1

====Offers Import Request====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| varchar(255)
| 9876786897623
|-
| style="font-weight:bold;" | unit
| Единица измерения
| varchar(50)
| шт / кг
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. Пока слать 1 (есть в наличии) или 0 (нет в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_without_vat
| Цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | promotion_price_without_vat
| Промо цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | delivery_days
| Дни доставки* '''На данный момент данный параметр не используется! Вся функциональность по настройке дней доставки регулируется через WEB-интерфейс'''
| varchar(127)
| "1,2,3,4,5,6,0"
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения '''Сервисное поле поставщика. Возвращается в заказе. Например, GUID для 1С.'''
| varchar(255)
| string / null
|-
| style="font-weight:bold;" | quantum
| Квант поставки
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | isImport
| Импортировать предложение (да/нет)
| boolean
| 1 / 0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "product1",
"sku": "9876786897623",
"store_id": null
"unit": "",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 555,
"price_2": null,
"price_3": null,
"price_4": null,
"price_5": null *Указание выгодной цены,
"price_without_vat": null,
"promotion_price_without_vat": null,
"delivery_days": "1,2,3,4,5,6,0",
"unique_code": null, //тут может быть GUID
"quantum": 5.000,
"isImport": "1",
"minQuantity": 5.000,
"status": 1
}
]

====Offers Import Response====
{| class="wikitable"
|-
! Name !! Description !! Schema !! Example
|-
| '''id''' || Идентификатор очереди || string || 5d720cfee9d7c84ad038ff41
|-
| '''count''' || Количество предложений || integer || 2
|-
| '''comment''' || Комментарий || string || null
|}
Пример ответа:
{
"id": "5d720cfee9d7c84ad038ff41",
"count": 2,
"comment": null
}

===Изменение предложений===
PUT /offers/{sku}

====Offers Request (изменение)====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. Пока слать 1 (есть в наличии) или 0 (нет в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет)
| string
| 1
|-
| style="font-weight:bold;" | quantum
| Квант
| decimal(19,3)
| 8.0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "Обновленное название предложения",
"manufacturer": "",
"quantity": 100,
"expires_at": null,
"price_1": 333,
"price_2": 500,
"price_3": null,
"price_4": null,
"price_5": null,
"status": 1
"quantum": 8.0,
"minQuantity": null, //нет требования по минимальному количеству в заказе
"status": 1
}
]

====Offers Response====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования предложения в системе SmartSatu
| integer($int32)
| 4317231
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| 425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA
|-
| style="font-weight:bold;" | sku
| Артикул предложения
| string
| 4870007151458
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 329
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 329
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| null
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения
| string
| 141209
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта (идентификатор товарной карточки в системе SmartSatu)
| string
| 28952
|-
| style="font-weight:bold;" | step
| Квант поставки (quantum)
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| null
|}
Пример ответа:

[
{
"id": 4317231,
"name": "425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA",
"sku": 870007151458,
"unit": "шт",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 329,
"price_2": 329,
"price_3": null,
"price_4": null,
"price_5": null,
"unique_code": "141209",
"product_id": null,
"step": null,
"minQuantity": null,
}
]

===Удаление предложений===
DELETE /offers/{sku}
====Delete Offer====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | status
| Код
| integer
| 204
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение удалено
|}
Пример ответа:
{
"status": 204,
"message": "Предложение удалено."
}

===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

===404===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Not Found
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение не существует, удалено либо недоступно
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 404
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:

{
"name": "Not Found",
"message": "Предложение не существует, удалено либо недоступно",
"code": 0,
"status": 404,
"type": "yii\\web\\HttpException"
}

API Offers

2021-08-10T08:24:23Z

User: /* 403 */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению списка предложений, а также изменению, удалению и импорту предложений в системе Smart Satu.

Предложение - это цена, которую предлагает поставщик за определенный товар. Также система Smart Satu позволяет загружать как общие предложения, которые доступны всем торговым точкам, так индивидуальные для конкретных магазинов.

Больше информации по предложениям находится по ссылке: [http://docs.smartsatu.com/wiki/SmartSatuSupplier#.D0.A0.D0.B0.D0.B1.D0.BE.D1.82.D0.B0_.D1.81_.D0.BF.D1.80.D0.B5.D0.B4.D0.BB.D0.BE.D0.B6.D0.B5.D0.BD.D0.B8.D1.8F.D0.BC.D0.B8 Работа с предложениями]

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Импорт предложений===
POST /offers/import?start=1
===Получение списка предложений===
GET /offers
===Изменение предложений===
PUT /offers/{sku}

===Удаление предложений===
DELETE /offers/{sku}

==Описание==
===Батчевый импорт предложений===
Данный метод предназначен для оптового импорта предложений (batch) в систему с ограничением в 1000 предложений в одном запросе.
Первый запрос должен отправляться с параметром <code>start=1</code>
<code>https://food.smartsatu.com/api/offers/import?start=1</code>
В ответ первого запроса вы получите транзакционный идентификатор очереди вида:
{
'id': '98db89147d6cd0018417b71'
}
Для всех последующих запросов на импорт предложений, вам необходимо добавлять транзакционный идентификатор в параметры запроса:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71</code>
Для того чтобы закончить оптовый импорт предложений в систему, необходимо отправить запрос с параметром end=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1</code>
Если вам необходимо удалить все старые предложения, то в последнем запросе необходимо передать параметр delete=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1&delete=1</code>

В атрибуте 'comment' в JSON-ответе описываются причины ошибок.

Для того чтобы осуществить батчевую '''загрузку персональных прайсов (для конкретной торговой точки)''' необходимо указать в get параметрах запроса <code>store_id</code> (id торговой точки):
<code>https://food.smartsatu.com/api/offers/import?start=1&end=1&delete=1&store_id=80</code>

Рекомендации по батчевой загрузке предложений:
Рекомендуем прогружать по 500-1000 предложений в одном запросе. Т.к. если прайс-лист до 1000 предложений, то его можно прогрузить одним запросом. Для этого в запросе на батчевую загрузку устанавливаются флаги старта и окончания очереди: offers/import?start=1&end=1.
Прайс-лист может быть больше чем 1000 штук. Так, если прайс-лист содержит больше 1000 предложений, то открывается очередь с первым запросом с первой 1000 предложений: offers/import?start=1. В ответе вернется id очереди.
С последующими запросами нужно будет слать id очереди в get параметрах offers/import?id=XXXX.
C последним чанком большого прайс-листа нужно будет послать флаг окончания offers/import?id=XXXX&end=1.
'''NB!''' Допустим нужно загрузить 5000 предложений. Мы отправляем первый запрос с 1000 предложений и получаем в ответ идентификатор очереди. Дальше посылаем еще 4 запроса с 1000 предложений в каждом запросе и идентификатором очереди. При этом в последнем запросе нужно отправить параметр end=1, который зыкрывает очередь и является тригером для обработчика на загрузку предложений в систему. Если очередь не будет закрыта, то она не будет обработана и загружена в систему.

Чтобы удалить старый прайс-лист, нужно послать флаг удаления с первым или последним чанком offers/import?id=XXXX&delete=1. Если это прайс загружаемый одним запросом, то в get параметрах указываем все три флага (start, end, delete) offers/import?start=1&end=1&delete=1

В предложениях доступна загрузка '''Акций''' с типом '''"Выгодная цена"''' - фактическая скидка на товар. Для этого в предложении необходимо указать первоначальную цену Price 1 (для магазина), Price 2 (для ХоРеКа) и конечную промо-цену Price 5.
Таким образом для Торговой точки в каталоге товаров предложения с Выгодной ценой отображаются с перечеркнутой старой ценой (Price 1 или Price 2) и итоговая промо-цена (Price 5). Кроме того, предложение дополнительно помечается иконкой акции "%".

Для временно отсутствующего у поставщика товара в поле <code>quantity</code> предложения указывается значение <code>0</code> (ноль). Торговым точкам товар будет отображен с пометкой "нет в наличии". Добавить в корзину и заказать такой товар торговые точки не смогут.

ВАЖНО: значение Quantum (количество товара в фасовке/упаковке) обязательно должно быть кратно значению minQuantity (минимальное количество данного товара, которое ТТ обязано купить для оформления заказа). Если значения не пройдут валидацию, то добавится только значение Quantum.
Например:
Поставщик выставил предложение на товар по цене 1100 руб за единицу. Фасовка (quantum) осуществляется по 10 шт. Минимальное количество в заказе (minQuantity) - 30 шт. Для успешного заказа торговая точка первоначально добавляет в корзину 30 шт товара (сумма заказа составит 1100 * 30), далее добавление в корзину будет происходить с шагом в 10 шт.

===Получение списка предложений===
Для того чтобы получить список всех предложений, необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/offers. Ответом от сервера будет являться массив данных со списком всех ваших предложений в системе Smart Satu с их данными.
===Редактирование предложения===
Для того чтобы отредактировать предложения требуется добавить в запрос SKU данного предложения.
''Пример: https://food.smartsatu.site/api/offers/9876786897623''

Вместе с данным параметром мы отправляем JSON-тело запроса на изменение.

===Обновление остатков===
Для загрузки измененного количества товара (остатков) необходимо использовать API https://food.smartsatu.com/api/offers/import-only-quantity, в запросе к которому передается массив товаров ('''sku''' либо '''unique_code''') с актуальными значениями остатков:
[
{
"store_id": null,
"sku": null,
"unique_code": "48700034204351",
"quantity": 30,
}
]
Для обновления остатков в определенных персональных прайслистах необходимо в параметре '''store_id''' указать массив идентификаторов торговых точек.

===Удаление предложения===
Для того чтобы изменить предложение, необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}, где sku - это штрих-код предложения, которое необходимо изменить.
Ответом от сервера будет являться массив данных с измененными данными предложения.

Для удаления конкретного предложения из всех прайс-листов (как общих, так и индивидульных) необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}/all, где sku - это штрих-код предложения, которое необходимо изменить. ''Пример: https://food.smartsatu.com/api/offers/5053990106868/all''

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение предложения
|
|}
==Ответы==
'''Offers Import Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Import_Response Offers Import Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|}
'''Offers Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Response Offers Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Offers#401 401]
|}
'''Offers Response (изменение):'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|}
'''Delete Offer:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 204
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|-
| style="font-weight:bold;" | 404
| Not Found
| [http://docs.smartsatu.com/wiki/API_Offers#404 404]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Импорт предложений===
POST /offers/import?start=1

====Offers Import Request====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| varchar(255)
| 9876786897623
|-
| style="font-weight:bold;" | unit
| Единица измерения
| varchar(50)
| шт / кг
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. Пока слать 1 (есть в наличии) или 0 (нет в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_without_vat
| Цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | promotion_price_without_vat
| Промо цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | delivery_days
| Дни доставки* '''На данный момент данный параметр не используется! Вся функциональность по настройке дней доставки регулируется через WEB-интерфейс'''
| varchar(127)
| "1,2,3,4,5,6,0"
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения '''Сервисное поле поставщика. Возвращается в заказе. Например, GUID для 1С.'''
| varchar(255)
| string / null
|-
| style="font-weight:bold;" | quantum
| Квант поставки
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | isImport
| Импортировать предложение (да/нет)
| boolean
| 1 / 0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "product1",
"sku": "9876786897623",
"store_id": null
"unit": "",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 555,
"price_2": null,
"price_3": null,
"price_4": null,
"price_5": null *Указание выгодной цены,
"price_without_vat": null,
"promotion_price_without_vat": null,
"delivery_days": "1,2,3,4,5,6,0",
"unique_code": null, //тут может быть GUID
"quantum": 5.000,
"isImport": "1",
"minQuantity": 5.000,
"status": 1
}
]

====Offers Import Response====
{| class="wikitable"
|-
! Name !! Description !! Schema !! Example
|-
| '''id''' || Идентификатор очереди || string || 5d720cfee9d7c84ad038ff41
|-
| '''count''' || Количество предложений || integer || 2
|-
| '''comment''' || Комментарий || string || null
|}
Пример ответа:
{
"id": "5d720cfee9d7c84ad038ff41",
"count": 2,
"comment": null
}

===Изменение предложений===
PUT /offers/{sku}

====Offers Request (изменение)====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. Пока слать 1 (есть в наличии) или 0 (нет в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет)
| string
| 1
|-
| style="font-weight:bold;" | quantum
| Квант
| decimal(19,3)
| 8.0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "Обновленное название предложения",
"manufacturer": "",
"quantity": 100,
"expires_at": null,
"price_1": 333,
"price_2": 500,
"price_3": null,
"price_4": null,
"price_5": null,
"status": 1
"quantum": 8.0,
"minQuantity": null, //нет требования по минимальному количеству в заказе
"status": 1
}
]

====Offers Response====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования предложения в системе SmartSatu
| integer($int32)
| 4317231
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| 425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA
|-
| style="font-weight:bold;" | sku
| Артикул предложения
| string
| 4870007151458
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 329
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 329
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| null
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения
| string
| 141209
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта (идентификатор товарной карточки в системе SmartSatu)
| string
| 28952
|-
| style="font-weight:bold;" | step
| Квант поставки (quantum)
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| null
|}
Пример ответа:

[
{
"id": 4317231,
"name": "425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA",
"sku": 870007151458,
"unit": "шт",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 329,
"price_2": 329,
"price_3": null,
"price_4": null,
"price_5": null,
"unique_code": "141209",
"product_id": null,
"step": null,
"minQuantity": null,
}
]

===Удаление предложений===
DELETE /offers/{sku}
====Delete Offer====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | status
| Код
| integer
| 204
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение удалено
|}
Пример ответа:
{
"status": 204,
"message": "Предложение удалено."
}

===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}

===404===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Not Found
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение не существует, удалено либо недоступно
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 404
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:

{
"name": "Not Found",
"message": "Предложение не существует, удалено либо недоступно",
"code": 0,
"status": 404,
"type": "yii\\web\\HttpException"
}

API Offers

2021-08-10T08:24:09Z

User: /* 401 */

==Обзор==
Данный документ описывает методы для работы поставщика/дистрибьютора по получению списка предложений, а также изменению, удалению и импорту предложений в системе Smart Satu.

Предложение - это цена, которую предлагает поставщик за определенный товар. Также система Smart Satu позволяет загружать как общие предложения, которые доступны всем торговым точкам, так индивидуальные для конкретных магазинов.

Больше информации по предложениям находится по ссылке: [http://docs.smartsatu.com/wiki/SmartSatuSupplier#.D0.A0.D0.B0.D0.B1.D0.BE.D1.82.D0.B0_.D1.81_.D0.BF.D1.80.D0.B5.D0.B4.D0.BB.D0.BE.D0.B6.D0.B5.D0.BD.D0.B8.D1.8F.D0.BC.D0.B8 Работа с предложениями]

'''Версия'''

''Version'': 1.0.0

'''Контактная информация'''

''Contact'': [[info@smartsatu.com]]

'''URI схема'''

''Host : //food.smartsatu.com/api/ Schemes : HTTPS''

==Методы==
===Импорт предложений===
POST /offers/import?start=1
===Получение списка предложений===
GET /offers
===Изменение предложений===
PUT /offers/{sku}

===Удаление предложений===
DELETE /offers/{sku}

==Описание==
===Батчевый импорт предложений===
Данный метод предназначен для оптового импорта предложений (batch) в систему с ограничением в 1000 предложений в одном запросе.
Первый запрос должен отправляться с параметром <code>start=1</code>
<code>https://food.smartsatu.com/api/offers/import?start=1</code>
В ответ первого запроса вы получите транзакционный идентификатор очереди вида:
{
'id': '98db89147d6cd0018417b71'
}
Для всех последующих запросов на импорт предложений, вам необходимо добавлять транзакционный идентификатор в параметры запроса:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71</code>
Для того чтобы закончить оптовый импорт предложений в систему, необходимо отправить запрос с параметром end=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1</code>
Если вам необходимо удалить все старые предложения, то в последнем запросе необходимо передать параметр delete=1:
<code>https://food.smartsatu.com/api/offers/import?id=98db89147d6cd0018417b71&end=1&delete=1</code>

В атрибуте 'comment' в JSON-ответе описываются причины ошибок.

Для того чтобы осуществить батчевую '''загрузку персональных прайсов (для конкретной торговой точки)''' необходимо указать в get параметрах запроса <code>store_id</code> (id торговой точки):
<code>https://food.smartsatu.com/api/offers/import?start=1&end=1&delete=1&store_id=80</code>

Рекомендации по батчевой загрузке предложений:
Рекомендуем прогружать по 500-1000 предложений в одном запросе. Т.к. если прайс-лист до 1000 предложений, то его можно прогрузить одним запросом. Для этого в запросе на батчевую загрузку устанавливаются флаги старта и окончания очереди: offers/import?start=1&end=1.
Прайс-лист может быть больше чем 1000 штук. Так, если прайс-лист содержит больше 1000 предложений, то открывается очередь с первым запросом с первой 1000 предложений: offers/import?start=1. В ответе вернется id очереди.
С последующими запросами нужно будет слать id очереди в get параметрах offers/import?id=XXXX.
C последним чанком большого прайс-листа нужно будет послать флаг окончания offers/import?id=XXXX&end=1.
'''NB!''' Допустим нужно загрузить 5000 предложений. Мы отправляем первый запрос с 1000 предложений и получаем в ответ идентификатор очереди. Дальше посылаем еще 4 запроса с 1000 предложений в каждом запросе и идентификатором очереди. При этом в последнем запросе нужно отправить параметр end=1, который зыкрывает очередь и является тригером для обработчика на загрузку предложений в систему. Если очередь не будет закрыта, то она не будет обработана и загружена в систему.

Чтобы удалить старый прайс-лист, нужно послать флаг удаления с первым или последним чанком offers/import?id=XXXX&delete=1. Если это прайс загружаемый одним запросом, то в get параметрах указываем все три флага (start, end, delete) offers/import?start=1&end=1&delete=1

В предложениях доступна загрузка '''Акций''' с типом '''"Выгодная цена"''' - фактическая скидка на товар. Для этого в предложении необходимо указать первоначальную цену Price 1 (для магазина), Price 2 (для ХоРеКа) и конечную промо-цену Price 5.
Таким образом для Торговой точки в каталоге товаров предложения с Выгодной ценой отображаются с перечеркнутой старой ценой (Price 1 или Price 2) и итоговая промо-цена (Price 5). Кроме того, предложение дополнительно помечается иконкой акции "%".

Для временно отсутствующего у поставщика товара в поле <code>quantity</code> предложения указывается значение <code>0</code> (ноль). Торговым точкам товар будет отображен с пометкой "нет в наличии". Добавить в корзину и заказать такой товар торговые точки не смогут.

ВАЖНО: значение Quantum (количество товара в фасовке/упаковке) обязательно должно быть кратно значению minQuantity (минимальное количество данного товара, которое ТТ обязано купить для оформления заказа). Если значения не пройдут валидацию, то добавится только значение Quantum.
Например:
Поставщик выставил предложение на товар по цене 1100 руб за единицу. Фасовка (quantum) осуществляется по 10 шт. Минимальное количество в заказе (minQuantity) - 30 шт. Для успешного заказа торговая точка первоначально добавляет в корзину 30 шт товара (сумма заказа составит 1100 * 30), далее добавление в корзину будет происходить с шагом в 10 шт.

===Получение списка предложений===
Для того чтобы получить список всех предложений, необходимо отправить GET-запрос c пустым телом по URL: https://food.smartsatu.com/api/offers. Ответом от сервера будет являться массив данных со списком всех ваших предложений в системе Smart Satu с их данными.
===Редактирование предложения===
Для того чтобы отредактировать предложения требуется добавить в запрос SKU данного предложения.
''Пример: https://food.smartsatu.site/api/offers/9876786897623''

Вместе с данным параметром мы отправляем JSON-тело запроса на изменение.

===Обновление остатков===
Для загрузки измененного количества товара (остатков) необходимо использовать API https://food.smartsatu.com/api/offers/import-only-quantity, в запросе к которому передается массив товаров ('''sku''' либо '''unique_code''') с актуальными значениями остатков:
[
{
"store_id": null,
"sku": null,
"unique_code": "48700034204351",
"quantity": 30,
}
]
Для обновления остатков в определенных персональных прайслистах необходимо в параметре '''store_id''' указать массив идентификаторов торговых точек.

===Удаление предложения===
Для того чтобы изменить предложение, необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}, где sku - это штрих-код предложения, которое необходимо изменить.
Ответом от сервера будет являться массив данных с измененными данными предложения.

Для удаления конкретного предложения из всех прайс-листов (как общих, так и индивидульных) необходимо отправить PUT-запрос c JSON-телом по URL: https://food.smartsatu.com/api/offers/{sku}/all, где sku - это штрих-код предложения, которое необходимо изменить. ''Пример: https://food.smartsatu.com/api/offers/5053990106868/all''

==Безопасность==
В headers запроса обязательно должна передаваться страна пользователя, а также уникальный токен авторизации, который был получен при входе в систему. Ответом от сервера будет являться массив данных с измененными данными заказа.
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | In
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
|-
| style="font-weight:bold;" | Authorization
| header
| required
| Для создания HTTP Basic Auth заголовка нужно преобразовать access_token следующим образом: $auth= "Basic " . base64encode(access_token . ":"); Данный токен должен использоваться в каждом запросе в системе.
|-
| style="font-weight:bold;" | country
| header
| required
| Параметр страны должен использоваться в каждом запросе в системе.
|}
==Параметры==
{| class="wikitable"
! style="font-weight:bold;" | Type
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | Body
| style="font-style:italic;" | body required
| Запрос на изменение предложения
|
|}
==Ответы==
'''Offers Import Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Import_Response Offers Import Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Orders#401 401]
|}
'''Offers Response:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Offers#Offers_Response Offers Response]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [http://docs.smartsatu.com/wiki/API_Offers#401 401]
|}
'''Offers Response (изменение):'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 200
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|}
'''Delete Offer:'''
{| class="wikitable"
! style="font-weight:bold;" | HTTP Code
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
|-
| style="font-weight:bold;" | 204
| Ok
| [http://docs.smartsatu.com/wiki/API_Orders#Response_Orders_Items Response Order Items]
|-
| style="font-weight:bold;" | 401
| Unauthorized
| [[http://docs.smartsatu.com/wiki/API_Offers#401 401]
|-
| style="font-weight:bold;" | 403
| Forbidden
| [http://docs.smartsatu.com/wiki/API_Offers#403 403]
|-
| style="font-weight:bold;" | 404
| Not Found
| [http://docs.smartsatu.com/wiki/API_Offers#404 404]
|}
'''Принимаемые ресурсом типы MIME'''
*application/json
'''Возвращаемые ресурсом типы MIME'''
*application/json

==Определения==
===Импорт предложений===
POST /offers/import?start=1

====Offers Import Request====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | sku
| Штрих-код предложения
| varchar(255)
| 9876786897623
|-
| style="font-weight:bold;" | unit
| Единица измерения
| varchar(50)
| шт / кг
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. Пока слать 1 (есть в наличии) или 0 (нет в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_without_vat
| Цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | promotion_price_without_vat
| Промо цена без НДС (РФ)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | delivery_days
| Дни доставки* '''На данный момент данный параметр не используется! Вся функциональность по настройке дней доставки регулируется через WEB-интерфейс'''
| varchar(127)
| "1,2,3,4,5,6,0"
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения '''Сервисное поле поставщика. Возвращается в заказе. Например, GUID для 1С.'''
| varchar(255)
| string / null
|-
| style="font-weight:bold;" | quantum
| Квант поставки
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | isImport
| Импортировать предложение (да/нет)
| boolean
| 1 / 0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| 5.000
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "product1",
"sku": "9876786897623",
"store_id": null
"unit": "",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 555,
"price_2": null,
"price_3": null,
"price_4": null,
"price_5": null *Указание выгодной цены,
"price_without_vat": null,
"promotion_price_without_vat": null,
"delivery_days": "1,2,3,4,5,6,0",
"unique_code": null, //тут может быть GUID
"quantum": 5.000,
"isImport": "1",
"minQuantity": 5.000,
"status": 1
}
]

====Offers Import Response====
{| class="wikitable"
|-
! Name !! Description !! Schema !! Example
|-
| '''id''' || Идентификатор очереди || string || 5d720cfee9d7c84ad038ff41
|-
| '''count''' || Количество предложений || integer || 2
|-
| '''comment''' || Комментарий || string || null
|}
Пример ответа:
{
"id": "5d720cfee9d7c84ad038ff41",
"count": 2,
"comment": null
}

===Изменение предложений===
PUT /offers/{sku}

====Offers Request (изменение)====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название предложения
| varchar(255)
| product1
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| varchar(255)
| null
|-
| style="font-weight:bold;" | quantity
| Количество '''Для учета остатков. Пока слать 1 (есть в наличии) или 0 (нет в наличии).'''
| smallint(6)
| 1 / 0
|-
| style="font-weight:bold;" | expires_at
| Годен до
| int(10)
| null / unixtimestamp
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для торговых точек в типом Магазин)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для для торговых точек в типом HoReCa)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для для торговых точек в типом Рынок)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_4
| Цена 4 (только в случае заведения Акции)
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | price_5
| Выгодная цена
| decimal(19,2)
| float / null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет)
| string
| 1
|-
| style="font-weight:bold;" | quantum
| Квант
| decimal(19,3)
| 8.0
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| decimal(19,3)
| null
|-
| style="font-weight:bold;" | status
| Активность предложения (да/нет) '''Если нужно скрыть товарную карточку из каталога, то выставляем 0 (нет).'''
| tinyint(1)
| 1 / 0
|}
Пример запроса:
[
{
"name": "Обновленное название предложения",
"manufacturer": "",
"quantity": 100,
"expires_at": null,
"price_1": 333,
"price_2": 500,
"price_3": null,
"price_4": null,
"price_5": null,
"status": 1
"quantum": 8.0,
"minQuantity": null, //нет требования по минимальному количеству в заказе
"status": 1
}
]

====Offers Response====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | id
| Идентификатор наименования предложения в системе SmartSatu
| integer($int32)
| 4317231
|-
| style="font-weight:bold;" | name
| Название предложения
| string
| 425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA
|-
| style="font-weight:bold;" | sku
| Артикул предложения
| string
| 4870007151458
|-
| style="font-weight:bold;" | unit
| Единица измерения предложения
| string
| шт
|-
| style="font-weight:bold;" | manufacturer
| Производитель
| string
| null
|-
| style="font-weight:bold;" | quantity
| Количество
| string
| 1
|-
| style="font-weight:bold;" | expires_at
| Годен до
| string
| null
|-
| style="font-weight:bold;" | price_1
| Цена 1 (для магазинов)
| string
| 329
|-
| style="font-weight:bold;" | price_2
| Цена 2 (для HoReCa)
| string
| 329
|-
| style="font-weight:bold;" | price_3
| Цена 3 (для рынков)
| string
| null
|-
| style="font-weight:bold;" | price_4
| Цена 4
| string
| null
|-
| style="font-weight:bold;" | price_5
| Цена 5
| string
| null
|-
| style="font-weight:bold;" | unique_code
| Уникальный код предложения
| string
| 141209
|-
| style="font-weight:bold;" | product_id
| Идентификатор продукта (идентификатор товарной карточки в системе SmartSatu)
| string
| 28952
|-
| style="font-weight:bold;" | step
| Квант поставки (quantum)
| string
| null
|-
| style="font-weight:bold;" | minQuantity
| Минимальное количество товара для заказа
| string
| null
|}
Пример ответа:

[
{
"id": 4317231,
"name": "425МЛ ЗЕЛЕНЫЙ ГОРОШЕК GREEN GA",
"sku": 870007151458,
"unit": "шт",
"manufacturer": "",
"quantity": 1,
"expires_at": null,
"price_1": 329,
"price_2": 329,
"price_3": null,
"price_4": null,
"price_5": null,
"unique_code": "141209",
"product_id": null,
"step": null,
"minQuantity": null,
}
]

===Удаление предложений===
DELETE /offers/{sku}
====Delete Offer====
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | status
| Код
| integer
| 204
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение удалено
|}
Пример ответа:
{
"status": 204,
"message": "Предложение удалено."
}

===401===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Unauthorized
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Your request was made with invalid credentials
|-
| style="font-weight:bold;" | code
| Код
| integer
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer
| 401
|-
| style="font-weight:bold;" | type
| Тип
| string
| "yii\\web\\UnauthorizedHttpException"
|}
Пример ответа:
{
"name": "Unauthorized",
"message": "Your request was made with invalid credentials.",
"code": 0,
"status": 401,
"type": "yii\\web\\UnauthorizedHttpException"
}

===403===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Forbidden
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| You're not allowed to delete this item
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 403
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:
{
"name": "Forbidden",
"message": "You're not allowed to delete this item.",
"code": 0,
"status": 403,
"type": "yii\\\\web\\\\HttpException"
}
===404===
{| class="wikitable"
! style="font-weight:bold;" | Name
! style="font-weight:bold;" | Description
! style="font-weight:bold;" | Schema
! style="font-weight:bold;" | Example
|-
| style="font-weight:bold;" | name
| Название
| string
| Not Found
|-
| style="font-weight:bold;" | message
| Сообщение
| string
| Предложение не существует, удалено либо недоступно
|-
| style="font-weight:bold;" | code
| Код
| integer($int32)
| 0
|-
| style="font-weight:bold;" | status
| Статус
| integer($int32)
| 404
|-
| style="font-weight:bold;" | type
| Тип
| string
| yii\\web\\HttpException
|}
Пример ответа:

{
"name": "Not Found",
"message": "Предложение не существует, удалено либо недоступно",
"code": 0,
"status": 404,
"type": "yii\\web\\HttpException"
}