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

GET /v1/product/[product id]

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

[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": 4648350,
  "update_date": "2020-10-25 14:18:00",
  "family_name": "Demo Product",
  "name": "1 Pc / 1 year",
  "is_publish": true,
  "image_url": "https://my-shop.com/images/product-1234.png",
  "description": "<p><strong>Test product</strong></p>",
  "comment_for_manager": "There will be a full description later",
  "url_to_instructions": "https://www.google.ru",
  "url_to_download": "https://www.google.ru",
  "business_segment": "b2c",
  "available_for_sale": "all",
  "is_service": true,
  "license_type": "new",
  "licence_term": "P1Y",
  "renew_settings": {
    "product_id_for_renew": [
      4645130,
      4645131,
      4645131
    ],
    "renew_ar": {
      "enable": true,
      "required": false
    },
    "renew_pmr": true,
    "renew_email": false
  },
  "localization_values": {
    "en_EN": {
      "family_name": "Test product",
      "name": "1 PC/1 year",
      "description": "<p><strong>Test product</strong> for test purchase</p>",
      "comment_for_cart": "This is a test purchase.",
      "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."
    },
    "cs_CZ": {
      "family_name": "Zkušební výrobek",
      "name": "1 ks / 1 rok",
      "description": "<p><strong>Testovací produkt</strong> pro zkušební nákup</p>",
      "comment_for_cart": "Jedná se o zkušební nákup.",
      "comment_for_product_top": "Licence je platná po dobu 1 roku.",
      "comment_for_product_middle": "Nová verze testovaného produktu.",
      "comment_for_product_for_AR": "Licence se obnovuje automaticky.",
      "comment_for_product_for_MR": "Budete muset ručně obnovit licenci po 1 roce.",
      "comment_for_product_bottom": "Tato licence není určena k prodeji nebo aktivaci mimo zemi."
    }
  },
  "display_settings": {
    "hide_name": true,
    "hide_item_quantity": true
  },
  "variants": [
    {
      "vendor_code": "1",
      "sku": "111",
      "from": 1,
      "to": 5,
      "price": {
        "USD": {
          "currency": "USD",
          "price": "99.99"
        },
        "EUR": {
          "currency": "USD",
          "price": "99.99"
        }
      }
    },
    {
      "vendor_code": "1",
      "sku": "111",
      "from": 6,
      "price": {
        "USD": {
          "currency": "USD",
          "price": "80.99"
        },
        "EUR": {
          "currency": "USD",
          "price": "80.00"
        }
      }
    }
  ],
  "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": [
      4645130,
      4645131
    ]
  },
  "typo": {
    "status": true,
    "date_from": "2020-10-15 14:18:40",
    "date_to": "2020-10-25 14:18:40",
    "localization_values": {
      "en_EN": {
        "comment_for_typo": "This is a test purchase."
      },
      "cs_CZ": {
        "comment_for_typo": "Jedná se o zkušební nákup."
      }
    },
    "product_id": [
      4645130,
      4645131
    ]
  },
  "license_data": {
    "en_EN": {
      "customer_notification": "Key: {KEY}"
    },
    "cs_CZ": {
      "customer_notification": "Klíč: {KEY}"
    }
  },
  "software_registry": {
    "status": true,
    "date": "2020-10-15",
    "url": "https://reestr.digital.gov.ru/reestr/111",
    "registration_number": 111
  }
}
{
 "id": 4648350,
 "update_date": "2020-10-25 14:18:00",
 "family_name": "Demo Product",
 "name": "1 Pc / 1 year",
 "is_publish": true,
 "image_url": "",
 "description": "",
 "comment_for_manager": "",
 "url_to_instructions": "",
 "url_to_download": "",
 "business_segment": "",
 "licence_term": "",
 "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": {
    "USD": {
     "currency": "USD",
     "price": "99.99"
    }
   }
  }
 ],
 "typo": [],
 "cross_sell": [],
 "license_data": [],
 "available_for_sale": "all",
 "is_service": true,
 "license_type": "new"
}

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

Код ответа сервера Описание
HTTP/1.1 400 Bad Request Запрос не валиден (ошибка в параметрах; не переданы необходимые данные и т.п.).
В теле ответа будет передан дополнительный код ошибки (один или несколько).
HTTP/1.1 401 Unauthorized Неуспешная аутентификация.
В теле ответа будет передан дополнительный код ошибки (один или несколько). 
HTTP/1.1 404 Not found Неверный URL запроса или продукт не найден. Проверьте адрес запроса. В теле ответа может быть передан дополнительный код ошибки (один или несколько). 
HTTP/1.1 500 Request Error Ошибка на стороне сервера. Повторите запрос позднее или обратитесь в службу поддержки.
Error Message Описание
1220 Failed to generate a response for product [id]. Please contact technical support. При обработке не смогли однозначно определить настройки вашего аккаунта. Обратитесь в службу поддержки.

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

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"
  }
 ]
}