API Контрагенты
Работа с данными Контрагента
- Создать Контрагента
- Создать контактное лицо Контрагента
- Создать Контрагента с типом (юридическое лицо) организация
- Создать Контрагента с типом третьего лица
- Загрузить список адресов Контрагентов
- Загрузить параметры Контрагента
- Загрузить список контактных лиц Контрагента
- Загрузить список Контрагентов отправителей/получателей/третье лицо
- Обновить данные Контрагента
- Обновить данные контактного лица Контрагента
- Удалить Контрагента получателя
- Удалить Контактное лицо Контрагента
Загрузить параметры Контрагента
Метод «getCounterpartyOptions», работает в модели «Counterparty», этот метод используется для получения параметров контрагента отправителя в разрезе возможности заказа дополнительных услуг, из раздела: «Формирование запросов на создание ЭН с дополнительными услугами»
Заказать услуги возможно по обращению к личному менеджеру.
URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/
Доступность: Требует использования API-ключа.
URL-адрес запроса
Параметры запроса
string
Форматы JSON, XML
Заголовки запросов
(дополнительный)
string
Тип формата текста, отправляемого в API.
Текст запроса
Параметр | Тип данных | Описание |
---|---|---|
apiKey* | string[36] | Ваш ключ API 2.0 |
modelName* | string | Имя модели |
calledMetdod* | string | Имя вызываемого метода |
metdodProperties | Свойства метода | |
Ref* | string[36] | Идентификатор контрагента |
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "Counterparty",
"calledMethod": "getCounterpartyOptions",
"methodProperties": {
"Ref": "5ace4a2e-13ee-11e5-add9-005056887b8d"
}
}
<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<calledMethod>getCounterpartyOptions</calledMethod>
<methodProperties>
<Ref>5ace4a2e-13ee-11e5-add9-005056887b8d</Ref>
</methodProperties>
<modelName>Counterparty</modelName>
</file>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
---|---|---|
CanPaytdetdirdPerson | Bool | Плательщик 3е лицо |
CanAfterpaymentOnGoodsCost | Bool | Оплата денег за товар (Контроль оплаты) |
CanNonCashPayment | Bool | Безналичный расчет |
CanCreditdocuments | Bool | Оформление кредита |
HideDeliveryCost | Bool | Не отображать сумму доставки |
CanSameDayDelivery | Bool | Доставка день в день |
CanForwardingService | Bool | Экспедирование (Контроль поштучной передачи) |
DeliveryByHand | Bool | Доставка в руки |
DescentFromFloor | Bool | Спуск с этажа |
BackDeliveryValuablePapers | Bool | Обратная доставка Ц1П |
BackwardDeliverySubtypesDocuments | Bool | Обратная доставка документов |
AfterpaymentType | Bool | Тип для услуги Контроль оплаты |
AddressDocumentDelivery | Bool | Адресная доставка документов |
BlockInternationalSenderLKK | Bool | Международная доставка |
PartialReturn | Bool | Частичный возврат |
Debtor | Bool | Возможность безналичного расчета |
CanEWTransporter | Bool | |
CanSameDayDeliveryStandart | Bool | Доставка день в день (локал-стандарт) |
CreditDocuments | Bool | Обратная доставка кредитных документов |
SignedDocuments | Bool | Контроль подписи документов |
Services | Bool | Обратная доставка документов с различными подтипами |
<?xml version="1.0" encoding="UTF-8"?>
<root>
<data>
<element>
<AddressDocumentDelivery>false</AddressDocumentDelivery>
<AfterpaymentType>NovaPoshta</AfterpaymentType>
<BackDeliveryValuablePapers>false</BackDeliveryValuablePapers>
<BackwardDeliverySubtypesDocuments>false</BackwardDeliverySubtypesDocuments>
<BlockInternationalSenderLKK>false</BlockInternationalSenderLKK>
<CanAfterpaymentOnGoodsCost>false</CanAfterpaymentOnGoodsCost>
<CanCreditDocuments>false</CanCreditDocuments>
<CanEWTransporter>false</CanEWTransporter>
<CanForwardingService>false</CanForwardingService>
<CanNonCashPayment>false</CanNonCashPayment>
<CanPayTheThirdPerson>false</CanPayTheThirdPerson>
<CanSameDayDelivery>false</CanSameDayDelivery>
<CanSameDayDeliveryStandart>true</CanSameDayDeliveryStandart>
<CanSignedDocuments>false</CanSignedDocuments>
<CreditDocuments>false</CreditDocuments>
<Debtor>false</Debtor>
<DeliveryByHand>false</DeliveryByHand>
<DescentFromFloor>false</DescentFromFloor>
<FillingWarranty>false</FillingWarranty>
<HaveMoneyWallets>false</HaveMoneyWallets>
<HideDeliveryCost>false</HideDeliveryCost>
<LoyaltyProgram>true</LoyaltyProgram>
<PartialReturn>false</PartialReturn>
<PickupService>false</PickupService>
<Services>false</Services>
<ShowDeliveryByHand>false</ShowDeliveryByHand>
<SignedDocuments>false</SignedDocuments>
</element>
</data>
<errorCodes />
<errors />
<info />
<infoCodes />
<messageCodes />
<success>true</success>
<warningCodes />
<warnings />
</root>
{
"success": true,
"data": [
{
"FillingWarranty": false,
"AddressDocumentDelivery": false,
"CanPayTheThirdPerson": false,
"CanAfterpaymentOnGoodsCost": false,
"CanNonCashPayment": false,
"CanCreditDocuments": false,
"CanEWTransporter": false,
"CanSignedDocuments": false,
"HideDeliveryCost": false,
"BlockInternationalSenderLKK": false,
"PickupService": false,
"CanSameDayDelivery": false,
"CanSameDayDeliveryStandart": true,
"CanForwardingService": false,
"ShowDeliveryByHand": false,
"DeliveryByHand": false,
"PartialReturn": false,
"LoyaltyProgram": true,
"DescentFromFloor": false,
"BackDeliveryValuablePapers": false,
"BackwardDeliverySubtypesDocuments": false,
"AfterpaymentType": "NovaPoshta",
"CreditDocuments": false,
"SignedDocuments": false,
"Services": false,
"Debtor": false,
"HaveMoneyWallets": false
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}