[ENG] WooCommerce
Below is the documentation for the proprietary InPost WooCommerce plugin. It contains information about installation and configuration of the plugin
Plugin: (latest version of new release 1.6.2 available on wordpress)
Changelog
Na tej stronie:
- 1 Changelog
- 2 Authorization
- 3 Plugin installation
- 4 Plugin configuration
- 4.1 Logging in (Authorization)
- 4.2 Send options
- 4.3 Dispatch Point
- 4.4 Sender
- 4.5 Additional options
- 4.6 Debug Mode
- 4.7 Quick Returns
- 5 Available delivery methods
- 6 Delivery Services
- 6.1 Configuration
- 6.1.1 Service name
- 6.1.2 Logo
- 6.1.3 Setting the amount from which free delivery applies
- 6.1.4 Insurance
- 6.1.5 Possibility to add the text "free shipping" in the checkout
- 6.1.6 Inclusion of discount for coupons
- 6.1.7 Shipping price
- 6.1.8 Shipping taxed (according to WooCommerce rules)
- 6.1.9 Flat-rate
- 6.1.10 Shipping class configuration
- 6.2 Shipping class costs
- 6.3 InPost Locker Economy
- 6.4 Weekend Parcel Service
- 6.1 Configuration
- 7 Order processing/shipping
- 8 Configure delivery methods in products
- 9 Handling coupons for delivery
- 10 Integration with Flexible Shipping
- 11 Solutions to problems
- 12 Contact
Authorization
Production environment
You must have access credentials to connect to the ShipX API before installation:
Access Token (key)
ID organization
and
Access Token for Geowidget
Download a tutorial explaining how to quickly create access to the ShipX API and Geowidget on your own:
https://inpost.pl/sites/default/files/2022-03/instrukcja-konfiguracji-api-shipx.pdf
Test environment
Access generation
InPost - Manager paczek > tab Moje konto > API
To generate a Token and an organization ID, you need to complete all the data, including billing details under My Account > Data. In order to create a Parcel Locker® shipment you need funds in your account, you will top up your account virtually in the Payments tab
Geowidget:
Access Token do Geowidget > tab Moje konto > API > Geowidget
Plugin installation
Log in to your store's admin panel on the WooCommerce platform
Go to Plugins → Installed Plugins
2. In this tab, select the Add new and then Upload Plugin
(Click the button and upload the installation package as an Archive)
Plugin configuration
Search the module for further configuration by going to InPost → Settings
Logging in (Authorization)
Here you can fill in your API access data (Token, Organization ID), which you can generate yourself in the Parcel Manager under the "API" tab.
(Access to the environments is at the beginning of this documentation)
Organization ID | should be completed from Parcel Manager (My Account tab - API, format - 5 digits) |
Token | should be completed from the Parcel Manager (My Account - API tab) |
Geowidget production token | should be completed from the Parcel Manager (My Account tab - API - Geowidget). Without this data, the Map will not display correctly |
Geowidget sandbox token | should be completed from the Sandbox Parcel Manager (My Account - API - Geowidget tab) Without this data, the map will not display correctly |
API Type | Production/Sandbox |
Szybkie Zwroty | here you can fill in the abbreviated name of your account set up on the Fast Returns website |
Send options
Default insurance amount | allows you to specify a default insurance value to be completed on shipments |
Default package size | applies to Parcel Locker service - gab. A/B/C |
Default courier package size | default dimensions for courier shipments (when checked overwrites the dimensions set in the product) |
Default send method | Courier/Parcel Locker |
Parcel locker label format | choice of A4 or A6 |
Default send parcel locker | default parcel locker, which will be substituted when you select the way of shipment - parcel locker |
Dispatch Point
Dispatch Point | allows you to add/delete/edit Receipt Points |
Sender
Sender | It should be completed with the company data |
Additional options
Enable InPost methods for all products in your shop | Checkbox to enable InPost delivery methods in all products at once |
Enable SmartCourier method for all products in your shop | Enables SmartCourier delivery method for all products |
Do not provide InPost parcel locker service if the weight of goods exceeds 25 kg | Only works if weight is set in the product |
Send an email to the buyer about the start of the delivery process just after parcel created? | Sends an email to the customer about the creation of the shipment |
Change order status to Completed after shipment created? | Changes the status of an order after creating a shipment in the order |
Automatically add buyer order comment to field 'Reference' | Automatically copies the buyer's comment/remarks to the “Reference Number” field when creating a shipment in an order |
Debug Mode
This mode allows you to enable additional options available to the administrator as well as change the location of the "Select Parcel Machine" button display
Enable JS mode of the map button → Setup for Multisite stores (in the absence of “Choose Parcel Post” button)
Disable condition to enable geowidget scripts only on Checkout page → Enable when the “Select Parcel Post” button is not working
Quick Returns
The service allows customers to return shipments ordered from the store via Parcel Locker
In the plugin configuration, you need to provide a link to the Fast Returns form (e.g. https://szybkiezwroty.pl/pl/Nazwa_sklepu). The link is created when you create an account for this service through the Sales Representative
A customer who is logged in to the store in the order tab sees a new Fast Returns button this takes them to your form where they can make a return
Available delivery methods
Delivery methods | Description |
---|---|
InPost Locker 24/7 InPost Locker COD | Delivery of a shipment to Parcel Locker/Parcel Point pickup points
|
InPost Courier InPost Courier COD | Delivery of the shipment to the address provided by the customer Service available only for business customer (contract)
|
InPost Courier C2C InPost Courier C2C COD | Delivery of the package to the address provided by the customer Service available for retail customer - (prepaid) (rates according to the price list on the website InPost.pl
|
InPost Locker Weekend | Delivery of a shipment to Parcel Locker on the weekend available 24/7 |
InPost SmartCourier | Delivery of a shipment to the address provided by the customer. A service dedicated to the delivery of goods that require personal delivery with confirmation of the recipient's data. The delivery process requires verification of the addressee with such data as first name, last name, age of majority, and if delivery of a category of goods requires sobriety of the recipient of the shipment, this will also be verified |
Delivery Services
Configuration
To configure the services available in the shopping cart, you need to add each one individually in the configuration
To do this, go to WooCommerce → Settings → Shipping
2. Select the country (edit button)
3. Click Add shipping method
4. Select a specific service
5. The service is added. It needs to be configured
When selecting a service, we have the ability to configure it:
Service name | The name of the service and the logo should be added according to the guidelines in the „Poradniku skutecznej implementacji dostaw InPost w koszyku e-commerce” link: https://inpost.pl/sites/default/files/docs/regulaminy/instrukcja-ekspozycji-dostawy-paczkomat-inpost-247-w-twoim-sklepie-777232.pdf |
Logo | originally the current logo is already added to the delivery method |
Setting the amount from which free delivery applies |
|
Insurance | Allows you to specify a default insurance value to be completed on shipments
|
Possibility to add the text "free shipping" in the checkout |
|
Inclusion of discount for coupons |
|
Shipping price |
|
Shipping taxed (according to WooCommerce rules) |
|
Flat-rate | In addition, by unchecking Uniform rate, you can set the shipping price in terms of the weight in the cart, the size as well as the price of the products themselves weight/size/price are taken from the settings of the product |
Shipping class configuration | Configuring a shipping class allows you to group products when it comes to prices |
Preview:
Shipping class costs
Configuring a shipping class allows us to group products when it comes to prices. We create a shipping class, which we can assign to a specific item(s) in the product settings.
We can add as many shipping classes as we want.
Class creation:
You need to create shipping classes on the tab WooCommerce → Settings → Shipping → Shipping classes → Add shipping class
Configuring in the delivery method:
WooCommerce → Settings → Shipping → Zone
In a given form of delivery, such as InPost Parcel Locker® 24/7, you need to specify what shipping costs will be in a particular class
Priority of calculation of delivery price:
if the free delivery threshold is reached then - free delivery
2. if the free delivery threshold is not reached - we take the price for the delivery class
3. if the delivery class is not specified - then the settings of our plugin (flat rate or price from the table against the size/weight)
Configuration in the product:
Moving to a specific product, you need to set in the Shipping tab which shipping class it should belong to
InPost Locker Economy
Products ordered through the provided InPost Paczkomat® Economy Parcel service get an attractive delivery price. Receiving economy parcels from Paczkomat® InPost is the safest way to carry out online orders, especially with the remote opening of the box through the InPost Mobile application
A new shipping method should be added to the operation of the service
WooCommerce tab → Settings → Shipping → Add shipping method
2. Then configure the service by providing the commercial product ID given in the contract and complete the price for the service
3. When the customer selects the InPost Locker Economy, information about the service and the variant will appear in the order
Weekend Parcel Service
In order to make the Parcel on the Weekend service available, you need to add a new delivery method
To do this, go to WooCommerce → Settings → Shipping
select a country (edit button)
click Add Shipping Method
From the list, select: InPost Locker Weekend
We proceed to the delivery configuration:
By setting a specific day and time, we indicate at what times the specified service should appear in the shopping cart on the website
Order processing/shipping
Order handling
Allows generation of labels, creation of shipments, printing of collection orders
Moving on to the order after the customer selects a specific service, the window for InPost shipping appears
After completing and verifying the data, press the Send Parcel button to generate the package and assign a tracking number
After a while, the Get stickers and tracking number button appears
Mass shipment creation
The plugin allows you to create shipments in bulk
Go to the Orders tab and select the specific orders in which you want to create a shipment
Then expand the list - Bulk actions at the top of the table and select InPost PL create shipments
It is possible to create shipments in bulk with specifically selected A/B/C dimensions:
Create multiple shipments in an order
It is possible to create several parcels in an order
After creating the first shipment under the Get sticker button, click Create another shipment
Select the delivery method for your next shipment and click Add Another Package
A new window with shipment information is shown. Select the Send Parcel button
The window refreshes and the option to download the label appears
Creating multi-packet shipments
Standard Courier service is the possibility of generating multi-packet shipments (1/3,2/3 ...).
Entering the order we checkobox: Send as several packages
A window appears with a view of additional shipments 5/5 - remove the unnecessary number of shipments
We enter the dimensions and click Send Parcel
After creating a shipment, you can download labels (number of labels depending on the number of shipments)
Mass downloading of labels
The plugin allows you to download labels in bulk
There are two places where this can be done
Tab Orders - bulk actions button at the top of the table:
2. Tab InPost - Shipments - Get stickers button (after selecting shipments)
Shipping service
Tabs:
InPost → Shipments
Here it is possible to handle and view drive-up orders, currently processed and shipped shipments, generate labels, create and print pickup orders
Here you can also create labels in bulk
Configure delivery methods in products
Mass editing from within the plugin
We have created a general view of the added products in the store so that we can more easily determine the available delivery methods and product sizes (Parcel Locker)
It is possible to filter by categories, product type or search for products by name
Directly in the product
Templates
In each product, it is possible to specify specific dimensions for courier shipments and dimensions for Parcel Post® shipments. They are automatically downloaded to your order.
Availability of services
Directly in the product, set the visibility of individual services in the shopping cart:
Handling coupons for delivery
Coupon support in the shopping cart can be enabled at WooCommerce → Settings → General → Enable coupons
Configuration can be found under Marketing → Coupons
We click add coupon
We choose from Discount type → Inpost
Set the value of the coupon, its name, expiration date and for which forms of delivery it should appear
Click Publish
In the shopping cart after the customer adds the coupon, the discount information shows above the shipping and the shipping amount is reduced by the value of the coupon
Integration with Flexible Shipping
Our module allows you to integrate with Flexible Shipping plugin
After activating this plugin, the standard list of InPost services disappears
To configure the services available in the shopping cart, you need to add each one individually in the plugin configuration
To do so, go to WooCommerce → Settings → Shipping
2. select a country (edit button)
3. click Add shipping method
4. select Flexible Shipping
After creating a form of delivery, you need to configure it
Go to the specific newly created service, which is tentatively named Flexible Shipping, and click Edit
We fill in the name of the service
2. We select a specific service assigned to InPost API
3. Set the price and configure further settings of the Flexible Shipping plugin
Solutions to problems
An error occurred while connecting to the API
One of the reasons for the above error is when the data provided in the place of Organization ID and Token is incorrect - or the data provided does not apply to the API Type: Sandbox (Sandbox and Production are two separate environments and have different organization IDs)
After each modification of the token or organization ID, save the settings (only then the authorization data is verified)
This error can also appear when the store's connection to the API is blocked - either on the server side of the store (you should verify this state in your hosting) or on our side. In this case, please contact us via our form https://inpost.pl/formularz-wsparcie
Creating a parcel - Selected offer
In the order when creating a shipment in the status instead of tracking number appears Status: offer selected
This means that the shipment has not been created
Possible reasons:
Lack of funds in the account in Parcel Manager (for Prepaid customers)
No bank account number in Manager Parcels
In case of courier service, no attached courier contract in Parcel Manager
Error regarding recipient data - post code
Geowidget - no access
When the shopping cart in Geowidget shows the error "No access, check if the token has been generated for the correct site" you need to re-generate the token for Geowidget in Parcel Manager but specifying the correct store site address. The error is related to providing an incorrect store URL.
No deliveries in the InPost shopping cart
No services in the product
InPost services must be added in a specific product:
You can also add InPost services to all products at once:
Delivery method 'Free Delivery'
This method in WooCommerce causes that when it meets the condition and can be displayed in the shopping cart next to the product, it removes all other available delivery methods.
It should be removed
Free delivery from a specific amount can be set in our InPost methods
No button- "Select Parcel Locker"
Check:
Token for Geowidget - generate it without specifying the site URL
Install the latest version of the plugin
Check if the added delivery method was made according to the documentation
[ENG] WooCommerce | Configuration
Test if it changes anything to enable the option in the plugin configuration: JS mode (at the very bottom in debugging)
If there is no improvement, please contact us using the form https://inpost.pl/formularz-wsparcie
"Select Parcel Locker" button does not respond
You should:
Check if the tokens for Geowidget and API are correct
Check if the shipping methods are still added in WooCommerce - Settings - Shipping.
Check if InPost services are enabled in products (product configuration)
Check if any of the options are enabled in the INPOST tab at the very bottom:
Enable JS mode of the map button
Disable check so that the script for geowidget is connected only on the Checkout page → Enable when the " Select Parcel Post" button does not work
Contact
If you have any questions, please use the Integration Department's contact form, which is available here: https://inpost.pl/formularz-wsparcie
After entering the form, just select "Customer Support" from the list, in the category select: InPost module, and in the field "Please specify the name of the module" enter: WooCommerce