Export Health Certificates

API

This API enables traders to apply for export health certificates, check the status of applications you've made, and check for validation errors on your applications. This is the first step towards enabling digital integration for moving agri-food goods.

Operations

The following operations are available for this API. Expand the sections to find out more about each, including the parameters and request/response structures.

Post /ehc-application

Provide the details of an application to raise an Export Health Certificate for your consignment.

Use the online documentation to construct a payload representing your application. Optionally use the /ehc-application-example endpoint to view example payloads to assist you.

Use the reference-data/metadata endpoint to find and search reference data lists for sub sections of the payload according to your consignment, e.g. Certifiers, Countries, Means of Transport.

Submit your constructed payload to the /ehc-application endpoint and react to the response status code accordingly.

Parameters
Name Description
Request Body

Details of your request for an Export Health Certificate Application.

Data type: object using the model EhcApplicationMessage
Format: application/json
Parameter location: Body
For example: 
Failed to generate sample value: generated sample is too big.


Responses application/json
Code Description
202

The submitted payload has passed preliminary validation and has resulted in a Request being created.

A Request is a way to track the asynchronous processing of your message.

The Request is now being validated and processed in order to attempt to create an Export Health Certificate Application.

You can commence polling for status changes to the Request using the /request-status endpoint and the requestId provided in the response body.

Here is an example response for this RequestStatusDetails schema: 

{
  "_links": [
    {
      "href": "https://defra.gov.uk/api/v1/example/123",
      "rel": "status",
      "method": "GET"
    }
  ],
  "requestId": "b09fb181-948d-4c0c-9928-bf6d0b7ca357",
  "customerReference": "TRD-AAA111-01",
  "status": "Accepted",
  "createdOn": "2021-02-01T14:05:00+00:00",
  "lastUpdated": "2021-02-01T16:40:00+00:00"
}
400

The attempt to create a Request failed preliminary validation and has not been created.

Validation errors can be found in the response body and must be corrected before re-submitting.

Here is an example response for this CommonProblemDetails schema: 

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "00-d55147526d044e41aa246671de874080-de7c8222d3b2684a-00",
  "errors": {
    "applicationName": [
      "'Application Name' must not be empty."
    ],
    "certificateQuantity": [
      "'Certificate Quantity' must be greater than or equal to '1'."
    ]
  }
}

Get /ehc-application-example/{ehcName}

Find an Export Health Certificate example request by the name of the certificate, e.g. 8293EHC.

Parameters
Name Description
ehcName

Export Health Certificate name

Data type: string
Parameter location: Path
Is mandatory: Yes


Responses application/json
Code Description
200

Successfully retrieved a sample Export Health Certificate Application payload.

Here is an example response for this EhcApplicationMessage schema: 

Failed to generate sample value: generated sample is too big.
400

The Export Health Certificate name to find has failed validation.

Here is an example response for this CommonProblemDetails schema: 

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "00-d55147526d044e41aa246671de874080-de7c8222d3b2684a-00",
  "errors": {
    "applicationName": [
      "'Application Name' must not be empty."
    ],
    "certificateQuantity": [
      "'Certificate Quantity' must be greater than or equal to '1'."
    ]
  }
}
404

No sample is available or the name did not correspond to a known Export Health Certificate. Please verify the name and use the Metadata endpoint to confirm it is available.

Here is an example response for this CommonProblemDetails schema: 

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "traceId": "00-11dc1a21a6bc20489d3009fb27d57b87-ddc5556eac52a943-00",
  "errors": {}
}

Get /ehc-application/{requestId}/request-status

After having confirmation that your submission has been accepted as a Request for an Application from the previous /ehc-application endpoint, you are now in a position to poll for status updates.

You can use this /request-status endpoint with the requestId to poll for status updates in order to react accordingly.

Parameters
Name Description
requestId

Format - uuid. Request Id which can be found in the /ehc-application submission response.

Data type: string
Parameter location: Path
Is mandatory: Yes


Responses application/json
Code Description
200

The Request has been successfully validated, submitted and resulted in an Export Health Certificate Application having been created.

Location and details of the created Export Health Certificate Application resource can be found in the response body.

You may now transition to using the /status endpoint should you wish to follow the progress of this Application as it moves through the workflow of an Export Health Certificate.

Here is an example response for this RequestStatusDetails schema: 

{
  "_links": [
    {
      "href": "https://defra.gov.uk/api/v1/example/123",
      "rel": "status",
      "method": "GET"
    }
  ],
  "requestId": "b09fb181-948d-4c0c-9928-bf6d0b7ca357",
  "customerReference": "TRD-AAA111-01",
  "status": "Accepted",
  "createdOn": "2021-02-01T14:05:00+00:00",
  "lastUpdated": "2021-02-01T16:40:00+00:00"
}
202

The Request is still in the process of being validated and you should continue to poll for status changes.

Here is an example response for this RequestStatusDetails schema: 

{
  "_links": [
    {
      "href": "https://defra.gov.uk/api/v1/example/123",
      "rel": "status",
      "method": "GET"
    }
  ],
  "requestId": "b09fb181-948d-4c0c-9928-bf6d0b7ca357",
  "customerReference": "TRD-AAA111-01",
  "status": "Accepted",
  "createdOn": "2021-02-01T14:05:00+00:00",
  "lastUpdated": "2021-02-01T16:40:00+00:00"
}
400

The Request was rejected due to validation errors.

Validation errors can be found in the response body. Polling should be stopped and errors need to be fixed before re-submitting.

Here is an example response for this CommonProblemDetails schema: 

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "00-d55147526d044e41aa246671de874080-de7c8222d3b2684a-00",
  "errors": {
    "applicationName": [
      "'Application Name' must not be empty."
    ],
    "certificateQuantity": [
      "'Certificate Quantity' must be greater than or equal to '1'."
    ]
  }
}
404

A Request with the specified Request Id could not be found. Please verify that the Request Id is correct and try again.

