Файлы в Заказах

Как работать с файлами ATI.SU

Методы для работы с файлами в Заказах

Прикрепление данных файла к Заказу

Прикрепление данных файла к заказу

post

/v1.2/orders/files/info

Развернуть все Свернуть все

body

object

{...}

deal_id: guid

file_info:{...}

file_id: string

соответствует file_key, получаемому при создании файла

file_name: string (nullable)

}

file_type: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17]

Тип файла

0 — Другой документ
1 — Товарно-транспортная накладная
2 — Товарная накладная
3 — Транспортная накладная
4 — Накладная
5 — Счет-фактура
6 — Счет на оплату
7 — Платежное поручение
8 — Акт выполненных работ
9 — Заявка
10 — Заявка к договору
11 — Заказ
12 — Договор
13 — Доп. соглашение к договору
14 — Доверенность
15 — Поручение экспедитору
16 — Информационное письмо
17 — Документ о происшествии с грузом/ТС

}

CURL

Копировать

Пример ответа

Ответ

200 Успешное добавление

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"storage_file_id":"string",

"access":0,

"add_date":"1970-01-01T00:00:00.000Z",

"deal_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"is_counterparty_file":false,

"file_name":"string",

"size":0,

"link":"string",

"source_type":0,

"source_file_type":0,

"file_type":0,

"timeslots_warehouse_ids":[...]

]

}

{...}

Файлы заказа

id: guid

Id файла

storage_file_id: string

Id файла в хранилище

access: enum

[0, 1, 2, 3]

Доступ к файлу

0 — только загрузивший файл
1 — обе стороны
2 — загрузивший файл и водитель
3 — доступен обеим сторонам и водителю

add_date: date-time

Время загрузки файла

deal_id: guid

Id связанного Заказа

is_counterparty_file: boolean

Файл контрагента

file_name: string

Имя файла

size: int32

Размер файла

link: string

Ссылка на файл

source_type: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8]

Источник файла

0 — Загружен в заказ
1 — Скопирован из груза
2 — Скопирован из данных о водителе
3 — Скопироване из данных о грузовике
4 — Скопирован из данных о прицепе
5 — Скопирован из данных о полуприцепе
6 — Скопирован из данных о тягаче
7 — Загружен для Ати-водителя

source_file_type: enum

[0, 1, 2, 3, 4, 5, 8]

Тип загруженного файла

0 — Обычный файл
1 — Водительское удостоверение
2 — Паспорт водителя
3 — Техпаспорт ТС
4 — Пластик
5 — Фото ТС

file_type: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17]

Тип файла

0 — Другой документ
1 — Товарно-транспортная накладная
2 — Товарная накладная
3 — Транспортная накладная
4 — Накладная
5 — Счет-фактура
6 — Счет на оплату
7 — Платежное поручение
8 — Акт выполненных работ
9 — Заявка
10 — Заявка (к договору)
11 — Заказ
12 — Договор
13 — Доп. соглашение (к договору)
14 — Доверенность
15 — Поручение экспедитору
16 — Информационное письмо
17 — Документ о происшествии с грузом/ТС

timeslots_warehouse_ids: [int32]

Список складов с Временными окнами с доступом к файлу

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

ONE-OF

1:{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Прикрепление файла к Заказу

Прикрепление файла к заказу

post

/v1.2/orders/files

file_type

integer

deal_id

guid

attachment

binary

CURL

Копировать

Пример ответа

Ответ

200 Успешное добавление

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"storage_file_id":"string",

"access":0,

"add_date":"1970-01-01T00:00:00.000Z",

"deal_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"is_counterparty_file":false,

"file_name":"string",

"size":0,

"link":"string",

"source_type":0,

"source_file_type":0,

"file_type":0,

"timeslots_warehouse_ids":[...]

]

}

{...}

Файлы заказа

id: guid

Id файла

storage_file_id: string

Id файла в хранилище

access: enum

[0, 1, 2, 3]

Доступ к файлу

0 — только загрузивший файл
1 — обе стороны
2 — загрузивший файл и водитель
3 — доступен обеим сторонам и водителю

add_date: date-time

Время загрузки файла

deal_id: guid

Id связанного Заказа

is_counterparty_file: boolean

Файл контрагента

file_name: string

Имя файла

size: int32

Размер файла

link: string

Ссылка на файл

source_type: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8]

Источник файла

0 — Загружен в заказ
1 — Скопирован из груза
2 — Скопирован из данных о водителе
3 — Скопироване из данных о грузовике
4 — Скопирован из данных о прицепе
5 — Скопирован из данных о полуприцепе
6 — Скопирован из данных о тягаче
7 — Загружен для Ати-водителя

source_file_type: enum

[0, 1, 2, 3, 4, 5, 8]

Тип загруженного файла

0 — Обычный файл
1 — Водительское удостоверение
2 — Паспорт водителя
3 — Техпаспорт ТС
4 — Пластик
5 — Фото ТС

file_type: enum

[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17]

Тип файла

0 — Другой документ
1 — Товарно-транспортная накладная
2 — Товарная накладная
3 — Транспортная накладная
4 — Накладная
5 — Счет-фактура
6 — Счет на оплату
7 — Платежное поручение
8 — Акт выполненных работ
9 — Заявка
10 — Заявка (к договору)
11 — Заказ
12 — Договор
13 — Доп. соглашение (к договору)
14 — Доверенность
15 — Поручение экспедитору
16 — Информационное письмо
17 — Документ о происшествии с грузом/ТС

timeslots_warehouse_ids: [int32]

Список складов с Временными окнами с доступом к файлу

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Данная версия метода устарела и её поддержка будет прекращена.
Пожалуйста, используйте метод POST /v1.2/orders/files/info

Удаление приложенного файла Заказа

Удаление приложенного файла заказа

delete

/v1.2/orders/files/{fileId}

fileId

guid

Id файла

CURL

Копировать

Пример ответа

Ответ

200 Успешное удаление

Развернуть все Свернуть все

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Настройка доступа к файлу Заказа

Настройка доступа к файлу заказа

put

/v1.2/orders/files/{fileId}/access

fileId

guid

Id файла

Развернуть все Свернуть все

body

object

Настройка доступа

{...}

access: enum

[0, 1, 2, 3]

Доступ к файлу

0 — только загрузивший файл
1 — обе стороны
2 — загрузивший файл и водитель
3 — доступен обеим сторонам и водителю

timeslots_warehouse_ids: [int32]

Список складов с Временными окнами с доступом к файлу

}

CURL

Копировать

Пример ответа

Ответ

200 Успешное изменение доступа

Развернуть все Свернуть все

Пример

Модель

"binary"

binary

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Настройка доступа к файлу Заказа

Настройка доступа к файлу заказа

post

/v1.2/orders/files/{fileId}/access

fileId

guid

Id файла

CURL

Копировать

Пример ответа

Ответ

200 Успешное изменение доступа

Развернуть все Свернуть все

Пример

Модель

"binary"

binary

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"reason":"string",

"error":"string"

}

{...}

Модель ошибки

reason: string

Причина ошибки

error: string

Ключ ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Данная версия метода устарела и её поддержка будет прекращена.
Пожалуйста, используйте метод PUT /v1.2/orders/files/{fileId}/access