[ENG] Shopify

Owned by Paweł Milewski
Last updated: Nov 15, 2024
10 min read

 

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 SHOPIFY plan

Due to changes in Shopify, we had to disable "Advanced Mode" or Geowidget in Shopify Plus. As of 04.01, only the list of points will be available and "Advanced Mode" will be deactivated.

 

Plugin:

17.05.2023

Marketplace Shopify

https://apps.shopify.com/inpost-oficjalna-aplikacja?locale=pl&search_id=d8ba9002-e8bf-4807-8eba-ebfc96402a1c&surface_detail=inpost&surface_inter_position=1&surface_intra_position=8&surface_type=search

 

! After installing the plugin, add the webhook address in the Parcel Manager panel:

Manager Paczek → Moje Konto → API → Ustawienia Organizacji → Adres Webhook

https://shop-plugin-api.inpost.pl/api/inpost/webhook

 

! The activation of carrier-calculated shipping is required for the proper functioning of the InPost application.

CCS can be activated by contacting Shopify support

After activation, reinstall the InPost application

Changelog

Changelog:

15.11.2024 → Mass label generation has been improved

→ A4 format for InPost Paczkomat 24/7 service has been added (generating several labels on one page)

→ Label cancellation has been added (after 30 days a label that has not been sent is removed from the “Shipments” tab)

→ Added has been paged in the “Shipments” tab.

27.08.2024 → Added COD service for C2C courier delivery method

→ Added editing of buyer data (if we edit the data in the order in Shopify - it will also change in the InPost panel when creating a package)

→ Provide the ability to edit the amount of COD when creating a parcel

31.07.2024 → Adding a tab “excluded products” , which allows you to disable InPost delivery methods in specific products

→ Adding the possibility of displaying Parcel/Packet and Parcel-Point or Parcel-Point alone in InPost Parcel delivery methods

→ Improvement of bulk label downloading

→ Improved filtering of shipments in the “Shipments” tab. - remembering filters

04.06.2024 → Addition of automatic replenishment of the tracking number in the order when the order status is changed to ‘completed’

18.04.2024 → Addition of error display

→ Blocking excessive requests sent by the shop

04.01.2024 → Shopify API update in app

→ Disabling the advanced mode (geowidget)

→ Changing the display of the name of services in the shopping basket

→ FIX: Label in A6 format

08.12.2023 → Including the Shopify order number on the label

31.10.2023 → Addition of information on required checkout liquid

→ Change of name of POP/Packet Machine

25.10.2023 → FIX: Changing Parcel Machine® receiving (after changing the sending one)

05.10.2023 → FIX: Search for parcel machine by address (not postcode)

 

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: Installing apps

 

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

 

 

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.

 

 

Authorization (Login Details)

 

ID organizacji

Must be completed from Parcel Manager (My Account tab - API, format - 5 digits)

Autoryzacja (Token API)

Allows you to configure access to the ShipX API (Production and Sandbox). Data like organization ID and token can be obtained from the Parcel Manager. We described it in the first part of this documentation Autoryzacja

Autoryzacja (Token Geowidget) Shopify Plus

Allows you to add a Token to Geowidget (you need to generate a Geowiedget token for the map with InPost points to work properly)

Tryb API

Sandbox/Produkcja

Status wtyczki

Deactivating the plug-in will not affect the orders being processed. New customers will not be able to use the delivery methods defined in the settings.

 

Services

 

Tryb

You should select the plan you have in the store:

 

Standard: Does not display Geowidget map, no option to upload service logo

 

Standard:

 

 

 

 

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

 

 

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

  1. 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

  2. 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.

* 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.

 

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

 

 

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.

 

 

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.

 

 

EFFECT:

 

 

Returns made through the form have 2 acceptance options:

  1. Automatic - the customer, when completing the form, receives a return code, which he must enter while at the machine

  2. 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

 

 

 

Disable products

 

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

 

 

 

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

  • Sposób nadania

  • Status

  • Usługa

  • Ilość pokazanych przesyłek na stroniw

  • Nr referencyjny

  • Nr zamówienia

  • Nr telefonu

  • E-mail odbiorcy

 

List of shipments

In the list of shipments, columns are available:

  • Zamawianie podjazdu  - Ordering a driveway

  • Drukowanie etykiet - Printing labels

  • Drukowanie etykiet zwrotnych - Print return labels

  • Drukuj zleceń odbioru - Print collection orders

 

  • 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

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

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:

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

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

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

 

 

Orders - courier driveway

Panel for viewing submitted driveway orders

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

 

Product

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

 

 

Help

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

 

 

 

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 "Wsparcie Klienta” from the list, in the category select: Moduł InPost, and in the field "Proszę podać nazwę modułu” enter: Shopify