Here is an example response for this CommonProblemDetails schema: 

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "traceId": "00-11dc1a21a6bc20489d3009fb27d57b87-ddc5556eac52a943-00",
  "errors": {}
}

Get /ehc-application/{requestId}/status

Find an Export Health Certificate Application to view its status and that of the certificates that are being processed as a result.

Any Applications returned here are in the Export Health Certificate workflow and will be navigating through the certification process.

You can periodically poll to find the status, however the frequency of updates will depend on the persons who are handling the process.

Parameters
Name Description
requestId

Format - uuid. Request Id provided by the /ehc-application submission response.

Data type: string
Parameter location: Path
Is mandatory: Yes


Responses application/json
Code Description
200

Successfully retreived the status of the requested Export Health Certificate Application and related Certificates.

Here is an example response for this ApplicationDetails schema: 

{
  "_links": [
    {
      "href": "https://defra.gov.uk/api/v1/example/123",
      "rel": "status",
      "method": "GET"
    }
  ],
  "requestId": "b09fb181-948d-4c0c-9928-bf6d0b7ca357",
  "systemRequestId": "1700000123",
  "customerReference": "TRD-AAA111-01",
  "status": "Submitted",
  "certificates": [
    {
      "certificateId": "d8e7af71-6d66-442a-9ea1-5a1bad1348ac",
      "certificateSerialNumber": "20/2/012345",
      "status": "Submitted",
      "createdOn": "2021-02-01T14:06:00+00:00",
      "lastUpdated": "2021-02-02T09:10:00+00:00"
    }
  ],
  "createdOn": "2021-02-01T14:05:00+00:00",
  "lastUpdated": "2021-02-01T16:40:00+00:00"
}
404

The Request could not be found.

Please verify that the Request Id is correct and that the Request was successfully submitted by checking the /request-status endpoint for a 200 OK response.

Here is an example response for this CommonProblemDetails schema: 

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "traceId": "00-11dc1a21a6bc20489d3009fb27d57b87-ddc5556eac52a943-00",
  "errors": {}
}

Get /ehc-metadata

This endpoint is provided to help with the discovery and usability of the APIs to make the submission of Export Health Certificates as seamless and successful as possible.

Links are provided in the response to navigate around the APIs to find:

  • Example payloads for submission of Export Health Certificate requests
  • Endpoint to submit new Export Health Certificate requests
  • Reference data lists to support the creation process
  • Supplementary information to provide context and guidance
Parameters
Name Description
ehcName

Filter by Export Health Certificate name containing text.

Data type: string
Parameter location: Query
Is mandatory: No
title

Filter by Export Health Certificate title containing text.

Data type: string
Parameter location: Query
Is mandatory: No
isAvailableViaApi

Filter by whether the Export Health Certificate is available via the API.

Data type: boolean
Parameter location: Query
Is mandatory: No
pageNumber

Format - int64. Page number to return.

Data type: integer
Parameter location: Query
Is mandatory: No
pageSize

Format - int64. Number of items per page.

Data type: integer
Parameter location: Query
Is mandatory: No


Responses application/json
Code Description
200

Successfully retrieved Export Health Certificate metadata.

Here is an example response for this EhcMetadataPagedResult schema: 

{
  "data": [
    {
      "_links": [
        {
          "href": "https://defra.gov.uk/api/v1/example/123",
          "rel": "status",
          "method": "GET"
        }
      ],
      "ehcName": "8293EHC",
      "title": "Eggs for human consumption to the European Union and Northern Ireland",
      "isAvailableViaApi": true
    }
  ],
  "records": 1.0,
  "pageNumber": 1.0,
  "pageSize": 10.0,
  "totalRecords": 1.0,
  "totalPages": 1.0
}
400

The parameters provided in the filter were invalid.

Here is an example response for this CommonProblemDetails schema: 

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "00-d55147526d044e41aa246671de874080-de7c8222d3b2684a-00",
  "errors": {
    "applicationName": [
      "'Application Name' must not be empty."
    ],
    "certificateQuantity": [
      "'Certificate Quantity' must be greater than or equal to '1'."
    ]
  }
}

Schemas

The following section shows the model definitions that are used by the operations above when sending and receiving data to the API.

Abattoir

Details of the site where the commodity is slaughtered, including the locations approval number.

Property Value
organisation

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: Yes
location

Details of a location including approval numbers for the establishment.

Reference data is available:
Data type: object using the model Location
Is mandatory: Yes
slaughterDate

Date/time the animal is/was slaughtered.
Data type: string with format date-time
Is mandatory: No

Address

Address details.

Reference data is available:

Property Value
postCode

Postcode.
Data type: string
Maximum length: 10
Is mandatory: No
coordinates

Geographic co-ordinates.
Data type: object using the model Coordinates
Is mandatory: No
what3Words

What 3 Words location identifier details.
Data type: object using the model What3Words
Is mandatory: No
unlocode

United Nations Code for Trade and Transport Locations.
Data type: string
Maximum length: 20
Is mandatory: No
lineOne

Address line one.
Data type: string
Maximum length: 100
Is mandatory: No
lineTwo

Address line two.
Data type: string
Maximum length: 100
Is mandatory: No
lineThree

Address line three.
Data type: string
Maximum length: 100
Is mandatory: No
lineFour

Address line four.
Data type: string
Maximum length: 100
Is mandatory: No
lineFive

Address line five.
Data type: string
Maximum length: 100
Is mandatory: No
city

City.
Data type: string
Maximum length: 50
Is mandatory: No
country

Country details.

Reference data is available:
Data type: object using the model Country
Is mandatory: No
approvalNumber

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No

ApplicationDetails

Details of the Application and relevant Certificates.

Property Value
_links

Hypermedia as the Engine of Application State (HATEOAS) links to related resources.
Data type: array [object] using the model ResourceLink
Is mandatory: No
requestId

Unique identifier for the request that triggered the generation of the Application.
Data type: string with format uuid
For example: b09fb181-948d-4c0c-9928-bf6d0b7ca357
Is mandatory: No
systemRequestId

System identifier created by the system mastering the Application.
Data type: string
For example: 1700000123
Is mandatory: No
customerReference

