По всей базе знаний
Softline Checkout
Наверх
По всей базе знаний
Softline CheckoutИнтеграцияProducts API
[GET] Получение продукта

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

Описание запроса

GET /v1/product/[product id]

Запрос позволяет получить данные продукта.

Данные для отправки запроса

Параметры в URL запроса

[product id]
required
Идентификатор продукта.
Вы можете получить его в ответ на запросы: Пример передачи параметра в URL: /v1/product/123456

Параметры заголовка

AuthorizationJWT
required
Авторизационный токен.
  • Формат значения: Bearer [token]
  • Вместо [token] подставьте значение token, полученное в ответ на запрос к Authentication API.

Пример запроса

GET https://api.ecommerce.softline.com/v1/product/123456

Ответ на запрос

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

Положительный ответ

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

Параметры в теле ответа

id
number
required
Идентификатор продукта.
[...]
required
Данные продукта.
  • Список и формат параметров аналогичен запросу на создание продукта.
  • Если какой-либо параметр является не обязательным и не был заполнен в при создании/редактировании продукта, то он будет заполнен значением по по умолчанию.
  • При работе с тестовой средой: во всех параметрах, которые могут содержать URL на нашей стороне, URL в ответе будут предназначены для тестовой среды (будут иметь суффикс .demoslweb.com).
update_date
string
required
Дата последнего обновления продукта.
  • Формат даты: YYYY-MM-DD HH:MI:SS.
  • Часовой пояс даты соответствует часовому поясу сервера.

Пример положительного ответа (продукт с полностью заполненными свойствами)

{
  "id": 4653498,
  "update_date": "2023-10-26 09:54:40",
  "family_name": "Демо-продукт",
  "name": "Лицензия на 1 год",
  "is_publish": true,
  "image_url": "",
  "description": "<p><strong>Тестовый продукт</strong></p>",
  "comment_for_manager": "Комментарий для менеджера",
  "url_to_instructions": "https://www.google.com",
  "url_to_download": "https://www.google.com",
  "business_segment": "b2c",
  "licence_term": "P1Y",
  "device_quantity": 1,
  "fulfillment_id": null,
  "localization_values": {
    "en_EN": {
      "family_name": "Test product",
      "description": "<p><strong>Test product</strong> for test purchase</p>",
      "name": "1 PC/1 year",
      "comment_for_product_top": "The license is valid for 1 year.",
      "comment_for_product_middle": "New version of the test product.",
      "comment_for_product_for_AR": "The license is renewed automatically.",
      "comment_for_product_for_MR": "You will need to manually renew your license after 1 year.",
      "comment_for_product_bottom": "This license is not for sale or activation outside of the country.",
      "comment_for_cart": "This is a test purchase."
    }
  },
  "display_settings": {
    "hide_name": true,
    "hide_item_quantity": true
  },
  "renew_settings": {
    "product_id_for_renew": [
      4653352,
      4653352
    ],
    "renew_ar": {
      "enable": true,
      "required": false
    },
    "renew_pmr": true,
    "renew_email": false
  },
  "variants": [
    {
      "vendor_code": "1",
      "sku": "111",
      "sku_ar": "",
      "price": {
        "RUB": {
          "currency": "USD",
          "price": "99.99"
        }
      },
      "from": 1,
      "to": 5
    },
    {
      "vendor_code": "1",
      "sku": "111",
      "sku_ar": "",
      "price": {
        "RUB": {
          "currency": "USD",
          "price": "80.99"
        }
      },
      "from": 6
    }
  ],
  "typo": {
    "status": true,
    "date_from": "2020-10-15 14:18:40",
    "date_to": "2020-10-25 14:18:40",
    "localization_values": {
      "ru_RU": {
        "comment_for_typo": "Специальное предложение"
      },
      "en_EN": {
        "comment_for_typo": "Special offer"
      }
    },
    "product_id": [
      4653352
    ]
  },
  "cross_sell": {
    "type": "add_to_basket",
    "status": true,
    "date_from": "2020-10-15 14:18:00",
    "date_to": "2020-10-25 14:18:00",
    "removal_available": true,
    "quantity_change_available": false,
    "product_id": [
      4653352
    ]
  },
  "license_data": {
    "ru_RU": {
      "customer_notification": "Ключ активации: {KEY}"
    },
    "en_EN": {
      "customer_notification": "Key: {KEY}"
    }
  },
  "available_for_sale": "all",
  "is_service": true,
  "license_type": "new",
  "software_registry": {
    "status": true,
    "date": "2020-10-15",
    "url": "https://reestr.digital.gov.ru/reestr/111",
    "registration_number": 111
  }
}

Пример положительного ответа (продукт с минимально заполненными свойствами)

{
  "id": 4653499,
  "update_date": "2023-10-26 09:57:20",
  "family_name": "Демо-продукт",
  "name": "Базовая лицензия",
  "is_publish": true,
  "image_url": "",
  "description": "",
  "comment_for_manager": "",
  "url_to_instructions": "",
  "url_to_download": "",
  "business_segment": "",
  "licence_term": "",
  "device_quantity": null,
  "fulfillment_id": null,
  "localization_values": [],
  "display_settings": {
    "hide_name": false,
    "hide_item_quantity": false
  },
  "renew_settings": {
    "product_id_for_renew": [],
    "renew_ar": {
      "enable": false,
      "required": false
    },
    "renew_pmr": false,
    "renew_email": false
  },
  "variants": [
    {
      "vendor_code": "1",
      "sku": "111",
      "sku_ar": "",
      "price": {
        "RUB": {
          "currency": "USD",
          "price": "99.99"
        }
      }
    }
  ],
  "typo": [],
  "cross_sell": [],
  "license_data": [],
  "available_for_sale": "all",
  "is_service": true,
  "license_type": "new",
  "software_registry": []
}

Ответ об ошибке

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

Справочник HTTP-кодов ответа сервера при ошибке

Код ответа сервера Описание
HTTP/1.1 400 Bad Request Запрос не валиден (ошибка в параметрах; не переданы необходимые данные и т.п.).
В теле ответа будет передан дополнительный код ошибки (один или несколько).
HTTP/1.1 401 Unauthorized Неуспешная аутентификация.
В теле ответа будет передан дополнительный код ошибки (один или несколько). 
HTTP/1.1 404 Not found Неверный URL запроса или продукт не найден. Проверьте адрес запроса. В теле ответа может быть передан дополнительный код ошибки (один или несколько). 
HTTP/1.1 500 Request Error Ошибка на стороне сервера. Повторите запрос позднее или обратитесь в службу поддержки.

Справочник дополнительных кодов ошибок для HTTP 400

Error Message Описание
1220 Failed to generate a response for product [id]. Please contact technical support. При обработке не смогли однозначно определить настройки вашего аккаунта. Обратитесь в службу поддержки.

Справочник дополнительных кодов ошибок для HTTP 401

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

Справочник дополнительных кодов ошибок для HTTP 404

Error Message Описание
1030 Product not found Запрос не может быть выполнен. Продукт с переданным id не найден или у вас нет доступа к нему. 

Параметры в теле ответа

errors
array [objects]
required
Список ошибок.
errors / [error object]
/
error
number
required
Код ошибки.
errors / [error object]
/
message
string
Описание ошибки.

Пример ответа об ошибке

{
 "errors": [{
   "error": 1030,
   "message": "Product not found"
  }
 ]
}
Политика конфиденциальности
© 2024 Softline