Connecting Nova Poshta to an online store
Important: This service is currently available in Ukrainian only and is aimed at the Ukrainian market.
You can enable integration with Nova Poshta so that your customers can select the required post office from the list when making an order.
Tip: To date, there is no possibility to automatically create a shipping waybill. That is, information from your online store will not be transferred to your Nova Post account.
Content:
Getting an API key in your Nova Poshta account
Connecting the integration to the site on Weblium
Setting up the integration on Weblium
Extending the API key expiration date
Register a personal account on the Nova Poshta website or log in to an existing one.
Go to the Безпека (Security) tab and click on the Створити ключ (Generate a key) button:
Confirm the creation of the API key by clicking on the Створити (Generate) button:
Copy your API key in the Ключ (Key) column:
Note: In the "Сервіс" (Service) column, exactly "Бізнес-кабінет" (Business account) should be indicated but not "Мобільний додаток" (Mobile app), etc.
Important: The API key is generated for a period of 1 year. After the final date, the key stops working and can no longer be used on your site. You can learn how to renew your API key in the last section of this guide (this can be done ahead of time).
Open your site settings, go to the Shipment section and click the Connect button in the Nova Poshta section:
Paste your API key into the field and click on the Save button:
As in other shipment methods, you can add Comments for your customers and edit the inscriptions on the fields that customers of your store fill in, namely, change the name and placeholder inside these fields:
ㅤㅤㅤ1) In the Shipping method name field, you can respectively indicate the name of the shipping method you have chosen;
ㅤㅤㅤ2) In the Comments field, you can specify additional information for your customers, which will be displayed under the name of the shipping method;
ㅤㅤㅤ3) In the City field field, you can specify the text that will be displayed in the cart above and inside the field from which your customers will choose the city to receive the parcel;
ㅤㅤㅤ4) You can also change the name and placeholder text inside the Post office field field (where a customer selects a specific Nova Poshta post office in his city):
Note: The information from these fields comes directly from the Nova Poshta database.
The next option to configure is Post offices filter.
Here, you can select the types of post offices that will appear on the customer's side when choosing an office:
1) Post office - a regular post of Nova Poshta that accepts parcels weighing up to 30 kg (some offices have a lower maximum parcel weight).
2) Cargo department - they receive / issue a shipment with an actual and volumetric weight of up to 1,000 kg per departure item, a maximum length of up to 300 cm, and a height of up to 170 cm.
3) Parcel locker is an automatic terminal for receiving and sending parcels to do this at any time in a reasonably convenient way.
Tip: You can find more detailed information about the Nova Poshta parcel locker operation here.
Note: If you have large-size items, you may find it helpful to turn off this type of post (as well as regular post offices) and keep only the cargo department option.
4) PrivatBank parcel locker - the same as described in the previous item. Privatbank cooperates with Nova Poshta and provides its own parcel lockers for use.
5) Parcel Shop provides placement for receiving and issuing parcels weighing up to 15 kg in shopping centers and supermarkets in a small area.
Tip: You can learn more about this type of department here.
Important: As of today, such types of offices as "PrivatBank parcel locker" and "Parcel Shop" are unavailable. We currently have them because Nova Poshta still technically allows you to select these options, and accordingly, we also left them available. These 2 office types may become available again in the future, so you can leave them enabled if you wish.
You can also customize the shipping cost.
It can be fixed:
Important: A fixed price will be added to the total amount of the order.
...and custom:
And finally, you can choose payment methods when choosing which delivery option from Nova Poshta will be available to your customers:
Tip: Nova Poshta works stably with all the payment systems indicated in the screenshot above.
Don't forget to publish the site for all the latest changes.
After completing all the settings and saving them, you will see Nova Poshta in the shopping cart on your site:
Note: In the cart, the city and post office choice is available only in Ukrainian.
Your API key can be renewed. This can be done if you go to the personal account of Nova Poshta, similar to the connection process, in the Налаштування (Settings) section, go to the Безпека (Security) tab and click on the clock icon next to the desired key:
…and extend it by pressing the Підтвердити (confirm) button:
However, several situations will not allow you to renew the key if the expiration date has already passed or if the key has been deleted. That is, the key's expiration date can be extended until its end date has come and it has not been withdrawn.
Important: If the key has expired, you need to repeat the connection process from this instruction (generate a new API key and re-enable it in your site settings instead of the obsolete key).
Tip: The key can be renewed in advance immediately after its creation.
You can enable integration with Nova Poshta so that your customers can select the required post office from the list when making an order.
Tip: To date, there is no possibility to automatically create a shipping waybill. That is, information from your online store will not be transferred to your Nova Post account.
Content:
Getting an API key in your Nova Poshta account
Connecting the integration to the site on Weblium
Setting up the integration on Weblium
Extending the API key expiration date
Getting an API key in your Nova Poshta account
Register a personal account on the Nova Poshta website or log in to an existing one.
Go to the Безпека (Security) tab and click on the Створити ключ (Generate a key) button:
Confirm the creation of the API key by clicking on the Створити (Generate) button:
Copy your API key in the Ключ (Key) column:
Note: In the "Сервіс" (Service) column, exactly "Бізнес-кабінет" (Business account) should be indicated but not "Мобільний додаток" (Mobile app), etc.
Important: The API key is generated for a period of 1 year. After the final date, the key stops working and can no longer be used on your site. You can learn how to renew your API key in the last section of this guide (this can be done ahead of time).
Connecting the integration to the site on Weblium
Open your site settings, go to the Shipment section and click the Connect button in the Nova Poshta section:
Paste your API key into the field and click on the Save button:
Setting up the integration on Weblium
As in other shipment methods, you can add Comments for your customers and edit the inscriptions on the fields that customers of your store fill in, namely, change the name and placeholder inside these fields:
ㅤㅤㅤ1) In the Shipping method name field, you can respectively indicate the name of the shipping method you have chosen;
ㅤㅤㅤ2) In the Comments field, you can specify additional information for your customers, which will be displayed under the name of the shipping method;
ㅤㅤㅤ3) In the City field field, you can specify the text that will be displayed in the cart above and inside the field from which your customers will choose the city to receive the parcel;
ㅤㅤㅤ4) You can also change the name and placeholder text inside the Post office field field (where a customer selects a specific Nova Poshta post office in his city):
Note: The information from these fields comes directly from the Nova Poshta database.
The next option to configure is Post offices filter.
Here, you can select the types of post offices that will appear on the customer's side when choosing an office:
1) Post office - a regular post of Nova Poshta that accepts parcels weighing up to 30 kg (some offices have a lower maximum parcel weight).
2) Cargo department - they receive / issue a shipment with an actual and volumetric weight of up to 1,000 kg per departure item, a maximum length of up to 300 cm, and a height of up to 170 cm.
3) Parcel locker is an automatic terminal for receiving and sending parcels to do this at any time in a reasonably convenient way.
Tip: You can find more detailed information about the Nova Poshta parcel locker operation here.
Note: If you have large-size items, you may find it helpful to turn off this type of post (as well as regular post offices) and keep only the cargo department option.
4) PrivatBank parcel locker - the same as described in the previous item. Privatbank cooperates with Nova Poshta and provides its own parcel lockers for use.
5) Parcel Shop provides placement for receiving and issuing parcels weighing up to 15 kg in shopping centers and supermarkets in a small area.
Tip: You can learn more about this type of department here.
Important: As of today, such types of offices as "PrivatBank parcel locker" and "Parcel Shop" are unavailable. We currently have them because Nova Poshta still technically allows you to select these options, and accordingly, we also left them available. These 2 office types may become available again in the future, so you can leave them enabled if you wish.
You can also customize the shipping cost.
It can be fixed:
Important: A fixed price will be added to the total amount of the order.
...and custom:
And finally, you can choose payment methods when choosing which delivery option from Nova Poshta will be available to your customers:
Tip: Nova Poshta works stably with all the payment systems indicated in the screenshot above.
Don't forget to publish the site for all the latest changes.
After completing all the settings and saving them, you will see Nova Poshta in the shopping cart on your site:
Note: In the cart, the city and post office choice is available only in Ukrainian.
Extending the API key expiration date
Your API key can be renewed. This can be done if you go to the personal account of Nova Poshta, similar to the connection process, in the Налаштування (Settings) section, go to the Безпека (Security) tab and click on the clock icon next to the desired key:
…and extend it by pressing the Підтвердити (confirm) button:
However, several situations will not allow you to renew the key if the expiration date has already passed or if the key has been deleted. That is, the key's expiration date can be extended until its end date has come and it has not been withdrawn.
Important: If the key has expired, you need to repeat the connection process from this instruction (generate a new API key and re-enable it in your site settings instead of the obsolete key).
Tip: The key can be renewed in advance immediately after its creation.
Updated on: 12/08/2023
Thank you!