Фрахт

Робота із заявками на перевезення вантажів

🔗Початок роботи з API

Отримати список заявок (JSON)

post

Метод getFreightList моделі Freight дозволяє отримати список заявок на фрахт.

Body

application/json

apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]

modelNamestring · enumRequired

Назва моделі API

Possible values:

calledMethodstring · enumRequired

Назва методу API

Possible values:

Responses

200

Успішна відповідь (JSON)

application/json

successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/

HTTPcURLJavaScriptPython

POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 354

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "FreightGeneral",
  "calledMethod": "getFreightList",
  "methodProperties": {
    "Ref": "",
    "Number": "",
    "DateTime": "",
    "DeclaredCost": "",
    "Status": "",
    "DateTimeVehicleFiling": "",
    "SenderSettlement": "",
    "RecipientSettlement": "",
    "Customer": "",
    "CustomerContactName": "",
    "CustomerPhone": "",
    "Weight": "",
    "Volume": "",
    "Page": "",
    "Limit": ""
  }
}

200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "",
      "Number": "",
      "DateTime": "",
      "DeletionMark": "0",
      "Status": "",
      "DeniedReason": "",
      "DateTimeVehicleFiling": "",
      "DateTimeVehicleDeparture": "",
      "DateTimeVehicleArrival": "",
      "DateTimeVehicleUnloading": "",
      "CargoDescriptionString": "",
      "DeclaredCost": "",
      "Cost": "",
      "Weight": "",
      "Length": "",
      "Width": "",
      "Height": "",
      "Volume": "",
      "SemiTrailerType": "",
      "Customer": "",
      "CustomerContactName": "",
      "CustomerPhone": "",
      "CustomerEMail": "",
      "SenderSettlement": "",
      "SenderAddressString": "",
      "SenderString": "",
      "SenderName": "",
      "SenderPhone": "",
      "SenderEMail": "",
      "RecipientSettlement": "",
      "RecipientAddressString": "",
      "RecipientString": "",
      "RecipientName": "",
      "RecipientPhone": "",
      "RecipientEMail": "",
      "AdditionalInformation": "",
      "IntermediateStoppingPoints": {
        "1": {
          "Settlement": "e718a680-4b33-11e4-ab6d-005056801329",
          "SettlementDescription": "Київ",
          "AddressDescription": "Карельский переулок, 5",
          "DateTimeVehicleDeparture": "2022-04-27 02:00:00",
          "DateTimeVehicleArrival": "2022-04-27 01:00:00",
          "ContactName": "Федишин Любов Миколаївна",
          "Phone": "380961111111"
        },
        "2": {
          "Settlement": "e718a680-4b33-11e4-ab6d-005056801329",
          "SettlementDescription": "Київ",
          "AddressDescription": "Столичное шоссе, 103",
          "DateTimeVehicleDeparture": "2022-04-27 05:00:00",
          "DateTimeVehicleArrival": "2022-04-27 04:00:00",
          "ContactName": "Іванов Іван Іванович",
          "Phone": "380961111111"
        }
      },
      "CustomerDescription": "",
      "SenderSettlementDescription": "",
      "RecipientSettlementDescription": ""
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Отримати список заявок (XML)

post

Метод getFreightList моделі Freight дозволяє отримати список заявок на фрахт у форматі XML.

Body

application/xml

apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:

calledMethodstring · enumRequired

Назва методу API

Possible values:

Responses

200

Успішна відповідь (XML)

application/xml

successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/

HTTPcURLJavaScriptPython

POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 773

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>FreightGeneral</modelName>
    <calledMethod>getFreightList</calledMethod>
    <methodProperties>
        <Ref></Ref>
        <Number></Number>
        <DateTime></DateTime>
        <DeclaredCost></DeclaredCost>
        <Status></Status>
        <DateTimeVehicleFiling></DateTimeVehicleFiling>
        <SenderSettlement></SenderSettlement>
        <RecipientSettlement></RecipientSettlement>
        <Customer></Customer>
        <CustomerContactName></CustomerContactName>
        <CustomerPhone></CustomerPhone>
        <Weight></Weight>
        <Volume></Volume>
        <Page></Page>
        <Limit></Limit>
    </methodProperties>
</file>
"

200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Ref></Ref>
            <Number></Number>
            <DateTime></DateTime>
            <DeletionMark>0</DeletionMark>
            <Status></Status>
            <DeniedReason></DeniedReason>
            <DateTimeVehicleFiling></DateTimeVehicleFiling>
            <DateTimeVehicleDeparture></DateTimeVehicleDeparture>
            <DateTimeVehicleArrival></DateTimeVehicleArrival>
            <DateTimeVehicleUnloading></DateTimeVehicleUnloading>
            <CargoDescriptionString></CargoDescriptionString>
            <DeclaredCost></DeclaredCost>
            <Cost></Cost>
            <Weight></Weight>
            <Length></Length>
            <Width></Width>
            <Height></Height>
            <Volume></Volume>
            <SemiTrailerType></SemiTrailerType>
            <Customer></Customer>
            <CustomerContactName></CustomerContactName>
            <CustomerPhone></CustomerPhone>
            <CustomerEMail></CustomerEMail>
            <SenderSettlement></SenderSettlement>
            <SenderAddressString></SenderAddressString>
            <SenderString></SenderString>
            <SenderName></SenderName>
            <SenderPhone></SenderPhone>
            <SenderEMail></SenderEMail>
            <RecipientSettlement></RecipientSettlement>
            <RecipientAddressString></RecipientAddressString>
            <RecipientString></RecipientString>
            <RecipientName></RecipientName>
            <RecipientPhone></RecipientPhone>
            <RecipientEMail></RecipientEMail>
            <AdditionalInformation></AdditionalInformation>
            <IntermediateStoppingPoints>
                <item>
                    <Settlement>e718a680-4b33-11e4-ab6d-005056801329</Settlement>
                    <SettlementDescription>Київ</SettlementDescription>
                    <AddressDescription>Карельский переулок, 5</AddressDescription>
                    <DateTimeVehicleDeparture>2022-04-27 02:00:00</DateTimeVehicleDeparture>
                    <DateTimeVehicleArrival>2022-04-27 01:00:00</DateTimeVehicleArrival>
                    <ContactName>Федишин Любов Миколаївна</ContactName>
                    <Phone>380961111111</Phone>
                </item>
                <item>
                    <Settlement>e718a680-4b33-11e4-ab6d-005056801329</Settlement>
                    <SettlementDescription>Київ</SettlementDescription>
                    <AddressDescription>Столичное шоссе, 103</AddressDescription>
                    <DateTimeVehicleDeparture>2022-04-27 05:00:00</DateTimeVehicleDeparture>
                    <DateTimeVehicleArrival>2022-04-27 04:00:00</DateTimeVehicleArrival>
                    <ContactName>Іванов Іван Іванович</ContactName>
                    <Phone>380961111111</Phone>
                </item>
            </IntermediateStoppingPoints>
            <CustomerDescription></CustomerDescription>
            <SenderSettlementDescription></SenderSettlementDescription>
            <RecipientSettlementDescription></RecipientSettlementDescription>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>