[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.8.3 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 Courier options
- 4.4 Dispatch Point
- 4.5 Sender
- 4.6 Additional options
- 4.7 Debug Mode
- 4.8 Quick Returns
- 5 Available delivery methods
- 6 Delivery Services
- 6.1 Configuration
- 6.1.1 Service name
- 6.1.2 Logo
- 6.1.3 PWW mode
- 6.1.4 Setting the amount from which free delivery applies
- 6.1.5 Insurance
- 6.1.6 Possibility to add the text "free shipping" in the checkout
- 6.1.7 Inclusion of discount for coupons
- 6.1.8 Shipping price
- 6.1.9 Shipping taxed (according to WooCommerce rules)
- 6.1.10 Flat-rate
- 6.1.11 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
https://sandbox-manager.paczkomaty.pl/ > 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 |
Important! When the shopping cart in Geowidget shows the error "No access, check if the token has been generated for the correct site" you must re-generate the token for Geowidget in the Parcel Manager but with the correct shop site address.
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 |
Courier options
Set default dimensions for courier shipments | this option sets one size for all courier shipments. |
Manage courier templates | allows you to create a template for a courier service, which you can then select when creating a shipment |
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 |
If there is no general InPost shipping method for products, always choose the most expensive option | When this setting is enabled, if there is a product in the cart with only the Parcel Locker service and another product with only the Courier service, it will select the most expensive one and display the delivery method |
Enable Webhook | This option allows you to update order statuses. Paste the generated webhook address into Package Manager. My Account tab → API → Organization Settings → New Webhook Address |
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
The Quick Returns button appears in the customer panel when a link is added in the plugin configuration "Quick Returns - link"
Returns made through the form have two acceptance options:
Automatic - when the customer completes the form, he or she is given a return code that must be entered while at the machine
Manual acceptance - the customer completes and submits the form but it is the store owner who accepts or not - the given return. Only after acceptance does the customer receive the return code