Список допустимых кодов стран

Info

Console

Метод доступен для моделей: FBY, FBS, Экспресс и DBS.

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

inventory-and-order-processing — Обработка заказов и учёт товаров
inventory-and-order-processing:read-only — Просмотр информации о заказах
pricing — Управление ценами
pricing:read-only — Просмотр цен
offers-and-cards-management — Управление товарами и карточками
offers-and-cards-management:read-only — Просмотр товаров и карточек
promotion — Продвижение товаров
promotion:read-only — Просмотр информации о продвижении товаров
finance-and-accounting — Просмотр финансовой информации и отчётности
communication — Общение с покупателями
settings-management — Настройка магазинов
supplies-management:read-only — Получение информации по FBY-заявкам
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

Возвращает список стран с их кодами в формате ISO 3166-1 alpha-2.

Страна производства countryCode понадобится при продаже товаров из-за рубежа для бизнеса. Инструкция

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

Request

POST

https://api.partner.market.yandex.ru/v2/regions/countries

Responses

200 OK

Список стран с их кодами в формате ISO 3166-1 alpha-2.

Body

application/json

{
  "countries": [
    {
      "region": {
        "id": 0,
        "name": "example",
        "type": "OTHER",
        "parent": null
      },
      "countryCode": "RU"
    }
  ]
}

Name

Description

countries

Type: CountryDTO[]

Список стран с их кодами в формате ISO 3166-1 alpha-2.

Example

[
  {
    "region": {
      "id": 0,
      "name": "example",
      "type": "OTHER",
      "parent": null
    },
    "countryCode": "RU"
  }
]

RegionType

Тип региона.

Возможные значения:

CITY_DISTRICT — район города.
CITY — крупный город.
CONTINENT — континент.
COUNTRY_DISTRICT — область.
COUNTRY — страна.
REGION — регион.
REPUBLIC_AREA — район субъекта федерации.
REPUBLIC — субъект федерации.
SUBWAY_STATION — станция метро.
VILLAGE — город.
OTHER — неизвестный регион.

Type: string

Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA

RegionDTO

Регион доставки.

Name	Description
id	Type: integer Идентификатор региона.
name	Type: string Название региона. Example: `example`
type	Type: RegionType Тип региона. Тип региона. Возможные значения: `CITY_DISTRICT` — район города. `CITY` — крупный город. `CONTINENT` — континент. `COUNTRY_DISTRICT` — область. `COUNTRY` — страна. `REGION` — регион. `REPUBLIC_AREA` — район субъекта федерации. `REPUBLIC` — субъект федерации. `SUBWAY_STATION` — станция метро. `VILLAGE` — город. `OTHER` — неизвестный регион. Enum: `OTHER`, `CONTINENT`, `REGION`, `COUNTRY`, `COUNTRY_DISTRICT`, `REPUBLIC`, `CITY`, `VILLAGE`, `CITY_DISTRICT`, `SUBWAY_STATION`, `REPUBLIC_AREA`
parent	Type: RegionDTO Информация о родительском регионе. Указываются родительские регионы до уровня страны. Регион доставки. Example `{ "id": 0, "name": "example", "type": "OTHER", "parent": null }`

Example

{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": {
    "id": 0,
    "name": "example",
    "type": null,
    "parent": null
  }
}

CountryCode

Страна производства в формате ISO 3166-1 alpha-2. Как получить

Type: string

Min length: 2

Max length: 2

Pattern: ^[A-Z]{2}$

Example: RU

CountryDTO

Страна и ее код в формате ISO 3166-1 alpha-2.

Name

Description

countryCode

Type: CountryCode

Страна производства в формате ISO 3166-1 alpha-2. Как получить

Min length: 2

Max length: 2

Pattern: ^[A-Z]{2}$

Example: RU

region

Type: RegionDTO

Регион доставки.

Example

{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": null
}

Example

{
  "region": {
    "id": 0,
    "name": "example",
    "type": "OTHER",
    "parent": null
  },
  "countryCode": "RU"
}

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"
    }
  ]
}

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

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

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

Example

{
  "status": "OK"
}

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"
    }
  ]
}

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"
    }
  ]
}

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

Справочник служб доставки

Поиск региона