Публичный API-прокси

Base URL

https://b2b.agropromshina.ru/api/modules

Tags

Методы

isAlive_API

Назначение

Проверяет доступность API и валидность API_key.

Operation

Request body

Example

{
  "action": "isAlive_API",
  "API_key": "<API_KEY>"
}

cURL

curl --request POST \
  --url https://b2b.agropromshina.ru/api/modules \
  --data '{"action":"isAlive_API","API_key":"<API_KEY>"}'

Responses

200 OK

{
  "status": "OK",
  "result": "OK"
}

Error

{
  "status": "error",
  "result": "<описание ошибки>"
}

Пример:

{
  "status": "error",
  "result": "Неверный API_key"
}

getStocks_API

Назначение

Возвращает актуальные остатки товаров по доступным складам. Поддерживает фильтрацию по бренду.

Operation

Request body

Example

{
  "action": "getStocks_API",
  "API_key": "<API_KEY>",
  "brand": "undefined"
}

cURL

curl --request POST \
  --url https://b2b.agropromshina.ru/api/modules \
  --data '{"action":"getStocks_API","API_key":"<API_KEY>","brand":"undefined"}'

Filtering

Фильтр по одному бренду:

{
  "action": "getStocks_API",
  "API_key": "<API_KEY>",
  "brand": "Petlas"
}

Фильтр по нескольким брендам:

{
  "action": "getStocks_API",
  "API_key": "<API_KEY>",
  "brand": "Petlas,MONROC"
}

Если фильтр не нужен, может быть передано значение:

{
  "brand": "undefined"
}

Responses

200 OK

{
  "status": "OK",
  "result": [
    {
      "product_id": "00-00000001",
      "code": "00-00000001",
      "artikul": "7072",
      "name": "16,0/70-20 (400/70-20) cat.no 7072 16PR IND25 TL 156/A8 Petlas",
      "brand": "Petlas",
      "price": "",
      "price_base": "48625",
      "discount": "20",
      "stocks": [
        {
          "stock_id": 234,
          "stock_code": 234,
          "stock_name": "Воронеж - Доровских Э.Н. ИП (Автошина)",
          "stock_city": "Воронеж",
          "read_only": false,
          "quantity": "7"
        },
        {
          "stock_id": 242,
          "stock_code": 242,
          "stock_name": "Волгоград - АЦСТ",
          "stock_city": "Волгоград",
          "read_only": false,
          "quantity": "8"
        }
      ]
    }
  ]
}

Response schema

Product

Stock

Error

{
  "status": "error",
  "result": "<описание ошибки>"
}

Пример:

{
  "status": "error",
  "result": "Неверный API_key"
}

getProductStocks_API

Назначение

Возвращает остатки по конкретным товарам, артикулам или брендам. Фильтры передаются в product_id, artikul, brand.

Operation

Request body

Example

{
  "action": "getProductStocks_API",
  "API_key": "<API_KEY>",
  "product_id": "undefined",
  "artikul": "undefined",
  "brand": "undefined"
}

cURL

curl --request POST \
  --url https://b2b.agropromshina.ru/api/modules \
  --data '{"action":"getProductStocks_API","API_key":"<API_KEY>","product_id":"undefined","artikul":"undefined","brand":"undefined"}'

Filtering

Получение остатков по конкретному товару:

{
  "action": "getProductStocks_API",
  "API_key": "<API_KEY>",
  "product_id": "00-00000001",
  "artikul": "undefined",
  "brand": "undefined"
}

Получение остатков по нескольким товарам:

{
  "action": "getProductStocks_API",
  "API_key": "<API_KEY>",
  "product_id": "00-00000001,00-00000003",
  "artikul": "undefined",
  "brand": "undefined"
}

Получение остатков по артикулу:

{
  "action": "getProductStocks_API",
  "API_key": "<API_KEY>",
  "product_id": "undefined",
  "artikul": "7072",
  "brand": "undefined"
}

Получение остатков по бренду:

{
  "action": "getProductStocks_API",
  "API_key": "<API_KEY>",
  "product_id": "undefined",
  "artikul": "undefined",
  "brand": "Petlas"
}

Responses

200 OK

{
  "status": "OK",
  "result": [
    {
      "product_id": "00-00000001",
      "code": "00-00000001",
      "artikul": "7072",
      "name": "16,0/70-20 (400/70-20) cat.no 7072 16PR IND25 TL 156/A8 Petlas",
      "brand": "Petlas",
      "price": "",
      "price_base": "48625",
      "discount": "20",
      "stocks": [
        {
          "stock_id": 234,
          "stock_code": 234,
          "stock_name": "Воронеж - Доровских Э.Н. ИП (Автошина)",
          "stock_city": "Воронеж",
          "read_only": false,
          "quantity": "7"
        },
        {
          "stock_id": 242,
          "stock_code": 242,
          "stock_name": "Волгоград - АЦСТ",
          "stock_city": "Волгоград",
          "read_only": false,
          "quantity": "8"
        }
      ]
    }
  ]
}

Response schema

Product

Stock

Error

{
  "status": "error",
  "result": "<описание ошибки>"
}

Пример:

{
  "status": "error",
  "result": "Неверный API_key"
}

getProducts_API

Назначение

