io.github.shopanaio/novaposhta
NPM · @SHOPANA/NOVAPOSHTA-MCP-SERVER · SCANNED AUG 3
MCP Server for Nova Poshta API integration with AI assistants
Available components
How this component scores in each security and reliability category. Every signal is checked automatically from public evidence about the published package, including repeated runs of it in an isolated sandbox, and we only credit what we can confirm. How we score →
Supply Chain Security87
- No malware found by supply-chain analysis.Pass
- Only part of the dependency tree could be resolved (95 of 99), so this covers what we could see, not the whole tree.Partial
- No install/post-install scripts declared.Pass
- Only part of the dependency tree could be resolved (95 of 99), so this covers what we could see, not the whole tree. View diagnostics → Partial
Provenance & Transparency44
- Source repository is publicly reachable at the declared URL. View diagnostics → Pass
- Provenance check failed: no build-provenance attestation is published. See how to fix → View diagnostics → Fail
- Clear OSI-approved license (Apache-2.0).Pass
- Actively maintained (last published 254 days ago).Pass
- Disclosure check failed: no security disclosure policy was found in the source repository. See how to fix → Fail
Schema Quality & AI Usability71
- AI-judged instruction clarity (good).Pass
- Tool/resource definitions use about 4775 tokens (~95/item across 50 items; 50 tools + 0 resources), lean.Pass
- Usage-examples check failed: none of the tools include examples. See how to fix → Fail
Stability & Change Management0
- Stability not yet verified: not enough scan history yet (needs a 30-day window).Unverified
Tool Coverage100
- 100% of tools have a non-trivial description (not blank, and not just the tool's name).Pass
- 99% of tool parameters carry a description.Partial
Capabilities100
- Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.Pass
Unverified: 1 category
A category scored 0 because we could not verify it: a data source with nothing on this package, evidence we could not reach, or a check we could not run. We only credit what we can confirm.
Add this component to your MCP client. Where a client-specific snippet is available, pick your client below and copy it straight into your config; otherwise use the connection detail shown.
npm · @shopana/novaposhta-mcp-server
claude mcp add shopanaio-novaposhta -- npx -y @shopana/novaposhta-mcp-server
codex mcp add shopanaio-novaposhta -- npx -y @shopana/novaposhta-mcp-server
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"shopanaio-novaposhta": {
"type": "local",
"command": [
"npx",
"-y",
"@shopana/novaposhta-mcp-server"
],
"enabled": true
}
}
} openclaw mcp add shopanaio-novaposhta --command npx --arg -y --arg @shopana/novaposhta-mcp-server
mcp_servers:
shopanaio-novaposhta:
command: "npx"
args: ["-y", "@shopana/novaposhta-mcp-server"] {
"mcpServers": {
"shopanaio-novaposhta": {
"command": "npx",
"args": [
"-y",
"@shopana/novaposhta-mcp-server"
]
}
}
} Every change we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.
- 2 Aug 26 +43
- Provenance: unverified → fail ▼ security
- Known CVEs: unverified → partial ▲ security
- Install scripts: unverified → pass ▲ security
- Malware scan: unverified → pass ▲ security
- Stability: Stability not yet verified: not enough scan history yet (needs a 30-day window). security
- Tool coverage: 100 → unverified ▼ functional
- License: unverified → pass ▲ functional
- Dependency health: unverified → partial ▲ functional
- Maintenance: unverified → pass ▲ functional
- MCP protocol: unverified → pass ▲ functional
- Schema quality: unverified → good ▲ functional
- First check of Schema quality: unverified functional
- Licence: Apache-2.0 functional
- 31 Jul 26 −7
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
- 30 Jul 26 −18
- Malware scan: pass → unverified ▼ security
- 27 Jul 26 46
First indexed and scored.
Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.
Captured 3 Aug 2026 · Analysed npm/@shopana/[email protected]
Provenance none
Ecosystem: npm · Outcome: none
Dependencies 95 packages
95 packages in the resolved dependency tree · 94 deprecated · 29 stale.
The dependency tree was only partially resolved, so these counts may be incomplete.
The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability.
address_delete ~52
Delete counterparty address by reference using Address/delete (doc 1.25). Allowed only before the address participates in an Internet document; afterward the API blocks deletion.
| Name | Type | Req | Description |
|---|---|---|---|
| Ref | string | yes | Address reference to delete. |
No output schema declared.
No examples provided.
address_get_settlement_country_region ~91
Get settlement country regions (регіонів) for a specific area via Address/getSettlementCountryRegion (doc 1.3). Returns list of regions within an administrative area. Requires areaRef parameter. Docs recommend caching for 12 hours.
| Name | Type | Req | Description |
|---|---|---|---|
| AreaRef | string | yes | Area reference from address_get_settlements. |
| Ref | string | — | Optional region reference to get specific region. |
No output schema declared.
No examples provided.
address_get_settlements ~66
Get settlement areas (областей) via Address/getSettlementAreas (doc 1.3). Returns list of administrative regions/areas in Ukraine. Docs recommend caching this public directory for 12 hours.
| Name | Type | Req | Description |
|---|---|---|---|
| Ref | string | — | Optional area reference to get specific area. |
No output schema declared.
No examples provided.
address_get_warehouses ~305
List Nova Poshta warehouses (branches, postomats, pickup points) via Address/getWarehouses (doc 1.5). Docs emphasize caching the branch directory daily to leverage schedule arrays, max weight limits, and warehouse types without re-fetching thousands of rows. IMPORTANT: Always use limit parameter (recommended: 10-20) to avoid large responses.
| Name | Type | Req | Description |
|---|---|---|---|
| BicycleParking | string | — | Filter by bicycle parking availability (1/0). |
| CityName | string | — | City name filter. |
| CityRef | string | — | City reference from getCities. |
| FindByString | string | — | Search string for warehouse name, address, or street. |
| Language | string | — | Language code (UA, RU, EN). |
| Limit | number | — | Items per page (default 50). Recommended: 10-20 to avoid large responses. |
| POSTerminal | string | — | Filter by POS terminal availability (1/0). |
| Page | number | — | Page number (default 1). |
| PostFinance | string | — | Filter by NovaPay cash desk availability (1/0). |
| Ref | string | — | Specific warehouse reference (returns single warehouse). |
| SettlementRef | string | — | Settlement reference from searchSettlements. |
| TypeOfWarehouseRef | string | — | Filter by warehouse type (Branch, Postomat, Pickup Point). |
| WarehouseId | string | — | Warehouse number (e.g., "1" for Branch #1). |
No output schema declared.
No examples provided.
address_save ~114
Create new address for a counterparty via Address/save (doc 1.24). Requires API key plus CounterpartyRef, StreetRef, BuildingNumber; response returns the Ref and Description needed for door-to-door delivery.
| Name | Type | Req | Description |
|---|---|---|---|
| BuildingNumber | string | yes | Building number (required). |
| CounterpartyRef | string | yes | Counterparty reference. |
| Flat | string | — | Apartment number (optional). |
| Note | string | — | Additional note (optional). |
| StreetRef | string | yes | Street reference from address_search_streets. |
No output schema declared.
No examples provided.
address_search_cities ~130
Find Nova Poshta cities by name or postal index using Address/getCities (doc 1.3). Docs note the city directory is public (no API key) but must be cached and refreshed daily because it exposes Area and Delivery1-Delivery7 flags. IMPORTANT: Always use limit parameter (recommended: 10) to avoid large responses.
| Name | Type | Req | Description |
|---|---|---|---|
| FindByString | string | yes | Partial city name or postal code. |
| Limit | number | — | Items per page (max 50). Recommended: 10 to avoid large responses. |
| Page | number | — | Page number (default 1). |
No output schema declared.
No examples provided.
address_search_settlements ~117
Search for settlements (city, town, village) with pagination over the same Address/getCities dataset described in doc 1.3 (Area + Delivery1-Delivery7 fields, daily refresh recommended). IMPORTANT: Always use limit parameter (recommended: 10) to avoid large responses.
| Name | Type | Req | Description |
|---|---|---|---|
| CityName | string | yes | Settlement name or postal code. |
| Limit | number | — | Items per page (1-500). Recommended: 10 to avoid large responses. |
| Page | number | — | Page number (default 1). |
No output schema declared.
No examples provided.
address_search_streets ~113
Search for streets inside a settlement via Address/getStreet (doc 1.4). Used for door pickup/delivery flows, limited to 500 records per page, public but should be cached and refreshed daily. IMPORTANT: Always use limit parameter (recommended: 10) to avoid large responses.
| Name | Type | Req | Description |
|---|---|---|---|
| Limit | number | — | Max items to return. Recommended: 10 to avoid large responses. |
| SettlementRef | string | yes | Settlement reference ID. |
| StreetName | string | yes | Street name or fragment. |
No output schema declared.
No examples provided.
address_update ~115
Update existing counterparty address with Address/update (doc 1.25). Nova Poshta docs stress you can edit an address only until a waybill is created with it, so run this immediately after address creation.
| Name | Type | Req | Description |
|---|---|---|---|
| BuildingNumber | string | — | Updated building number. |
| CounterpartyRef | string | yes | Counterparty reference. |
| Flat | string | — | Updated apartment number. |
| Note | string | — | Updated note. |
| Ref | string | yes | Address reference to update. |
| StreetRef | string | — | Updated street reference. |
No output schema declared.
No examples provided.
contact_person_delete ~73
Delete contact person by reference using ContactPerson/delete (doc 1.27). Nova Poshta allows deletions via API only for legal entities and only until the contact was used on an Internet document.
| Name | Type | Req | Description |
|---|---|---|---|
| CounterpartyRef | string | yes | Counterparty reference. |
| Ref | string | yes | Contact person reference to delete. |
No output schema declared.
No examples provided.
contact_person_save ~133
Create new contact person for a counterparty via ContactPerson/save (doc 1.26). Docs require entering all fields in Ukrainian and with an API key; response returns the Ref/Description pair referenced in waybills.
| Name | Type | Req | Description |
|---|---|---|---|
| CounterpartyRef | string | yes | Counterparty reference from getCounterparties. |
| string | — | Email address (optional). | |
| FirstName | string | yes | First name (required). |
| LastName | string | yes | Last name (required). |
| MiddleName | string | — | Middle name (optional). |
| Phone | string | yes | Phone number 380XXXXXXXXX (required). |
No output schema declared.
No examples provided.
contact_person_update ~131
Update existing contact person details via ContactPerson/update (doc 1.27). Only legal entities may edit full profiles, private persons can change phone only, and edits are allowed solely before a waybill is issued for that counterparty.
| Name | Type | Req | Description |
|---|---|---|---|
| CounterpartyRef | string | yes | Counterparty reference. |
| string | — | Updated email. | |
| FirstName | string | — | Updated first name. |
| LastName | string | — | Updated last name. |
| MiddleName | string | — | Updated middle name. |
| Phone | string | — | Updated phone. |
| Ref | string | yes | Contact person reference to update. |
No output schema declared.
No examples provided.
counterparty_delete ~62
Delete counterparty by reference using Counterparty/delete (doc 1.22). IMPORTANT: Docs explicitly state only Recipient counterparties can be deleted through the API; Sender cleanup must go through your account manager.
| Name | Type | Req | Description |
|---|---|---|---|
| Ref | string | yes | Counterparty reference to delete. |
No output schema declared.
No examples provided.
counterparty_get_addresses ~103
Get addresses for a specific counterparty using Counterparty/getCounterpartyAddresses (doc 1.6). Requires API key plus CounterpartyProperty/Ref and, per docs, should be refreshed daily because every page is capped at 500 entries.
| Name | Type | Req | Description |
|---|---|---|---|
| CounterpartyProperty | string | — | Counterparty role: Sender or Recipient. |
| Page | number | — | Page number (default 1). |
| Ref | string | yes | Counterparty reference from getCounterparties. |
No output schema declared.
No examples provided.
counterparty_get_contact_persons ~81
Get contact persons for a counterparty through Counterparty/getCounterpartyContactPersons (doc 1.6). API key is mandatory and the list should be cached daily; use paging to stay under the 500-record response cap.
| Name | Type | Req | Description |
|---|---|---|---|
| Page | number | — | Page number (default 1). |
| Ref | string | yes | Counterparty reference. |
No output schema declared.
No examples provided.
counterparty_get_counterparties ~140
Get counterparties list filtered by property (Sender/Recipient/ThirdPerson) via Counterparty/getCounterparties (doc 1.6). Docs require an API key, recommend caching the directory daily, and note each page tops out at 500 rows so always filter with CounterpartyProperty/FindByString.
| Name | Type | Req | Description |
|---|---|---|---|
| CityRef | string | — | Filter by city reference. |
| CounterpartyProperty | string | yes | Counterparty role: Sender, Recipient, or ThirdPerson. |
| FindByString | string | — | Search by name, phone, or EDRPOU. |
| Page | number | — | Page number (default 1). |
No output schema declared.
No examples provided.
counterparty_get_options ~70
Get counterparty options and permissions via Counterparty/getCounterpartyOptions (doc 1.23) to see booleans such as CanPayTheThirdPerson, CanSameDayDelivery, HideDeliveryCost, etc., before building a waybill.
| Name | Type | Req | Description |
|---|---|---|---|
| Ref | string | yes | Counterparty reference. |
No output schema declared.
No examples provided.
counterparty_save ~219
Create new counterparty (private person or organization) with Counterparty/save (docs 1.20–1.21). Provide CityRef + CounterpartyProperty/Type; private persons require first/last name while organizations must also send OwnershipForm and EDRPOU. Docs recommend refreshing supporting directories monthly and note an API key is required.
| Name | Type | Req | Description |
|---|---|---|---|
| CounterpartyProperty | string | yes | Role: Sender or Recipient |
| CounterpartyType | string | yes | Type: PrivatePerson or Organization |
| EDRPOU | string | — | EDRPOU code (required for Organization). |
| string | — | Email address (optional). | |
| FirstName | string | — | First name (required for PrivatePerson, optional for Organization). |
| LastName | string | — | Last name (required for PrivatePerson, optional for Organization). |
| MiddleName | string | — | Middle name (optional). |
| OwnershipForm | string | — | Ownership form reference (required for Organization). |
| Phone | string | yes | Phone number in format 380XXXXXXXXX (required). |
No output schema declared.
No examples provided.
counterparty_update ~135
Update existing counterparty details via Counterparty/update (doc 1.22). Nova Poshta only lets you edit a counterparty from creation up until you create a waybill (ІД) with it, so run updates early.
| Name | Type | Req | Description |
|---|---|---|---|
| CounterpartyProperty | string | yes | Counterparty role: Sender or Recipient |
| string | — | Updated email. | |
| FirstName | string | — | Updated first name. |
| LastName | string | — | Updated last name. |
| MiddleName | string | — | Updated middle name. |
| Phone | string | — | Updated phone. |
| Ref | string | yes | Counterparty reference to update. |
No output schema declared.
No examples provided.
get_document_list ~123
List documents created in the given date range. Per doc 1.2, these queries target the InternetDocument model used for оформлення відправлень, so date filters help keep the success/data/errors response manageable.
| Name | Type | Req | Description |
|---|---|---|---|
| DateTimeFrom | string | yes | Start date (format dd.mm.yyyy). |
| DateTimeTo | string | yes | End date (format dd.mm.yyyy). |
| GetFullList | string | — | Use "1" to request full list ignoring pagination (may be slow). |
| Page | number | — | Page number (default 1). |
No output schema declared.
No examples provided.
get_document_movement ~67
Get movement history for up to 10 documents including statuses and timestamps. Doc 1.2 identifies InternetDocument numbers as the primary shipment identifiers, which this endpoint accepts in batches.
| Name | Type | Req | Description |
|---|---|---|---|
| DocumentNumbers | array | yes | — |
| ShowDeliveryDetails | boolean | — | Include extended delivery checkpoints. |
No output schema declared.
No examples provided.
reference_decode_message ~78
Decode Nova Poshta API message code into human readable text. Doc 1.2 explains how every response contains success/data/errors/warnings/info blocks with numeric codes; this helper calls getMessageCodeText to map those codes to UA/RU descriptions.
| Name | Type | Req | Description |
|---|---|---|---|
| MessageCode | string | yes | Message code (e.g., 20000200039). |
No output schema declared.
No examples provided.
reference_get_backward_cargo_types ~59
List backward delivery cargo types via Common/getBackwardDeliveryCargoTypes (doc 1.18). Returns types of cargo that can be sent back (documents, money, etc.). Used for return shipments and COD. Docs recommend caching monthly.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
reference_get_cargo_description_list ~77
List cargo descriptions with optional search via Common/getCargoDescriptionList (doc 1.15). Returns predefined descriptions for common cargo types. Supports search by keyword. Docs recommend caching monthly.
| Name | Type | Req | Description |
|---|---|---|---|
| FindByString | string | — | Optional search keyword for cargo description. |
| Page | number | — | Page number (default 1). |
No output schema declared.
No examples provided.
reference_get_cargo_types ~60
List available cargo types supported by Nova Poshta via Common/getCargoTypes (doc 1.8). Docs advise caching this API-key-protected directory monthly; expect values such as Parcel, Cargo, Documents, TiresWheels, Pallet.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
reference_get_ownership_forms ~58
List corporate ownership forms required for counterparty creation via Common/getOwnershipFormsList (doc 1.11). Docs provide both short and full names for refs such as ТОВ, ПрАТ, ФГ and recommend a monthly refresh.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
reference_get_pack_list ~87
List available packaging types via Common/getPackList (doc 1.10). Returns standard package dimensions and descriptions. Useful for calculating delivery costs and validating package options. Docs recommend caching monthly.
| Name | Type | Req | Description |
|---|---|---|---|
| Height | number | — | Optional package height filter in cm. |
| Length | number | — | Optional package length filter in cm. |
| Width | number | — | Optional package width filter in cm. |
No output schema declared.
No examples provided.
reference_get_pallet_types ~45
List pallet types with dimensions and weight via Common/getPalletsList (doc 1.13). Refresh monthly per docs, especially when offering reverse delivery of pallets.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
reference_get_payment_forms ~62
Get list of payment forms (Cash/NonCash) for waybill creation with Common/getPaymentForm (doc 1.7). Nova Poshta notes non-cash payments are available only to contracted clients, so keep a cached copy to validate user choices.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
reference_get_payment_methods ~55
List supported payment methods for shipments (Cash/NonCash) matching the Common/getPaymentForm directory from doc 1.7, which notes that non-cash payments are only available to customers with a Nova Poshta contract.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
reference_get_pickup_time_intervals ~88
Get available pickup time intervals via Common/getPickupTimeIntervals (doc 1.17). Returns time windows when Nova Poshta can pick up packages from sender. Requires city reference and date. Docs recommend caching hourly.
| Name | Type | Req | Description |
|---|---|---|---|
| DateTime | string | yes | Pickup date (dd.mm.yyyy). |
| SenderCityRef | string | yes | Sender city reference from address_search_cities. |
No output schema declared.
No examples provided.
reference_get_redelivery_payers ~57
List payer types for redelivery via Common/getTypesOfPayersForRedelivery (doc 1.19). Returns who can pay for backward delivery (Sender/Recipient). Used with return shipments. Docs recommend caching monthly.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
reference_get_service_types ~56
List delivery service types (warehouse-door etc.) through Common/getServiceType (doc 1.9). Docs say to refresh monthly and point out the four core technologies: WarehouseWarehouse, WarehouseDoors, DoorsWarehouse, DoorsDoors.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
reference_get_time_intervals ~82
Get available delivery time intervals for recipient city using Common/getTimeIntervals (doc 1.16). Requires RecipientCityRef (and optional DateTime) and returns Number/Start/End entries that docs recommend caching monthly.
| Name | Type | Req | Description |
|---|---|---|---|
| DateTime | string | — | Specific date (dd.mm.yyyy). |
| RecipientCityRef | string | yes | Recipient city reference. |
No output schema declared.
No examples provided.
reference_get_tires_wheels_list ~51
List available tires and wheels types via Common/getTiresWheelsList (doc 1.12). Returns types and descriptions for shipping tires and wheels as cargo. Docs recommend caching monthly.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
reference_get_types_of_counterparties ~62
Get list of counterparty types (PrivatePerson/Organization) via Common/getTypesOfCounterparties (doc 1.14). Requires API key and, per docs, should be refreshed monthly to stay aligned with sender/recipient onboarding rules.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
reference_get_types_of_payers ~66
Get list of payer types (Sender/Recipient/ThirdPerson) for waybill creation via Common/getTypesOfPayers (doc 1.7). Docs stress the ThirdPerson payer is accessible only after signing a service contract and that the directory should be cached monthly.
Input schema present but exposes no named parameters.
No output schema declared.
No examples provided.
track_document ~93
Track a single Nova Poshta document by number and optional phone to receive live status, location, and ETA. Doc 1.2 describes the standard success/data/errors/warnings/info envelope returned by Nova Poshta, which this helper surfaces back to the caller.
| Name | Type | Req | Description |
|---|---|---|---|
| DocumentNumber | string | yes | Nova Poshta tracking number (14 digits). |
| Phone | string | — | Optional recipient phone in international format (380XXXXXXXXX). |
No output schema declared.
No examples provided.
track_multiple ~80
Track multiple Nova Poshta documents with organized results and statistics via TrackingDocument/getStatusDocuments (doc 1.2). Returns successful/failed tracking attempts with delivery statistics (delivered, in-transit, at-warehouse counts). More convenient than track_multiple_documents for batch operations.
| Name | Type | Req | Description |
|---|---|---|---|
| DocumentNumbers | array | yes | List of tracking numbers (14 digits each). |
No output schema declared.
No examples provided.
track_multiple_documents ~67
Track multiple Nova Poshta documents at once and receive aggregated statistics. Doc 1.2 states every API call returns the same envelope, so use the success/errors/warnings fields here to mirror the native batch tracking response.
| Name | Type | Req | Description |
|---|---|---|---|
| DocumentNumbers | array | yes | List of tracking numbers to check. |
No output schema declared.
No examples provided.
waybill_calculate_cost ~210
Calculate delivery cost and optional delivery date estimation for a shipment. Doc 1.2 explains that every Nova Poshta call sends apiKey/modelName/calledMethod/methodProperties, so this helper either forwards your raw InternetDocument payload or builds one from typed fields (CitySender, CityRecipient, ServiceType, CargoType, Cost, Weight, SeatsAmount).
| Name | Type | Req | Description |
|---|---|---|---|
| CargoType | string | — | Cargo type (Parcel, Documents, TiresWheels, etc.). |
| CityRecipient | string | — | Recipient city reference. |
| CitySender | string | — | Sender city reference. |
| Cost | number | — | Declared value in UAH. |
| SeatsAmount | number | — | Number of seats. |
| ServiceType | string | — | Service type (WarehouseWarehouse, WarehouseDoors, etc.). |
| Weight | number | — | Weight in kg. |
| request | object | — | Raw Nova Poshta price calculation payload (CitySender, CityRecipient, ServiceType, CargoType, Cost, Weight, SeatsAmount). |
No output schema declared.
No examples provided.
waybill_create ~81
Create a standard Nova Poshta waybill (Internet document) via InternetDocument/save (doc 1.2). This is the basic waybill creation method. For additional services use waybill_create_with_options. For postomat delivery use waybill_create_for_postomat.
| Name | Type | Req | Description |
|---|---|---|---|
| request | object | yes | Raw Nova Poshta create waybill payload (see docs). |
No output schema declared.
No examples provided.
waybill_create_batch ~72
Batch create multiple waybills sequentially via InternetDocument/save (doc 1.2). Processes each waybill one by one to avoid rate limiting. Returns array of results including any errors. Useful for bulk shipment creation.
| Name | Type | Req | Description |
|---|---|---|---|
| requests | array | yes | Array of Nova Poshta create waybill payloads. |
No output schema declared.
No examples provided.
waybill_create_for_postomat ~83
Create a waybill for postomat delivery via InternetDocument/save (doc 1.2). Postomats have size/weight restrictions (max 30kg, max dimensions). Requires proper warehouse selection (postomat type) and seat options configuration.
| Name | Type | Req | Description |
|---|---|---|---|
| request | object | yes | Raw Nova Poshta create postomat waybill payload with optionsSeat array. |
No output schema declared.
No examples provided.
waybill_create_with_options ~97
Create a Nova Poshta waybill with additional options and services via InternetDocument/save (doc 1.2). Supports backward delivery, additional services, third-party payer, and RedBox barcodes. Use this when you need COD, insurance, or return shipments.
| Name | Type | Req | Description |
|---|---|---|---|
| request | object | yes | Raw Nova Poshta create waybill payload with additional options (backwardDeliveryData, additionalServices, thirdPerson, redBoxBarcode). |
No output schema declared.
No examples provided.
waybill_delete ~66
Delete one or multiple waybills by their DocumentRef via InternetDocument/delete (doc 1.2). Waybills can only be deleted before they enter processing. Returns success/error status for the operation.
| Name | Type | Req | Description |
|---|---|---|---|
| documentRefs | array | yes | Array of DocumentRef values to delete. |
No output schema declared.
No examples provided.
waybill_delete_batch ~73
Batch delete multiple waybills by their DocumentRef via InternetDocument/delete (doc 1.2). Alias for waybill_delete that processes all refs in a single API call. Waybills can only be deleted before they enter processing.
| Name | Type | Req | Description |
|---|---|---|---|
| documentRefs | array | yes | Array of DocumentRef values to delete. |
No output schema declared.
No examples provided.
waybill_get_delivery_date ~126
Get estimated delivery date for a city pair and service type. Doc 1.2 outlines the generic Nova Poshta envelope, and this helper builds the methodProperties (CitySender, CityRecipient, ServiceType, optional DateTime) expected by the delivery-date method.
| Name | Type | Req | Description |
|---|---|---|---|
| CityRecipient | string | — | Recipient city reference. |
| CitySender | string | — | Sender city reference. |
| DateTime | string | — | Optional shipment date (dd.mm.yyyy). |
| ServiceType | string | — | Service type. |
| request | object | — | Raw Nova Poshta delivery date payload. |
No output schema declared.
No examples provided.
waybill_get_estimate ~174
Get complete shipment estimate (price + delivery date) in one call via InternetDocument/getDocumentPrice and getDocumentDeliveryDate (doc 1.2). Combines cost calculation and delivery date estimation for convenience. Requires the same PascalCase parameters as waybill_calculate_cost.
| Name | Type | Req | Description |
|---|---|---|---|
| CargoType | string | — | Cargo type (Parcel, Documents, TiresWheels, etc.). |
| CityRecipient | string | — | Recipient city reference. |
| CitySender | string | — | Sender city reference. |
| Cost | number | — | Declared value in UAH. |
| SeatsAmount | number | — | Number of seats. |
| ServiceType | string | — | Service type (WarehouseWarehouse, WarehouseDoors, etc.). |
| Weight | number | — | Weight in kg. |
| request | object | — | Raw Nova Poshta price calculation payload. |
No output schema declared.
No examples provided.
waybill_update ~70
Update an existing waybill. Per doc 1.2 the same InternetDocument request envelope is used for update calls, so pass the raw payload (must include DocumentRef) exactly as defined by Nova Poshta.
| Name | Type | Req | Description |
|---|---|---|---|
| request | object | yes | Raw Nova Poshta update payload (must include DocumentRef). |
No output schema declared.
No examples provided.