Customer refenence assigned by the originating customer system.
Data type: string
For example: TRD-AAA111-01
Is mandatory: No
status

Statuses for the Application process for an Export Health Certificate.
Data type: string using the enumeration ApplicationStatus Submitted, InReview, AwaitingReturn, Completed, Cancelled, Rejected
Is mandatory: No
certificates

Certificate details belonging to the Application.
Data type: array [object] using the model CertificateDetails
Is mandatory: No
createdOn

Date/time when the Application was created.
Data type: string with format date-time
For example: 2021-02-01T02:05:00.0000000+00:00
Is mandatory: No
lastUpdated

Date/time when the Application was last updated, if an update has occurred.
Data type: string with format date-time
For example: 2021-02-01T04:40:00.0000000+00:00
Is mandatory: No

ApplicationStatus

Statuses for the Application process for an Export Health Certificate.

Data type: string
Enumeration values: Submitted, InReview, AwaitingReturn, Completed, Cancelled, Rejected

AssertedAuthentication

Asserted authentication mechanisms.

Property Value
type

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
actualDateTime

Date/time of this authentication.
Data type: string with format date-time
Is mandatory: No
issueLocation

Details of a location including approval numbers for the establishment.

Reference data is available:
Data type: object using the model Location
Is mandatory: No
provider

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: No
locationProvider

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: No
includedClause

Included clauses.
Data type: array [object] using the model TradeIdentifier
Is mandatory: No

AuthenticationType

Data type: string
Enumeration values: Authority, Veterinary, DEFRAVeterinary

BorderControlPost

Border control post information.

Reference data is available:

Property Value
id

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: Yes
name

Name of the BCP.
Data type: string
Maximum length: 200
Minimum length: 1
Is mandatory: Yes

CertificateDelivery

Certificate delivery details.

Property Value
method

Method of certificate delivery.
Data type: string
Maximum length: 50
Minimum length: 1
Is mandatory: No
address

Address details.

Reference data is available:
Data type: object using the model Address
Is mandatory: Yes
contact

Persons details.
Data type: object using the model Person
Is mandatory: No
attentionOf

Persons details.
Data type: object using the model Person
Is mandatory: No

CertificateDetails

Details of the Certificate.

Property Value
certificateId

System identifier created by the system mastering the Certificate.
Data type: string
For example: d8e7af71-6d66-442a-9ea1-5a1bad1348ac
Is mandatory: No
certificateSerialNumber

Certificate serial number used on the actual certificate document.
Data type: string
For example: 20/2/012345
Is mandatory: No
status

Export Health Certificate statuses.
Data type: string using the enumeration CertificateStatus Submitted, PendingReturn, Approved, Cancelled, Rejected
Is mandatory: No
createdOn

Date/time when the Certificate was created.
Data type: string with format date-time
For example: 2021-02-01T02:06:00.0000000+00:00
Is mandatory: No
lastUpdated

Date/time when the Certificate was last updated, if an update has occurred.
Data type: string with format date-time
For example: 2021-02-02T09:10:00.0000000+00:00
Is mandatory: No

CertificateRegion

Geographical region for certificate issue.

Data type: string
Enumeration values: England, Scotland, Wales

CertificateStatus

Export Health Certificate statuses.

Data type: string
Enumeration values: Submitted, PendingReturn, Approved, Cancelled, Rejected

Classification

Classification details.

Property Value
systemId

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
name

Name of classification.
Data type: string
Maximum length: 200
Minimum length: 1
For example:
Is mandatory: No
class

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
className

A class name, expressed as text, for this classification.
Data type: string
Maximum length: 100
Minimum length: 1
Is mandatory: No

CommonProblemDetails

Common API problem format for describing system and user error HTTP API responses based on https://tools.ietf.org/html/rfc7807.

Property Value
type

A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".
Data type: string
Is mandatory: No
title

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see[RFC7231], Section 3.4).
Data type: string
Is mandatory: No
status

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
Data type: integer with format int32
Is mandatory: No
detail

A human-readable explanation specific to this occurrence of the problem.
Data type: string
Is mandatory: No
instance

A URI reference that identifies the specific occurrence of the problem.It may or may not yield further information if dereferenced.
Data type: string
Is mandatory: No
errors

Errors associated with the request.
Is mandatory: No

Consignment

Collates, collections of commodities, goods together. Defining the parameters by which the consignment will transport between Consignor (Exporter) and Consignee (Importer).

Reference data is available:

Property Value
exporterConsignmentReferenceId

An exporter reference for the consignment, linking reference materials to the consignment.
Data type: string
Maximum length: 100
Minimum length: 1
For example:
Is mandatory: Yes
availabilityDueDateTime

Date/time when this consignment is due to be available.
Data type: string with format date-time
Is mandatory: No
exportExitDateTime

Date/time when this consignment transitions through the last one of the UKs Border Control Posts to exit the UK.
Data type: string with format date-time
Is mandatory: Yes
departureDateTime

Date/time value when this consignment leaves site for the UK exit point.
Data type: string with format date-time
Is mandatory: Yes
exportSignatureAuthorisedDateTime

Date/time when this consignment is signed off, authorised.
Data type: string with format date-time
Is mandatory: No
inspectionDate

Inspetion date/time for the consignment.
Data type: string with format date-time
Is mandatory: No
collectionDate

Collection date/time for the consignment.
Data type: string with format date-time
Is mandatory: No
consignmentIdentification

Details on how the elements of the consignment can be identified.
Data type: array [object] using the model ConsignmentIdentification
Is mandatory: No
consignmentSeal

Details of seals used to secure the consignment.
Data type: array [object] using the model ConsignmentSeal
Is mandatory: No
shipStores

Describes destination where the final destination is outside of the trading block.
Data type: string
Maximum length: 200
Minimum length: 1
For example:
Is mandatory: No
consignor

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: Yes
consignorAgent

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: No
consignee

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: Yes
responsible

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: No
origin

