Создать шаблон заказа

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

Назначение

Сохраните параметры заказа как шаблон для выбранной организации заказчика. Укажите название в data.transferOrderTemplateName и сохраните идентификатор из data.templateId.

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

Request

POST

https://partner-test-yamagistrali.ru/api/transferOrderTemplate/create/v2

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

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,
      "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"
    },
    "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,
    "meta": {
      "conditions": [
        {
          "conditionsTemplateId": "example",
          "conditionsTemplateType": "example",
          "conditionsTemplateVersion": "example",
          "executorId": "example",
          "variables": null
        }
      ]
    },
    "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",
          "npTin": "example",
          "period": null,
          "phoneCountryCode": "example",
          "position": 0,
          "transshipmentTypes": [
            null
          ]
        },
        "npUnshipment": null,
        "packageType": "example",
        "packages": [
          {}
        ],
        "quantizationMethod": "example"
      }
    ],
    "tagId": "example",
    "temperatureRegime": [
      {
        "from": 0,
        "to": 0
      }
    ],
    "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: TransferOrderTemplateCreateV2Request

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
    },
    "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",
    "groupsId": [
      "example"
    ],
    "partners": [
      {
        "id": "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,
  "meta": {
    "conditions": [
      {
        "conditionsTemplateId": "example",
        "conditionsTemplateType": "example",
        "conditionsTemplateVersion": "example",
        "executorId": "example",
        "variables": {}
      }
    ]
  },
  "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",
        "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,
          "packageExternalId": "example",
          "packageName": "example",
          "ruEdo": null,
          "shipmentBodyType": "example",
          "stackability": "example",
          "temperatureRegime": [
            null
          ],
          "weight": 0.5
        }
      ],
      "quantizationMethod": "example"
    }
  ],
  "tagId": "example",
  "temperatureRegime": [
    {
      "from": 0,
      "to": 0
    }
  ],
  "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
  }
}

TransferOrderTemplateCreateV2DocumentsDelay

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
}

TransferOrderTemplateCreateV2AdditionalConditions

Name	Description
additionalComment	Type: string \| null Комментарий Example: `example`
currency	Type: string \| null Валюта (селектор) Example: `example`
documentsDelay	Any of 2 types Type: TransferOrderTemplateCreateV2DocumentsDelay 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
}

TransferOrderTemplateCreateV2AgreementRules

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"
}

TransferOrderTemplateCreateV2TariffMatrixParams

Name

Description

isWhoFirst

Type: boolean

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

Example

{
  "isWhoFirst": true
}

TransferOrderTemplateCreateV2AuctionCreateV2

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 без учёта НДС
bidStep	Type: number \| null
buyNowPrice	Type: number \| 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" }`
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 Type: TransferOrderTemplateCreateV2TariffMatrixParams Example `{ "isWhoFirst": true }` Type: object \| null Const: `null` Example `{}` Параметры Тарифной матрицы Example `{ "isWhoFirst": true }`

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
  },
  "useTariffMatrix": true,
  "vatInPriceNotConsider": true
}

TransferOrderTemplateCreateV2CargoCategoryCreateV2

Name

Description

category

Type: string | null

Example: example

categoryComment

Type: string | null

Example: example

Example

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

TransferOrderTemplateCreateV2CustomerCreateV2

Name	Description
customerAddress	Type: string Example: `example`
customerCountry	Type: string Example: `example`
customerForwarderId	Type: string Example: `example`
customerLegalForm	Type: string Example: `example`
customerName	Type: string Example: `example`
customerPhone	Type: string Example: `example`
customerTin	Type: string Example: `example`
customerCargoPrice	Type: number \| null
customerComment	Type: string \| null Example: `example`

Example

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

TransferOrderTemplateCreateV2DimensionsCreateV2

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
}

TransferOrderTemplateCreateV2Partner

Name

Description

Type: string

Example: example

tin

Type: string

Example: example

Example

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

TransferOrderTemplateCreateV2DistributionCreateV2

