Информация о покупателе — физическом лице (DBS)

Возвращает информацию о покупателе по идентификатору заказа.

Чтобы получить информацию о покупателе, который является юридическим лицом, воспользуйтесь запросом 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

Type

Description

campaignId*

integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

orderId*

integer<int64>

Идентификатор заказа.

Responses

200 OK

Информация о покупателе.

Body

application/json
{
    "status": "OK",
    "result": {
        "id": "string",
        "lastName": "string",
        "firstName": "string",
        "middleName": "string",
        "type": "PERSON",
        "phone": "string"
    }
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

result

OrderBuyerInfoDTO

Информация о покупателе и его номере телефона.
Информация о покупателе с базовыми полями.

ApiResponseStatusType

Тип ответа.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

OrderBuyerInfoDTO

Информация о покупателе и его номере телефона.

Name

Type

Description

id

string

Идентификатор покупателя.

lastName

string

Фамилия покупателя.

firstName

string

Имя покупателя.

middleName

string

Отчество покупателя.

type

OrderBuyerType

Тип покупателя: физическое лицо или организация. Этот параметр используется FBS- и FBY-магазинами, размещающими товары на витрине business.market.yandex.ru.


Enum: PERSON, BUSINESS

phone

string

Подменный номер телефона покупателя. Подробнее о таких номерах читайте в Справке для продавцов.

Формат номера: +<код_страны><код_региона><номер_телефона>.

OrderBuyerType

Тип покупателя:

  • PERSON — физическое лицо.

  • BUSINESS — организация.

Type

Description

OrderBuyerType

Enum: PERSON, BUSINESS

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

ApiErrorDTO

Общий формат ошибки.

Name

Type

Description

code*

string

Код ошибки.

message

string

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

401 Unauthorized

В запросе не указаны данные для авторизации.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

403 Forbidden

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.