[GET] Получение промоакции

Softline CheckoutИнтеграцияPromotions API

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

GET /v1/promotion/[promotion id]

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

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

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

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

[promotion id]

required

Идентификатор промоакции
Вы можете получить его в ответ на запросы:

Пример передачи параметра в URL: /v1/promotion/123456

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

AuthorizationJWT

required

Авторизационный токен

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

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

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

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

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

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

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

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

number

required

Идентификатор промоакции

[...]

required

Данные промоакции
Список и формат параметров аналогичен запросу на создание промоакции. Если какой-либо параметр является не обязательным и не был заполнен в при создании/редактировании промоакции, то он будет заполнен значением по по умолчанию. За исключением:

coupons.coupon_type - если параметр не был заполнен в промоакции ранее, то он не будет возвращен в ответе на запрос получения данных промоакции. В этом случае промокоды имеют тип reusable.

update_date

string

required

Дата последнего обновления промоакции

Формат даты: YYYY-MM-DDThh:mm:ss±hh:mm.

Пример положительного ответа

{
 "id": 36,
 "promotion_type": "coupon",
 "promotion_name": "Black Friday",
 "status": true,
 "date_from": "2022-04-08T12:53:02+03:00",
 "date_to": "3000-01-01T00:00:00+03:00",
 "update_date": "2022-11-01T12:53:02+03:00",
 "coupons": {
  "coupon_type": "one-time",
  "coupon_code": [
   "PROMO-001",
   "PROMO-002"
  ],
  "discount_percent": "10",
  "product_id": [
   11111
  ]
 },
 "update_date": "2022-04-08T12:53:02+03:00"
}

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

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

Справочник 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	Описание
11000	No access to promotion management. Please contact technical support.	При обработке не смогли однозначно определить настройки вашего аккаунта. Обратитесь в службу поддержки.

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

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

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

Error	Message	Описание
11200	Promotion not found: [id промоакции]	Запрос не может быть выполнен. Промоакция с переданным id не найдена или у вас нет доступа к ней. В ошибке будут передан идентификаторы промоакции, не прошедший проверку.

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

errors

array [objects]

required

Список ошибок.

errors / [error object]

error

number

required

Код ошибки.

errors / [error object]

message

string

Описание ошибки.

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

{
 "errors": [{
   "error": 11200,
   "message": "Promotion not found: 123"
  }
 ]
}