logo

Dispatch import service

Imports dispatches

Create and close dispatches

Imports closed outbound dispatch data with all associated receptacle and mail item information.

Access to this method is authorized by the Import dispatches operation.

Note: You can only import closed dispatches and receptacles. Dispatch update is not supported.

Error

In addition to the standard error codes described in Response codes, the IPS API returns a 404 error code for specific error cases, with additional error information as listed in the table below.

Code Description
1 Mandatory data is missing from the dispatch, receptacle, bundle, inner bag or mail item.
2 A property value in the request contains an invalid value or is in the wrong format.
3 Reference data not found.
4 The request contains inconsistent data. For example, if trying to insert a parcel in a letter receptacle.
5 No transport found for the dispatch.
6 The route exists but is not compatible with the dispatch.
7 Data already exists in the database.
8 Failure storing the dispatch, receptacle, bundle , inner bag or mail item.
9 The request body does not match the specified structure.
10 Unexpected error handled by the API.
11 Error returned from internal IPS business process.
Securityips_token
Request
Request Body schema: application/json
DispatchId
required
string <= 20 characters ^[A-z0-9]{20}$

Dispatch identifier. Format must be compliant with S8 UPU standard

DispatchPreviousSerialNo
number <= 4 characters ^[0-9]{4}$

Previous dispatch serial number (omitted for the first dispatch of the series)

DispatchWeight
required
number <float> ^[0-9]{9}\.[0-9]{3}$

Dispatch weight

DispatchEarliestDeparture
required
string <date-time>

Earliest possible departure date/local time of the dispatch

DispatchRouteScheduleIdentifier
string <= 36 characters ^[A-z0-9]{36}$

Unique identifier of the route schedule (GUID or, in a future IPS release, user friendly route schedule identifier).

If omitted, IPS will look for the earliest suitable route schedule after the specified departure date and time.

DispatchClosureDateTime
required
string <date-time>

Date/time of the dispatch closure event. Time is local, plus offset from GMT

DispatchProductType
string or null

Product type

Null UPU parcels

C e-commerce parcels

G Interconnect Standard

H Interconnect Premium

K Kahala

M PRIME

P EPG

Enum: "C" "G" "H" "K" "M" "P"
DispatchComments
string <= 256 characters ^[A-z0-9]{256}$

Comment on the dispatch

required
Array of objects (DispatchOtbCNs)
required
Array of objects (Receptacles)
Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

post/DispatchImportService.svc/rest/dispatch
Request samples
application/json
{
  • "DispatchId": "CHZRHBNZAKLAAUN00005",
  • "DispatchPreviousSerialNo": 4,
  • "DispatchWeight": 10.5,
  • "DispatchEarliestDeparture": "2020-06-30 00:00",
  • "DispatchRouteScheduleIdentifier": "8E98516B-1864-4B86-AB45-1CB92117D60D",
  • "DispatchClosureDateTime": "2020-06-29T16:38:06+01:00",
  • "DispatchProductType": "C",
  • "DispatchComments": null,
  • "DispatchOtbCNs": [
    ],
  • "Receptacles": [
    ]
}
Response samples
application/json
{
  • "Dispatch": {
    }
}
➔ Next to DNL service