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

Info

Console

Метод доступен для модели DBS.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

inventory-and-order-processing — Обработка заказов и учёт товаров
inventory-and-order-processing:read-only — Просмотр информации о заказах
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

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

Как получить информацию о покупателе, который является юридическим лицом

Воспользуйтесь запросом POST v2/campaigns/{campaignId}/orders/{orderId}/business-buyer.

Получить данные можно, только если заказ находится в статусе PROCESSING, DELIVERY или PICKUP.

⚙️ Лимит: 3 000 запросов в час

Request

GET

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/orders/{orderId}/buyer

Path parameters

Name

Description

campaignId

Type: integer

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

блок Идентификатор кампании;
вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

идентификатором магазина, который отображается в личном кабинете продавца;
рекламными кампаниями.

Min value: 1

orderId

Type: integer

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

Responses

200 OK

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

Body

application/json

{
  "status": "OK",
  "result": {
    "id": "example",
    "lastName": "example",
    "firstName": "example",
    "middleName": "example",
    "email": "example",
    "type": "PERSON",
    "phone": "example",
    "trusted": true
  }
}

Type: object

All of 2 types

Type: ApiResponse

Стандартная обертка для ответов сервера.
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: OrderBuyerInfoDTO

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

Example

{
  "id": "example",
  "lastName": "example",
  "firstName": "example",
  "middleName": "example",
  "email": "example",
  "type": "PERSON",
  "phone": "example",
  "trusted": true
}

Example

{
  "result": {
    "id": "example",
    "lastName": "example",
    "firstName": "example",
    "middleName": "example",
    "email": "example",
    "type": "PERSON",
    "phone": "example",
    "trusted": true
  }
}

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

Example

{
  "status": "OK"
}

OrderBuyerType

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

PERSON — физическое лицо.
BUSINESS — организация.

Type: string

Enum: PERSON, BUSINESS

OrderBuyerBasicInfoDTO

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

Name	Description
type	Type: OrderBuyerType Тип покупателя: физическое лицо или организация. Только для FBS- и FBY-магазинов, которые размещают товары на витрине business.market.yandex.ru. Тип покупателя: `PERSON` — физическое лицо. `BUSINESS` — организация. Enum: `PERSON`, `BUSINESS`
firstName	Type: string Имя. Example: `example`
id	Type: string Идентификатор покупателя. Example: `example`
lastName	Type: string Фамилия. Example: `example`
middleName	Type: string Отчество. Example: `example`

Example

{
  "id": "example",
  "lastName": "example",
  "firstName": "example",
  "middleName": "example",
  "type": "PERSON"
}

OrderBuyerInfoDTO

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

Type: object

All of 2 types

Type: OrderBuyerBasicInfoDTO

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

Example

{
  "id": "example",
  "lastName": "example",
  "firstName": "example",
  "middleName": "example",
  "email": "example",
  "type": "PERSON"
}

Type: object

phone

Type: string

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

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

Example: example

trusted

Type: boolean

Проверенный покупатель.

Если параметр trusted вернулся со значением true, Маркет уже проверил покупателя — не звоните ему. Обработайте заказ как обычно и передайте его курьеру или отвезите в ПВЗ.

При необходимости свяжитесь с покупателем в чате. Как это сделать

Подробнее о звонках покупателю читайте в Справке Маркета для продавцов.

Example

{
  "phone": "example",
  "trusted": true
}

Example

{
  "id": "example",
  "lastName": "example",
  "firstName": "example",
  "middleName": "example",
  "email": "example",
  "type": "PERSON",
  "phone": "example",
  "trusted": true
}

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибках при работе с заказами

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

ApiErrorDTO

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

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

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

Example: example

Example

{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

Type: ApiResponse

Стандартная обертка для ответов сервера.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: ApiErrorDTO[] | null

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

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

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

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

403 Forbidden

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

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

404 Not Found

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

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

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

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

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

Продление срока хранения заказа

Отмена заказа покупателем