Name	Description
comment	Type: string Example: `example`
publicMatcher	Type: boolean
type	Type: string Example: `example`
amount	Type: number \| null
currency	Type: string \| null Example: `example`
dayDocClose	Type: integer \| null
dayDocDelay	Type: integer \| null
docFormat	Type: string \| null Example: `example`
groupsId	Type: string[] \| null Example `[ "example" ]`
partners	Type: TransferOrderTemplateCreateV2Partner[] \| null Исполнители Example `[ { "id": "example", "tin": "example" } ]`
typeDocClose	Type: string \| null Example: `example`
typeDocDelay	Type: string \| null Example: `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"
}

TransferOrderTemplateCreateV2DriverAssignmentDeadline

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"
  }
}

TransferOrderTemplateCreateV2ExecutionSettings

Name

Description

driverAssignmentDeadline

Any of 2 types

Type: TransferOrderTemplateCreateV2DriverAssignmentDeadline

Example

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

Type: object | null

Const: null
Example
```
{}
```

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

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"
    }
  }
}

TransferOrderTemplateCreateV2Car

Name

Description

Type: string | null

Идентификатор транспортного средства

Example: example

version

Type: integer | null

Тип транспортного средства

Example

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

TransferOrderTemplateCreateV2CompanyInfo

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"
}

TransferOrderTemplateCreateV2Driver

Name

Description

Type: string | null

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

Example: example

version

Type: integer | null

Тип транспортного средства

Example

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

TransferOrderTemplateCreateV2Trailer

Name

Description

Type: string | null

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

Example: example

version

Type: integer | null

Тип транспортного средства

Example

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

TransferOrderTemplateCreateV2FlightCreator

Name	Description
car	Any of 2 types Type: TransferOrderTemplateCreateV2Car Example `{ "id": "example", "version": 0 }` Type: object \| null Const: `null` Example `{}` Транспортное средство Example `{ "id": "example", "version": 0 }`
comment	Type: string \| null Комментарий Example: `example`
companyInfo	Any of 2 types Type: TransferOrderTemplateCreateV2CompanyInfo 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: TransferOrderTemplateCreateV2DocumentsDelay 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 Type: TransferOrderTemplateCreateV2Driver Example `{ "id": "example", "version": 0 }` Type: object \| null Const: `null` Example `{}` Водитель 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 Type: TransferOrderTemplateCreateV2Trailer Example `{ "id": "example", "version": 0 }` Type: object \| null Const: `null` Example `{}` Прицеп 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
}

TransferOrderTemplateCreateV2ForwarderCreateV2

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

{}

TransferOrderTemplateCreateV2Conditions

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": {}
}

TransferOrderTemplateCreateV2Meta

Name	Description
conditions	Type: TransferOrderTemplateCreateV2Conditions[] \| null Example `[ { "conditionsTemplateId": "example", "conditionsTemplateType": "example", "conditionsTemplateVersion": "example", "executorId": "example", "variables": {} } ]`

Example

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

TransferOrderTemplateCreateV2PaymentDelayPeriodCreateV2

Name	Description
daysDelayPeriod	Type: integer \| null
paymentType	Type: string \| null Example: `example`
postPayCalendarType	Type: string \| null Example: `example`

Example

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

TransferOrderTemplateCreateV2NodalPointAdditionalContact

Name	Description
npcName	Type: string Имя контактного лица. Example: `example`
npcPhone	Type: string Телефон контактного лица. Example: `example`
npcCountry	Type: string \| null Страна контактного лица. Example: `example`
npcEmail	Type: string \| null Email-адреса контактного лица. Example: `example`
npcExternalId	Type: string \| null Идентификатор контакта в системе клиента. Example: `example`

Example

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

TransferOrderTemplateCreateV2Address

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"
}

TransferOrderTemplateCreateV2NpAddress

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: TransferOrderTemplateCreateV2Address 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"
  }
}

TransferOrderTemplateCreateV2NodalPointShipmentPeriod

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
}

TransferOrderTemplateCreateV2NodalPointCreateV2

Name	Description
content	Type: string Содержимое разгрузки/погрузки. Example: `example`
country	Type: string Идентификатор разгрузки/погрузки. Страна разгрузки/погрузки. Example: `example`
npGeoAddress	All of 1 type Type: TransferOrderTemplateCreateV2NpAddress 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 Type: TransferOrderTemplateCreateV2NodalPointShipmentPeriod Example `{ "from": { "displayTZ": "+03:00", "time": "2020-01-01T11:47:38+03:00", "useLocation": "+05:00" }, "loadingTime": 0, "to": null }` Дата и время разгрузки/погрузки.Приходит или 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 Комментарий к адресу. Example: `example`
id	Type: string \| null Идентификатор разгрузки/погрузки. Example: `example`
legalAddress	Type: string \| null юридический адрес компании которая производит разгрузку/погрузку Example: `example`
legalPhone	Type: string \| null Example: `example`
name	Type: string \| null Название разгрузки/погрузки. Example: `example`
npAdditionalContact	Type: TransferOrderTemplateCreateV2NodalPointAdditionalContact[] \| null Дополнительные контакты разгрузки/погрузки. Example `[ { "npcCountry": "example", "npcEmail": "example", "npcExternalId": "example", "npcName": "example", "npcPhone": "example" } ]`
npGeoLegalAddress	Any of 2 types Type: TransferOrderTemplateCreateV2NpAddress 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`
npTin	Type: string \| null ИНН разгрузки/погрузки. Example: `example`
phoneCountryCode	Type: string \| null Идентификатор страны компании которая производит разгрузку/погрузку Example: `example`
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",
  "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,
  "transshipmentTypes": [
    "example"
  ]
}

