Создать заказ на перевозку

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

Назначение

Создайте заказ на перевозку от имени выбранной организации. Передайте её в data.forwarder, владельца груза — в data.customer. Нужны непустые data.bodyType и data.shipments; в каждой задаче нужны погрузка, выгрузка и непустой список packages. Для черновика оставьте data.distribution без значения. Сохраните data.id.

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

Request

POST

https://partner-test-yamagistrali.ru/api/orders/v0/transferOrder/create

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

Body

application/json
{
  "data": {
    "additionalConditions": {
      "additionalComment": "example",
      "currency": "example",
      "documentsDelay": {},
      "emails": [
        "example"
      ],
      "externalOrderID": "example",
      "fullName": "example",
      "isVatPayer": true,
      "phones": [
        "example"
      ],
      "price": 0.5,
      "priceComment": "example",
      "priceWithVat": 0.5,
      "specifyConditions": true,
      "vat": 0.5
    },
    "agreementRules": {
      "isDriverCanChangePackagesWithoutApproval": true,
      "isExecutorCanChangePackagesWithoutApproval": true,
      "isExecutorCanChangeShipmentsWithoutApproval": true,
      "isForwarderCanChangePackagesWithoutApproval": true,
      "isForwarderCanChangeShipmentsWithoutApproval": true,
      "isWarehouseCanChangePackagesWithoutApproval": true
    },
    "auction": {
      "allowMultimodal": true,
      "auctionType": "example",
      "autoExtension": true,
      "autoExtensionActive": 0,
      "autoExtensionDuration": 0,
      "autoExtensionTime": 0,
      "autoSelection": true,
      "bargainingIsPossible": true,
      "bidStep": 0.5,
      "buyNowPrice": 0.5,
      "decreaseOnly": true,
      "decreaseOnlyFromDeclaredPrice": true,
      "duration": 0,
      "endDate": {},
      "hideBidsFromCarrier": true,
      "startDate": null,
      "tariffMatrixParams": {},
      "useTariffMatrix": true,
      "vat": 0.5,
      "vatInPriceNotConsider": true
    },
    "bodyType": [
      "example"
    ],
    "bodyTypeComment": "example",
    "cargoCategory": {
      "category": "example",
      "categoryComment": "example"
    },
    "cargoComment": "example",
    "cargoId": "example",
    "currency": "example",
    "customer": {
      "customerAddress": "example",
      "customerCargoPrice": 0.5,
      "customerComment": "example",
      "customerCountry": "example",
      "customerForwarderId": "example",
      "customerLegalForm": "example",
      "customerName": "example",
      "customerPhone": "example",
      "customerTin": "example"
    },
    "dimensions": {
      "breadth": 0.5,
      "height": 0.5,
      "length": 0.5,
      "palletCount": 0,
      "volume": 0.5,
      "weight": 0.5
    },
    "distribution": {
      "amount": 0.5,
      "comment": "example",
      "currency": "example",
      "dayDocClose": 0,
      "dayDocDelay": 0,
      "docFormat": "example",
      "groupsId": [
        "example"
      ],
      "partners": [
        {}
      ],
      "publicMatcher": true,
      "type": "example",
      "typeDocClose": "example",
      "typeDocDelay": "example"
    },
    "executionSettings": {
      "driverAssignmentDeadline": {}
    },
    "fileContainerId": "example",
    "files": [
      "example"
    ],
    "flightCreator": {
      "car": {},
      "comment": "example",
      "companyInfo": {},
      "currency": "example",
      "documentsDelay": null,
      "driver": {},
      "externalFlightID": "example",
      "flightName": "example",
      "isVatPayer": true,
      "price": 0.5,
      "priceComment": "example",
      "priceWithVat": 0.5,
      "trailer": {},
      "vat": 0.5,
      "willNotCarryMyself": true
    },
    "forwarder": {
      "forwarderComment": "example",
      "forwarderId": "example",
      "forwarderName": "example",
      "forwarderTin": "example"
    },
    "freeTags": [
      "example"
    ],
    "isVolumeAuction": true,
    "meta": {
      "conditions": [
        {
          "conditionsTemplateId": "example",
          "conditionsTemplateType": "example",
          "conditionsTemplateVersion": "example",
          "executorId": "example",
          "variables": null
        }
      ]
    },
    "orderExternalID": "example",
    "paymentDelayPeriod": {
      "daysDelayPeriod": 0,
      "paymentType": "example",
      "postPayCalendarType": "example"
    },
    "shipments": [
      {
        "comment": "example",
        "distributionPriority": 0,
        "name": "example",
        "npShipment": null,
        "npUnshipment": null,
        "packageType": "example",
        "packages": [
          {}
        ],
        "quantizationMethod": "example",
        "shipmentExternalID": "example"
      }
    ],
    "switchOffDatesValidation": true,
    "tagId": "example",
    "temperatureRegime": [
      {
        "from": 0,
        "label": "example",
        "to": 0
      }
    ],
    "transferOrderAdditionalConditions": "example",
    "transferOrderAdditionalConfiguration": {},
    "transferOrderCost": {
      "currency": "example",
      "price": 0.5
    },
    "transferOrderName": "example",
    "transferOrderType": "example",
    "transshipmentTypes": [
      "example"
    ],
    "trustCoordinates": true,
    "typePaymentAndTax": "example",
    "utm": {
      "utmCampaign": "example",
      "utmContent": "example",
      "utmMedium": "example",
      "utmSource": "example",
      "utmTerm": "example"
    },
    "volumeAuction": {
      "auctionType": "example",
      "duration": 0,
      "endDate": null,
      "flightsCount": 0.5,
      "startDate": null,
      "tarifficationType": "example",
      "tonsCount": 0.5,
      "transitDistance": 0.5,
      "vehicleCapacityFrom": 0.5,
      "vehicleCapacityTo": 0.5
    }
  }
}

Name

Description

data

Type: OrdersV0TransferOrderCreateRequest

Example
{
  "additionalConditions": {
    "additionalComment": "example",
    "currency": "example",
    "documentsDelay": {
      "daysTypeAfterDocuments": "example",
      "daysTypeBeforeDocuments": "example",
      "delayAfterDocuments": 0,
      "delayBeforeDocuments": 0
    },
    "emails": [
      "example"
    ],
    "externalOrderID": "example",
    "fullName": "example",
    "isVatPayer": true,
    "phones": [
      "example"
    ],
    "price": 0.5,
    "priceComment": "example",
    "priceWithVat": 0.5,
    "specifyConditions": true,
    "vat": 0.5
  },
  "agreementRules": {
    "isDriverCanChangePackagesWithoutApproval": true,
    "isExecutorCanChangePackagesWithoutApproval": true,
    "isExecutorCanChangeShipmentsWithoutApproval": true,
    "isForwarderCanChangePackagesWithoutApproval": true,
    "isForwarderCanChangeShipmentsWithoutApproval": true,
    "isWarehouseCanChangePackagesWithoutApproval": true
  },
  "auction": {
    "allowMultimodal": true,
    "auctionType": "example",
    "autoExtension": true,
    "autoExtensionActive": 0,
    "autoExtensionDuration": 0,
    "autoExtensionTime": 0,
    "autoSelection": true,
    "bargainingIsPossible": true,
    "bidStep": 0.5,
    "buyNowPrice": 0.5,
    "decreaseOnly": true,
    "decreaseOnlyFromDeclaredPrice": true,
    "duration": 0,
    "endDate": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    },
    "hideBidsFromCarrier": true,
    "startDate": null,
    "tariffMatrixParams": {
      "isWhoFirst": true,
      "tariffMatrixIds": [
        null
      ]
    },
    "useTariffMatrix": true,
    "vat": 0.5,
    "vatInPriceNotConsider": true
  },
  "bodyType": [
    "example"
  ],
  "bodyTypeComment": "example",
  "cargoCategory": {
    "category": "example",
    "categoryComment": "example"
  },
  "cargoComment": "example",
  "cargoId": "example",
  "currency": "example",
  "customer": {
    "customerAddress": "example",
    "customerCargoPrice": 0.5,
    "customerComment": "example",
    "customerCountry": "example",
    "customerForwarderId": "example",
    "customerLegalForm": "example",
    "customerName": "example",
    "customerPhone": "example",
    "customerTin": "example"
  },
  "dimensions": {
    "breadth": 0.5,
    "height": 0.5,
    "length": 0.5,
    "palletCount": 0,
    "volume": 0.5,
    "weight": 0.5
  },
  "distribution": {
    "amount": 0.5,
    "comment": "example",
    "currency": "example",
    "dayDocClose": 0,
    "dayDocDelay": 0,
    "docFormat": "example",
    "groupsId": [
      "example"
    ],
    "partners": [
      {
        "id": "example",
        "tin": "example"
      }
    ],
    "publicMatcher": true,
    "type": "example",
    "typeDocClose": "example",
    "typeDocDelay": "example"
  },
  "executionSettings": {
    "driverAssignmentDeadline": {
      "duration": 0,
      "endDate": null
    }
  },
  "fileContainerId": "example",
  "files": [
    "example"
  ],
  "flightCreator": {
    "car": {
      "id": "example",
      "version": 0
    },
    "comment": "example",
    "companyInfo": {
      "companyName": "example",
      "companyType": "example",
      "country": "example",
      "email": "example",
      "fullName": "example",
      "phone": "example",
      "tin": "example"
    },
    "currency": "example",
    "documentsDelay": null,
    "driver": {
      "id": "example",
      "version": 0
    },
    "externalFlightID": "example",
    "flightName": "example",
    "isVatPayer": true,
    "price": 0.5,
    "priceComment": "example",
    "priceWithVat": 0.5,
    "trailer": {
      "id": "example",
      "version": 0
    },
    "vat": 0.5,
    "willNotCarryMyself": true
  },
  "forwarder": {
    "forwarderComment": "example",
    "forwarderId": "example",
    "forwarderName": "example",
    "forwarderTin": "example"
  },
  "freeTags": [
    "example"
  ],
  "isVolumeAuction": true,
  "meta": {
    "conditions": [
      {
        "conditionsTemplateId": "example",
        "conditionsTemplateType": "example",
        "conditionsTemplateVersion": "example",
        "executorId": "example",
        "variables": {}
      }
    ]
  },
  "orderExternalID": "example",
  "paymentDelayPeriod": {
    "daysDelayPeriod": 0,
    "paymentType": "example",
    "postPayCalendarType": "example"
  },
  "shipments": [
    {
      "comment": "example",
      "distributionPriority": 0,
      "name": "example",
      "npShipment": {
        "addressComment": "example",
        "content": "example",
        "country": "example",
        "id": "example",
        "legalAddress": "example",
        "legalPhone": "example",
        "name": "example",
        "npAdditionalContact": [
          null
        ],
        "npGeoAddress": null,
        "npGeoLegalAddress": null,
        "npLegalType": "example",
        "npShipmentId": "example",
        "npTin": "example",
        "period": null,
        "phoneCountryCode": "example",
        "position": 0,
        "sequenceOrder": 0,
        "transshipmentTypes": [
          null
        ]
      },
      "npUnshipment": null,
      "packageType": "example",
      "packages": [
        {
          "amount": 0.5,
          "capacity": 0.5,
          "cargoCategory": null,
          "cargoInsurance": null,
          "comment": "example",
          "count": 0,
          "currency": "example",
          "dimensionHeight": 0.5,
          "dimensionLength": 0.5,
          "dimensionWeight": 0.5,
          "hazardClass": "example",
          "packageExternalId": "example",
          "packageName": "example",
          "ruEdo": null,
          "shipmentBodyType": "example",
          "stackability": "example",
          "temperatureRegime": [
            null
          ],
          "weight": 0.5
        }
      ],
      "quantizationMethod": "example",
      "shipmentExternalID": "example"
    }
  ],
  "switchOffDatesValidation": true,
  "tagId": "example",
  "temperatureRegime": [
    {
      "from": 0,
      "label": "example",
      "to": 0
    }
  ],
  "transferOrderAdditionalConditions": "example",
  "transferOrderAdditionalConfiguration": {},
  "transferOrderCost": {
    "currency": "example",
    "price": 0.5
  },
  "transferOrderName": "example",
  "transferOrderType": "example",
  "transshipmentTypes": [
    "example"
  ],
  "trustCoordinates": true,
  "typePaymentAndTax": "example",
  "utm": {
    "utmCampaign": "example",
    "utmContent": "example",
    "utmMedium": "example",
    "utmSource": "example",
    "utmTerm": "example"
  },
  "volumeAuction": {
    "auctionType": "example",
    "duration": 0,
    "endDate": null,
    "flightsCount": 0.5,
    "startDate": null,
    "tarifficationType": "example",
    "tonsCount": 0.5,
    "transitDistance": 0.5,
    "vehicleCapacityFrom": 0.5,
    "vehicleCapacityTo": 0.5
  }
}

