Информация о покупателе — физическом лице
Метод доступен для модели DBS.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- inventory-and-order-processing — Обработка заказов и учёт товаров
- inventory-and-order-processing:read-only — Просмотр информации о заказах
- all-methods — Полное управление кабинетом
- all-methods:read-only — Просмотр всех данных
Возвращает информацию о покупателе по идентификатору заказа.
Как получить информацию о покупателе, который является юридическим лицом
Воспользуйтесь запросом POST campaigns/{campaignId}/orders/{orderId}/business-buyer.
Получить данные можно, только если заказ находится в статусе PROCESSING
, DELIVERY
или PICKUP
.
⚙️ Лимит: 3 000 запросов в час |
---|
Request
GET
https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/buyer
Path parameters
Name |
Description |
campaignId* |
Type: integer<int64> Идентификатор магазина в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
Min value: |
orderId* |
Type: integer<int64> Идентификатор заказа. |
Responses
200 OK
Информация о покупателе.
Body
application/json
{
"status": "OK",
"result": {
"id": "string",
"lastName": "string",
"firstName": "string",
"middleName": "string",
"type": "PERSON",
"phone": "string",
"trusted": false
}
}
Name |
Description |
result |
Type: OrderBuyerInfoDTO Информация о покупателе и его номере телефона. |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
OrderBuyerInfoDTO
Информация о покупателе и его номере телефона.
Name |
Description |
type* |
Type: OrderBuyerType Тип покупателя: физическое лицо или организация. Этот параметр используется FBS- и FBY-магазинами, размещающими товары на витрине business.market.yandex.ru. Enum: |
firstName |
Type: string Имя покупателя. |
id |
Type: string Идентификатор покупателя. |
lastName |
Type: string Фамилия покупателя. |
middleName |
Type: string Отчество покупателя. |
phone |
Type: string Подменный номер телефона покупателя. Подробнее о таких номерах читайте в Справке Маркета для продавцов. Формат номера: |
trusted |
Type: boolean Проверенный покупатель. Если параметр При необходимости свяжитесь с покупателем в чате. Как это сделать Подробнее о звонках покупателю читайте в Справке Маркета для продавцов. |
ApiResponseStatusType
Тип ответа. Возможные значения:
OK
— ошибок нет.ERROR
— при обработке запроса произошла ошибка.
Type |
Description |
Enum: |
OrderBuyerType
Тип покупателя:
-
PERSON
— физическое лицо. -
BUSINESS
— организация.
Type |
Description |
Enum: |
400 Bad Request
Запрос содержит неправильные данные.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
ApiErrorDTO
Общий формат ошибки.
Name |
Description |
code* |
Type: string Код ошибки. |
message |
Type: string Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
404 Not Found
Запрашиваемый ресурс не найден.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
No longer supported, please use an alternative and newer version.