Додавання документа до eТТН

URI: /ettn/addDocument/648c2da1085dcd82500f2bd2

Використовується для додавання документа до eТТН.

Запит виконується методом POST у json форматі з даними.

Параметри запиту

Ім'я	Тип	Обов.	Опис
exchangedDocumentContext	object	Так	Параметри документа
exchangedDocumentContext. dateTime	string	Так	Дата і час складання документа
exchangedDocumentContext. logisticName	string	Так	Місце складання документа
exchangedDocumentContext. logisticDescription	string	Так	Адреса місця складання документа
exchangedDocumentContext. status	string	Так	Поточний статус eТТН: PLANNED - Перевезення заплановано. Документ е-ТТН створено та підписано вантажовідправником. Вантаж готовий до відвантаження PICKUP - Відбулось завантаження (на початковому або проміжному складі), документ е-ТТН підписано перевізником, що підтверджує матеріальну відповідальність за вантаж. Вантаж у процесі перевезення. ONSTORAGE - Вантаж прийнято на зберігання на проміжному складі, відбулось розвантаження. ARRIVAL - Вантаж отримано і прийнято на пункті призначення, матеріальну відповідальність перекладено на вантажоодержувача. CANCELED - Документ відмінено
chainConsignment	object	Так	Містить загальні параметри вантажу
chainConsignment. grossWeightUnitCode	string	Так	Одиниця виміру ваги вантажу
chainConsignment. grossWeightMeasure	string	Так	Загальна вага вантажу
chainConsignment. associatedInvoiceCurrencyID	string	Так	Назва валюти
chainConsignment. associatedInvoiceAmount	string	Так	Загальна сума відпущеного вантажу
chainConsignment. quantity	string	Так	Кількість місць
consignorTradeParty	object	Так	Параметри відправника вантажу
consignorTradeParty.schemeAgencyID	string	Так	Назва ідентифікатора (ЄДРПОУ, КАТОТТГ, РНОКПП, УКТЗЕД)
consignorTradeParty.id	string	Так	Номер ідентифікатора
consignorTradeParty.name	string	Так	Ім'я відправника
consignorTradeParty.surname	string	Так	Прізвище відправника
consignorTradeParty.patronymic	string	Так	По батькові відправника
consignorTradeParty.roleCode	string	Так
consignorTradeParty.telephone	string	Так	Номер телефона відправника
consignorTradeParty.mobile	string	Так	Номер мобільного телефона відправника
consignorTradeParty.email	string	Так	Адреса електронної пошти відправника
consignorTradeParty.postCode	string	Так	Поштовий індекс реєстрації відправника
consignorTradeParty.street	string	Так	Адреса реєстрації відправника
consignorTradeParty.city	string	Так	Населений пункт в якому зареєстрований відправник
consignorTradeParty.countryID	string	Так	Ідентифікатор країни
consignorTradeParty.countryName	string	Так	Назва країни реєстрації відправника
consignorTradeParty.taxRegistration	string	Так	ЄДРПОУ підприємства, та/або РНОКПП всіх відповідальних осіб
consigneeTradeParty	object	Так	Параметри отримувача вантажу
consigneeTradeParty.id	string	Так	Номер ідентифікатора
consigneeTradeParty.name	string	Так	Ім'я отримувача
consigneeTradeParty.surname	string	Так	Прізвище отримувача
consigneeTradeParty.patronymic	string	Так	По батькові отримувача
consigneeTradeParty.telephone	string	Так	Номер телефона отримувача
consigneeTradeParty.mobile	string	Так	Номер мобільного телефона отримувача
consigneeTradeParty.email	string	Так	Адреса електронної пошти отримувача
consigneeTradeParty.postCode	string	Так	Поштовий індекс реєстрації отримувача
consigneeTradeParty.street	string	Так	Адреса реєстрації отримувача
consigneeTradeParty.city	string	Так	Населений пункт в якому зареєстрований отримувач
consigneeTradeParty.countryID	string	Так	Ідентифікатор країни
consigneeTradeParty.countryName	string	Так	Назва країни реєстрації отримувача
consigneeTradeParty.taxRegistration	string	Так	ЄДРПОУ підприємства, та/або РНОКПП всіх відповідальних осіб
carrierTradeParty	object	Так	Параметри перевізника
carrierTradeParty.id	string	Так	Номер ідентифікатора
carrierTradeParty.name	string	Так	Ім'я водія
carrierTradeParty.surname	string	Так	Прізвище водія
carrierTradeParty.patronymic	string	Так	По батькові водія
carrierTradeParty.telephone	string	Так	Номер телефона водія
carrierTradeParty.mobile	string	Так	Номер мобільного телефона водія
carrierTradeParty.email	string	Так	Адреса електронної пошти водія
carrierTradeParty.postCode	string	Так	Поштовий індекс реєстрації водія
carrierTradeParty.street	string	Так	Адреса реєстрації водія
carrierTradeParty.city	string	Так	Населений пункт в якому зареєстрований водій
carrierTradeParty.countryID	string	Так	Ідентифікатор країни
carrierTradeParty.countryName	string	Так	Назва країни реєстрації водія
carrierTradeParty.taxRegistration	string	Так	ЄДРПОУ підприємства, та/або РНОКПП всіх відповідальних осіб
forwarder	object	Так	Параметри експедитора
forwarder.id	string	Так	Номер ідентифікатора
forwarder.name	string	Так	Ім'я експедитора
forwarder.surname	string	Так	Прізвище експедитора
forwarder.patronymic	string	Так	По батькові експедитора
forwarder.telephone	string	Так	Номер телефона експедитора
forwarder.mobile	string	Так	Номер мобільного телефона експедитора
forwarder.email	string	Так	Адреса електронної пошти експедитора
forwarder.postCode	string	Так	Поштовий індекс реєстрації експедитора
forwarder.street	string	Так	Адреса реєстрації експедитора
forwarder.city	string	Так	Населений пункт в якому зареєстрований експедитор
forwarder.countryID	string	Так	Ідентифікатор країни
forwarder.countryName	string	Так	Назва країни реєстрації експедитора
forwarder.taxRegistration	string	Так	РНОКПП всіх відповідальних осіб за необхідності. У випадку перевізника - РНОКПП водія обов'язково!
customer	object	Так	Параметри замовника
customer.id	string	Так	Номер ідентифікатора
customer.name	string	Так	Ім'я замовника
customer.surname	string	Так	Прізвище замовника
customer.patronymic	string	Так	По батькові замовника
customer.telephone	string	Так	Номер телефона замовника
customer.mobile	string	Так	Номер мобільного телефона замовника
customer.email	string	Так	Адреса електронної пошти замовника
customer.postCode	string	Так	Поштовий індекс реєстрації замовника
customer.street	string	Так	Адреса реєстрації замовника
customer.city	string	Так	Населений пункт в якому зареєстрований замовник
customer.countryID	string	Так	Ідентифікатор країни
customer.countryName	string	Так	Назва країни реєстрації замовника
customer.taxRegistration	string	Так	ЄДРПОУ підприємства, та/або РНОКПП всіх відповідальних осіб за необхідності
security	object	Так	Параметри компанії, що надає охоронні послуги
security.id	string	Так	Номер ідентифікатора
security.companyName	string	Так	Назва охоронної компанії
security.contact	object	Так	Параметри контактної особи
security.contact.name	string	Так	Ім'я контактної особи
security.contact.surname	string	Так	Прізвище контактної особи
security.contact.patronymic	string	Так	По батькові контактної особи
chainConsignmentNext	object	Так	Параметри вантажу
chainConsignmentNext. itemGrossWeightUnitCode	string	Так	Одиниця виміру маси
chainConsignmentNext. itemGrossWeightMeasure	string	Так	Маса брутто
chainConsignmentNext. amount	string	Так
chainConsignmentNext. schemeAgencyID	string	Так	Назва ідентифікатора (ЄДРПОУ, КАТОТТГ, РНОКПП, УКТЗЕД)
chainConsignmentNext. temperatureMin	string	Так	Мінімальна температура температурного режиму
chainConsignmentNext. temperatureMax	string	Так	Максимальна температура температурного режиму
chainConsignmentNext. chainID	string	Так
chainConsignmentNext. amountOne	string	Так
chainConsignmentNext. minimumValueMeasure	string	Так	Мінімальна температура температурного режиму
chainConsignmentNext. minimumValueUnitCode	string	Так	Одиниця виміру мінімальної температури
chainConsignmentNext. cargoName	string	Так	Найменування вантажу
chainConsignmentNext. dangerousGoods	string	Так	Код UNDG, 0 - якщо не використовується
chainConsignmentNext. dangerousGoodsLevel	string	Так	Клас небезпечних речовин 1-4
chainConsignmentNext. sequenceNumeric	string	Так	Порядковий номер вантажу
chainConsignmentNext. itemCurrencyID	string	Так	Назва валюти
chainConsignmentNext. itemCurrencyValue	string	Так	Загальна сума з ПДВ
chainConsignmentNext. itemTariffQuantityCode	string	Так	Назва валюти
chainConsignmentNext. itemTariffQuantityValue	string	Так	Ціна за одиницю без ПДВ
chainConsignmentNext. packageQuantity	string	Так	Кількість місць вантажу
chainConsignmentNext. packageCode	string	Так	Вид пакування (https://gs1.se/en/guides/documentation/code-lists/t0137-packaging-type-code/)
chainConsignmentNext. associatedReferencedLogistics TransportEquipment	list[object]	Так	Містить список контейнерів з вантажем
chainConsignmentNext. associatedReferencedLogistics TransportEquipment. transportEquipment	string	Так	Номер контейнера з вантажем
chainConsignmentNext. associatedReferencedDocument	list[object]	Так	Містить список документів з вантажем
chainConsignmentNext. associatedReferencedDocument. associatedDocumentID	string	Так	Ідентифікатор документа
chainConsignmentNext. associatedReferencedDocument. associatedDocumentRemark	string	Так	Опис документа
chainConsignmentNext. transportLogisticsPackage	list[object]	Так	Параметри пакування
chainConsignmentNext. transportLogisticsPackage.packageCount	string	Так	Кількість місць
chainConsignmentNext. transportLogisticsPackage.typeCode	string	Так	Вид пакування
chainConsignmentNext. transportLogisticsPackage.type	string	Так	Одиниця виміру
chainConsignmentNext. transportLogisticsPackage.packageName	string	Так	Назва транспортного пакування
chainConsignmentNext. transportLogisticsPackage.barcode	string	Так	Бар-коди
chainConsignmentNext.applicableNote	list[object]	Так	Додаткові примітки
chainConsignmentNext. applicableNote.contentCode	string	Так	Код примітки: VENDOR_CODE - артикул QUANTITY - кількість товару URL - Посилання на документ BASE_UOM - Одиниця виміру кількості товару BUYER_CODE - артикул покупця PRICE_WITH_VAT - ціна за одиницю з ПДВ SUM_WITHOUT_VAT - загальна сума без ПДВ RETURN_TARE - ознака "зворотня тара" NET_WEIGHT - маса нетто RTP_TYPE - Тип транспортного пакування RTP_NAME - Назва транспортного пакування RTP_QUANTITY - Кількість транспортного пакування
chainConsignmentNext. applicableNote.content	string	Так	Вміст примітки
carrierLogistics	object	Так	Місце навантаження
carrierLogistics.id	string	Так	Номер ідентифікатора
carrierLogistics.name	string	Так	Назва місця навантаження
carrierLogistics.typeCode	string	Так
carrierLogistics.latitudeMeasure	string	Так	Географічні координати місця навантаження (широта)
carrierLogistics.longitudeMeasure	string	Так	Географічні координати місця навантаження (довгота)
consigneeLogistics	object	Так	Місце розвантаження
consigneeLogistics.id	string	Так	Номер ідентифікатора
consigneeLogistics.name	string	Так	Назва місця розвантаження
consigneeLogistics.typeCode	string	Так
consigneeLogistics.latitudeMeasure	string	Так	Географічні координати місця розвантаження (широта)
consigneeLogistics.longitudeMeasure	string	Так	Географічні координати місця розвантаження (довгота)
transportEquipmentCar	object	Так	Інформація про автомобіль в перевезенні
transportEquipmentCar.id	string	Так	Реєстраційний номер автомобіля
transportEquipmentCar.code	integer	Так
transportEquipmentCar.country	string	Так	Країна реєстрації автомобіля
transportEquipmentCar.applicableNote	list[object]	Так	Додаткові параметри
transportEquipmentCar. applicableNote.code	string	Так	Назва параметра (BRAND, MODEL, COLOR)
transportEquipmentCar. applicableNote.content	string	Так	Значення параметра
transportTrailer	object	Так	Інформація про причеп в перевезенні
transportTrailer.id	string	Так	Реєстраційний номер причепа
transportTrailer.code	integer	Так
transportTrailer.country	string	Так	Країна реєстрації причепа
transportTrailer.categoryCode	string	Так	Категорія причепа: BX - Boxcar (ЗД вагон) CN - Контейнер TE - Trailer (причеп)
transportTrailer.characteristicCode	string	Так	Тип причепа: 14 - причеп 17 - напів-причеп
transportTrailer.affixedLogisticsSeal	list[object]	Так	Інформація про пломбування SEAL_NO
transportTrailer.affixedLogisticsSeal.id	string	Так	Ідентифікатор пломби
transportTrailer.applicableNote	list[object]	Так	Додаткові параметри
transportTrailer. applicableNote.code	string	Так	Назва параметра (BRAND, MODEL)
transportTrailer. applicableNote.content	string	Так	Значення параметра
uaSignatureStorage	object	Так	Підписи документів
uaSignatureStorage.typeCode	string	Так
uaSignatureStorage.documentBase64	string	Так	base64 графічне відображення документа
uaSignatureStorage.signature	list[object]	Так	Параметри підпису документа
uaSignatureStorage. signature.signingPartyRoleCode	string	Так
uaSignatureStorage. signature.signatureBase64	string	Так	base64 підпису p7s
uaSignatureStorage. signature.name	string	Так	Прізвище та ініціали підписанта
uaSignatureStorage. signature.position	string	Так	Посада підписанта
uaSignatureStorage. signature.taxRegistration	string	Так

Приклад запиту

Запит повинен містити наступні заголовки:

Authorization: {{bearer}}
Content-Type: application/json
Accept: application/json

Запит: /ettn/addDocument/648c2da1085dcd82500f2bd2
{
    "exchangedDocumentContext": {
        "dateTime": "2021-10-26 21:32:52",
        "logisticName": "Місце складання документа",
        "logisticDescription": "79000, м.Львів, вул. Словацького, 1",
        "status": "PLANNED"
    },
    "chainConsignment": {
        "grossWeightUnitCode": "KGM",
        "grossWeightMeasure": "24601",
        "associatedInvoiceCurrencyID": "UAH",
        "associatedInvoiceAmount": "100",
        "quantity": "11"
    },
    "consignorTradeParty": {
        "schemeAgencyID": "ЄДРПОУ",
        "id": "12345678",
        "name": "Василь",
        "surname": "Васильченко",
        "patronymic": "Васильович",
        "roleCode": "CZ",
        "telephone": "0441112233",
        "mobile": "0931112233",
        "email": "[email protected]",
        "postCode": "01001",
        "street": "вул.Хрещатик, 22",
        "city": "Київ",
        "countryID": "UA",
        "countryName": "м.Київ",
        "taxRegistration": "12345678"
    },
    "consigneeTradeParty": {
        "id": "12345679",
        "name": "Василь",
        "surname": "Васильченко",
        "patronymic": "Васильович",
        "telephone": "0441112233",
        "mobile": "0931112233",
        "email": "[email protected]",
        "postCode": "01001",
        "street": "вул.Хрещатик, 22",
        "city": "Київ",
        "countryID": "UA",
        "countryName": "м.Київ",
        "taxRegistration": "12345678"
    },
    "carrierTradeParty": {
        "id": "12345680",
        "name": "Василь",
        "surname": "Васильченко",
        "patronymic": "Васильович",
        "telephone": "0441112233",
        "mobile": "0931112233",
        "email": "[email protected]",
        "postCode": "01001",
        "street": "вул.Хрещатик, 22",
        "city": "Київ",
        "countryID": "UA",
        "countryName": "м.Київ",
        "taxRegistration": "12345678"
    },
    "forwarder": {
        "id": "12345681",
        "name": "Василь",
        "surname": "Васильченко",
        "patronymic": "Васильович",
        "telephone": "0441112233",
        "mobile": "0931112233",
        "email": "[email protected]",
        "postCode": "01001",
        "street": "вул.Хрещатик, 22",
        "city": "Київ",
        "countryID": "UA",
        "countryName": "м.Київ",
        "taxRegistration": "12345678"
    },
    "customer": {
        "id": "12345682",
        "name": "Василь",
        "surname": "Васильченко",
        "patronymic": "Васильович",
        "telephone": "0441112233",
        "mobile": "0931112233",
        "email": "[email protected]",
        "postCode": "01001",
        "street": "вул.Хрещатик, 22",
        "city": "Київ",
        "countryID": "UA",
        "countryName": "м.Київ",
        "taxRegistration": "12345678"
    },
    "security": {
        "id": "12345678",
        "companyName": "ТОВ Компанія охорона",
        "contact": {
            "name": "Іван",
            "surname": "Небезпечний",
            "patronymic": "Іванович"
        }
    },
    "chainConsignmentNext": {
        "itemGrossWeightUnitCode": "KGM",
        "itemGrossWeightMeasure": "246",
        "amount": "100",
        "schemeAgencyID": "0101 30 00 00",
        "temperatureMin": "-20",
        "temperatureMax": "-15",
        "chainID": "1",
        "amountOne": "500",
        "minimumValueMeasure": "-20",
        "minimumValueUnitCode": "CEL",
        "cargoName": "Опис елементу 1 вантажу",
        "dangerousGoods": "0",
        "dangerousGoodsLevel": "1",
        "sequenceNumeric": "1",
        "itemCurrencyID": "UAH",
        "itemCurrencyValue": "10",
        "ItemTariffQuantityCode": "UAH",
        "ItemTariffQuantityValue": "500",
        "packageQuantity": "100",
        "packageCode": "CN",
        "associatedReferencedLogisticsTransportEquipment": [
            {
                "transportEquipment": "123456789-123"
            }
        ],
        "associatedReferencedDocument": [
            {
                "associatedDocumentID": "123123",
                "associatedDocumentRemark": "Опис документу"
            }
        ],
        "transportLogisticsPackage": [
            {
                "packageCount": "100",
                "typeCode": "SA",
                "type": "кг",
                "packageName": "Упаковано в мішки",
                "barcode": "1234578"
            }
        ],
        "applicableNote": [
            {
                "contentCode": "VENDOR_CODE",
                "content": "123123"
            },
            {
                "contentCode": "QUANTITY",
                "content": "1"
            },
            {
                "contentCode": "URL",
                "content": "https://name.domain.com"
            },
            {
                "contentCode": "BASE_UOM",
                "content": "шт"
            },
            {
                "contentCode": "BUYER_CODE",
                "content": "123"
            },
            {
                "contentCode": "PRICE_WITH_VAT",
                "content": "100"
            },
            {
                "contentCode": "RETURN_TARE",
                "content": "так"
            },
            {
                "contentCode": "NET_WEIGHT",
                "content": "100"
            },
            {
                "contentCode": "RTP_TYPE",
                "content": "конейнер"
            },
            {
                "contentCode": "RTP_NAME",
                "content": "конейнер для перевезення сипучих речовин"
            },
            {
                "contentCode": "RTP_QUANTITY",
                "content": "1"
            }
        ]
    },
    "carrierLogistics": {
        "id": "test",
        "name": "test 2",
        "typeCode": "5",
        "latitudeMeasure": "48.138708833123815",
        "longitudeMeasure": "11.503074665045691"
    },
    "consigneeLogistics": {
        "id": "test",
        "name": "test 2",
        "typeCode": "10",
        "latitudeMeasure": "48.138708833123815",
        "longitudeMeasure": "11.503074665045691"
    },
    "transportEquipmentCar": {
        "id": "АА1234ВВ",
        "code": 2,
        "country": "UK",
        "applicableNote": [
            {
                "code": "BRAND",
                "content": "Volvo"
            },
            {
                "code": "MODEL",
                "content": "Truck"
            },
            {
                "code": "COLOR",
                "content": "Синій"
            }
        ]
    },
    "transportTrailer": {
        "id": "АА1234ВВ",
        "code": 4,
        "country": "UK",
        "categoryCode": "TE",
        "characteristicCode": "14",
        "affixedLogisticsSeal": [
            {
                "id": "123123"
            },
            {
                "id": "23456"
            }
        ],
        "applicableNote": [
            {
                "code": "BRAND",
                "content": "Volvo"
            },
            {
                "code": "MODEL",
                "content": "Super Trailer"
            }
        ]
    },
    "uaSignatureStorage": {
        "typeCode": "730",
        "documentBase64": "",
        "signature": [
            {
                "signingPartyRoleCode": "CN",
                "signatureBase64": "{{signature1}}",
                "name": "Петренко В.В.",
                "position": "комірник",
                "taxRegistration": "12345678"
            },
            {
                "signingPartyRoleCode": "CA",
                "signatureBase64": "{{signature2}}",
                "name": "Іваненко В.В.",
                "position": "водій",
                "taxRegistration": "12345678"
            }
        ]
    }
}

Параметри запиту​

Приклад запиту​

Параметри запиту

Приклад запиту