[ENG] Shopify

Open

Below is the documentation for InPost's proprietary Shopify solution. It contains information about the installation and configuration of the plugin.

The plugin is available on the Shopify app strore

Shopify as of January 1, 2023 has changed the rules for granting access to the Carrier Service API which allows our application to work only from the GROW plan

Open

 

Open

Changelog

Na tej stronie:

Authorization

Production environment

Sandbox environment

Important!

Sandbox mode is available only when no production order has yet been processed by the application.

Due to the limitations of displaying POPs in the test maps, production maps have been used in the application to allow you to preview the selection of default Parcelboxes or Parcelpoints.

To create a shipment in test mode with Parcel Post or POP broadcast, you need to enter the data manually.

• Parcel Locker : WAW099, AND01A, BBI01N

• POP : POP-004-TEST

Plugin installation

Install the app from the Shopify App Store

Steps:

• Log in to the Shopify App Store

• Find Inpost app, then click it

• On the app offer page, click Add app

• To authorize the use of the app, click Install app in the Shopify dashboard
  
  

Once the app is installed, you can view and use it on the Apps page of your Shopify dashboard.

More information: https://help.shopify.com/en/manual/apps/installing-apps

After installation, the application on the left will appear in the store panel:

Open

Configuration

To configure the plug-in, we go to the InPost application. There you will see several tabs below telling you what they mean:

The changes made should be saved, by clicking the Zapisz Ustawienia at the bottom of the screen

After saving the settings, a confirmation message will appear.

Open

Authorization (Login Details)

Open

Services

Numer zamówienia na etykiecie	Checking this feature on the label will add the Shopify order number to the reference number:   Open   Label: Open
Zapobiegaj mnożeniu ceny w przypadku dostawy z wielu lokalizacji	If the delivery is made from several locations (two products in the basket are from different locations), select this option so that the delivery price is not duplicated.
Metody dostawy	Allows you to configure delivery methods: service name the number of parcel machines that will be displayed in the shopping cart (closest to the address that the customer specified) types of pickup points to appear in checkout cost of delivery free delivery threshold maximum allowed weight for products at which this delivery service will display in the shopping cart positioning of services (by clicking on the up or down arrow) logo (only with Shopify Plus) ! It is important to set the weight for each product in the store   Open   You can find a delivery implementation guide at: https://inpost.pl/sites/default/files/docs/regulaminy/instrukcja-ekspozycji-dostawy-paczkomat-inpost-247-w-twoim-sklepie-777232.pdf   In addition, for Weekend Parcel, please specify: Availability from / to day of the week Availability from / to the hour
Szybkie Zwroty	Enables configuration of the Quick Returns service In the plug-in 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 After adding the short name, a code will be generated. The code allows you to display the Return button in the customer panel of the skep. The code should be copied and added in the store template according to the following instructions. Open Quick Returns Return Button Implementation | INSTRUCTIONS * Fill in the abbreviated name of your account set up on the Quick Returns service * After adding the short name, a code will be generated. The code allows you to display the 'return' button in the skep customer panel. The code should be copied and added in the store template according to the instructions below.   1. Refer to the Shopify manual Edytowanie kodu szablonu · Centrum Pomocy Shopify From the Shopify admin panel, go to options: Online Store > Templates. 2. We make sure that our store uses the classic customer panel and that you have access to edit the template code.   Open 3. Verify which of the following files you can edit in your store   Path for templates/customers/order.json 1. We find in the templates/customers/order.json file the name of the section that our template uses   Open   2. In the above case, it is main-order, so the path to the section file is as follows: sections/main-order.liquid Edit the sections/main-order.liquid file by adding the embed code from the app under the order details table.   Open   Path for templates/customers/order.liquid Edit the templates/customers/order.liquid file by adding the embed code from the app under the order details table.   Open   EFFECT:   Open   Returns made through the form have 2 acceptance options: Automatic - the customer, when completing the form, receives a return code, which he must enter while at the machine Manual acceptance - the customer submits the form but you are the one who accepts or not a given return. Only after acceptance does the customer receive the return code
Domyślna wartość ubezpieczenia	Default amount that will be displayed when creating InPost shipments (blank indicates 0)
Ustawienia nadania	allows you to set the default parcel size, which will be automatically substituted when creating a parcel default way of sending parcel shipments default outgoing parcel machine for parcel shipments default POP point
Punkt odbioru	A place to define a parcel pick-up point when creating a drive-up order Points can be added, deleted and edited
Nadawca	Specify the sender of the packages - all fields must be completed

Checkout - list points

Example checkout appearance (with Basic setting - list of items):

Open

Checkout - geowidget

The plugin allows you to share pickup points in the form of a Geowidget.

Depending on your store plan, you can choose:

Basic - list of points (for Shopify plans)

Checkout - Geowidget in checkout (for Shopify Plus plans)

Thank You Page - Geowidget in summary (for Shopify plans)

Open

In order for the Geowidget to work properly, you need to provide a key for Google Maps + Geocoding API, which can be obtained from:

https://mapsplatform.google.com/ → Get Started → Create an account (if you don't have one)

Then proceed to account configuration. You must fill in the necessary data, including contact and payment details.

Moving on, another window will appear, displaying the generated unique API key. By entering it into your website script, you will enable site users to use Google Maps functionality.

When creating, enable the following interfaces:

• Directions API

• Geocoding API

• Geolocation API

Copy the key and paste it into the InPost application.

Next, add a block with a map:

Settings > Checkout > Configurations > Customize:

Open