Возвращает список актуальной номенклатуры для портала с основными реквизитами, файлами номенклатуры, дополнительными характеристиками и остатками по доступным пользователю складам.

Метод возвращает только товары из актуальной номенклатуры портала.

Operation

Request body

Example

{
  "action": "getProducts_API",
  "API_key": "<API_KEY>"
}

cURL

curl --request POST \
  --url https://b2b.agropromshina.ru/api/modules \
  --data '{"action":"getProducts_API","API_key":"<API_KEY>"}'

Responses

200 OK

{
  "status": "OK",
  "result": [
    {
      "product_id": "00-00000001",
      "code": "00-00000001",
      "artikul": "7072",
      "name": "16,0/70-20 (400/70-20) cat.no 7072 16PR IND25 TL 156/A8 Petlas",
      "full_name": "Шина 16,0/70-20 (400/70-20) cat.no 7072 16PR IND25 TL 156/A8 Petlas",
      "brand": "Petlas",
      "size": "16,0/70-20 (405/70-20)",
      "picture": "",
      "category": "Индустриальные",
      "full_category": "1 Шины/PETLAS/Индустриальные/",
      "files": [
        {
          "guid": "34a330fc-9f27-11e5-9f47-00155d228319",
          "extension": "png",
          "s3_url": "",
          "display_order": 0
        }
      ],
      "additional_attributes": [
        {
          "property_name": "Проект",
          "value": "ПРОМ"
        },
        {
          "property_name": "Уровень бренда",
          "value": "Medium"
        },
        {
          "property_name": "Внешний диаметр, мм (шины)",
          "value": "1 075"
        }
      ],
      "warehouses": [
        {
          "name": "Батайск - ШинВалом ТД",
          "quantity": 0
        },
        {
          "name": "Воронеж - Доровских Э.Н. ИП (Автошина)",
          "quantity": 7
        },
        {
          "name": "Волгоград - АЦСТ",
          "quantity": 8
        }
      ]
    }
  ]
}

Response schema

Product

Product file

Additional attribute

Поле additional_attributes содержит массив дополнительных характеристик товара. Значение value возвращается строкой.

Примеры дополнительных реквизитов:

[
  {
    "property_name": "Проект",
    "value": "ПРОМ"
  },
  {
    "property_name": "Сайт производителя (Шины)",
    "value": "http://www.petlas.com/ru/tire/ind-25/IND36/"
  }
]

Warehouse

Поле warehouses содержит массив складов, доступных пользователю API, с остатками товара.

Warehouse display rules

В массив warehouses попадают склады, доступные пользователю API. Для каждого склада возвращается наименование склада и количество товара. Остаток возвращается в поле quantity.

Error

{
  "status": "error",
  "result": "<описание ошибки>"
}

Пример:

{
  "status": "error",
  "result": "Неверный API_key"
}

addProductToOrder_API

Назначение

Добавляет товар в заказ клиента. Может создать новый заказ или добавить позицию в открытый заказ.

Operation

Request body

Example

{
  "action": "addProductToOrder_API",
  "API_key": "<API_KEY>",
  "product_id": "УТ-00004852",
  "artikul": "3001050001",
  "brand": "undefined",
  "stock_id": "292",
  "quantity": "2",
  "comment": "Комментарий",
  "payment_method": "",
  "shipment_method": "",
  "shipment_address": "",
  "shipment_comment": "",
  "into_new_order": ""
}

cURL

curl --request POST \
  --url https://b2b.agropromshina.ru/api/modules \
  --data '{"action":"addProductToOrder_API","API_key":"<API_KEY>","product_id":"УТ-00004852","artikul":"3001050001","brand":"undefined","stock_id":"292","quantity":"2","comment":"Комментарий","payment_method":"","shipment_method":"","shipment_address":"","shipment_comment":"","into_new_order":""}'

Product lookup rules

Если передан product_id, метод ищет номенклатуру по коду:

product_id -> Справочник.Номенклатура.НайтиПоКоду()

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

Если вместе с artikul передан brand, метод дополнительно ограничивает поиск по производителю/бренду:

Номенклатура.Производитель.Наименование ПОДОБНО brand

Order creation rules

Метод может как добавить товар в существующий заказ, так и создать новый заказ.

Если into_new_order не передан или имеет пустое значение, метод пытается найти открытый заказ текущего дня с признаками:

• заказ проведен;
• не помечен на удаление;
• создан за текущий день;
• относится к партнеру и контрагенту пользователя;
• относится к нужной организации, соглашению и договору;
• имеет статус К обеспечению;
• содержит признак B2B в комментарии.

Если подходящий заказ не найден, создается новый заказ.

Если into_new_order передан как 1, true или истина, новый заказ создается принудительно.

Delivery rules

Responses

200 OK

{
  "status": "OK",
  "result": [
    {
      "order_status": "OK",
      "result": "in stock",
      "order_number": "0000-000001",
      "stock_id": "292",
      "stock_name": "Наименование склада",
      "product_name": "Наименование товара",
      "product_id": "УТ-00004852",
      "artikul": "3001050001",
      "quantity": "2"
    }
  ]
}

Response schema

Add result

Error

{
  "status": "error",
  "result": "<описание ошибки>"
}

Примеры:

{
  "status": "error",
  "result": "incorrect product_id or artikul"
}

{
  "status": "error",
  "result": "no real actions with orders allowed"
}