TransferOrderTemplateCreateV2PackageCargoInsurance

Name	Description
cargoInsurancePackageName	Type: string Наименование товара для страховой организации Example: `example`
cargoInsuranceProductId	Type: string Идентификатор продукта страхового агента, выбранный по умолчанию Example: `example`
insuranceOrganizationId	Type: string Идентификатор страхового агента, выбираемая по умолчанию Example: `example`
cargoInsuranceSubProductIds	Type: string[] \| null Идентификаторы подпродуктов cтрахования груза, выбранные по умолчанию Example `[ "example" ]`
comment	Type: string \| null Комментарий Example: `example`
transportationType	Type: string[] \| null Виды перевозки Example `[ "example" ]`

Example

{
  "cargoInsurancePackageName": "example",
  "cargoInsuranceProductId": "example",
  "cargoInsuranceSubProductIds": [
    "example"
  ],
  "comment": "example",
  "insuranceOrganizationId": "example",
  "transportationType": [
    "example"
  ]
}

TransferOrderTemplateCreateV2DangerousCargoCreateV2

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"
}

TransferOrderTemplateCreateV2PackagesRuEdo

Name	Description
cargoState	Type: string \| null состояние груза Example: `example`
codeToVNom	Type: string \| null код товарной номенклатуры Example: `example`
dangerousCargo	Any of 2 types Type: TransferOrderTemplateCreateV2DangerousCargoCreateV2 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"
}

TransferOrderTemplateCreateV2TemperatureRegimeCreateV2

Name	Description
from	Type: integer \| null
to	Type: integer \| null

Example

{
  "from": 0,
  "to": 0
}

TransferOrderTemplateCreateV2PackageCreateV2

Name	Description
amount	Type: number \| null
capacity	Type: number \| null
cargoCategory	Any of 2 types Type: TransferOrderTemplateCreateV2CargoCategoryCreateV2 Example `{ "category": "example", "categoryComment": "example" }` Type: object \| null Const: `null` Example `{}` Example `{ "category": "example", "categoryComment": "example" }`
cargoInsurance	Any of 2 types Type: TransferOrderTemplateCreateV2PackageCargoInsurance Example `{ "cargoInsurancePackageName": "example", "cargoInsuranceProductId": "example", "cargoInsuranceSubProductIds": [ "example" ], "comment": "example", "insuranceOrganizationId": "example", "transportationType": [ "example" ] }` Type: object \| null Const: `null` Example `{}` Данные для страхования груза Example `{ "cargoInsurancePackageName": "example", "cargoInsuranceProductId": "example", "cargoInsuranceSubProductIds": [ "example" ], "comment": "example", "insuranceOrganizationId": "example", "transportationType": [ "example" ] }`
comment	Type: string \| null Example: `example`
count	Type: integer \| null
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: TransferOrderTemplateCreateV2PackagesRuEdo 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`
stackability	Type: string \| null Example: `example`
temperatureRegime	Type: TransferOrderTemplateCreateV2TemperatureRegimeCreateV2[] \| null Example `[ { "from": 0, "to": 0 } ]`
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,
  "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
}

TransferOrderTemplateCreateV2ShipmentCreateV2

Name	Description
npShipment	Type: TransferOrderTemplateCreateV2NodalPointCreateV2 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", "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, "transshipmentTypes": [ "example" ] }
npUnshipment	Type: TransferOrderTemplateCreateV2NodalPointCreateV2 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", "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, "transshipmentTypes": [ "example" ] }
comment	Type: string \| null Example: `example`
name	Type: string \| null Example: `example`
packages	Type: TransferOrderTemplateCreateV2PackageCreateV2[] \| 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, "packageExternalId": "example", "packageName": "example", "ruEdo": { "cargoState": "example", "codeToVNom": "example", "dangerousCargo": {}, "mark": [ "example" ], "pkgType": "example" }, "shipmentBodyType": "example", "stackability": "example", "temperatureRegime": [ { "from": 0, "to": 0 } ], "weight": 0.5 } ]
packageType	Type: string \| null Example: `example`
quantizationMethod	Type: string \| null Example: `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",
    "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,
    "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,
      "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"
}