OrdersV0TransferOrderCreateDocumentsDelay

Name

Description

daysTypeAfterDocuments

Type: string | null

Дни (после предоставления документов) - рабочие/календарные

Example: example

daysTypeBeforeDocuments

Type: string | null

Дни (до предоставления документов) - рабочие/календарные

Example: example

delayAfterDocuments

Type: integer | null

Отсрочка, дней (после предоставления документов)

delayBeforeDocuments

Type: integer | null

Отсрочка, дней (до предоставления документов)
Example
{
  "daysTypeAfterDocuments": "example",
  "daysTypeBeforeDocuments": "example",
  "delayAfterDocuments": 0,
  "delayBeforeDocuments": 0
}

OrdersV0TransferOrderCreateAdditionalConditions

Name

Description

additionalComment

Type: string | null

Комментарий

Example: example

currency

Type: string | null

Валюта (селектор)

Example: example

documentsDelay
Any of 2 types

  • Type: OrdersV0TransferOrderCreateDocumentsDelay

    Example
    {
  "daysTypeAfterDocuments": "example",
  "daysTypeBeforeDocuments": "example",
  "delayAfterDocuments": 0,
  "delayBeforeDocuments": 0
}

  • Type: object | null

    Const: null

    Example
    {}

Отсрочка документов

Example
{
  "daysTypeAfterDocuments": "example",
  "daysTypeBeforeDocuments": "example",
  "delayAfterDocuments": 0,
  "delayBeforeDocuments": 0
}

emails

Type: string[] | null

Электронная почта (массив для поддержки кнопок + и удалить)

Example
[
  "example"
]

externalOrderID

Type: string | null

Идентификатор заказа во внешней системе

Example: example

fullName

Type: string | null

ФИО

Example: example

isVatPayer

Type: boolean | null

Является ли плательщиком НДС

phones

Type: string[] | null

Телефон (массив для поддержки кнопок + и удалить)

Example
[
  "example"
]

price

Type: number | null

Стоимость без НДС

priceComment

Type: string | null

Комментарий к цене

Example: example

priceWithVat

Type: number | null

Стоимость с НДС

specifyConditions

Type: boolean | null

Указать условия (переключатель/тумблер)

vat

Type: number | null

НДС
Example
{
  "additionalComment": "example",
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "emails": [
    "example"
  ],
  "externalOrderID": "example",
  "fullName": "example",
  "isVatPayer": true,
  "phones": [
    "example"
  ],
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "specifyConditions": true,
  "vat": 0.5
}

OrdersV0TransferOrderCreateAgreementRules

Name

Description

isDriverCanChangePackagesWithoutApproval

Type: boolean

Может ли водитель менять места в заказе без согласования

isExecutorCanChangePackagesWithoutApproval

Type: boolean

Может ли исполнитель менять места в заказе без согласования

isExecutorCanChangeShipmentsWithoutApproval

Type: boolean

Может ли исполнитель менять грузы в заказе без согласования

isForwarderCanChangePackagesWithoutApproval

Type: boolean

Может ли заказчик менять места в заказе без согласования

isForwarderCanChangeShipmentsWithoutApproval

Type: boolean

Может ли заказчик менять грузы в заказе без согласования

isWarehouseCanChangePackagesWithoutApproval

Type: boolean

Может ли склад менять места в заказе без согласования
Example
{
  "isDriverCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangeShipmentsWithoutApproval": true,
  "isForwarderCanChangePackagesWithoutApproval": true,
  "isForwarderCanChangeShipmentsWithoutApproval": true,
  "isWarehouseCanChangePackagesWithoutApproval": true
}

TimestampTZInput

Name

Description

displayTZ

Type: string

Example: +03:00

time

Type: string<date-time>

Example: 2020-01-01T11:47:38+03:00

useLocation

Type: string

Example: +05:00
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

OrdersV0TransferOrderCreateTariffMatrixInfo

Name

Description

tariffMatrixId

Type: string

Идентификатор Тарифной матрицы

Example: example
Example
{
  "tariffMatrixId": "example"
}

OrdersV0TransferOrderCreateTariffMatrixParams

Name

Description

isWhoFirst

Type: boolean

Торговля по принципу кто первый

tariffMatrixIds

Type: OrdersV0TransferOrderCreateTariffMatrixInfo[] | null

Параметры тарифных матриц

Example
[
  {
    "tariffMatrixId": "example"
  }
]
Example
{
  "isWhoFirst": true,
  "tariffMatrixIds": [
    {
      "tariffMatrixId": "example"
    }
  ]
}

OrdersV0TransferOrderCreateAuction

Name

Description

allowMultimodal

Type: boolean

Разрешить мультимодальные

auctionType

Type: string

тип торгов

Example: example

autoExtension

Type: boolean

Автопродление

autoExtensionActive

Type: integer

Время Активации автопродления в сеуундах

autoExtensionDuration

Type: integer

Максимальное длительность продления в секундах

autoExtensionTime

Type: integer

Время продления в секундах

autoSelection

Type: boolean

Автовыбор

bargainingIsPossible

Type: boolean

торг возможен

decreaseOnly

Type: boolean

Только на понижение

decreaseOnlyFromDeclaredPrice

Type: boolean

Только на понижение от заданной цены

duration

Type: integer

Длительность торгов в секундах

hideBidsFromCarrier

Type: boolean

Скрывать ставки от исполнителя

useTariffMatrix

Type: boolean

Торги Тарифная матрица

vatInPriceNotConsider

Type: boolean

без учёта НДС (depricated: более не используется, значение используемое в ставка true)

bidStep

Type: number | null

Шаг торгов

buyNowPrice

Type: number | null

«Buy now» (input - число)

endDate
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Дата окончания

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

startDate
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Дата начала (опциональное)

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

tariffMatrixParams
Any of 2 types

Параметры Тарифной матрицы

Example
{
  "isWhoFirst": true,
  "tariffMatrixIds": [
    {
      "tariffMatrixId": "example"
    }
  ]
}

vat

Type: number | null

НДС Distribution.amount (опциональное)
Example
{
  "allowMultimodal": true,
  "auctionType": "example",
  "autoExtension": true,
  "autoExtensionActive": 0,
  "autoExtensionDuration": 0,
  "autoExtensionTime": 0,
  "autoSelection": true,
  "bargainingIsPossible": true,
  "bidStep": 0.5,
  "buyNowPrice": 0.5,
  "decreaseOnly": true,
  "decreaseOnlyFromDeclaredPrice": true,
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "hideBidsFromCarrier": true,
  "startDate": null,
  "tariffMatrixParams": {
    "isWhoFirst": true,
    "tariffMatrixIds": [
      {
        "tariffMatrixId": "example"
      }
    ]
  },
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatInPriceNotConsider": true
}

OrdersV0TransferOrderCreateCargoCategory

Name

Description

category

Type: string

Тип груза.

Example: example

categoryComment

Type: string | null

Коментарий к типу груза.

Example: example
Example
{
  "category": "example",
  "categoryComment": "example"
}

OrdersV0TransferOrderCreateCustomer

Name

Description

customerAddress

Type: string

адрес заказчика

Example: example

customerComment

Type: string

Комментарий заказчика

Example: example

customerCountry

Type: string

страна заказчика

Example: example

customerForwarderId

Type: string

Идентификатор организации владельца груза в роли заказчика

Example: example

customerLegalForm

Type: string

юридическая форма организации (OOO,ИП др)

Example: example

customerName

Type: string

Имя контактного лица заказчика перевозки.

Example: example

customerPhone

Type: string

Телефон контактного лица заказчика перевозки.

Example: example

customerTin

Type: string

ИНН / БИН или другой уникальный налоговый номер
компании - заказчика перевозки.

Example: example

customerCargoPrice

Type: number | null

стоимость груза в блоке заказчика
Example
{
  "customerAddress": "example",
  "customerCargoPrice": 0.5,
  "customerComment": "example",
  "customerCountry": "example",
  "customerForwarderId": "example",
  "customerLegalForm": "example",
  "customerName": "example",
  "customerPhone": "example",
  "customerTin": "example"
}

OrdersV0TransferOrderCreateDimensions

Name

Description

breadth

Type: number | null

Ширина с точностью до 2х знактов.

height

Type: number | null

Высота с точностью до 2х знактов.

length

Type: number | null

Длина с точностью до 2х знактов.

palletCount

Type: integer | null

Количество палет.

volume

Type: number | null

Объём с точностью до 3х знактов.

weight

Type: number | null

Вес в КГ.
Example
{
  "breadth": 0.5,
  "height": 0.5,
  "length": 0.5,
  "palletCount": 0,
  "volume": 0.5,
  "weight": 0.5
}

OrdersV0TransferOrderCreatePartner

Name

Description

id

Type: string

Example: example

tin

Type: string

Example: example
Example
{
  "id": "example",
  "tin": "example"
}

OrdersV0TransferOrderCreateDistribution

Name

Description

comment

Type: string

Комментарий, например, "какие-то условия"

Example: example

currency

Type: string

Валюта, например, "rub"

Example: example

dayDocClose

Type: integer

-- deadlineDocumentCalendarDay если typeDocClose = calendar
deadlineDocumentWorkDay если typeDocClose = work

dayDocDelay

Type: integer

-- deferredPaymentCalendarDay если typeDocDelay = calendar
deferredPaymentWorkDay если typeDocDelay = work

docFormat

Type: string

формат предоставления

Example: example

publicMatcher

Type: boolean

открытый аукцион или нет

type

Type: string

Тип определения исполнителя, например, "Отправить в свои заказы"

Example: example

typeDocClose

Type: string

Тип дней для "Острочка предоставления закрывающих документов"

Example: example

typeDocDelay

Type: string

Тип дней для "Отстрочка на оплату после предоставления закрывающих документов"

Example: example

amount

Type: number | null

Заявленная стоимость торгов ( Сумма, например, 123)

groupsId

Type: string[] | null

Группы, связанные с определением исполнителя (пока неизвестно, что конкретно будет в этом массиве)

Example
[
  "example"
]

partners

Type: OrdersV0TransferOrderCreatePartner[] | null

Исполнители

Example
[
  {
    "id": "example",
    "tin": "example"
  }
]
Example
{
  "amount": 0.5,
  "comment": "example",
  "currency": "example",
  "dayDocClose": 0,
  "dayDocDelay": 0,
  "docFormat": "example",
  "groupsId": [
    "example"
  ],
  "partners": [
    {
      "id": "example",
      "tin": "example"
    }
  ],
  "publicMatcher": true,
  "type": "example",
  "typeDocClose": "example",
  "typeDocDelay": "example"
}

OrdersV0TransferOrderCreateDriverAssignmentDeadline

Name

Description

duration

Type: integer | null

endDate
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}
Example
{
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  }
}

OrdersV0TransferOrderCreateExecutionSettings

Name

Description

driverAssignmentDeadline
Any of 2 types

Срок на назначение водителя и ТС в секундах или по дате

Example
{
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  }
}
Example
{
  "driverAssignmentDeadline": {
    "duration": 0,
    "endDate": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    }
  }
}

OrdersV0TransferOrderCreateCar

Name

Description

id

Type: string | null

Идентификатор

Example: example

version

Type: integer | null

Версия
Example
{
  "id": "example",
  "version": 0
}

OrdersV0TransferOrderCreateCompanyInfo

Name

Description

companyName

Type: string | null

Название компании

Example: example

companyType

Type: string | null

Тип компании

Example: example

country

Type: string | null

Страна

Example: example

email

Type: string | null

Почта

Example: example

fullName

Type: string | null

Полное наименование

Example: example

phone

Type: string | null

Телефон

Example: example

tin

Type: string | null

ИНН

Example: example
Example
{
  "companyName": "example",
  "companyType": "example",
  "country": "example",
  "email": "example",
  "fullName": "example",
  "phone": "example",
  "tin": "example"
}

OrdersV0TransferOrderCreateFlightCreator

Name

Description

car
Any of 2 types

Информация об автомобиле

Example
{
  "id": "example",
  "version": 0
}

comment

Type: string | null

Поле комментария

Example: example

