“Barcode” web service
1. Introduction
1.1 Who is this manual written for?
This manual is for business customers of Swiss Post who want to use the “Barcode” web service.
The “Barcode” web service can be used for the following basic services:
- Domestic parcel
- Swiss-Express “Moon”
- SameDay afternoon/evening
- VinoLog
- Direct parcel posting
- Letters with barcode (BMB) domestic:
- Registered (R)
- A Mail Plus
- Dispomail
- Dispomail Easy
- GCourt documents (GU)
- Debt collection documents (BU)
- A and B Mail letters with Electronic cash on delivery (BLN)
- Letters with barcode (BMB) international:
- Registered (R) international
- PRIORITY Plus
1.2 How is this manual structured?
- Section 1 “Introduction”: The first section provides an introduction to the “Barcode” web service
- Section 2 “Service specifications”: This section describes the uses and possible applications of the operations as well as the notification services of the “Barcode” web service (WSBC)
- Section 3 “Registration, homologation, support”: The registration procedure for the “Barcode” web service is described here.
- Section 4 “Technical specifications”: This section describes the services in detail (interface specification), the operations and results
- Section 5 “Appendix: ’Barcode’ web service interface”: Some resources for using the “Barcode” web service are described in this section.
- Section 6 “Further publications and useful links”: This section lists further publications and links
- Section 7 “Customer sheet for homologation of Parcel, Express, VinoLog and Direct delivery consignments”: This section provides the customer sheets for homologation of the address label, which is to be submitted together with the address label.
1.3 Validity
For each new version of the “Barcode” web service, a new version of this manual will be issued and made available to customers in electronic form.
These instructions are valid from September 2023. They replace the version dated April 2021. Changes are possible in the event of extension or adaptation of Swiss Post’s service offering.
We have marked all sections with changes to content with a line at the margin.
1.4 Cost
Post CH Ltd’s “Barcode” web service is provided free of charge.
1.5 Conditions of use
The “Barcode” web service is intended solely for generating labels and for obtaining service, additional service and delivery instruction lists.
1.6 Subscriber Conditions
The Subscriber Conditions for the “Barcode” web service form an integral part of the current service manual. You will receive these at the latest when you register for the “Barcode” web service. Section 6 provides a direct link to the Subscriber Conditions.
1.7 Contact point for technical questions / Customer Service
Technical enquiries
Post CHLtd
Digital customer interfaces
Wankdorfallee 4
3030 Bern
digitalintegration@swisspost.ch
www.swisspost.ch/webservice-barcode
General enquiries
Post CH Ltd
Swiss Post Contact Center
Wankdorfallee 4
3030 Bern
Telefon +41 848 888 888
(CHF 0.08/Min. from landline phones within Switzerland)
1.8 Acronyms and definitions
Term | Definition | Example | English term |
Customer’s address | Address identifying the sender. Need not be the same as the address of the actual sender. The sender’s address can take the form of pure text and/or a logo on the label. | – | – |
Address component | The document can be packed and sent in the window envelope (standard size 100 × 45 mm) without needing to affix a label. In addition, a maximum of one vertical/ horizontal barcode is possible with an additional service suitable for the basic product service. If more than one additional service is selected for a basic product service, a printed label must be used. | See example below | – |
Address label | Address label bearing the required barcode. Label for displaying the information about an item that is relevant for shipping. This may be an adhesive label or a sheet for insertion in a pouch on the item. In the case of letters, the label is usually applied directly to the documents for use with windowed envelopes. At least one selected service is indicated on a label by means of barcodes (so it cannot consist simply of individual service barcodes or delivery instructions). | See example below | label |
BL/BLC | German acronyms for Basisleistung (= basic service) and Basisleistungscode (= basic service code), subset of service code DLC. Actual service provided by Swiss Post, e.g. PostPac Economy | – | basic service / basic service code |
BMB domestic | Letters with barcode (BMB) domestic: Generic term for the basic services Registered (R) domestic, A Mail Plus, Dispomail, Dispomail Easy, Court documents (GU) and Debt collection documents (BU), also A and B Mail letters with the additional service Electronic cash on delivery (BLN) | – | – |
BMB international | Letters with barcode (BMB) international: Generic term for the basic services Registered (R) international (RETR, PRI) and PRIORITY Plus (INTL) | – | – |
COD | Acronym for Cash on delivery | – | cash on delivery |
Label layout Domestic Parcels, Express, VinoLog and Direct parcel posting | Different layouts are available for every label type. For ”parcel” labels there are different label layouts which differ according to size for example (A5, A6 or A7). | See example below | |
Label layout for Letters with barcode (BMB) domestic and international | In the case of the Letters with barcode (BMB) domestic and Letters with barcode (BMB) international service groups, the barcode can be printed on labels (A6 and A7, excl. Debt collection documents [BU] and Court documents [GU]) or generated as an address component for a standard envelope with window (FE) or with the “Generate single barcodes” operation as an individual chart (customer positioning of address label). | See example below | service |
DL | German acronym for Dienstleistung = service. A combination of basic services, additional services and delivery instructions defined by Swiss Post which describes the service to be performed. Depending on the basic service, additional service and delivery instructions chosen, further specific service information must also be indicated (amount in francs in the case of Cash on delivery, date an item was handed in in the case of delivery not before a certain date, etc.). | – | service code |
DLC | German acronym for Dienstleistungscode = service. code Identifies the required postal service combination of basic service code, additional services and delivery instructions | – | – |
Single barcodes | For letters with barcodes (BMB), the different codes per address label can be obtained individually, so that these can be individually placed in your letters and other document correspondence. This is achieved by using the “Generate single barcodes” operation. | – | – |
Free text | For entering information on the space on the label for free text | “Your order of ...” | – |
Franking licence | Alphanumeric identifier (4, 6 or 8 digits) authorizing a customer to use the services of Swiss Post. Internally, this may comprise the 6-digit postcode prefixed by 00. | – | franking licence |
GAS | German acronym for Geschäftsantwortsendung = business reply item; a basic service | – | – |
Cardinality | Indicates the number of times an element may be present (in a call) | “1..n” for the element ATT_PRZL signifies: 1 to n service codes (PRZL) are permitted. | – |
Barcodes for Online Consignment Notes (LSO) | If you want to create the consignment note for data transfer (letters with barcode – BMB) yourself, you can obtain the barcode required for this. To do so, you use the “Generate barcode” operation in order to obtain the barcode required (for the consignment note number). The 18-digit code consists of the postal identification (98.93.000000.) and the final 8-digit item number (20000000-29999999). | – | – |
Logistics services provider | “Post CH Ltd” or the Swiss Post logo is automatically printed onto each address label to identify the logistics service provider. This must not be removed and constitutes an integral part of the address label. | – | – |
“pro clima” logo | All private and business customers will automatically benefit from the new features of “pro clima” shipping as Swiss Post is applying carbon offsetting to all shipments sent within Switzerland and internationally from 1 January 2021. The surcharges resulting from carbon offsetting will be borne entirely by Swiss Post. | See example below | – |
Return note | The optical return note “Return as unregistered” ensures that a Registered Switzerland return shipment is processed in the less expensive returns channel. All return services can be used in combination with the return DmC (www.swisspost.ch/returns). | – | – |
Return data matrix code (DmC) | With the return data matrix code, the various return services can be used. This DmC can be applied to both Registered Switzerland and A Mail Plus. | See example below | – |
Item number for Domestic Parcels, Express, VinoLog and Direct parcel posting | 8-digit consecutive number (the last 8 digits of the identcode) for the unique identification of a shipment. In the case of parcels, must not be repeated within 60 days. The structure of the identcodes depends on the chosen basic service (see identcode type), the precise content in turn depends on many different parameters (service, mailing method, invoice route, etc.). | 99.34.123456.12345678 | item number |
Item number for Letters with barcode (BMB) domestic | 8-digit consecutive number (the last 8 digits of the identcode) for the unique identification of a shipment. In the case of letters (domestic), must not be repeated within 180 days. The structure of the identcodes depends on the chosen basic service (see identcode type). | 98.34.123456.12345678 | item number |
Item number for Letters with barcode (BMB) international | 5-digit consecutive number for the unique identification of a shipment. In the case of letters international, must not be repeated within 180 days. | RyyyyxxxxxpCH< | item number |
Identcode for Domestic Parcels, Express, VinoLog and Direct parcel posting | 18-digit code comprising the mail identifier, the franking licence and the item number. Code for the unique identification of a item. The structure of the identcode depends on the chosen basic service (see identcode type), the precise content in turn depends on many different parameters (service, mailing method, invoice route, etc.). | 99.34.123456.12345678 | identcode |
Identcode for Letters with barcode (BMB) domestic | Code for the unique identification of a letter item. The structure of the identcodes depends on the chosen service (see identcode type). 18-digit code comprising the mail identifier (2 digits), the franking licence (2+6 digits) and the item number (8 digits) or 18-digit code comprising the mail identifier (2 digits), the product code (2 digits), the franking licence (6 digits) and the item number (8 digits) | 98.34.123456.12345678 98.04.123456.12345678 | identcode |
Identcode for Letters with barcode (BMB) international | 13-digit code with user information | RyyyyxxxxxpCH | identcode |
Barcode | Represents the actual barcode and is used for identification and electronic delivery tracking | See example below | barcode |
Identcode type for Domestic Parcels, Express, VinoLog and Direct parcel posting | Set of identcodes having the same logical structure Identcode type Parcel (used for the Domestic Parcels, Express and Solutions service groups) | 99.34.123456.12345678 | – |
Identcode type for Letters with barcode (BMB) domestic | Comprising identcodes with the same logical structure as a type. Identcode type Letters with barcode (BMB) domestic (used for the Domestic Letters service group) | 98.34.123456.12345678 | – |
Identcode type for Letters with barcode (BMB) international | R = identifiery = franking licence (alphanumeric)x = item numberp = check digit CH = ISO code for Switzerland | PRI, RETR: RyyyyxxxxxpCH INTL: RyyyyyxxxxpCH | – |
PRZL | Stands for Produktzusatzlabel = product label, which is identical to the additional service barcode ➞ see definition) | – | – |
Type (data type) | Defines the value range of an element Binary = Data stream (Base64) with Base64 encoding Boolean = Logical values TRUE or FALSE Date = Date specification | CUS_Logo = binary logo of customer ATT_ProClima = TRUE (print “pro clima” logo) ATT_DeliveryDate = 2009-11-19 (delivery date for ZAW3217 | – |
Type (data type) | Enumeration = Enumeration type e.g.: de, fr, it, en Integer = Numeric integers String = Alphanumeric strings | Language = de (language used to call the service) CUS_ZIP = 3030 (postcode) LabelLayout = A6 (layout of address label) | – |
ZL | German acronym for Zusatzleistung = additional service, subset of service code (DLC) Optional additional services that Swiss Post performs in connection with the mailing item – e.g. Electronic cash on delivery. The additional service is always an extension to the basic service. Only certain combinations of basic services and additional services are possible. Several additional services can be combined with a basic service, but not all additional services can be combined with each other | Electronic cash on delivery Signature Fragile etc. | additional service |
ZAW | German acronym for Zustellungsanweisung = delivery instruction, subset of service code (DLC) The code indicates how the item is to be delivered to the recipient – e.g. Notify delivery by telephone. Delivery instructions are only possible in conjunction with a basic service. | Direct delivery to an upper floor; Specific delivery date, deliver on ... | delivery instructions |
Delivery instruction barcode | Barcode identifying a delivery instruction. The text describing the delivery instruction is also required for this barcode. Delivery instructions are only possible in conjunction with a basic service. > | See example below | – |
Examples
2. Service specifications
The most important functions of the “Barcode” web service at a glance:
- Generation of barcodes for which the user is authorized
- As a label without the recipient’s address
- As a complete shipping label incl. sender’s address (text or logo) and delivery address
- As an address component for a standard envelope with window 100 × 45 mm
- Generation of single barcodes (without address label) for Letters with barcode (BMB) domestic
- Validate access to web service
- Obtain all offered service groups, basic services, additional services and delivery instructions as a list
- Validate the combinations of selected services
- Forward all relevant consignment and delivery data to DataTransfer (with the exception of Letters with barcode [BMB] domestic and international)
Other benefits
Your benefits:
- Pull barcodes directly from your system ➞ you stay in your familiar user environment
- No separate programming of barcodes required ➞ no need to acquire specialist postal knowledge
- Round-the-clock access to latest postal services ➞ no worries about maintaining your barcode database
- High availability, high performance ➞ also suitable for high mailing volumes
- Simplify your dispatch process ➞ save money thanks to optimization of parcel and letter handling process
- Web service is free ➞ only investment is for linking up the “Barcode” web service to your system
- No shipping labels required if integrated in delivery note or as address component for envelope with window ➞ cost savings on labels1)
- Order data can be directly linked to dispatch data ➞ all the information from the order no. through to the consignment no. at your fingertips1)
- Fast consignment tracking, preferably combined with “Track consignments” web service ➞ check the current processing status at any time1)
The “Barcode” web service provides address labels with Swiss Post barcodes in a machine-readable format (XML). You can choose between
- a label with the recipient’s and the customer’s address (or logo)
- a label with only the recipient’s address
- a label without the sender’s and recipient’s address, i.e. only the actual service barcodes and additional service barcodes
- single barcodes for basic and additional services in respect of Letters with barcode (BMB) domestic (for positioning barcodes yourself in documents or on address labels)
1) Not part of “Barcode” web service, must be programmed separately in your system if required
Please note that a separate data transfer link is required for Letters with barcode (BMB). This is because the delivery note for the posting can only be created once the physical mailing (daily closing) has been prepared. Information on this can be found at www.swisspost.ch/post-datatransfer-cug. You also have the option of purchasing barcodes for stock.
2.1 Short description of operations
You can link the consignment information with order data in your system. The “Barcode” web service allows you to purchase all basic services described in section 4.5, additional services and delivery instructions as a product list. The “Barcode” web service will always offer you the most up-to-date basic services and the associated additional services and delivery instructions. This service is described under the read operations in sections 5.6 to 5.10.
We also offer a service which validates the combinations of basic services with the additional services and delivery instructions. This ”Validate Combination” service is described in section 5.2
In the case of the Domestic Parcels, Express and Solutions service groups you have the option of printing the address label as a shipping label and affixing it to the item, or incorporating the label in your delivery note for use as a label in a document pouch.
The address labels are available in various layouts, printer resolutions (dpi) and image formats/printer languages. These are described in sections 4.5 to 4.8.
2.1.1 Operation “Validate combination”
With the “Validate combination” operation, you have the option of testing the validity of the combination before running the “Generate address label” operation. This in turn enables you to test basic services in combination with additional services or delivery instructions or to test the compatibility of additional services and delivery instructions.
Together with the read operations, you can therefore show dynamically to users the basic and additional services/delivery instructions functions applicable to them only, which they can perform based on their frequently selected options.
2.1.2 Operation “Generate address label”
The “Generate address label” function is the primary function of the “Barcode” web service. By way of support, you can download web service XSD schema and sample files with technical details on the “Barcode” web service website: www.swisspost.ch/post-barcode-cug.
With the “Generate address label” request, the combinations of selected basic and additional services/delivery instructions will be tested automatically, whether or not you have already done this yourself beforehand. With the “Generate address label” operation, the mailing data (e.g. COD amount) is also validated.
For the “Parcels”, “Express” and “Solutions” service groups, the mailing data is automatically transferred to DataTransfer. This means that you receive the same benefits as you would under DataTransfer.
2.1.3 Operation “Generate single barcodes”
Operation “Generate single barcodes” only applies to letters with barcodes. In the request, all selected basic and additional services are defined; as response you receive all barcodes individually as graphics, which you can then position in your address label yourself using the design and placement instructions
2.1.4 Operation “Generate barcodes”
Letter customers who create the delivery note online (LSO) themselves can use this operation to obtain the barcode required for the delivery note number.
2.1.5 Operation “Read basic services of a franking licence”
With this operation, you can request all basic services included in a franking licence number. This can be very helpful when using different franking licence numbers and service groups (e.g. Parcels domestic, Letter with barcode [BMB] international, etc.) in ensuring that the correct franking licence number is used.
2.1.6 Operation “Read service groups”
The “Read service groups” operation allows you to query all valid service groups offered by the “Barcode” web service (e.g. Parcel, Express, Letters with barcode domestic). The results form the basis of other read operation queries. This allows you to convert the dynamic views of available services options.
2.1.7 Operation “Read basic services”
The “Read service groups” operation allows you to query all valid basic services offered by the “Barcode” web service (e.g. PostPac Priority, Swiss-Express “Moon”, Registered [R] domestic) with an available service group. The results form the basis of other read operation queries. This allows you to convert the dynamic views of available services options.
2.1.8 Operation “Read additional services”
The “Read additional services” operation allows you to query all valid additional services offered by the “Barcode” web service (e.g. Signature, electronic COD, Fragile) with an available basic service. The results form the basis of other read operation queries. This allows you to convert the dynamic views of available services options.
2.1.9 Operation “Read delivery instructions”
The “Read delivery instructions” operation allows you to query all valid delivery instructions offered by the “Barcode” web service (e.g. ZAW3211) with an available basic service.
2.1.10 Operation “Read presentation types”
The “Read presentation types” allows you to query all valid presentation types offered by the “Barcode” web service (e.g. A6, window). What basic services and how many additional services or delivery instructions can be selected, depending on the size, are defined for each presentation type.
2.2 E-mail notification service for Parcels, Express and Solutions
You can arrange for your recipient customer to receive updates via e-mail on the tracking status of a mail item, or specify that you receive delivery confirmation of each mail item, thus ensuring you are immediately informed that the item has been delivered. The notification service is available for mail items in the Parcels, Express (without SameDay afternoon/evening and SameDay afternoon/evening bulky goods) and Solutions service groups (no “delivery information” with VinoLog). The above gives you five different services to choose from. Technical information on notification services is described in section 5.3.1.2. Please contact your Swisspost customer advisor for the wording of e-mail messages and the instructions on free text.
“Order confirmation” notification
With this service, you inform your recipient that you have handed over the mail item to Post CH Ltd. With this notification service, Post CH Ltd gives no guarantee that it has actually accepted the item (i.e. Post CH Ltd cannot confirm at the time of sending the message whether the item has been accepted).
The notification message is sent as soon the data transfer has been concluded. You can add personal free text for your messages.
“Delivery information” message
With this service, the recipient is advised of an upcoming delivery. The message is triggered by sorting information from the sorting centre. Based on this data, the delivery date can be estimated and the recipient advised accordingly. You can choose between standard text or personal free text for your message.
“Collection information” message
This service is designed for those recipients who collect their mail items from a Post Office (P.O. Box or poste restante). This notification dispels uncertainty as to whether the item is ready for collection or not. The message is triggered by delivery of the item to the relevant post office
“Reminder to recipient” message
This service entails the recipient receiving a message that the parcel has not yet been collected. This reminder message is triggered when initial delivery of the item to the recipient was not possible and is sent as a collection advice notifying the customer that an item has not been collected within three days of arrival at the respective post office. This service is provided when you enter the data, but is only triggered if the above situation occurs.
“Handover status to sender” message
As soon as the item has been delivered or a delivery attempt has been made, you or the e-mail recipient specified in the data file will receive an e-mail. This means that you are proactively informed as soon as a delivery or attempted delivery has been made. In the event of an attempted delivery, you will receive a second message as soon as delivery occurs within the following ten days.
“Exchange/return” delivery notification (delivery notification ZAW3233)
With the “Exchange/return” delivery notification, we are able to offer a simple, standardised service for the exchange or return of goods sent to your customers. This involves your customer receiving advanced notice via a standard Swiss Post e-mail message regarding this exchange or return. This process enables your customers to receive good quality.
For more information on the “Exchange/return” delivery notification, please contact your Customer Advisor.
“Saturday delivery” notification
You can use the additional service “SA” (Saturday delivery) to inform the recipient by e-mail about the scheduled delivery on the next Saturday. The standard notification (free text is not supported) is triggered after data transmission.
2.2.1 Overview of notification services
Notification services are currently available for the following DLG Parcel, Express and Solutions services.
Basic services1) | Proof of posting (Service code 1) | Delivery information (Service code 2) | Collection information (Service code 4) | Reminder to recipient (Service code 32) | Handover status to sender (Service code 64) | Exchange/ return (Service code 128) | Saturday delivery (Service code 256) |
PostPac Economy | x | x | x | x | x | – | – |
SmallPac Economy | x | x | x | x | x | – | – |
Bulky goods Economy | x | x | x | x | x | – | – |
PostPac Priority | x | x | x | x | x | x | x |
SmallPac Priority | x | x | x | x | x | x | x |
Bulky goods Priority | x | x | x | x | x | x | x |
PostPac Promo | x | x | x | x | x | – | – |
Swiss-Express “Moon” | x | x | x | x | x | x | – |
Bulky goods “Moon” | x | x | x | x | x | x | – |
SameDay afternoon/ evening | x | – | – | x | x | x | – |
SameDay afternoon/ evening bulky goods | x | – | – | x | x | x | – |
VinoLog | x | x | x | x | x | x | x |
VinoLog Priority | x | x | x | x | x | x | x |
Direct parcel posting | x | – | – | x | x | x | – |
Free text supported | x | x | – | x | – | – | – |
1) Notification services cannot be used for basic services with business reply labels
3. Registration and support
3.1 Registration
Registration for and activation of the “Barcode” web service (WSBC) is carried out in the following steps:
3.1.1 Registration and activation of “Barcode” web service
To register for the “Barcode” web service, please contact your customer advisor.
Once the “Barcode” web service has been activated, you will receive an e-mail from Digital Integration with the access data for calling up the WSBC (technical user name, password, franking licence numbers) and links for downloading useful files.
3.1.2 Access data
The “Barcode” web service is protected from unauthorized access by a special account (known as a “technical user”) with a user name and password. You can also control specific access rights for the web service from this account.
Digital Integration will manage the access data and communicate it to you. If you require a new password or an additional technical user name, please contact Digital Integration.
3.1.3 Optional homologation
Post CH Ltd offers customers the option of a homologation for shipping labels. If you would like a homologation, please follow the steps described below.
The optional homologation process is as follows:
- Create five sample addresses with integrated barcode on the original label
- Send the sample addresses directly to one of the addresses below. For homologation of Parcel, Express items or Solutions (Direct parcel posting, VinoLog), you also send the completed customer sheet, as detailed in section 7, Appendix 1
- The Centre of Excellence for Packaging and Address Quality or your contact person letter barcodes will check the design
- If any of the requirements are not met, Swiss Post will contact you to discuss the corrections that need to be made and the next steps to take
- Once the labels have been approved, the Parcel Quality CoE will also notify “Barcode” Digital Integration staff directly, who will then activate the “Barcode” web service for generating production labels
- Support staff will also notify you by e mail when the “Barcode” web service has been activated for you. You can then use the “Barcode” web service in its entirety
The following is recommended to help you achieve the quality required for homologation quickly:
- The size of the address label conforms to the dimensions specified
- Good print contrast
- Good quality paper is used for mail items, in order to obtain a clean, well-defined print-out
- The printer is set to Normal mode (i.e. not Economy mode with “low toner”)
If the print quality of the address labels is unsatisfactory, Post CH Ltd will have the right to deactivate the “Barcode” web service. However, the customer will always be notified of the inadequate quality first. Labels may only be printed with the defined printer resolutions and print formats.
3.1.4 Integration of the consignment barcode in dispatch documents
When integrating the address label into a dispatch document (e.g. delivery note), please note the following, which applies to the Parcels, Express and Solutions service groups:
Size of address label
The dimensions of the graphics supplied by “Barcode” web services must not be changed:
A5: 148 mm × 210 mm
A6: 105 mm × 148 mm
A7: 74 mm × 105 mm
The size of the consignment barcode must keep within the following measurements:
Length: 68,0 to bis 69,0 mm
Height: 22,8 to bis 23,2 mm
White space
Between the mailing barcode and the left edge of the document, a white space of at least 8 mm must be observed. There must be at least 10 mm of white space all around the recipient address.
Position of the sender
If you insert the sender’s details yourself, ensure that they are positioned on the left hand side of the mailing barcode within the document. In addition, the sender’s details should not appear lower than the last line of the recipient’s address, where the sender’s details are not vertically aligned. (This applies only to “Parcels”, “Express” and “Solutions”.)
Centre of excellence for Domestic Parcels, Express and Solutions
German | French or Italien |
Post CH AG Logistik-Services Kompetenzzentrum Verpackungs- und Adressqualität Postfach 4620 Härkingen | Poste CH SA Services logistiques CC Qualité de l’emballage et de l’adressage Z.I. Les Graveys Case postale 1310 Daillens |
Contact for Letters with barcode (BMB) domestic and international barcodes
Post CH Ltd OK for Printing 2nd Level Lischmatt 40 4621 Härkingen Switzerland |
3.1.5 Support
If you have any questions about the “Barcode” web service, please contact your Swiss Post customer advisor or, for technical support, contact Digital Integration.
Post CH Ltd Digital customer interfaces Wankdorfallee 4 3030 Berne |
3.1.6 Termination
If you no longer wish to use the “Barcode” web service, please send an e-mail to Digital Integration providing the reason for your cancellation, the time of deactivation and the relevant franking licence numbers: digitalintegration@post.ch.
4. Technical specifications
4.1 Description of the service
A description of the “Barcode” web service can be found in the WSDL file: www.swisspost.ch/post-barcode-cug.htm
You can perform tests with the XSD schema: www.swisspost.ch/post-barcode-cug.htm
You will require a technical user to call the “Barcode” web service (see section 3.1.2). The user name and password must be communicated with “Basic Authentication” when you call the web service.
To help you with your programming, you can also obtain instructions on access with PHP with examples as PHP sources and a Client API user manual with library for Java and C#/.Net from: www.swisspost.ch/post-barcode-cug.
Sample requests in XML for the various operations can be found at www.swisspost.ch/post-barcode-cug.
4.2 Endpoint address for “Barcode” web service
Swiss Post environment for producing labels:
Endpoint: https://wsbc.post.ch/wsbc/barcode/v2_4
Username: will be sent to you by Digital Integration
Password: will be sent to you by Digital Integration
4.3 Scheduled interruptions /availability
Installation work or other scheduled interruptions to the “Barcode” web service will be carried out at off-peak times wherever possible. Customers will be advised in good time via e-mail of scheduled downtimes and interruptions to the service.
4.4 Interruptions to “Barcode” web service
Swiss Post sets the highest internal standards for high performance and stable, trouble-free operation of the “Barcode” web service. However, in exceptional circumstances technical problems or failures may result in an interruption to the “Barcode” web service. In order to deal with such situations, we recommend you have the ability to fall back on an alternative process using Swiss Post’s conventional barcode labels
4.5 Services offered
Labels are available for the following service groups:
- Domestic Parcels (PostPac Priority, PostPac Economy, bulky goods Priority, bulky goods Economy, PostPac Promo, PostPac Economy GAS, PostPac Priority GAS, bulky goods Economy GAS, bulky goods Priority GAS)
- Express (Swiss-Express “Moon”, bulky goods “Moon”, Swiss Express “Moon” GAS, SameDay afternoon/evening , SameDay afternoon/evening bulky goods, SameDay afternoon/evening GAS
- Solutions (VinoLog, Direct parcel posting)
- Letters with barcode (BMB) domestic with the following basic services:
- Registered (R) domestic, A Mail Plus, Dispomail, Dispomail Easy, Court documents (GU) and Debt collection documents (BU) (all including the relevant additional services)
- A and B Mail letters with Electronic cash on delivery (BLN) additional service
- Letters with barcode (BMB) international with the following products:
- Registered (R) international
4.6 Label formats
- Format A7 (74 × 105 mm)
- Format A6 (105 × 148 mm)
- Format A5 (148 × 210 mm): only available for Domestic Parcels, Express and Solutions
- Format FE (window envelope): only available for Letters with barcode (BMB) domestic and international
4.6.1 Contents for individual label formats
Attribute | Format “Fenster” (FE) | Format A7 | Format A6 | Format A5 |
Service group Domestic Parcels | No | Yes | Yes | Yes |
Service group Express | No | Yes | Yes | Yes |
Service group Solutions: | – | – | – | – |
– VinoLog | No | No | Yes | Yes |
– Direct parcel posting | No | Yes | Yes | Yes |
Service group Letters with barcode (BMB) domestic: | – | – | – | – |
– Registered (R) | Yes | Yes | Yes | Yes |
– A Mail Plus | Yes | Yes | Yes | No |
– Dispomail | Yes | Yes | Yes | No |
– Dispomail Easy | Yes | Yes | Yes | No |
– Court documents (GU)1) | Yes | No | No | No |
– Debt collection documents (BU)1) | Yes | No | No | No |
– A Mail (only possible with additional service) | Yes | Yes | Yes | No |
– B Mail individual items (only possible with additional service) | Yes | Yes | Yes | No |
Service group Letters with barcode (BMB) international (RETR, PRI only) | Yes | Yes | Yes | No |
Sender’s address2) | No | Yes, 25 characters per line | Yes, 25 characters per line | Yes, 25 characters per line |
or sender’s logo | No | Yes, as given in section 4.10 | Yes, as given in section 4.10 | Yes, as given in section 4.10 |
Recipient’s address (see also chapter 4.6.2) | Yes | Yes | Yes | Yes |
Free text (see also chapter 4.6.2) | No | Yes | Yes, Except for international items | Yes |
Home post office | No | No | Yes | Yes |
“pro clima”3) | Yes | Yes | Yes | Yes |
Additional services4) | max. 1 PRZL | Yes, max. 1 PRZL | Yes, max. 3 PRZL | Yes, max. 5 PRZL |
Delivery instructions5) | No | No | Yes, max. 2 ZAW | Yes, max. 4 ZAW |
Single bar codes for Letters with barcode (BMB)6) | no criteria | no criteria | no criteria | no criteria |
Return note (R Switzerland only) | Yes | Yes | Yes | No |
Return data matrix code (R Switzerland, A Mail Plus) | Yes | Yes | Yes | No |
1) For legal reasons NO address labels can be generated in formats A6 and A7 for the basic services Court documents (GU) and Debt collection documents (BU).
2) When using two delivery instructions per address label (affects DLG Parcels, Express and Solutions) or with VinoLog, there may be an overlap of the last sender character by the consignment number or the VinoLog bar.
3) For Letters with barcode (BMB) domestic the ProClima logo will be printed automatically (at no additional charge).
4) Basic services with additional barcodes must be included in maximum number of PRZL (e.g. for PostPac Priority, Swiss-Express Moon, etc.).
5) Delivery instructions are only available for Domestic Parcels, Express and Solutions
6) When retrieving single barcodes, it is not possible to reduce their size, because the positioning of the single barcodes is the responsibility of the user and must conform to the guidelines stipulated in the manual on “Barcodes and Data Matrix codes for letters mail” (www.post.ch/-/media/portal-opp/pm/dokumente/handbuch-barcodes-und-datatmatrix-codes-fuer-briefsendungen.pdf?la=en&vs=5).
4.6.2 Recipient’s address – maximum number of address lines (concerns the “GenerateLabel” request)
The number of address lines that can be printed on an address label is limited because there is a limited amount of space on the labels. Depending on the selected format, the selected basic service, the number of address fields and, if applicable, the delivery instructions (ZAW) or free text, not all address lines can be printed.
Rules when exceeding the maximum amount of address lines
When the maximum permitted amount of address lines is exceeded, address lines are omitted from the address label in the order below. This only applies to address lines from the “Recipient” address block and – if applicable and permissible – for free text
- Title (Title) is omitted
- Address suffix (AddressSuffix) is omitted
- Name 3 (Name3) is omitted
- Free text (FreeText) is omitted
Please find some examples further down.
Data transmission
The information from the “AddressSuffix” address field element is not transmitted to DataTransfer, regardless of the number of address lines used.
„LabelAddress“ address block
When using the “LabelAddress” address block, you can define yourself which recipient’s address lines are to be printed on the address label and in what order for a minimum of 2 and a maximum of 5 address lines (LabelLine1 to LabelLine5). An exception applies to the fields “ZIP” and “City” (and, for international mailings, also to “Country”), which are taken across from the “Recipient” address block. This means that you must define the procedure to be used yourself if the maximum amount of address lines is exceeded.
Maximum number of address lines per DLG and format | Format ”Fenster“ (FE) | Format A71) | Format A6) | Format A5 |
DLG parcel incl. any free text (up to 1 delivery instruction) | – | 61) | 8 | 8 |
DLG parcel incl. any free text (with 2 delivery instructions) | – | – | 6 | 8 |
DLG Express incl. any free text (up to 1 delivery instruction) | – | 61) | 8 | 8 |
DLG Express incl. any free text (with 2 delivery instructions) | – | – | 6 | 8 |
DLG solutions, VinoLog only incl. any free text (up to 1 delivery instruction) | – | – | 7 | 7 |
DLG solutions, VinoLog only incl. any free text (with 2 delivery instructions | – | – | 5 | 7 |
DLG solutions, without VinoLog incl. any free text (up to 1 delivery instruction) | – | 51) | 5 | 7 |
DLG solutions, without VinoLog incl. any free text (with 2 delivery instructions) | – | – | 5 | 7 |
DLG BMB domestic | 6 | 61) | 8 | – |
DLG BMB international | 6 | 61) | 8 | – |
1) Delivery instructions are not possible for A7 format.
Examples for addressing rules for the “Recipient” address block
The examples below apply only if the “LabelAddress” address block is not used. Missing information in the recipient’s address is completed using the contents of the “Recipient” address block and – if available – the free text.
Example 1: Format A6, max. 1 ZAW, DLG parcels
Details in the “Recipient” block + free text: 8 address lines
- FreeText (1st address line) Title (2nd address line)
- Firstname (3rd address line)
- Name1 (3rd address line)
- Name2 (4th address line)
- Name3 (5th address line)
- AddressSuffix (6th address line)
- Street (7th address line)
- HouseNo (7th address line)
- ZIP (8th address line)
- City (8th address line)
Details on the address label: max. no. of address lines allowed: 8 no adjustment by WSBC required
- FreeText
- Title
- Firstname Name1
- Name2
- Name3
- AddressSuffix
- Street HouseNo
- ZIP City
Example 2: Format A6, 2 ZAWs, DLG parcels
Details in the “Recipient” block + free text: 8 address lines
- Title (1st address line)
- Firstname (2nd address line)
- Name1 (2nd address line)
- Name2 (3rd address line)
- Name3 (4th address line)
- AddressSuffix (5th address line)
- Street (6th address line)
- HouseNo (6th address line)
- ZIP (7th address line)
- City (7th address line)
Details on the address label: max. no. of address lines allowed: 6 automatic adjustment by WSBC
- Firstname Name1
- Name2
- Name3
- AddressSuffix
- Street HouseNo
- ZIP City
Example 3: Format A7, DLG BMB domestic; “Registered (R) domestic”
Details in the “Recipient” block: 7 address lines
- Title (1st address line)
- Firstname (2nd address line)
- Name1 (2nd address line)
- Name2 (3rd address line)
- Name3 (4th address line)
- AddressSuffix (5th address line)
- Street (6th address line)
- HouseNo (6th address line)
- ZIP (7th address line)
- City (7th address line)
Details on the address label:max. no. of address lines allowed: 6 automatic adjustment by WSBC
- Firstname Name1
- Name2
- Name3
- AddressSuffix
- Street HouseNo
- ZIP City
4.6.3 Names of label elements
4.7 Printer resolution (dpi)
200 dpi (equivalent to 203 dpi on Zebra label printers)
300 dpi (equivalent to 305 dpi on Zebra label printers)
600 dpi (equivalent to 610 dpi on Zebra label printers)
4.8 Image formats /printer languages
EPS
GIF
JPG (not recommended as barcode may not have high enough quality)
PNG
sPDF1)
ZPL2
4.9 Layout options for express items
The basic service barcodes for SameDay and Swiss-Express “Moon” services are printed in colour.
If there is no possibility to print the corresponding basic service barcode in colour on the address label, it can be printed in black and white. However, an additional, coloured basic service barcode must then be affixed to the item.
The coloured stickers can be ordered via www.swisspost.ch/ online-services > Order forms & brochures.
4.10 Label generation time and file sizes
The time it takes to generate a label and the corresponding file size depend on the format selected, the printer resolution, the sender’s logo and the image format/printer language used. The speed of the Internet connection is also a key factor. It is therefore very important to have a fast connection.
The table below gives some guideline values (measured with transfer rate of 45,000 kbps, without a sender’s logo). However, these do not take the data rate of your Internet connection into account, which could have a major impact on performance. These are average figures for formats A5, A6, A7 and FE
Image formats/ printer languages | Average figure, only generation time in milliseconds | Average including data transmission in milliseconds |
EPS | ~ 50 | 500–1000 |
GIF | ~ 100 | 500–1000 |
JPG | ~ 300 | 750–1500 |
PNG | ~ 400 | 750–1500 |
~ 50 | 500–1000 | |
sPDF | ~ 15 | 300–750 |
ZPL2 | ~ 5 | 300–750 |
1) Format sPDF is a PDF file without embedded fonts. In order to display this format correctly, the Arial font must be installed on your computer. The generation and transmission times are faster with sPDF than with PDF.
4.11 Sender’s logo
The sender’s address must always be entered in the “Barcode” web service. You can hide the display of the sender details on the address label or display them as a text or image (e.g. company logo).
If using an image/logo, please note the following:
- File size: max. 50 kB
- File forma: GIF, PNG or JPG
You can control how your image/logo is printed on address labels with the following four optional fields:
- Aspect ratio: Using this field, you can decide whether the original ratio of width to height should be maintained or scaled to 47 mm × 25 mm.
- Vertical align: Using this field, you can decide whether the logo should be aligned vertically at the top or in the middle.
- Horizontal align: Using this field, you can decide whether the logo should be aligned horizontally at the left margin or flush with the barcode.
- Rotation: Using this field, you can decide whether the logo should be printed in portrait or landscape orientation on the address label (clockwise rotation options: 0°/90°/180°/270°).
If no settings are changed in these fields, your image/logo will be automatically printed with the following settings:
- scaling to the aspect ratio of 1.88 (image width: 47 mm / image height: 25 mm)
- The logo will be printed rotated anti-clockwise by 90°.
We recommend using a black and white logo for printing in the ZLP2 format.
4.12 Printer models approved for “Barcode” web service
When your system receives them, you can forward the labels generated by the “Barcode” web service directly to a continuous label printer. This is possible with printer language ZPL2. In order for this to work, the printer models used must support ZPL2 as a printer language, otherwise the quality requirements of the labels will not be met.
To ensure adequate barcode print quality, you should always use high-quality shipping label materials.
Note also that shipping labels are printed in either landscape or portrait format, depending on the specifications of the printer models.
5. Appendix: “Barcode” web service interface
5.1 Overview of service codes (DLC)
- Technical errors (e.g. validation errors) are returned as error elements in the response. A response may contain warnings as well as the desired response – e.g. several warnings may be issued when generating multiple address labels. With warnings, the request is executed, but when an error occurs it is rejected.
- Master data and error messages are returned in the language used for the call (German, French, Italian or English)
5.1.1 Overview for service codes (DLC) – Domestic Parcels, Express and Solutions
The service descriptions for the following basic and additional services plus delivery instructions can be found at www.swisspost.ch/post-distribution-national.
Combinations of multiple service codes, e.g. “PRI, SP”, are split into their individual elements. The following is given as an example (sequencing of individual content does not matter):
<PRZL> PRI </PRZL>
<PRZL> SP </PRZL>
DLC | Basic services |
ECO | PostPac Economy |
SMP | SmallPac Economy |
PRI | PostPac Priority |
SMPPRI | SmallPac Priority |
SP, ECO | Bulky goods Economy |
SP, PRI | Bulky good sPriority |
PPR | PostPac Promo |
SEM | Swiss-Express «Moon» |
SEM, SP | Bulky goods «Moon» |
SKB | SameDay afternoon/evening |
SKB, SP | SameDay afternoon/evening Bulky goods |
VL | VinoLog |
VLPRI, PRI | VinoLog Priority |
DIR | Direct parcel posting |
GAS, ECO | PostPac Economy GAS |
GAS, PRI | PostPac Priority GAS |
GAS, SP, ECO | Bulky goods Economy GAS |
GAS, SP, PRI | Bulky goods Priority GAS |
GAS, SEM | Swiss-Express «Moon» GAS |
GAS, SKB | SameDay afternoon/evening GAS |
DLC | Zusatzleistungen |
FRA | Fragile |
MAN | Manual processing |
RMP | Personal delivery |
SI | Signature |
AS | Assurance (insurance) |
COLD | ThermoCare Cold |
BLN | Electronic COD |
LQ | Limited Quantities (hazarouds goods) |
AMB | ThermoCare Ambient |
DLOG | Data logger |
SA | Saturday delivery |
ZFZ0912 | Time slot delivery 9–121) |
ZFZ1114 | Time slot delivery 11–141) |
ZFZ1217 | Time slot delivery 12–171) |
ZF16302100 | Time slot delivery 1630–211) |
ZF16301800 | Time slot delivery 1630–181) |
ZF17301900 | Time slot delivery 1730–191) |
ZF18302000 | Time slot delivery 1830–201) |
ZF19302100 | Time slot delivery 1930–211) |
1) When using the ZFZ (Time slot delivery) value-added service, we recommend you first perform an area check for each recipient address via your connection to the Digital Commerce API – Swiss Post shipping options.
DLC | Delivery instructions |
ZAW3211 | Direct delivery to an upper floor (A) |
ZAW3212 | Do not place in letterbox; deliver manually or notify (B) |
ZAW3213 | Notify delivery by telephone (C) |
ZAW3214 | Place in letterbox or at front door (D) |
ZAW3215 | Deliver contents; take back box (K) |
ZAW3216 | Failed delivery; return item as priority on the same day (E) |
ZAW3217 | Specific delivery date, deliver on ... (F) |
ZAW3218 | Deliver when all items have arrived (G) |
ZAW3219 | Deposit item (H) |
ZAW3220 | Follow delivery information in document pouch (I) |
ZAW3222 | Present item; leave in cellar (L) |
ZAW3232 | You require a contract with Post CH Ltd2) |
ZAW3233 | Exchange/Return3) |
ZAW3234 | Do not deliver to mailbox or neighbour: do not leave anywhere |
2) For the collection of empty containers or materials for recycling – please contact your customer advisor for further information.
3) Only available in conjunction with notification service code 128 (“Exchange/return”).
DLC | Combination code (comprising multiple DLC) |
PRISI | PRI + SI |
PRI0912 | PRI + ZFZ0912 |
PRI1114 | PRI + ZFZ1114 |
PRISI09 | PRI + SI + ZFZ0912 |
PRISI11 | PRI + SI + ZFZ1114 |
DIRSUN9 | DIR + Sun + 09-12 |
VLSI | VinoLog + SI |
VLPRI, PRISI | VinoLog + PRI + SI |
PRI1217 | PRI + ZFZ1217 |
PRISI12 | PRI + SI + ZFZ1217 |
PRI163021 | PRI + ZF16302100 |
PRIS163021 | PRI + SI + ZF16302100 |
PRI163018 | PRI + ZF16301800 |
PRIS163018 | PRI + SI + ZF16301800 |
PRI173019 | PRI + ZF17301900 |
PRIS173019 | PRI + SI + ZF17301900 |
PRI183020 | PRI + ZF18302000 |
PRIS183020 | PRI + SI + ZF18302000 |
PRI193021 | PRI + ZF19302100 |
PRIS193021 | PRI + SI + ZF19302100 |
DIR0912 | DIR + ZFZ0912 |
DIR1114 | DIR + ZFZ1114 |
DIR1217 | DIR + ZFZ1217 |
DIR163021 | DIR + ZF163021 |
DIR163018 | DIR + ZF163018 |
DIR173019 | DIR + ZF173019 |
DIR183020 | DIR + ZF183020 |
DIR193021 | DIR + ZF193021 |
DIRSI | DIR + SI |
DIRSI09 | DIR + SI + ZFZ0912 |
DIRSI11 | DIR + SI + ZFZ1114 |
DIRSI12 | DIR + SI + ZFZ1217 |
DIRS163021 | DIR + SI + ZF163021 |
DIRS163018 | DIR + SI + ZF163018 |
DIRS173019 | DIR + SI + ZF173019 |
DIRS183020 | DIR + SI + ZF183020 |
DIRS193021 | DIR + SI + ZF193021 |
5.1.2 Overview of service codes (DLC) – Letters with barcode (BMB) domestic
The product descriptions for the following basic and additional services can be found at www.swisspost.ch/post-briefe-versand-national.
DLC | Basic services |
RINL | Registered (R) domestic< |
APLUS | A Mail Plus |
DISP | Dispomail |
GU | Court documents (GU) |
BU | Debt collection documents (BU) |
APOST | A Mail |
BPOST | B Mail individual items |
DLC | Additional services |
AR | Acknowledgement of receipt (AR) |
BLN | Electronic cash on delivery (BLN) |
CEC | Item for the blind (CEC) |
RMP | Personal delivery (RMP) |
SEM | Swiss-Express «Moon»1) |
eAR | Electronic return receipt |
MAN | Manual processing |
1) Only available for “legal documents (GU)” basic service.
5.1.3 Overview of service codes (DLC) – Letters with barcode (BMB) international
The product descriptions for the following basic and additional services can be found at www.swisspost.ch/post-versand-international-gk.
DLC | Basic services |
RETR, PRI | Registered (R) international PRIORITY |
INTL | PRIORITY Plus |
DLC | Additional services |
AR | Acknowledgement of receipt (AR) |
CEC | Item for the blind (CEC) |
RMP | Personal delivery (RMP) |
Combinations from several services codes, e.g.“RETR, PRI” will be transmitted individually as content where appropriate. The following is given as an example (sequencing of individual content does not matter):
<PRZL> RETR </PRZL>
<PRZL> PRI </PRZL>
5.2 Validate Combination operation
This operation returns a validation response for a given combination of service codes.
5.2.1 Validate Combination request
You can download an XML example as well as a graphical interface description per request here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
ValidateCombination | 1..1 | – | Root element of Validate Combination operation | – |
Language | 1..1 | Enumeration (de, fr, it, en) | Language used to call the service | en |
Envelope | 1..1 | – | Container for elements | – |
LabelDefinition | 1..1 | – | Container for label-defining elements | – |
LabelLayout | 1..1 | String (2) | Layout of the address label | A5 |
Data | 1..1 | – | Container for elements | – |
Provider | 1..1 | – | Container for elements | – |
Sending | 1..1 | – | Container for elements | – |
Item | 1..n | – | Container for elements per label | – |
ItemID | 0..1 | String (0..50) | ID assigned by customer on the label level, is returned unchanged in the response | – |
Attributes | 0..1 | – | Container for elements | – |
PRZL | 1..n | String (0..5) | Combination of service codes to be validated | PRI, SP |
Country | 0..1 | String (2) | Optional ISO country code. If not CH or LI, the country-specific validation is performed | US |
5.2.2 Validate Combination response
Returns a list of errors and warnings from validation if applicable.
You can download an XML example as well as a graphical interface description per request here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
ValidateCombination Response | 1..1 | – | Root element of Validate Combination Response operation | – |
Envelope | 1..1 | – | Container for elements | – |
LabelDefinition | 1..1 | – | Container for label-defining elements | – |
LabelLayout | 1..1 | String (2) | Layout of the address label | A5 |
Data | 1..1 | – | Container for elements | – |
Provider | 1..1 | – | Container for elements | – |
Sending | 1..1 | – | Container for elements | – |
Item | 1..n | – | Container for elements per label | – |
ItemID | 0..1 | String (0..50) | ID assigned by customer on the label level, copied over from the request | – |
Country | 0..1 | String (2) | Optional ISO country code. If not CH or LI, the country-specific validation is performed | US |
Errors | 0..1 | – | Container for error messages | – |
Error | 1..n | – | Container for error message | – |
Code | 1..1 | String (0..5) | Error code | E0012 |
Message | 1..1 | String (0..500) | Description of the error in the language used for the call | – |
Warnings | 0..1 | – | Container for warnings | – |
Warning | 1..n | – | Container for warning | – |
Code | 1..1 | String (5) | Warning code | W0012 |
Message | 1..1 | String (0..500) | Description of the warning in the language used for the call | – |
5.3 Generate Label operation (Generate Label)
Returns one or more generated labels in binary format.
5.3.1 Generate Label request (Generate Label)
You can download an XML example as well as a graphical interface description per request here: www.swisspost.ch/post-barcode-cug
AlignElement | Cardinality | Type | Description | Example (if appropriate) |
GenerateLabel | 1..1 | GenerateLabel | Root element of Generate address label operation | – |
Language | 1..1 | Enumeration (de, fr, it, en) | Language in which the service is activated | de |
Envelope | 1..1 | GenerateLabel Envelope | Content holder | – |
LabelDefinition | 1..1 | GenerateLabel Definition | Content holder with address label details | – |
LabelLayout | 1..1 | String (2, [a-zA-Z,0-9]{2}) | Address label layout | A5 |
PrintAddresses | 1..1 | Enumeration (None, OnlyRecipient, OnlyCustomer, RecipientAnd Customer) | Details on the printing of sender’s and recipient’s address (delivery note) None – no addresses are printed OnlyRecipient – only the recipient’s address is printed OnlyCustomer – only the customer’s address is printed RecipientAndCustomer – Both the sender’s and the recipient’s addresses are printed | OnlyRecipient |
ImageFileType | 1..1 | String (1..5, [a-zA-Z,0-9]{1,5}) | Address label file format | |
ImageResolution | 1..1 | Integer | Address label resolution in DPI (dots per inch) | 300 |
PrintPreview | 1..1 | Boolean | PrintPreview enabled/disabled (SPECIMEN lettering from the label generated) | true |
FileInfos | 1..1 | Generate FileInfos | Content holder | – |
FrankingLicense2) | 1..1 | String (4..8, [a-zA-Z,0-9]{4} or [0-9]{6} or [0-9]{8}) | Customer franking licence number or postcode | – |
PpFranking4) | 1..1 | Boolean | Indicates whether the PP flag has been set or not | true |
CustomerSystem | 0..1 | String (0..255), [a-zA-Z,0-9,\s] {1,255} | Indicates optional parameters for customer system names | AVG Client |
Customer | 1..1 | Generate Customer | Content holder with customer details. Refers to the sender’s customer | – |
Name1 | 1..1 | String (0..25) | First name and surname, or company name | Meier AG |
Name2 | 0..1 | String (0..25) | Additional name 1 (company suffix or department) | General Agency |
Street | 1..1 | String (0..25) | Address (house number and street) | Viktoriaplatz 10 |
POBox | 0..1 | String (0..25) | P.O. Box | P.O. Box 4021 |
ZIP | 1..1 | Integer (0..6) | Postcode | 8048 |
City | 1..1 | String (0..25) | Place | Zurich |
Country | 0..1 | String (2, [a-zA-Z]{2}) | Country as two-digit ISO-3166-1-alpha-2 code | CH |
Logo | 0..1 | Binary (Base64) | Binary customer logo | – |
LogoFormat | 0..1 | String (3) | Logo format | GIF |
LogoRotation | 0..1 | Enumeration (0, 90, 180, 270) | Clockwise rotation | 270 |
LogoAspectRatio | 0..1 | Enumeration (EXPAND, KEEP) | Aspect ratio (width to height) | EXPAND |
LogoHorizontal Align | 0..1 | Enumeration (WITH_CONTENT, LEFT) | Horizontal alignmen | WITH_ CONTENT |
LogoVertical Align | 0..1 | Enumeration (TOP, MIDDLE) | Vertical alignment | TOP |
DomicilePost Office | 0..1 | String (0..35) | Domicile Post Office | 3097 Liebefeld |
Data | 1..1 | GenerateData | Content holder | – |
Provider | 1..1 | Generate Provider | Content holder | – |
Sending | 1..1 | Generate Sending | Content holder | – |
SendingID | 0..1 | String (0..50) | ID assigned by customer at request level is returned unchanged in the response. If no SendingID is supplied, WSBC generates a random number. | – |
Item | 1..n | GenerateItem | Content holder per address label | – |
ItemID2) | 0..1 | String (0..200) | ID assigned by customers at address label level will be returned unchanged in the response | – |
ItemNumber2) | 0..1 | String (0..8, [0-9] {1,8}) | Mailing number | 12345678 |
IdentCode2) | 0..1 | String (13..23, [0-9]{18} or [0-9]{23} or [a-zA-Z,0-9]{13}) | Mailing code. For use by Swiss Post internal systems only. In systems external to Swiss Post this field is ignored and a warning returned. | 9934123456 12345678 |
Recipient3) | 1..1 | Generate Recipient | Content holder with recipient details | – |
PostIdent | 0..1 | String (0..15) | Postal identification | – |
Title | 0..1 | String (0..35) | Salutation | Ms |
Personally Addressed | 0..1 | Boolean | When set to FALSE, indicates the company first, then the recipient, on the address label Toggles to TRUE Default True. | True |
Firstname | 0..1 | String (0..35) | First name of recipient | Melanie |
Name1 | 1..1 | String (0..35) | Last name and first name (if not in Firstname), or company name | Steiner |
Name2 | 0..1 | String (0..35) | Additional name 1 (company suffix, department or keyword & PickPost / MyPost24 UserID) | Marketing Dept., PickPost 12345678 or MyPost24 12345678 |
Name3 | 0..1 | String (0..35) | Additional name 2 (Attn/FAO; c/o or department [if not in Name2]) | Attn/FAO Hans Meier |
AddressSuffix | 0..1 | String (0..35) | Additional name address | East building |
Street1) | 0..1 | String (0..35) | Street | Viktoriastrasse |
HouseNo | 0..1 | String (0..10) | House number | 21 |
POBox1) | 0..1 | String (0..35) | Name “P.O. box” and – if available – P.O. box number | P.O. Box 4021 |
FloorNo | 0..1 | String (0..5) | Floor number (data transfer only, not printed on address labels) | 3a |
MailboxNo | 0..1 | Integer (0..10) | Letter box number (data transfer only, not printed on address labels) | 10 |
ZIP | 0..1 | String (0..10) | Postcode | 3030 |
City | 1..1 | String (0..35) | Place | Berne 1 |
Country | 0..1 | String (2, [a-zA-Z]{2}) | Country – two-digit ISO 3166-1-alpha-2 code | CH |
Hauskey | 0..1 | Integer (0..13) | House key: authorized for internal Swiss Post systems only | 58096554 |
Phone | 0..1 | String (0..20) | Telephone number (for delivery instruction 3213) | 031 338 11 11 |
Mobile | 0..1 | String (0..20) | Mobile number (for delivery instruction 3213) | 031 338 11 11 |
0..1 | String (0..160) | E-mail address | h.muster@ post.ch | |
LabelAddress | 0..1 | LabelAddress | Used in order to display the address lines in a customized order, or to specifically abbreviate long addresses. The postcode and location are taken across from the “Recipient” address block. | – |
LabelLine | 2..5 | String (0..35) | Contents of the recipient address lines, min. 2 and max. 5 address lines (the postcode and location fields are automatically taken across from the “Recipient” address block; see also section 4.6.1). | – |
Additional INFOS | 0..1 | Generate AdditionalINFOS | Content holder | – |
Additional Data | 0..20 | Generate AdditionalData | Content holder | – |
Type | 1..1 | String (0..35) | General keys for electronic cash on delivery (BLN) COD amount in CHF Additional keys for BLN with ISR ISR reference number | NN_BETRAG NN_ESR_REFNR |
Value | 1..1 | String (0..50) | Value for additional information, must be separated by decimal point (comma not allowed) | 150.50 |
Attributes | 0..1 | Generate Attributes | Content holder | |
PRZL | 1..n | String (1..7, [a-zA-Z,0-9]{1,7}) | Service code (DLC) | ECO, PRI, SP |
FreeText | 0..1 | String (0..34) | Free text for recipient address | Thank you for your order |
DeliveryDate | 0..1 | Date | Delivery date (for delivery instruction 3217) | 2009-08-20 |
ParcelNo | 0..1 | Integer (0..99) | Parcel number of total (for delivery instruction 3218) | 2 |
ParcelTotal | 0..1 | Integer (0..99) | Total number of parcels (for delivery instruction 3218) | 5 |
DeliveryPlace | 0..1 | String (0..35) | Drop point (for delivery instruction 3219) | At front door |
DispatchDate | 0..1 | String (YYYYMMDD) | Delivery date (date on which the consignment is handed over to Swiss Post) | – |
DispatchTime | 0..1 | String (HHMM) | Delivery time (time at which the consignment is handed over to Swiss Post) | – |
ProClima | 0..1 | Boolean | Printing of ProClima logo | – |
ReturnInfo | 0..1 | ReturnInfoType | Content holder for returns information | – |
ReturnNote | 0..1 | Boolean | Return note, printed as text on the address label | – |
Instruction ForReturns | 0..1 | Boolean | Instructions for returns, DmC is printed on the address label | – |
ReturnService | 0..1 | Integer (1) | Return service | 5 |
CustomerID ReturnAddress | 0..1 | Integer (8) | Address ID return address, corresponds to the AMP key | 16078484 |
Dimensions | 0..1 | Dimensions | Content holder for dimensions | – |
Weight | 0..1 | Integer (0..99’999) | Weight in grams (limited to 5 digits) for Parcels, Express and Solutions service groups | 12500 |
UNNumbers | 0..1 | _ | Content holder for UN number for the “LQ” (hazardous goods) additional service | – |
UNNumber | 0..n | Integer (0..9’999) | List of UN numbers (limited to 4 digits) for “LQ” additional service (hazardous goods) | 1234, 1235, 1236 |
Notification | 0..15 | Generate Notification | List of notification services | – |
Type | 1..1 | String (Mail) | Means of communication | |
Service | 1..1 | Integer (0..20) | Service code | 1, 2, 128 |
FreeText1 | 0..1 | String (0..160) | Free text 1 | Test 1 |
FreeText2 | 0..1 | String (0..512) | Free text 2 | Test 2 |
Notification Delivery Instructions | 0..1 | String (0..50) | Codes for ordering the Loginless Link. For use by Swiss Post internal systems only. In systems external to Swiss Post, this field will be ignored and a warning returned. | – |
Language | 1..1 | Language | Language | DE, FR, IT or EN |
Communication | 1..1 | Generate Communication | Content holder for communication medium | |
0..1 | String (0..160) | E-mail address | a@b.ch |
1) Domestic Parcels, Express and Solutions: either address or P.O. box permitted. BMB domestic: state address and P.O. box with number (if applicable). P.O. Box details are compulsory fpr Dispomail and Dispomail Easy. BMB international: no rules. All address components must be split between Address 1 and Address 2.
2) Validation logic for FrankingLicence, ItemID, ItemNumber, IdentCode and Hauskey fields: – FrankingLicence: Mandatory (left-pad with zeros up to 8 digits) – ItemID: Optional, any value – ItemNumber: Optional, any value. If filled in, validation for uniqueness. If ItemNumber is empty, the item number is generated and the identcode is generated from this item number and the franking licence. – IdentCode and Hauskey: Not permitted. If this field is filled, it will be ignored and a warning will also be returned. IdentCode is provided solely for internal calls at Swiss Post.
3) With the basic services with GAS, the recipient is the return address in accordance with the contractual terms for business reply items.
4) The postage paid impression for the Letters with barcode (BMB) domestic and international service groups does not appear automatically in the address and applies to each request.
5) Additional information on BLN (electronic COD) is detailed under section 5.3.1.1.
5.3.1.1 Posting BLN (electronic COD) via “Barcode” web service (for “Parcels” and “Swiss-Express”)
If you already use the “Barcode” web service actively and would later like to programme BLN, we can provide a test environment for you. Please contact Digital Integration for further information.
BLN-defined transaction types for credit notes
The credit note for COD amounts can be applied by means of three different account types:
- PostFinance account from PostFinance
- IBAN from a bank or PostFinance
- QR-IBAN or Swiss Post ISR
With transaction types 1 (PostFinance account) and 2 (IBAN), only the COD amount is required. With transaction type 3 (QR-IBAN/ISR), both the COD amount and the 27-digit QR reference (previously the ISR reference number) are required.
PostFinance account (transaction type 1) or IBAN (transaction type 2)
Element | Cardinality | Type | Description | Example (if appropriate) |
AdditionalINFOS | 0..1 | – | Content holder | – |
AdditionalData | 0..20 | – | Content holder | – |
Type | 1..1 | String (0..35) | Field for COD amount | NN_BETRAG |
Value | 1..1 | String (0..50) | COD amount, must be separated by decimal point (comma not allowed) | 150.50 |
QR-IBAN or Swiss Post ISR (transaction type 3)
Element | Cardinality | Type | Description | Example (if appropriate) |
AdditionalINFOS | 0..1 | – | Content holder | – |
AdditionalData | 0..20 | – | Content holder | – |
Type | 1..1 | String (0..35) | Field for COD amount | NN_BETRAG |
Value | 1..1 | String (0..50) | COD amount, must be separated by decimal point (comma not allowed) | 150.50 |
Type | 1..1 | String (0..35) | Field for the structured reference | NN_ESR_REFNR |
Value | 1..1 | String (0..50) | QR reference (previously ISR reference number) in accordance with modulo 10 | Reference number |
Type | 1..1 | String (0..35) | QR IBAN account number | NN_QR_IBAN |
Type | 1..1 | String (0..35) | QR Reference number | NN_QR_REFNR |
5.3.1.2 Notification services
Notification code
In the “Notification” element, the “Service” field has the following valid values:
Notification | Code |
Proof of posting | 1 |
Delivery information | 2 |
Collection information | 4 |
Reminder to recipient | 32 |
Handover status to sender | 64 |
“Exchange/return” | 1281) |
Saturday delivery | 2562) |
Notification text messages
The description of the content of e-mail messages as well as technical specifications regarding free text are available at www.swisspost.ch/post-e-log-avisierungsservices-details.
1) This notification service can only be used with delivery instruction ZAW3233.
2) This notification service can only be used with the additional service “SA”.
5.3.2 Generate Label response (Generate Label)
You can download an XML example as well as a graphical interface description per response here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
GenerateSingle Barcodes Response | 1..1 | GenerateLabel Response | Root element of Generate address label operation response | – |
Envelope | 1..1 | GenerateSingle BarcodesResponse Envelope | Content holder | – |
LabelDefinition | 1..1 | GenerateLabel ResponseLabel Definition | Content holder with address label details | – |
LabelLayout | 1..1 | String (2, [a-zA-Z,0-9]{2}) | Address label layout | A5 |
PrintAddresses | 1..1 | Enumeration (None, OnlyRecipient, OnlyCustomer, RecipientAnd Customer) | Details on the printing of sender’s and recipient’s address (delivery note) None – no addresses are printed OnlyRecipient – Only the recipient’s address is printed OnlyCustomer – Only the customer’s address is printed RecipientAndCustomer – Both the sender’s and the recipient’s addresses are printed | OnlyRecipient |
ImageFileType | 1..1 | String (1..5, [a-zA-Z,0-9]{1,5}) | Address label file format | |
ImageResolution | 1..1 | Integer | Address label resolution in DPI (dots per inch) | 300 |
PrintPreview | 1..1 | Boolean | Indicates whether the generated address label is used for a text print-out (ItemNo is not looped!) | – |
ColorPrint Required | 1..1 | Boolean | Displays whether generated address label is to be printed in colour or in black and white | – |
Data | 1..1 | GenerateLabel ResponseData | Content holder | – |
Provider | 1..1 | GenerateLabel ResponseProvider | Content holder | – |
Sending | 1..1 | GenerateLabel ResponseSending | Content holder | – |
SendingID | 0..1 | String (0..50) | Optional ID assigned by customer at request level is returned unchanged in the response, if set. Otherwise this element is missing. | Auftrags Ref123 |
Item | 1..n | GenerateLabel ResponseItem | Content holder per address label | – |
ItemID | 0..1 | String (0.. 200) | ID assigned by customer at address label level is taken from request | – |
IdentCode | 0..1 | String (0..50) | Mailing code | 993412345612 345678 |
Label | 0..1 | Binary (Base64) | Generated address labels | – |
Errors | 0..1 | ErrorsType | Content holder for error messages | – |
Error | 1..n | MessageType | Content holder for error message | – |
Code | 1..1 | String (5, [W,E]{1}[0-9]{4}) | Error code | E0012 |
Message | 1..1 | String (0..500) | Description of error in the language in which the operation is activated | – |
Warnings | 0..1 | WarningsType | Content holder for warnings | – |
Warning | 1..n | MessageType | Content holder for warning | – |
Code | 1..1 | String (5, [W,E]{1}[0-9]{4}) | Warning code | W0012 |
Message | 1..1 | String (0..500) | Description of warning in the language in which the operation is activated | – |
5.4 Generate barcodes operation (Generate Barcode) (only relevant for letter products)
For the corresponding request, precisely one barcode will be generated and returned in the correct format for the Barcode online delivery note (LSO 98.93). This enables you to obtain a delivery note number via “Barcode” web service, if you create the online delivery note yourself (only available for service group “Letter with barcode” [BMB])
5.4.1 Generate barcodes request (Generate Barcode)
You can download an XML example as well as a graphical interface description per request here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
Generate Barcode | 1..1 | GenerateBarcode | Root element of “Generate barcode” operation | – |
Language | 1..1 | Enumeration (de, fr, it, en) | Language in which the service is activated | de |
Barcode Definition | 1..1 | BarcodeDefinition | Content holder for the barcode definition | – |
BarcodeType | 1..1 | Enumeration (LSO_1, LSO_2, LSO_3) | Barcode type to be generated | LSO_1 |
ImageFileType | 1..1 | String (1..5, [a-zA-Z,0-9]{1,5}) | Address label file format | |
ImageResolution | 1..1 | Integer | Address label resolution in DPI (dots per inch) | 300 |
5.4.2 Generate barcodes response (Generate Barcode)
You can download an XML example as well as a graphical interface description per response here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
Generate Barcode Response | 1..1 | GenerateBarcode Response | Root element of “Generate barcode” operation response | – |
Barcode ResponseData | 1..1 | BarcodeResponse Data | Content holder for response data | – |
Barcode | 0..1 | Binary (Base64) | Barcode image as binary data | – |
DeliveryNoteRef | 1..1 | String(50) | Online delivery note (LSO) number | – |
Barcode Definition | 1..1 | BarcodeDefinition | Content holder for the barcode definition | – |
BarcodeType | 1..1 | Enumeration (LSO_1, LSO_2, LSO_3) | Barcode type to be generated | LSO_1 |
ImageFileType | 1..1 | String (1..5, [a-zA-Z,0-9]{1,5}) | Address label file format | |
ImageResolution | 1..1 | Integer | Address label resolution in DPI (dots per inch) | 300 |
ColorPrint Required | 1..1 | Boolean | Displays whether generated barcode label to be printed in colour or in black and white | false |
Errors | 0..1 | ErrorsType | Content holder for error messages | – |
Error | 1..n | MessageType | Content holder for an error message | – |
Code | 1..1 | String (5, [W,E]{1}[0-9]{4}) | Error code | E0012 |
Message | 1..1 | String (0..500) | Description of error in the language in which the operation is activated | – |
Warnings | 0..1 | WarningsType | Content holder for warnings | – |
Warning | 1..n | MessageType | Content holder for warning | – |
Code | 1..1 | String (5, [W,E]{1}[0-9]{4}) | Warning code | W0012 |
Message | 1..1 | String (0..500) | Description of warning in the language in which the operation is activated | – |
5.5 Generate single barcodes operation (GenerateSingleBarcodes) (only relevant for letter products)
Returns all single barcodes for one or several address labels generated in binary format
5.5.1 Generate single barcodes request (GenerateSingleBarcodes)
You can download an XML example as well as a graphical interface description per request here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
GenerateSingle Barcodes | 1..1 | GenerateSingle Barcodes | Root element of “Generate single barcodes” operation | – |
Language | 1..1 | Enumeration (de, fr, it, en) | Language in which the service is activated | de |
Envelope | 1..1 | GenerateSingle Barcodes Envelope | Content holder | – |
Barcode Definition | 1..1 | GenerateSingle Barcodes Definition | Content holder with single barcodes details | – |
ImageFileType | 1..1 | String (1..5, [a-zA-Z,0-9]{1,5}) | Address label file format | |
ImageResolution | 1..1 | Integer | Address label resolution in DPI (dots per inch) | 300 |
FileInfos | 1..1 | GenerateFileInfos | Content holder | – |
FrankingLicense | 1..1 | String (4..8, [a-zA-Z,0-9]{4} or [0-9]{6} or [0-9]{8}) | Franking licence number or postcode of in-house customers | – |
PpFranking | 1..1 | Boolean | Indicates whether the PP flag has been set or not | true |
CustomerSystem | 0..1 | String (0..255), [azA-Z,0-9,\s]{1,255} | Indicates optional parameters for customer system names | AVG Client |
Customer | 1..1 | Generate Customer | Content holder with customer details. Refers to the sender’s customer | – |
Name1 | 1..1 | String (0..25) | First name and surname, or company name | Meier AG |
Name2 | 0..1 | String (0..25) | Additional designation – Name | General Agency |
Street | 1..1 | String (0..25) | Address (house number and street) | Viktoriaplatz 10 |
POBox | 0..1 | String (0..25) | P.O. Box | P.O. Box 4021 |
ZIP | 1..1 | Integer (0..6) | Postcode | 8048 |
City | 1..1 | String (0..25) | Place | Zurich |
Country | 0..1 | String (2, [a-zA-Z]{2}) | Country – two-digit ISO 3166-1-alpha-2 code | CH |
DomicilePost Office | 0..1 | String (0..35) | Domicile Post Office | 3097 Liebefeld |
Data | 1..1 | GenerateData | Content holder | – |
Provider | 1..1 | GenerateProvider | Content holder | – |
Sending | 1..1 | GenerateSending | Content holder | – |
SendingID | 0..1 | String (0..50) | ID assigned by customer at request level is returned unchanged in the response. If no SendingID is supplied, WSBC generates a random number | – |
Item | 1..n | GenerateItem | Content holder per address labe | – |
ItemID | 0..1 | String (0.. 200) | ID assigned by customers at address label level will be returned unchanged in the response | – |
ItemNumber ** | 0..1 | String (0..8, [0-9]{1,8}) | Mailing number | 12345678 |
IdentCode | 0..1 | String (0..50) | Mailing code. For use by Swiss Post internal systems only. In systems external to Swiss Post this field is ignored and a warning returned | 9934123456 12345678 |
Recipient | 1..1 | Generate Recipient | Content holder with recipient details | – |
PostIdent | 0..1 | String (0..15) | Postal identification | – |
Title | 0..1 | String (0..35) | Salutation | Ms |
Personally Addressed | 0..1 | Boolean | When set to FALSE, indicates the company first, then the recipient, on the address label Toggles to TRUE. Default True | True |
Name1 | 1..1 | String (0..35) | First name and surname, or company name | Steiner |
Firstname | 0..1 | String (0..35) | First name of recipient | Melanie |
Name2 | 0..1 | String (0..35) | Additional designation – Name | FAO Hans Meier |
Name3 | 0..1 | String (0..35) | Additional name 2 for name | Marketing department |
AddressSuffix | 0..1 | String (0..35) | Additional name address | East building |
Street | 0..1 | String (0..35) | Street | Viktoriastrasse |
HouseNo | 0..1 | String (0..10 | House number | 21 |
POBox | 0..1 | String (0..35) | P.O. Box | P.O. Box 4021 |
FloorNo | 0..1 | String (0..5) | Floor number | 3a |
MailboxNo | 0..1 | Integer (0..10) | Letter box number | 10 |
ZIP | 0..1 | String (0..10) | Postcode | 3030 |
City | 1..1 | String (0..35) | Place | Berne 1 |
Country | 0..1 | String (2, [a-zA-Z]{2}) | Country – two-digit ISO 3166-1-alpha-2 code | CH |
Hauskey | 0..1 | Integer (0..13) | House key: authorized for internal Swiss Post systems only | 58096554 |
Phone | 0..1 | String (0..20) | Telephone number (for delivery instruction 3213) | 031 338 11 11 |
Mobile | 0..1 | String (0..20) | Mobile number (for delivery instruction 3213) | 079 338 11 11 |
0..1 | String (0..160) | E-mail address | h.muster@post.ch | |
LabelAddress | 0..1 | LabelAddress | Used in order to display the address lines in a customized order, or to specifically abbreviate long addresses. The postcode and location are taken across from the “Recipient” address block. | – |
LabelLine | 2..5 | String (0..35) | Contents of the recipient address lines, min. 2 and max. 5 address lines (the postcode and location fields are automatically taken across from the “Recipient” address block; see also section 4.6.1). | – |
Additional INFOS | 0..1 | Generate AdditionalINFOS | Content holder | – |
AdditionalData | 0..20 | Generate AdditionalData | Content holder | – |
Type | 1..1 | String (0..35) | General keys for electronic cash on delivery (BLN) COD amount in CHF Additional keys for BLN with ISR ISR reference numbe | NN_BETRAG NN_ESR_REFNR |
Value | 1..1 | String (0..50) | Value for additional information | 150.50 |
Attributes | 0..1 | Generate Attributes | Content holder | – |
PRZL | 1..n | String (1..7, [a-zA-Z,0-9]{1,7}) | Service code (DLC) | ECO, PRI, SP |
FreeText | 0..1 | String (0..34) | Free text for recipient address | Thank you for your order |
DeliveryDate | 0..1 | Date | Delivery date (for delivery instruction 3217) | 2009-08-20 |
ParcelNo | 0..1 | Integer (0..99) | Parcel number of total (for delivery instruction 3218) | 2 |
ParcelTotal | 0..1 | Integer (0..99) | Total number of parcels (for delivery instruction 3218) | 5 |
DeliveryPlace | 0..1 | String (0..35 | Drop point (for delivery instruction 3219) | At front door |
ProClima | 0..1 | Boolean | Printing of ProClima logo | – |
ReturnInfo | 0..1 | ReturnInfoType | Content holder for returns information | – |
ReturnNote | 0..1 | Boolean | Return note, printed as text on the address label | – |
Instruction ForReturns | 0..1 | Boolean | Instructions for returns, DmC is printed on the address label | – |
ReturnService | 0..1 | Integer (1) | Return service | 5 |
CustomerID ReturnAddress | 0..1 | Integer (8) | Address ID return address, corresponds to the AMP key | 16078484 |
Dimensions | 0..1 | Dimensions | Content holder for dimensions | – |
Weight | 0..1 | Integer (0..99’999) | Weight in grams (limited to 5 digits) for Parcels, Express and Solutions service groups | 12500 |
UNNumbers | 0..1 | – | Content holder for UN number for the “LQ” (hazardous goods) additional service | – |
UNNumber | 0..n | Integer (0..9’999) | List of UN numbers (limited to 4 digits) for “LQ” additional service (hazardous goods) | 1234, 1235, 1236 |
Notification | 0..15 | Generate Notification | List of notification services | – |
Type | 1..1 | String (Mail) | Means of communication | |
Service | 1..1 | Integer (0..20) | Service code | 1, 2, 128 |
FreeText1 | 0..1 | String (0..160) | Free text 1 | Test 1 |
FreeText2 | 0..1 | String (0..512) | Free text 2 | Test 2 |
Language | 1..1 | Language | Language | DE, FR, IT or EN |
Communication | 1..1 | Generate Communication | Content holder for communication medium | |
0..1 | String (0..160) | E-mail address | a@b.ch |
5.6 Read Service Groups operation (ReadServiceGroups)
Returns all service groups.
Input | Term |
ServiceGroup-ID | Service group |
1 | Parcel |
2 | Express |
3 | Solutions |
4 | Letters with barcode domestic |
5 | Letters with barcode international |
5.5.2 Generate single barcodes response (GenerateSingleBarcodes)
You can download an XML example as well as a graphical interface description per response here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
GenerateSingle Barcodes Response | 1..1 | GenerateSingle Barcodes Response | Root element of Generate address label operation response | – |
Envelope | 1..1 | GenerateSingle BarcodesResponse Envelope | Content holder | – |
Barcode Definition | 1..1 | GenerateSingle BarcodesDefinition Response | Content holder with address label details | – |
ImageFileType | 1..1 | String (1..5, [a-zA-Z,0-9]{1,5}) | Address label file format | |
ImageResolution | 1..1 | Integer | Address label resolution in DPI (dots per inch) | 300 |
ColorPrint Required | 1..1 | Boolean | Displays whether generated address label is to be printed in colour or in black and white | – |
Data | 1..1 | GenerateSingle BarcodesResponse Data | Content holder | – |
Provider | 1..1 | GenerateSingle BarcodesResponse Provider | Content holder | – |
Sending | 1..1 | GenerateSingle BarcodesResponse Sending | Content holder | – |
SendingID | 0..1 | String (0..50) | Optional ID assigned by customer at request level is returned unchanged in the response, if set. Otherwise this element is missing. | Auftrags Ref123 |
Item | 1..n | GenerateSingle BarcodesResponse Item | Content holder per address label | – |
ItemID | 0..1 | String (0.. 200) | ID assigned by customer at address label level is taken from request | – |
IdentCode | 0..1 | String (0..50) | Mailing code | 9934123456 12345678 |
Barcodes | 0..1 | GenerateSingle BarcodesResponse Barcodes | Content holder for generated barcodes | – |
Barcode | 1..n | Binary (Base64) | Generated single barcodes | – |
Errors | 0..1 | ErrorsType | Content holder for error messages | – |
Error | 1..n | MessageType | Content holder for an error message | – |
Code | 1..1 | String (5, [W,E]{1}[0-9]{4}) | Error code | E0012 |
Message | 1..1 | String (0..500) | Description of error in the language in which the operation is activated | – |
Warnings | 0..1 | WarningsType | Content holder for warnings | – |
Warning | 1..n | MessageType | Content holder for warning | – |
Code | 1..1 | String (5, [W,E]{1}[0-9]{4}) | Warning code | W0012 |
Message | 1..1 | String (0..500) | Description of warning in the language in which the operation is activated | – |
5.6 Read Service Groups operation (ReadServiceGroups)
Returns all service groups.
Input | Term |
ServiceGroup-ID | Service group |
1 | Parcel |
2 | Express |
3 | Solutions |
4 | Letters with barcode domestic |
5 | Letters with barcode international |
5.6.1 Read Service Groups request (ReadServiceGroups)
You can download an XML example as well as a graphical interface description per request here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
ReadService Groups | 1..1 | – | Root element of Read Basic Services operation | – |
Language | 1..1 | Enumeration (de, fr, it, en) | Language used to call the service | en |
5.6.2 Read Service Groups response (ReadServiceGroups)
You can download an XML example as well as a graphical interface description per response here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
ReadService Groups Response | 1..1 | – | Root element of the Read Service Groups response operation | – |
ServiceGroup | 0..n | – | Container for service groups description | – |
ServiceGroupID | 1..1 | Integer | Numeric identification of service group | 1 |
Description | 1..1 | String (0..255) | Description of basic service | Parcel, letter |
Errors | 0..1 | – | Container for error messages | – |
Error | 1..n | – | Container for error message | – |
Code | 1..1 | String (5) | Error code | E0012 |
Message | 1..1 | String (0..500) | Description of the error in the language used for the call | – |
5.7 Read Basic Services operation (ReadBasicServices)
Returns all the basic services for a specified service group.
Input | Input | Output | Output |
ServiceGroupID | Service group | Resulting basic service | Service code |
1 | Parcel | PostPac Economy | ECO |
1 | Parcel | SmallPac Economy | SMP |
1 | Parcel | PostPac Priority | PRI |
1 | Parcel | SmallPac Priority | SMPPRI |
1 | Parcel | Bulky goods Economy | SP, ECO |
1 | Parcel | Bulky goods Priority | SP, PR |
1 | Parcel | PostPac Promo | PPR |
1 | Parcel | PostPac Economy GAS | GAS, ECO |
1 | Parcel | PostPac Priority GAS | GAS, PRI |
1 | Parcel | Bulky goods Economy GAS | GAS, SP, ECO |
1 | Parcel | Bulky good Priority GAS | GAS, SP, PRI |
2 | Express | Swiss-Express “Moon” | SEM |
2 | Express | Bulky goods “Moon” | SEM, SP |
2 | Express | SameDay afternoon/evening | SKB |
2 | Express | SameDay afternoon/evening bulky goods | SKB, SP |
2 | Express | Swiss-Express “Moon” GAS | GAS, SEM |
2 | Express | SameDay afternoon/evening GAS | GAS, SKB |
3 | Solutions | VinoLog | VL |
3 | Solutions | VinoLog Priority | VLPRI, PRI |
3 | Solutions | Direct parcel posting | DIR |
4 | Letters with barcode domestic | Registered (R) domestic | RINL |
4 | Letters with barcode domestic | A Mail Plus | APLUS |
4 | Letters with barcode domestic | Dispomail | DISP |
4 | Letters with barcode domestic | Court documents (GU) | GU |
4 | Letters with barcode domestic | Debt collection documents (BU) | BU |
4 | Letters with barcode domestic | A Mail | APOST |
4 | Letters with barcode domestic | B Mail individual items | BPOST |
5 | Letters with barcode international | Registered (R) international PRIORITY | RETR, PRI |
5 | Letters with barcode international | PRIORITY Plus | INTL |
5.7.1 Read Basic Services request (ReadBasicServices)
You can download an XML example as well as a graphical interface description per request here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
ReadBasicServices | 1..1 | – | Root element of Read Basic Services operation | – |
Language | 1..1 | Enumeration (de, fr, it, en) | Language used to call the service | en |
ServiceGroupID | 1..1 | Integer | Numeric identifier for service group | 1 |
5.7.2 Read Basic Services response (ReadBasicServices)
You can download an XML example as well as a graphical interface description per response here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
ReadBasic Services Response | 1..1 | – | Root element of the Read Basic Services response operation | – |
BasicService | 0..n | – | Container for description of basic service | – |
PRLZ | 1..n | String (0..5) | Short designation for a service code. Only one service code is output per PRZL element. Basic services comprising multiple service codes are split into several PRZL elements. | PRI |
Description | 1..1 | String (0..255) | Description of basic service | ECO, RINL |
Errors | 0..1 | – | Container for error messages | – |
Error | 1..n | – | Container for error message | – |
Code | 1..1 | String (5) | Error code | E0012 |
Message | 1..1 | String (0..500) | Description of the error in the language used for the call | – |
5.8 Read Additional Services operation (ReadAdditionalServices)
Returns all the additional services for a specified basic service.
Input | Term | Output | Output | Output | Output | Output | Output | Output | Output | Output | Output | Output |
DLC short designation | Basic service | BLN | COLD | RMP | MAN | FRA | AS | SI | LQ | AMB | SA | ZFZ |
ECO | PostPac Economy | ✓ | X | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | X | X | ✓ |
SMP | SmallPac Economy | X | X | X | X | X | X | X | ✓ | X | X | X |
PRI | PostPac Priority | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
SMPPRI | SmallPac Priority | X | X | X | X | X | X | X | ✓ | X | ✓ | X |
SP, ECO | Bulky goods Economy | ✓ | X | ✓ | X | ✓ | ✓ | ✓ | ✓ | X | X | ✓ |
SP, PRI | Bulky goods Priority | (Bulky goods Economy) AND (PostPac Priority) | (Bulky goods Economy) AND (PostPac Priority) | (Bulky goods Economy) AND (PostPac Priority) | (Bulky goods Economy) AND (PostPac Priority) | (Bulky goods Economy) AND (PostPac Priority) | (Bulky goods Economy) AND (PostPac Priority) | (Bulky goods Economy) AND (PostPac Priority) | (Bulky goods Economy) AND (PostPac Priority) | X | ✓ | ✓> |
PPR | PostPac Promo | X | X | X | X | X | X | X | X | X | X | X |
GAS, ECO | PostPac Economy GAS | X | X | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | X | X | X |
GAS, PRI | PostPac Priority GAS | X | X | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | X | X | |
GAS, SP, ECO | Bulky goods Economy GAS | X | X | ✓ | X | ✓ | ✓ | ✓ | ✓ | X | X | X |
GAS, SP, PRI> | Bulky goods Priority GAS | X | X | ✓ | X | ✓ | ✓ | ✓ | ✓ | X | X | X |
SEM | Swiss-Express “Moon” | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | X | X |
SEM, SP< | Bulky goods “Moon” | (Swiss-Express “Moon”) AND (bulky goods Economy) | (Swiss-Express “Moon”) AND (bulky goods Economy) | (Swiss-Express “Moon”) AND (bulky goods Economy) | (Swiss-Express “Moon”) AND (bulky goods Economy) | (Swiss-Express “Moon”) AND (bulky goods Economy) | (Swiss-Express “Moon”) AND (bulky goods Economy) | (Swiss-Express “Moon”) AND (bulky goods Economy) | (Swiss-Express “Moon”) AND (bulky goods Economy) | X | X | X |
SKB | SameDay afternoon/ evening | X | ✓ | ✓ | X | ✓ | ✓ | ✓ | ✓ | ✓ | X | ✓ |
SKB, SP | SameDay afternoon/ evening bulky goods | (SameDay afternoon/evening) AND (Bulky goods Economy) | (SameDay afternoon/evening) AND (Bulky goods Economy) | (SameDay afternoon/evening) AND (Bulky goods Economy) | (SameDay afternoon/evening) AND (Bulky goods Economy) | (SameDay afternoon/evening) AND (Bulky goods Economy) | (SameDay afternoon/evening) AND (Bulky goods Economy) | (SameDay afternoon/evening) AND (Bulky goods Economy) | (SameDay afternoon/evening) AND (Bulky goods Economy) | X | X | ✓ |
GAS, SEM | Swiss-Express “Moon” GAS | X | X | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | X | X | X |
GAS, SKB | SameDay afternoon/ evening GAS | X | X | ✓ | X | ✓ | ✓ | ✓ | ✓ | X | X | X |
VL | VinoLog | ✓ | X | ✓ | X | X | ✓ | ✓ | ✓ | X | ✓ | ✓ |
VLPRI, PRI | VinoLog Priority | ✓ | X | ✓ | X | X | ✓ | ✓ | ✓ | X | ✓ | ✓ |
DIR | Direct parcel posting | X | X | ✓> | X | ✓ | ✓ | ✓ | ✓ | X | X | ✓ |
✓ = permitted, X = not permitted
For Letters with barcode (BMB) domestic
Input | Term | Output | Output | Output | Output | Output |
DLC short designation | Basic service | AR | BLN | CEC | RMP | Without |
RINL | Registered (R) domestic | ✓ | ✓ | ✓ | ✓ | ✓ |
APLUS | A Mail Plus | X | X | ✓ | X | ✓ |
DISP | Dispomail | X | X | ✓ | X | ✓ |
GU | Court documents (GU) | X | X | X | ✓ | ✓ |
BU | Debt collection documents (BU) | X | X | X | ✓ | ✓ |
APOST | A Mail | X | ✓ | X | X | X |
BPOST | B Mail individual items | X | ✓ | X | X | X |
✓ = permitted, X = not permitted
For Letters with barcode (BMB) international
Input | Term | Output | Output | Output | Output |
DLC short designation | Basic service | AR | CEC | RMP | Without |
RETR, PRI | Registered international PRIORITY | ✓ | ✓ | Depends on country and AR | ✓ |
INTL | PRIORITY Plus | X | X | X | ✓ |
✓ = permitted, X = not permitted
5.8.1 Read Additional Services request (ReadAdditionalServices)
You can download an XML example as well as a graphical interface description per request here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
ReadAdditional Services | 1..1 | – | Root element of Read Additional Services operation | – |
Language | 1..1 | Enumeration (de, fr, it, en) | Language used to call the service | en |
PRLZ | 1..n | String (0..5) | Short designation for a service code. Only one service code is output per PRZL. Basic services comprising multiple service codes are split between several PRZL elements. | ECO |
5.8.2 Read Additional Services response (ReadAdditionalServices)
You can download an XML example as well as a graphical interface description per response here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
ReadAdditional Services Response | 1..1 | – | Root element of the Read Additional Services response operation | – |
Additional Service | 0..n | – | Container for additional service | – |
PRLZ | 1..1 | String (0..5) | Short designation of a service code (special additional service) | N |
Description | 1..1 | String (0..255) | Description of the additional service | – |
Errors | 0..1 | – | Container for error messages | – |
Error | 1..n | – | Container for error message | – |
Code | 1..1 | String (5) | Error code | E0012 |
Message | 1..1 | String (0..500) | Description of the error in the language used for the call | – |
5.9 Read Delivery Instructions operation (ReadDeliveryInstructions) for Domestic Parcels, Express and Solutions
Returns all the delivery instructions for a specified basic service. You can order the corresponding document (Barcode for Business Customers – Appendix 1) by e-mailing paketnational.pl43@post.ch.
Input | Term |
DLC short designation | Basic service |
ECO | PostPac Economy |
SMP | SmallPac Economy |
PRI | PostPac Priority |
SMPPRI | SmallPac Priority |
SP, ECO | Bulky goods Economy |
SP, PRI | Bulky goods Priority |
PPR | PostPac Promo |
GAS, ECO | PostPac Economy GAS |
GAS, PRI | PostPac Priority GAS |
GAS, SP, ECO | Bulky goods Economy GAS |
GAS, SP, PRI | Bulky goods Priority GAS |
SEM | Swiss-Express «Moon» |
SEM, SP | Bulky goods «Moon» |
SKB | SameDay afternoon/evening |
SKB, SP | SameDay afternoon/evening Bulky goods |
GAS, SEM | Swiss-Express «Moon» GAS |
GAS, SKB | SameDay afternoon/evening GAS |
VL | VinoLog |
VLPRI, PRI | VinoLog Priority |
DIR | Direct parcel posting |
5.9.1 Read Delivery Instructions request (ReadDeliveryInstructions)
You can download an XML example as well as a graphical interface description per request here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
ReadDelivery Instructions | 1..1 | – | Root element of Read Delivery Instructions operation | – |
Language | 1..1 | Enumeration (de, fr, it, en) | Language used to call the service | en |
PRLZ | 1..n | String (0..5) | Short designation for a service code. Only one service code is output per PRZL. Basic services comprising multiple service codes are split between several PRZL elements. | ECO |
5.9.2 Read Delivery Instructions response (ReadDeliveryInstructions)
You can download an XML example as well as a graphical interface description per response here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
ReadDelivery Instructions Response | 1..1 | – | Root element of the Read Delivery Instructions response operation | – |
Delivery Instructions | 0..n | – | Container for additional service | – |
PRLZ | 1..1 | String (0..5) | Short designation of a service code (special delivery instruction) | ZAW3213 |
Description | 1..1 | String (0..255) | Description of the delivery instruction | – |
Errors | 0..1 | – | Container for error messages | – |
Error | 1..n | – | Container for error message | – |
Code | 1..1 | String (5) | Error code | E0012 |
Message | 1..1 | String (0..500) | Description of the error in the language used for the call | – |
5.10 Read Label Layouts operation (ReadLabelLayouts)
Returns all the label layouts for a specified service group.
5.10.1 Read Label Layouts request (ReadLabelLayouts)
You can download an XML example as well as a graphical interface description per request here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
ReadLabelLayouts | 1..1 | – | Root element of Read Label Layouts operation | – |
Language | 1..1 | Enumeration (de, fr, it, en) | Language used to call the service | de |
PRLZ | 1..n | String (1..7) | Short description of a service code (DLC). Only one service code (DLC) will be returned per product label (PRZL) element. Basic services comprising several service codes (DLC) will be allocated to several product label (PRZL) elements. | ECO |
5.10.2 Read Label Layouts response (ReadLabelLayouts)
You can download an XML example as well as a graphical interface description per response here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
ReadLabel LayoutsResponse | 1..1 | – | Root element of Read Label Layouts Response operation | – |
LabelLayout | 0..n | – | Container for label layout | – |
LabelLayout | 1..1 | String (2) | Layout ID | A5 |
MaxServices | 1..1 | Integer | Maximum number of permitted basic services and additional services per label | 3 |
MaxDelivery Instructions | 1..1 | Integer | Maximum number of delivery instructions permitted per label | 2 |
FreeTextAllowed | 1..1 | Boolean | Indicates whether free text is permitted on label | – |
Errors | 0.1 | – | Container for error messages | – |
Error | 1..n | – | Container for error message | – |
Code | 1..1 | String (5) | Error code | E0012 |
Message | 1..1 | String (0..500) | Description of the error in the language used for the call | – |
5.11 Read basic services of a franking licence operation (ReadAllowedServices ByFrankingLicense)
Returns all for a franking licence applicable to group services with description, PostId, and available basic services.
5.11.1 Read basic services of a franking licence request (ReadAllowedServices ByFrankingLicense)
You can download an XML example as well as a graphical interface description per request here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
ReadAllowed Services By FrankingLicense | 1..1 | ReadAllowed ServicesByFranking License | Root element for the “Read basic services of a franking licence” operation | – |
FrankingLicense | 1..1 | String(4..8, [a-zA-Z,0-9]{4} or [0-9]{6} or [0-9]{8}) | Customer franking licence | 32100196 |
Language | 1..1 | Enumeration (de, fr, it, en) | Language in which the service is activated.; | de |
5.11.2 Read basic services of a franking licence response (ReadAllowedServices ByFrankingLicense)
You can download an XML example as well as a graphical interface description per response here: www.swisspost.ch/post-barcode-cug
Element | Cardinality | Type | Description | Example (if appropriate) |
ReadAllowed Services ByFranking License Response | 1..1 | ReadAllowed ServicesByFranking LicenseResponse | Root element for the “Read basic services of a franking licence” operation | – |
ServiceGroups | 0..n | ReadAllowed ServicesService Groups | Content holder for services (service groups) | – |
ServiceGroup | 1..1 | ServiceGroup | Complex type of a service | 1 |
ServiceGroupID | 1..1 | Integer | Service PostId | 3 |
Description | 1..1 | String(0..255) | Description of the service (in the set language) | – |
BasicService | 0..n | BasicService | Complex type of a basic service | – |
PRZL | 0..n | String(1..7, [a-zA-Z,0-9]{1,7}) | Short description of a service code (DLC) | PRI |
Description | 1..1 | String(0..255) | Description of the basic service (in the set language) | – |
5.12 Error messages
Every error message consists of a four-digit error code prefixed by “E” (E1234), beginning at E1000, plus an associated error text. The web service returns the error texts in the specified language (German, French, Italian or English).
If an error message is returned, the requested service is not executed and is rejected. The error must be corrected and the call repeated.
The curly brackets are placeholders and are replaced by the relevant values in the actual error message.
Error code | Error message (English) |
E1000 | The desired combination of the basic service codes ({0}) is invalid. |
E1001 | The desired additional services ({0}) cannot be combined with the requested basic service ({1}). |
E1002 | The requested additional services ({0}) cannot be combined with each other. |
E1003 | The desired delivery instructions ({0}) cannot be combined with the requested basic service ({1}). |
E1004 | The desired delivery instructions ({0}) cannot be combined with the requested additional services ({1}). |
E1005 | The requested delivery instructions ({0}) cannot be combined with each other. |
E1006 | The stated number of basic and additional service codes ({0}) exceeds the maximum number of presentable service codes for the desired presentation type. Please reduce the number of service codes or choose a larger presentation format. |
E1007 | The stated number of delivery instructions ({0}) exceeds the maximum number of presentable delivery instructions for the desired presentation type. Please reduce the number of delivery instructions or choose a larger presentation format. |
E1008 | The desired service group is invalid. |
E1009 | The desired basic service is invalid. |
E1011 | The stated presentation type ({0}) is invalid. |
E1012 | The stated service code ({0}) is invalid for the desired service group ({1}). |
E1013 | The stated presentation type ({0}) is invalid for the desired service group ({1}). |
E1014 | An additional service with COD amount must be selected (BLN). |
E1015 | No valid basic service codes could be found in the list of service codes ({0}). |
E1016 | The presentation time ({0}) is invalid for the basic service selected ({1}). |
E2001 | A valid recipient address must be stated. |
E2002 | A domicile post office must be provided. |
E2003 | The COD amount must be provided for COD items (BLN). |
E2004 | The ISR reference number for the electronic COD (BLN) is invalid. Please check the format and check digit. |
E2005 | A telephone number must be provided for the delivery instruction “Notify delivery by telephone” (ZAW3213). |
E2006 | A valid delivery date must be stated for the delivery instruction “Specific delivery date: deliver on ...” (ZAW3217). |
E2007 | A “parcel number” and a “parcel total” must be provided for the delivery instruction “Deliver when all items have arrived” (ZAW3218). |
E2008 | A “deposit point” must be provided for the delivery instruction “Deposit consignments” (ZAW3219). |
E2009 | No franking licence was indicated. |
E2010 | This account is not authorized to purchase addresses for the franking licence ({0}). |
E2011 | The consignment number provided is outside the area of validity (1–{0}). |
E2012 | The desired picture format ({1}) is not offered. Please select a valid picture format ({1}). |
E2013 | The desired resolution ({0} dpi) is not offered. Please select a valid picture format ({1}). |
E2014 | VinoLog deliveries are not possible for the desired recipient postcode ({0}). |
E2015 | VinoLog deliveries in combination wtih evening delivery (ZAW3229) are not possible for the desired recipient postcode ({0}). |
E2016 | The consignment number provided is not unique. |
E2017 | A valid sender address must be stated. |
E2018 | The indicated sender logo format ({0}) is not permitted. |
E2019 | The sender logo exceeds the maximum size of {0} KB. |
E2020 | The COD amount is outside the valid range. |
E2024 | The sender logo could not be scanned. Please check that it conforms to a valid picture format ({0}). |
E2025 | A P.O. box address must be specified. |
E2026 | The franking licence used ({0}) is not authorized for the basic service ({1}) of the service group ({2}). |
E2027 | The franking licence used ({0}) is not the correct length. |
E2028 | {0} is not a valid ISO country code. |
E2029 | Additional service {0} is not permitted for mailings to {1} or only in combination with another additional service. |
E2030 | Basic service {0} does not belong to an international service group. |
E2031 | Basic service {0} does not belong to a domestic service group. |
E2032 | For domestic mailings the addressee’s postcode must be specified. |
E2033 | For domestic mailings the addressee’s postcode must consist of digits only. |
E2034 | For domestic mailings the addressee’s postcode must not exceed the maximum length of {0} characters. |
E2035 | This franking licence ({0}) is not a customer franking licence and a valid consignment barcode must therefore be specified. |
E2036 | The weight should be express as a maximum of 5 digits and should not amount to more than {0} grams (e.g.29500). |
E2037 | The weight must be a value great than 0. |
E2038 | The UN number must be exactly 4 digits (e.g. 1234). |
E2039 | The LQ additional service is only available from Version 2.1 onwards. |
E2040 | The notification service {0} cannot be combined with the basic service {1}. |
E2041 | The e-mail address ({0}) must correspond to the following pattern {1}. |
E2042 | The telephone number ({0}) must be between 10 and 20 digits long and must begin with {1}, {2} or {3}. Numbers and spaces are permitted; hyphens (-) or forward slashes (/) or other special characters (|, \, ^, etc.) are not permitted. |
E2043 | For the {0} notification the delivery instruction {1} is required. |
E2044 | For the {0} delivery instruction the notification {1} is required. |
E2045 | The following characters only are permitted in the Item ID: A to Z (and a to z), numbers 0 to 9, underscore “_”, hyphen “-”, plus sign “+”. |
E2047 | The communication type (e-mail) does not match the e-mail address given. |
E2049 | For COD items (BLN), a valid ISR (NN_ESR_KNDNR) must be set. |
E2050 | For COD items (BLN), a valid IBAN number (NN_IBAN) must be set. |
E2051 | For COD items (BLN) with IBAN, a valid name for the end beneficiary (NN_END_NAME_VORNAME) must be set. |
E2052 | For COD items (BLN) with IBAN, a valid additional description for the end beneficiary (NN_END_ZUSATZ_NAME) must be set. |
E2053 | For COD items (BLN) with IBAN, a valid street (NN_END_STRASSE) must be set. |
E2054 | For COD items (BLN) with IBAN, a valid postcode (NN_END_PLZ) must be set. |
E2055 | For COD items (BLN) with IBAN, a valid city (NN_END_ORT) must be set. |
E2056 | For COD items (BLN) with IBAN or ISR account number (NN_ESR_KNDNR), a valid sender contact e-mail address (NN_CUS_EMAIL) must be specified. |
E2057 | For COD items (BLN) with IBAN or ISR account number (NN_ESR_KNDNR), a valid sender contact phone number (NN_CUS_PHONE or NN_CUS_MOBILE) must be specified. |
E2058 | For COD items (BLN), a combination of ISR and IBAN fields is not permitted. |
E2059 | The basic service {0} can only be used in conjunction with the value-added service {1}. |
E2060 | The notification service {0} can only be used together with the value-added service {1}. |
E2061 | The recipient address could not be determined - check for delivery area not possible. |
E2064 | At least two LabelLines are required. LabelLines that are blank or only contain empty spaces are not permitted. |
E2065 | The delivery area check cannot be carried out at the moment. Please contact Support. |
E2066 | The service {0} is not available for this address. |
E9991 | The output format for single barcodes is currently not supported. |
E9992 | No valid web service call! |
E9993 | The Zubofi system is currently not available. Please try again later. |
E9994 | The Kurepo system is currently not available. Please try again later. |
E9995 | The output format ({1}) is currently not supported in resolution ({0} dpi). |
E9996 | Too many addressees were requested. A maximum of {3} addressees per request can be generated with the resolution ({0} dpi), output format ({1}) and addressee format ({2}). |
E9997 | The web service barcode was unable to generate a unique consignment number. If the problem reoccurs, please contact the Support team. |
E9998 | User {0} is not authorized for this service. |
E9999 | The service is not available at the moment. |
5.13 Warnings
Every warning consists of a four-digit warning code prefixed by “W” (W1234), beginning at W1000, plus an associated warning text. The web service returns the warning texts in the specified language (German, French, Italian or English). An operation may return more than one warning at a time.
If a warning is returned, the requested service is executed, taking the warning into account. Warnings help to optimize your use of the “Barcode” web service.
The curly brackets are placeholders and are replaced by the relevant values in the actual warning.
Warning code | Warning (English) |
W2003 | You have indicated a COD amount without requesting the additional service BLN. |
W2005 | You have indicated a telephone number without requesting the delivery instruction “Notify delivery by telephone” (ZAW3213). |
W2006 | You have indicated a delivery date without requesting the delivery instruction “Specific delivery date: delivery on ...” (ZAW3217). |
W2007 | You have indicated a parcel number and/or a parcel total without requesting the delivery instruction “Deliver when all consignments have arrived” (ZAW3218). |
W2008 | You have indicated a deposit point without requesting the delivery instruction “Deposit consignments” (ZAW3219). |
W2009 | A text cannot be generated with the requested presentation type ({0}); the display will be suppressed. To display a text, please select a larger presentation type. |
W2010 | Generation of the addressee will require too much time with the requested presentation type ({0}) and resolution ({1}). |
W2011 | PP franking is ignored for the basic service {0}. |
W2012 | For in-house Swiss Post applications the weight field is optional. The weight field has not been filled in correctly (max. {0} grams, greater than or the same as 0) and has therefore not been returned. |
W2014 | Free text is not required in the notification {0}. Free text 1 and 2 have been ignored. |
W2016 | For the chosen presentation type the recipient is restricted to {0} lines. The title will be ignored. To display the title, please select a larger presentation type. |
W2017 | For the chosen presentation type the recipient is restricted to {0} lines. The AddressSuffix will be ignored. To display the AddressSuffix, please select a larger presentation type. |
W2018 | For an A6 label with 2 ZAWs, the sender’s address is truncated to 20 characters per line in ZPL2 format. |
W2019 | For the chosen presentation type the recipient is restricted to {0} lines. Name3 will be ignored. To display Name3, please select a larger presentation type. |
W2020 | For the chosen presentation type the recipient is restricted to {0} lines. Free text will be ignored. To display the free text, please select a larger presentation type. |
W2021 | For the chosen presentation type, the recipient is restricted to {0} lines. Excessive LabelLines will be ignored. To display all LabelLines, please select a larger presentation type. |
W2022 | The specified weight will not be printed on the label as this information is not relevant to the selected service group. |
W2024 | The NotificationDeliveryInstructions field may only be set by internal Post applications. The field is ignored. |
W2025 | The UrlLink field may only be set by internal Post applications. The field is ignored. |
W2026 | The UrlPic field may only be set by internal Post applications. The field is ignored. |
W9997 | The Consignment code field may be filled in using Swiss Post applications only. |
6. Online services and additional links
Overview of Swiss Post’s online services
www.swisspost.ch/online-services
Publications on the “Barcode” web service
“Barcode” web service website
www.swisspost.ch/post-webservice-barcode
User manual Client API, Library for Java and C#/.Net and instructions for PHP
www.swisspost.ch/post-barcode-cug
Manual, WSDL, XSD and examples for downloading
www.swisspost.ch/post-barcode-cug.htm
“Barcode” web service subscriber conditions
www.swisspost.ch/post-tnb-webservice-barcode.pdf
Publications on the “Track & Trace” web service
“Track & Trace” web service website
www.swisspost.ch/post-e-log-webservice-sendung-verfolgen
Manual, WSDL and examples for the “Track consignment”web service
www.swisspost.ch/post-sendungenverfolgen-cug
Publications on DataTransfer for Letters with barcode BMB
7. Appendix 1: Customer sheet on homologation of Parcel, Express, VinoLog and Direct delivery consignments
8. Release Notes
Updates in version 2.5.4 (September 2023)
- New contact points added. Affected sections: 1.7 / 3.15 / 3.16
- New basic services added: SmallPac Economy, SmallPac Priority, VinoLog Priority. Affected sections 2.2.1 / 5.1.1 / 5.7 / 5.8 / 5.9