JSONObject

Type: object

Example

{}

TransferOrderTemplateCreateV2PriceCreateV2

Name

Description

price

Type: number

currency

Type: string | null

Example: example

Example

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

TransferOrderTemplateCreateV2VolumeAuction

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
}

TransferOrderTemplateCreateV2Request

Name	Description
currency	Type: string Example: `example`
etrnRequired	Type: boolean Заказ валидирует под этрн
forwarder	Type: TransferOrderTemplateCreateV2ForwarderCreateV2 Example `{ "forwarderComment": "example", "forwarderId": "example", "forwarderName": "example", "forwarderTin": "example" }`
isVolumeAuction	Type: boolean
meta	Type: TransferOrderTemplateCreateV2Meta Example `{ "conditions": [ { "conditionsTemplateId": "example", "conditionsTemplateType": "example", "conditionsTemplateVersion": "example", "executorId": "example", "variables": {} } ] }`
transferOrderAdditionalConfiguration	Type: JSONObject Example `{}`
transferOrderTemplateName	Type: string Example: `example`
additionalConditions	Any of 2 types Type: TransferOrderTemplateCreateV2AdditionalConditions 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: TransferOrderTemplateCreateV2AgreementRules 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: TransferOrderTemplateCreateV2AuctionCreateV2 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 }, "useTariffMatrix": true, "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 }, "useTariffMatrix": true, "vatInPriceNotConsider": true }
bodyType	Type: string[] \| null Example `[ "example" ]`
bodyTypeComment	Type: string \| null Example: `example`
cargoCategory	Any of 2 types Type: TransferOrderTemplateCreateV2CargoCategoryCreateV2 Example `{ "category": "example", "categoryComment": "example" }` Type: object \| null Const: `null` Example `{}` Example `{ "category": "example", "categoryComment": "example" }`
cargoComment	Type: string \| null Example: `example`
cargoId	Type: string \| null Example: `example`
customer	Any of 2 types Type: TransferOrderTemplateCreateV2CustomerCreateV2 Example `{ "customerAddress": "example", "customerCargoPrice": 0.5, "customerComment": "example", "customerCountry": "example", "customerForwarderId": "example", "customerLegalForm": "example", "customerName": "example", "customerPhone": "example", "customerTin": "example" }` Type: object \| null Const: `null` Example `{}` Example `{ "customerAddress": "example", "customerCargoPrice": 0.5, "customerComment": "example", "customerCountry": "example", "customerForwarderId": "example", "customerLegalForm": "example", "customerName": "example", "customerPhone": "example", "customerTin": "example" }`
dimensions	Any of 2 types Type: TransferOrderTemplateCreateV2DimensionsCreateV2 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: TransferOrderTemplateCreateV2DistributionCreateV2 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 `{}` 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: TransferOrderTemplateCreateV2ExecutionSettings 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": {} } }`
flightCreator	Any of 2 types Type: TransferOrderTemplateCreateV2FlightCreator 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" ]`
paymentDelayPeriod	Any of 2 types Type: TransferOrderTemplateCreateV2PaymentDelayPeriodCreateV2 Example `{ "daysDelayPeriod": 0, "paymentType": "example", "postPayCalendarType": "example" }` Type: object \| null Const: `null` Example `{}` Example `{ "daysDelayPeriod": 0, "paymentType": "example", "postPayCalendarType": "example" }`
shipments	Type: TransferOrderTemplateCreateV2ShipmentCreateV2[] \| null 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": null }, "npGeoLegalAddress": null, "npLegalType": "example", "npTin": "example", "period": { "from": {}, "loadingTime": 0, "to": null }, "phoneCountryCode": "example", "position": 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, "packageExternalId": "example", "packageName": "example", "ruEdo": {}, "shipmentBodyType": "example", "stackability": "example", "temperatureRegime": [ {} ], "weight": 0.5 } ], "quantizationMethod": "example" } ]
tagId	Type: string \| null Example: `example`
temperatureRegime	Type: TransferOrderTemplateCreateV2TemperatureRegimeCreateV2[] \| null Example `[ { "from": 0, "to": 0 } ]`
transferOrderAdditionalConditions	Type: string \| null Example: `example`
transferOrderCost	Any of 2 types Type: TransferOrderTemplateCreateV2PriceCreateV2 Example `{ "currency": "example", "price": 0.5 }` Type: object \| null Const: `null` Example `{}` Example `{ "currency": "example", "price": 0.5 }`
transferOrderName	Type: string \| null Example: `example`
transferOrderType	Type: string \| null Example: `example`
transshipmentTypes	Type: string[] \| null Example `[ "example" ]`
typePaymentAndTax	Type: string \| null Example: `example`
volumeAuction	Any of 2 types Type: TransferOrderTemplateCreateV2VolumeAuction 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
    },
    "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",
    "groupsId": [
      "example"
    ],
    "partners": [
      {
        "id": "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,
  "meta": {
    "conditions": [
      {
        "conditionsTemplateId": "example",
        "conditionsTemplateType": "example",
        "conditionsTemplateVersion": "example",
        "executorId": "example",
        "variables": {}
      }
    ]
  },
  "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",
        "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,
          "packageExternalId": "example",
          "packageName": "example",
          "ruEdo": null,
          "shipmentBodyType": "example",
          "stackability": "example",
          "temperatureRegime": [
            null
          ],
          "weight": 0.5
        }
      ],
      "quantizationMethod": "example"
    }
  ],
  "tagId": "example",
  "temperatureRegime": [
    {
      "from": 0,
      "to": 0
    }
  ],
  "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
  }
}

