Documentation SOAP

Bulkmail webservice

Summary

  • Name: BulkMail web service
  • Reason to Call: Give advance notification for and present a shipment
  • Input: Shipment information, mailing Address file
  • Output: Verified and sorted advance notification file, presenting form

Methods

PreAdviceBulkMailOrderGive advance notification of a shipment
ValidateAdressAttachmentVerify an address file
GetValdiationResultDownload files for unsorted products
ValidateAndSortAddressAttachmentSort an address file
GetValidationAndSortingResultDownload files for sorted products
GetPackagingInformationDownload PackagingCards
TenderBulkMailOrderPresent a shipment

Call details

Certificate

The certificate is a “pfx” file: “xxx.pfx”; these will be communicated via mail

WSDL of the test environment (a/pat environment)

https://b2b-2.mijnpost.pat.postnl.nl/B2BService.svc?wsdl

URL Bulkmail web service

https://b2b-2.mijnpost.pat.postnl.nl/B2BService.svc

URL of the MijnPost test environment (a/pat environment)

https://ppo.waz.mijnpost.pat.postnl.nl

Login account and password for MijnPost

These will be communicated via mail

Versioning

API

Version

Release Date

Status

Release Notes

Schema Changes

Bulkmail web service

1_0

Oct 01, 2012

Supported

 

 

1_1

Oct 28, 2014

Current Version

Different namespaces

Yes

Starting

Message Implementation Guides

Explanation of message fields

Products

Business rules

PreAdviceBulkMailOrder

