IMI GO! REST API

About the API

Security

All requests to the API must be encrypted using HTTPS.

Authentication

The API uses HTTP Basic Authentication.

Dates

Accepted ISO 8601 UTC formats. 2012-03-19T07:22Z

Currency

Accepted ISO 4217

Entities

Consignment

Parties must contain one CONSIGNEE and one CONSIGNOR. Additional valid PartyTypes are SERVICEPOINT and DEPOT
TransportPayer must be set to either CONSIGNEE or CONSIGNOR
TermsOfDeliveryCode Incoterm codes allowed
ConsignmentProperties the PropertyTypes must already been set up for your specific need

Respons

Paging

For endpoints with possible large results we paginates some responses, for performance reasons. This is because returning the entire data set might be feasible for some queries but prohibitive for others that return a very large amount of data.