Import service

Imports mailitems

Import mail items

Imports new and existing mail items.

Access to this method is authorized by the Import mail items operation.

Securityips_token

Request

Request Body schema: application/json

AdditionalFeesCurrencyCd	string
AdditionalFeesValue	number
	object (Addressee)
ClassCd required	string
Content	string
CurrencyCd	string
CustomNo	string
	object (CustomsTaxInformation)
DestCountryCd	string
DutiableInd	string
DutiableValue	number <float>
InnrbagId	string or null
required	Array of objects (ItemEvents)
ItemId required	string
ItemWeight	number <float>
	object (Letter)
	object (Parcel)
LocalId	string
Misc1	string
Misc2	string
Misc3	string
Misc4	string
MrsExpirationDate	string or null
MrsOriginalId	string or null
MrsStatus	string or null
NetworkEntryLocationTypeCd	string
OperatorCd	string
OrigCountryCd required	string
PostagePaidCurrencyCd	string
PostagePaidValue	number
PostalStatusFcd	string
ProductTypeCd	string or null
RecptclId	string or null
	object (Sender)
	object (ServiceTypes)
Value	number

Responses

200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/ImportService.svc/rest/Mailitem

Request samples

Payload

application/json

Request to import a letter

{"ItemId": "LE22101702XPL",
"ClassCd": "U",
"OrigCountryCd": "PL",
"Letter": {"InsuredValue": 16.5,
"InsuredSDRValue": 3.2,
"RouteInstructionCd": "BA",
"SenderInstructionCd": "RD",
"LetterCharacteristicCd": "IB",
"CoDValue": 15.54,
"CoDCurrencyCd": "CHF",
"CoDInd": 1,
"ExemptInd": 0,
"ExpressInd": 0,
"DeliveryProofInd": 0,
"ConveyanceTypeCd": "P",
"InsuredCurrencyCd": "CHF",
"MailCategoryCd": "A",
"MailItemCategoryCd": "AC",
"ReturnDelay": 123
},
"ItemEvents": [{"TNCd": "30",
"Date": "2019-01-02T01:11:00",
"OfficeCd": "PLWAWA"
}
]
}

Response samples

application/json