companyInfo
Any of 2 types

  • Type: OrdersV0TransferOrderCreateCompanyInfo

    Example
    {
  "companyName": "example",
  "companyType": "example",
  "country": "example",
  "email": "example",
  "fullName": "example",
  "phone": "example",
  "tin": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

Информация о компании

Example
{
  "companyName": "example",
  "companyType": "example",
  "country": "example",
  "email": "example",
  "fullName": "example",
  "phone": "example",
  "tin": "example"
}

currency

Type: string | null

Валюта (селектор)

Example: example

documentsDelay
Any of 2 types

  • Type: OrdersV0TransferOrderCreateDocumentsDelay

    Example
    {
  "daysTypeAfterDocuments": "example",
  "daysTypeBeforeDocuments": "example",
  "delayAfterDocuments": 0,
  "delayBeforeDocuments": 0
}

  • Type: object | null

    Const: null

    Example
    {}

Отсрочка документов

Example
{
  "daysTypeAfterDocuments": "example",
  "daysTypeBeforeDocuments": "example",
  "delayAfterDocuments": 0,
  "delayBeforeDocuments": 0
}

driver
Any of 2 types

Информация о водителе

Example
{
  "id": "example",
  "version": 0
}

externalFlightID

Type: string | null

Внешний идентификатор рейса

Example: example

flightName

Type: string | null

Название рейса

Example: example

isVatPayer

Type: boolean | null

Является ли плательщиком НДС

price

Type: number | null

Стоимость без НДС

priceComment

Type: string | null

Комментарий к цене

Example: example

priceWithVat

Type: number | null

Стоимость с НДС

trailer
Any of 2 types

Информация о прицепе

Example
{
  "id": "example",
  "version": 0
}

vat

Type: number | null

НДС

willNotCarryMyself

Type: boolean | null

Переключатель "Не буду везти сам"
Example
{
  "car": {
    "id": "example",
    "version": 0
  },
  "comment": "example",
  "companyInfo": {
    "companyName": "example",
    "companyType": "example",
    "country": "example",
    "email": "example",
    "fullName": "example",
    "phone": "example",
    "tin": "example"
  },
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "driver": {
    "id": "example",
    "version": 0
  },
  "externalFlightID": "example",
  "flightName": "example",
  "isVatPayer": true,
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "trailer": {
    "id": "example",
    "version": 0
  },
  "vat": 0.5,
  "willNotCarryMyself": true
}

OrdersV0TransferOrderCreateForwarder

Name

Description

forwarderId

Type: string

Идентификатор заказчика в сервисе Яндекс Магистрали

Example: example

forwarderComment

Type: string | null

Комментарий заказчика

Example: example

forwarderName

Type: string | null

Название организации заказчика

Example: example

forwarderTin

Type: string | null

ИНН заказчика

Example: example
Example
{
  "forwarderComment": "example",
  "forwarderId": "example",
  "forwarderName": "example",
  "forwarderTin": "example"
}

MapStringString

Объект со строковыми значениями

Name

Description

[additional]

Type: string

Example: example
Example
{}

OrdersV0TransferOrderCreateConditions

Name

Description

conditionsTemplateId

Type: string

Example: example

conditionsTemplateType

Type: string

Example: example

conditionsTemplateVersion

Type: string

Example: example

executorId

Type: string | null

Example: example

variables
Any of 2 types

  • Type: MapStringString

    Объект со строковыми значениями

    Example
    {}

  • Type: object | null

    Const: null

    Example
    {}
Example
{}
Example
{
  "conditionsTemplateId": "example",
  "conditionsTemplateType": "example",
  "conditionsTemplateVersion": "example",
  "executorId": "example",
  "variables": {}
}

OrdersV0TransferOrderCreateMeta

Name

Description

conditions

Type: OrdersV0TransferOrderCreateConditions[] | null

Example
[
  {
    "conditionsTemplateId": "example",
    "conditionsTemplateType": "example",
    "conditionsTemplateVersion": "example",
    "executorId": "example",
    "variables": {}
  }
]
Example
{
  "conditions": [
    {
      "conditionsTemplateId": "example",
      "conditionsTemplateType": "example",
      "conditionsTemplateVersion": "example",
      "executorId": "example",
      "variables": {}
    }
  ]
}

OrdersV0TransferOrderCreatePaymentDelayPeriod

Name

Description

paymentType

Type: string

Тип оплаты.

Example: example

daysDelayPeriod

Type: integer | null

Количество дней отсрочки платяжа.

postPayCalendarType

Type: string | null

Тип постоплаты.

Example: example
Example
{
  "daysDelayPeriod": 0,
  "paymentType": "example",
  "postPayCalendarType": "example"
}

OrdersV0TransferOrderCreateNodalPointAdditionalContact

Name

Description

npcName

Type: string

Имя контактного лица.

Example: example

npcPhone

Type: string

Телефон контактного лица.

Example: example

npcCountry

Type: string | null

Страна контактного лица.

Example: example

npcEmail

Type: string | null

Электронные адреса контактного лица.

Example: example

npcExternalId

Type: string | null

Идентификатор контакта в системе клиента.

Example: example
Example
{
  "npcCountry": "example",
  "npcEmail": "example",
  "npcExternalId": "example",
  "npcName": "example",
  "npcPhone": "example"
}

OrdersV0TransferOrderCreateAddress

Name

Description

address

Type: string

@address адрес, например Калужское шоссе, 22-й километр, 10

Example: example

countryCode

Type: string

@countryCode код страны

Example: example

lat

Type: number

@lat широта

lon

Type: number

@lon долгота

accuracy

Type: string | null

@accuracy уровень точности

Example: example

area

Type: string | null

@area район

Example: example

displayAddress

Type: string | null

@display_address адрес для основного отображения, например Фудсити, или Москва, ул. Медиков, д 18

Example: example

geoData

Type: string | null

Ответ геокодера или иной системы

Example: example

house

Type: string | null

@house дом

Example: example

locality

Type: string | null

@locality город

Example: example

postalCode

Type: string | null

@postalCode почтовый индекс

Example: example

province

Type: string | null

@province провинция

Example: example

regionCode

Type: string | null

@regionCode код региона

Example: example

street

Type: string | null

@street улица

Example: example
Example
{
  "accuracy": "example",
  "address": "example",
  "area": "example",
  "countryCode": "example",
  "displayAddress": "example",
  "geoData": "example",
  "house": "example",
  "lat": 0.5,
  "locality": "example",
  "lon": 0.5,
  "postalCode": "example",
  "province": "example",
  "regionCode": "example",
  "street": "example"
}

OrdersV0TransferOrderCreateNpAddress

Name

Description

address

Type: string | null

Обязательно к заполнению, если не заполнено поле npAddress

Example: example

lat

Type: number | null

Обязательно к заполнению, если не заполнено поле npAddress

long

Type: number | null

Обязательно к заполнению, если не заполнено поле npAddress

npAddress
Any of 2 types

  • Type: OrdersV0TransferOrderCreateAddress

    Example
    {
  "accuracy": "example",
  "address": "example",
  "area": "example",
  "countryCode": "example",
  "displayAddress": "example",
  "geoData": "example",
  "house": "example",
  "lat": 0.5,
  "locality": "example",
  "lon": 0.5,
  "postalCode": "example",
  "province": "example",
  "regionCode": "example",
  "street": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

Обязательно к заполнению, если не заполнены поля lat, lon, address

Example
{
  "accuracy": "example",
  "address": "example",
  "area": "example",
  "countryCode": "example",
  "displayAddress": "example",
  "geoData": "example",
  "house": "example",
  "lat": 0.5,
  "locality": "example",
  "lon": 0.5,
  "postalCode": "example",
  "province": "example",
  "regionCode": "example",
  "street": "example"
}
Example
{
  "address": "example",
  "lat": 0.5,
  "long": 0.5,
  "npAddress": {
    "accuracy": "example",
    "address": "example",
    "area": "example",
    "countryCode": "example",
    "displayAddress": "example",
    "geoData": "example",
    "house": "example",
    "lat": 0.5,
    "locality": "example",
    "lon": 0.5,
    "postalCode": "example",
    "province": "example",
    "regionCode": "example",
    "street": "example"
  }
}

OrdersV0TransferOrderCreateNodalPointShipmentPeriod

Name

Description

from

Type: TimestampTZInput

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

loadingTime

Type: integer | null

to
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}
Example
{
  "from": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "loadingTime": 0,
  "to": null
}

OrdersV0TransferOrderCreateNodalPointShipment

Name

Description

country

Type: string

Страна разгрузки/погрузки.

Example: example

npGeoAddress
All of 1 type

  • Type: OrdersV0TransferOrderCreateNpAddress

    Example
    {
  "address": "example",
  "lat": 0.5,
  "long": 0.5,
  "npAddress": {
    "accuracy": "example",
    "address": "example",
    "area": "example",
    "countryCode": "example",
    "displayAddress": "example",
    "geoData": "example",
    "house": "example",
    "lat": 0.5,
    "locality": "example",
    "lon": 0.5,
    "postalCode": "example",
    "province": "example",
    "regionCode": "example",
    "street": "example"
  }
}

Геоадрес разгрузки/погрузки.

Example
{
  "address": "example",
  "lat": 0.5,
  "long": 0.5,
  "npAddress": {
    "accuracy": "example",
    "address": "example",
    "area": "example",
    "countryCode": "example",
    "displayAddress": "example",
    "geoData": "example",
    "house": "example",
    "lat": 0.5,
    "locality": "example",
    "lon": 0.5,
    "postalCode": "example",
    "province": "example",
    "regionCode": "example",
    "street": "example"
  }
}

period
All of 1 type

Дата и время разгрузки/погрузки.Приходит или Date или Period
Период разгрузки/погрузки. если в периоде, не заполнено поле to, то считаем не периодом, а точной датой

Example
{
  "from": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "loadingTime": 0,
  "to": null
}

position

Type: integer

очередь разгрузки/погрузки.

addressComment

Type: string | null

Комментарий к адресу (до 1000 символов)

Example: example

content

Type: string | null

Содержимое разгрузки/погрузки.

Example: example

id

Type: string | null

Example: example

legalAddress

Type: string | null

юридический адрес компании которая производит разгрузку/погрузку. deprecated. use npGeoLegalAddress

Example: example

legalPhone

Type: string | null

Example: example

name

Type: string | null

Название разгрузки/погрузки.

Example: example

npAdditionalContact

Type: OrdersV0TransferOrderCreateNodalPointAdditionalContact[] | null

Дополнительные контакты разгрузки/погрузки.

Example
[
  {
    "npcCountry": "example",
    "npcEmail": "example",
    "npcExternalId": "example",
    "npcName": "example",
    "npcPhone": "example"
  }
]

npGeoLegalAddress
Any of 2 types

  • Type: OrdersV0TransferOrderCreateNpAddress

    Example
    {
  "address": "example",
  "lat": 0.5,
  "long": 0.5,
  "npAddress": {
    "accuracy": "example",
    "address": "example",
    "area": "example",
    "countryCode": "example",
    "displayAddress": "example",
    "geoData": "example",
    "house": "example",
    "lat": 0.5,
    "locality": "example",
    "lon": 0.5,
    "postalCode": "example",
    "province": "example",
    "regionCode": "example",
    "street": "example"
  }
}

  • Type: object | null

    Const: null

    Example
    {}

Юридический Геоадрес разгрузки/погрузки.

Example
{
  "address": "example",
  "lat": 0.5,
  "long": 0.5,
  "npAddress": {
    "accuracy": "example",
    "address": "example",
    "area": "example",
    "countryCode": "example",
    "displayAddress": "example",
    "geoData": "example",
    "house": "example",
    "lat": 0.5,
    "locality": "example",
    "lon": 0.5,
    "postalCode": "example",
    "province": "example",
    "regionCode": "example",
    "street": "example"
  }
}

npLegalType

Type: string | null

Юридический тип разгрузки/погрузки.

Example: example

npShipmentId

Type: string | null

Идентификатор разгрузки/погрузки.

Example: example

npTin

Type: string | null

ИНН разгрузки/погрузки.

Example: example

phoneCountryCode

Type: string | null

Идентификатор страны компании которая производит разгрузку/погрузку

Example: example

sequenceOrder

Type: integer | null

transshipmentTypes

Type: string[] | null

Example
[
  "example"
]
Example
{
  "addressComment": "example",
  "content": "example",
  "country": "example",
  "id": "example",
  "legalAddress": "example",
  "legalPhone": "example",
  "name": "example",
  "npAdditionalContact": [
    {
      "npcCountry": "example",
      "npcEmail": "example",
      "npcExternalId": "example",
      "npcName": "example",
      "npcPhone": "example"
    }
  ],
  "npGeoAddress": {
    "address": "example",
    "lat": 0.5,
    "long": 0.5,
    "npAddress": {
      "accuracy": "example",
      "address": "example",
      "area": "example",
      "countryCode": "example",
      "displayAddress": "example",
      "geoData": "example",
      "house": "example",
      "lat": 0.5,
      "locality": "example",
      "lon": 0.5,
      "postalCode": "example",
      "province": "example",
      "regionCode": "example",
      "street": "example"
    }
  },
  "npGeoLegalAddress": null,
  "npLegalType": "example",
  "npShipmentId": "example",
  "npTin": "example",
  "period": {
    "from": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    },
    "loadingTime": 0,
    "to": null
  },
  "phoneCountryCode": "example",
  "position": 0,
  "sequenceOrder": 0,
  "transshipmentTypes": [
    "example"
  ]
}

