- Назначение
- Request
- Responses
- 200 OK
- Body
- TransferOrderTemplateGetV2DocumentsDelay
- TransferOrderTemplateGetV2AdditionalConditions
- TimestampTZOutput
- TransferOrderTemplateGetV2TariffMatrixParams
- TransferOrderTemplateGetV2AuctionGetV2
- TransferOrderTemplateGetV2CargoCategoryGetV2
- TransferOrderTemplateGetV2CustomerGetV2
- TransferOrderTemplateGetV2DimensionsGetV2
- TransferOrderTemplateGetV2Group
- TransferOrderTemplateGetV2Partner
- TransferOrderTemplateGetV2DistributionGetV2
- TransferOrderTemplateGetV2DriverAssignmentDeadline
- TransferOrderTemplateGetV2ExecutionSettings
- TransferOrderTemplateGetV2Car
- TransferOrderTemplateGetV2CompanyInfo
- TransferOrderTemplateGetV2Driver
- TransferOrderTemplateGetV2Trailer
- TransferOrderTemplateGetV2FlightCreator
- TransferOrderTemplateGetV2ForwarderGetV2
- TransferOrderTemplateGetV2PaymentDelayPeriodGetV2
- TransferOrderTemplateGetV2NodalPointAdditionalContact
- TransferOrderTemplateGetV2Address
- TransferOrderTemplateGetV2NpAddress
- TransferOrderTemplateGetV2NodalPointShipmentPeriod
- TransferOrderTemplateGetV2NodalPointShipment
- TransferOrderTemplateGetV2PackageCargoInsurance
- TransferOrderTemplateGetV2DangerousCargoGetV2
- TransferOrderTemplateGetV2PackagesRuEdo
- TransferOrderTemplateGetV2TemperatureRegimeGetV2
- TransferOrderTemplateGetV2PackageGetV2
- TransferOrderTemplateGetV2ShipmentGetV2
- TransferOrderTemplateGetV2TagInfo
- JSONObject
- TransferOrderTemplateGetV2PriceGetV2
- TransferOrderTemplateGetV2VolumeAuction
- TransferOrderTemplateGetV2Response
- 400 Bad Request
- 403 Forbidden
- 500 Internal Server Error
Получить шаблон заказа
Порядок работы для агента · Методы API и схема OpenAPI.
Назначение
Получите сохранённые параметры заказа по идентификатору templateId. Используйте их при подготовке нового заказа.
Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде
exampleпоказывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.
Request
GET
https://partner-test-yamagistrali.ru/api/transferOrderTemplate/get/v2
Тестовый стенд
Query parameters
|
Name |
Description |
|
templateId |
Type: string Example: `` |
Responses
200 OK
OK
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
},
"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": null,
"useTariffMatrix": true,
"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",
"groups": [
{}
],
"groupsId": [
"example"
],
"partners": [
{}
],
"publicMatcher": true,
"type": "example",
"typeDocClose": "example",
"typeDocDelay": "example"
},
"etrnRequired": true,
"executionSettings": {
"driverAssignmentDeadline": {}
},
"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,
"paymentDelayPeriod": {
"daysDelayPeriod": 0,
"paymentType": "example",
"postPayCalendarType": "example"
},
"shipments": [
{
"comment": "example",
"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,
"transshipmentTypes": [
null
]
},
"npUnshipment": null,
"packageType": "example",
"packages": [
{}
],
"quantizationMethod": "example",
"shipmentId": "example"
}
],
"tagId": "example",
"tagsInfo": [
{
"code": "example",
"name": "example"
}
],
"temperatureRegime": [
{
"from": 0,
"to": 0
}
],
"templateId": "example",
"transferOrderAdditionalConditions": "example",
"transferOrderAdditionalConfiguration": {},
"transferOrderCost": {
"currency": "example",
"price": 0.5
},
"transferOrderName": "example",
"transferOrderTemplateName": "example",
"transferOrderType": "example",
"transshipmentTypes": [
"example"
],
"typePaymentAndTax": "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: TransferOrderTemplateGetV2Response Example
|
TransferOrderTemplateGetV2DocumentsDelay
|
Name |
Description |
|
daysTypeAfterDocuments |
Type: string | null Дни (после предоставления документов) - рабочие/календарные Example: |
|
daysTypeBeforeDocuments |
Type: string | null Дни (до предоставления документов) - рабочие/календарные Example: |
|
delayAfterDocuments |
Type: integer | null Отсрочка, дней (после предоставления документов) |
|
delayBeforeDocuments |
Type: integer | null Отсрочка, дней (до предоставления документов) |
Example
{
"daysTypeAfterDocuments": "example",
"daysTypeBeforeDocuments": "example",
"delayAfterDocuments": 0,
"delayBeforeDocuments": 0
}
TransferOrderTemplateGetV2AdditionalConditions
|
Name |
Description |
|
additionalComment |
Type: string | null Комментарий Example: |
|
currency |
Type: string | null Валюта (селектор) Example: |
|
documentsDelay |
Any of 2 types
Отсрочка документов Example
|
|
emails |
Type: string[] | null Электронная почта (массив для поддержки кнопок + и удалить) Example
|
|
externalOrderId |
Type: string | null Идентификатор заказа во внешней системе Example: |
|
fullName |
Type: string | null ФИО Example: |
|
isVatPayer |
Type: boolean | null Является ли плательщиком НДС |
|
phones |
Type: string[] | null Телефон (массив для поддержки кнопок + и удалить) Example
|
|
price |
Type: number | null Стоимость без НДС |
|
priceComment |
Type: string | null Комментарий к цене 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
}
TimestampTZOutput
|
Name |
Description |
|
displayTZ |
Type: string Example: |
|
time |
Type: string<date-time> Example: |
Example
{
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
}
TransferOrderTemplateGetV2TariffMatrixParams
|
Name |
Description |
|
isWhoFirst |
Type: boolean | null Торговля по принципу кто первый |
Example
{
"isWhoFirst": true
}
TransferOrderTemplateGetV2AuctionGetV2
|
Name |
Description |
|
allowMultimodal |
Type: boolean |
|
auctionType |
Type: string 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 |
|
tariffMatrixParams |
All of 1 type
Параметры Тарифной матрицы Example
|
|
useTariffMatrix |
Type: boolean Торги Тарифная матрица |
|
vatInPriceNotConsider |
Type: boolean без учёта НДС |
|
bidStep |
Type: number | null |
|
buyNowPrice |
Type: number | null |
|
endDate |
Any of 2 types
Example
|
|
startDate |
Any of 2 types
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-01T00:00:00"
},
"hideBidsFromCarrier": true,
"startDate": null,
"tariffMatrixParams": {
"isWhoFirst": true
},
"useTariffMatrix": true,
"vatInPriceNotConsider": true
}
TransferOrderTemplateGetV2CargoCategoryGetV2
|
Name |
Description |
|
category |
Type: string | null Example: |
|
categoryComment |
Type: string | null Example: |
Example
{
"category": "example",
"categoryComment": "example"
}
TransferOrderTemplateGetV2CustomerGetV2
|
Name |
Description |
|
customerAddress |
Type: string Example: |
|
customerCountry |
Type: string Example: |
|
customerForwarderId |
Type: string Example: |
|
customerLegalForm |
Type: string Example: |
|
customerName |
Type: string Example: |
|
customerPhone |
Type: string Example: |
|
customerTin |
Type: string Example: |
|
customerCargoPrice |
Type: number | null |
|
customerComment |
Type: string | null Example: |
Example
{
"customerAddress": "example",
"customerCargoPrice": 0.5,
"customerComment": "example",
"customerCountry": "example",
"customerForwarderId": "example",
"customerLegalForm": "example",
"customerName": "example",
"customerPhone": "example",
"customerTin": "example"
}
TransferOrderTemplateGetV2DimensionsGetV2
|
Name |
Description |
|
weight |
Type: number |
|
breadth |
Type: number | null |
|
height |
Type: number | null |
|
length |
Type: number | null |
|
palletCount |
Type: integer | null |
|
volume |
Type: number | null |
Example
{
"breadth": 0.5,
"height": 0.5,
"length": 0.5,
"palletCount": 0,
"volume": 0.5,
"weight": 0.5
}
TransferOrderTemplateGetV2Group
|
Name |
Description |
|
id |
Type: string Example: |
|
name |
Type: string Example: |
Example
{
"id": "example",
"name": "example"
}
TransferOrderTemplateGetV2Partner
|
Name |
Description |
|
id |
Type: string Example: |
|
isBlackList |
Type: boolean |
|
name |
Type: string Example: |
|
tin |
Type: string Example: |
Example
{
"id": "example",
"isBlackList": true,
"name": "example",
"tin": "example"
}
TransferOrderTemplateGetV2DistributionGetV2
|
Name |
Description |
|
comment |
Type: string Example: |
|
publicMatcher |
Type: boolean |
|
type |
Type: string Example: |
|
amount |
Type: number | null |
|
currency |
Type: string | null Example: |
|
dayDocClose |
Type: integer | null |
|
dayDocDelay |
Type: integer | null |
|
docFormat |
Type: string | null Example: |
|
groups |
Type: TransferOrderTemplateGetV2Group[] | null Группы, связанные с определением исполнителя Example
|
|
groupsId |
Type: string[] | null Example
|
|
partners |
Type: TransferOrderTemplateGetV2Partner[] | null Исполнители Example
|
|
typeDocClose |
Type: string | null Example: |
|
typeDocDelay |
Type: string | null Example: |
Example
{
"amount": 0.5,
"comment": "example",
"currency": "example",
"dayDocClose": 0,
"dayDocDelay": 0,
"docFormat": "example",
"groups": [
{
"id": "example",
"name": "example"
}
],
"groupsId": [
"example"
],
"partners": [
{
"id": "example",
"isBlackList": true,
"name": "example",
"tin": "example"
}
],
"publicMatcher": true,
"type": "example",
"typeDocClose": "example",
"typeDocDelay": "example"
}
TransferOrderTemplateGetV2DriverAssignmentDeadline
|
Name |
Description |
|
duration |
Type: integer | null |
|
endDate |
Any of 2 types
Example
|
Example
{
"duration": 0,
"endDate": {
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
}
}
TransferOrderTemplateGetV2ExecutionSettings
|
Name |
Description |
|
driverAssignmentDeadline |
Any of 2 types
Срок на назначение водителя и ТС в секундах или по дате Example
|
Example
{
"driverAssignmentDeadline": {
"duration": 0,
"endDate": {
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
}
}
}
TransferOrderTemplateGetV2Car
|
Name |
Description |
|
id |
Type: string | null Идентификатор транспортного средства Example: |
|
version |
Type: integer | null Тип транспортного средства |
Example
{
"id": "example",
"version": 0
}
TransferOrderTemplateGetV2CompanyInfo
|
Name |
Description |
|
companyName |
Type: string | null Название компании Example: |
|
companyType |
Type: string | null Тип компании Example: |
|
country |
Type: string | null Страна Example: |
|
|
Type: string | null Почта Example: |
|
fullName |
Type: string | null ФИО Example: |
|
phone |
Type: string | null Телефон Example: |
|
tin |
Type: string | null ИНН Example: |
Example
{
"companyName": "example",
"companyType": "example",
"country": "example",
"email": "example",
"fullName": "example",
"phone": "example",
"tin": "example"
}
TransferOrderTemplateGetV2Driver
|
Name |
Description |
|
id |
Type: string | null Идентификатор водителя Example: |
|
version |
Type: integer | null Тип транспортного средства |
Example
{
"id": "example",
"version": 0
}
TransferOrderTemplateGetV2Trailer
|
Name |
Description |
|
id |
Type: string | null Идентификатор прицепа Example: |
|
version |
Type: integer | null Тип транспортного средства |
Example
{
"id": "example",
"version": 0
}
TransferOrderTemplateGetV2FlightCreator
|
Name |
Description |
|
car |
Any of 2 types
Транспортное средство Example
|
|
comment |
Type: string | null Комментарий Example: |
|
companyInfo |
Any of 2 types
Информация о компании Example
|
|
currency |
Type: string | null Валюта Example: |
|
documentsDelay |
Any of 2 types
Отсрочка документов Example
|
|
driver |
Any of 2 types
Водитель Example
|
|
externalFlightId |
Type: string | null Внешний идентификатор рейса Example: |
|
flightName |
Type: string | null Название рейса Example: |
|
isVatPayer |
Type: boolean | null Является ли плательщиком НДС |
|
price |
Type: number | null Стоимость без НДС |
|
priceComment |
Type: string | null Комментарий к цене Example: |
|
priceWithVat |
Type: number | null Стоимость с НДС |
|
trailer |
Any of 2 types
Прицеп Example
|
|
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
}
TransferOrderTemplateGetV2ForwarderGetV2
|
Name |
Description |
|
forwarderId |
Type: string Example: |
|
forwarderComment |
Type: string | null Example: |
|
forwarderName |
Type: string | null Example: |
|
forwarderTin |
Type: string | null Example: |
Example
{
"forwarderComment": "example",
"forwarderId": "example",
"forwarderName": "example",
"forwarderTin": "example"
}
TransferOrderTemplateGetV2PaymentDelayPeriodGetV2
|
Name |
Description |
|
daysDelayPeriod |
Type: integer | null |
|
paymentType |
Type: string | null Example: |
|
postPayCalendarType |
Type: string | null Example: |
Example
{
"daysDelayPeriod": 0,
"paymentType": "example",
"postPayCalendarType": "example"
}
TransferOrderTemplateGetV2NodalPointAdditionalContact
|
Name |
Description |
|
npcName |
Type: string Имя контактного лица. Example: |
|
npcPhone |
Type: string Телефон контактного лица. Example: |
|
npcCountry |
Type: string | null Страна контактного лица. Example: |
|
npcEmail |
Type: string | null Электронные адреса контактного лица. Example: |
|
npcExternalId |
Type: string | null Идентификатор контакта в системе клиента. Example: |
Example
{
"npcCountry": "example",
"npcEmail": "example",
"npcExternalId": "example",
"npcName": "example",
"npcPhone": "example"
}
TransferOrderTemplateGetV2Address
|
Name |
Description |
|
address |
Type: string @address адрес, например Example: |
|
countryCode |
Type: string @countryCode код страны Example: |
|
lat |
Type: number @lat широта |
|
lon |
Type: number @lon долгота |
|
accuracy |
Type: string | null @accuracy уровень точности Example: |
|
area |
Type: string | null @area район Example: |
|
displayAddress |
Type: string | null @display_address адрес для основного отображения, например Example: |
|
geoData |
Type: string | null Ответ геокодера или иной системы Example: |
|
house |
Type: string | null @house дом Example: |
|
locality |
Type: string | null @locality город Example: |
|
postalCode |
Type: string | null @postalCode почтовый индекс Example: |
|
province |
Type: string | null @province провинция Example: |
|
regionCode |
Type: string | null @regionCode код региона Example: |
|
street |
Type: string | null @street улица 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"
}
TransferOrderTemplateGetV2NpAddress
|
Name |
Description |
|
address |
Type: string | null Обязательно к заполнению, если не заполнено поле npAddress Example: |
|
lat |
Type: number | null Обязательно к заполнению, если не заполнено поле npAddress |
|
long |
Type: number | null Обязательно к заполнению, если не заполнено поле npAddress |
|
npAddress |
Any of 2 types
Обязательно к заполнению, если не заполнены поля lat, lon, address 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"
}
}
TransferOrderTemplateGetV2NodalPointShipmentPeriod
|
Name |
Description |
|
from |
Type: TimestampTZOutput Example
|
|
loadingTime |
Type: integer | null |
|
to |
Any of 2 types
Example
|
Example
{
"from": {
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
},
"loadingTime": 0,
"to": null
}
TransferOrderTemplateGetV2NodalPointShipment
|
Name |
Description |
|
country |
Type: string Страна разгрузки/погрузки. Example: |
|
id |
Type: string Example: |
|
npGeoAddress |
All of 1 type
Геоадрес разгрузки/погрузки. Example
|
|
period |
All of 1 type
Дата и время разгрузки/погрузки.Приходит или Date или Period Example
|
|
position |
Type: integer очередь разгрузки/погрузки. |
|
addressComment |
Type: string | null Комментарий к адресу (до 1000 символов) Example: |
|
content |
Type: string | null Содержимое разгрузки/погрузки. Example: |
|
legalAddress |
Type: string | null юридический адрес компании которая производит разгрузку/погрузку. deprecated. use npGeoLegalAddress Example: |
|
legalPhone |
Type: string | null Example: |
|
name |
Type: string | null Название разгрузки/погрузки. Example: |
|
npAdditionalContact |
Type: TransferOrderTemplateGetV2NodalPointAdditionalContact[] | null Дополнительные контакты разгрузки/погрузки. Example
|
|
npGeoLegalAddress |
Any of 2 types
Юридический Геоадрес разгрузки/погрузки. Example
|
|
npLegalType |
Type: string | null Юридический тип разгрузки/погрузки. Example: |
|
npShipmentId |
Type: string | null Идентификатор разгрузки/погрузки. Example: |
|
npTin |
Type: string | null ИНН разгрузки/погрузки. Example: |
|
phoneCountryCode |
Type: string | null Идентификатор страны компании которая производит разгрузку/погрузку Example: |
|
transshipmentTypes |
Type: string[] | null 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-01T00:00:00"
},
"loadingTime": 0,
"to": null
},
"phoneCountryCode": "example",
"position": 0,
"transshipmentTypes": [
"example"
]
}
TransferOrderTemplateGetV2PackageCargoInsurance
|
Name |
Description |
|
cargoInsurancePackageName |
Type: string Наименование товара для страховой организации Example: |
|
cargoInsuranceProductId |
Type: string Идентификатор продукта страхового агента, выбранный по умолчанию Example: |
|
insuranceOrganizationId |
Type: string Идентификатор страхового агента, выбираемая по умолчанию Example: |
|
cargoInsuranceSubProductIds |
Type: string[] | null Идентификаторы подпродуктов cтрахования груза, выбранные по умолчанию Example
|
|
comment |
Type: string | null Комментарий Example: |
|
transportationType |
Type: string[] | null Виды перевозки Example
|
Example
{
"cargoInsurancePackageName": "example",
"cargoInsuranceProductId": "example",
"cargoInsuranceSubProductIds": [
"example"
],
"comment": "example",
"insuranceOrganizationId": "example",
"transportationType": [
"example"
]
}
TransferOrderTemplateGetV2DangerousCargoGetV2
|
Name |
Description |
|
hazardClass |
Type: string Example: |
|
classificationCode |
Type: string | null Example: |
|
competentAuthoritySign |
Type: string | null Example: |
|
controlTemperature |
Type: string | null Example: |
|
description |
Type: string | null Example: |
|
emergencyTemperature |
Type: string | null Example: |
|
explosiveNetMass |
Type: string | null Example: |
|
explosiveNetMassTotal |
Type: string | null Example: |
|
hazardLabel |
Type: string | null Example: |
|
holdTimeExpiryDate |
Type: string | null Example: |
|
maxActivity |
Type: string | null Example: |
|
mixtureCompositionPercent |
Type: string | null Example: |
|
packageCategory |
Type: string | null Example: |
|
packingGroup |
Type: string | null Example: |
|
physicalChemicalDescription |
Type: string | null Example: |
|
properShippingName |
Type: string | null Example: |
|
radionuclideName |
Type: string | null Example: |
|
regulatoryAct |
Type: string | null Example: |
|
safetyIndex |
Type: string | null Example: |
|
technicalName |
Type: string | null Example: |
|
totalActivity |
Type: string | null Example: |
|
transportIndex |
Type: string | null Example: |
|
tunnelRestrictionCode |
Type: string | null Example: |
|
unHazardId |
Type: string | 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"
}
TransferOrderTemplateGetV2PackagesRuEdo
|
Name |
Description |
|
cargoState |
Type: string | null состояние груза Example: |
|
codeToVNom |
Type: string | null код товарной номенклатуры Example: |
|
dangerousCargo |
Any of 2 types
Example
|
|
mark |
Type: string[] | null маркировка Example
|
|
pkgType |
Type: string | 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"
}
TransferOrderTemplateGetV2TemperatureRegimeGetV2
|
Name |
Description |
|
from |
Type: integer | null |
|
to |
Type: integer | null |
Example
{
"from": 0,
"to": 0
}
TransferOrderTemplateGetV2PackageGetV2
|
Name |
Description |
|
hazardClass |
Type: string For backward compatibility only Example: |
|
amount |
Type: number | null |
|
capacity |
Type: number | null |
|
cargoCategory |
Any of 2 types
Новые поля Example
|
|
cargoInsurance |
Any of 2 types
Данные для страхования груза Example
|
|
comment |
Type: string | null Example: |
|
count |
Type: integer | null |
|
currency |
Type: string | null объявленная валюта Example: |
|
dimensionHeight |
Type: number | null |
|
dimensionLength |
Type: number | null |
|
dimensionWeight |
Type: number | null |
|
packageExternalId |
Type: string | null Example: |
|
packageName |
Type: string | null Example: |
|
ruEdo |
Any of 2 types
Данные для Российского ЭДО Example
|
|
shipmentBodyType |
Type: string | null Example: |
|
stackability |
Type: string | null Example: |
|
temperatureRegime |
Type: TransferOrderTemplateGetV2TemperatureRegimeGetV2[] | null Example
|
|
weight |
Type: number | null |
Example
{
"amount": 0.5,
"capacity": 0.5,
"cargoCategory": {
"category": "example",
"categoryComment": "example"
},
"cargoInsurance": {
"cargoInsurancePackageName": "example",
"cargoInsuranceProductId": "example",
"cargoInsuranceSubProductIds": [
"example"
],
"comment": "example",
"insuranceOrganizationId": "example",
"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,
"to": 0
}
],
"weight": 0.5
}
TransferOrderTemplateGetV2ShipmentGetV2
|
Name |
Description |
|
npShipment |
Type: TransferOrderTemplateGetV2NodalPointShipment Example
|
|
npUnshipment |
Type: TransferOrderTemplateGetV2NodalPointShipment Example
|
|
shipmentId |
Type: string Example: |
|
comment |
Type: string | null Example: |
|
name |
Type: string | null Example: |
|
packages |
Type: TransferOrderTemplateGetV2PackageGetV2[] | null Example
|
|
packageType |
Type: string | null Example: |
|
quantizationMethod |
Type: string | null Example: |
Example
{
"comment": "example",
"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": {}
},
"npGeoLegalAddress": null,
"npLegalType": "example",
"npShipmentId": "example",
"npTin": "example",
"period": {
"from": {
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
},
"loadingTime": 0,
"to": null
},
"phoneCountryCode": "example",
"position": 0,
"transshipmentTypes": [
"example"
]
},
"npUnshipment": null,
"packageType": "example",
"packages": [
{
"amount": 0.5,
"capacity": 0.5,
"cargoCategory": {
"category": "example",
"categoryComment": "example"
},
"cargoInsurance": {
"cargoInsurancePackageName": "example",
"cargoInsuranceProductId": "example",
"cargoInsuranceSubProductIds": [
null
],
"comment": "example",
"insuranceOrganizationId": "example",
"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,
"to": 0
}
],
"weight": 0.5
}
],
"quantizationMethod": "example",
"shipmentId": "example"
}
TransferOrderTemplateGetV2TagInfo
|
Name |
Description |
|
code |
Type: string Example: |
|
name |
Type: string Example: |
Example
{
"code": "example",
"name": "example"
}
JSONObject
Type: object
Example
{}
TransferOrderTemplateGetV2PriceGetV2
|
Name |
Description |
|
price |
Type: number |
|
currency |
Type: string | null Example: |
Example
{
"currency": "example",
"price": 0.5
}
TransferOrderTemplateGetV2VolumeAuction
|
Name |
Description |
|
auctionType |
Type: string Example: |
|
duration |
Type: integer |
|
tarifficationType |
Type: string Example: |
|
transitDistance |
Type: number |
|
endDate |
Any of 2 types
Example
|
|
flightsCount |
Type: number | null |
|
startDate |
Any of 2 types
Example
|
|
tonsCount |
Type: number | null |
|
vehicleCapacityFrom |
Type: number | null |
|
vehicleCapacityTo |
Type: number | null |
Example
{
"auctionType": "example",
"duration": 0,
"endDate": {
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
},
"flightsCount": 0.5,
"startDate": null,
"tarifficationType": "example",
"tonsCount": 0.5,
"transitDistance": 0.5,
"vehicleCapacityFrom": 0.5,
"vehicleCapacityTo": 0.5
}
TransferOrderTemplateGetV2Response
|
Name |
Description |
|
currency |
Type: string Валюта, например, "rub" Example: |
|
etrnRequired |
Type: boolean Заказ валидирует под этрн |
|
isVolumeAuction |
Type: boolean |
|
templateId |
Type: string Example: |
|
transferOrderAdditionalConfiguration |
Type: JSONObject Example
|
|
transferOrderTemplateName |
Type: string Example: |
|
additionalConditions |
Any of 2 types
Example
|
|
auction |
Any of 2 types
Example
|
|
bodyType |
Type: string[] | null Example
|
|
bodyTypeComment |
Type: string | null Example: |
|
cargoCategory |
Any of 2 types
Example
|
|
cargoComment |
Type: string | null Example: |
|
cargoId |
Type: string | null Example: |
|
customer |
Any of 2 types
Example
|
|
dimensions |
Any of 2 types
Example
|
|
distribution |
Any of 2 types
Example
|
|
executionSettings |
Any of 2 types
Дополнительные настройки исполнения заказа Example
|
|
flightCreator |
Any of 2 types
Информация о создателе рейса Example
|
|
forwarder |
Any of 2 types
Example
|
|
freeTags |
Type: string[] | null Теги заказчика Example
|
|
paymentDelayPeriod |
Any of 2 types
Example
|
|
shipments |
Type: TransferOrderTemplateGetV2ShipmentGetV2[] | null Example
|
|
tagId |
Type: string | null Example: |
|
tagsInfo |
Type: TransferOrderTemplateGetV2TagInfo[] | null Теги заказчика (информация о тегах) Example
|
|
temperatureRegime |
Type: TransferOrderTemplateGetV2TemperatureRegimeGetV2[] | null Example
|
|
transferOrderAdditionalConditions |
Type: string | null Example: |
|
transferOrderCost |
Any of 2 types
Example
|
|
transferOrderName |
Type: string | null Example: |
|
transferOrderType |
Type: string | null Example: |
|
transshipmentTypes |
Type: string[] | null Example
|
|
typePaymentAndTax |
Type: string | null Example: |
|
volumeAuction |
Any of 2 types
Example
|
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
},
"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-01T00:00:00"
},
"hideBidsFromCarrier": true,
"startDate": null,
"tariffMatrixParams": {
"isWhoFirst": true
},
"useTariffMatrix": true,
"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",
"groups": [
{
"id": "example",
"name": "example"
}
],
"groupsId": [
"example"
],
"partners": [
{
"id": "example",
"isBlackList": true,
"name": "example",
"tin": "example"
}
],
"publicMatcher": true,
"type": "example",
"typeDocClose": "example",
"typeDocDelay": "example"
},
"etrnRequired": true,
"executionSettings": {
"driverAssignmentDeadline": {
"duration": 0,
"endDate": null
}
},
"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,
"paymentDelayPeriod": {
"daysDelayPeriod": 0,
"paymentType": "example",
"postPayCalendarType": "example"
},
"shipments": [
{
"comment": "example",
"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,
"transshipmentTypes": [
"example"
]
},
"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",
"shipmentId": "example"
}
],
"tagId": "example",
"tagsInfo": [
{
"code": "example",
"name": "example"
}
],
"temperatureRegime": [
{
"from": 0,
"to": 0
}
],
"templateId": "example",
"transferOrderAdditionalConditions": "example",
"transferOrderAdditionalConfiguration": {},
"transferOrderCost": {
"currency": "example",
"price": 0.5
},
"transferOrderName": "example",
"transferOrderTemplateName": "example",
"transferOrderType": "example",
"transshipmentTypes": [
"example"
],
"typePaymentAndTax": "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
}
}
400 Bad Request
Bad Request
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|
Error
|
Name |
Description |
|
info |
Type: object Example
|
|
message |
Type: string Example: |
|
message_code |
Type: string Example: |
Example
{
"info": {},
"message": "example",
"message_code": "example"
}
403 Forbidden
Forbidden
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|
500 Internal Server Error
Internal Server Error
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|