Home

Barcode web service manual

1. hazarouds goods VL VinoLog SA Saturday delivery ZAW3220 Follow delivery information in document pouch DIRECT Direct AZS Evening delivery ZAW3222 Present item leave in cellar L GAS ECO PostPac Economy GAS ZAW3232 You reguire a contract with Post CH Ltd GAS PRI PostPac Priority GAS ZAW3233 Exchange Return GAS SP Bulky goods Economy GAS ZAW3234 Do not deliver to mailbox or ECO neighbour do not leave anywhere valid from 1 1 2014 GAS SP PRI Bulky goods Priority GAS GAS SEM S vviss Express Moon GAS GAS SKB Swiss Courier Lightning GAS Basic service DIRECT can only be used in conjunction with AZS When using the additional service AZS Evening delivery we recommend to perform an area check for each recipient s address using the Delivery web service beforehand For the collection of empty containers or materials for recycling please contact your customer advisor for further information Only available in conjunction with notification service code 128 Exchange return a 3 Combinations of multiple service codes e g PRI SP are split into their individual elements The following is given as an example seguencing of individual content does not matter lt PRZL gt PRI lt PRZL gt lt PRZL gt SP lt PRZL gt 26 5 1 2 Overview of service codes DLC Letters with barcode BMB domestic The product descriptions for the following basic and addit
2. 3216 3215 3214 3213 3212 3211 PostPac Economy ZA PRI PostPac Priority ZA v ZA X ZA v v ZA v ZA ZA ZA ZA ZA SP ECO Bulky goods Economy v X ZA X ZA v v ZA ZA v v v x v SP PRI Bulky goods Priority v x ZA x ZA v v ZA v ZA ZA ZA x v PPR PostPac Promo X X x X X X X x X X X X X X GAS ECO PostPac Economy GAS X X x X v v v ZA ZA v v ZA ZA v GAS PRI PostPac Priority GAS X X x X v v ZA ZA ZA v v ZA v v GAS SP ECO Bulky goods Economy GAS x x x X v v ZA ZA v x v v x v GAS SP PRI Bulky goods Priority GAS X x x X v v ZA v v X v ZA X v SEM Svviss Express Moon v ZA ZA X v v x X ZA v v v v v SEM SP Bulky goods Moon v ZA ZA X v v x x v v v ZA X v SKB Swiss Courier Lightning v ZA ZA X v v x x ZA ZA ZA ZA ZA v SKB SP Bulky goods Lightning v v ZA X v v x x v v v ZA X v GAS SEM Svviss Express Moon GAS X X x X v v x x v v v v v v GAS SKB Swiss Courier Lightning GAS x X x X v v x x ZA v ZA ZA ZA v VL VinoLog v X X ZA X X ZA v v X X ZA ZA v DIRECT Direct v v v v v v v x v ZA v v X X d permitted X not permitted 5 9 1 Read Delivery Instructions request ReadDeliverylnstructions You can download an XML example as well as a graphical interface description per reguest here www swisspost ch post barcode cug Cardinality Type Description Example if appropriate ReadDeliverylnstructions Root element of Read Delivery Instructions operation Language ES Enumeration Language used to call the service en d
3. Barcode vveb service Manual June 2014 Yellovv in motion Table of contents 1 Introduction 11 Change history 1 2 Who is this manual written for 1 3 How is this manual structured 1 3 1 Section 1 Introduction 1 3 2 Section 2 Service specifications 1 3 3 Section 3 Registration homologation and support 1 3 4 Section 4 Technical specifications 1 3 5 Section 5 Appendix Barcode vveb service interface 1 3 6 Section 6 Further publications and useful links 1 3 7 Section 7 Customer sheet for homologation of Parcel Express and Courier VinoLog and Direct consignments 1 4 Validity 1 5 Cost 1 6 Conditions of use 1 7 Subscriber Conditions 1 8 Acronyms and definitions 2 Service specifications 2A Short description of operations 2 1 1 Operation Validate combination 2 1 2 Operation Generate address label 21 3 Operation Generate single barcodes 21 4 Operation Generate barcodes 2 1 5 Operation Read basic services of a franking licence 2 1 6 Operation Read service groups 2 1 7 Operation Read basic services 2 1 8 Operation Read additional services 21 9 Operation Read delivery instructions 2 1 10 Operation Read presentation types 2 2 SMS and or e mail notification service for parcels Express Courier and Solutions 2 2 1 Overview of notification services 3 Registration homologation and support
4. EN Registration 31 1 Registration and activation of Barcode web service 3 1 2 Access data 31 3 Homologation and activation 31 4 Integration of the consignment barcode in dispatch documents 31 5 Support 3 1 6 Termination NA o O O Un U1 Hi N OD DD ao 14 14 14 15 15 15 15 15 15 15 15 15 17 18 18 18 18 18 19 19 19 4 1 4 2 4 3 4 4 4 5 4 6 4 6 1 4 6 2 4 6 3 4 7 4 8 4 9 4 10 4 11 5 1 5 1 1 5 1 2 51 3 5 2 5 2 1 5 2 2 5 3 5 3 5 3 2 5 4 5 4 1 5 4 2 5 5 5 5 1 2 0 2 5 6 5 6 1 5 6 2 5 7 5 71 5 2 Technical specifications Description of the service Endpoint address for Barcode vveb service Scheduled interruptions availability Interruptions to Barcode web service Services offered Label formats Contents for individual label formats Recipient s address maximum number of address lines concerns the GenerateLabel request Names of label elements Printer resolution dpi Image formats printer languages Label generation time and file sizes Sender s logo Printer models approved for Barcode web service Appendix Barcode web service interface Overview of service codes DLC Overview of service codes DLC Domestic Parcels Swiss Express Swiss Courier and Solutions Overview of service codes DLC Letters with barcode BMB domestic Overview of service codes DLC Letters with barcode BMB international Valida
5. Root element of Generate barcode operation response Content holder for response data Barcode image as binary data Online delivery note LSO number Content holder for the barcode definition Barcode type to be generated Address label file format Address label resolution in DPI dots per inch Displays whether generated barcode label to be printed in colour or in black and white Content holder for error messages Content holder for an error message Error code Description of error in the language in which the operation is activated Content holder for warnings Content holder for warning Warning code Description of warning in the language in which the operation is activated 150 300 false E0012 WOo12 37 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 vvell as a graphical interface description per request here www swisspost ch post barcode cug Element GenerateSingleBarcodes Language Envelope BarcodeDefinition ImageFileType ImageResolution Filelnfos FrankingLicense PpFranking CustomerSystem Customer Name1 Name2 Street POBox ZIP City Country DomicilePostOffice Data Provider 38 Cardinality pel Type GenerateSingle Barcodes Enumeration de fr it en GenerateSingle
6. BMB international PRZL 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 30 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 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 5 digit consecutive number for the unique identification of a shipment In the case of letters international must not be repeated within 180 days 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 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
7. fr it en PRLZ ET String 1 7 Short description of a service code DLC Only one service code ECO DLC vvill be returned per product label PRZL element Basic services comprising several service codes DLC will be allocated to several product label PRZL elements 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 Cardinality Type Description Example if appropriate ReadLabelLayoutsResponse Root element of Read Label Layouts Response operation LabelLayout Dn Container for label layout LabelLayout String 2 Layout ID A5 Maxservices d nteger Maximum number of permitted basic services and additional 3 services per label MaxbDeliverylnstructions Integer Maximum number of delivery instructions permitted per label 2 FreeTextAllowed lec Boolean Indicates whether free text is permitted on label Errors On Container for error messages Error IES Container for error message Code Des String 5 Error code E0012 Message db String 0 500 Description of the error in the language used for the call 49 Returns all for a franking licence applicable to group services with description Postld 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
8. hazardous goods List of notification services Means of communication Service code Free text 1 Free text 2 Language Content holder for communication medium E mail address Mobile NN_BETRAG NN_ESR_REFNR 150 50 ECO PRI SP Thank you for your order 2009 08 20 2 5 At front door 12500 1234 1235 1236 SMS or EMAIL il 2 123 Test 1 Test 2 DE FR IT or EN Email or Mobile a b ch Mobile Cardinality Type Description Example if appropriate GenerateSingle GenerateSingle Root element of Generate address label operation response BarcodesResponse Barcodes Response Envelope 5 GenerateSingle Content holder BarcodesRespon seEnvelope BarcodeDefinition 2 GenerateSingle Content holder with address label details BarcodesDefini tionResponse ImageFileType ES String 1 5 la Address label file format PDF ZA Z 0 9 1 5 ImageResolution 1 Integer Address label resolution in DPI dots per inch 300 ColorPrintRequired E Boolean Displays vvhether generated address label is to be printed in colour or in black and vvhite Data 5 GenerateSingle Content holder BarcodesRespon seData Provider 1 GenerateSingle Content holder BarcodesRespon seProvider Sending 1 GenerateSingle Content holder BarcodesRespon seSending SendinglD omi String 0 50 Optional ID assigned by customer at request level is returned AuftragsRef123 unchanged in the response if set Otherwise this
9. Barcodes Envelope GenerateSingle Barcodes Definition String 1 5 a zA Z 0 9 1 5 Integer GenerateFilelnfos String 4 8 la zA Z 0 9114 or 0 9 6 or 0 9 8 Boolean String 0 255 la 2 7 0 9 5 1 255 Generate Customer String 0 25 String 0 25 String 0 25 String 0 25 Integer 0 6 String 0 25 String 2 a zA Z 2 String 0 35 GenerateData GenerateProvider Description Root element of Generate single barcodes operation Language in which the service is activated Content holder Content holder with single barcodes details Address label file format Address label resolution in DPI dots per inch Content holder Franking licence number or postcode of in house customers Indicates whether the PP flag has been set or not Indicates optional parameters for customer system names Content holder with customer details Refers to the sender s customer First name and surname or company name Additional designation Name Address house number and street P O Box Postcode Place Country two digit ISO 3166 1 alpha 2 code Domicile Post Office Content holder Content holder Example if appropriate de PDF 300 true AVG Client Meier AG General Agency Viktoriaplatz 10 P O Box 4021 8048 Zurich CH 3097 Liebefeld Cardinality Type Description Example if appropriate Sending SendinglD I
10. Solutions VinoLog No No Yes Yes Direct No Yes yes Yes Service group Letters vvith barcode BMB domestic Registered R A Mail Plus Yes Yes Yes No Dispomail Yes Yes Yes No Dispomail Easy Yes Yes Yes No Court documents GU Yes Yes Yes No Debt collection documents BU Yes No No No A Mail Yes No No No only possible with additional Yes Yes Yes No service Yes Yes No B Mail individual items Yes Yes Yes No only possible with additional service Service group Letters with Yes Yes Yes No barcode BMB international Sender5 address No Yes 25 characters per line Yes 25 characters per line Yes 25 characters per line or logo No Yes Dimensions as given Yes Dimensions as given Yes Dimensions as given in section 4 10 in section 4 10 in section 4 10 Recipient s address Yes Yes Yes Yes see also chapter 4 6 2 Free text see also chapter 4 6 2 No Yes Yes Except for international Yes items Home post office No No Yes Yes pro clima Yes Yes Yes Yes Additional services Max 1 Yes max 1 PRZL Yes max 3 PRZL Yes max 5 PRZL PRZL Delivery instructions No No Yes max 2 ZAVV Yes max 4 ZAW Single bar codes for Letters with criteria barcode BMB 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 Courier
11. Z P e Integer 0 6 Postcode 8048 City us String 0 25 Place Zurich Country omi String 2 Country as two digit ISO 3166 1 alpha 2 code CH a zA Z 2 Logo 0 1 Binary Base64 Binary customer logo LogoFormat OF String 3 Logo format GIF DomicilePostOffice omi String 0 35 Domicile Post Office 3097 Liebefeld Data d GenerateData Content holder Provider 1 1 GenerateProvider Content holder Sending da GenerateSending Content holder 30 Cardinality Type Description Example if appropriate SendinglD Item temiD ItemNumber ldentCode Recipient Postldent Title PersonallyAddressed Firstname Name1 Name Name AddressSuffix Street HouseNo POBox FloorNo MailboxNo ZIP City Country Phone Mobile Email LabelAddress LabelLine o B N eJe Je e String 0 50 Generateltem String 0 200 String 0 8 0 91 1 8 String 13 23 0 9 18 or 0 9 23 or a zA Z 0 9 13 Generate Recipient String 0 15 String 0 35 Boolean String 0 35 String 0 35 String 0 35 String 0 35 String 0 35 String 0 35 String 0 10 String 0 35 String 0 5 Integer 0 10 String 0 10 String 0 35 String 2 a zA Z 2 String 0 20 String 0 20 String 0 160 LabelAddress String 0 35 ID assigned by customer at request level is returned unchanged in the response If no SendinglD is supplied WSBC generates a
12. at reguest level is returned AuftragsRef123 unchanged in the response if set Otherwise this element is missing Item GenerateLabel Content holder per address label Responseltem temiD String 0 200 D assigned by customer at address label level is taken from request IdentCode String 0 50 Mailing code 993412345612 345678 Label Binary Base64 Generated address labels Errors ErrorsType Content holder for error messages Error MessageType Content holder for error message 35 Cardinality Type Description Example if appropriate Code String 5 DALE Error code E0012 1 0 9 4 Message 5 String 0 500 Description of error in the language in vvhich the operation is activated VVarnings 0 1 WarningsType Content holder for warnings Warning m MessageType Content holder for warning Code l String 5 DALE Warning code VV0012 1 0 9 4 Message 1 3 String 0 500 Description of warning in the language in which the operation is activated For the corresponding request precisely one barcode vvill 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 vveb 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 reques
13. be separated by decimal point 150 50 comma not allovved Type IE String 0 35 Field for ISR reference number NN ESR REFNR Value String 0 50 Reference number Reference number 5 3 1 2 Notification services Notification text messages The description of the content of SMS and e mail messages as Notification code vvell as technical specifications regarding free text are available at In the Notification element the Service filed has the follow yvvvvvv svvisspost ch post e log avisierungsservices cietails ing valid values Proof of posting 1 Delivery information Collection information 4 Reminder to recipient z Handover status to sender 64 Exchange return 128 Saturday delivery 2562 Evening delivery follovving days 2579 Evening delivery same day 2589 9 This notification service can only be used with delivery instruction ZAVV3233 2 This notification service can only be used with the additional service SA 3 This notification service can only be used with the additional service AZS and the basic service PostPac Priority bulky goods Priority PostPac Economy or bulky goods Economy 4 This notification service can only be used with the additional service AZS and the basic services Swiss Courier Lightning bulky goods Lightning or Direct 34 5 3 2 Generate Label response Generate Label You can download an XML example as vvell as a graphical interface descriptio
14. ee lt gt III IRIN eek L SS eeen 99 60 001750 00004544 99 60 001750 00004972 vveb service Firma Muster AG Abteilung BE Herr Hans Specimen Mustergasse 12 9999 Musterhausen Only barcodes for integration Barcode vvith recipient address into vvaybill for direct printing VVeb connection 4 aaaaasasasasasasasasasasasasasiIsIsese Electronic response address labels with or without address o dei Va 2 lt o bd Logic processing component DataTransfer Figure 1 Schematic diagram of the Generate label Barcode web service Domestic Parcels Swiss Express Swiss Courier and Solutions service groups 12 Letters vvith barcode BMB domestic and international service group Customersystem Electronic query for address label basic additional service language format print resolution picture format etc e g Registered mail R Personal delivery RMP DE VVindovv 300 GIF 3030 Bern DEST P 98 34 108433 00070264 49 proclima 5 LAPOSTA Firma Muster AG Abteilung BE Herr Hans Specimen Mustergasse 12 9999 Musterhausen Barcode vveb service RMP VVeb connection o Mie dei Va 5 lt o Logic processing component Electronic response Address la
15. eq sons 5oTsoq py HO 1504 0 puas OEI ssaippe jo sajdwwes q 19945 s ulo3sn YUM 194 960 puas sp ld dp uonnios q i lqe ns ou ase si ulid xineul og DOLU J91ulId 9 gt eul JOU Jong Jose ER 491SueJJ0uuuo9U j OulJouU adh p sn 1410 pue SU nod u eds p ege 4oded ssaippe opo gt 4eg jaqe ssaippy waishs 442 A9WO SND uonduosed I6ip g Dumue1 Sue 928 d 9D021SOd uoud l L ns 05 1261 02 Auedwod Jo ouieN sjle9p Auedwio gt suonnjos pue 4o11n07 sseidxy S 924ed JO si qe sse4ppe Jo Uon e6oJouIoH 399Us 4ouI03 sn2 DOSU 92I1A49s goAM opoo4eg 56 Wa Post CH Ltd Support VVebservices Viktoriastrasse 21 P O Box 3030 Berne Svvitzerland webservice swisspost ch www swisspost ch SWISS 1
16. g de fr it en Float Floating point numbers Integer Numeric integers String Alphanumeric strings 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 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 ser vice but not all additional services can be combined with each other 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 Barcode identifying a delivery instruction The text describing the deliv ery instruction is also required for this barcode Delivery instructions are only possible in conjunction with a basic service CUS_Logo binary logo of customer ATT_ProClima TRUE print pro clima logo ATT_DeliveryDate 2009 11 19 delivery date for ZAW3217 Language de language used to call the service ATT_Amount 150 75 COD amount CUS_ZIP 3030 postcode LabelLayout A6 layout of address label Cash on delivery additional service Signature Fragile etc Direc
17. mail identifier 2 digits the product code 2 digits the franking licence 6 digits and the item number 8 digits 13 digit code with user information Represents the actual barcode and is used for identification and elec tronic delivery tracking Set of identcodes having the same logical structure Identcode type Parcel used for the Domestic Parcels Swiss Express Swiss Courier and Solutions service groups Comprising identcodes with the same logical structure as a type Identcode type Letters with barcode BMB domestic used for the Domestic Letters service group R identifier y franking licence four digits alphanumeric x item number five digits p check digit CH ISO code for Switzerland Stands for Produktzusatzlabel product label which is identical to the additional service barcode see definition 99 34 123456 12345678 item number 98 34 123456 12345678 item number item number 99 34 123456 12345678 identcode identcode 98 34 123456 12345678 98 04 123456 12345678 RyyyyxxxxxpCH identcode barcode 99 34 123456 12345678 98 34 123456 12345678 RyyyyxxxxxpCH Type data type Type data type ZL ZAVV Delivery instruction barcode 10 Defines the value range of an element Binary Data stream Base64 with Base64 encoding Logical values TRUE or FALSE Date Date specification Enumeration Enumeration type e
18. random number Content holder per address label ID assigned by customers at address label level will be returned unchanged in the response Mailing number Mailing code For use by Swiss Post internal systems only In systems external to Swiss Post this field is ignored and a warning returned Content holder with recipient details Postal identification Salutation When set to FALSE indicates the company first then the recipient on the address label Toggles to TRUE Default True First name of recipient First name and surname or company name Additional designation Name Additional name 2 for name Additional name address Street House number Name P O box and if available EO box number Floor number data transfer only not printed on address labels Letter box number data transfer only not printed on address labels Postcode Place Country two digit ISO 3166 1 alpha 2 code Telephone number for delivery instruction 13 Mobile number for delivery instruction 13 E mail address 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 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 12345678 9934123456 123
19. wi ters wi h barcode domestic h barcode international h barcode international Service group Resulting basic service PostPac Economy PostPac Priority Bulky goods Economy Bulky goods Priority PostPac Promo PostPac Economy GAS PostPac Priority GAS Bulky goods Economy GAS Bulky good Priority GAS Swiss Express Moon Bulky goods Moon Swiss Courier Lightning Bulky goods Lightning Swiss Express Moon GAS Swiss Courier Lightning GAS VinoLog Direct Registered R domestic A Mail Plus Dispomail Dispomail Easy Court documents GU Debt collection documents BU A Mail B Mail individual items Registered R international ECONOMY Registered R international PRIORITY Service code ECO PRI SP ECO SP PRI PPR GAS ECO GAS PRI GAS SP ECO GAS SP PRI SEM SEM SP SKB SKB SP GAS SEM GAS SKB VL DIRECT RINL APLUS DISP DISPE GU BU APOST BPOST RETR ECO RETR PRI 5 7 1 Read Basic Services request ReadBasicServices You can download an XML example as vvell as a graphical interface description per request here www swisspost ch post barcode cug Cardinality Type Description Example if appropriate ReadBasicServices Root element of Read Basic Services operation Language 11 Enumeration Language used to cal the service en de fr it en ServiceGrouplD 1511 nteger Numeric identifier for service group 1 5 7 2 Read Basic Services res
20. 12 9999 Musterhausen J rg Dummermuth PL21 Viktoriastrasse 21 Post CH AG 3030 Bern Figure 3b Option to use the address label as a shipping label on parcels as shown in this example illustration does not show actual size 14 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 Swiss Express Swiss Courier 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 resolu tions 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
21. 45678 Ms True Melanie Steiner FAO Hans Meier Marketing department East building Viktoriastrasse 21 P O Box 4021 3a 10 3030 Berne 1 CH 031 338 11 11 079 338 11 11 h muster post ch 31 Cardinality Type Description Example if appropriate AdditionallNFOS Generate Content holder AdditionallNFOS AdditionalData 0 20 Generate Content holder AdditionalData Type String 0 35 General keys for electronic cash on delivery BLN 1 1 COD amount in CHF NN_BETRAG Additional keys for BLN with ISR d ISR reference number NN_ESR_REFNR Value 17 String 0 50 Value for additional information must be separated by decimal 150 50 point comma not allovved Attributes oni Generate Content holder Attributes PRZL En String 1 7 Service code DLC 206 EEL ZE a zA Z 0 9 1 7 Amount DS Float COD amount for additional service N must be separated 150 50 0 99999 99 by decimal point comma not allovved 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 17 2009 08 20 ParcelNo D Integer 0 99 Parcel number of total for delivery instruction 18 2 ParcelTotal 0 1 Integer 0 99 Total number of parcels for delivery instruction 18 5 DeliveryPlace RK String 0 35 Drop point for delivery instruction 19 At front door ProClima 0 1 Boolean Printing of ProClima logo Dimensions 0 Dimensions Content holder for dimen
22. A Address label layout A5 Z 0 9 2 PrintAddresses EO Enumeration Details on the printing of sender s and recipient s address OnlyRecipient None delivery note 575 None no addresses are printed OnlyCustomer Ge RecipientAnd OnlyRecipient only the recipient s address is printed Customer OnlyCustomer only the customer s address is printed RecipientAndCustomer Both the sender s and the recipients addresses are printed ImageFileType 1 51 String 1 5 Address label file format PDF a zA Z 0 9 1 5 mageResolution 1 nteger Address label resolution in DPI dots per inch 300 PrintPreview e Boolean PrintPrevievv enabled disabled SPECIMEN lettering from the true label generated Filelnfos 1 GenerateFilelnfos Content holder FrankingLicense String 4 8 Customer franking licence number or postcode a zA Z 0 9 4 or 0 9 6 or 0 9 8 PpFranking ne Boolean Indicates whether the PP flag has been set or not true CustomerSystem omi String 0 255 Indicates optional parameters for customer system names AVG Client a zA Z 0 9 s 1 255 Customer 1 Generate Content holder with customer details Refers to the sender s Customer customer Name EN String 0 25 First name and surname or company name Meier AG Name 0 String 0 25 Additional designation Name General Agency Street 1 1 String 0 25 Address house number and street Viktoriaplatz 10 POBox D String 0 25 P O Box P O Box 4021
23. DeliveryPlace String 0 35 91 89 88 E ER AE ProClima Boolean Dimensions Dimensions VVeight nteger 0 99 999 UNNumbers 05 UNNumber 0 n Integer 0 9 999 Notification 0 15 Generate Notification Type db String Mail SMS Service IE Integer 0 20 FreeText1 omi String 0 160 FreeText2 om String 0 512 Language 1541 Language Communication ilk Generate Communication Email Om String 0 160 Mobile Mobile Mobile 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 40 Content holder Content holder General keys for electronic cash on delivery BLN COD amount in CHF Additional keys for BLN with ISR ISR reference number Value for additional information Content holder Service code DLC COD amount for additional service N Free text for recipient address Delivery date for delivery instruction 17 Parcel number of total for delivery instruction 18 Total number of parcels for delivery instruction 18 Drop point for delivery instruction 19 Printing of ProClima logo Content holder for dimensions Weight in grams limited to 5 digits for LQ additional service Hazardous goods Content holder for UN number for the LQ hazardous goods additional service List of UN numbers limited to 4 digits for LQ additional service
24. Si E Post CH AG PostMail Marketing PM11 Viktoriastrasse 21 Postfach 3030 Bem RMP MUSTERSENDUNG Post CH AG PostMail Marketing PM11 Viktoriastrasse 21 Postfach 3030 Bem basic service basic service code cash on delivery ficht in den Ablagekasien legen zustellen avisieren ito auxdiaire distribution ou avis de retrait Additional service 1 Non lasciare neta cassetta di deposito distribuire o avvisare Additional service 2 Recipient address EN Ee Label layout for Letters vvith barcode BMB domestic and international DL DLC Single barcodes Free text Franking licence GAS Cardinality Barcodes for Online Consign ment Notes LSO Logistics services provider pro clima logo n the case of the Letters vvith barcode BMB domestic and Letters vvith 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 Exception Debt collection documents BU and court documents GU or when generated as an address component for a standard window envelope FE or with the Generate single barcodes operation as an individual chart customer positioning of address label German acronym for Dienstleistung service A combination of basic services additional services and delivery instructions de
25. The service is not available at the moment 53 Every vvarning consists of a four digit vvarning code prefixed by TAT 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 vvarning 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 English W2003 W2004 W2005 W2006 W2007 W2008 W2009 W2010 W2011 W2012 W2013 W2014 W2015 W2016 W2017 W2018 W2019 W2020 W2021 VV9997 54 You have indicated a COD amount vvithout requesting the additional service COD N BLN You have indicated an ISR reference number without requesting the additional service Electronic COD BLN You have indicated a telephone number vvithout requesting the delivery instruction Notify delivery by telephone ZAVV3213 You have indicated a delivery date vvithout requesting the delivery instruction Specific delivery date delivery on 2AVV3217 You have indicated a parcel number and or a parcel total without requesting the delivery instruction Deliver when all consignments have arrived ZAW3218 You have indicated a deposit poin
26. abels and 5 3 Generate single barcodes operations 224 VinoLog solution can novv be 5 8 combined vvith SA value added service 22 Registration and activation revised ES U ZE Nevv endpoint for accessing VVSBC 4 2 U 222 Elements for BLN removed in request 5 3 5 5 U 2222 ZAVV3232 GALI Delivery instruction Collect empty containers or materials for recycling relaunched Insert U Update 1 3 1 Section 1 Introduction The first section provides an introduction to the Barcode web service 1 3 2 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 1 3 3 Section 3 Registration homologation support The registration procedure for the Barcode web service is described here 1 3 4 Section 4 Technical specifications This section describes the services in detail interface specification the operations and results 1 3 5 Section 5 Appendix Barcode web service interface Some resources for using the Barcode web service are described in this section 1 3 6 Section 6 Further publications and useful links This section lists further publications and links 1 3 7 Section 7 Customer sheet for homologation of Parcel Express and Courier VinoLog and Direct consignments This section provides the customer sheets for homologat
27. ail address NN_CUS_EMAIL must be specified For COD items BLN vvith IBAN or ISR account number NN ESR KNDNR a valid sender contact phone number NN CUS PHONE or NN CUS MOB LE must be specified For COD items BLN a combination of ISR and IBAN fields is not permitted The basic service 0 can only be used in conjunction with the value added service 1 The notification service 0 can only be used together with the value added service 1 The recipient address could not be determined check for evening delivery not possible Evening delivery for this address not part of the offer The checking of the evening delivery cannot be carried out at the moment Please contact Support The checking of the evening delivery cannot be carried out at the moment Please contact Support The output format for single barcodes is currently not supported No valid web service call The Zubofi system is currently not available Please try again later The Kurepo system is currently not available Please try again later The output format 1 is currently not supported in resolution dpi 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 The web service barcode was unable to generate a unique consignment number If the problem reoccurs please contact the Support team User 0 is not authorized for this service
28. akes 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 45000 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 milli seconds Average including data transmission in milli seconds 500 1000 G F 100 500 1000 JPG 300 750 1500 PNG 400 750 1500 PDF 50 500 1000 sPDF 15 300 750 ZPL2 5 300 750 You can omit the sender s details on the label or you can include them in the form of text or an image e g company logo You can suppress the display of the sender details on the address label or display them as a text or image e g company logo The sender s address must however always be entered in the Barcode web service If using an image logo please note the following Image width 47 mm Image height 25 mm File size max 50 kB File format GIF or PNG Colour table indexed colours max 200 colours The logo will be printed rotated counter clock
29. 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 Swiss Express and Solutions 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 http www swisspost ch en post startseite post geschaeftskunden post briefe post briefe erhalten post briefe unzustellbare sendungen pm einschreiben anleitung barcode pdf 21 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
30. ate 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 indi vidually 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 Courier 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 24 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 Moo
31. bel with barcode s e g for envelope with window Figure 2 Schematic diagram to call up the Barcode web service gt Generate Label Letters with barcode BMB domestic and international service group 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 DIE PosT P pes L 99 60 001750 00004552 BLN 2380 00 Firma Muster AG Abteilung BE Herr Hans Specimen Mustergasse 12 9999 Musterhausen Rechnung Lieferschein Artikel Nr Artikel Preis Stk Aktionspres b roklammem mite 10 Fensterumschiage CS neutral 1 Kugeischreiberiang 01 Heftkiammerngold Bnefpapier AS wess Versandkostenartef otal inki MWSt zahibar inert 30 Tagen Figure 3a Option to integrate directly in the delivery note Sendung dem Empfanger direkt auf der Etage zustellen Distribuer l envoi au destinataire directement a l tage Recapitare l invio al destinatario direttamente al suo piano 3030 Bern WSBC 2 2 18 10 2013 TU 516850 20 99 60 001750 00004550 DIEPOST F musem an so PRI SP LO Firma Muster AG Abteilung BE Herr Hans Specimen Mustergasse
32. cation service is available for mail items in the Parcels Swiss Express Swiss Courier without Swiss Courier Lightning and bulky goods Lightning and Solutions service groups no delivery information with VinoLog The above gives you five different services to choose from which are subject to a charge Please contact your Post CH Ltd customer advisor for price enquiries Technical information on notification services is described in section 5 3 1 2 You will find the wording of SMS and e mail messages and the instructions on free text at the www swisspost ch avisierungsservices website 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 choose between standard text or personal free text for your message Delivery information message VVith this service the recipient is advised of an upcoming deliv ery The message is triggered by sorting information from the sorting centre Based on this data the delivery date can be esti mated and the recipient advised accordingly You can choose betvveen standard text or personal free text for your messag
33. e Collection information message This service is designed for those recipients vvho collect their mail items from a Post Office P O Box or poste restante This notification dispels uncertainty as to vvhether 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 or mobile recipient specified in the data file will receive an e mail or SMS 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 16 Exchange return delivery notification delivery notification ZAW3233 With the Exchange return delivery notification we are able to offer a simple standardised se
34. e ZIP 8th address line City 8th address line Example 2 Format A6 2 ZAWs DLG parcels Details on the address label Details in the Recipient block free text max no of address lines allowed 8 address lines FreeText 1st address line FreeText Title 2nd address line Title Firsthame 3rd address line Firstname Name Name1 3rd address line Name2 Name2 4th address line Name3 Name3 5th address line AddressSuffix AddressSuffix 6th address line Street HouseNo Street 7th address line ZIP City HouseNo 7th address line ZIP 8th address line City 8th address line Example 3 Format A7 DLG BMB domestic Details on the address label Registered R domestic max no of address lines allowed Details in the Recipient block 7 address lines Title 1st address line Title Firstname 2nd address line Firstname Name1 Name1 2nd address line Name2 Name2 3rd address line Name3 Name3 4th address line AddressSuffix AddressSuffix 5th address line Street HouseNo Street 6th address line ZIP City HouseNo 6th address line ZIP 7th address line City 7th address line 23 4 6 3 Names of label elements Delivery instructions Additional information to delivery instructions Additional information to additional service Logistics services provider pro clima logo Lieferung telefonisch avisieren Yel Nr L
35. e fr it en PRZL 1 n String 0 5 Short designation for a service code Only one service code is out ECO put per PRZL Basic services comprising multiple service codes are split between several PRZL elements 47 5 9 2 Read Delivery Instructions response ReadDeliverylnstructions You can download an XML example as well as a graphical interface description per response here www swisspost ch post barcode cug Cardinality Type Description Example if appropriate ReadDeliverylnstructions Root element of the Read Delivery Instructions response Response operation Deliverylnstructions 0 n Container for additional service PRZL 1 1 String 0 5 Short designation of a service code special delivery instruction ZAW3213 Description String 0 255 Description of the delivery instruction Errors 0 1 Container for error messages Error M Container for error message Code 1 1 String 5 Error code E0012 Message 5 String 0 500 Description of the error in the language used for the call 48 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 reguest here www swisspost ch post barcode cug Cardinality Type Description Example if appropriate ReadLabelLayouts Root element of Read Label Layouts operation Language A Enumeration Language used to call the service de de
36. ed to cal the service en de fr it en 5 6 2 Read Service Groups response ReadServiceGroups You can dovvnload an XML example as vvell as a graphical interface description per response here www swisspost ch post barcode cug Cardinality Type Description Example if appropriate ReadServiceGroupsResponse Root element of the Read Service Groups response operation ServiceGroup 0 n Container for service groups description ServiceGrouplD 1 nteger Numeric identification of service group 1 Description EN String 0 255 Description of service group Parcel letter Errors DS Container for error messages Error 1 n Container for error message Code 1 String 5 Error code E0012 Message E String 0 500 Description of the error in the language used for the call Returns all the basic services for a specified service group eau Tom iii ServiceGrouplD HU Parcel Parcel Parcel Parcel Parcel Parcel Parcel Parcel Parcel Swiss Express Swiss Courier Swiss Express Swiss Courier Swiss Express Swiss Courier Swiss Express Swiss Courier Swiss Express Swiss Courier Swiss Express Swiss Courier Solutions Solutions Letters wi Letters wi Le Le Le Le Le Le Le Le ters wi ters wi ters wi ters wi h barcode domestic h barcode domestic h barcode domestic h barcode domestic h barcode domestic h barcode domestic ters with barcode domestic ters wi ters
37. element is missing Item En GenerateSingle Content holder per address label BarcodesRespon seltem ItemlD 0 1 String 0 200 D assigned by customer at address label level is taken from request IdentCode omi String 0 50 Mailing code 9934123456 12345678 Barcodes oni GenerateSingle Content holder for generated barcodes BarcodesRespon seBarcodes Barcode EO Binary Base64 Generated single barcodes Errors OF ErrorsType Content holder for error messages Error I MessageType Content holder for an error message Code 1 3 String 5 DALE Error code E0012 1 0 9 4 Message 2 String 0 500 Description of error in the language in vvhich the operation is activated VVarnings 0 WarningsType Content holder for warnings Warning 1 n MessageType Content holder for warning Code String 5 W E Warning code VV0012 1 0 9 4 Message 1 1 String 0 500 Description of warning in the language in which the operation is activated 41 Returns all service groups ran n Parcel Swiss Express Swiss Courier Solutions Letters with barcode domestic Uu db U N 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 reguest here www swisspost ch post barcode cug Cardinality Type Description Example if appropriate ReadServiceGroups Root element of Read Service Groups operation Language E Enumeration Language us
38. er Lightning 2 Diagram for Generate address 58 U label operation modified 2 section a ba 2 m VinoLog 25500 Direct only in conjunction with AZS 211 Changes affect DLG Parcels Express Misc Letters vvith barcode BMB domestic Courier and Solutions Nevv basic and additional services and 7 7 combination codes DIRECT AZS SA PRIAZS etc inserted Dispomail Dispomail Easy Court documents GU Debt collection documents BU A and B Mail letters with the Cash on delivery N or 211 Nevv notification services 27 Saturday and evening delivery and summayy table inserted EG Renameg Be 5 mie 7 Electronic cash on delivery BLN additional service Solutions Letters with barcode BMB international St Two new delivery instructions for 4 6 1 Registered R international RETR PRI and RETR ECO format supported 2 11 ZAVV3229 deliver in the evening 5 9 U removed BAZ Business reply labels GAS DLG parcels 5 1 1 U and Swiss Express Swiss Courier are now listed under basic services BAD The Generate Label request now 4 6 2 includes new fields for the recipient s address Name3 and AddressSuffix Recipient s address block LabelAddress completely revised 2 12 ZAVV3234 Do not deliver to 5 mailbox or neighbour do not leave anyvvhere introduced 21 New SendinglD element in 5 Generate address l
39. ery instruction DLG Swiss Express Swiss Courier incl any free text with 2 delivery instructions DLG solutions VinoLog only incl any free text up to 1 delivery instruction DLG solutions VinoLog only incl any free text with 2 delivery instructions DLG solutions without VinoLog incl any free text up to 1 delivery instruction DLG solutions without VinoLog incl any free text with 2 delivery instructions DLG BMB domestic DLG BMB international 9 Delivery instructions are not possible for A7 format 22 E 6 8 6 8 8 E 6 8 7 7 5 7 Z 5 7 7 5 7 6 6 8 6 6 8 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 max 1 ZAW DLG parcels Details on the address label Details in the Recipient block free text max no of address lines allowed 8 address lines FreeText 1st address line FreeText Title 2nd address line Title Firstname 3rd address line Firstname Name1 Name1 3rd address line Name2 Name2 4th address line Name3 Name3 5th address line AddressSuffix AddressSuffix 6th address line Street HouseNo Street 7th address line ZIP City HouseNo 7th address lin
40. 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 ldentCode 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 reguest 5 Additional information on BLN electronic COD is detailed under section 5 3 1 1 Reference number 84 9 27 For 9 digit ISR customer numbers 99999999999999999999999999P For 5 digit ISR customer numbers 000000000000999999999999999 5 3 1 1 Posting BLN electronic COD via Barcode web service for Parcels and Swiss Express BLN defined transaction types 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 Web Service Support for further informa tion The credit note for COD amounts can be applied by means of two different account types 1 Yellow Account with inpayment slip IS from PostFinance with upper limit on doemstic transactions 2 by Swis
41. fined 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 German acronym for Dienstleistungscode service code Identifies the required postal service combination of basic service code additional services and delivery instructions 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 For entering information on the space on the label for free text 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 German acronym for Geschaftsantvvortsendung business reply item a basic service Indicates the number of times an element may be present in a call If you want to create the consignment note for data transfer letters with barcode BMB yourself you can obtain the barcode reguired for this To do so you use the Generate barcode operation in order to obtain the barcode reguired for the consignment note number The 18 di
42. git code consists of the postal identification 98 93 000000 and the final 8 digit item number 20000000 29999999 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 The pro clima logo indicates an item for which the surcharge for carbon neutral shipping has been paid and a contract to that effect has been signed For Letters with barcode BMB domestic the ProClima logo is printed automatically at no additional charge Basic service Barcode Additional service 2 Recipient address service service code Example Your order of franking licence 1 n for the element ATT_PRZL signifies 1 to n service codes PRZL are permitted EN Ee Item number for Domestic Parcels Swiss Express Swiss Courier VinoLog and Direct Item number for Letters with barcode BMB domestic Item number for Letters with barcode BMB international Identcode for Domestic Parcels Swiss Express Swiss Courier VinoLog and Direct Identcode for Letters with barcode BMB domestic Identcode for Letters with barcode BMB international Barcode Identcode type for Domestic Parcels Swiss Express Swiss Courier VinoLog and Direct Identcode type for Letters with barcode BMB domestic Identcode type for Letters with barcode
43. gnored To display Name3 please select a larger presentation type For the chosen presentation type the recipient is restricted to 0 lines Free text vvill be ignored To display the free text please select a larger presentation type For the chosen presentation type the recipient is restricted to lines Excessive Label ines will be ignored To display all LabelLines please select a larger presentation type The Consignment code field may be filled in using Swiss Post applications only 6 Further publications and useful links Barcode vveb service vvebsite www swisspost ch post webservice barcode User manual Client API Library for Java and C Net and instructions for PHP vvvvvv svvisspost ch post barcode cug Manual VVSDL XSD and examples for dovvnloading www swisspost ch post barcode cug htm Barcode web service subscriber conditions www swisspost ch post tnb webservice barcode pdf Track amp 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 www swisspost ch post datatransfer cug briefe htm 55 ion Customer sheet on homologat of Parcel Express and Courier VinoLog and Direct consignments 7 Appendix 1 u bubuEH 0297 xog Od G u qe byy 92U9 92xJ Jo nu sseippv pue Sulb5ey
44. ical interface description per request here www swisspost ch post barcode cug Cardinality Type Description Example if appropriate ReadAdditionalServices Root element of Read Additional Services operation Language KOI Enumeration Language used to call the service en de fr it en PRZL EO String 0 5 Short designation for a service code Only one service code is ECO output per PRZL Basic services comprising multiple service codes are split betvveen several PRZL elements 5 8 2 Read Additional Services response ReadAdditionalServices You can download an XML example as vvell as a graphical interface description per response here www swisspost ch post barcode cug Cardinality Type Description Example if appropriate ReadAdditionalServices Root element of the Read Additional Services response Response operation AdditionalService 0 n Container for additional service PRZL String 0 5 Short designation of a service code special additional service N Description le String 0 255 Description of the additional service Errors DS Container for error messages Error EN Container for error message Code 1 String 5 Error code E0012 Message a String 0 500 Description of the error in the language used for the call 46 Returns all the delivery instructions for a specified basic service np Terms DLC sho Basic service ZAW ZAW ZAW ZAW ZAW ZAW ZAW ZAW ZAW uu 3233 3218 3217
45. in the set language 50 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 reguested 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 message English 000 001 002 003 004 005 006 m SEK m Ai m Mun m E1007 008 009 o H m a m ida m aa TO E2001 E2002 E2003 E2004 E2005 E2006 E2007 E2008 E2009 E2010 E2011 E2012 The desired combination of the basic service codes 0 is invalid The desired additional services 0 cannot be combined with the reguested basic service 1 The reguested additional services 0 cannot be combined with each other The desired delivery instructions 0 cannot be combined with the requested basic service 11 The desired delivery instructions cannot be combined with the requested additional services 1 The reguested delivery instructions 0 cannot be combined with each other 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 choo
46. interface description per reguest here www swisspost ch post barcode cug Cardinality Type Description Example IT appropriatel ReadAllovvedServices ReadAllovved Root element for the Read basic services of a franking licence ByFrankingLicense ServicesByFrank operation ingLicense FrankingLicense LA String 4 8 Customer franking licence 32100196 a zA Z 0 9 4 or 0 9 6 or 0 9 8 Language 1 1 Enumeration Language in vvhich the service is activated de de fr it en 5 11 2 Read basic services of a franking licence response ReadAllovvedServices ByFrankingLicense You can download an XML example as well as a graphical interface description per response here www swisspost ch post barcode cug Cardinality Type Description Example if appropriate ReadAllowed ReadAllowed Root element for the Read basic services of a franking licence Services ByFranking ServicesBy operation LicenseResponse FrankingLicense Response ServiceGroups 0 n ReadAllovved Content holder for services service groups Services ServiceGroups ServiceGroup 1 1 ServiceGroup Complex type of a service 1 ServiceGrouplD ES nteger Service Postld 3 Description il 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 Short description of a service code DLC PRI Z 0 9 1 7 Description eel String 0 255 Description of the basic service
47. ion of the address label which is to be submitted together with the address label 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 Post CH Ltd s Barcode web service is provided free of charge The Barcode web service is intended solely for generating labels and for obtaining service additional service and delivery instruction lists 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 EN Ee 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 The document can be packed and sent in the window envelope 3030 Bem component standard size 100 x 45 mm without needing to affix a label R IN NI IDI H ll 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 98 34 108433 00020077 Address label Address label bearing the reguired barcode a Rum Label for displayi
48. ional services can be found at www swisspost ch post briefe versand national RINL Registered R domestic AR Acknowledgement of receipt AR APLUS A Mail Plus BLN Electronic cash on delivery BLN DISP Dispomail GEG Item for the blind CEC DISPE Dispomalil Easy N Cash on delivery N GU Court documents GU RMP Personal delivery RMP BU Debt collection SEM Swiss Express Moon 1 documents BU APOST A Mail eAR Electronic return receipt BPOST B Mail individual items 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 nc O Basic services 22 Additional services RETR PRI Registered R interna AR Acknovvledgement of tional PRIORITY receipt AR RETR Registered R interna CEC Item for the blind CEC ECO tional ECONOMY N Cash on delivery N 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 seguencing of individual content does not matter lt PRZL gt RETR lt PRZL gt lt PRZL gt PRI lt PRZL gt 27 This operation returns a validation response for a given combina tion of service codes 5 2 1 Validate Combination request You can dow
49. ivraison a aviser t l phone No t l 079 999 99 99 Distribuzione avvisare telefonicamente No tel p 99 g Sendung dem Empf nger direkt auf dei Etage zustellen Distribuer l envoi au destinataire directement l tage Recapitare l invio al destinatario direttamertte al suo piano 3030 Bern Version information WSBC 0 0 7 SNAPSHOT 04 11 2009 Mike DIEPOST T1 Barcode Identcode 99 60 111100 00000101 Home post office CHF 650 25 MAN N 1 von 4 Firma Muster AG Abteilung BE Herr Hans Specimen Mustergasse 12 3000 Musterhausen J Dummermuth Post CH AG PostLogistics 3030 Bern Recipient s address Free text Service codes Sender s address or logo Figure 4 Sample address labels for Parcels and Swiss Express Swiss Courier service groups 24 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 EPS GIF JPG not recommended as barcode may not have high enough quality PNG PDF sPDF ZPL2 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 The time it t
50. ls 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 Courier Swiss Express Moon bulky goods Moon Swiss Courier Lightning bulky goods Lightning Swiss Express Moon GAS Swiss Courier Lightning GAS Solutions VinoLog Direct 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 the Cash on delivery N or Electronic cash on delivery BLN additional service Letters with barcode BMB international with the following products Registered R international RETR PRI and RETR ECO all included in the corresponding additional services A7 format 74 x 105 mm A6 format 105 x 148 mm A5 format 148 x 210 mm only available for Domestic Parcels Swiss Express Swiss Courier and Solutions Format FE vvindovv envelope only available for Letters vvith barcode BMB domestic and international 4 6 1 Contents for individual label formats Format Format A7 Format A6 Fenster Service group Domestic Parcels No Yes Yes Yes Service group Svviss Express No No Yes Yes Swiss Courier Service group
51. n 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 que ries 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 You can arrange for your recipient customer to receive updates via SMS or 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 notifi
52. n per response here www swisspost ch post barcode cug Cardinality Type Description Example if appropriate GenerateLabelResponse GenerateLabe Root element of Generate address label operation response Response Envelope GenerateLabe Content holder Response Envelope LabelDefinition GenerateLabe Content holder with address label details ResponseLabe Definition LabelLayout String 2 a zA Address label layout A5 Z 0 9 2 PrintAddresses Enumeration Details on the printing of sender s and recipient s address OnlyRecipient None delivery note 25755 None no addresses are printed OnlyCustomer dizki Eer Recipi entAnd OnlyRecipient Only the recipient s address is printed Customer OnlyCustomer Only the customer s address is printed RecipientAndCustomer Both the sender s and the recipient s addresses are printed ImageFileType String 1 5 Address label file format PDF a zA Z 0 9 1 5 ImageResolution Integer Address label resolution in DPI dots per inch 300 PrintPreview Boolean Indicates whether the generated address label is used for a text print out ItemNo is not looped ColorPrintRequired Boolean Displays whether generated address label is to be printed in colour or in black and white Data GenerateLabel Content holder ResponseData Provider GenerateLabel Content holder Response Provider Sending GenerateLabel Content holder Response Sending SendinglD String 0 50 Optional ID assigned by customer
53. ng the information about an item that is relevant for Sie EZA shipping This may be an adhesive label or a sheet for insertion in a MUSTERSENDUNG BL BLC BMB domestic BMB international COD Label layout Domestic Parcels Swiss Express Swiss Courier VinoLog and Direct 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 German acronyms for Basisleistung basic service and Basisleis tungscode basic service code subset of service code DLC Actual service provided by Swiss Post e g PostPac Economy 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 Cash on delivery N or Electronic cash on delivery BLN Letters with barcode BMB international Generic term for the basic services Registered R international RETR PRI and RETR ECO Acronym for Cash on delivery 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 R il een 98 34 108433 00070289 SS
54. ngs may be services plus delivery instructions can be found at issued when generating multiple address labels With warnings www swisspost ch post distribution national the reguest 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 Basic services Additional Delivery instructions Combination code services comprising multiple DLC ECO PostPac Economy FRA Fragile ZAW3211 Direct delivery to an upper floor A PRISI PRI SI PRI PostPac Priority MAN Manual processing ZAVV3212 Do not place in letterbox PRIAZS PR AZS deliver manually or notify B ZE EGO Bulky goods Economy N Cash on delivery ZAW3213 Notify delivery by telephone C PRIAZSI PRIORITY AZS SI NB only one S in DLC SP PRI Bulky goods Priority RMP Personal delivery ZAW3214 Place in letterbox or at front door DIRAZS D RECT AZS PPR PostPac Promo SI Signature ZAVV3215 Deliver contents take back box K DIRAZSI D RECT AZS SI NB only one S in DLC SEM Svviss Express Moon AS Signature ZAVV3216 Failed delivery return item as insurance priority on the same day E SEM SP Bulky goods Moon COLD Disposet Cold ZAW3217 Specific delivery date deliver on F SKB Swiss Courier Lightning BLN Electronic COD ZAVV3218 Deliver when all items have arrived G SKB SP Bulky goods Lightning LO Limited Quantities ZAW3219 Deposit item
55. nical 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 instruc tions 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 reguests in XML for the various operations can be found at www swisspost ch post barcode cug Swiss Post environment for producing labels Endpoint https wsbc post ch wsbc barcode v2_2 Username will be sent to you by Web Service Support Password will be sent to you by Web Service Support 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 Swiss Post sets the highest internal standards for high perfor mance and stable trouble free operation of the Barcode web service However in exceptional circumstances technical prob lems or failures may result in an interruption to the Barcode web service In order to deal with such situations we recom mend you have the ability to fall back on an alternative process using Swiss Post s conventional barcode labels Labels are available for the following service groups Domestic Parce
56. nload an XML example as well as a graphical interface description per reguest here www swisspost ch post barcode cug Cardinality Type Description Example if appropriate ValidateCombination Root element of Validate Combination operation Language x Enumeration Language used to call the service en de fr it en Envelope 5 Container for elements LabelDefinition EN Container for label defining elements LabelLayout Ys String 2 Layout of the address label A5 Data lles Container for elements Provider b Container for elements Sending 1 Container for elements Item dil Container for elements per label temiD 0 String 0 50 ID assigned by customer on the label level is returned unchanged in the response Attributes omi Container for elements PRZL Tu 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 Ll the country specific US validation is performed 28 5 2 2 Validate Combination response Returns a list of errors and vvarnings from validation if applicable You can download an XML example as well as a graphical interface description per reguest here www swisspost ch post barcode cug Cardinality Type Description Example if appropriate ValidateCombination Root element of Validate Combination Response operation Response Envelope 5 Container for elements LabelDefinition EN Container for label defining elemen
57. ocess Web service is free only investment is for linking up the Barcode vveb service to your system No shipping labels reguired if integrated in delivery note or as address component for envelope with window cost savings on labels Order data can be directly linked to dispatch data all the information from the order no through to the consignment no at your fingertips Fast consignment tracking preferably combined with Track consignments web service check the current processing status at any time Not part of Barcode web service must be programmed separately in your system if reguired 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 sender5 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 11 Domestic Parcels Svviss Express Svviss Courier and Solutions service groups Customersystem Electronic query for address labels basic additional services format print resolution picture format etc e g PRI SI A6 200 ZPL
58. 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 1 Title Title is omitted 2 AddressSuffix AddressSuffix is omitted 3 Name 3 Name3 is omitted 4 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 Format A7 Format A6 Fenster FE 6 8 8 DLG parcel incl any free text up to 1 delivery instruction DLG parcel incl any free text with 2 delivery instructions DLG Swiss Express Swiss Courier incl any free text up to 1 deliv
59. one number 0 must be between 9 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 For the 0 notification the delivery instruction 1 is reguired For the 0 delivery instruction the notification 1 is reguired Go The following characters only are permitted in the Item ID A to Z and a to 2 numbers O to 9 underscore 7 hyphen plus sign The communication type e mail or SMS does not match the telephone number or e mail address given For COD items BLN a valid ISR customer number NN ESR KNDNR must be set For COD items BLN a valid IBAN number NN IBAN must be set For COD items BLN with IBAN a valid name for the end beneficiary NN_END_NAME_VORNAME must be set For COD items BLN with IBAN a valid additional description for the end beneficiary NN END ZUSATZ NAME must be set For COD items BLN with IBAN a valid street NN_END_STRASSE must be set For COD items BLN with IBAN a valid postcode NN_END_PLZ must be set Error message English E2055 E2056 E2057 E2058 E2059 E2060 E2061 E2062 E2063 E2065 E9991 E9992 E9993 E9994 E9995 E9996 E9997 E9998 E9999 For COD items BLN with IBAN a valid city NN END ORT must be set For COD items BLN with IBAN or ISR account number NN_ESR_KNDNR a valid sender contact e m
60. ontains 0 colours However a maximum of 1 colours are permitted The sender logo could not be scanned Please check that it conforms to a valid picture format 0 A P O box address must be specified The franking licence used 0 is not authorized for the basic service 1 of the service group 2 The franking licence used is not the correct length 0 is not a valid ISO country code Additional service 0 is not permitted for mailings to 1 or only in combination with another additional service Basic service 0 does not belong to an international service group Basic service 0 does not belong to a domestic service group For domestic mailings the addressee s postcode must be specified For domestic mailings the addressee s postcode must consist of digits only For domestic mailings the addressee s postcode must not exceed the maximum length of 0 characters This franking licence 0 is not a customer franking licence and a valid consignment barcode must therefore be specified The weight should be express as a maximum of 5 digits and should not amount to more than 0 grams e g 29500 The weight must be a value great than 0 The UN number must be exactly 4 digits e g 1234 The LO additional service is only available from Version 2 1 onwards The notification service 10 cannot be combined with the basic service 1 The e mail address 0 must correspond to the following pattern 1 The teleph
61. out The printer is set to Normal mode i e not Economy mode with low toner 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 Courier 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 105 mm x 148 mm A7 74mmx 105mm The size of the consignment barcode must keep within the fol lovving measurements Length 68 0 mm to 69 0 mm Height 22 8 mm to 23 2 mm 3030 Bern WSBC 200 25 05 2011 TU 4862 02 22 8 mm bis 23 2 mm 99 60 001750 0001 5359 68 0 mm bis 69 0 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 Courier and Solutions Centre of excellence fo
62. ponse ReadBasicServices You can download an XML example as vvell as a graphical interface description per response here www swisspost ch post barcode cug Cardinality Type Description Example if appropriate ReadBasicServicesResponse Root element of the Read Basic Services response operation BasicService 0 n Container for description of basic service PRZL 1 n String 0 5 Short designation for a service code Only one service code is PRI output per PRZL element Basic services comprising multiple service codes are split into several PRZL elements Description WEN 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 String 5 Error code E0012 Message 1 1 String 0 500 Description of the error in the language used for the call 44 Returns all the additional services for a specified basic service For Domestic Parcels Svviss Express Svviss Courier VinoLog and Direct mun ferme Output DLC short Basic service GOLD LO PostPac Economy v X v PRI PostPac Priority v v v v ZA ZA v ZA v v v SP ECO Bulky goods Economy ZA x ZA v X ZA ZA ZA v x ZA SP PRI Bulky goods Priority Bulky goods Economy AND PostPac Priority v v PPR PostPac Promo x X X X X X X x X X X GAS ECO PostPac Economy GAS X x v v v v v v v x x GAS PRI PostPac Priority GAS X X v ZA v ZA v ZA v x X GAS SP ECO Bulky goods Economy GAS X x v ZA x ZA
63. r Domestic Parcels Swiss Express Swiss Courier and Solutions Post CH Ltd Poste CH SA PostLogistics PostLogistics Kompetenzzentrum CC Qualit de l emballage et de Verpackungs und Adressgualit t Fadressage Postfach Z Les Graveys 4620 Harkingen Case postale 1310 Daillens Telefon 058 386 15 53 qualitaet verpackung adresse post ch T l phone 058 386 85 06 qualite emballage adressage poste ch Contact for Letters with barcode BMB domestic and international barcodes Post CH Ltd PostMail OK for Printing 2nd Level Lischmatt 40 4621 Harkingen Switzerland Tel 41 0 58 338 13 29 gzd2ndpm swisspost ch 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 Web Service Support Post CH Ltd Web Service Support Viktoriastrasse 21 3030 Berne Tel 41 0 848 888 488 webservice swisspost ch 3 1 6 Termination If you no longer wish to use the Barcode web service please send an e mail to Web Service Support providing the reason for your cancellation the time of deactivation and the relevant franking licence numbers webservice swisspost ch 4 Technical specifications A description of the Barcode vveb service can be found in the VVSDL 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 reguire a tech
64. r 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 Your company administrator for My Post Business can open a technical user Web Service Support will manage the access data and communi cate it to you If you require a new password or an additional technical user name please contact Web Service Support 18 Once the Barcode web service has been activated a Specimen imprint will automatically be added to every label for the corre sponding franking licence As long as this Specimen imprint appears the labels must not be used for production operations In this test status the Barcode web service can be set up and tested by the customer The Barcode web service will only be activated for production for the respective franking licences following successful homologation of the labels by Post CH Ltd 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 inadeguate guality first Labels may only be printed with the defined printer resolutions and print formats If a different printer model or different printer resolution is used following successf
65. rue First name and surname or company name First name of recipient Additional designation Name Additional name 2 for name Additional name address Street House number P O Box Floor number Letter box number Postcode Place Country two digit ISO 3166 1 alpha 2 code Telephone number for delivery instruction 13 Mobile number for delivery instruction 13 E mail address 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 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 12345678 9934123456 12345678 Ms True Steiner Melanie FAO Hans Meier Marketing department East building Viktoriastrasse 21 P O Box 4021 3a 10 3030 Berne 1 CH 031 338 1111 079 3381111 h muster post ch 39 Cardinality Type Description Example if appropriate AdditionallNFOS GenerateAdditi onallNFOS AdditionalData 0 20 GenerateAdditi onalData Type String 0 35 1 1 VET Value IE String 0 50 Attributes 0 1 Generate Attributes PRZL don String 1 7 a zA Z 0 9 1 7 Amount On Float 0 99999 99 FreeText om String 0 34 DeliveryDate Date ParcelNo Integer 0 99 ParcelTotal Integer 0 99
66. rvice for the exchange or return of goods sent to your customers This involves your customer receiving advanced notice via a standard Swiss Post SMS or e mail message regarding this exchange or return This process enables your customers to receive good guality Triggering of the SMS or e mail occurs immediately upon data transfer if the relevant details are available in the data file No SMS messages are sent between 10 pm and 6 am For more information on the Exchange return delivery notifi cation please contact your Customer Advisor Saturday delivery notification You can use the additional service SA Saturday delivery to inform the recipient by SMS and or e mail about the scheduled delivery on the next Saturday The standard notification free text is not supported is triggered after data transmission Evening delivery same or following day You can use the additional service AZS Evening delivery and the corresponding basic function to inform the recipient by SMS and or e mail about the scheduled evening delivery on the follow ing day PRI or following days ECO or on the same day The standard notification free text is not supported is triggered after data transmission 2 2 1 Overvievv of notification services Notification services are currently available for the follovving DLG Parcel Express Courier and Solutions services Basic services Proof of Delivery Collection Reminder Hando
67. s Post ISR With transaction type 1 yellow Account IS only the COD amount is reguired With transaction type 2 Swiss Post ISR both the COD amount and the ISR reference number is reguired ISR reference number For the ISR reference number the following data format is valid excerpt from the PostFinance manual on Record Structures electronic Services www postfinance ch content dam pf de doc consult manual dldata efin_recdescr_man_en pdf mandatory The reference number is printed on the processing document in blocks of 5 whereby leading zeros can be suppresses The details must be entered in the field with right alignment empty positions must be extended with leading zeros Reference numbers with the value O zero will be rejected We recommand that you recalculate and compare the check digit modulo 10 recursive 33 Yellovv Account vvith inpayment slip TransactionType 1 Cardinality Type Description Example if appropriate AdditionallNFOS Content holder AdditionalData 0 20 Content holder Type TA String 0 35 Field for COD amount NN BETRAG Value 13 String 0 50 COD amount must be separated by decimal point 150 50 comma not allovved Svviss Post ISR TransactionType 2 Cardinality Type Description Example if appropriate AdditionallNFOS Content holder AdditionalData 0 20 Content holder Type TL String 0 35 Field for COD amount NN BETRAG Value EN String 0 50 COD amount must
68. se a larger presentation format 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 The desired service group is invalid The desired basic service is invalid The stated presentation type 0 is invalid The stated service code 0 is invalid for the desired service group 1 The stated presentation type 0 is invalid for the desired service group 1 An additional service with COD amount must be selected N BLN No valid basic service codes could be found in the list of service codes 0 The presentation time 0 is invalid for the basic service selected 1 A valid recipient address must be stated A domicile post office must be provided The COD amount must be provided for COD items N BLN The ISR reference number for the electronic COD BLN is invalid Please check the format and check digit A telephone number must be provided for the delivery instruction Notify delivery by telephone ZAW3213 A valid delivery date must be stated for the delivery instruction Specific delivery date deliver on ZAW3217 A parcel number and a parcel total must be provided for the delivery instruction Deliver when all items have arrived ZAW3218 A deposit point must be provided for the delivery instr
69. sions Weight on Integer Weight in grams limited to 5 digits for LQ additional service 12500 0 99 999 Hazardous goods UNNumbers 0 1 2 Content holder for UN number for the LQ hazardous goods additional service UNNumber n Integer List of UN numbers limited to 4 digits for LO additional service 1234 1235 0 9 999 hazardous goods 1236 Notification omis Generate List of notification services Notification Type UN String Means of communication SMS or EMAIL Mail SMS Service TI Integer 0 20 Service code 12128 FreeText1 0 String 0 160 Free text 1 Test 1 FreeText2 0 1 String 0 512 Free text 2 Test 2 Language 1 Language Language DE FR T or EN Communication EN Generate Content holder for communication medium Email or Communication Mobile Email 0 1 String 0 160 E mail address a b ch Mobile OF String 9 20 Mobile number 41791234567 32 Key 1 Domestic Parcels Swiss Express Swiss Courier 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 ItemlD ItemNumber and IdentCode fields FrankingLicence Mandatory left pad with zeros up to 8 digits ItemlD Optional any value ItemNumber Optional any value If
70. t delivery to an upper floor delivery instructions Specific delivery date deliver on PI 2 Service specifications The most important functions of the Barcode web service at a glance Generation of barcodes for vvhich 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 x 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 Data Transfer 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 reguired 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 pr
71. t here www swisspost ch post barcode cug Cardinality Type Description Example if appropriate GenerateBarcode Generate Root element of Generate barcode operation Barcode Language 1 Enumeration Language in vvhich the service is activated de de fr it en BarcodeDefinition 1 Barcode Content holder for the barcode definition Definition BarcodeType Enumeration Barcode type to be generated LSO_1 1450 11 ao 2 ISOR ImageFileType 2 String 1 5 Address label file format PDF a zA Z 0 9 1 5 ImageResolution GO nteger Address label resolution in DPI dots per inch 300 36 5 4 2 Generate barcodes response Generate Barcode You can download an XML example as vvell as a graphical interface description per response here www swisspost ch post barcode cug Cardinality Type Description Example if appropriate GenerateBarcode Response BarcodeResponseData Barcode DeliveryNoteRef BarcodeDefinition BarcodeType ImageFileType ImageResolution ColorPrintRequired Errors Error Code Message Warnings Warning Code Message GenerateBarcode Response BarcodeResponse Data Binary Base64 String 50 BarcodeDefinition Enumeration dao 21 ESOL LSO 3 String 1 5 a zA Z 0 9 1 5 Integer Boolean MessageType String 5 DALE 110 914 String 0 500 WarningsType MessageType String 5 DALE 110 914 String 0 500
72. t without reguesting the delivery instruction Deposit consignments ZAW3219 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 Generation of the addressee will require too much time with the requested presentation type 0 and resolution 1 PP franking is ignored for the basic service 0 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 Free text 2 cannot be used with SMS notifications Free text 2 has been ignored Free text is not reguired in the notification 0 Free text 1 and 2 have been ignored No delivery information can be found for these address details Please ensure that your address details are correct and complete 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 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 For an A6 label with 2 ZAWs the sender s address is truncated to 20 characters per line in ZPL2 format For the chosen presentation type the recipient is restricted to 0 lines Name3 vvill be i
73. te Combination operation Validate Combination reguest Validate Combination response Generate Label operation Generate Label Generate Label reguest Generate Label Generate Label response Generate Label Generate barcodes operation Generate Barcode only relevant for letter products Generate barcodes reguest Generate Barcode Generate barcodes response Generate Barcode Generate single barcodes operation GenerateSingleBarcodes only relevant for domestic letter products Generate single barcodes reguest GenerateSingleBarcodes Generate single barcodes response GenerateSingleBarcodes Read Service Groups operation ReadServiceGroups Read Service Groups reguest ReadServiceGroups Read Service Groups response ReadServiceGroups Read Basic Services operation ReadBasicServices Read Basic Services reguest ReadBasicServices Read Basic Services response ReadBasicServices 20 20 20 20 20 20 20 21 22 24 25 25 25 25 25 26 26 26 27 27 28 28 29 29 29 35 36 36 37 38 38 40 42 42 42 43 44 44 5 8 5 8 1 5 8 2 5 9 5 9 1 5 9 2 5 10 5 10 1 5 10 2 5 11 5 11 1 5 11 2 5 12 5 13 6 1 6 2 6 3 Read Additional Services operation ReadAdditionalServices Read Additional Services request ReadAdditionalServices Read Additional Services response ReadAdditionalServices Read Delivery Instructions operation ReadDeliverylnstructions for Domestic Parcels Swiss Express Swiss Co
74. tem ItemlD ItemNumber IdentCode Recipient Postldent Title PersonallyAddressed Name Firstname Name2 Name3 AddressSuffix Street HouseNo POBox FloorNo MailboxNo ZIP City Country Phone Mobile EMail LabelAddress LabelLine E EI GenerateSending String 0 50 Generateltem String 0 200 String 0 8 0 9 1 8 String 0 50 Generate Recipient String 0 15 String 0 35 Boolean ring 0 35 0 35 ring 0 35 ring 0 35 Go DOS Ween EOS 5 0 35 String 0 35 String 0 10 S S ring 0 35 ring 0 5 Integer 0 10 String 0 10 String 0 35 String 2 2 21 2 String 0 20 String 0 20 String 0 160 LabelAddress String 0 35 Content holder ID assigned by customer at request level is returned unchanged in the response If no SendinglD is supplied VVSBC generates a random number Content holder per address label ID assigned by customers at address label level will be returned unchanged in the response Mailing number Mailing code For use by Swiss Post internal systems only In systems external to Swiss Post this field is ignored and a warning returned Content holder with recipient details Postal identification Salutation When set to FALSE indicates the company first then the recipient on the address label Toggles to TRUE Default T
75. 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 24 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 Courier and Solutions service groups the mailing data is automatically transferred to Data Transfer This means that you receive the same benefits as you would under DataTransfer 2 1 3 Operation Generate single barcodes Operation Gener
76. ts LabelLayout d String 2 Layout of the address label A5 Data US Container for elements Provider b Container for elements Sending 1 Container for elements Item EN Container for elements per label temiD 0 1 String 0 50 D assigned by customer on the label level copied over from the request Country omi String 2 Optional ISO country code If not CH or LI the country specific US validation is performed Errors oz Container for error messages Error scht Container for error message Code 1 String 0 5 Error code E0012 Message 5 String 0 500 Description of the error in the language used for the call VVarnings 0 1 Container for warnings Warning dd Container for warning Code E String 5 VVarning code VVO012 Message String 0 500 Description of the warning in the language used for the call 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 29 Cardinality Type Description Example if appropriate GenerateLabel GenerateLabel Root element of Generate address label operation Language 1 Enumeration Language in which the service is activated de de fr it en Envelope 1 GenerateLabel Content holder Envelope LabelDefinition e GenerateLabel Content holder with address label details Definition LabelLayout a String 2 a z
77. uction Deposit consignments ZAW3219 No franking licence was indicated This account is not authorized to purchase addresses for the franking licence 0 The consignment number provided is outside the area of validity 1 0 The desired picture format 1 is not offered Please select a valid picture format 1 51 Error message English E2013 E2014 E2015 E2016 E2017 E2018 E2019 E2020 E2021 E2022 E2023 E2024 E2025 E2026 E2027 E2028 E2029 E2030 E2031 E2032 E2033 E2034 E2035 E2036 E2037 E2038 E2039 E2040 E2041 E2042 E2043 E2044 E2045 E2047 E2049 E2050 E2051 E2052 E2053 E2054 52 The desired resolution 0 dpi is not offered Please select a valid picture format 1 VinoLog deliveries are not possible for the desired recipient postcode 0 VinoLog deliveries in combination wtih evening delivery ZAW3229 are not possible for the desired recipient postcode 10 The consignment number provided is not unigue A valid sender address must be stated The indicated sender logo format 0 is not permitted The sender logo exceeds the maximum size of 0 KB The COD amount is outside the valid range Two COD amounts were indicated Please indicate the amount for COD items N in the ATT Amount field and in the REC DATA field for electronic COD items BLN The sender logo does not have an indexed colour palette The sender logo s indexed colour palette c
78. ul homologation or if you switch from shipping label to integration in the delivery note or vice versa the homologation process must be repeated The 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 or Courier items or Solutions Direct VinoLog you also send the completed customer sheet as detailed in section 7 Appendix 1 The Centre of Excellence for Packaging and Address Ouality or your contact person letter barcodes will check the design If any of the reguirements 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 Ouality CoE will also notify Barcode web service support staff directly who will then activate the Barcode web service for generat ing 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 guality reguired for homologation guickly 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 vvell defined print
79. urier and Solutions Read Delivery Instructions reguest ReadDeliverylnstructions Read Delivery Instructions response ReadDeliverylnstructions Read Label Layouts operation ReadLabelLayouts Read Label Layouts reguest ReadLabelLayouts Read Label Layouts response ReadLabelLayouts Read basic services of a franking licence operation ReadAllowedServices ByFrankingLicense Read basic services of a franking licence request ReadAllovvedServices ByFrankingLicense Read basic services of a franking licence response ReadAllowedServices ByFrankingLicense Error messages Warnings Further publications and useful links Publications on the Barcode web service Publications on the Track amp Trace web service Publications on DataTransfer for Letters with barcode BMB Appendix 1 Customer sheet on homologation of Parcel Express and Courier VinoLog and Direct consignments 45 46 46 47 47 48 49 49 49 50 50 50 51 54 55 55 55 55 56 1 Introduction VVSBC HB Brief description of the changes This manual is for business customers of Swiss Post who want to Version use the Barcode web service New operations Incorporated Read 2 1 3 basics services of a franking licence 2 1 5 and generate single barcodes The Barcode web service can be used for the following basic services Domestic parcel Swiss Express only Swiss Express Moon Swiss Courier only Swiss Couri
80. v ZA v x x GAS SP PRI Bulky goods Priority GAS X x v ZA x ZA v ZA v x x SEM Swiss Express Moon v ZA v ZA v ZA v ZA ZA X x SEM SP Bulky goods Moon Svviss Express Moon AND bulky goods Economy x X SKB Swiss Courier Lightning X ZA v ZA X ZA ZA ZA ZA X ZA SKB SP Bulky goods Lightning Swiss Courier Lightning AND Bulky goods Economy x v GAS SEM Svviss Express Moon GAS X X v ZA ZA ZA v ZA v X X GAS SKB Swiss Courier Lightning GAS X x ZA ZA X ZA ZA v v X X VL VinoLog v X x v x X v v x ZA ZA DIRECT Direct X v ZA X X ZA ZA ZA ZA X ZA 9 Direct can only be used in conjunction with AZS For Letters vvith barcode BMB domestic 5 designation RINL Registered R domestic ZA ZA ZA ZA ZA ZA APLUS A Mail Plus X x ZA x X ZA DISP Dispomail X x v x x v DISPE Dispomail Easy X x ZA x x ZA GU Court documents GU X x x x v v BU Debt collection documents BU X x x x v v APOST A Mail X ZA X ZA X X BPOST B Mail individual items X ZA x ZA x x d permitted X not permitted 45 For Letters with barcode BMB international DLC UT d service bei designation RETR PRI Registered international PRIORITY Depends Depends on country on country and AR RETR ECO Registered international ECONOMY ZA x Depends Depends v on country on country and AR d permitted X not permitted 5 8 1 Read Additional Services request ReadAdditionalServices You can download an XML example as well as a graph
81. ver Exchange Saturday Evening Evening posting information information to recipient status to return delivery delivery delivery Service Service Service Service sender Service Service following same day code 1 code 2 EECH code 32 Service code 128 code 256 days Service code 64 Service code 258 code 257 PostPac Economy v v ZA v v v Bulky goods Economy ZA v v ZA v v PostPac Priority v v v v v v v v Bulky goods Priority ZA v ZA ZA v ZA v v PostPac Promo v v ZA v v Swiss Express Moon ZA v ZA ZA v Bulky goods Moon v ZA v v v Swiss Courier ZA ZA v ZA Lightning Bulky goods v v v v Lightning VinoLog v v v v v v v Direct v v v ZA Free text supported v v v 9 Notification services cannot be used for basic services with business reply labels 17 3 Registration homologation and support Registration for and activation of the Barcode vveb service VVSBC is carried out in the following steps 3 1 1 Registration and activation of Barcode vveb service To register for the Barcode vveb service please contact your customer advisor Access to My Post Business which is opened during registration is reguired to use the Barcode web service Once the Barcode web service has been activated you will receive an e mail from Web Service Support with the access data for calling up the WSBC technical user name password franking licence numbers and links fo
82. wise by 90 We recommend using a black and white logo for printing in the ZPL2 format 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 vvork the printer models used must support ZPL2 as a printer language othervvise the quality requirements for homolo gation of the labels vvill not be met Ideally you should use one of the printer models we have already homologated To ensure adeguate barcode print guality you should always use high quality shipping label materials An overview of our homologated printer models is available at www swisspost ch post mypostbusiness auftrag druckermodelle Note also that shipping labels are printed in either landscape or portrait format depending on the specifications of the homolo gated printer models Further information on homologation and achieving the desired guality can be found in section 3 1 3 25 5 Appendix Barcode vveb service interface SA Overview of service codes DLC o 5 1 1 Overvievv for service codes DLC Domestic Parcels Svviss Express Svviss Courier and Solutions Technical errors e g validation errors are returned as error elements in the response A response may contain vvarnings as The service descriptions for the follovving basic and additional well as the desired response e g several vvarni

Barcode web service manual

Contents

Download Pdf Manuals

Related Search

Related Contents