Endpoints

Base URL

All of our API endpoints are accessed through the base url: https://api.clear-port.com/v1/

The format of data sent to and received from all endpoints is JSON.

Rate Limiting

API requests are limited to a maximum of 100 per minute. Any further requests will return a 429 Too Many Requests status code.

CDS Exports

Create

  • Endpoint: cds/exports

  • Method: POST

  • Request body schema: CreateExportDataSchema

  • Returns

    • 202 Accepted. CreateExportResponseSchema

    • 400 Bad Request. There was a problem with the data you provided. An explanation will be provided in the response body.

    • 401 Unauthorised. You did not provide a valid API key.

    • 429 Too many requests.

Get

  • Endpoint: cds/exports/:correlationId

  • Method: GET

  • Parameters:

  • correlationId - the value returned by the Create method

  • Response body schema: GetExportDataSchema

  • Returns

    • 200 Ok. GetExportDataSchema

    • 401 Unauthorised. You did not provide a valid API key.

    • 404 Not found. The declaration could not be found.

    • 429 Too many requests.

Download PDF

  • Endpoint: cds/exports/:correlationId/pdf

  • Method: GET

  • Parameters:

  • correlationId - the value returned by the Create method

  • Response: file

  • Returns

    • 200 Ok.

    • 401 Unauthorised. You did not provide a valid API key.

    • 404 Not found. The declaration could not be found.

    • 429 Too many requests.

CDS Imports

Create

  • Endpoint: cds/imports

  • Method: POST

  • Schema: CreateImportDataSchema

  • Returns

    • 202 Accepted. CreateImportResponseSchema

    • 400 Bad Request. There was a problem with the data you provided. An explanation will be provided in the response body.

    • 401 Unauthorised. You did not provide a valid API key.

    • 429 Too many requests.

Get

  • Endpoint: cds/imports/:correlationId

  • Method: GET

  • Parameters:

  • correlationId - the value returned by the Create method

  • Response body schema: GetImportDataSchema

  • Returns

    • 200 Ok.

    • 401 Unauthorised. You did not provide a valid API key.

    • 404 Not found. The declaration could not be found.

    • 429 Too many requests.

Download PDF

  • Endpoint: cds/imports/:correlationId/pdf

  • Method: GET

  • Parameters:

  • correlationId - the value returned by the Create method

  • Response: file

  • Returns

    • 200 Ok.

    • 401 Unauthorised. You did not provide a valid API key.

    • 404 Not found. The declaration could not be found.

    • 429 Too many requests.

Get Tax Calculation

  • Endpoint: cds/imports/:mrn/tax

  • Method: GET

  • Parameters:

  • mrn - the Movement Reference Number of the import

  • Response body schema: GetImportTaxDataSchema

  • Returns

    • 200 Ok.

    • 401 Unauthorised. You did not provide a valid API key.

    • 404 Not found. The declaration could not be found.

    • 429 Too many requests.

Air Imports

Get AWB

  • Endpoint: air-imports/consignments/:awb

  • Method: GET

  • Parameters:

    • awb - the Air Waybill number

    • hawb (querystring) - the House Waybill number, if applicable

    • split (querystring) - the split reference, if applicable

  • Response body schema: Array of GetAirConsignmentsDataSchema

  • Returns

    • 200 Ok.

    • 401 Unauthorised. You did not provide a valid API key.

    • 404 Not found. The declaration could not be found.

    • 429 Too many requests.

NCTS Departures

Create

  • Endpoint: ncts/v5/departures

  • Method: POST

Download TAD

  • Endpoint: ncts/v5/departures/:id/tad

  • Method: GET

Vehicles

Create

  • Endpoint: vehicles

  • Method: POST

List

  • Endpoint: vehicles

  • Method: GET

Get Vehicle

  • Endpoint: vehicles/:id

  • Method: GET

Update

  • Endpoint: vehicles/:id

  • Method: PUT

Safety and Security Declarations

Create

  • Endpoint: ens/declarations

  • Method: POST

  • Schema: CreateENSDataSchema

  • Returns

    • 202 Accepted. CreateENSResponseSchema

    • 400 Bad Request. There was a problem with the data you provided. An explanation will be provided in the response body.

    • 401 Unauthorised. You did not provide a valid API key.

    • 429 Too many requests.

Get

  • Endpoint: ens/declarations/:correlationId

  • Method: GET

  • Parameters:

    • correlationId - the value passed to the Create method

    • Response body schema: GetENSDataSchema

  • Returns

    • 200 Ok. GetENSDataSchema

    • 401 Unauthorised. You did not provide a valid API key.

    • 404 Not found. The declaration could not be found.

    • 429 Too many requests.

GVMS

Create

  • Endpoint: gvms/

  • Method: POST

  • Schema: CreateGVMSDataSchema

  • Returns

    • 202 Accepted.

    • 400 Bad Request. There was a problem with the data you provided. An explanation will be provided in the response body.

    • 401 Unauthorised. You did not provide a valid API key.

    • 429 Too many requests.

Get

  • Endpoint: gvms/:correlationId

  • Method: GET

  • Schema: GetGVMSDataSchema

  • Returns

    • 200 Ok.

    • 400 Bad Request. There was a problem with the data you provided. An explanation will be provided in the response body.

    • 401 Unauthorised. You did not provide a valid API key.

    • 404 Not found. A GVMS declaration with that Correlation Id cannot be found.

    • 429 Too many requests.

Update

  • Endpoint: gvms/:correlationId

  • Method: POST

  • Schema: UpdateGVMSDataSchema

  • Returns

    • 200 Ok.

    • 400 Bad Request. There was a problem with the data you provided. An explanation will be provided in the response body.

    • 401 Unauthorised. You did not provide a valid API key.

    • 429 Too many requests.

Download PDF

  • Endpoint: gvms/:gmrid/pdf

  • Method: GET

  • Returns

    • 200 Ok.

    • 400 Bad Request. There was a problem with the data you provided. An explanation will be provided in the response body.

    • 401 Unauthorised. You did not provide a valid API key.

    • 404 Not found. A GVMS declaration with that GMR Id cannot be found.

    • 429 Too many requests.

ELO

Create

  • Endpoint: elo/

  • Method: POST

  • Schema: CreateELODataSchema

  • Returns

    • 202 Accepted.

    • 400 Bad Request. There was a problem with the data you provided. An explanation will be provided in the response body.

    • 401 Unauthorised. You did not provide a valid API key.

    • 429 Too many requests.

Get

  • Endpoint: elo/:correlationId

  • Method: GET

  • Schema: GetELODataSchema

  • Returns

    • 200 Ok.

    • 400 Bad Request. There was a problem with the data you provided. An explanation will be provided in the response body.

    • 401 Unauthorised. You did not provide a valid API key.

    • 404 Not found. A GVMS declaration with that Correlation Id cannot be found.

    • 429 Too many requests.

Download PDF

  • Endpoint: elo/:correlationId/pdf

  • Method: GET

  • Returns

    • 200 Ok.

    • 400 Bad Request. There was a problem with the data you provided. An explanation will be provided in the response body.

    • 401 Unauthorised. You did not provide a valid API key.

    • 404 Not found. An ELO declaration with that Correlation Id cannot be found.

    • 429 Too many requests.