Describe the origin of the individual consignment trade line commodities.
Data type: array [object] using the model Location
Is mandatory: Yes
exportLocation

The export location for this consignment.
Data type: array [object] using the model Location
Is mandatory: Yes
reExportCountry

Re-export countries for this consignment.
Data type: array [object] using the model Country
Is mandatory: No
storageEvent

Storage events.
Data type: array [string]
Is mandatory: No
importLocation

Detail significant border crossings. Occurrence one (1) must specify the point of entry into the trading block. Occurrence two (2) defines the final destination location. The final destination will be superseded with the information provided in the Ship Store location.
Data type: array [object] using the model Location
Is mandatory: Yes
consigneeReceiptLocation

Details of a location including approval numbers for the establishment.

Reference data is available:
Data type: object using the model Location
Is mandatory: No
transitLocation

Transit locations for this consignment. Provide the ordering as it will be transported.
Data type: array [object] using the model Location
Is mandatory: No
loadingLocation

Details of a location including approval numbers for the establishment.

Reference data is available:
Data type: object using the model Location
Is mandatory: Yes
unloadingLocation

Details of a location including approval numbers for the establishment.

Reference data is available:
Data type: object using the model Location
Is mandatory: Yes
inspectionLocation

Details of a location including approval numbers for the establishment.

Reference data is available:
Data type: object using the model Location
Is mandatory: No
examinationEvent

The examination event for this consignment.
Data type: string
Maximum length: 500
Is mandatory: No
carrier

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: No
despatchParty

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: Yes
deliveryParty

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: No
customsTransitAgent

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: No
transportMovement

Details the means and mode of transport the consignment will utilise, including any transport identification marks and equipment used to move the commodity to the loading location.
Data type: array [object] using the model Transport
Is mandatory: Yes

ConsignmentIdentification

Details on how the elements of the consignment can be identified.

Property Value
mark

Consignment identification mark.
Data type: string
Maximum length: 100
Minimum length: 1
For example:
Is mandatory: Yes

ConsignmentLine

Provides a way of grouping similar commodities within a Consignment together for processing.

Reference data is available:

Property Value
consignmentSummary

Details several measures describing the consignment line.

Reference data is available:
Data type: object using the model ConsignmentSummary
Is mandatory: Yes
physicalPackage

A physical package for this consignment line.
Data type: array [object] using the model Package
Is mandatory: No
exporterConsignmentLineReferenceId

An exporter reference for the consignment line.
Data type: string
Maximum length: 100
Minimum length: 1
For example:
Is mandatory: Yes
tradeLineItem

Trade line items included in this consignment line.
Data type: array [object] using the model TradeLineItem
Is mandatory: Yes

ConsignmentSeal

Details of seals used to secure the consignment.

Property Value
sealNo

Seal number.
Data type: string
Maximum length: 100
Minimum length: 1
For example:
Is mandatory: Yes

ConsignmentSummary

Details several measures describing the consignment line.

Reference data is available:

Property Value
totalQuantity

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: No
totalPackages

Describe the physical package containing the commodities.

Reference data is available:
Data type: object using the model Package
Is mandatory: No
totalMeasures

Trade measurement details.
Data type: object using the model TradeMeasure
Is mandatory: No

ContactDetail

Person contact detail.

Property Value
phoneNumber

Contact telephone number.
Data type: string
Maximum length: 200
Minimum length: 1
Is mandatory: No
emailAddress

Contact email address.
Data type: string
Maximum length: 200
Minimum length: 1
Is mandatory: No

Container

Details of the container, including markings.

Property Value
containerId

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: Yes
sealId

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No

Coordinates

Geographic co-ordinates.

Property Value
latitude

Latitude.
Data type: number with format double
Minimum: -90.0
Maximum: 90.0
For example: 51.509865
Is mandatory: Yes
longitude

Longitude.
Data type: number with format double
Minimum: -180.0
Maximum: 180.0
For example: -0.118092
Is mandatory: Yes

CopyIndicator

The indication of whether or not this exchanged document is a copy.

Property Value
content

The value of the indicator.
Data type: string
Maximum length: 100
Minimum length: 1
For example:
Is mandatory: Yes
format

Whether the indicator is numeric, textual or binary.
Data type: string
Maximum length: 100
Minimum length: 1
For example:
Is mandatory: Yes

Country

Country details.

Reference data is available:

Property Value
countryId

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: Yes
countrySubDivisionId

ISO country sub division code identifier.
Data type: array [object] using the model TradeIdentifier
Is mandatory: No
market

The trading market / block the country is part of.
Data type: string
Maximum length: 300
Minimum length: 1
Is mandatory: No

CuttingPlant

The location of the site where the commodity is prepared, including the locations approval number.

Property Value
organisation

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: Yes
location

Details of a location including approval numbers for the establishment.

Reference data is available:
Data type: object using the model Location
Is mandatory: Yes

EhcApplication

Provides an area in the payload structure where Customers provide parameters to support the application for an Export Health Certificate (EHC).

Certificate delivery address if needed, which certifier they wish to carry out the inspection(s).

Reference data is available:

Property Value
certificateRequiredByDate

Certificate required by date to facilitate the release of the consignment.
Data type: string with format date-time
For example: 2021-04-01T12:00:00.0000000+00:00
Is mandatory: Yes
certificateRegion

Geographical region for certificate issue.
Data type: string using the enumeration CertificateRegion England, Scotland, Wales
Is mandatory: Yes
certifier

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: Yes
certificateQuantity

Certificate quantity type for this application.
Data type: integer with format int32
Minimum: 1.0
Maximum: 1.0
For example: 1
Is mandatory: No
certificateDelivery

Certificate delivery details.
Data type: object using the model CertificateDelivery
Is mandatory: Yes

EhcApplicationMessage

Export Health Certificate message for submission.

Property Value
ehcApplication

Provides an area in the payload structure where Customers provide parameters to support the application for an Export Health Certificate (EHC).

Certificate delivery address if needed, which certifier they wish to carry out the inspection(s).

