API Росско

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

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


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

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

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

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

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

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

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

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

1. Сервис «GetSearch»

http://artem.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://artem.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://artem.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://artem.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СтрокаСумма