Адрес
Адрес сервера API: http://1c.rassvet.ooo/og_merchant
Шаблон URI методов: /hs/OpenExchangeAPI/V1/<Имя метода>
Полный адрес запроса: http://1c.rassvet.ooo/og_merchant/hs/OpenExchangeAPI/V1/<Имя метода>
Логин:
Пароль:
Формат запроса и ответа: application/json
Использование параметров
Все параметры необязательны
Шаблон использования параметров
<Имя метода>?<Имя параметра1> = <Значение параметра1>&<Имя параметра2> = <Значение параметра2>
Формат даты
Формат даты: "гггг-мм-чч", слитно, либо с разделителями: ".", ",", "-", ":"
Примеры использования параметров
/OpenExchangeAPI/V1/GetCustomersTable?datefrom=20190206 (записи, начиная с 2019-02-06 00:00:00) /OpenExchangeAPI/V1/GetCustomersTable?dateto=20190220 (записи до 2019-02-20 23:59:59) /OpenExchangeAPI/V1/GetCustomersTable?datefrom=2019-02:06&dateto=2019.02,20 (записи с 2019-02-06 00:00:00 по 2019-02-20 23:59:59) /OpenExchangeAPI/V1/GetCustomersTable?datefrom=2019-02-06&dateto=20190220:15:20:22 (записи с 2019-02-06 00:00:00 по 2019-02-20 15:20:22)
Описание методов
Получение таблицы клиентов
GET /OpenExchangeAPI/V1/GetCustomersTable
Запрос:
{
"datefrom": Текст, если время не указано - устанавливается 00:00:00
"dateto ": Текст, если время не указано - устанавливается 23:59:59
}
Ответ:
{
CustomerId – текст
CustomerName - текст
}
Получение таблицы проектов
GET /OpenExchangeAPI/V1/GetProjectsTable
Ответ:
{
ProjectId - Целое или текст
ProjectName - Текст
ProjectType - Текст
CustomerId - Целое или текст
}
Получение таблицы торговых сетей
GET /OpenExchangeAPI/V1/GetChainsTable
Ответ:
{
ChainId - Текст
ChainName - Текст
ChainType - Текст
ChainScope - Текст
}
Получение таблицы торговых точек
GET /OpenExchangeAPI/V1/GetSalesPointsTable
Запрос:
{
"datefrom": Текст,
"dateto ": Текст
}
Ответ:
{
SalesPointId - Текст
SalesPointName - Текст
ChainId - Текст, UID записи торговой сети
ChainName - Текст, Наименование торговой сети
Address - Текст
Country - Текст
Region - Текст
Distrinct - Текст
City - Текст
IntracityDistrict - Текст
Settlement - Текст
Territory - Текст
Street - Текст
House - Текст
Block - Текст
Longitude - Число, 12,10
Latitude - Число, 12,10
}
Получение таблицы каналов продаж клиентов
GET /OpenExchangeAPI/V1/GetCustomerChannelsTable
Ответ:
{
CustomerChannelId - Текст
CustomerChannelName - Текст
ProjectId - Текст
}
Получение таблицы форматов торговых точек клиентов
GET /OpenExchangeAPI/V1/GetCustomerFormatsTable
Ответ:
{
CustomerFormatId - Текст
CustomerFormatName - Текст
ProjectId - Текст
}
Получение таблицы торговых точек клиентов
GET /OpenExchangeAPI/V1/GetCustomerSalesPointsTable
Получение таблицы категорий товаров
GET /OpenExchangeAPI/V1/GetProductCategoriesTable
Ответ:
{
CategoryId - Текст
SegmentCode - Текст
Segment - Текст
FamilyCode - Текст
Family - Текст
ClassCode - Текст
Class - Текст
BrickCode - Текст
Brick - Текст
}
Получение таблицы товаров
GET /OpenExchangeAPI/V1/GetProductsTable
Ответ:
{
ProductId - Текст
ProductCode - Текст
ProductName - Текст
Manufacturer - Текст
Brand - Текст
PriceSegment - Текст
ProductCategoryId - Текст
}
Получение таблицы базы знаний по торговым точкам
GET /OpenExchangeAPI/V1/GetKBSalesPointsTable
Запрос:
{
"datefrom": Текст
"dateto ": Текст
}
Ответ:
{
SalesPointId - Текст
SalesPointIdentityCode - Текст, Наименование торговой точки клиента
}
Получение таблицы базы знаний по продуктам
GET /OpenExchangeAPI/V1/GetKBProductsTable
Ответ:
{
ProductId - Текст
ProductIdentityCode - Текст, Наименование SKU
}
Связанные статьи