Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Na tej stronie

Table of Contents

General

Expand
titleHow can I access the ShipX API production environment?

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

Expand
titleDoes the ShipX API have a test environment?

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

Expand
titleHow do I generate access to the sandbox environment?

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.

Expand
titleDo you have api requests that I can use?

yes, json queries can be downloaded from the link: [1.3.0] API General Information

Expand
titleAPI response "401 invalid authorization" message what should I do?

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/

Expand
titleAPI response the message "500 server error" what should I do?

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

Expand
titleAPI response"403 access forbidden fo this token'

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

Expand
titleCan I create more than one package with one request?

Yes, there is such a possibility with the batch : [1.6.4] Creating and viewing shipment batches

Expand
titleIs it required to enter sender information when creating a package?

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

Expand
titleIn asnychronic mode, do I have to wait for offers to be prepared and then purchased?

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.

Expand
titleWhen creating a COD shipment, the API reponse the error "Insurance should be equal or higher than COD"

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

Expand
titleWhen creating a COD package, the package does not change its status to confirmed

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.

Expand
titleIs it required to fill the sender's data when creating a package?

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

Expand
titleDo we have to specify dimensions and weight of a parcel?

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

Expand
titleCan we also use templates for courier parcels

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

Code Block
languagejson
"parcels": {
                "dimensions": {
                "length": "10",
                "width": "10",
                "height": "10",
                "unit": "mm"
            },
            "weight": {
                "amount": "10",
                "unit": "kg"
            }
           },

Expand
titleI cannot update the data in the shipment.

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

Expand
titleI cannot cancel the shipment.

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.

Expand
titleCan I create a "Paczka w weekend" in the ShipX API?

Yes, the ShipX API allows you to create a package with a service “Paczka w Weekend”: [1.9.0] Service Weekend shipments

Expand
titleWhen can I create a parcel with the "Paczka w Weekend" service?

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.

Expand
titleI have created a shipment, but cannot download the label
  • 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.

Expand
titleCan I download more than one label with a single request?

Yes, you can download labels for up to 100 shipments: [1.6.0] Multiple shipments label download

Expand
titleCan I provide a foreign phone number?

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

Expand
titleAPI response "debt_collection'

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.

Expand
titleAPI response "trucker_ID_is_not_set_for_organization'

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.

Expand
titleI create an Allegro SMART package, unfortunately it did not create as SMART.

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. [1.14.0] SMART service handling

Expand
titleI cannot create an Allegro SMART package on the sandbox environment.

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

Expand
titleWhy, on a sandbox environment, does tracking return no information?

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

Tracking

Expand
titleIs it possible to search for more than one package with a single request?

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

Expand
titleCan I check the status of a package created last month?

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

Statuses

Expand
titleHow do I get the status list?

How to get the status list is described in the documentation: [1.2.0] Statuses

Expand
titleIs it possible to download the statuses in English?

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