Получить список шаблонов заказа
Порядок работы для агента · Методы API и схема OpenAPI.
Назначение
Найдите сохранённый шаблон заказа по названию или организации. Используйте data.namePattern и data.forwarderId для фильтрации. Идентификатор шаблона приходит в data.items[].templateId.
Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде
exampleпоказывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.
Request
POST
https://partner-test-yamagistrali.ru/api/transferOrderTemplate/getTemplateNames/v0
Тестовый стенд
Body
application/json
{
"data": {
"forwarderId": "example",
"namePattern": "example"
}
}
|
Name |
Description |
|
data |
Type: TransferOrderTemplateGetTemplateNamesV0Request Example |
TransferOrderTemplateGetTemplateNamesV0Request
|
Name |
Description |
|
forwarderId |
Type: string | null Example: |
|
namePattern |
Type: string | null Example: |
Example
{
"forwarderId": "example",
"namePattern": "example"
}
Responses
200 OK
OK
Body
application/json
{
"data": {
"items": [
{
"forwarderId": "example",
"forwarderName": "example",
"lastUsedAt": {
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
},
"name": "example",
"templateId": "example",
"updatedAt": null
}
]
}
}
|
Name |
Description |
|
data |
Type: TransferOrderTemplateGetTemplateNamesV0Response Example |
TimestampTZOutput
|
Name |
Description |
|
displayTZ |
Type: string Example: |
|
time |
Type: string<date-time> Example: |
Example
{
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
}
TransferOrderTemplateGetTemplateNamesV0TemplateName
|
Name |
Description |
|
forwarderId |
Type: string Example: |
|
forwarderName |
Type: string Example: |
|
lastUsedAt |
Type: TimestampTZOutput Example |
|
name |
Type: string Example: |
|
templateId |
Type: string Example: |
|
updatedAt |
Type: TimestampTZOutput Example |
Example
{
"forwarderId": "example",
"forwarderName": "example",
"lastUsedAt": {
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
},
"name": "example",
"templateId": "example",
"updatedAt": null
}
TransferOrderTemplateGetTemplateNamesV0Response
|
Name |
Description |
|
items |
Type: TransferOrderTemplateGetTemplateNamesV0TemplateName[] | null Example |
Example
{
"items": [
{
"forwarderId": "example",
"forwarderName": "example",
"lastUsedAt": {
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
},
"name": "example",
"templateId": "example",
"updatedAt": null
}
]
}
400 Bad Request
Bad Request
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example |
Error
|
Name |
Description |
|
info |
Type: object Example |
|
message |
Type: string Example: |
|
message_code |
Type: string 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 |
500 Internal Server Error
Internal Server Error
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example |