Introduction
The XXX API exposes xxx functions.
This API reference explains each of the API endpoints, with example requests and responses in the right-hand column of the page.
Authorization
To use the XXX API, you need to include a token with each HTTP call (a GUID that is associated with one or more API operations).
Response codes
| Code | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request -- data in the request body is invalid |
| 401 | Unauthorized -- authorization failed |
| 500 | Internal Server Error -- an exception error occurred |
If an error or a code other than HTTP 200 is returned, see the response body for details (the format of an error response body is shown in the column on the right).
Response body format
{
Errors: [
"Error message 1", "Error message 2"...
]
}
XXX API methods
XXX import
Imports xxx.
HTTP request
POST http://[hostname]/Import.Service/ImportService.svc/rest/inquiry?token={token}
where {token} is the required GUID for authorization.
Example request
{
"Amount": "String content",
"CN08":{
"AddresseeAddress": "String content",
"AddresseeCity": "String content",
"AddresseeName": "String content",
"AddresseePostCd": "String content",
"AddresseeTelephone": "String content",
"AdviceOfReceipt": "String content",
"ArrivalDt": "String content",
"BulkAdvice": "String content",
"CODAmountNotCollected": "String content",
"CODAmountToGIroOffice": "String content",
"CODAmountToGiroAccount": "String content",
"CODAmountToSender": "String content",
"CODNotCollectReason": "String content",
"COdNotReceived": "String content",
"ContentDescription": "String content",
"ContentsMissing": "String content",
"Damaged": "String content",
"DeclarationReq": "String content",
"Delay": "String content",
"DestCODAmount": "String content",
"DestCODCurrency": "String content",
"DestCODDispDate": "String content",
"DestSign": "String content",
"DestSignDate": "String content",
"DestinationOE": "String content",
"DispSignature": "String content",
"DispatchBillNo": "String content",
"DispatchDepDate": "String content",
"DispatchId": "String content",
"DispatchList": "String content",
"DispatchMailCategory": "String content",
"DispatchOE": "String content",
"DispatchSerialNo": "String content",
"DispatchTransitDepDate": "String content",
"DispatchTransitMailCategory": "String content",
"DispatchTransitOE": "String content",
"ExpressItem": "String content",
"FinalDate": "String content",
"FinalReply": "String content",
"FinalReplyComment": "String content",
"FinalReplyRefNo": "String content",
"FinalSign": "String content",
"GiroAccount": "String content",
"GiroOffice": "String content",
"HandlingClassCd": "String content",
"IncompleteAdviceReceipt": "String content",
"InputDate": "String content",
"InsuredAmt": "String content",
"InsuredCurrency": "String content",
"ItemDeliveryDate": "String content",
"ItemDeliveryState": "String content",
"ItemDestInputDate": "String content",
"ItemFoundSentTo": "String content",
"ItemHeldAt": "String content",
"ItemHeldDate": "String content",
"ItemHeldReasonCd": "String content",
"ItemNotArrived": "String content",
"ItemRedirectAddress": "String content",
"ItemRedirectDate": "String content",
"ItemReturnCd": "String content",
"ItemReturnDate": "String content",
"ItemReturnedDate": "String content",
"ItemType": "String content",
"ItemWeight": "String content",
"LetterParcelBill": "String content",
"MailCategoryCd": "String content",
"OrigCODAmt": "String content",
"OrigCODCurrency": "String content",
"OrigCODInd": "String content",
"PriorityCd": "String content",
"ReceiptSeen": "String content",
"SenderAddress": "String content",
"SenderCity": "String content",
"SenderName": "String content",
"SenderPostCd": "String content",
"SenderTelephone": "String content",
"SignatureDate": "String content",
"SpecialList": "String content",
"TransitBulkAdvice": "String content",
"TransitDestinationOE": "String content",
"TransitDispSignature": "String content",
"TransitDispSignatureDate": "String content",
"TransitDispatchBillNo": "String content",
"TransitDispatchId": "String content",
"TransitDispatchList": "String content",
"TransitDispatchSerialNo": "String content",
"TransitLetterParcelBill": "String content",
"TransitSpecialList": "String content",
"UnexplainedReturn": "String content"
},
"CompensationTypeCd": "String content",
"DestOperatorCd": "String content",
"E3":{
"DestFlightNo": "String content",
"EMSAddresseeAddress": "String content",
"EMSAddresseeCity": "String content",
"EMSAddresseeName": "String content",
"EMSAddresseeNotified": "String content",
"EMSAddresseePostCode": "String content",
"EMSAddresseeTelephone": "String content",
"EMSArrivalDateAtDest": "String content",
"EMSArrivedAtDest": "String content",
"EMSAttemptDeliveryDate": "String content",
"EMSAttemptDeliveryOffice": "String content",
"EMSBagNo": "String content",
"EMSCurrency": "String content",
"EMSCustomDelayReason": "String content",
"EMSDestOE": "String content",
"EMSDestSign": "String content",
"EMSDispDepartDate": "String content",
"EMSDispId": "String content",
"EMSFinalDeliveryDate": "String content",
"EMSItemDelayed": "String content",
"EMSItemDeliveryState": "String content",
"EMSItemNotArrived": "String content",
"EMSItemOtherReason": "String content",
"EMSItemReturned": "String content",
"EMSItemValue": "String content",
"EMSItemWeight": "String content",
"EMSRecipientSign": "String content",
"EMSReturnDate": "String content",
"EMSReturnDispatched": "String content",
"EMSSenderAddress": "String content",
"EMSSenderCity": "String content",
"EMSSenderName": "String content",
"EMSSenderPostCode": "String content",
"EMSSenderTelephone": "String content",
"EMSSignature": "String content",
"FirstTransFlightNo": "String content",
"IsDocument": "String content",
"IsGift": "String content",
"IsMerchandise": "String content",
"Observations": "String content",
"OrigFlightNo": "String content",
"OverLabelledFid": "String content",
"SecondTransFlightNo": "String content"
},
"InquiryDate": "String content",
"InquiryDirection": "String content",
"InquiryEvents":[{
"InquiryEvtCd": "String content",
"InquiryEvtDt": "String content",
"OfficeCd": "String content",
"Offset":1.26743233E+15,
"ParsedDate":"\/Date(928142400000+0200)\/",
"UserFid": "String content",
"WorkstationFid": "String content"
}],
"InquiryNo": "String content",
"InternalComments": "String content",
"IsAmountInOwnCurrency": "String content",
"ItemId": "String content",
"MailClassCd": "String content",
"OrigOperatorCd": "String content",
"OwnCurrency": "String content",
"OwnPostEntity": "String content",
"PartnerOperatorCd": "String content",
"PostingDate": "String content",
"PostingOfficeCd": "String content",
"Reference": "String content"
}
XXX list
Retrieves a XXX list.
HTTP request
GET http://[host name]/APIService/ListService.svc/rest/dnl?agentId={agentid}&token={token}
where {agentId} is the agent code and {token} is the required GUID for authorization. If agentid is null, the response contains a delivery list for each agent who has mail items to deliver.
Example response (200)
{
"DeliveryAgentCode":"String content",
"Mailitems":[
{
"Identifier":"String content",
"LocalIdentifier":"String content",
"MailItemDeliveryInformation":{
"COD":{
"Amount":12678967.543233,
"Currency":"String content"
},
"DeliveryAddress":{
"Address":"String content",
"City":"String content",
"Forename":"String content",
"Name":"String content",
"PhoneNo":"String content",
"Postcode":"String content"
}
}
}
]
}
Success
If successful, this method returns an HTTP 200 response with items grouped by agent. If agent is null, the structure is repeated for each agent listed.
XXX export
Exports new and existing XXX.
HTTP request
POST http://[host name]/APIService/ExportService.svc/rest/Item?token={token}
where {token} is the required GUID for authorization.
Example request
{
"AdditionalFeesCurrencyCd":"String content",
"AdditionalFeesValue":12678967.543233,
"Addressee":{
"Address":"String content",
"AddressLine_2":"String content",
"AltDelivAddressCityTown":"String content",
"AltDelivAddressHouseId":"String content",
"AltDelivAddressLine_1":"String content",
"AltDelivAddressLine_2":"String content",
"AltDelivAddressPostcode":"String content",
"City":"String content",
"CodBIC":"String content",
"CodIBAN":"String content",
"ConsumerRegNumber":"String content",
"Country":"String content",
"CountrySubEntity":"String content",
"CustomerChargArrangement":"String content",
"CustomerLanguage":"String content",
"DeliveryServiceType":"String content",
"Email":"String content",
"FaxNo":"String content",
"Forename":"String content",
"HouseNumber":"String content",
"HouseNumberExtension":"String content",
"IntendedDeliveryLocationType":"String content",
"MailSourceExport":"String content",
"Name":"String content",
"NotificationMethods":"String content",
"NotificationTypes":"[
{
"NotificationTypeCd":"String content"
}
]
"POBox":"String content",
"PhoneNo":"String content",
"PickUpPointId":"String content",
"Postcode":"String content",
"PosteRestanteInd":"String content",
"StreetName":"String content",
"Title":"String content",
},
"ClassCd":"String content",
"Content":"String content",
"CurrencyCd":"String content",
"CustomNo":"String content",
"CustomsTaxInformation":{
"AccompanyingDocuments":[
{
"DocumentTypeCode":"String content",
"Identifier":"String content",
"Name":"String content"
}
],
"ContentPieces":[
{
"DeclaredValue":12678967.543233,
"DeclaredValueCurrencyCode":"String content",
"Description":"String content",
"Identifier":2147483647,
"NetWeight":12678967.543233,
"NumberOfUnits":2147483647,
"OriginLocation":"String content",
"TariffHeading":"String content",
}
],
"DeclaredGrossWeight":12678967.543233,
"ItemNatureCode":"String content",
"ItemNatureCodeDescription":{
"Code": 2147483647,
"Description":"String content",
}
"Observations":"String content",
"RecipientCustomsReferenceNumber":"String content",
SenderCustomsReferenceNumber":"String content",
},
"DestCountryCd":"String content",
"DutiableInd":"String content",
"DutiableValue":12678967.543233,
"IdentifierType":"String content",
"InnrbagId":"String content",
"ItemEvents":[
{
"AttemptedDeliveryLocation":"String content",
"ConditionCd":2147483647,
"CustomsOfficeCd":"String content",
"CustomsOfficeTypeCd":"String content",
"CustomsReleaseStatusCd":"String content",
"Date":"String content",
"DelivLocation":"String content",
"DeliveryAgent":32767,
"DeliveryTypeCd":"String content",
"LodgementModeCd":"String content",
"MailSourceCd":"String content",
"NextOfficeFcd":"String content",
"NonDeliveryMeasure":"String content",
"NonDeliveryReason":32767,
"OfficeCd":"String content",
"RetentionReasonCd":32767,
"SignatoryBase64":"String content",
"SignatoryBase64Ext":"String content",
"SignatoryNm":"String content",
"TNCd":"String content",
"TransitDirectionCd":"String content",
"UserFid":"String content",
"WorkstationFid":"String content",
}
],
"ItemId":"String content",
"ItemWeight":12678967.543233,
"Letter":{
"CoDCurrencyCd":"String content",
"CoDInd":"String content",
"CoDValue":12678967.543233,
"ConveyanceTypeCd":"String content",
"DeliveryProofInd":"String content",
"ExemptInd":"String content",
"ExpressInd":"String content",
"InsuredCurrencyCd":"String content",
"InsuredSDRValue":12678967.543233,
"InsuredValue":12678967.543233,
"MailCategoryCd":"String content",
"MailItemCategoryCd":"String content",
"ReturnDelay":2147483647,
"RouteInstructionCd":"String content",
"SenderInstructionCd":"String content",
"LetterCharacteristicCd":"String content",
}
"LocalId":"String content",
"Misc1":"String content",
"Misc2":"String content",
"Misc3":"String content",
"Misc4":"String content",
"MrsExpirationDate":"\/Date(928142400000+0200)\/",
"MrsOriginalId":"String content",
"MrsStatus":"String content",
"NetworkEntryLocationTypeCd":"String content",
"OperatorCd":"String content",
"OrigCountryCd":"String content",
"Parcel":{
"CoDCurrencyCd":"String content",
"CoDInd":"String content",
"CoDValue":12678967.543233,
"ConveyanceTypeCd":"String content",
"DeliveryProofInd":"String content",
"ExemptInd":"String content",
"ExpressInd":"String content",
"InsuredCurrencyCd":"String content",
"InsuredSDRValue":12678967.543233,
"InsuredValue":12678967.543233,
"MailCategoryCd":"String content",
"MailItemCategoryCd":"String content",
"ReturnDelay":2147483647,
"RouteInstructionCd":"String content",
"SenderInstructionCd":"String content",
"ParcelDue":12678967.543233,
"ParcelRate":12678967.543233,
},
"PostagePaidCurrencyCd":"String content",
"PostagePaidValue":12678967.543233,
"PostalStatusFcd":"String content",
"ProductTypeCd":"String content",
"RecptclId":"String content",
"Sender":{
"Address":"String content",
"AddressLine_2":"String content",
"AltDelivAddressCityTown":"String content",
"AltDelivAddressHouseId":"String content",
"AltDelivAddressLine_1":"String content",
"AltDelivAddressLine_2":"String content",
"AltDelivAddressPostcode":"String content",
"City":"String content",
"CodBIC":"String content",
"CodIBAN":"String content",
"ConsumerRegNumber":"String content",
"Country":"String content",
"CountrySubEntity":"String content",
"CustomerChargArrangement":"String content",
"CustomerLanguage":"String content",
"DeliveryServiceType":"String content",
"Email":"String content",
"FaxNo":"String content",
"Forename":"String content",
"HouseNumber":"String content",
"HouseNumberExtension":"String content",
"IntendedDeliveryLocationType":"String content",
"MailSourceExport":"String content",
"Name":"String content",
"NotificationMethods":"String content",
"NotificationTypes":[
{
"NotificationTypeCd":"String content"
}
],
"POBox":"String content",
"PhoneNo":"String content",
"PickUpPointId":"String content",
"Postcode":"String content",
"PosteRestanteInd":"String content",
"StreetName":"String content",
"Title":"String content",
},
"Services":[
{
"ServiceCd":"String content"
}
],
"Value":12678967.543233
}
Example response (200)
{
"AgentCode":"String content",
"Mailitems":[
{
"Identifier":"String content",
"LocalIdentifier":"String content",
"MailItemDeliveryInformation":{
"COD":{
"Amount":12678967.543233,
"Currency":"String content"
},
"DeliveryAddress":{
"Address":"String content",
"City":"String content",
"Forename":"String content",
"Name":"String content",
"PhoneNo":"String content",
"Postcode":"String content"
}
}
}
]
}
XXX trace
Retrieves trace information for XXX.
HTTP request
GET http://[host name]/APIService/TraceService.svc/rest/Items?ids={comma-separated list of item identifiers}&lang={language code}&token={token}
where {ids} can be either international or local identifiers, {language code} is a 2 character language code for displaying localized text, and {token} is the required GUID for authorization. If language code is null, then the default language code 'en' (English) is used.
Example response (200)
{
"Fid":"String content",
"InfoFromEdi":[
{
"Characteristics":{
"ExemptIndicator":true,
"ExpressIndicator":true,
"HandlingClass":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content",
},
"InsuredMoney":{
"Amount":12678967.543233,
"Currency":"String content",
}
},
"DestCountry":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"InternationalId":"String content",
"OrigCountry":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"Weight":12678967.543233,
"Events":[
{
"CustomsReleaseStatus":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"DispatchNumber":"String content",
"EdiEvent":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"EventOffice":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"EventType":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"LocalDateTime":"String content",
"NonDeliveryMeasure":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"NonDeliveryReason":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"ReceivedDispatch":"String content",
"RetentionReason":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"Signatory":{
"SignatoryImage":"String content",
"SignatoryName":"String content"
},
"Charges":{
"COD":{
"Amount":{
"Amount":12678967.543233,
"Currency":"String content"
},
"BIC":"String content",
"IBAN":"String content"
},
"Customer_charging_arrangement":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
}
},
"ItemArrivalStatus":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"MrsInfo":{
"ExpirationDatetime":"String content",
"ItemOriginalId":"String content",
"StatusCode":"String content"
}
}
]
}
],
"OperationalMailitems":[
{
"Characteristics":{
"ExemptIndicator":true,
"ExpressIndicator":true,
"HandlingClass":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"InsuredMoney":{
"Amount":12678967.543233,
"Currency":"String content"
}
},
"DestCountry":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"InternationalId":"String content",
"OrigCountry":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"Weight":12678967.543233,
"Charges":{
"COD":{
"Amount":{
"Amount":12678967.543233,
"Currency":"String content"
},
"BIC":"String content",
"IBAN":"String content"
},
"Customer_charging_arrangement":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
}
},
"Events":[
{
"CustomsReleaseStatus":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"DispatchNumber":"String content",
"EdiEvent":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"EventOffice":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"EventType":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"LocalDateTime":"String content",
"NonDeliveryMeasure":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"NonDeliveryReason":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"ReceivedDispatch":"String content",
"RetentionReason":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
},
"Signatory":{
"SignatoryImage":"String content",
"SignatoryName":"String content"
},
"GmtDateTime":"String content",
"NextOffice":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
}
}
],
"LocalId":"String content",
"MrsInfo":{
"ExpirationDatetime":"String content",
"ItemOriginalId":"String content",
"StatusCode":"String content"
},
"ProductType":{
"Code":"String content",
"Name":"String content",
"LocalName":"String content"
}
}
]
}
]
Success
If successful, this method returns an HTTP 200 response with the results grouped by mail item FID.