OrdersV0TransferOrderCreatePackageCargoInsurance

Name

Description

cargoInsuranceProductId

Type: string

Идентификатор продукта страхования груза

Example: example

insuranceOrganizationId

Type: string

Идентификатор страховой организации

Example: example

packageName

Type: string

Наименование товара для страховой организации

Example: example

totalAmount

Type: number

Общая стоимость товара для страховой организации

cargoInsuranceSubProductIds

Type: string[] | null

Идентификаторы подпродуктов cтрахования груза

Example
[
  "example"
]

comment

Type: string | null

Комментарий

Example: example

transportationType

Type: string[] | null

Виды перевозки

Example
[
  "example"
]
Example
{
  "cargoInsuranceProductId": "example",
  "cargoInsuranceSubProductIds": [
    "example"
  ],
  "comment": "example",
  "insuranceOrganizationId": "example",
  "packageName": "example",
  "totalAmount": 0.5,
  "transportationType": [
    "example"
  ]
}

OrdersV0TransferOrderCreateDangerousCargo

Name

Description

hazardClass

Type: string

Example: example

classificationCode

Type: string | null

Example: example

competentAuthoritySign

Type: string | null

Example: example

controlTemperature

Type: string | null

Example: example

description

Type: string | null

Example: example

emergencyTemperature

Type: string | null

Example: example

explosiveNetMass

Type: string | null

Example: example

explosiveNetMassTotal

Type: string | null

Example: example

hazardLabel

Type: string | null

Example: example

holdTimeExpiryDate

Type: string | null

Example: 2006-01-02T00:00:00Z

maxActivity

Type: string | null

Example: example

mixtureCompositionPercent

Type: string | null

Example: example

packageCategory

Type: string | null

Example: example

packingGroup

Type: string | null

Example: example

physicalChemicalDescription

Type: string | null

Example: example

properShippingName

Type: string | null

Example: example

radionuclideName

Type: string | null

Example: example

regulatoryAct

Type: string | null

Example: example

safetyIndex

Type: string | null

Example: example

technicalName

Type: string | null

Example: example

totalActivity

Type: string | null

Example: example

transportIndex

Type: string | null

Example: example

tunnelRestrictionCode

Type: string | null

Example: example

unHazardId

Type: string | null

Example: example
Example
{
  "classificationCode": "example",
  "competentAuthoritySign": "example",
  "controlTemperature": "example",
  "description": "example",
  "emergencyTemperature": "example",
  "explosiveNetMass": "example",
  "explosiveNetMassTotal": "example",
  "hazardClass": "example",
  "hazardLabel": "example",
  "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
  "maxActivity": "example",
  "mixtureCompositionPercent": "example",
  "packageCategory": "example",
  "packingGroup": "example",
  "physicalChemicalDescription": "example",
  "properShippingName": "example",
  "radionuclideName": "example",
  "regulatoryAct": "example",
  "safetyIndex": "example",
  "technicalName": "example",
  "totalActivity": "example",
  "transportIndex": "example",
  "tunnelRestrictionCode": "example",
  "unHazardId": "example"
}

OrdersV0TransferOrderCreatePackagesRuEdo

Name

Description

cargoState

Type: string | null

состояние груза

Example: example

codeToVNom

Type: string | null

код товарной номенклатуры

Example: example

dangerousCargo
Any of 2 types

  • Type: OrdersV0TransferOrderCreateDangerousCargo

    Example
    {
  "classificationCode": "example",
  "competentAuthoritySign": "example",
  "controlTemperature": "example",
  "description": "example",
  "emergencyTemperature": "example",
  "explosiveNetMass": "example",
  "explosiveNetMassTotal": "example",
  "hazardClass": "example",
  "hazardLabel": "example",
  "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
  "maxActivity": "example",
  "mixtureCompositionPercent": "example",
  "packageCategory": "example",
  "packingGroup": "example",
  "physicalChemicalDescription": "example",
  "properShippingName": "example",
  "radionuclideName": "example",
  "regulatoryAct": "example",
  "safetyIndex": "example",
  "technicalName": "example",
  "totalActivity": "example",
  "transportIndex": "example",
  "tunnelRestrictionCode": "example",
  "unHazardId": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

сведения об опасном грузе

Example
{
  "classificationCode": "example",
  "competentAuthoritySign": "example",
  "controlTemperature": "example",
  "description": "example",
  "emergencyTemperature": "example",
  "explosiveNetMass": "example",
  "explosiveNetMassTotal": "example",
  "hazardClass": "example",
  "hazardLabel": "example",
  "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
  "maxActivity": "example",
  "mixtureCompositionPercent": "example",
  "packageCategory": "example",
  "packingGroup": "example",
  "physicalChemicalDescription": "example",
  "properShippingName": "example",
  "radionuclideName": "example",
  "regulatoryAct": "example",
  "safetyIndex": "example",
  "technicalName": "example",
  "totalActivity": "example",
  "transportIndex": "example",
  "tunnelRestrictionCode": "example",
  "unHazardId": "example"
}

mark

Type: string[] | null

маркировка

Example
[
  "example"
]

pkgType

Type: string | null

тип упаковки

Example: example
Example
{
  "cargoState": "example",
  "codeToVNom": "example",
  "dangerousCargo": {
    "classificationCode": "example",
    "competentAuthoritySign": "example",
    "controlTemperature": "example",
    "description": "example",
    "emergencyTemperature": "example",
    "explosiveNetMass": "example",
    "explosiveNetMassTotal": "example",
    "hazardClass": "example",
    "hazardLabel": "example",
    "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
    "maxActivity": "example",
    "mixtureCompositionPercent": "example",
    "packageCategory": "example",
    "packingGroup": "example",
    "physicalChemicalDescription": "example",
    "properShippingName": "example",
    "radionuclideName": "example",
    "regulatoryAct": "example",
    "safetyIndex": "example",
    "technicalName": "example",
    "totalActivity": "example",
    "transportIndex": "example",
    "tunnelRestrictionCode": "example",
    "unHazardId": "example"
  },
  "mark": [
    "example"
  ],
  "pkgType": "example"
}

OrdersV0TransferOrderCreateTemperatureRegime

Name

Description

from

Type: integer

Температура градусов в цельсиях, минимум.

to

Type: integer

Температура градусов в цельсиях, максимум.

label

Type: string | null

Метка температурного режима.

Example: example
Example
{
  "from": 0,
  "label": "example",
  "to": 0
}

OrdersV0TransferOrderCreatePackagesCreate

Name

Description

count

Type: integer

Количество

hazardClass

Type: string

класс опасности

Example: example

stackability

Type: string

стакающийся?

Example: example

amount

Type: number | null

Объявленная стоимость

capacity

Type: number | null

Объем

cargoCategory
Any of 2 types
Example
{
  "category": "example",
  "categoryComment": "example"
}

cargoInsurance
Any of 2 types

  • Type: OrdersV0TransferOrderCreatePackageCargoInsurance

    Example
    {
  "cargoInsuranceProductId": "example",
  "cargoInsuranceSubProductIds": [
    "example"
  ],
  "comment": "example",
  "insuranceOrganizationId": "example",
  "packageName": "example",
  "totalAmount": 0.5,
  "transportationType": [
    "example"
  ]
}

  • Type: object | null

    Const: null

    Example
    {}

Данные для страхования груза

Example
{
  "cargoInsuranceProductId": "example",
  "cargoInsuranceSubProductIds": [
    "example"
  ],
  "comment": "example",
  "insuranceOrganizationId": "example",
  "packageName": "example",
  "totalAmount": 0.5,
  "transportationType": [
    "example"
  ]
}

comment

Type: string | null

Example: example

currency

Type: string | null

Валюта

Example: example

dimensionHeight

Type: number | null

dimensionLength

Type: number | null

dimensionWeight

Type: number | null

packageExternalId

Type: string | null

Идентификатор единицы товара со стороны заказчика.

Example: example

packageName

Type: string | null

Отображаемое имя единицы товара.

Example: example

ruEdo
Any of 2 types

  • Type: OrdersV0TransferOrderCreatePackagesRuEdo

    Example
    {
  "cargoState": "example",
  "codeToVNom": "example",
  "dangerousCargo": {
    "classificationCode": "example",
    "competentAuthoritySign": "example",
    "controlTemperature": "example",
    "description": "example",
    "emergencyTemperature": "example",
    "explosiveNetMass": "example",
    "explosiveNetMassTotal": "example",
    "hazardClass": "example",
    "hazardLabel": "example",
    "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
    "maxActivity": "example",
    "mixtureCompositionPercent": "example",
    "packageCategory": "example",
    "packingGroup": "example",
    "physicalChemicalDescription": "example",
    "properShippingName": "example",
    "radionuclideName": "example",
    "regulatoryAct": "example",
    "safetyIndex": "example",
    "technicalName": "example",
    "totalActivity": "example",
    "transportIndex": "example",
    "tunnelRestrictionCode": "example",
    "unHazardId": "example"
  },
  "mark": [
    "example"
  ],
  "pkgType": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

Данные для Российского ЭДО

Example
{
  "cargoState": "example",
  "codeToVNom": "example",
  "dangerousCargo": {
    "classificationCode": "example",
    "competentAuthoritySign": "example",
    "controlTemperature": "example",
    "description": "example",
    "emergencyTemperature": "example",
    "explosiveNetMass": "example",
    "explosiveNetMassTotal": "example",
    "hazardClass": "example",
    "hazardLabel": "example",
    "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
    "maxActivity": "example",
    "mixtureCompositionPercent": "example",
    "packageCategory": "example",
    "packingGroup": "example",
    "physicalChemicalDescription": "example",
    "properShippingName": "example",
    "radionuclideName": "example",
    "regulatoryAct": "example",
    "safetyIndex": "example",
    "technicalName": "example",
    "totalActivity": "example",
    "transportIndex": "example",
    "tunnelRestrictionCode": "example",
    "unHazardId": "example"
  },
  "mark": [
    "example"
  ],
  "pkgType": "example"
}

shipmentBodyType

Type: string | null

Тип упаковки груза.

Example: example

temperatureRegime

Type: OrdersV0TransferOrderCreateTemperatureRegime[] | null

Example
[
  {
    "from": 0,
    "label": "example",
    "to": 0
  }
]

weight

Type: number | null

Вес
Example
{
  "amount": 0.5,
  "capacity": 0.5,
  "cargoCategory": {
    "category": "example",
    "categoryComment": "example"
  },
  "cargoInsurance": {
    "cargoInsuranceProductId": "example",
    "cargoInsuranceSubProductIds": [
      "example"
    ],
    "comment": "example",
    "insuranceOrganizationId": "example",
    "packageName": "example",
    "totalAmount": 0.5,
    "transportationType": [
      "example"
    ]
  },
  "comment": "example",
  "count": 0,
  "currency": "example",
  "dimensionHeight": 0.5,
  "dimensionLength": 0.5,
  "dimensionWeight": 0.5,
  "hazardClass": "example",
  "packageExternalId": "example",
  "packageName": "example",
  "ruEdo": {
    "cargoState": "example",
    "codeToVNom": "example",
    "dangerousCargo": {
      "classificationCode": "example",
      "competentAuthoritySign": "example",
      "controlTemperature": "example",
      "description": "example",
      "emergencyTemperature": "example",
      "explosiveNetMass": "example",
      "explosiveNetMassTotal": "example",
      "hazardClass": "example",
      "hazardLabel": "example",
      "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
      "maxActivity": "example",
      "mixtureCompositionPercent": "example",
      "packageCategory": "example",
      "packingGroup": "example",
      "physicalChemicalDescription": "example",
      "properShippingName": "example",
      "radionuclideName": "example",
      "regulatoryAct": "example",
      "safetyIndex": "example",
      "technicalName": "example",
      "totalActivity": "example",
      "transportIndex": "example",
      "tunnelRestrictionCode": "example",
      "unHazardId": "example"
    },
    "mark": [
      "example"
    ],
    "pkgType": "example"
  },
  "shipmentBodyType": "example",
  "stackability": "example",
  "temperatureRegime": [
    {
      "from": 0,
      "label": "example",
      "to": 0
    }
  ],
  "weight": 0.5
}

OrdersV0TransferOrderCreateShipmentCreate

Name

Description

npShipment
All of 1 type

  • Type: OrdersV0TransferOrderCreateNodalPointShipment

    Example
    {
  "addressComment": "example",
  "content": "example",
  "country": "example",
  "id": "example",
  "legalAddress": "example",
  "legalPhone": "example",
  "name": "example",
  "npAdditionalContact": [
    {
      "npcCountry": "example",
      "npcEmail": "example",
      "npcExternalId": "example",
      "npcName": "example",
      "npcPhone": "example"
    }
  ],
  "npGeoAddress": {
    "address": "example",
    "lat": 0.5,
    "long": 0.5,
    "npAddress": {
      "accuracy": "example",
      "address": "example",
      "area": "example",
      "countryCode": "example",
      "displayAddress": "example",
      "geoData": "example",
      "house": "example",
      "lat": 0.5,
      "locality": "example",
      "lon": 0.5,
      "postalCode": "example",
      "province": "example",
      "regionCode": "example",
      "street": "example"
    }
  },
  "npGeoLegalAddress": null,
  "npLegalType": "example",
  "npShipmentId": "example",
  "npTin": "example",
  "period": {
    "from": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    },
    "loadingTime": 0,
    "to": null
  },
  "phoneCountryCode": "example",
  "position": 0,
  "sequenceOrder": 0,
  "transshipmentTypes": [
    "example"
  ]
}

Погрузка

Example
{
  "addressComment": "example",
  "content": "example",
  "country": "example",
  "id": "example",
  "legalAddress": "example",
  "legalPhone": "example",
  "name": "example",
  "npAdditionalContact": [
    {
      "npcCountry": "example",
      "npcEmail": "example",
      "npcExternalId": "example",
      "npcName": "example",
      "npcPhone": "example"
    }
  ],
  "npGeoAddress": {
    "address": "example",
    "lat": 0.5,
    "long": 0.5,
    "npAddress": {}
  },
  "npGeoLegalAddress": null,
  "npLegalType": "example",
  "npShipmentId": "example",
  "npTin": "example",
  "period": {
    "from": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    },
    "loadingTime": 0,
    "to": null
  },
  "phoneCountryCode": "example",
  "position": 0,
  "sequenceOrder": 0,
  "transshipmentTypes": [
    "example"
  ]
}

