Which CDS export specific fields can be used in the API?

A full list of API fields can be found here, but details of fields specific to using the Customs Declaration Service (CDS) for exports can be found below.

Goods Location

The Country and Type fields must be templated, or entered manually, as they are not available in the API.

The Code can be populated from the delivery information via the API, as example below.

"locations" : [ {

        "locationType" : "AGREED_GOODS_LOCATION",

        "name" : "DVRDOVDVR"

      } ],

Parties

Carrier is a required Party for CDS exports and is available in the API as a standard party type. API field example:

"parties": [

                                                {

                                                            "partyType": "CARRIER",

                                                            "name": "Manley Tools",

                                                            "street": "Main Street",

                                                            "city": "That City",

                                                            "postCode": "ABC 456",

                                                            "country": "DK",

                                                            "customsIds": []

                                                },

Transport

The CDS fields highlighted above must be templated, or entered manually, as they are not available in the API. 

Nature of Transact (Header level)

This field must be templated, or entered manually, as at header level this field is not available in the API. This information can be sent at item level via the API.

Authorizations

These fields must be templated, or entered manually, as they are not available in the API.

Countries of Routing

API field example:

"dispatchCountryCode": "GB",

                                                            "destinationCountryCode": "DK",

This example will populate the fields marked in red above. The entries contained in the list will either need to be templated or entered manually.

Nature of Transact (Item level)

API field example:

extension: class ICDeliveryItemExtensionDataDTO {

                              exportGB: class ICDeliveryItemEUDTO {

                    “transactionNatureCode” : “11”

}