The message below has been created with the SoapUI tool.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mij="http://mijnpost.postnl.business2business/" xmlns:ns="urn:mijnpost.postnl.business2business/1" xmlns:hum="http://schemas.datacontract.org/2004/07/Humiq.MyTNT.B2BService.Common.V1" xmlns:sys="http://schemas.datacontract.org/2004/07/System.Xml" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <soapenv:Header/> <soapenv:Body> <mij:PreAdviceBulkMailOrderV2> <mij:preAdviceMessage> <ns:BulkMailOrders> <hum:BulkmailOrderType> <hum:AlternateDocumentID> <hum:DocumentIDType> <hum:ID> <hum:Value>nieuwAlternateDocumentid</hum:Value> </hum:ID> <hum:RevisionID> <hum:Value>?</hum:Value> </hum:RevisionID> <hum:VariationID> <hum:Value>?</hum:Value> </hum:VariationID> </hum:DocumentIDType> </hum:AlternateDocumentID> <hum:DocumentDateTime>?</hum:DocumentDateTime> <hum:FileName> <hum:Value>document.pdf</hum:Value> </hum:FileName> <hum:FileSizeQuantity> <hum:Value>?</hum:Value> <hum:unitCode>?</hum:unitCode> </hum:FileSizeQuantity> <hum:FileType> <hum:CodeType1> <hum:Value>PDF</hum:Value> </hum:CodeType1> </hum:FileType> <hum:Title> <hum:TextType1> <hum:Value>?</hum:Value> </hum:TextType1> </hum:Title> <hum:UserArea> <hum:Any> <sys:XmlElement> </sys:XmlElement> </hum:Any> </hum:UserArea> <hum:Consignment> <hum:ConsignmentType> <hum:AlternateConsignmentID> <hum:Value></hum:Value> </hum:AlternateConsignmentID> <hum:ConsignmentContract> <hum:ContractID> <hum:Value></hum:Value> </hum:ContractID> <hum:ContractPositionID> <hum:Value></hum:Value> </hum:ContractPositionID> </hum:ConsignmentContract> <hum:ConsignmentID> <hum:Value></hum:Value> </hum:ConsignmentID> <hum:ConsignmentPhysicalData> <hum:AddressLabelingTypeCode> <hum:Value>1</hum:Value> </hum:AddressLabelingTypeCode> <hum:MailingWrapperFinishingTypeCode> <hum:Value>1</hum:Value> </hum:MailingWrapperFinishingTypeCode> <hum:MailingWrapperTypeCode> <hum:Value>5</hum:Value> </hum:MailingWrapperTypeCode> <hum:PhysicalDataFormatCode> <hum:Value>21</hum:Value> </hum:PhysicalDataFormatCode> <hum:PhysicalDataLength> <hum:Value>140</hum:Value> </hum:PhysicalDataLength> <hum:PhysicalDataProductWeight> <hum:Value>200</hum:Value> </hum:PhysicalDataProductWeight> <hum:PhysicalDataQuantity> <hum:Value>50000</hum:Value> </hum:PhysicalDataQuantity> <hum:PhysicalDataThickness> <hum:Value>30.6</hum:Value> </hum:PhysicalDataThickness> <hum:PhysicalDataWidth> <hum:Value>160</hum:Value> </hum:PhysicalDataWidth> </hum:ConsignmentPhysicalData> <hum:ConsignmentProcessing> <hum:ConsignmentDeliveryDateSpecified>true</hum:ConsignmentDeliveryDateSpecified> <hum:ConsignmentShippingDate>2016-02-22</hum:ConsignmentShippingDate> <hum:ConsignmentShippingDateSpecified>true</hum:ConsignmentShippingDateSpecified> <hum:DestinationCountryCode> <hum:Value></hum:Value> </hum:DestinationCountryCode> <hum:DestinationZone> <hum:Value></hum:Value> </hum:DestinationZone> <hum:KIXIndicatorSpecified>true</hum:KIXIndicatorSpecified> </hum:ConsignmentProcessing> <hum:CustomerConsignment> <hum:ConsignmentAuthorizationNumber> <hum:languageCode>?</hum:languageCode> <hum:markupLanguageCode>?</hum:markupLanguageCode> </hum:ConsignmentAuthorizationNumber> <hum:ConsignmentCharacteristics> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>ORIK-1</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>voorbeeld handleiding </hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>ORIK-2</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value></hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>ORIK-3</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value></hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> </hum:ConsignmentCharacteristics> <hum:ConsignmentIssueNumber> <hum:Value>editienr-1</hum:Value> <hum:languageCode>?</hum:languageCode> <hum:markupLanguageCode>?</hum:markupLanguageCode> </hum:ConsignmentIssueNumber> </hum:CustomerConsignment> <hum:ItemID> <hum:ItemIDType> <hum:ID> <hum:Value>2835</hum:Value> </hum:ID> </hum:ItemIDType> </hum:ItemID> </hum:ConsignmentType> </hum:Consignment> <hum:CustomerParty> <hum:PartyIDs> <hum:ID> <hum:IdentifierType1> <hum:Value>9915811</hum:Value> </hum:IdentifierType1> </hum:ID> </hum:PartyIDs> </hum:CustomerParty> <hum:ShippingParty> <hum:PartyIDs> <hum:ID> <hum:IdentifierType1> <hum:Value>9915811</hum:Value> </hum:IdentifierType1> </hum:ID> </hum:PartyIDs> </hum:ShippingParty> <hum:WorkLocation> <hum:LocationId> <hum:Value>10098</hum:Value> </hum:LocationId> </hum:WorkLocation> <hum:MergeConsignmentIndicator>true</hum:MergeConsignmentIndicator> <hum:ContractPositionID> <hum:Value>90</hum:Value> </hum:ContractPositionID> <hum:ContractDescription> <hum:Value>?</hum:Value> </hum:ContractDescription> <hum:ItemID> <hum:ItemIDType> <hum:ID> <hum:Value></hum:Value> </hum:ID> <hum:RevisionID> <hum:Value>?</hum:Value> </hum:RevisionID> <hum:VariationID> <hum:Value>?</hum:Value> </hum:VariationID> <hum:agencyRole>?</hum:agencyRole> </hum:ItemIDType> </hum:ItemID> <hum:languageCode>?</hum:languageCode> <hum:markupLanguageCode>?</hum:markupLanguageCode> <hum:ConsignmentPeriodicalName> <hum:Value></hum:Value> </hum:ConsignmentPeriodicalName> </hum:BulkmailOrderType> </ns:BulkMailOrders> <ns:MessageHeader> <hum:Message> <hum:ErrorMessages> <hum:Result> <hum:ErrorCode>?</hum:ErrorCode> <hum:ErrorMessage>?</hum:ErrorMessage> </hum:Result> </hum:ErrorMessages> <hum:IsTestOrder>false</hum:IsTestOrder> <hum:IsTestOrderSpecified>true</hum:IsTestOrderSpecified> </hum:Message> </ns:MessageHeader> </mij:preAdviceMessage> </mij:PreAdviceBulkMailOrderV2> </soapenv:Body> </soapenv:Envelope>