Responses

200 OK

Body

application/json

{
  "data": {
    "templateId": "example"
  }
}

Name	Description
data	Type: TransferOrderTemplateCreateV2Response Example `{ "templateId": "example" }`

TransferOrderTemplateCreateV2Response

Name

Description

templateId

Type: string

Example: example

Example

{
  "templateId": "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" }`

409 Conflict

Шаблон с таким именем уже есть у выбранной организации

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" }`

Обновить заказ на перевозку

Получить шаблон заказа

Создать шаблон заказа

НазначениеНазначение

RequestRequest

BodyBody

TransferOrderTemplateCreateV2DocumentsDelayTransferOrderTemplateCreateV2DocumentsDelay

TransferOrderTemplateCreateV2AdditionalConditionsTransferOrderTemplateCreateV2AdditionalConditions

TransferOrderTemplateCreateV2AgreementRulesTransferOrderTemplateCreateV2AgreementRules

TimestampTZInputTimestampTZInput

TransferOrderTemplateCreateV2TariffMatrixParamsTransferOrderTemplateCreateV2TariffMatrixParams

TransferOrderTemplateCreateV2AuctionCreateV2TransferOrderTemplateCreateV2AuctionCreateV2

TransferOrderTemplateCreateV2CargoCategoryCreateV2TransferOrderTemplateCreateV2CargoCategoryCreateV2

TransferOrderTemplateCreateV2CustomerCreateV2TransferOrderTemplateCreateV2CustomerCreateV2

TransferOrderTemplateCreateV2DimensionsCreateV2TransferOrderTemplateCreateV2DimensionsCreateV2

TransferOrderTemplateCreateV2PartnerTransferOrderTemplateCreateV2Partner

TransferOrderTemplateCreateV2DistributionCreateV2TransferOrderTemplateCreateV2DistributionCreateV2

TransferOrderTemplateCreateV2DriverAssignmentDeadlineTransferOrderTemplateCreateV2DriverAssignmentDeadline

TransferOrderTemplateCreateV2ExecutionSettingsTransferOrderTemplateCreateV2ExecutionSettings

TransferOrderTemplateCreateV2CarTransferOrderTemplateCreateV2Car

TransferOrderTemplateCreateV2CompanyInfoTransferOrderTemplateCreateV2CompanyInfo

TransferOrderTemplateCreateV2DriverTransferOrderTemplateCreateV2Driver

TransferOrderTemplateCreateV2TrailerTransferOrderTemplateCreateV2Trailer

TransferOrderTemplateCreateV2FlightCreatorTransferOrderTemplateCreateV2FlightCreator

TransferOrderTemplateCreateV2ForwarderCreateV2TransferOrderTemplateCreateV2ForwarderCreateV2

MapStringStringMapStringString

TransferOrderTemplateCreateV2ConditionsTransferOrderTemplateCreateV2Conditions

TransferOrderTemplateCreateV2MetaTransferOrderTemplateCreateV2Meta

TransferOrderTemplateCreateV2PaymentDelayPeriodCreateV2TransferOrderTemplateCreateV2PaymentDelayPeriodCreateV2

