API (от англ. application programming interface) или Интерфейс программирования приложений — это набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением, библиотекой или сервисом для использования во внешних программных продуктах. API используется для подключения разных программных приложений друг к другу.
API Parterra предоставляет две основные функции:
1. Поиск и подбор товаров по кроссам
Ваш интернет-магазин или торговая программа могут в реальном времени обращаться к нашему сервису и получать актуальную информацию об остатках и стоимости для определенных товарных групп. Если же искомого товара нет в наличии, то ваш интернет-магазин может запросить у нашего сервиса кроссы к нему.
2. Оформление и актуализация данных о заказе
Ваш интернет-магазин или другое программное обеспечение могут по созданным вами настройкам самостоятельно оформлять в нашем интернет-магазине заказы. После того как заказы оформлены, вы можете через свой программный продукт автоматизировано отслеживать их статус.
Преимущества использования API:
- 100% достоверность информации об остатках и ценах,
- Нет необходимости вручную вводить номера товаров в поисковую строку интернет-магазина Parterra,
- Нет необходимости вручную оформлять и отслеживать актуальный статус заказа.
Для подключения к API вы должны являться клиентом Parterra и быть зарегистрированы на портале. Если вы являетесь клиентом Parterra, то обратитесь к менеджеру с заявкой на получение ключей API.
Если у вас все еще есть вопросы по работе API, покажите этот текст своему программисту или обратитесь в службу поддержки Parterra.
1. Сервис GetPartWeb9Combo
http://parterra.ru/service/v1/GetPartWeb9Combo?wsdl
Сервис, позволяющий искать товары по названию (можно использовать одно или несколько слов, разделенных пробелами), номеру или GUID товара.
| Имя | Тип | Обязательный | Описание | Примечание |
|---|---|---|---|---|
| username | Строка | Да | Первый секретный ключ | |
| password | Строка | Да | Второй секретный ключ | |
| SEARCH_TEXT | Строка | Да | Значение для поиска (название, номер, GUID) товара | Пример значений: масло, свечи зажигания, 333114, NSIN0019620397 |
| limit | Число | Нет | Лимит поиска | |
| offset | Число | Нет | Сдвиг поиска |
| Имя | Тип | Описание | Примечание |
|---|---|---|---|
| Success | Булевое значение | Результат запроса | true/false |
| ErrorDescription | Строка | Сообщение об ошибке. | Выводится, когда возникает ошибка. Пример значения: Вы не ввели логин и/или пароль! |
| Result | Список объектов (элемент GetPartResults) | Список найденных товаров |
| Имя | Тип | Описание | Примечание |
|---|---|---|---|
| IsLimitOver | Булевое значение | Количество элементов больше чем показано | true/false |
| TotalResults | Число | Общее количество записей. | |
| PartsList | Список объектов (элемент Part) | Список найденных товаров |
| Имя | Тип | Описание |
|---|---|---|
| GUID | Строка | Уникальный идентификатор товара |
| BRAND_ID | Число | Уникальный идентификатор производителя товара |
| BRAND_NAME | Строка | Наименование производителя товара |
| OE | Строка | Код товара (присвоенный производителем) |
| TEXT | Строка | Наименование товара |
| BASE_UNIT | Строка | Единица измерения товара |
| GROSS_WEIGHT | Число | Вес товара |
| VOLUME | Число | Объем товара |
| StocksList | Список объектов (элемент Stock) | Список складов, если товар есть на складе |
| Имя | Тип | Описание |
|---|---|---|
| STOCK_ID | Строка | Уникальный идентификатор склада |
| BASE_PRICE | Число | Стоимость товара |
| INVENTORY | Число | Количество товара |
| SHIPMENT_MULTIPLICITY | Число | Кратность отгрузки товара |
| DELIVERY_TIME | Число | Срок доставки товара |
Принцип работы:
- Находим товары для заданного значения поиска. В случае, если товар не найден или произошла какая-то ошибка, элемент «Success» будет «false», если найдено, то «Success» будет «true»;
- Если товар не найден, то элемент PartsList отсутствует;
- Для найденного товара выводим информацию по нему в секции PartsList → Part;
- Для найденного товара остатки на складах будут отажены в секции StocksList → Stock;
2. Сервис GetPartInfo5
http://parterra.ru/service/v1/GetPartInfo5?wsdl
Сервис, позволяющий искать кроссы по GUID товара.
| Имя | Тип | Обязательный | Описание | Примечание |
|---|---|---|---|---|
| username | Строка | Да | Первый секретный ключ | |
| password | Строка | Да | Второй секретный ключ | |
| GUID | Строка | Да | GUID товара | Пример значения: NSIN0019620397 |
| Имя | Тип | Описание | Примечание |
|---|---|---|---|
| Success | Булевое значение | Результат запроса | true/false |
| ErrorDescription | Строка | Сообщение об ошибке. | Выводится, когда возникает ошибка. Пример значения: Вы не ввели логин и/или пароль! |
| Result | Список объектов (элемент GetPartInfoResult) | Список найденных товаров |
| Имя | Тип | Описание |
|---|---|---|
| Part | Список объектов (элемент Part) | Информация по товару |
| StocksList | Список объектов (элемент Stock) | Список складов, если товар есть на складе. |
| CrossesList | Список объектов (элемент Cross) | Список найденных кроссов товара |
| Имя | Тип | Описание |
|---|---|---|
| GUID | Строка | Уникальный идентификатор товара |
| BRAND_ID | Число | Уникальный идентификатор производителя товара |
| BRAND_NAME | Строка | Наименование производителя товара |
| OE | Строка | Код товара (присвоенный производителем) |
| TEXT | Строка | Наименование товара |
| BASE_UNIT | Строка | Единица измерения товара |
| GROSS_WEIGHT | Число | Вес товара |
| VOLUME | Число | Объем товара |
| Имя | Тип | Описание |
|---|---|---|
| STOCK_ID | Строка | Уникальный идентификатор склада |
| BASE_PRICE | Число | Стоимость товара |
| INVENTORY | Число | Количество товара |
| SHIPMENT_MULTIPLICITY | Число | Кратность отгрузки товара |
| DELIVERY_TIME | Число | Срок доставки товара |
| Имя | Тип | Описание |
|---|---|---|
| Part | Список объектов (элемент Part) | Информация по товару |
| StocksList | Список объектов (элемент Stock) | Список складов, если товар есть на складе. |
3. Сервис «GetCheckout»
http://parterra.ru/service/v1/GetCheckout?wsdl
Оформление заказа.
| Имя | Тип | Обязательный | Описание | Примечание |
|---|---|---|---|---|
| username | Строка | Да | Первый секретный ключ | |
| password | Строка | Да | Второй секретный ключ | |
| comments | Строка | Нет | Комментарий к заказу | |
| items | Список объектов (элемент item) | Да | Список товаров в заказе |
| Имя | Тип | Обязательный | Описание | Примечание |
|---|---|---|---|---|
| GUID | Строка | Да | Уникальный идентификатор товара | |
| COUNT | Число | Да | Количество единиц товара | Количество должно быть кратно кратности товара |
| STOCK_ID | Строка | Да | Уникальный идентификатор склада |
| Имя | Тип | Описание | Примечание |
|---|---|---|---|
| Success | Булевое значение | Результат запроса | true/false |
| ErrorDescription | Строка | Сообщение об ошибке. | Выводится, когда возникает ошибка. Пример значения: Вы не ввели логин и/или пароль! |
| Result | Список объектов (элемент result_order) | Резульат заказа |
| Имя | Тип | Описание |
|---|---|---|
| order_id | Число | Номер заказа |
| delivery_time | Число | Срок доставки, в днях |
| delivery_sum | Число | Сумма доставки, руб. |
| sum | Число | Сумма заказа, руб. |
| items | Список объектов (элемент array_of_result_item) | Список товаров в заказе |
| Имя | Тип | Описание |
|---|---|---|
| GUID | Строка | Уникальный идентификатор товара |
| COUNT | Число | Количество единиц товара |
| STOCK_ID | Строка | Уникальный идентификатор склада |
| BASE_PRICE | Число | Стоимость товара |
4. Сервис GetOrderStatus
http://parterra.ru/service/v1/GetOrderStatus?wsdl
Статусы заказа.
| Имя | Тип | Обязательный | Описание | Примечание |
|---|---|---|---|---|
| username | Строка | Да | Первый секретный ключ | |
| password | Строка | Да | Второй секретный ключ | |
| order_id | Число | Да | Номер заказа |
| Имя | Тип | Описание | Примечание |
|---|---|---|---|
| Success | Булевое значение | Результат запроса | true/false |
| ErrorDescription | Строка | Сообщение об ошибке. | Выводится, когда возникает ошибка. Пример значения: Вы не ввели логин и/или пароль! |
| Result | Список объектов (элемент result_order) | Информация по заказу |
| Имя | Тип | Описание |
|---|---|---|
| order_id | Число | Номер заказа |
| create_date | Строка | Дата создания заказа |
| update_date | Строка | Дата обновления заказа |
| delivery_time | Число | Срок доставки, в днях |
| delivery_sum | Число | Сумма доставки, руб. |
| sum | Число | Сумма заказа, руб. |
| order_status | Строка | Статус заказа |
| items | Список объектов (элемент array_of_result_item) | Список товаров в заказе |
| Имя | Тип | Описание |
|---|---|---|
| GUID | Строка | Уникальный идентификатор товара |
| COUNT | Число | Количество единиц товара |
| STOCK_ID | Строка | Уникальный идентификатор склада |
| BASE_PRICE | Число | Стоимость товара |