Reference data is available:
Data type: object using the model EhcApplication
Is mandatory: Yes
exchangeDocument

Confirms the level of regulatory assurance to any importing and any transit countries competent authorities the goods have been measured against. Including references to supporting documents.
Data type: object using the model ExchangeDocument
Is mandatory: Yes
consignment

Collates, collections of commodities, goods together. Defining the parameters by which the consignment will transport between Consignor (Exporter) and Consignee (Importer).

Reference data is available:
Data type: object using the model Consignment
Is mandatory: Yes
consignmentLine

Details of the consignment lines that are part of the consignment.
Data type: array [object] using the model ConsignmentLine
Is mandatory: Yes

EhcMetadata

Export Health Certificate metadata.

Property Value
_links

Hypermedia as the Engine of Application State (HATEOAS) links to related resources.
Data type: array [object] using the model ResourceLink
Is mandatory: No
ehcName

EHC name.
Data type: string
For example: 8293EHC
Is mandatory: No
title

Title / description.
Data type: string
For example: Eggs for human consumption to the European Union and Northern Ireland
Is mandatory: No
isAvailableViaApi

Is this EHC available via the API?
Data type: boolean
For example: True
Is mandatory: No

EhcMetadataPagedResult

Paginated response from the API.

Property Value
data

Specified page within the data set.
Data type: array [object] using the model EhcMetadata
Is mandatory: No
records

Number of records in the current page.
Data type: integer with format int64
For example: 1
Is mandatory: No
pageNumber

Page number.
Data type: integer with format int64
For example: 1
Is mandatory: No
pageSize

Page size.
Data type: integer with format int64
For example: 10
Is mandatory: No
totalRecords

Total number of records across all pages.
Data type: integer with format int64
For example: 1
Is mandatory: No
totalPages

Total number of pages.
Data type: integer with format int64
For example: 1
Is mandatory: No

EhcNameVersion

Name and version of an Export Health Certificate.

Property Value
ehcName

Name of the EHC.
Data type: string
Maximum length: 10
Minimum length: 1
For example: 8293EHC
Is mandatory: Yes
ehcVersion

Version number of the EHC.
Data type: string
Maximum length: 10
Minimum length: 1
For example: 1.8
Is mandatory: No

ExchangeDocument

Confirms the level of regulatory assurance to any importing and any transit countries competent authorities the goods have been measured against. Including references to supporting documents.

Property Value
ehc

Name and version of an Export Health Certificate.
Data type: object using the model EhcNameVersion
Is mandatory: Yes
exporterApplicationReferenceId

Exporter application reference to enable the tracking of the application through its certificate assurance and issuing life cycle.
Data type: string
Maximum length: 100
Minimum length: 1
For example: TRD-ABC-001
Is mandatory: Yes
description

A textual description of this exchange document.
Data type: string
Maximum length: 200
Minimum length: 1
For example:
Is mandatory: No
certificateType

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
exchangeDocumentStatus

A character string (letters, figures or symbols) that for brevity and/or language independence may be used to represent or replace a definitive value or text of an Attribute together with relevant supplementary information.
Data type: object using the model TypeCode
Is mandatory: No
issueDateTime

Date/time for the issuance of this exchange document.
Data type: string with format date-time
Is mandatory: No
copyIndicator

The indication of whether or not this exchanged document is a copy.
Data type: object using the model CopyIndicator
Is mandatory: No
includeNote

A note included in this exchange document.
Data type: array [object] using the model IncludeNote
Is mandatory: No
referenceDocument

A document referenced by this exchanged document.
Data type: string
Maximum length: 200
Minimum length: 1
For example:
Is mandatory: No
signatoryAuthentication

A signatory document authentication for this exchange document.
Data type: string
Maximum length: 200
Minimum length: 1
For example:
Is mandatory: No
veterinarianPracticeSignatoryAuthentication

An signatory document authentication for an exchanged document.
Data type: object using the model SignatoryAuthentication
Is mandatory: No
veterinarian

Persons details.
Data type: object using the model Person
Is mandatory: No

FactoryVessel

Details of the vessel, including its approval number.

Property Value
organisation

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: Yes
location

Details of a location including approval numbers for the establishment.

Reference data is available:
Data type: object using the model Location
Is mandatory: Yes

HatcheryLocation

The location of the site where the commodity is incubated, hatched and reared, plus approval number.

Property Value
organisation

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: Yes
location

Details of a location including approval numbers for the establishment.

Reference data is available:
Data type: object using the model Location
Is mandatory: Yes

IncludeNote

A note included in an exchange document.

Property Value
noteId

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
note

The note text included in the exchange document.
Data type: string
Maximum length: 500
Minimum length: 1
For example:
Is mandatory: Yes

Location

Details of a location including approval numbers for the establishment.

Reference data is available:

Property Value
id

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
name

Location site name, an organisations name.
Data type: string
Maximum length: 100
Minimum length: 1
Is mandatory: No
country

Country details.

Reference data is available:
Data type: object using the model Country
Is mandatory: No
address

Address details.

Reference data is available:
Data type: object using the model Address
Is mandatory: No
approvalNumber

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
temperature

A temperature setting, such as the storage temperature or operational temperature, for this piece of transport equipment.

Reference data is available:
Data type: object using the model Temperature
Is mandatory: No
function

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
borderControlPost

Border control post information.

Reference data is available:
Data type: object using the model BorderControlPost
Is mandatory: No

ManufacturingPlant

The location of the site where the commodity is manufactured, including the approval number

Property Value
organisation

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: Yes
location

Details of a location including approval numbers for the establishment.

Reference data is available:
Data type: object using the model Location
Is mandatory: Yes

Measure

A numeric value determined by measuring an object along with the specified unit of measure.

Property Value
value

The numeric value determined by measuring an object.
Data type: number with format double
Is mandatory: Yes
unit

Type of unit describing the measure.
Data type: string
Maximum length: 100
Is mandatory: No
version

The version of the measure unit code list.
Data type: string
Maximum length: 50
Is mandatory: No
measureNote

