[GET] Получение списка продуктов

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

• Endpoints URL:
  • Боевая среда: https://api.ecommerce.softline.com/v1/product
  • Тестовая среда: https://api.ecommerce.softline.com.demoslweb.com/v1/product
• Метод: GET
• Формат: JSON
• Авторизация: с помощью токена

• /v1/product
  Все доступные продукты. Список отсортирован по убыванию id продуктов
• /v1/product?search_string=test
  Все доступные продукты, у которых строка "test" присутствует хотя бы в одном из полей, перечисленных в описании параметра search_string. Список отсортирован по убыванию id продуктов
• /v1/product?exclude_renew_ar_products=1
  Все доступные продукты, за исключением дочерних продуктов для продления AR подписки. Список отсортирован по убыванию id продуктов
• /v1/product?sale_currency[]=USD&sale_currency[]=EUR
  Все доступные продукты, у которых разрешена продажа хотя бы в одной из валют: USD, EUR
• /v1/product?limit=10
  Первые 10 найденных продуктов. Список отсортирован по id продуктов
• /v1/product?limit=10&offset=5
  10 продуктов, начиная с 6 по 15. Список отсортирован по id продуктов
• /v1/product?offset=5
  Все продукты, начиная с 6 из найденных. Список отсортирован по id продуктов
• /v1/product?sort_by_update_date=desc
  Все доступные продукты. Список отсортирован по убыванию даты обновления продуктов (update_date)

• Для продукта 001 выключена подписка с автоматическим продлением (AR):

  "renew_settings": {
   "renew_ar": {
    "enable": false
   },
   "renew_pmr": false,
   "renew_email": false
  }
  

• В ответ на запрос /v1/product?exclude_renew_ar_products=1 вернется продукт 001

• Для продукта 002 включена подписка с автоматическим продлением (AR). Продукт 002 используется для создания подписки и ее продления (то есть одновременно является родительским и дочерним для себя):

  "renew_settings": {
   "product_id_for_renew": [002],
   "renew_ar": {
    "enable": true
   }
  }
  

• В ответ на запрос /v1/product?exclude_renew_ar_products=1 вернется продукт 002, так как применяется исключение - продукт продлевается сам на себя

• Для продукта 003 включена подписка с автоматическим продлением (AR). Продукт 003 является родительским, то есть инициирует создание подписки. Для продления подписки используется продукт 004

  "renew_settings": "renew_settings": {
   "product_id_for_renew": [004,004],
   "renew_ar": {
    "enable": true
   }
  }
  

• В ответ на запрос /v1/product?exclude_renew_ar_products=1 вернется продукт 003. Продукт 004 отсутствует в ответе, так как является дочерним

• Для продукта 006 выключена подписка с автоматическим продлением (AR), но включена PMR подписка. Продукт 006 является родительским, то есть инициирует создание подписки. Для продления подписки используется продукт 007

  "renew_settings": {
   "product_id_for_renew": [007, 007],
   "renew_ar": {
    "enable": false
   },
   "renew_pmr": true
  }
  

• В ответ на запрос /v1/product?exclude_renew_ar_products=1 вернутся продукты 006 и 007, так как подписки AR выключены и исключение дочерних продуктов не применяется

Предположим у вас есть продукты:

• Продукт 001 – имеет индивидуальные цены в валютах продажи: AUD, CAD
• Продукт 002 – имеет одну цену в базовой валюте продажи: EUR, таким образом этот продукт доступен для продажи во всех валютах в соответствии с вашим договором

Валюты, доступные по договору: USD, EUR, AUD, CAD, GBP, NZD

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

При успешной обработке запроса вы получите код ответа сервера HTTP/1.1 200 OK. В теле ответа будет передан список найденных продуктов в формате JSON.

В случае ошибки при обработке запроса вы получите код ответа сервера, соответствующий результату обработки.
В зависимости от кода в теле ответа могут присутствовать дополнительные параметры.

Справочник этих ошибок одинаковый для всех API, которые используют авторизацию по токену.