ValidateAdressAttachment

The message below has been created with the SoapUI tool. 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://mijnpost.postnl.business2business/" xmlns:icta="http://schemas.datacontract.org/2004/07/ICTA.VenS.Sorteren.B2BService" xmlns:hum="http://schemas.datacontract.org/2004/07/Humiq.MyTNT.B2BService.Common.V1" xmlns:sys="http://schemas.datacontract.org/2004/07/System.Xml" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <soapenv:Header/> <soapenv:Body> <tem:ValidateAddressAttachmentV1> <tem:request> <icta:AddressAttachment> <hum:Consignment> <hum:ConsignmentType> <hum:ConsignmentContract> <hum:ContractDescription> <hum:Value>?</hum:Value> <hum:languageCode>?</hum:languageCode> <hum:markupLanguageCode>?</hum:markupLanguageCode> </hum:ContractDescription> <hum:ContractID> <hum:Value>?</hum:Value> <hum:schemeAgencyID>?</hum:schemeAgencyID> <hum:schemeAgencySchemeAgencyID>?</hum:schemeAgencySchemeAgencyID> <hum:schemeAgencySchemeID>?</hum:schemeAgencySchemeID> <hum:schemeID>?</hum:schemeID> <hum:schemeVersionID>?</hum:schemeVersionID> </hum:ContractID> <hum:ContractPositionID> <hum:Value>?</hum:Value> <hum:schemeAgencyID>?</hum:schemeAgencyID> <hum:schemeAgencySchemeAgencyID>?</hum:schemeAgencySchemeAgencyID> <hum:schemeAgencySchemeID>?</hum:schemeAgencySchemeID> <hum:schemeID>?</hum:schemeID> <hum:schemeVersionID>?</hum:schemeVersionID> </hum:ContractPositionID> </hum:ConsignmentContract> <hum:ConsignmentID> <hum:Value>120482157893</hum:Value> </hum:ConsignmentID> </hum:ConsignmentType> </hum:Consignment> <hum:ExtraAttachment> <hum:ExtraAttachmentType> <hum:Attachment> <hum:EmbeddedData> <hum:Value>stringxxx</hum:Value> </hum:EmbeddedData> <hum:FileName> <hum:Value>voorbeeld.xlsx</hum:Value> </hum:FileName> <hum:FileType> <hum:CodeType1> <hum:Value>Excel</hum:Value> </hum:CodeType1> </hum:FileType> </hum:Attachment> <hum:AttachmentCharacteristics> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>SeparationCharacter</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>;</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>WorkSheetName</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>Ver_ngein_UIT</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>NumberOfHeaderRows</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>1</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>StreetNamePosition</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>1</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>BuildingNumberPosition</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>1</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>BuildingNumberExtensionPosition</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>1</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>PostalCodePosition</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>2</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>CityNamePosition</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>3</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>CountryCodePosition</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>0</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>CountryNamePosition</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>0</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> </hum:AttachmentCharacteristics> </hum:ExtraAttachmentType> </hum:ExtraAttachment> <hum:ProcessCode> <hum:Value>100</hum:Value> </hum:ProcessCode> <hum:ProcessedInputCharacteristics> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>SortOnPostalCodeBuildingNumber</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>true</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>TenderUnrecognizedAddresses</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>true</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>TransportEquipmentTypeCode</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>RCB</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>ThicknessMailPiece</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>1</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>MinimumNumberInABundle</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>5</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>MaximumNumberInABundle</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>10</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>MaximumWeigthTransportEquipment</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>300</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>SplitBetweenSCAndVBL</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>false</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>SeparationCharacterBundlesAndTransportEquipment</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>*</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>SeparationCharacterLocationInFile</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>First</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>SortingOrderSCActive</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>true</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>BundleStrapType</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>STRAPEX</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>CustomerReferenceInformation</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>CustomerReferenceInformation tekst</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>SortingCenterOrderPosition1</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>NIWG-GW</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>SortingCenterOrderPosition2</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>ZL-AF</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>SortingCenterOrderPosition3</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>ASD-AH</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>SortingCenterOrderPosition4</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>HT-S</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>SortingCenterOrderPosition5</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>GV-L</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>SortingCenterOrderPosition6</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>GV-L</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> </hum:ProcessedInputCharacteristics> <hum:ProcessedResultCharacteristics> <hum:CharacteristicType> <hum:CharacteristicName> <hum:Value>test</hum:Value> </hum:CharacteristicName> <hum:CharacteristicValue> <hum:Value>handleiding voorbeeld</hum:Value> </hum:CharacteristicValue> </hum:CharacteristicType> </hum:ProcessedResultCharacteristics> </icta:AddressAttachment> <icta:MessageHeader> <hum:CreationDateTime>2015-05-29T07:18:33.811Z</hum:CreationDateTime> <hum:SenderParty> <hum:ContactPerson> <hum:EmailURI> <hum:EmailURI> <hum:Value>?</hum:Value> <hum:schemeID>?</hum:schemeID> </hum:EmailURI> </hum:EmailURI> <hum:FaxNumber> <hum:PhoneNumber> <hum:AreaID>?</hum:AreaID> <hum:CountryCode>?</hum:CountryCode> <hum:CountryDiallingCode>?</hum:CountryDiallingCode> <hum:CountryName> <hum:Value>?</hum:Value> <hum:languageCode>?</hum:languageCode> </hum:CountryName> <hum:ExtensionID>?</hum:ExtensionID> <hum:SubscriberID>?</hum:SubscriberID> </hum:PhoneNumber> </hum:FaxNumber> <hum:InternalID> <hum:Value>?</hum:Value> <hum:schemeAgencyID>?</hum:schemeAgencyID> <hum:schemeID>?</hum:schemeID> </hum:InternalID> <hum:OrganisationFormattedName> <arr:string>?</arr:string> </hum:OrganisationFormattedName> <hum:PersonFormattedName> <arr:string>?</arr:string> </hum:PersonFormattedName> <hum:PhoneNumber> <hum:PhoneNumber> <hum:AreaID>?</hum:AreaID> <hum:CountryCode>?</hum:CountryCode> <hum:CountryDiallingCode>?</hum:CountryDiallingCode> <hum:CountryName> <hum:Value>?</hum:Value> <hum:languageCode>?</hum:languageCode> </hum:CountryName> <hum:ExtensionID>?</hum:ExtensionID> <hum:SubscriberID>?</hum:SubscriberID> </hum:PhoneNumber> </hum:PhoneNumber> </hum:ContactPerson> <hum:InternalID> <hum:Value>9915</hum:Value> <hum:schemeAgencyID>?</hum:schemeAgencyID> <hum:schemeID>?</hum:schemeID> </hum:InternalID> <hum:StandardID> <hum:PartyStandardID> <hum:Value>9915811</hum:Value> <hum:schemeAgencyID>?</hum:schemeAgencyID> </hum:PartyStandardID> </hum:StandardID> </hum:SenderParty> <hum:TestDataIndicator>false</hum:TestDataIndicator> <hum:TestDataIndicatorSpecified>false</hum:TestDataIndicatorSpecified> </icta:MessageHeader> </tem:request> </tem:ValidateAddressAttachmentV1> </soapenv:Body> </soapenv:Envelope>