TransferOrderTemplateCreateV2NodalPointAdditionalContactTransferOrderTemplateCreateV2NodalPointAdditionalContact

TransferOrderTemplateCreateV2AddressTransferOrderTemplateCreateV2Address

TransferOrderTemplateCreateV2NpAddressTransferOrderTemplateCreateV2NpAddress

TransferOrderTemplateCreateV2NodalPointShipmentPeriodTransferOrderTemplateCreateV2NodalPointShipmentPeriod

TransferOrderTemplateCreateV2NodalPointCreateV2TransferOrderTemplateCreateV2NodalPointCreateV2

TransferOrderTemplateCreateV2PackageCargoInsuranceTransferOrderTemplateCreateV2PackageCargoInsurance

TransferOrderTemplateCreateV2DangerousCargoCreateV2TransferOrderTemplateCreateV2DangerousCargoCreateV2

TransferOrderTemplateCreateV2PackagesRuEdoTransferOrderTemplateCreateV2PackagesRuEdo

TransferOrderTemplateCreateV2TemperatureRegimeCreateV2TransferOrderTemplateCreateV2TemperatureRegimeCreateV2

TransferOrderTemplateCreateV2PackageCreateV2TransferOrderTemplateCreateV2PackageCreateV2

TransferOrderTemplateCreateV2ShipmentCreateV2TransferOrderTemplateCreateV2ShipmentCreateV2

JSONObjectJSONObject

TransferOrderTemplateCreateV2PriceCreateV2TransferOrderTemplateCreateV2PriceCreateV2

TransferOrderTemplateCreateV2VolumeAuctionTransferOrderTemplateCreateV2VolumeAuction

TransferOrderTemplateCreateV2RequestTransferOrderTemplateCreateV2Request

ResponsesResponses

200 OK200 OK

BodyBody

TransferOrderTemplateCreateV2ResponseTransferOrderTemplateCreateV2Response

400 Bad Request400 Bad Request

BodyBody

ErrorError

403 Forbidden403 Forbidden

BodyBody

409 Conflict409 Conflict

BodyBody

500 Internal Server Error500 Internal Server Error

BodyBody

Назначение

Request

Body

TransferOrderTemplateCreateV2DocumentsDelay

TransferOrderTemplateCreateV2AdditionalConditions

TransferOrderTemplateCreateV2AgreementRules

TimestampTZInput

TransferOrderTemplateCreateV2TariffMatrixParams

TransferOrderTemplateCreateV2AuctionCreateV2

TransferOrderTemplateCreateV2CargoCategoryCreateV2

TransferOrderTemplateCreateV2CustomerCreateV2

TransferOrderTemplateCreateV2DimensionsCreateV2

TransferOrderTemplateCreateV2Partner

TransferOrderTemplateCreateV2DistributionCreateV2

TransferOrderTemplateCreateV2DriverAssignmentDeadline

TransferOrderTemplateCreateV2ExecutionSettings

TransferOrderTemplateCreateV2Car

TransferOrderTemplateCreateV2CompanyInfo

TransferOrderTemplateCreateV2Driver

TransferOrderTemplateCreateV2Trailer

TransferOrderTemplateCreateV2FlightCreator

TransferOrderTemplateCreateV2ForwarderCreateV2

MapStringString

TransferOrderTemplateCreateV2Conditions

TransferOrderTemplateCreateV2Meta

TransferOrderTemplateCreateV2PaymentDelayPeriodCreateV2

TransferOrderTemplateCreateV2NodalPointAdditionalContact

TransferOrderTemplateCreateV2Address

TransferOrderTemplateCreateV2NpAddress

TransferOrderTemplateCreateV2NodalPointShipmentPeriod

TransferOrderTemplateCreateV2NodalPointCreateV2

TransferOrderTemplateCreateV2PackageCargoInsurance

TransferOrderTemplateCreateV2DangerousCargoCreateV2

TransferOrderTemplateCreateV2PackagesRuEdo

TransferOrderTemplateCreateV2TemperatureRegimeCreateV2

TransferOrderTemplateCreateV2PackageCreateV2

TransferOrderTemplateCreateV2ShipmentCreateV2

JSONObject

TransferOrderTemplateCreateV2PriceCreateV2

TransferOrderTemplateCreateV2VolumeAuction

TransferOrderTemplateCreateV2Request

Responses

200 OK

Body

TransferOrderTemplateCreateV2Response

400 Bad Request

Body

Error

403 Forbidden

Body

409 Conflict

Body

500 Internal Server Error

Body