Получить типы кузовов

Порядок работы для агента · Методы API и схема OpenAPI.

Назначение

Получите справочник типов кузовов. Используйте значение из справочника в data.bodyType при подготовке заказа.

Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде example показывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.

Request

GET

https://partner-test-yamagistrali.ru/api/dicts/bodyTypes/v0/bodyTypesGet

Тестовый стенд

Responses

200 OK

OK

Body

application/json
{
  "data": {
    "body_type": [
      {
        "code": "example",
        "name": "example"
      }
    ]
  }
}

Name

Description

data

Type: DictsBodyTypesV0BodyTypesGetResponse

Example
{
  "body_type": [
    {
      "code": "example",
      "name": "example"
    }
  ]
}

BodyTypesGetItem

Name

Description

code

Type: string

Example: example

name

Type: string

Example: example

Example
{
  "code": "example",
  "name": "example"
}

DictsBodyTypesV0BodyTypesGetResponse

Name

Description

body_type

Type: BodyTypesGetItem[] | null

Example
[
  {
    "code": "example",
    "name": "example"
  }
]
Example
{
  "body_type": [
    {
      "code": "example",
      "name": "example"
    }
  ]
}

400 Bad Request

Bad Request

Body

application/json
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

Name

Description

error

Type: Error

Example
{
  "info": {},
  "message": "example",
  "message_code": "example"
}

Error

Name

Description

info

Type: object

Example
{}

message

Type: string

Example: example

message_code

Type: string

Example: example

Example
{
  "info": {},
  "message": "example",
  "message_code": "example"
}

403 Forbidden

Forbidden

Body

application/json
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

Name

Description

error

Type: Error

Example
{
  "info": {},
  "message": "example",
  "message_code": "example"
}

500 Internal Server Error

Internal Server Error

Body

application/json
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

Name

Description

error

Type: Error

Example
{
  "info": {},
  "message": "example",
  "message_code": "example"
}