{"Mailitem": {"AdditionalFeesCurrencyCd": "EUR",
"AdditionalFeesValue": 2,
"Addressee": {"Name": "John Doe",
"Forename": "Joe",
"Address": "Welpoststrasse 4",
"City": "Bern",
"Postcode": "3015",
"Country": "DE",
"Title": "MS",
"CountrySubEntity": "CH",
"PhoneNo": "+417777777777",
"FaxNo": "+418888888888",
"Email": "testrecp@test.com",
"NotificationMethod": "E",
"NotificationTypes": {"NotificationTypeCd": "ND"
},
"HouseNumber": "hn1",
"HouseNumberExtension": "hext1",
"CustomerLanguage": "ENG",
"AltDelivAddressCityTown": "Bern",
"AltDelivAddressHouseId": "204",
"AltDelivAddressLine_1": "Welpoststrasse 4",
"AltDelivAddressLine_2": "Welpoststrasse 4",
"AltDelivAddressPostcode": "3006",
"CodBIC": "BICXXX",
"CodIBAN": "IBAN1234",
"ConsumerRegNumber": "REG12345",
"CustomerChargArrangement": "DDU",
"AddressLine_2": "Welpoststrasse 4",
"IntendedDeliveryLocationType": "",
"DeliveryServiceType": "1",
"PickUpPointId": "PKUP",
"MailSourceExport": "201",
"POBox": null,
"PosteRestanteInd": null,
"StreetName": null
},
"ClassCd": "U",
"Content": "D",
"CurrencyCd": "EUR",
"CustomNo": "abccust",
"CustomsTaxInformation": {"AccompanyingDocuments": [{"DocumentTypeCode": "380",
"Identifier": "01/01/2021-1",
"Name": "Invoice"
}
],
"ContentPieces": [{"DeclaredValue": 12,
"DeclaredValueCurrencyCode": "EUR",
"Description": "Toy-Sport-Jouet",
"Identifier": 123456,
"NetWeight": 1.5,
"NumberOfUnits": 1,
"OriginLocation": "CH",
"TariffHeading": "490110"
}
],
"DeclaredGrossWeight": 2.25,
"ItemNatureCode": "31",
"ItemNatureCodeDescription": [{"Code": 31,
"Description": "Gift"
}
],
"Observations": "ObservationsCustomsTaxInformation",
"RecipientCustomsReferenceNumber": "RecipientCustRef00001",
"SenderCustomsReferenceNumber": "SenderCustRef00001"
},
"DestCountryCd": "DE",
"DutiableInd": "100",
"DutiableValue": 12.55,
"InnrbagId": "PLWAWANLAMSAAUN90002001",
"ItemEvents": [{"TNCd": "1",
"SignatoryBase64": "iVBORw0KGgoAAAANSUhEUgAAACYAAAAmCAYAAACoPemuAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAWdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjFM78X/AAAIYUlEQVRYR+3Ye1BU9xUHcJp2+kc640xn2kn/i0ISEQ2Qsa4ICAZEERRRMUp4ZdpEU61J1SRGE7MxDxJj1ICQqGhqGg0ij7BA0k4yTadN7SQ+eMjyXpbXPmFhd1lTcVk9/Z7fvUvuLi40nSR2pr0zZ4SL3PvZc36/8/v9CPr/dbsutTroDq16/Y8pKOgH8q3bc5kPJP1EuydB1bY34fG23Q+ebX12ia7lmfgx7VNx2uadiwubdsSlaZ+K/8V3CuWH2z7OmuMK5EXZyzJf7Du88nznvqVfdbyQSO3PJ1DbngcJOGrdtYRano4n4Kh5x2K68rsYT9OTMU2N26KPNG2LXl2/LfbnnFn5sd/8IrX6Dpdm412jNXnrXLW5ryEuXK3N+yeCXJpcclZk0/AHG8n4djrpX19BHXsTBQ5ZI2SNtE/HkXbnYmrezrhYanoihhp/G00NW6LG6x+Paq3fHHXw4mZVxqVN839GNE1GOwuSZzirsvJcdXmnXLV5eoSHIbeK0Q9zyFGeRSPADf3hIbKeWEcDb60i3cvLROZ8sxZLV56MIWSMGrcybhEBR5c3LaTLj6rcF361oO3CI78suPiYaplM8b3M76SrzMfW0uDvM2ikNJNGq3NuiRJRk0fOqmyylz1Mw2eAe2+9wJmOriHDkTQpiyhzG8rcU5RG7epEQknlrC2iht9EUf3mhSIaty4SeIzLdpnie5lL0lXG4tXUf3glGYvTEavJfHwt2d7fQM7K7Ek4qaRZZD+bSbbTG/CB1pOlZC2ZUF7zuxl09cstdNP8LNHgHiLrbrqmfYIsZzdQx76lAsIZ5dK37kJ2UXZ8f2uYrSRDNVCwSgxgLkfXS8uo980UGihMI75vKFotsslZctXkChxnVZQUGbZxSQHirPOHMiCspRtp9PNNNN65nTzaLXT90w1kfzeZ2p9LEGORx97lx1QiAsNOZagMQEifQvok/Mv8dad6qShP36FU6juYKrJqPrZGlJFh9nOTS8ofpueNFaR7ZTlZj6XSWFUaXStLoZFjSaKUl4C59Cji1wsw3qaDISti2vvhvIOZ/+3AuNG9sgwvTREv7tm/AlldJTI1iIxxtnoPpFB3fjJ1A9WJ8WUqWkFjNWsEbgQZEwPfC0Pw9y3PBIKdyRBjbKInyTgBQ3TlRwucdqc02zBYpZLvS5IQCP3ryQLaJc9Ono0NGNz9h5fT2EcZZDuZQl0vxEswBY4nwRSwTBX3JR+YjOs7qiJ3dzDp3ozyxXFsRztAcMkYxeNHtAbMQBGAtezi/x8rzUa0CoZIOMCA43stu+IDw0zvpIsHK3G9RVE0rg8mj2EWXW28T7xEwskwGdf9KmAooYBMKE/g0LsYN9EmGOaHq8f9gDBHGWAY0BMwRG/BIhrXAdU/izzGWXTDMpMsFZFSZ/fD6V9LxthKFUuUBPPFcUkD4bAiTA3jvsUPZlzP4Wi63hZCnh6gFLBx06yvx5sCx2XkGcvLk+j0Mg7r5LQ4vofqBIBVZaosJeskGMKmiSB3G7LFsD4ESukxz6Qb1pnkuhgqJoRyvPFM7Du0UoJ5l6FJOBmmxAHG91t3B4TlArZWPNiL61AvIdc/5pCnV84a45AxDsN78xUljUMzlvobtwcB88EB5Y8DzIvj+wFhX9Xmqqwn14k1bgKHkjo+m0sePTBenBzXu0IAx9Ii4zhb3FS5GYuZKsN8cHJJ/ScDZ3VKGDdIL8yLc/x5LiYAMIxDWcfRNrr3x5C1PJIGqyKk5gtcP3YXvHx1vgiYPFP9S3qrydC4VYK175kGxp9YmTXHp/Ow1gMKhQDQ3RmMGTt5ZWAU7yy44Uowecvjh/OW9MqOKOp64wHSF4bjZ9GAJUxRShmmxDk+AQyTYLwd0QEYvhYwv5WBlzNeObpeSvq6jfjhsKMVOItmNhlOzyVj6RzqKQ4XP8OwmWqMAYZSKHGOPwGmBaoF0RpMbm0IHjJ52WIUrxy8HPmvDM07Y0hf8ACZK+ZglYgmxxfBZCqfQ8YyGQb4tDAuhRLn+CNgV4BqlsLd5AeTcbxqcPAC79NGiiMxHkNpqO4+smpCcc8P9na4wKM6U5eSS6HEOT66n9wNADUyClEP2PPSyqDMGm+DeLvDS5NyZTCcvJ8GK2fTUC1g1RLMfh6wsjAylYb9hzCEow6wSwBdZlQwXb+INuGFKXAWrBq8cjDMO1MZxzBrBWAawKoAQ1ntfw0RKNMHYcgoYMgshk1gmO39h8QuQYkb/Xgeub8MIfcFDsC+AGyv1OOUON4gcoPuxprpnakCdiJcKmU1YBUy7DPAzoSR8TRgRREiswFh1zTZ92DL3M0nIAteIvZVwPUdiiN7ZQSNfX4vuYEa+/u9EkxuwF4ctxpu0LyYe2EchpJwGiwLFeW0nAsFNpZGPgEMKOOpeaTHVgqoGx3qpRUyZfJF59b/0KV5JAmnoHIgXcM4ZPAyw0DdywlkPqEiZ91cPEiGKXCDp7CtBo43ixNthGHHGTabBssBQ3tg2FBlGPUXR5Pu1UQnzhYnOtRJkXj9v3dip7qHfwrcdkSDvTzrpphxaAW8Fnp7nBLG50s+KfF2m2He5ms4ClgpYGdDgVyAoZJ0E7vd9u785Ts61ckz5Nd984tPylfr8iIBPI4jm028HGWegMk4PsINIWu9OAt4Zyrj+gvnk6lkIfUeXO7G71Xr9icn8klffvy3cxlrNt3p1ORmA/i34dKN43z6xtgQOHFKQtZ4+8OTgeE83voPpppwDMzXH0i5W37Md3tZy7LvcVbn5Dsqswzcw/gIx4dj3mHgmHcDJ6fzAwUrc/hPU/KvfL8X/SX+R8OVWamO6pwPARvG0nRyoHBNhPzj/47rtv/R7n/4Cgr6Fz6wfMYSzMlVAAAAAElFTkSuQmCC",
"SignatoryBase64Ext": "png",
"Date": "2019-01-01T01:11:00",
"OfficeCd": "CHZRHB",
"UserFid": "INTERNAL\\\\tannerh",
"WorkstationFid": "PC10117009",
"ConditionCd": "30",
"AttemptedDeliveryLocation": null,
"CustomsOfficeCd": null,
"CustomsOfficeTypeCd": null,
"CustomsReleaseStatusCd": null,
"DelivLocation": null,
"DeliveryAgent": null,
"DeliveryTypeCd": null,
"LodgementModeCd": null,
"MailSourceCd": null,
"NextOfficeFcd": null,
"NonDeliveryMeasure": null,
"NonDeliveryReason": null,
"RetentionReasonCd": null,
"SignatoryNm": null,
"TransitDirectionCd": null,
"CollectionPostcode": null
}
],
"ItemId": "RR23010110XMK",
"ItemWeight": 1,
"Letter": {"InsuredValue": 16.5,
"InsuredSDRValue": 3.2,
"RouteInstructionCd": "EC",
"SenderInstructionCd": "RD",
"CoDValue": 15.54,
"CoDCurrencyCd": "CHF",
"CoDInd": 0,
"ExemptInd": 0,
"ExpressInd": 0,
"DeliveryProofInd": 0,
"ConveyanceTypeCd": "P",
"InsuredCurrencyCd": "EUR",
"MailCategoryCd": "A",
"MailItemCategoryCd": "FC",
"ReturnDelay": 123,
"LetterCharacteristicCd": "AL"
},
"Parcel": {"InsuredValue": 16.5,
"InsuredSDRValue": 3.2,
"RouteInstructionCd": "EC",
"SenderInstructionCd": "RD",
"CoDValue": 15.54,
"CoDCurrencyCd": "CHF",
"CoDInd": 0,
"ExemptInd": 0,
"ExpressInd": 0,
"DeliveryProofInd": 0,
"ConveyanceTypeCd": "P",
"InsuredCurrencyCd": "EUR",
"MailCategoryCd": "A",
"MailItemCategoryCd": "FC",
"ReturnDelay": 123,
"ParcelRate": 0,
"ParcelDue": 0
},
"LocalId": "RR23010110XMK_LOCAL",
"Misc1": "misc111",
"Misc2": "misc112",
"Misc3": "misc113",
"Misc4": "misc114",
"MrsExpirationDate": "2019-01-02T01:11:00",
"MrsOriginalId": "R",
"MrsStatus": "N",
"NetworkEntryLocationTypeCd": "3",
"OperatorCd": "CHA",
"OrigCountryCd": "CH",
"PostagePaidCurrencyCd": "EUR",
"PostagePaidValue": 2,
"PostalStatusFcd": "MINL",
"ProductTypeCd": "K",
"RecptclId": "PLWAWANLAMSAAUN90002001100050",
"Sender": {"Name": "John Doe",
"Forename": "Joe",
"Address": "Welpoststrasse 4",
"City": "Bern",
"Postcode": "3015",
"Country": "CH",
"Title": "MS",
"CountrySubEntity": "CH",
"PhoneNo": "+41760000000",
"FaxNo": "41760000000",
"Email": "send@test.com",
"NotificationMethod": "E",
"NotificationTypes": {"NotificationTypeCd": "ND"
},
"HouseNumber": "22",
"HouseNumberExtension": "234",
"CustomerLanguage": "ENG",
"AltDelivAddressCityTown": "Bern",
"AltDelivAddressHouseId": "304",
"AltDelivAddressLine_1": "Welpoststrasse 4",
"AltDelivAddressLine_2": "Welpoststrasse 4",
"AltDelivAddressPostcode": "3015",
"CodBIC": "SBIC",
"CodIBAN": "SIBAN55555",
"ConsumerRegNumber": "REG12345678",
"CustomerChargArrangement": "DDU",
"AddressLine_2": "Welpoststrasse 4",
"IntendedDeliveryLocationType": "",
"DeliveryServiceType": "1",
"PickUpPointId": "POINT_1",
"MailSourceExport": "201",
"POBox": null,
"PosteRestanteInd": null,
"StreetName": "Welpoststrasse 4"
},
"Services": {"ServiceCd": "AA"
},
"Value": 11
}
}

➔ Next to Inquiry service