The following parameters can be used to open the bpost Shipping Manager iFrame

Please note that all values should be passed as a string.


Name

Required

Hashed

Allowed Values

Description

accountId

Required

Yes

 

Your unique customer ID of bpost P&E

action

Required

Yes

START
CONFIRM

START opens the redirect page
CONFIRM confirms the order

lang

Optional

No

NL
FR
EN
DE
Default: language settings of your browser

Language
NL = Dutch
FR = French
EN = English
DE = German

(capital letters required)

checksum

Required

No

SHA-256 hash

Checksum of fields.
See more information on the calculation of the Checksum 

orderReference

Required

Yes

Max length = 50

Order reference: unique ID used in your web shop to assign to an order. The value of this parameter is not managed by bpost. If the value already exists, it will overwrite current order info.

costCenter

Optional

Yes

Max length = 50

This information is used on your invoice and allows you to attribute different cost centers (e.g. different shops, warehouses, suppliers, …)

orderTotalPrice

Optional

No

Euro cents

Total price of the basket order in Euro cents (excluding shipping costs)

customerFirstName

Optional

No

 

First name of the customer

customerLastName

Optional

No

 

Last name of the customer
The first name and the last name together should not be longer than 40 characters. Only 40 characters are shown on the label

customerCompany

Optional

No

Max length =

Name of the company of the receiver

customerStreet

Optional

No

Max length = 40

Street name of the customer

customerStreetNumber

Optional

No

Max length = 8

Street number of the customer

customerBox

Optional

No

Max length = 8

Box number of the customer

customerCity

Optional

No

Max length = 40

City of the customer

customerPostalCode

Optional

No

Integer

Max length = 32

Postal code of the customer

customerCountry

Required

Yes

Uppercase
2 character country ISO code 

Country of the customer

customerEmail

Optional

No

Max length = 50

E-mail address of the customer

customerPhoneNumber

Optional

No

Max length = 20

Mobile phone number of the customer

orderLine

Optional

No

 

The items that are included in the order. Order lines are shown in the back end of the Shipping Manager and facilitate the use of the tool. Multiple orderLines are available for a single order.

orderWeight

Optional

Yes


Weight of the order in grams

deliveryMethodOverrides

Optional

Yes

 

Overrides of delivery method for specific order

extra

Optional

No

 

Additional parameters related to your web shop. Information not used by bpost and returned in the confirm/error/cancel URL.

extraSecure

Optional

Yes

 

Additional parameters related to your web shop included in the hash. Same as the extra parameters, but hashed.

confirmUrl

Optional

No

 

URL to where the customer is redirected once the iFrame is closed. If empty,the default value is used

cancelUrl

Optional

No

 

URL to where the customer is redirected if the button “back to shopping car” is clicked. If empty, the default value is used

errorUrl

Optional

No

 

URL to where the customer is redirected if an error occurs. If empty, the default value is used

shopHandlingInstruction  Optional  No    Shop handling instruction that will be visible in the Click & Collect app