Бонусы лояльности

Создание задачи на оповещение о начисленных бонусах по заказу.

Request

POST

/partner-integration/v1/loyalty/bonus-points

Headers

Name

Description

Authorization*

Type: string

Токен, сформированный на стороне Яндекс Еды.

Partner-Name*

Type: string

Имя Партнёра.

Body

application/json

{
    "order_id": "string",
    "points_request_type": {
        "type": "points_charge",
        "card_number": "string",
        "points_value": 0
    }
}

Name

Description

order_id*

Type: string

ID заказа в системе Партнёра.

Min length: 1

points_request_type*

Type: PointsCharge
or PointsError

Тип входящего реквеста, начисление баллов или ошибка.

PointsCharge

Начисление баллов.

Name	Description
points_value*	Type: integer Количество зачисленных по заказу баллов. Min value: `1`
type*	Type: string Дискриминатор схемы объекта, для `PointsCharge` равен `points_charge`. Example: `points_charge` Enum: `points_charge`
card_number	Type: string Номер карты пользователя.

PointsError

Начисление баллов не удалось.

Name	Description
reason*	Type: string Причина ошибки при начислении (клиент не участник ПЛ или зачисление не удалось). Enum: `not_loyalty_subscriber`, `charge_failed`
type*	Type: string Дискриминатор схемы объекта, для `PointsError` равен `points_error`. Example: `points_error` Enum: `points_error`
message	Type: string Дополнительная информация об ошибке.

Responses

201 Created

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

400 Bad Request

Неверно сформированный запрос.

Body

application/json

{
    "message": "string",
    "code": 0
}

Name	Description
code*	Type: integer Код ошибки.
message*	Type: string Сообщение об ошибке.
details	Type: Error

Error

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

Name	Description
code*	Type: integer Код ошибки.
message*	Type: string Сообщение об ошибке.
details	Type: Error

403 Forbidden

Нет доступа для создания задачи по указанному заказу.

Body

application/json

{
    "message": "string",
    "code": 0
}

Name	Description
code*	Type: integer Код ошибки.
message*	Type: string Сообщение об ошибке.
details	Type: Error

409 Conflict

В течение последних 24 часов для указанного заказа уже была назначена задача.

Body

application/json

{
    "message": "string",
    "code": 0
}

Name	Description
code*	Type: integer Код ошибки.
message*	Type: string Сообщение об ошибке.
details	Type: Error

500 Internal Server Error

Внутренняя ошибка сервиса, необходимо повторить запрос.

Body

application/json

{
    "message": "string",
    "code": 0
}

Name	Description
code*	Type: integer Код ошибки.
message*	Type: string Сообщение об ошибке.
details	Type: Error

Была ли статья полезна?

Открытие крышки робота-курьера

Валидация кода курьера