API Росско

API (от англ. application programming interface) или Интерфейс программирования приложений — это набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением, библиотекой или сервисом для использования во внешних программных продуктах. API используется для подключения разных программных приложений друг к другу.

API ROSSKO предоставляет две основные функции:


1. Поиск и подбор товаров по кроссам

Ваш интернет-магазин или торговая программа могут в реальном времени обращаться к нашему сервису и получать актуальную информацию об остатках и стоимости для определенных товарных групп. Если же искомого товара нет в наличии, то ваш интернет-магазин может запросить у нашего сервиса кроссы к нему.

2. Оформление и актуализация данных о заказе

Ваш интернет-магазин или другое программное обеспечение могут по созданным вами настройкам самостоятельно оформлять в нашем интернет-магазине заказы. После того как заказы оформлены, вы можете через свой программный продукт автоматизировано отслеживать их статус.

Преимущества использования API:

  • Нет необходимости ежедневно скачивать обновленный прайс-лист ROSSKO,
  • 100% достоверность информации об остатках и ценах,
  • Нет необходимости вручную вводить номера товаров в поисковую строку интернет-магазина ROSSKO,
  • Нет необходимости вручную оформлять и отслеживать актуальный статус заказа.

Для подключения к API вы должны являться клиентом Росско и быть зарегистрированы на портале. Получить ключи можно в своем личном кабинете.

Если у вас все еще есть вопросы по работе API, покажите этот текст своему программисту или обратитесь в службу поддержки ROSSKO.

1. Сервис «GetSearch»

http://ntagil.rossko.ru/service/v1/GetSearch?wsdl

Сервис, позволяющий искать товары по названию (можно использовать одно или несколько слов, разделенных пробелами), номеру или GUID товара.

Входные параметры:
Имя Тип Обязательный Описание Примечание
KEY1 Строка Да Первый секретный ключ
KEY2 Строка Да Второй секретный ключ
TEXT Строка Да Значение для поиска (название, номер, GUID) товара Пример значений: масло, свечи зажигания, 333114, NSIN0019620397

Выходные параметры (элемент SearchResult):
Имя Тип Описание Примечание
Success Булевое значение Результат запроса true/false
Text Строка Значение для поиска (название, номер, GUID) товара Пример значений: масло, свечи зажигания, 333114, NSIN0019620397
Message Строка Сообщение об ошибке. Выводится, когда возникает ошибка. Пример значения:
Вы не ввели логин и/или пароль!
PartsList Список объектов (элемент Part) Список найденных товаров

Элемент Part:
Имя Тип Описание
GUID Строка Уникальный идентификатор товара
Brand Строка Наименование производителя товара
PartNumber Строка Код товара (присвоенный производителем)
Name Строка Наименование товара
StocksList Список объектов (элемент Stock) Список складов, если товар есть на складе
CrossesList Список объектов (элемент Part) Список кроссов

Элемент Stock:
Имя Тип Описание
StockID Строка Уникальный идентификатор склада
Price Число Цена товара
Count Число Остаток товара на складе
DeliveryTime Число Время доставки со склада в днях

Принцип работы:

  • Находим товары для заданного значения поиска. В случае, если товар не найден или произошла какая-то ошибка, элемент «Success» будет «false», если найдено, то «Success» будет «true»;
  • Если товар не найден, то элемент PartsList отсутствует;
  • Для найденного товара выводим информацию по нему в секции PartsList → Part;
  • Для найденного товара остатки на складах будут отажены в секции StocksList → Stock;
  • Для найденного товара выводим информацию о кроссах в секции CrossesList → Part;

2. Сервис «GetCheckoutDetails»

http://ntagil.rossko.ru/service/v1/GetCheckoutDetails?wsdl

Позволяет показать способы доставки и оплаты, адреса доставки, реквизитов при оформлении заказа.

Входные параметры:
Имя Тип Обязательный Описание Примечание
KEY1 Строка Да Первый секретный ключ
KEY2 Строка Да Второй секретный ключ

Выходные параметры (элемент SearchResult):
Имя Тип Описание Примечание
Success Булевое значение Результат запроса true/false
Message Строка Сообщение об ошибке Выводится, когда возникает ошибка. Пример значения:
Вы не ввели логин и/или пароль!
TypeDelivery Список объектов (элемент Delivery) Способ доставки
TypePayment Список объектов (элемент Payment) Способ оплаты
AddressDelivery Список объектов (элемент Address) Адрес доставки
CompanyList Список объектов (элемент Company) Реквизит

Элемент Delivery:
Имя Тип Описание
ID Число Уникальный идентификатор способа доставки
Name Строка Наименование способа доставки
WarehouseList Список объектов (элемент Warehouse) Склады

Элемент Warehouse:
Имя Тип Описание
ID Число Уникальный идентификатор склада
Name Строка Наименование склада

Элемент Payment:
Имя Тип Описание
ID Число Уникальный идентификатор способа оплаты
Name Строка Наименование способа оплаты

Элемент Address:
Имя Тип Описание
City Строка Город
Street Строка Улица
Dom Строка Дом
Office Строка Офис
Name Строка Наименование склада

