Получить список файлов заказа со стороны заказчика
Порядок работы для агента · Методы API и схема OpenAPI.
Назначение
Получите список файлов и печатных форм заказа со стороны заказчика. Передайте data.orderId. Для скачивания выберите запись из списка готовых файлов.
Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде
exampleпоказывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.
Request
POST
https://partner-test-yamagistrali.ru/api/orders/file/listForForwarder/v0
Тестовый стенд
Body
application/json
{
"data": {
"hideArchive": true,
"orderId": "example"
}
}
|
Name |
Description |
|
data |
Type: OrdersFileListForForwarderV0Request Example |
OrdersFileListForForwarderV0Request
|
Name |
Description |
|
orderId |
Type: string Example: |
|
hideArchive |
Type: boolean |
Example
{
"hideArchive": true,
"orderId": "example"
}
Responses
200 OK
OK
Body
application/json
{
"data": {
"conditionsTemplatePrintForms": [
{
"format": "example",
"genFileAvailable": true,
"generatedFileName": "example",
"generationDocAvailable": true,
"id": "example",
"name": "example"
}
],
"conditionsTemplateRegularFiles": [
{
"created_at": {
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
},
"id": "example",
"name": "example"
}
],
"orderPrintForms": [
null
],
"orderRegularFiles": [
null
],
"systemConditionsTemplatePrintForms": [
null
],
"systemConditionsTemplateRegularFiles": [
null
]
}
}
|
Name |
Description |
|
data |
Type: OrdersFileListForForwarderV0Response Example |
OrdersFileListForForwarderV0PrintForm
|
Name |
Description |
|
format |
Type: string Example: |
|
generatedFileName |
Type: string Example: |
|
generationDocAvailable |
Type: boolean |
|
genFileAvailable |
Type: boolean |
|
id |
Type: string Example: |
|
name |
Type: string Example: |
Example
{
"format": "example",
"genFileAvailable": true,
"generatedFileName": "example",
"generationDocAvailable": true,
"id": "example",
"name": "example"
}
TimestampTZOutput
|
Name |
Description |
|
displayTZ |
Type: string Example: |
|
time |
Type: string<date-time> Example: |
Example
{
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
}
OrdersFileListForForwarderV0RegularFile
|
Name |
Description |
|
created_at |
Type: TimestampTZOutput Example |
|
id |
Type: string Example: |
|
name |
Type: string Example: |
Example
{
"created_at": {
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
},
"id": "example",
"name": "example"
}
OrdersFileListForForwarderV0Response
|
Name |
Description |
|
conditionsTemplatePrintForms |
Type: OrdersFileListForForwarderV0PrintForm[] | null Example |
|
conditionsTemplateRegularFiles |
Type: OrdersFileListForForwarderV0RegularFile[] | null Example |
|
orderPrintForms |
Type: OrdersFileListForForwarderV0PrintForm[] | null Example |
|
orderRegularFiles |
Type: OrdersFileListForForwarderV0RegularFile[] | null Example |
|
systemConditionsTemplatePrintForms |
Type: OrdersFileListForForwarderV0PrintForm[] | null Example |
|
systemConditionsTemplateRegularFiles |
Type: OrdersFileListForForwarderV0RegularFile[] | null Example |
Example
{
"conditionsTemplatePrintForms": [
{
"format": "example",
"genFileAvailable": true,
"generatedFileName": "example",
"generationDocAvailable": true,
"id": "example",
"name": "example"
}
],
"conditionsTemplateRegularFiles": [
{
"created_at": {
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
},
"id": "example",
"name": "example"
}
],
"orderPrintForms": [
null
],
"orderRegularFiles": [
null
],
"systemConditionsTemplatePrintForms": [
null
],
"systemConditionsTemplateRegularFiles": [
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 |