API Экспресс-накладная

Работа с экспресс-накладными

Расчитать стоимость услуг

Метод «getDocumentPrice», работает в модели «InternetDocument», этот метод позволяет рассчитать стоимости доставки груза.

Метод позволят просчитывать не только отправления грузов но и шин и дисков, паллет а также документов
Пример просчета стоимости Шин и Дисков:
"CargoType": "TiresWheels", //Тип отправления Шины и Диски
"CargoDetails": [{ // Массив с данными
"CargoDescription":"d7c456cf-aa8b-11e3-9fa0-0050568002cf", // Идентификатор типа отправления Шина R-13, из справочника Виды шин и дисков
"Amount": "2" //Количество шин
}]

Пример просчета стоимости грузов с передачей параметров:
"OptionsSeat": [{ // Массив с данными
"weight": 5, // вес отправления, кг
"volumetricWidth": 80, // ширина отправления, см
"volumetricLength": 25, // длинна отправления, см
"volumetricHeight": 25, // высота отправления, см
}]

Также доступен просчет стоимости с учетом стоимости упаковки из соответственного справочника "Виды упаковки". Идентификатор упаковки необходимо передавать в массиве "OptionsSeat"
Пример:
"OptionsSeat": [{ // Массив с данными
"weight": 5, // вес отправления, кг
"volumetricWidth": 80, // ширина отправления, см
"volumetricLength": 25, // длинна отправления, см
"volumetricHeight": 25, // высота отправления, см
"packRef": "1499fa4a-d26e-11e1-95e4-0026b97ed48a"
}],

URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/


Доступность: Требует использования API-ключа.

Try it

URL-адрес запроса

Параметры запроса

string

Форматы JSON, XML

Заголовки запросов

(дополнительный)
string
Тип формата текста, отправляемого в API.

Текст запроса

Основные параметры

Параметр Тип данных Описание
modelName* string Имя модели
calledMethod* string Имя вызываемого метода
methodProperties*   Свойства метода
CitySender* string[36] Код города отправителя
CityRecipient* string[36] код города получателя
Weight* int[36] min - 0,1 Вес фактический
ServiceType* int[36] Тип услуги
Cost* int[36] Целое число, объявленная стоимость (если объявленная стоимость не указана, API автоматически подставит минимальную объявленную цену - 300.00
CargoType* string[36] Значение из справочника Тип груза: Cargo, Documents, TiresWheels, Pallet
SeatsAmount* string[36] Целое число, количество мест отправления
RedeliveryCalculate string[36] Обратная доставка
PackCount int[36] Кол-во упаковок
PackRef int[36] Идентификатор упаковки
Amount int[36] Целое число
CargoDetails string[36] Массив
* Обозначение обязательного параметра

<?xml version="1.0" encoding="UTF-8" ?>
<root>
<modelName>InternetDocument</modelName>
<calledMethod>getDocumentPrice</calledMethod>
<methodProperties>
    <CitySender>8d5a980d-391c-11dd-90d9-001a92567626</CitySender>
    <CityRecipient>db5c88e0-391c-11dd-90d9-001a92567626</CityRecipient>
    <Weight>10</Weight>
    <ServiceType>WarehouseWarehouse</ServiceType>
    <Cost>100</Cost>
    <CargoType>Cargo</CargoType>
    <SeatsAmount>1</SeatsAmount>
    <RedeliveryCalculate>
        <CargoType>Money</CargoType>
        <Amount>100</Amount>
    </RedeliveryCalculate>
    <OptionsSeat>
    <item>
        <weight>2</weight>
        <volumetricWidth>1</volumetricWidth>
        <volumetricLength>1</volumetricLength>
        <volumetricHeight>1</volumetricHeight>
        <packRef>f6f72e4d-5daf-11e3-b441-0050568002cf</packRef>
        </item>
    </OptionsSeat>
</methodProperties>
</root>
{
  "modelName": "InternetDocument",
  "calledMethod": "getDocumentPrice",
  "methodProperties": {
    "CitySender": "8d5a980d-391c-11dd-90d9-001a92567626",
    "CityRecipient": "db5c88e0-391c-11dd-90d9-001a92567626",
    "Weight": "10",
    "ServiceType": "WarehouseWarehouse",
    "Cost": "100",
    "CargoType": "Cargo",
    "SeatsAmount": "1",
    "RedeliveryCalculate": {
      "CargoType": "Money",
      "Amount": "100"
    },
    "OptionsSeat": [
      {
        "weight": 5,
        "volumetricWidth": 80,
        "volumetricLength": 25,
        "volumetricHeight": 25,
        "packRef": "f6f72e4d-5daf-11e3-b441-0050568002cf"
      }
    ]
  }
}

Ответ 200

Всегда возвращает код 200 даже при логических ошибках.


Тело ответа на запрос

Параметр Тип данных Описание
AssessedCost int[36] Оценочная стоимость
Cost int[36] Cтоимость
CostRedelivery int[36] Cтоимость обратной доставки

{
  "success": true,
  "data": [
    {
      "AssessedCost": 100,
      "Cost": 65,
      "CostRedelivery": 37,
      "TZoneInfo": {
        "TzoneName": "Тарифна зона: Тарифна зона 4",
        "TzoneID": "4"
      },
      "CostPack": 4
    }
  ],
  "errors": [],
  "warnings": [
    "DateTime is set to current"
  ],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [
    "30000200880"
  ],
  "infoCodes": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <AssessedCost>100</AssessedCost>
            <Cost>50</Cost>
            <CostRedelivery>22</CostRedelivery>
            <TZoneInfo>
                <TzoneName>Тарифна зона: Тарифна зона 4</TzoneName>
                <TzoneID>4</TzoneID>
            </TZoneInfo>
            <CostPack>4</CostPack>
        </item>
    </data>
    <errors/>
    <warnings>
        <item>DateTime is set to current</item>
    </warnings>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes>
        <item>30000200880</item>
    </warningCodes>
    <infoCodes/>
</root>