Migrating from SOAP API
If you have previously used the EMCS SOAP API, you may find the following information useful.
Differences
The endpoints accept data in XML format, and now return data in XML wrapped in JSON.
The XML for the IE messages remains the same as the SOAP API. The SOAP API wrapped the XML in a SOAP envelope, but this will no longer be needed in the RESTful API.
You can find the request schema on GitHub.
There is no longer an individual endpoint for every message you need to send. Many different messages can now be sent to a single endpoint, ‘Submit a message for an excise movement’.
Equivalent SOAP API endpoints
There some changes to the API endpoints in the new RESTful API. You can find the new endpoints and their previous SOAP API equivalents below.
Movements
| RESTful API | SOAP API equivalents |
|---|---|
| POST /customs/excise/movements | SubmitDraftMovement |
|
GET /customs/excise/movements GET /customs/excise/movements/{movementId} |
GetMovementForTrader |
| POST /customs/excise/movements/{movementId}/messages | SubmitReportofReceipt SubmitExplainDelayToDelivery SubmitCancellation SubmitChangeOfDestination SubmitAlertOrRejectionMovement SubmitSplitMovement SubmitReasonForShortage |
| GET /customs/excise/movements/{movementId}/messages | GetNewMessages |
Traders
| RESTful API | SOAP API equivalents |
|---|---|
| GET /customs/excise/traders | PreValidateTrader |