Submit a Transaction

Submit a transaction to the EU information system.

Submitting a transaction to the EU information system involves multiple steps. First, when you submit a transaction using the PUT /transaction/{id}/submit endpoint, the status is set to TO_SUBMIT. Within approximately five minutes, our asynchronous processing system picks up the job and submits the transaction to the EU information system TRACES. Once the submission is successful, the status updates to SUBMITTED.

The current status of a transaction can be checked at any time by polling the: GET /transaction/{id} endpoint.

Currently, all transactions are submitted to the TRACES Acceptance environment, which is a test environment and not legally binding.

Submit a transaction to be sent to traces.

put

Update the status property of a transaction to TO_SUBMIT.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

202Success

application/json

idstringRequired

id of this entity

Example: 02c36247-1aad-41ba-aa49-f114ca4c263f

statusstring · enumRequired

Status of this transaction.

Possible values:

customIdstringRequired

Custom identifier. Can be used for internal reference or tracking purposes.

Example: DEC-24-238620

activityTypestringRequired

Type of transaction to be performed.

Example: EXPORT

countryOfActivitystringRequired

Two-letter country code (ISO 3166 Alpha-2) of the place of activity. Depends on activityType. For import, Country of entry into the EU. For Export, Country of exit from the EU. For Domestic Production and Trade, EU country where goods are sourced, manufactured or produced or made available on the market.

Example: IT

isGeoLocationConfidentialbooleanRequired

Whether the geolocation data is confidential.

Example: false

customDataobjectOptional

Metadata related to the transaction. This can be used to store any additional information that is relevant to the transaction. The input object must fulfill the following requirements: - max <=10 keys - max key length of <=255 characters - max string value length of <=255 characters - values must be either strings, number, or booleans - keys cannot contain the substrings proto, constructor, or prototype

Example: {"key1":"someValue","key2":true,"key3":1234}

createdAtstringRequired

ISO 8601

Example: 2023-07-26T15:03:48Z

updatedAtstringRequired

ISO 8601

Example: 2023-07-28T09:13:37Z

400Error

401Error

403Error

404Error

409

409 Conflict when a transaction is already SUBMITTED, AVAILABLE, WITHDRAWN or PROCESSING.

422Error

put

/transactions/{id}/submit

HTTPcURLJavaScriptPython

PUT /transactions/{id}/submit HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
  "status": "DRAFT",
  "customId": "DEC-24-238620",
  "activityType": "EXPORT",
  "countryOfActivity": "IT",
  "isGeoLocationConfidential": "false",
  "components": [
    {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "hsn": "18010000",
      "commodity": "oil palm",
      "quantity": 123.45,
      "unit": "KGM",
      "description": "text",
      "namePairs": [
        {
          "commonName": "soybean",
          "scientificName": "Glycine max"
        }
      ],
      "transactionId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "dateOfProduction": "2021-01-01T00:00:00.000Z",
      "endDateOfProduction": "2021-01-01T00:00:00.000Z",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "supplierBusiness": {
        "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "email": "[email protected]",
        "name": "Example Inc.",
        "username": "John Doe",
        "addressStreet": "Salawati 143",
        "addressZip": "98451",
        "addressPostcode": "12345",
        "addressArea": "Brandenburg",
        "addressCity": "West Papua",
        "addressCountryCode": "ID",
        "addressCountry": "Indonesia",
        "addressLine1": "Salawati 123",
        "addressLine2": "3rd floor",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "initialLocale": "id-ID",
        "units": "metric",
        "plots": [
          "[Circular Reference]"
        ],
        "newlyCreated": "true",
        "members": [
          "[Circular Reference]"
        ],
        "connectionsAsSource": [
          "[Circular Reference]"
        ],
        "connectionsAsTarget": [
          "[Circular Reference]"
        ],
        "businessInvitations": [
          "[Circular Reference]"
        ],
        "contactPerson": "[Circular Reference]",
        "machineToMachineClientId": "1234567890asdfghjk",
        "eori": "text",
        "vat": "text",
        "tracesEnvironment": "ACCEPTANCE"
      },
      "supplierBusinesses": [
        {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "email": "[email protected]",
          "name": "Example Inc.",
          "username": "John Doe",
          "addressStreet": "Salawati 143",
          "addressZip": "98451",
          "addressPostcode": "12345",
          "addressArea": "Brandenburg",
          "addressCity": "West Papua",
          "addressCountryCode": "ID",
          "addressCountry": "Indonesia",
          "addressLine1": "Salawati 123",
          "addressLine2": "3rd floor",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "initialLocale": "id-ID",
          "units": "metric",
          "plots": [
            "[Circular Reference]"
          ],
          "newlyCreated": "true",
          "members": [
            "[Circular Reference]"
          ],
          "connectionsAsSource": [
            "[Circular Reference]"
          ],
          "connectionsAsTarget": [
            "[Circular Reference]"
          ],
          "businessInvitations": [
            "[Circular Reference]"
          ],
          "contactPerson": "[Circular Reference]",
          "machineToMachineClientId": "1234567890asdfghjk",
          "eori": "text",
          "vat": "text",
          "tracesEnvironment": "ACCEPTANCE"
        }
      ],
      "plotIds": [
        "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "02c36247-1aad-41ba-aa49-f114ca4c263f"
      ],
      "ddsReferences": [
        {
          "id": "24DKYIGLPU3439",
          "verificationNumber": "4NAB3QYM"
        }
      ]
    }
  ],
  "customData": {
    "key1": "someValue",
    "key2": true,
    "key3": 1234
  },
  "dds": {
    "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "submitted": false,
    "submittedAt": "2023-07-26T15:03:48Z",
    "tracesDdsReferenceNumber": "25DEPPQEM17212",
    "tracesDdsVerificationNumber": "KZ4BVOCZ",
    "errors": [
      "Error message"
    ],
    "createdAt": "2023-07-26T15:03:48Z",
    "updatedAt": "2023-07-26T15:03:48Z"
  },
  "legalEntity": {
    "name": "Example Palm Oil Trader",
    "email": "[email protected]",
    "addressCity": "West Papua",
    "addressCountryCode": "ID",
    "addressLine1": "Salawati 123",
    "addressLine2": "2nd floor",
    "addressPostcode": "12345",
    "eori": {},
    "vat": "1234567890asdfghjk",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z"
  },
  "createdAt": "2023-07-26T15:03:48Z",
  "updatedAt": "2023-07-28T09:13:37Z"
}