Information or additional detail regarding the measure.
Data type: string
Maximum length: 500
Is mandatory: No

Note

A note providing additional information.

Property Value
subject

The subject, expressed as text, of this note.
Data type: string
Maximum length: 200
Minimum length: 1
Is mandatory: No
content

Content, expressed as text, in this note.
Data type: string
Maximum length: 500
Minimum length: 1
Is mandatory: No
contentCode

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
subjectCode

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No

Package

Describe the physical package containing the commodities.

Reference data is available:

Property Value
level

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
type

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: Yes
itemQuantity

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: Yes
nominalGrossWeight

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: No
nominalGrossVolume

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: No

PackageCount

A count of packages containing the commodity.

Property Value
quantity

Count of the number number of physical packages.
Data type: number with format double
Minimum: 0.0
Exclusive minimum: True
Is mandatory: No
quantityUnits

Unit of measure for the count.
Data type: string
Maximum length: 100
Minimum length: 1
Is mandatory: No

PackingCentre

The location of the site where the commodity is packed, including the approval number.

Property Value
organisation

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: Yes
location

Details of a location including approval numbers for the establishment.

Reference data is available:
Data type: object using the model Location
Is mandatory: Yes

Party

The definition of a responsible party in the chain with contact details.

Property Value
uid

Identifier the party is known by.
Data type: array [object] using the model TradeIdentifier
Is mandatory: No
name

Name of the party.
Data type: string
Maximum length: 100
For example:
Is mandatory: Yes
address

Address details.

Reference data is available:
Data type: object using the model Address
Is mandatory: No
contact

Details of relevant persons at the Party.
Data type: array [object] using the model Person
Is mandatory: No
specifiedPerson

Persons details.
Data type: object using the model Person
Is mandatory: No

Period

The completion period for this process.

Property Value
startDateTime

Date/time for the start of this period.
Data type: string with format date-time
Is mandatory: No
endDateTime

Date/time for the end of this period.
Data type: string with format date-time
Is mandatory: No
durationMeasure

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: No

Person

Persons details.

Property Value
name

Unstructured / preferred name as text.
Data type: string
Maximum length: 100
Minimum length: 1
For example:
Is mandatory: Yes
fullName

Structured name for a person.
Data type: object using the model PersonName
Is mandatory: Yes
contactDetail

Person contact detail.
Data type: object using the model ContactDetail
Is mandatory: No
certification

Details of the certifications the representative holds if applicable.
Data type: array [object] using the model TradeIdentifier
Is mandatory: No

PersonName

Structured name for a person.

Property Value
title

Title.
Data type: string
Maximum length: 10
Minimum length: 1
For example: Mr
Is mandatory: No
givenName

Given / first name.
Data type: string
Maximum length: 100
Minimum length: 1
For example: Steven
Is mandatory: Yes
middleNames

Middle names.
Data type: string
Maximum length: 100
Minimum length: 1
For example: John
Is mandatory: No
surname

Surname / last name.
Data type: string
Maximum length: 100
Minimum length: 1
For example: Smith
Is mandatory: No

Product

Details of the Product including identifiers for the commodity.

Property Value
description

A textual description of this product.
Data type: string
Maximum length: 200
Minimum length: 1
For example:
Is mandatory: Yes
commonName

A common name, expressed as text of this product.
Data type: string
Maximum length: 100
Minimum length: 1
For example:
Is mandatory: No
scientificName

A scientific name, expressed as text, of this product.
Data type: string
Maximum length: 100
Minimum length: 1
For example:
Is mandatory: Yes
speciesName

A species name, expressed as text, of this product.
Data type: string
Maximum length: 100
Minimum length: 1
For example:
Is mandatory: No
cites

A CITES identified product.
Data type: string
Maximum length: 100
Minimum length: 1
For example:
Is mandatory: No
taricCode

TARIC codes for this product.
Data type: array [string]
Is mandatory: No
eppoCode

EPPO codes for this product.
Data type: array [string]
Is mandatory: No
naturalTemperatureCategory

Temperature category.
Data type: string using the enumeration TemperatureCategory Ambient, Chilled, Frozen
Is mandatory: Yes

ProductCharacteristic

Product characteristic details.

Property Value
characteristic

Name identifier for the characteristic.
Data type: string
Maximum length: 100
Minimum length: 1
Is mandatory: Yes
characteristicValue

Value for a characteristic.
Data type: object using the model ProductCharacteristicValue
Is mandatory: Yes

ProductCharacteristicValue

Value for a characteristic.

Property Value
addressValue

Address details.

Reference data is available:
Data type: object using the model Address
Is mandatory: No
booleanValue

Value expressed as a Boolean.
Data type: boolean
Is mandatory: No
stringValue

Value expressed as text.
Data type: string
Maximum length: 200
Minimum length: 1
Is mandatory: No
dateTimeValue

Value expressed as a date / time.
Data type: string with format date-time
Is mandatory: No
numberValue

Value expressed as a number.
Data type: number with format double
Is mandatory: No

ProductIdentification

Identification marks relating to the product.

Property Value
mark

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: Yes

ProductSeal

Seal number(s) and issuing authority.

Property Value
sealId

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: Yes

RequestStatus

Statuses for the asynchronous submission of a request message into the system.

Data type: string
Enumeration values: Accepted, SubmissionError, Submitted

RequestStatusDetails

Details of the Request in the system prior to it potentially becoming an Application.

Property Value
_links

Hypermedia as the Engine of Application State (HATEOAS) links to related resources.
Data type: array [object] using the model ResourceLink
Is mandatory: No
requestId

Unique identifier for the request that triggered the generation of the Application.
Data type: string with format uuid
For example: b09fb181-948d-4c0c-9928-bf6d0b7ca357
Is mandatory: No
customerReference

Customer refenence assigned by the originating customer system.
Data type: string
For example: TRD-AAA111-01
Is mandatory: No
status

Statuses for the asynchronous submission of a request message into the system.
Data type: string using the enumeration RequestStatus Accepted, SubmissionError, Submitted
Is mandatory: No
createdOn

