Документ отгрузки со свежей ссылкой на скачивание в выбранном формате

POST /v1/shipment/document/get

POST/v1/shipment/document/get

Тело запроса

document_id

string

required

Идентификатор документа.

format

string

Формат файла.

Допустимые значения

PDFEXCEL

Успешный ответ

200A successful response.

application/json

object

document

object

Документ со свежей ссылкой.

Показать свойства

document_id

string

Идентификатор документа.

type

string

Тип документа.

Допустимые значения

UPDACCEPTANCE_ACTWAYBILL

status

string

Статус документа.

Допустимые значения

PENDINGAVAILABLE

created_at

string

Время создания документа (RFC3339).

file

object

Файл документа.

Показать свойства

file_id

string

Идентификатор файла.

name

string

Имя файла.

url

string

Ссылка для скачивания.

expires_at

string

Время истечения ссылки (RFC3339).

Ошибки

400Некорректный запрос

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.

Допустимые значения

OPERATION_NOT_SUPPORTED

message

string

сообщение

details

object

401Ошибка авторизации

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.

Допустимые значения

OPERATION_NOT_SUPPORTED

message

string

сообщение

details

object

429Превышен лимит запросов

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.

Допустимые значения

OPERATION_NOT_SUPPORTED

message

string

сообщение

details

object

500Внутренняя ошибка сервера

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.

Допустимые значения

OPERATION_NOT_SUPPORTED

message

string

сообщение

details

object

defaultОшибка (неожиданная или прочие)

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.

Допустимые значения

OPERATION_NOT_SUPPORTED

message

string

сообщение

details

object

POST/v1/shipment/document/get

1curl https://api.omninet.ru/v1/shipment/document/get \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "document_id": "string",6  "format": "string"7}'

{
  "document": {
    "document_id": "string",
    "type": "string",
    "status": "string",
    "created_at": "string",
    "file": {
      "file_id": "string",
      "name": "string",
      "url": "string",
      "expires_at": "string"
    }
  }
}

A successful response.