Information about the buyer — an individual

The method is available for the DBS model.

If you are using an API Key token, one of the accesses in the list is required to call the method

Returns information about the customer by the order ID.

How to get information about a buyer who is a legal entity

You can receive the data only if the order is in the status PROCESSING, DELIVERY or PICKUP.

, Limit: 3,000 requests per hour

Request

GET

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The campaign ID.

You can find it using a query GET campaigns or find it in the seller's office on the Market — click on the name of your business and go to the page:

  • Modules and APIs → block Sending data to Yandex.Market.
  • Query log → drop-down list in the block Show logs.

, Do not send the store ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports.

Min value: 1

orderId*

Type: integer<int64>

The order ID.

Responses

200 OK

Information about the buyer.

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

Information about the buyer and his phone number.
Information about the buyer with basic fields.

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

OrderBuyerInfoDTO

Information about the buyer and his phone number.

Name

Description

type*

Type: OrderBuyerType

Buyer type: individual or organization. This parameter is used by FBS and FBY stores that place products on the business.market showcase.yandex.ru.

Enum: PERSON, BUSINESS

firstName

Type: string

The buyer's name.

id

Type: string

The buyer's ID.

lastName

Type: string

Last name of the buyer.

middleName

Type: string

Patronymic of the buyer.

phone

Type: string

The buyer's fake phone number. Read more about these numbers. in the Help of the Market for sellers.

Number format: +<country code><region_code><phone number>.

trusted

Type: boolean

A trusted customer.

If the parameter trusted returned with the value true The market has already checked the buyer — do not call him. Process the order as usual and hand it over to the courier or take it to the PVZ.

If necessary, contact the buyer in the chat. How to do it

Read more about customer calls. in the Help of the Market for sellers.

ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

OrderBuyerType

Type of buyer:

  • PERSON — an individual.

  • BUSINESS — organization.

Type

Description

OrderBuyerType

Enum: PERSON, BUSINESS

400 Bad Request

The request contains incorrect data. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

404 Not Found

The requested resource was not found. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error in Yandex. Market. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.