npUnshipment
All of 1 type

  • Type: OrdersV0TransferOrderCreateNodalPointShipment

    Example
    {
  "addressComment": "example",
  "content": "example",
  "country": "example",
  "id": "example",
  "legalAddress": "example",
  "legalPhone": "example",
  "name": "example",
  "npAdditionalContact": [
    {
      "npcCountry": "example",
      "npcEmail": "example",
      "npcExternalId": "example",
      "npcName": "example",
      "npcPhone": "example"
    }
  ],
  "npGeoAddress": {
    "address": "example",
    "lat": 0.5,
    "long": 0.5,
    "npAddress": {
      "accuracy": "example",
      "address": "example",
      "area": "example",
      "countryCode": "example",
      "displayAddress": "example",
      "geoData": "example",
      "house": "example",
      "lat": 0.5,
      "locality": "example",
      "lon": 0.5,
      "postalCode": "example",
      "province": "example",
      "regionCode": "example",
      "street": "example"
    }
  },
  "npGeoLegalAddress": null,
  "npLegalType": "example",
  "npShipmentId": "example",
  "npTin": "example",
  "period": {
    "from": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    },
    "loadingTime": 0,
    "to": null
  },
  "phoneCountryCode": "example",
  "position": 0,
  "sequenceOrder": 0,
  "transshipmentTypes": [
    "example"
  ]
}

Разгрузка

Example
{
  "addressComment": "example",
  "content": "example",
  "country": "example",
  "id": "example",
  "legalAddress": "example",
  "legalPhone": "example",
  "name": "example",
  "npAdditionalContact": [
    {
      "npcCountry": "example",
      "npcEmail": "example",
      "npcExternalId": "example",
      "npcName": "example",
      "npcPhone": "example"
    }
  ],
  "npGeoAddress": {
    "address": "example",
    "lat": 0.5,
    "long": 0.5,
    "npAddress": {}
  },
  "npGeoLegalAddress": null,
  "npLegalType": "example",
  "npShipmentId": "example",
  "npTin": "example",
  "period": {
    "from": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    },
    "loadingTime": 0,
    "to": null
  },
  "phoneCountryCode": "example",
  "position": 0,
  "sequenceOrder": 0,
  "transshipmentTypes": [
    "example"
  ]
}

packages

Type: OrdersV0TransferOrderCreatePackagesCreate[]

Min items: 1

Example
[
  {
    "amount": 0.5,
    "capacity": 0.5,
    "cargoCategory": {
      "category": "example",
      "categoryComment": "example"
    },
    "cargoInsurance": {
      "cargoInsuranceProductId": "example",
      "cargoInsuranceSubProductIds": [
        "example"
      ],
      "comment": "example",
      "insuranceOrganizationId": "example",
      "packageName": "example",
      "totalAmount": 0.5,
      "transportationType": [
        "example"
      ]
    },
    "comment": "example",
    "count": 0,
    "currency": "example",
    "dimensionHeight": 0.5,
    "dimensionLength": 0.5,
    "dimensionWeight": 0.5,
    "hazardClass": "example",
    "packageExternalId": "example",
    "packageName": "example",
    "ruEdo": {
      "cargoState": "example",
      "codeToVNom": "example",
      "dangerousCargo": {},
      "mark": [
        "example"
      ],
      "pkgType": "example"
    },
    "shipmentBodyType": "example",
    "stackability": "example",
    "temperatureRegime": [
      {
        "from": 0,
        "label": "example",
        "to": 0
      }
    ],
    "weight": 0.5
  }
]

packageType

Type: string

Example: example

comment

Type: string | null

Example: example

distributionPriority

Type: integer | null

name

Type: string | null

Example: example

quantizationMethod

Type: string | null

QuantizationMethod - способ разделения

Example: example

shipmentExternalID

Type: string | null

Название или номер груза заказа в вашей системе нутрений. Не отображается в интерфейсе

Example: example
Example
{
  "comment": "example",
  "distributionPriority": 0,
  "name": "example",
  "npShipment": {
    "addressComment": "example",
    "content": "example",
    "country": "example",
    "id": "example",
    "legalAddress": "example",
    "legalPhone": "example",
    "name": "example",
    "npAdditionalContact": [
      {
        "npcCountry": "example",
        "npcEmail": "example",
        "npcExternalId": "example",
        "npcName": "example",
        "npcPhone": "example"
      }
    ],
    "npGeoAddress": {
      "address": "example",
      "lat": 0.5,
      "long": 0.5,
      "npAddress": null
    },
    "npGeoLegalAddress": null,
    "npLegalType": "example",
    "npShipmentId": "example",
    "npTin": "example",
    "period": {
      "from": {},
      "loadingTime": 0,
      "to": null
    },
    "phoneCountryCode": "example",
    "position": 0,
    "sequenceOrder": 0,
    "transshipmentTypes": [
      "example"
    ]
  },
  "npUnshipment": null,
  "packageType": "example",
  "packages": [
    {
      "amount": 0.5,
      "capacity": 0.5,
      "cargoCategory": {
        "category": "example",
        "categoryComment": "example"
      },
      "cargoInsurance": {
        "cargoInsuranceProductId": "example",
        "cargoInsuranceSubProductIds": [
          null
        ],
        "comment": "example",
        "insuranceOrganizationId": "example",
        "packageName": "example",
        "totalAmount": 0.5,
        "transportationType": [
          null
        ]
      },
      "comment": "example",
      "count": 0,
      "currency": "example",
      "dimensionHeight": 0.5,
      "dimensionLength": 0.5,
      "dimensionWeight": 0.5,
      "hazardClass": "example",
      "packageExternalId": "example",
      "packageName": "example",
      "ruEdo": {
        "cargoState": "example",
        "codeToVNom": "example",
        "dangerousCargo": null,
        "mark": [
          null
        ],
        "pkgType": "example"
      },
      "shipmentBodyType": "example",
      "stackability": "example",
      "temperatureRegime": [
        {
          "from": 0,
          "label": "example",
          "to": 0
        }
      ],
      "weight": 0.5
    }
  ],
  "quantizationMethod": "example",
  "shipmentExternalID": "example"
}

JSONObject

Type: object

Example
{}

OrdersV0TransferOrderCreatePrice

Name

Description

currency

Type: string

Валюта.

Example: example

price

Type: number

Цена с точностью до 2х знаков.
Example
{
  "currency": "example",
  "price": 0.5
}

OrdersV0TransferOrderCreateUTM

Name

Description

utmSource

Type: string

Example: example

utmCampaign

Type: string | null

Example: example

utmContent

Type: string | null

Example: example

utmMedium

Type: string | null

Example: example

utmTerm

Type: string | null

Example: example
Example
{
  "utmCampaign": "example",
  "utmContent": "example",
  "utmMedium": "example",
  "utmSource": "example",
  "utmTerm": "example"
}

OrdersV0TransferOrderCreateVolumeAuction

Name

Description

auctionType

Type: string

Example: example

duration

Type: integer

tarifficationType

Type: string

Example: example

transitDistance

Type: number

endDate
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

flightsCount

Type: number | null

startDate
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

tonsCount

Type: number | null

vehicleCapacityFrom

Type: number | null

vehicleCapacityTo

Type: number | null
Example
{
  "auctionType": "example",
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "flightsCount": 0.5,
  "startDate": null,
  "tarifficationType": "example",
  "tonsCount": 0.5,
  "transitDistance": 0.5,
  "vehicleCapacityFrom": 0.5,
  "vehicleCapacityTo": 0.5
}

OrdersV0TransferOrderCreateRequest

Name

Description

bodyType

Type: string[]

Тип кузова.

Min items: 1

Example
[
  "example"
]

cargoCategory
All of 1 type

Категория груза.

Example
{
  "category": "example",
  "categoryComment": "example"
}

currency

Type: string

Валюта заказа

Example: example

customer
All of 1 type

  • Type: OrdersV0TransferOrderCreateCustomer

    Example
    {
  "customerAddress": "example",
  "customerCargoPrice": 0.5,
  "customerComment": "example",
  "customerCountry": "example",
  "customerForwarderId": "example",
  "customerLegalForm": "example",
  "customerName": "example",
  "customerPhone": "example",
  "customerTin": "example"
}

Инфорация о владельце груза.

Example
{
  "customerAddress": "example",
  "customerCargoPrice": 0.5,
  "customerComment": "example",
  "customerCountry": "example",
  "customerForwarderId": "example",
  "customerLegalForm": "example",
  "customerName": "example",
  "customerPhone": "example",
  "customerTin": "example"
}

forwarder
All of 1 type

Организация, от имени которой создаётся заказ

Example
{
  "forwarderComment": "example",
  "forwarderId": "example",
  "forwarderName": "example",
  "forwarderTin": "example"
}

isVolumeAuction

Type: boolean

meta

Type: OrdersV0TransferOrderCreateMeta

Example
{
  "conditions": [
    {
      "conditionsTemplateId": "example",
      "conditionsTemplateType": "example",
      "conditionsTemplateVersion": "example",
      "executorId": "example",
      "variables": {}
    }
  ]
}

shipments

Type: OrdersV0TransferOrderCreateShipmentCreate[]

Min items: 1

Example
[
  {
    "comment": "example",
    "distributionPriority": 0,
    "name": "example",
    "npShipment": {
      "addressComment": "example",
      "content": "example",
      "country": "example",
      "id": "example",
      "legalAddress": "example",
      "legalPhone": "example",
      "name": "example",
      "npAdditionalContact": [
        {}
      ],
      "npGeoAddress": null,
      "npGeoLegalAddress": null,
      "npLegalType": "example",
      "npShipmentId": "example",
      "npTin": "example",
      "period": null,
      "phoneCountryCode": "example",
      "position": 0,
      "sequenceOrder": 0,
      "transshipmentTypes": [
        "example"
      ]
    },
    "npUnshipment": null,
    "packageType": "example",
    "packages": [
      {
        "amount": 0.5,
        "capacity": 0.5,
        "cargoCategory": {},
        "cargoInsurance": {},
        "comment": "example",
        "count": 0,
        "currency": "example",
        "dimensionHeight": 0.5,
        "dimensionLength": 0.5,
        "dimensionWeight": 0.5,
        "hazardClass": "example",
        "packageExternalId": "example",
        "packageName": "example",
        "ruEdo": {},
        "shipmentBodyType": "example",
        "stackability": "example",
        "temperatureRegime": [
          {}
        ],
        "weight": 0.5
      }
    ],
    "quantizationMethod": "example",
    "shipmentExternalID": "example"
  }
]

switchOffDatesValidation

Type: boolean

transferOrderAdditionalConfiguration

Type: JSONObject

Example
{}

transferOrderType

Type: string

FTL LTL

Example: example

trustCoordinates

Type: boolean

Если true и адрес противоречит координатам приоритет отдается координатам

