[1.0.0] FAQ

 

 

General

To access the ShipX API, please follow the instructions in the link below:
https://inpost.pl/sites/default/files/2022-03/instrukcja-konfiguracji-api-shipx.pdf

Yes, the ShipX API has a test environment (sandbox) address of the test environment: https://sandbox-api-shipx-pl.easypack24.net

https://sandbox-manager.paczkomaty.pl/ Moje Konto > API tabs. To generate Token and Organization ID you need to fill in all the data, including invoice data in Moje konto> Dane tab. To create a parcel shipment you need funds on your account, you can top up your account virtually in the Płatności.

yes, json queries can be downloaded from the link: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153477

Make sure you have correctly copied the data from the API tab in https://manager.paczkomaty.pl

Remember to use the token on the production environment with https://manager.paczkomaty.pl and on a sandbox environment with https://sandbox-manager.paczkomaty.pl/

If the API returns error 500, please use the integration support form: https://inpost.pl/formularz-wsparcie and choose the System Availability Problem category.

The API returns an error when the wrong organization id is entered. Log in https://manager.paczkomaty.pl and verify that the organization id entered the application is the same as in the API tab in the Parcel Manager.

 

Shipment

Yes, there is such a possibility with the batch : https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153502

No, if you did not enter the sender's data when creating the package, it will be pulled from the system.

No, the ShipX API has a simplified mode, when creating packages you indicate the service

Nazwa szablonu

Wymiary

Waga

Gabaryt

small

8 x 38 x 64 cm

do 25 kg

Gabaryt A

medium

19 x 38 x 64 cm

do 25 kg

Gabaryt B

large

41 x 38 x 64 cm

do 25 kg

Gabaryt C

you are interested in and then the API automatically pays for it.

When creating a COD package, please note that the package must be insured for a minimum of the COD value or higher.

check in https://manager.paczkomaty.pl Have you filled in your bank account number? Once the account number is filled in, the pickup packages will be created correctly.

No, if you did not enter the sender's data when creating the package, it will be pulled from the system.

No, templates have been created for parcel shipments that you can use to indicate the box where the shipment should be placed:

Template name

Dimensions

Weight

Size

small

8 x 38 x 64 cm

do 25 kg

Size A

medium

19 x 38 x 64 cm

do 25 kg

Size B

large

41 x 38 x 64 cm

do 25 kg

Size C

We recommend that you provide the correct dimensions and weight for courier packages.

1 2 3 4 5 6 7 8 9 10 11 12 "parcels": {                 "dimensions": {                 "length": "10",                 "width": "10",                 "height": "10",                 "unit": "mm"             },             "weight": {                 "amount": "10",                 "unit": "kg"             }            },

 

You can only update shipments that have not yet been purchased, which means they have a status of createdoffers_prepared or offer_selected.

To cancel a shipment within a specific organization, you must be a member of that organization. As an additional requirement, the shipment must have a status of created or offers_prepared.

Yes, the ShipX API allows you to create a package with a service “Paczka w Weekend”: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/47382917

The service will be available during a specific time window, e.g. from Thursday at 8 p.m. to Saturday at 1 a.m. We do not take into account holidays.

  • A label can be downloaded for a shipment that has been paid for in the confirmed status or later.

  • To download a shipment label, the user must be the sender.

Yes, you can download labels for up to 100 shipments: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153510

No, ShipX API only supports Polish phone numbers, you need to provide a 9-digit phone number, without special characters and area codes e.g. "+48".

If you are a postpaid customer (with an agreement) check that you have paid your last invoice and then contact your account manager. If you are a prepaid customer (without an agreement) make sure you have sufficient credit in your account.

The API returns an error because you are trying to use a courier service that is only available after signing a courier contract. For prepaid accounts the dedicated service is C2C courier inpost_courier_c2c.

If you provide an incorrect service for the delivery method (i.e. serviceinpost_locker_standard for method Allegro Parcelockers 24/7), SMART service will not be available. https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153513

To create an Allegro SMART parcel on the sandbox, get the data needed to generate the package from the Allegro sandbox environment.

In a sandbox environment, the tracking component is disabled, so there is no way to check the status of a shipment.

Tracking

This is not possible, the API allows you to check the status for a single shipment.

Yes, the API allows you to track the status of packages 45 days back.

Statuses

How to get the status list is described in the documentation: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153478

Yes, the API allows you to get statuses with their descriptions in English. You should add the parameter: en_GB in the requisition.

 

 

 

Contact

If you have any additional questions, please contact us using the form https://inpost.pl/en/form-support