Date/time when the Request was created.
Data type: string with format date-time
For example: 2021-02-01T02:05:00.0000000+00:00
Is mandatory: No
lastUpdated

Date/time when the Request was last updated, if an update has occurred.
Data type: string with format date-time
For example: 2021-02-01T04:40:00.0000000+00:00
Is mandatory: No

ResourceLink

Hypermedia as the Engine of Application State (HATEOAS) resource link.

Property Value
href

Uniform Resource Identifier of the resource being linked to.
Data type: string
For example: https://defra.gov.uk/api/v1/example/123
Is mandatory: No
rel

Relationship of the resource.
Data type: string
For example: status
Is mandatory: No
method

HTTP method to use when calling the resource.
Data type: string
For example: GET
Is mandatory: No

SignatoryAuthentication

An signatory document authentication for an exchanged document.

Property Value
name

Name of the organisation providing signoff for the consignment.
Data type: string
Maximum length: 100
Minimum length: 1
Is mandatory: Yes
signatoryAuthenticationId

Registration identifier for the organisation.
Data type: string
Maximum length: 50
Minimum length: 1
Is mandatory: No
type Data type: string using the enumeration AuthenticationType Authority, Veterinary, DEFRAVeterinary
Is mandatory: Yes
address

Address details.

Reference data is available:
Data type: object using the model Address
Is mandatory: No

StorageLocation

The location of the site where the commodity is stored, including approval number and the conditions the store stores the commodity.

Property Value
organisation

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: Yes
location

Details of a location including approval numbers for the establishment.

Reference data is available:
Data type: object using the model Location
Is mandatory: Yes
storageDate

Date/time the products are moved into storage.
Data type: string with format date-time
Is mandatory: No
storageExpiryDate

Date/time the products in storage expires.
Data type: string with format date-time
Is mandatory: No

Temperature

A temperature setting, such as the storage temperature or operational temperature, for this piece of transport equipment.

Reference data is available:

Property Value
value

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: No
minimumValue

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: No
maximumValue

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: No
type

A character string (letters, figures or symbols) that for brevity and/or language independence may be used to represent or replace a definitive value or text of an Attribute together with relevant supplementary information.
Data type: object using the model TypeCode
Is mandatory: No
transportTemperatureCategory

Temperature category.
Data type: string using the enumeration TemperatureCategory Ambient, Chilled, Frozen
Is mandatory: Yes

TemperatureCategory

Temperature category.

Data type: string
Enumeration values: Ambient, Chilled, Frozen

TradeIdentifier

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.

Property Value
id

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects within the same scheme.
Data type: string
Maximum length: 100
Minimum length: 1
Is mandatory: Yes
name

A character string (letters, figures or symbols) that for brevity and/or language independence may be used to represent or replace a definitive value or text of an Attribute.
Data type: string
Maximum length: 100
Minimum length: 1
Is mandatory: No
schemaId

The identification of the identification scheme.
Data type: string
Maximum length: 50
Minimum length: 1
Is mandatory: No
schemaName

The name of the identification scheme.
Data type: string
Maximum length: 100
Minimum length: 1
Is mandatory: No
agencyId

The identification of the agency that maintains the identification scheme.
Data type: string
Maximum length: 50
Minimum length: 1
Is mandatory: No
agencyName

The name of the agency that maintains the identification scheme.
Data type: string
Maximum length: 100
Minimum length: 1
Is mandatory: No
versionId

The Version of the identification scheme.
Data type: string
Maximum length: 50
Minimum length: 1
Is mandatory: No
uniformResourceId

The Uniform Resource Identifier that identifies where the identification scheme data is located.
Data type: string
Maximum length: 50
Minimum length: 1
Is mandatory: No
schemaUniformResourceId

The Uniform Resource Identifier that identifies where the identification scheme is located.
Data type: string
Maximum length: 50
Minimum length: 1
Is mandatory: No
language

The identifier of the language used in the corresponding text string.
Data type: string
Maximum length: 50
Minimum length: 1
For example: EN
Is mandatory: No

TradeLineItem

Describes the commodity, details processes. Functions relating to the commodity.

Reference data is available:

Property Value
sequenceNumber

The sequence number for this trade line item. Starting at 1.
Data type: integer with format int32
Minimum: 1.0
For example: 1
Is mandatory: No
exporterTradeLineReferenceId

An exporter trade line reference for the trade line commodity.
Data type: string
Maximum length: 100
Minimum length: 1
For example:
Is mandatory: Yes
tradeProduct

Details of the Product including identifiers for the commodity.
Data type: object using the model Product
Is mandatory: Yes
productCharacteristic

Detail post-manufacturing characteristics for the resulting product
Data type: array [object] using the model ProductCharacteristic
Is mandatory: No
animalCharacteristic

Detail characteristics of the animal, requested attributes, tests and vaccinations.
Data type: array [object] using the model ProductCharacteristic
Is mandatory: No
aquacultureCharacteristic

Aquaculture characteristics.
Data type: array [object] using the model ProductCharacteristic
Is mandatory: No
container

Details of the container, including markings.
Data type: array [object] using the model Container
Is mandatory: No
productSeal

Seal number(s) and issuing authority.
Data type: array [object] using the model ProductSeal
Is mandatory: No
productIdentification

Identification marks relating to the product.
Data type: array [object] using the model ProductIdentification
Is mandatory: No
productionBatch

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
intendedUse

An intended use, expressed as text, of this trade line item.
Data type: string
Maximum length: 500
Minimum length: 1
Is mandatory: No
expiryDateTime

For products with a life span, provide the expiry date time for the product or output.
Data type: string with format date-time
Is mandatory: No
productImportDate

Import date.
Data type: string with format date-time
Is mandatory: No
measure

Trade measurement details.
Data type: object using the model TradeMeasure
Is mandatory: No
additionalInformationNote

A note providing additional information for this trade line item.
Data type: array [object] using the model Note
Is mandatory: No
applicableClassification

A classification applicable to this trade line item.
Data type: array [object] using the model Classification
Is mandatory: No
physicalPackageCount