additionalConditions
Any of 2 types

  • Type: OrdersV0TransferOrderCreateAdditionalConditions

    Example
    {
  "additionalComment": "example",
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "emails": [
    "example"
  ],
  "externalOrderID": "example",
  "fullName": "example",
  "isVatPayer": true,
  "phones": [
    "example"
  ],
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "specifyConditions": true,
  "vat": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

Дополнительные условия заказа

Example
{
  "additionalComment": "example",
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "emails": [
    "example"
  ],
  "externalOrderID": "example",
  "fullName": "example",
  "isVatPayer": true,
  "phones": [
    "example"
  ],
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "specifyConditions": true,
  "vat": 0.5
}

agreementRules
Any of 2 types

  • Type: OrdersV0TransferOrderCreateAgreementRules

    Example
    {
  "isDriverCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangeShipmentsWithoutApproval": true,
  "isForwarderCanChangePackagesWithoutApproval": true,
  "isForwarderCanChangeShipmentsWithoutApproval": true,
  "isWarehouseCanChangePackagesWithoutApproval": true
}

  • Type: object | null

    Const: null

    Example
    {}

Правила согласования

Example
{
  "isDriverCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangeShipmentsWithoutApproval": true,
  "isForwarderCanChangePackagesWithoutApproval": true,
  "isForwarderCanChangeShipmentsWithoutApproval": true,
  "isWarehouseCanChangePackagesWithoutApproval": true
}

auction
Any of 2 types

  • Type: OrdersV0TransferOrderCreateAuction

    Example
    {
  "allowMultimodal": true,
  "auctionType": "example",
  "autoExtension": true,
  "autoExtensionActive": 0,
  "autoExtensionDuration": 0,
  "autoExtensionTime": 0,
  "autoSelection": true,
  "bargainingIsPossible": true,
  "bidStep": 0.5,
  "buyNowPrice": 0.5,
  "decreaseOnly": true,
  "decreaseOnlyFromDeclaredPrice": true,
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "hideBidsFromCarrier": true,
  "startDate": null,
  "tariffMatrixParams": {
    "isWhoFirst": true,
    "tariffMatrixIds": [
      {
        "tariffMatrixId": "example"
      }
    ]
  },
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatInPriceNotConsider": true
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "allowMultimodal": true,
  "auctionType": "example",
  "autoExtension": true,
  "autoExtensionActive": 0,
  "autoExtensionDuration": 0,
  "autoExtensionTime": 0,
  "autoSelection": true,
  "bargainingIsPossible": true,
  "bidStep": 0.5,
  "buyNowPrice": 0.5,
  "decreaseOnly": true,
  "decreaseOnlyFromDeclaredPrice": true,
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "hideBidsFromCarrier": true,
  "startDate": null,
  "tariffMatrixParams": {
    "isWhoFirst": true,
    "tariffMatrixIds": [
      {}
    ]
  },
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatInPriceNotConsider": true
}

bodyTypeComment

Type: string | null

Комментарий к типу кузова.

Example: example

cargoComment

Type: string | null

Комментарий для себя

Example: example

cargoId

Type: string | null

Название или номер заказа в вашей системе

Example: example

dimensions
Any of 2 types

  • Type: OrdersV0TransferOrderCreateDimensions

    Example
    {
  "breadth": 0.5,
  "height": 0.5,
  "length": 0.5,
  "palletCount": 0,
  "volume": 0.5,
  "weight": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

Вес и объём.

Example
{
  "breadth": 0.5,
  "height": 0.5,
  "length": 0.5,
  "palletCount": 0,
  "volume": 0.5,
  "weight": 0.5
}

distribution
Any of 2 types

  • Type: OrdersV0TransferOrderCreateDistribution

    Example
    {
  "amount": 0.5,
  "comment": "example",
  "currency": "example",
  "dayDocClose": 0,
  "dayDocDelay": 0,
  "docFormat": "example",
  "groupsId": [
    "example"
  ],
  "partners": [
    {
      "id": "example",
      "tin": "example"
    }
  ],
  "publicMatcher": true,
  "type": "example",
  "typeDocClose": "example",
  "typeDocDelay": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

{
"type": "draft",
"groupsId": [],
"partners": [],
"amount": null,
"comment": "",
"publicMatcher": false
}
Тип опредения исполнителя.

Example
{
  "amount": 0.5,
  "comment": "example",
  "currency": "example",
  "dayDocClose": 0,
  "dayDocDelay": 0,
  "docFormat": "example",
  "groupsId": [
    "example"
  ],
  "partners": [
    {
      "id": "example",
      "tin": "example"
    }
  ],
  "publicMatcher": true,
  "type": "example",
  "typeDocClose": "example",
  "typeDocDelay": "example"
}

executionSettings
Any of 2 types

  • Type: OrdersV0TransferOrderCreateExecutionSettings

    Example
    {
  "driverAssignmentDeadline": {
    "duration": 0,
    "endDate": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    }
  }
}

  • Type: object | null

    Const: null

    Example
    {}

Дополнительные настройки исполнения заказа

Example
{
  "driverAssignmentDeadline": {
    "duration": 0,
    "endDate": {}
  }
}

fileContainerId

Type: string | null

Example: example

files

Type: string[] | null

Example
[
  "example"
]

flightCreator
Any of 2 types

  • Type: OrdersV0TransferOrderCreateFlightCreator

    Example
    {
  "car": {
    "id": "example",
    "version": 0
  },
  "comment": "example",
  "companyInfo": {
    "companyName": "example",
    "companyType": "example",
    "country": "example",
    "email": "example",
    "fullName": "example",
    "phone": "example",
    "tin": "example"
  },
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "driver": {
    "id": "example",
    "version": 0
  },
  "externalFlightID": "example",
  "flightName": "example",
  "isVatPayer": true,
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "trailer": {
    "id": "example",
    "version": 0
  },
  "vat": 0.5,
  "willNotCarryMyself": true
}

  • Type: object | null

    Const: null

    Example
    {}

Создатель рейса

Example
{
  "car": {
    "id": "example",
    "version": 0
  },
  "comment": "example",
  "companyInfo": {
    "companyName": "example",
    "companyType": "example",
    "country": "example",
    "email": "example",
    "fullName": "example",
    "phone": "example",
    "tin": "example"
  },
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "driver": {
    "id": "example",
    "version": 0
  },
  "externalFlightID": "example",
  "flightName": "example",
  "isVatPayer": true,
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "trailer": {
    "id": "example",
    "version": 0
  },
  "vat": 0.5,
  "willNotCarryMyself": true
}

freeTags

Type: string[] | null

Теги заказчика

Example
[
  "example"
]

orderExternalID

Type: string | null

Название или номер заказа в вашей системе нутрений. Не отображается в интерфейсе

Example: example

paymentDelayPeriod
Any of 2 types

Отсрочка платежа.

Example
{
  "daysDelayPeriod": 0,
  "paymentType": "example",
  "postPayCalendarType": "example"
}

tagId

Type: string | null

Example: example

temperatureRegime

Type: OrdersV0TransferOrderCreateTemperatureRegime[] | null

Температурный режим.

Example
[
  {
    "from": 0,
    "label": "example",
    "to": 0
  }
]

transferOrderAdditionalConditions

Type: string | null

Дополнительные условия заказа.

Example: example

transferOrderCost
Any of 2 types

Стоимость заказа.

Example
{
  "currency": "example",
  "price": 0.5
}

transferOrderName

Type: string | null

Отображаемое имя заказа на перевозку.

Example: example

transshipmentTypes

Type: string[] | null

Тип загрузки и выгрузки.

Example
[
  "example"
]

typePaymentAndTax

Type: string | null

Тип оплаты платежа.

Example: example

utm
Any of 2 types

  • Type: OrdersV0TransferOrderCreateUTM

    Example
    {
  "utmCampaign": "example",
  "utmContent": "example",
  "utmMedium": "example",
  "utmSource": "example",
  "utmTerm": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

Utm информация.

Example
{
  "utmCampaign": "example",
  "utmContent": "example",
  "utmMedium": "example",
  "utmSource": "example",
  "utmTerm": "example"
}

volumeAuction
Any of 2 types

  • Type: OrdersV0TransferOrderCreateVolumeAuction

    Example
    {
  "auctionType": "example",
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "flightsCount": 0.5,
  "startDate": null,
  "tarifficationType": "example",
  "tonsCount": 0.5,
  "transitDistance": 0.5,
  "vehicleCapacityFrom": 0.5,
  "vehicleCapacityTo": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "auctionType": "example",
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "flightsCount": 0.5,
  "startDate": null,
  "tarifficationType": "example",
  "tonsCount": 0.5,
  "transitDistance": 0.5,
  "vehicleCapacityFrom": 0.5,
  "vehicleCapacityTo": 0.5
}
Example
{
  "additionalConditions": {
    "additionalComment": "example",
    "currency": "example",
    "documentsDelay": {
      "daysTypeAfterDocuments": "example",
      "daysTypeBeforeDocuments": "example",
      "delayAfterDocuments": 0,
      "delayBeforeDocuments": 0
    },
    "emails": [
      "example"
    ],
    "externalOrderID": "example",
    "fullName": "example",
    "isVatPayer": true,
    "phones": [
      "example"
    ],
    "price": 0.5,
    "priceComment": "example",
    "priceWithVat": 0.5,
    "specifyConditions": true,
    "vat": 0.5
  },
  "agreementRules": {
    "isDriverCanChangePackagesWithoutApproval": true,
    "isExecutorCanChangePackagesWithoutApproval": true,
    "isExecutorCanChangeShipmentsWithoutApproval": true,
    "isForwarderCanChangePackagesWithoutApproval": true,
    "isForwarderCanChangeShipmentsWithoutApproval": true,
    "isWarehouseCanChangePackagesWithoutApproval": true
  },
  "auction": {
    "allowMultimodal": true,
    "auctionType": "example",
    "autoExtension": true,
    "autoExtensionActive": 0,
    "autoExtensionDuration": 0,
    "autoExtensionTime": 0,
    "autoSelection": true,
    "bargainingIsPossible": true,
    "bidStep": 0.5,
    "buyNowPrice": 0.5,
    "decreaseOnly": true,
    "decreaseOnlyFromDeclaredPrice": true,
    "duration": 0,
    "endDate": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    },
    "hideBidsFromCarrier": true,
    "startDate": null,
    "tariffMatrixParams": {
      "isWhoFirst": true,
      "tariffMatrixIds": [
        null
      ]
    },
    "useTariffMatrix": true,
    "vat": 0.5,
    "vatInPriceNotConsider": true
  },
  "bodyType": [
    "example"
  ],
  "bodyTypeComment": "example",
  "cargoCategory": {
    "category": "example",
    "categoryComment": "example"
  },
  "cargoComment": "example",
  "cargoId": "example",
  "currency": "example",
  "customer": {
    "customerAddress": "example",
    "customerCargoPrice": 0.5,
    "customerComment": "example",
    "customerCountry": "example",
    "customerForwarderId": "example",
    "customerLegalForm": "example",
    "customerName": "example",
    "customerPhone": "example",
    "customerTin": "example"
  },
  "dimensions": {
    "breadth": 0.5,
    "height": 0.5,
    "length": 0.5,
    "palletCount": 0,
    "volume": 0.5,
    "weight": 0.5
  },
  "distribution": {
    "amount": 0.5,
    "comment": "example",
    "currency": "example",
    "dayDocClose": 0,
    "dayDocDelay": 0,
    "docFormat": "example",
    "groupsId": [
      "example"
    ],
    "partners": [
      {
        "id": "example",
        "tin": "example"
      }
    ],
    "publicMatcher": true,
    "type": "example",
    "typeDocClose": "example",
    "typeDocDelay": "example"
  },
  "executionSettings": {
    "driverAssignmentDeadline": {
      "duration": 0,
      "endDate": null
    }
  },
  "fileContainerId": "example",
  "files": [
    "example"
  ],
  "flightCreator": {
    "car": {
      "id": "example",
      "version": 0
    },
    "comment": "example",
    "companyInfo": {
      "companyName": "example",
      "companyType": "example",
      "country": "example",
      "email": "example",
      "fullName": "example",
      "phone": "example",
      "tin": "example"
    },
    "currency": "example",
    "documentsDelay": null,
    "driver": {
      "id": "example",
      "version": 0
    },
    "externalFlightID": "example",
    "flightName": "example",
    "isVatPayer": true,
    "price": 0.5,
    "priceComment": "example",
    "priceWithVat": 0.5,
    "trailer": {
      "id": "example",
      "version": 0
    },
    "vat": 0.5,
    "willNotCarryMyself": true
  },
  "forwarder": {
    "forwarderComment": "example",
    "forwarderId": "example",
    "forwarderName": "example",
    "forwarderTin": "example"
  },
  "freeTags": [
    "example"
  ],
  "isVolumeAuction": true,
  "meta": {
    "conditions": [
      {
        "conditionsTemplateId": "example",
        "conditionsTemplateType": "example",
        "conditionsTemplateVersion": "example",
        "executorId": "example",
        "variables": {}
      }
    ]
  },
  "orderExternalID": "example",
  "paymentDelayPeriod": {
    "daysDelayPeriod": 0,
    "paymentType": "example",
    "postPayCalendarType": "example"
  },
  "shipments": [
    {
      "comment": "example",
      "distributionPriority": 0,
      "name": "example",
      "npShipment": {
        "addressComment": "example",
        "content": "example",
        "country": "example",
        "id": "example",
        "legalAddress": "example",
        "legalPhone": "example",
        "name": "example",
        "npAdditionalContact": [
          null
        ],
        "npGeoAddress": null,
        "npGeoLegalAddress": null,
        "npLegalType": "example",
        "npShipmentId": "example",
        "npTin": "example",
        "period": null,
        "phoneCountryCode": "example",
        "position": 0,
        "sequenceOrder": 0,
        "transshipmentTypes": [
          null
        ]
      },
      "npUnshipment": null,
      "packageType": "example",
      "packages": [
        {
          "amount": 0.5,
          "capacity": 0.5,
          "cargoCategory": null,
          "cargoInsurance": null,
          "comment": "example",
          "count": 0,
          "currency": "example",
          "dimensionHeight": 0.5,
          "dimensionLength": 0.5,
          "dimensionWeight": 0.5,
          "hazardClass": "example",
          "packageExternalId": "example",
          "packageName": "example",
          "ruEdo": null,
          "shipmentBodyType": "example",
          "stackability": "example",
          "temperatureRegime": [
            null
          ],
          "weight": 0.5
        }
      ],
      "quantizationMethod": "example",
      "shipmentExternalID": "example"
    }
  ],
  "switchOffDatesValidation": true,
  "tagId": "example",
  "temperatureRegime": [
    {
      "from": 0,
      "label": "example",
      "to": 0
    }
  ],
  "transferOrderAdditionalConditions": "example",
  "transferOrderAdditionalConfiguration": {},
  "transferOrderCost": {
    "currency": "example",
    "price": 0.5
  },
  "transferOrderName": "example",
  "transferOrderType": "example",
  "transshipmentTypes": [
    "example"
  ],
  "trustCoordinates": true,
  "typePaymentAndTax": "example",
  "utm": {
    "utmCampaign": "example",
    "utmContent": "example",
    "utmMedium": "example",
    "utmSource": "example",
    "utmTerm": "example"
  },
  "volumeAuction": {
    "auctionType": "example",
    "duration": 0,
    "endDate": null,
    "flightsCount": 0.5,
    "startDate": null,
    "tarifficationType": "example",
    "tonsCount": 0.5,
    "transitDistance": 0.5,
    "vehicleCapacityFrom": 0.5,
    "vehicleCapacityTo": 0.5
  }
}

Responses

200 OK

OK

Body

application/json
{
  "data": {
    "id": "example"
  }
}

Name

Description

data

Type: OrdersV0TransferOrderCreateResponse

Example
{
  "id": "example"
}

OrdersV0TransferOrderCreateFlightCreator

Name

Description

car
Any of 2 types

Информация об автомобиле

Example
{
  "id": "example",
  "version": 0
}

comment

Type: string | null

Поле комментария

Example: example

companyInfo
Any of 2 types

  • Type: OrdersV0TransferOrderCreateCompanyInfo

    Example
    {
  "companyName": "example",
  "companyType": "example",
  "country": "example",
  "email": "example",
  "fullName": "example",
  "phone": "example",
  "tin": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

Информация о компании

Example
{
  "companyName": "example",
  "companyType": "example",
  "country": "example",
  "email": "example",
  "fullName": "example",
  "phone": "example",
  "tin": "example"
}

currency

Type: string | null

Валюта (селектор)

Example: example

documentsDelay
Any of 2 types

  • Type: OrdersV0TransferOrderCreateDocumentsDelay

    Example
    {
  "daysTypeAfterDocuments": "example",
  "daysTypeBeforeDocuments": "example",
  "delayAfterDocuments": 0,
  "delayBeforeDocuments": 0
}

  • Type: object | null

    Const: null

    Example
    {}

Отсрочка документов

Example
{
  "daysTypeAfterDocuments": "example",
  "daysTypeBeforeDocuments": "example",
  "delayAfterDocuments": 0,
  "delayBeforeDocuments": 0
}

driver
Any of 2 types

Информация о водителе

Example
{
  "id": "example",
  "version": 0
}

externalFlightID

Type: string | null

Внешний идентификатор рейса

Example: example

flightName

Type: string | null

Название рейса

Example: example

isVatPayer

Type: boolean | null

Является ли плательщиком НДС

price

Type: number | null

Стоимость без НДС

priceComment

Type: string | null

Комментарий к цене

Example: example

priceWithVat

Type: number | null

Стоимость с НДС

trailer
Any of 2 types

Информация о прицепе

Example
{
  "id": "example",
  "version": 0
}

vat

Type: number | null

НДС

willNotCarryMyself

Type: boolean | null

Переключатель "Не буду везти сам"
Example
{
  "car": {
    "id": "example",
    "version": 0
  },
  "comment": "example",
  "companyInfo": {
    "companyName": "example",
    "companyType": "example",
    "country": "example",
    "email": "example",
    "fullName": "example",
    "phone": "example",
    "tin": "example"
  },
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "driver": {
    "id": "example",
    "version": 0
  },
  "externalFlightID": "example",
  "flightName": "example",
  "isVatPayer": true,
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "trailer": {
    "id": "example",
    "version": 0
  },
  "vat": 0.5,
  "willNotCarryMyself": true
}

OrdersV0TransferOrderCreateRequest

Name

Description

bodyType

Type: string[]

Тип кузова.

Min items: 1

Example
[
  "example"
]

cargoCategory
All of 1 type

Категория груза.

Example
{
  "category": "example",
  "categoryComment": "example"
}

currency

Type: string

Валюта заказа

Example: example

customer
All of 1 type

  • Type: OrdersV0TransferOrderCreateCustomer

    Example
    {
  "customerAddress": "example",
  "customerCargoPrice": 0.5,
  "customerComment": "example",
  "customerCountry": "example",
  "customerForwarderId": "example",
  "customerLegalForm": "example",
  "customerName": "example",
  "customerPhone": "example",
  "customerTin": "example"
}

Инфорация о владельце груза.

Example
{
  "customerAddress": "example",
  "customerCargoPrice": 0.5,
  "customerComment": "example",
  "customerCountry": "example",
  "customerForwarderId": "example",
  "customerLegalForm": "example",
  "customerName": "example",
  "customerPhone": "example",
  "customerTin": "example"
}

forwarder
All of 1 type

Организация, от имени которой создаётся заказ

Example
{
  "forwarderComment": "example",
  "forwarderId": "example",
  "forwarderName": "example",
  "forwarderTin": "example"
}

isVolumeAuction

Type: boolean

meta

Type: OrdersV0TransferOrderCreateMeta

Example
{
  "conditions": [
    {
      "conditionsTemplateId": "example",
      "conditionsTemplateType": "example",
      "conditionsTemplateVersion": "example",
      "executorId": "example",
      "variables": {}
    }
  ]
}

shipments

Type: OrdersV0TransferOrderCreateShipmentCreate[]

Min items: 1

Example
[
  {
    "comment": "example",
    "distributionPriority": 0,
    "name": "example",
    "npShipment": {
      "addressComment": "example",
      "content": "example",
      "country": "example",
      "id": "example",
      "legalAddress": "example",
      "legalPhone": "example",
      "name": "example",
      "npAdditionalContact": [
        {}
      ],
      "npGeoAddress": null,
      "npGeoLegalAddress": null,
      "npLegalType": "example",
      "npShipmentId": "example",
      "npTin": "example",
      "period": null,
      "phoneCountryCode": "example",
      "position": 0,
      "sequenceOrder": 0,
      "transshipmentTypes": [
        "example"
      ]
    },
    "npUnshipment": null,
    "packageType": "example",
    "packages": [
      {
        "amount": 0.5,
        "capacity": 0.5,
        "cargoCategory": {},
        "cargoInsurance": {},
        "comment": "example",
        "count": 0,
        "currency": "example",
        "dimensionHeight": 0.5,
        "dimensionLength": 0.5,
        "dimensionWeight": 0.5,
        "hazardClass": "example",
        "packageExternalId": "example",
        "packageName": "example",
        "ruEdo": {},
        "shipmentBodyType": "example",
        "stackability": "example",
        "temperatureRegime": [
          {}
        ],
        "weight": 0.5
      }
    ],
    "quantizationMethod": "example",
    "shipmentExternalID": "example"
  }
]

switchOffDatesValidation

Type: boolean

transferOrderAdditionalConfiguration

Type: JSONObject

Example
{}

transferOrderType

Type: string

FTL LTL

Example: example

trustCoordinates

Type: boolean

Если true и адрес противоречит координатам приоритет отдается координатам

additionalConditions
Any of 2 types

  • Type: OrdersV0TransferOrderCreateAdditionalConditions

    Example
    {
  "additionalComment": "example",
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "emails": [
    "example"
  ],
  "externalOrderID": "example",
  "fullName": "example",
  "isVatPayer": true,
  "phones": [
    "example"
  ],
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "specifyConditions": true,
  "vat": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

Дополнительные условия заказа

Example
{
  "additionalComment": "example",
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "emails": [
    "example"
  ],
  "externalOrderID": "example",
  "fullName": "example",
  "isVatPayer": true,
  "phones": [
    "example"
  ],
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "specifyConditions": true,
  "vat": 0.5
}

agreementRules
Any of 2 types

  • Type: OrdersV0TransferOrderCreateAgreementRules

    Example
    {
  "isDriverCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangeShipmentsWithoutApproval": true,
  "isForwarderCanChangePackagesWithoutApproval": true,
  "isForwarderCanChangeShipmentsWithoutApproval": true,
  "isWarehouseCanChangePackagesWithoutApproval": true
}

  • Type: object | null

    Const: null

    Example
    {}

Правила согласования

Example
{
  "isDriverCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangeShipmentsWithoutApproval": true,
  "isForwarderCanChangePackagesWithoutApproval": true,
  "isForwarderCanChangeShipmentsWithoutApproval": true,
  "isWarehouseCanChangePackagesWithoutApproval": true
}

auction
Any of 2 types

  • Type: OrdersV0TransferOrderCreateAuction

    Example
    {
  "allowMultimodal": true,
  "auctionType": "example",
  "autoExtension": true,
  "autoExtensionActive": 0,
  "autoExtensionDuration": 0,
  "autoExtensionTime": 0,
  "autoSelection": true,
  "bargainingIsPossible": true,
  "bidStep": 0.5,
  "buyNowPrice": 0.5,
  "decreaseOnly": true,
  "decreaseOnlyFromDeclaredPrice": true,
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "hideBidsFromCarrier": true,
  "startDate": null,
  "tariffMatrixParams": {
    "isWhoFirst": true,
    "tariffMatrixIds": [
      {
        "tariffMatrixId": "example"
      }
    ]
  },
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatInPriceNotConsider": true
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "allowMultimodal": true,
  "auctionType": "example",
  "autoExtension": true,
  "autoExtensionActive": 0,
  "autoExtensionDuration": 0,
  "autoExtensionTime": 0,
  "autoSelection": true,
  "bargainingIsPossible": true,
  "bidStep": 0.5,
  "buyNowPrice": 0.5,
  "decreaseOnly": true,
  "decreaseOnlyFromDeclaredPrice": true,
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "hideBidsFromCarrier": true,
  "startDate": null,
  "tariffMatrixParams": {
    "isWhoFirst": true,
    "tariffMatrixIds": [
      {}
    ]
  },
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatInPriceNotConsider": true
}

bodyTypeComment

Type: string | null

Комментарий к типу кузова.

Example: example

cargoComment

Type: string | null

Комментарий для себя

Example: example

cargoId

Type: string | null

Название или номер заказа в вашей системе

Example: example

dimensions
Any of 2 types

  • Type: OrdersV0TransferOrderCreateDimensions

    Example
    {
  "breadth": 0.5,
  "height": 0.5,
  "length": 0.5,
  "palletCount": 0,
  "volume": 0.5,
  "weight": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

Вес и объём.

Example
{
  "breadth": 0.5,
  "height": 0.5,
  "length": 0.5,
  "palletCount": 0,
  "volume": 0.5,
  "weight": 0.5
}

distribution
Any of 2 types

  • Type: OrdersV0TransferOrderCreateDistribution

    Example
    {
  "amount": 0.5,
  "comment": "example",
  "currency": "example",
  "dayDocClose": 0,
  "dayDocDelay": 0,
  "docFormat": "example",
  "groupsId": [
    "example"
  ],
  "partners": [
    {
      "id": "example",
      "tin": "example"
    }
  ],
  "publicMatcher": true,
  "type": "example",
  "typeDocClose": "example",
  "typeDocDelay": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

{
"type": "draft",
"groupsId": [],
"partners": [],
"amount": null,
"comment": "",
"publicMatcher": false
}
Тип опредения исполнителя.

Example
{
  "amount": 0.5,
  "comment": "example",
  "currency": "example",
  "dayDocClose": 0,
  "dayDocDelay": 0,
  "docFormat": "example",
  "groupsId": [
    "example"
  ],
  "partners": [
    {
      "id": "example",
      "tin": "example"
    }
  ],
  "publicMatcher": true,
  "type": "example",
  "typeDocClose": "example",
  "typeDocDelay": "example"
}

executionSettings
Any of 2 types

  • Type: OrdersV0TransferOrderCreateExecutionSettings

    Example
    {
  "driverAssignmentDeadline": {
    "duration": 0,
    "endDate": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    }
  }
}

  • Type: object | null

    Const: null

    Example
    {}

Дополнительные настройки исполнения заказа

Example
{
  "driverAssignmentDeadline": {
    "duration": 0,
    "endDate": {}
  }
}

fileContainerId

Type: string | null

Example: example

files

Type: string[] | null

Example
[
  "example"
]

flightCreator
Any of 2 types

  • Type: OrdersV0TransferOrderCreateFlightCreator

    Example
    {
  "car": {
    "id": "example",
    "version": 0
  },
  "comment": "example",
  "companyInfo": {
    "companyName": "example",
    "companyType": "example",
    "country": "example",
    "email": "example",
    "fullName": "example",
    "phone": "example",
    "tin": "example"
  },
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "driver": {
    "id": "example",
    "version": 0
  },
  "externalFlightID": "example",
  "flightName": "example",
  "isVatPayer": true,
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "trailer": {
    "id": "example",
    "version": 0
  },
  "vat": 0.5,
  "willNotCarryMyself": true
}

  • Type: object | null

    Const: null

    Example
    {}

Создатель рейса

Example
{
  "car": {
    "id": "example",
    "version": 0
  },
  "comment": "example",
  "companyInfo": {
    "companyName": "example",
    "companyType": "example",
    "country": "example",
    "email": "example",
    "fullName": "example",
    "phone": "example",
    "tin": "example"
  },
  "currency": "example",
  "documentsDelay": {
    "daysTypeAfterDocuments": "example",
    "daysTypeBeforeDocuments": "example",
    "delayAfterDocuments": 0,
    "delayBeforeDocuments": 0
  },
  "driver": {
    "id": "example",
    "version": 0
  },
  "externalFlightID": "example",
  "flightName": "example",
  "isVatPayer": true,
  "price": 0.5,
  "priceComment": "example",
  "priceWithVat": 0.5,
  "trailer": {
    "id": "example",
    "version": 0
  },
  "vat": 0.5,
  "willNotCarryMyself": true
}

freeTags

Type: string[] | null

Теги заказчика

Example
[
  "example"
]

orderExternalID

Type: string | null

Название или номер заказа в вашей системе нутрений. Не отображается в интерфейсе

Example: example

paymentDelayPeriod
Any of 2 types

Отсрочка платежа.

Example
{
  "daysDelayPeriod": 0,
  "paymentType": "example",
  "postPayCalendarType": "example"
}

tagId

Type: string | null

Example: example

temperatureRegime

Type: OrdersV0TransferOrderCreateTemperatureRegime[] | null

Температурный режим.

Example
[
  {
    "from": 0,
    "label": "example",
    "to": 0
  }
]

transferOrderAdditionalConditions

Type: string | null

Дополнительные условия заказа.

Example: example

transferOrderCost
Any of 2 types

Стоимость заказа.

Example
{
  "currency": "example",
  "price": 0.5
}

transferOrderName

Type: string | null

Отображаемое имя заказа на перевозку.

Example: example

transshipmentTypes

Type: string[] | null

Тип загрузки и выгрузки.

Example
[
  "example"
]

typePaymentAndTax

Type: string | null

Тип оплаты платежа.

Example: example

utm
Any of 2 types

  • Type: OrdersV0TransferOrderCreateUTM

    Example
    {
  "utmCampaign": "example",
  "utmContent": "example",
  "utmMedium": "example",
  "utmSource": "example",
  "utmTerm": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

Utm информация.

Example
{
  "utmCampaign": "example",
  "utmContent": "example",
  "utmMedium": "example",
  "utmSource": "example",
  "utmTerm": "example"
}

volumeAuction
Any of 2 types

  • Type: OrdersV0TransferOrderCreateVolumeAuction

    Example
    {
  "auctionType": "example",
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "flightsCount": 0.5,
  "startDate": null,
  "tarifficationType": "example",
  "tonsCount": 0.5,
  "transitDistance": 0.5,
  "vehicleCapacityFrom": 0.5,
  "vehicleCapacityTo": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "auctionType": "example",
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "flightsCount": 0.5,
  "startDate": null,
  "tarifficationType": "example",
  "tonsCount": 0.5,
  "transitDistance": 0.5,
  "vehicleCapacityFrom": 0.5,
  "vehicleCapacityTo": 0.5
}
Example
{
  "additionalConditions": {
    "additionalComment": "example",
    "currency": "example",
    "documentsDelay": {
      "daysTypeAfterDocuments": "example",
      "daysTypeBeforeDocuments": "example",
      "delayAfterDocuments": 0,
      "delayBeforeDocuments": 0
    },
    "emails": [
      "example"
    ],
    "externalOrderID": "example",
    "fullName": "example",
    "isVatPayer": true,
    "phones": [
      "example"
    ],
    "price": 0.5,
    "priceComment": "example",
    "priceWithVat": 0.5,
    "specifyConditions": true,
    "vat": 0.5
  },
  "agreementRules": {
    "isDriverCanChangePackagesWithoutApproval": true,
    "isExecutorCanChangePackagesWithoutApproval": true,
    "isExecutorCanChangeShipmentsWithoutApproval": true,
    "isForwarderCanChangePackagesWithoutApproval": true,
    "isForwarderCanChangeShipmentsWithoutApproval": true,
    "isWarehouseCanChangePackagesWithoutApproval": true
  },
  "auction": {
    "allowMultimodal": true,
    "auctionType": "example",
    "autoExtension": true,
    "autoExtensionActive": 0,
    "autoExtensionDuration": 0,
    "autoExtensionTime": 0,
    "autoSelection": true,
    "bargainingIsPossible": true,
    "bidStep": 0.5,
    "buyNowPrice": 0.5,
    "decreaseOnly": true,
    "decreaseOnlyFromDeclaredPrice": true,
    "duration": 0,
    "endDate": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    },
    "hideBidsFromCarrier": true,
    "startDate": null,
    "tariffMatrixParams": {
      "isWhoFirst": true,
      "tariffMatrixIds": [
        null
      ]
    },
    "useTariffMatrix": true,
    "vat": 0.5,
    "vatInPriceNotConsider": true
  },
  "bodyType": [
    "example"
  ],
  "bodyTypeComment": "example",
  "cargoCategory": {
    "category": "example",
    "categoryComment": "example"
  },
  "cargoComment": "example",
  "cargoId": "example",
  "currency": "example",
  "customer": {
    "customerAddress": "example",
    "customerCargoPrice": 0.5,
    "customerComment": "example",
    "customerCountry": "example",
    "customerForwarderId": "example",
    "customerLegalForm": "example",
    "customerName": "example",
    "customerPhone": "example",
    "customerTin": "example"
  },
  "dimensions": {
    "breadth": 0.5,
    "height": 0.5,
    "length": 0.5,
    "palletCount": 0,
    "volume": 0.5,
    "weight": 0.5
  },
  "distribution": {
    "amount": 0.5,
    "comment": "example",
    "currency": "example",
    "dayDocClose": 0,
    "dayDocDelay": 0,
    "docFormat": "example",
    "groupsId": [
      "example"
    ],
    "partners": [
      {
        "id": "example",
        "tin": "example"
      }
    ],
    "publicMatcher": true,
    "type": "example",
    "typeDocClose": "example",
    "typeDocDelay": "example"
  },
  "executionSettings": {
    "driverAssignmentDeadline": {
      "duration": 0,
      "endDate": null
    }
  },
  "fileContainerId": "example",
  "files": [
    "example"
  ],
  "flightCreator": {
    "car": {
      "id": "example",
      "version": 0
    },
    "comment": "example",
    "companyInfo": {
      "companyName": "example",
      "companyType": "example",
      "country": "example",
      "email": "example",
      "fullName": "example",
      "phone": "example",
      "tin": "example"
    },
    "currency": "example",
    "documentsDelay": null,
    "driver": {
      "id": "example",
      "version": 0
    },
    "externalFlightID": "example",
    "flightName": "example",
    "isVatPayer": true,
    "price": 0.5,
    "priceComment": "example",
    "priceWithVat": 0.5,
    "trailer": {
      "id": "example",
      "version": 0
    },
    "vat": 0.5,
    "willNotCarryMyself": true
  },
  "forwarder": {
    "forwarderComment": "example",
    "forwarderId": "example",
    "forwarderName": "example",
    "forwarderTin": "example"
  },
  "freeTags": [
    "example"
  ],
  "isVolumeAuction": true,
  "meta": {
    "conditions": [
      {
        "conditionsTemplateId": "example",
        "conditionsTemplateType": "example",
        "conditionsTemplateVersion": "example",
        "executorId": "example",
        "variables": {}
      }
    ]
  },
  "orderExternalID": "example",
  "paymentDelayPeriod": {
    "daysDelayPeriod": 0,
    "paymentType": "example",
    "postPayCalendarType": "example"
  },
  "shipments": [
    {
      "comment": "example",
      "distributionPriority": 0,
      "name": "example",
      "npShipment": {
        "addressComment": "example",
        "content": "example",
        "country": "example",
        "id": "example",
        "legalAddress": "example",
        "legalPhone": "example",
        "name": "example",
        "npAdditionalContact": [
          null
        ],
        "npGeoAddress": null,
        "npGeoLegalAddress": null,
        "npLegalType": "example",
        "npShipmentId": "example",
        "npTin": "example",
        "period": null,
        "phoneCountryCode": "example",
        "position": 0,
        "sequenceOrder": 0,
        "transshipmentTypes": [
          null
        ]
      },
      "npUnshipment": null,
      "packageType": "example",
      "packages": [
        {
          "amount": 0.5,
          "capacity": 0.5,
          "cargoCategory": null,
          "cargoInsurance": null,
          "comment": "example",
          "count": 0,
          "currency": "example",
          "dimensionHeight": 0.5,
          "dimensionLength": 0.5,
          "dimensionWeight": 0.5,
          "hazardClass": "example",
          "packageExternalId": "example",
          "packageName": "example",
          "ruEdo": null,
          "shipmentBodyType": "example",
          "stackability": "example",
          "temperatureRegime": [
            null
          ],
          "weight": 0.5
        }
      ],
      "quantizationMethod": "example",
      "shipmentExternalID": "example"
    }
  ],
  "switchOffDatesValidation": true,
  "tagId": "example",
  "temperatureRegime": [
    {
      "from": 0,
      "label": "example",
      "to": 0
    }
  ],
  "transferOrderAdditionalConditions": "example",
  "transferOrderAdditionalConfiguration": {},
  "transferOrderCost": {
    "currency": "example",
    "price": 0.5
  },
  "transferOrderName": "example",
  "transferOrderType": "example",
  "transshipmentTypes": [
    "example"
  ],
  "trustCoordinates": true,
  "typePaymentAndTax": "example",
  "utm": {
    "utmCampaign": "example",
    "utmContent": "example",
    "utmMedium": "example",
    "utmSource": "example",
    "utmTerm": "example"
  },
  "volumeAuction": {
    "auctionType": "example",
    "duration": 0,
    "endDate": null,
    "flightsCount": 0.5,
    "startDate": null,
    "tarifficationType": "example",
    "tonsCount": 0.5,
    "transitDistance": 0.5,
    "vehicleCapacityFrom": 0.5,
    "vehicleCapacityTo": 0.5
  }
}

OrdersV0TransferOrderCreateResponse

Name

Description

id

Type: string

Example: example
Example
{
  "id": "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"
}
Предыдущая
Отозвать исполняемый заказ со стороны заказчика
Следующая
Получить доступные организации с ролью заказчика