Closeout - error messages

A list of possible error messages and reason for unsuccessful confirmShipmentRequests.

Error 1 – “One or more shipments are not in a valid state for confirming” – normally you would get this error message when:
  • At least one of the shipments from the request has already been confirmed before.
  • At least one of the shipments from the request has been created with the <shipmentDate> as the future date. To avoid such situations it is very important to always create shipments with today’s date as <shipmentDate>. One thing to remember here is that they always need to be confirmed before 28 days. Otherwise they expire.
  • At least one of the shipments entered the Royal Mail network without being manifested and have already been delivered. 
Error 2 – “Access Denied” – it happens when some parts of <integrationHeader> are incorrect – Application ID, user ID or password. 

Error 3 - "Error deserializing XML message. Check your XML complies with the API documentation" - this is caused by:

  • At least one part of <integrationHeader> missing, e.g. <transactionID> / <applicationID> left blank.
  • API request non complaint with the API specifications.

Error 4 - "trackingNumber is required" - is returned when no tracking number is sent in the request.

Error 5 - "trackingNumber has a maximum length of 50" - <trakcingNumber> provided in the request exceeds the maximum length of 50 characters. 

Error 6 - "serviceCode is required" - is returned when no service code is sent in the request.

Error 7 - "serviceCode has a maximum length of 4" - <serviceCode> provided in the request exceeds the maximum length of 4 characters.

Error 8 - "carrierCode is required" - is returned when no carrier code is sent in the request.

Error 9 - "carrierCode has a maximum length of 4" - <carrierCode> provided in the request exceeds the maximum length of 4.