A count of packages containing the commodity.
Data type: object using the model PackageCount
Is mandatory: No
physicalPackage

Describe the physical package(s) containing the commodities.
Data type: array [object] using the model Package
Is mandatory: Yes
transportMovement

Describes to equipment used to move the commodity to the loading location.
Data type: array [object] using the model Transport
Is mandatory: Yes
origin

Details of the commodities origin, country and subdivision of the country.
Data type: array [object] using the model Location
Is mandatory: No
appliedProcess

Applied processes.
Data type: array [object] using the model TradeProcess
Is mandatory: No
assertedAuthentication

Asserted authentication mechanisms.
Data type: object using the model AssertedAuthentication
Is mandatory: No
manufacturingPlant

The location of the site where the commodity is manufactured, including the approval number.
Data type: array [object] using the model ManufacturingPlant
Is mandatory: No
abattoir

Details of the site where the commodity is slaughtered, including the locations approval number.
Data type: array [object] using the model Abattoir
Is mandatory: No
cuttingPlant

The location of the site where the commodity is prepared, including the locations approval number.
Data type: array [object] using the model CuttingPlant
Is mandatory: No
factoryVessel

Details of the vessel, including its approval number.
Data type: array [object] using the model FactoryVessel
Is mandatory: No
packingCentre

The location of the site where the commodity is packed, including the approval number.
Data type: array [object] using the model PackingCentre
Is mandatory: No
storage

The location of the site where the commodity is stored, including approval number and the conditions the store stores the commodity.
Data type: array [object] using the model StorageLocation
Is mandatory: No
poultryHatchery

The location of the site where the commodity is incubated, hatched and reared, plus approval number.
Data type: array [object] using the model HatcheryLocation
Is mandatory: No
veterinarianPracticeSignatoryAuthentication

An signatory document authentication for an exchanged document.
Data type: object using the model SignatoryAuthentication
Is mandatory: No

TradeMeasure

Trade measurement details.

Property Value
quantity

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: No
quantityMeasureUnit

Quantity measure unit.
Data type: string
Maximum length: 100
For example:
Is mandatory: No
netWeight

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: No
grossWeight

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: No
netVolume

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: No
grossVolume

A numeric value determined by measuring an object along with the specified unit of measure.
Data type: object using the model Measure
Is mandatory: No
measureNote

Information or additional detail regarding the measure.
Data type: string
Maximum length: 500
Is mandatory: No

TradeProcess

Trade process details.

Property Value
type

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
completionPeriod

The completion period for this process.
Data type: object using the model Period
Is mandatory: No
operationLocation

Details of a location including approval numbers for the establishment.

Reference data is available:
Data type: object using the model Location
Is mandatory: No
operator

The definition of a responsible party in the chain with contact details.
Data type: object using the model Party
Is mandatory: No

Transport

Details the means and mode of transport the consignment will utilise, including any transport identification marks and equipment used to move the commodity to the loading location.

Reference data is available:

Property Value
equipment

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
sealId

Seal identifiers.
Data type: array [object] using the model TradeIdentifier
Is mandatory: No
transportTemperatureCategory

Temperature category.
Data type: string using the enumeration TemperatureCategory Ambient, Chilled, Frozen
Is mandatory: No
meansOfTransport

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
meansOfTransportIdentification

Identification mark attached to the means of transport.
Data type: string
Maximum length: 200
Minimum length: 1
For example:
Is mandatory: No
approvalNumber

A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.A character string to identify and distinguish uniquely, one instance of an object in an identification scheme from all other objects in the same scheme together with relevant supplementary information.
Data type: object using the model TradeIdentifier
Is mandatory: No
document

Document names, supporting the consignment.
Data type: array [object] using the model TransportDocument
Is mandatory: No

TransportDocument

Transport document details.

Property Value
reference

Document reference.
Data type: string
Maximum length: 200
Minimum length: 1
Is mandatory: Yes

TypeCode

A character string (letters, figures or symbols) that for brevity and/or language independence may be used to represent or replace a definitive value or text of an Attribute together with relevant supplementary information.

Property Value
content

A character string (letters, figures or symbols) that for brevity and/or language independence may be used to represent or replace a definitive value or text of an Attribute.
Data type: string
Maximum length: 100
Minimum length: 1
For example: 17
Is mandatory: Yes
codeListId

The identification of a list of codes.
Data type: string
Maximum length: 50
Minimum length: 1
For example:
Is mandatory: No
codeListAgencyId

An agency that maintains one or more code lists.
Data type: string
Maximum length: 50
Minimum length: 1
For example:
Is mandatory: No
codeListAgencyName

The name of the agency that maintains the code list.
Data type: string
Maximum length: 100
Minimum length: 1
For example:
Is mandatory: No
codeListName

The name of a list of codes.
Data type: string
Maximum length: 100
Minimum length: 1
For example:
Is mandatory: No
codeListVersion

The Version of the code list.
Data type: string
Maximum length: 10
Minimum length: 1
For example:
Is mandatory: No
name

The textual equivalent of the code content.
Data type: string
Maximum length: 100
Minimum length: 1
For example: Requested
Is mandatory: Yes
language

The identifier of the language used in the corresponding text string.
Data type: string
Maximum length: 100
Minimum length: 1
For example: EN
Is mandatory: No

What3Words

What 3 Words location identifier details.

Property Value
wordOne

Word one.
Data type: string
Maximum length: 100
Minimum length: 1
For example:
Is mandatory: Yes
wordTwo

Word two.
Data type: string
For example:
Is mandatory: No
wordThree

Word three.
Data type: string
For example:
Is mandatory: No

Downloads

This API follows the OpenApi specification and is available for export and download in the following formats:

Download the OpenAPI 3 JSON file

OpenAPI 3 JSON

JSON, 4 KB

This file contains the JSON Format for OpenApi 3.

Download the OpenAPI 3 YAML file

OpenAPI 3 YAML

YAML, 4 KB

This file contains the YAML Format for OpenApi 3.