Skip to main content
API docs by Redocly

API specfication for QuayConnect eCustoms (0.2.6)

Download OpenAPI specification:Download

This API specification describes the functionalities for creating EU export and UK import customs declarations.

The main data structure in QuayConnect is a consignment which is the equivalent of a single sales order or invoice. Multiple consignment can be linked together through a voyageReference, which can be useful if multiple orders are shipped in a single container or trailer. In that case a transport order number, container number or trailer licence plate can be provided in the voyageNumber field to link multiple shipments together.

Create a new shipment.

This will automatically trigger the services that are configured for this organisation. The service configuration is a one-time setup that happens in the QuayConnect web appplication.

Authorizations:
ApiKey
Request Body schema: application/json

QuayConnect native data format.

shipmentReference
required
string

Unique reference number for this shipment / consignment, e.g. invoice reference.

Export: required Import: required

voyageReference
string

Unique reference for the voyage/truck/container, e.g. transport order id or trailer license plate can be used to group several consignments under a single trip.

Export: optional Import: optional

shipmentType
required
string
Enum: "FCL" "LCL" "FTL" "LTL"

FCL = Full Container Load LCL = Less than Container Load FTL = Full Truck Load LTL = Less than Truck Load

Export: required Import: required

required
object

Details of the voyage/transport.

Export: required

required
object

Details stated on the invoice

object
Array of objects

Goods shipped in this shipment. As mentioned on the respecive invoice.

Responses

Request samples

Content type
application/json
{
  • "shipmentReference": 512238,
  • "voyageReference": 12346798,
  • "shipmentType": "LCL",
  • "voyage": {
    },
  • "invoice": {
    },
  • "parties": {
    },
  • "goods": [
    ]
}

Response samples

Content type
application/json
{
  • "shipmentId": "string"
}

Create a new shipment with a non-native format.

This endpoint allows to create shipments using other data formats than the native format used for the /shipments endpoint. The data format used should be fixed on a per-company basis. Using the token, QuayConnect determines the organisation and associated data format to parse the received input.

Authorizations:
ApiKey
Request Body schema:

The non-native data format agreed upon in the onboarding process.

object

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "shipmentId": "string"
}

Upload supporting documents to a given shipment.

Some documents are required by the customs agent to process the. This endpoint allows to attach those documents to a previously created shipment.

Authorizations:
ApiKey
Request Body schema: application/json

document data

dataBase64
string

Base64 encoded data of the document.

filename
string

Name of the file.

documentIdentifier
string

Unique identifier of the document (e.g. invoice number).

documentType
string
Enum: "phytosanitary" "invoice" "health-certificate" "certificate-of-conformity"

Type of the supporting document.

mimeType
string

MIME type of the given document.

Responses

Request samples

Content type
application/json
{
  • "dataBase64": "string",
  • "filename": "string",
  • "documentIdentifier": "string",
  • "documentType": "phytosanitary",
  • "mimeType": [
    ]
}

Response samples

Content type
application/json
{
  • "documentId": "string"
}

Retrieve the status of a given shipment.

Authorizations:
ApiKey
path Parameters
shipmentId
required
string

Unique id of the shipment

Responses

Response samples

Content type
application/json
{
  • "export": {
    },
  • "import": {
    }
}