At the top, select Checkout/Thank you page (depending on the mode):

Open

Select Sections + Add block by choosing the block from the InPost app “Parcel locker selection”

Open

After saving the tokens, adding the block, and creating a new shopping cart, the InPost International method will appear in your store (see the Thank You Page screenshot for an example):

Open

In summary, it will be possible to select points from the list and map:

Open

After clicking Map:

Open

After selecting an item, click SAVE SELECTION

Disable products

The tab allows you to enable or disable the visibility of all InPost services in a given product.

Open

Shipments - management

A place to manage orders and shipments. We can manage them in bulk or by going into individual orders.

There is a view of all the important information - shipment number, order number, status, price, service, method of shipment, phone number, recipient's email, whether the package was shipped and date.

Filtering shipments

This is done by hanging or selecting the option and clicking ‘Szukaj przesyłek’

• Sposób nadania

• Status

• Usługa

• Ilość pokazanych przesyłek na stroniw

• Nr referencyjny

• Nr zamówienia

• Nr telefonu

• E-mail odbiorcy

Open

 

---

List of shipments

In the list of shipments, columns are available:

Checkbox - is used to perform group actions like:

• Zamawianie podjazdu  - Ordering a driveway

• Drukowanie etykiet - Printing labels

• Drukowanie etykiet zwrotnych - Print return labels

• Drukuj zleceń odbioru - Print collection orders

 

Open

Shipment No.

• Nr przesyłki utworzony: click takes you to shipment tracking

• Nr przesyłki nie utworzony: Clicking on the '+' takes you to the settings for a particular order

Open

Status — shipment status of a given order

Cena — total value of the order

Usługa — the selected delivery service

Sposób nadania — the selected shipping method

Nr tel. - details of the customer who placed the order

E-mail odbiorcy — data of the customer who placed the order data

Nadano — date of shipment

Utworzono — date of creation

Akcje -

• Drukuj etykietę

  • The action allows you to generate labels in 3 formats PDF, A6 format / EPL / ZPL

  • The action is available after creating a shipment

• Drukuj etykietę zwrotną

  • Action available only for courier services

• Drukuj zlecenie odbioru

  • Option available after ordering a driveway

• Zamów podjazd

  • This option allows, ordering a driveway for the entered parcel pick-up locations. It is required to select or define a pickup location

  • Option is available after parcel number is generated

Label generation

Generate labels in bulk via action buttons

Select specific shipments (which already have tracking numbers generated), select the three dots at the bottom in the black window that expand additional actions, and select Print labels - a window will appear with a choice of format.

Open

Single label generation

In the shipments tab, select the Print Labels button where we can choose the label format:

Open

Shipments - creating shipments

From the Application level in the Przesyłki tab

In the Przesyłki tab you will find all orders placed in the store for which the InPost delivery method has been selected

To create a shipment you need to:

In the ‘Nr przesyłki ‘ column, click the button ‘+’

• The button is available for orders for which no shipment number has been generated

Open

Admin is taken to the details of a given order. The order details view is divided into 2 sections

• The left section is customer data and order details

• The right section is used to generate the shipment.

Open

In the shipment handling panel admin can:

• Usługa — Service - verify or change the selected form of delivery

• Paczkomat odbiorczy klienta — Customer's receiving parcel - verify or change the customer's receiving parcel

• Status przesyłki — Shipment status - preview the status of the shipment

• Domyślny rozmiar paczki — Default parcel size - select the size of the parcel to be shipped

• Wartość ubezpieczenia — Insurance value - change the default insurance value [provided in the services tab

•  Numer referencyjny — Reference number

• Sposób nadania — Shipment method

• Punkt odbioru — Pickup point - list of pickup points available for a given way of shipment, points are added in the 'services' tab

• Numer przesyłki —Shipment number - The shipment number will be automatically assigned after the shipment is created

  1. Once the tracking number is generated, you can go directly to shipment tracking https://inpost.pl/sledzenie-przesylek  

  2. Once the tracking number is generated, you can also download parcel labels

Open

From within a given order

InPost shipment can be created directly from the order level, to do this you need to:

1. Go to the order in question

2. Select ' More Actions' > 'Create InPost shipment' in the upper right corner

   Open

   

3. Admin will be transferred to the parcel creation panel in the Inpost app

Create shipments in bulk

Under Shipments → select the orders in which no shipment numbers have been assigned and then enter the additional options (three dots) and select create shipments

Open

A message will appear (click create shipments):

Open

Confirmation of the creation of shipments, where we can print labels

Open

Completing the consignment number in the order

The tracking number will automatically be added to the order in Shopify but two conditions must be met:

1. Creation of the shipment in the InPost app

2. In the order list, change the status to FULFILLED

Open

Open

Orders - courier driveway

Panel for viewing submitted driveway orders

Columns: shipment number, date of shipment, pickup points, status

Open

Product

You need to set the weight in each product to generate a shipment in the order:

Open

External integration – correct source of data about the pickup point

Recently, we have noticed cases of misuse of the service_code field for external integration. This field is used exclusively for internal application needs, such as determining the order in which delivery methods are displayed at checkout, and may contain additional technical information (e.g., :i_0).

📍 The correct place to retrieve information about the selected pickup point and service name is the order attributes.
This data is stored and available in the order in the Shopify panel in the Additional details section (see example below) and via the API.

➡️ Example attributes:

InPost service: locker

InPost Parcel Locker: RZE285

This makes them independent of the application logic and always consistent with the customer's selected option.

Help

A place with information about the documentation (above) and a contact form for additional questions

Open