Элемент Company:
Имя Тип Описание
Name Строка Наименование организации
Requisites Строка Реквизиты организации

3. Сервис «GetCheckout»

http://ntagil.rossko.ru/service/v1/GetCheckout?wsdl

Оформление заказа.

Входные параметры:
Имя Тип Обязательный Описание Примечание
KEY1 Строка Да Первый секретный ключ
KEY2 Строка Да Второй секретный ключ
COMMENT Строка Нет Комментарий
TYPE_DELIVERY Список объектов (элемент Delivery) Да Способ доставки
TYPE_PAYMENT Список объектов (элемент Payment) Да Способ оплаты
CONTACT_DETAILS Список объектов (элемент Contact) Да Контактные данные
DELIVERY_PARTS Булевое значение Да Доставка по частям true/false
PARTS Список объектов (элемент Part) Да Список товаров

Элемент Delivery:
Имя Тип Обязательный Описание Примечание
DeliveryID Число Да Уникальный идентификатор способа доставки
DeliveryAddress Список объекта (элемент Address) Нет Адрес доставки

Элемент Address:
Имя Тип Обязательный Описание Примечание
City Строка Да Город
Street Строка Да Улица
Dom Строка Нет Дом
Office Строка Нет Офис

Элемент Payment:
Имя Тип Обязательный Описание Примечание
PaymentID Число Да Уникальный идентификатор способа оплаты
CompanyName Строка Нет Наименование организации
CompanyRekvizity Строка Нет Реквизиты организации

Элемент Contact:
Имя Тип Обязательный Описание Примечание
Name Строка Да Контактное лицо
Phone Строка Да Телефон
Office Строка Нет Офис

Элемент Part:
Имя Тип Обязательный Описание Примечание
PART_NUMBER Число Да Код товара (присвоенный производителем)
BRAND Строка Да Наименование производителя товара
COUNT Строка Да Нужное количество товара

Выходные параметры (элемент SearchResult):
Имя Тип Описание Примечание
Success Булевое значение Результат запроса true/false
Message Строка Сообщение об ошибке Выводится, когда возникает ошибка. Пример значения:
Вы не ввели логин и/или пароль!
OrderID Число Уникальный идентификатор заказа
ItemsList Список объектов (элемент Item) Список заказанных товаров
ItemsErrorList Список объектов (элемент ItemError) Список не l;заказанных товаров

Элемент Item:
Имя Тип Описание Примечание
PART_NUMBER Строка Код товара (присвоенный производителем) Если на складе нет нужного количества товара, то будет заказ остаток.
BRAND Строка Наименование производителя товара
COUNT Число Количество товара
DELIVERY_TIME Число Время доставки со склада в днях.

Элемент ItemError:
Имя Тип Описание
PART_NUMBER Строка Код товара (присвоенный производителем)
BRAND Строка Наименование производителя товара
COUNT Число Количество товара
MESSAGE Строка Сообщение по какой причине этот товар не был заказан.

4. Сервис «GetOrders»

http://ntagil.rossko.ru/service/v1/GetOrders?wsdl

Список заказов и статус по ним.

Входные параметры:
Имя Тип Обязательный Описание Примечание
KEY1 Строка Да Первый секретный ключ
KEY2 Строка Да Второй секретный ключ
ORDER_IDS Список объектов (элемент OrderId) Нет Список идентификаторов заказов
OFFSET Число Нет Смещение

Выходные параметры (элемент SearchResult):
Имя Тип Описание Примечание
Success Булевое значение Результат запроса true/false
Message Строка Сообщение об ошибке. Выводится, когда возникает ошибка. Пример значения:
Вы не ввели логин и/или пароль!
OrdersList Список объектов (элемент Order) Список заказов
Total Число Количество всего заказов

Элемент Order:
Имя Тип Описание
ID Число Уникальный идентификатор заказа
DateCreated Строка Дата заказа
DateDelivery Строка Дата доставки
Details Список объектов (элемент Detail) Детали заказа (способ оплаты и доставки, адрес доставки, реквизиты, комментарий)
Sum Строка Сумма заказа
StatusPayment Строка Статус заказа
Parts Список объектов (элемент Part) Список товаров в заказе

Элемент Detail:
Имя Тип Описание
TypeDelivery Строка Способ доставки
DeliveryAddress Строка Адрес доставки
TypePayment Строка Тип оплаты
CompanyName Строка Наименование организации
CompanyRekvizity Строка Реквизиты организации
Comment Строка Комментарий

Элемент Part:
Имя Тип Описание
GUID Строка Уникальный идентификатор товара
PartNumber Строка Код товара (присвоенный производителем)
Name Строка Наименование товара
Brand Строка Наименование производителя товара
Price Строка Цена
Count Число Количество
DeliveryTime Число Время доставки со склада в днях
Processing1C Список объектов (элемент DetailProcessing) Статус товара

Элемент DetailProcessing:
Имя Тип Описание
Confirmed Строка Подтвеждено товаров
DeliveryTime Строка Время доставки со склада в днях
Supplied Строка Отгружено
Collected Строка Отменено
Shipped Строка Отправлено
Sum Строка Сумма