Update a Transaction

Change data of a transaction, e.g. updating the country of activity.

Update a transaction.

Update the properties of the specified transaction. Handles updates partially.

patch

/transactions/{id}

Authorizations

Path parameters

idstringrequired

Body

countryOfActivitystring

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

customDataobject

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}

isGeoLocationConfidentialboolean

Whether the geolocation data is confidential.

Example: false

customIdstring

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

Example: DEC-24-238620

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.tradeaware.live-eo.com/transactions/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "countryOfActivity": "IT",
    "customData": {
      "key1": "someValue",
      "key2": true,
      "key3": 1234
    },
    "isGeoLocationConfidential": "false",
    "customId": "DEC-24-238620"
  }'

200

400

401

403

404

200

{
  "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": "[Circular Reference]"
    }
  ],
  "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"
  },
  "createdAt": "2023-07-26T15:03:48Z",
  "updatedAt": "2023-07-28T09:13:37Z"
}