Getting a chat by ID

The method is available for all models.

If you are using an API Key token, one of the accesses in the list is required to call the method
  • communication — Customer communication
  • all-methods — Full account management
  • all-methods:read-only — View all data

Returns the chat by its ID.

Enable API notifications

Yandex.Market will send you a request. POST notification when a new chat or message appears.

How to work with notifications

⚙️ Limit: 1,000 requests per hour

Request

GET

https://api.partner.market.yandex.ru/v2/businesses/{businessId}/chat

Path parameters

Name

Description

businessId*

Type: integer<int64>

Cabinet ID. To find out, use the request GET v2/campaigns.

ℹ️ What is a cabinet and a store on the Market?

Min value: 1

Query parameters

Name

Description

chatId*

Type: integer<int64>

The chat ID.

Min value: 1

Responses

200 OK

Information about the chat.

Body

application/json
{
    "status": "OK",
    "result": {
        "chatId": 0,
        "orderId": 0,
        "context": {
            "type": "ORDER",
            "customer": {
                "name": "string",
                "publicId": "string"
            },
            "campaignId": 0,
            "orderId": 0,
            "returnId": 0
        },
        "type": "CHAT",
        "status": "NEW",
        "createdAt": "2017-11-21T00:00:00+03:00",
        "updatedAt": "2017-11-21T00:00:00+03:00"
    }
}

Name

Description

status*

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

result
Type: object

chatId*

Type: integer<int64>

The chat ID.

Min value: 1

context*
Type: object

type*

Type: string

Type of context:

Enum: ORDER, RETURN, DIRECT

campaignId

Type: integer<int64>

The store's campaign ID.

You can find it using a query GET v2/campaigns or find it in the seller's office on the Market — click on your account icon → Settings and in the menu on the left, select APIs and modules:

  • block Campaign ID;
  • tab Query log → drop-down list in the block Show logs.

⚠️ It does not match the store's identifier (which is indicated in the merchant's account on the Market next to the store's name and in some reports). It is linked to the store one-to-one. Does not apply to advertising campaigns.

Min value: 1

customer
Type: object

name

Type: string

The buyer's public name in Yandex Passport, which is displayed in Yandex services.

Min length: 1

publicId

Type: string

The public user ID in Yandex Passport.

Examples where it is used
  • The market: https://market.yandex.ru/user/{public-id}/reviews
  • Zen: https://zen.yandex.ru/user/{public-id}
  • Reviews: https://yandex.ru/user/{public-id}

Read more about public data in Yandex ID documentation.

Min length: 1

Information about the buyer in the chat.

orderId

Type: integer<int64>

The order ID.

It is returned for orders and refunds.

Min value: 1

returnId

Type: integer<int64>

The refund ID.

It is returned only for refunds.

Min value: 1

Information about the order or refund for which the chat was started.

createdAt*

Type: string<date-time>

Date and time when the chat was created.

Date format: ISO 8601 with an offset relative to UTC.

Example: 2017-11-21T00:00:00+03:00

status*

Type: string

Chat status:

  • NEW — a new chat.
  • WAITING_FOR_CUSTOMER — We need a buyer's response.
  • WAITING_FOR_PARTNER — We need the store's response.
  • WAITING_FOR_ARBITER — We need an arbitrator's response.
  • WAITING_FOR_MARKET — We need a response from Yandex. Market.
  • FINISHED — The chat is over.

Enum: NEW, WAITING_FOR_CUSTOMER, WAITING_FOR_PARTNER, WAITING_FOR_ARBITER, WAITING_FOR_MARKET, FINISHED

type*

Type: string

Chat type:

  • CHAT — chat with the buyer.
  • ARBITRAGE — dispute.

Enum: CHAT, ARBITRAGE

updatedAt*

Type: string<date-time>

The date and time of the last message in the chat.

Date format: ISO 8601 with an offset relative to UTC.

Example: 2017-11-21T00:00:00+03:00

orderId

⦸

Type: integer<int64>

The order ID.

Min value: 1

Information about the chat.

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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, 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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • 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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • 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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • 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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of the Market. More information about the error

Body

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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

Previous
Message history
Next
Getting a list of chats