TradeAware
  • Welcome to TradeAware User Guide
    • Getting Started
  • Using the TradeAware Web App
    • Upload and Analyzing Plots
    • Connect with your supply chain
    • Risk Assessment
    • Transaction Management
    • Document Management
    • Plot Upload and Analysis Trouble Shooting
    • How-to videos
  • Using the TradeAware API
    • API Access and Business Account Registration
    • Authentication
      • Rotate client secret
      • Endpoints enabled for programmatic access
    • Plot Uploading and Analysis Requests
    • Commercial network management
    • Transaction Management
    • API reference
      • Auth
      • Plots
        • Analyses of a specific Plot
        • Batch
      • Analyses
      • Attachments
      • Business invitations
      • Business connections
      • Transactions
        • Create a Transaction
        • Retrieve Transactions
          • Get a transaction by id
          • List all transactions
        • Modify an existing Transaction
          • Update a Transaction
          • Add a Transaction Component
          • Update a Transaction Component
          • Delete a Transaction Component
        • Delete a Transaction
        • Submit a Transaction
        • Retrieve DDS Data
      • Risk Assessments
        • Supplier Risk Assessments
          • Create a Supplier Risk Assessment
          • Update a Supplier Risk Assessment
          • Retrieve Supplier Risk Assessments
            • Get a supplier risk assessment by id
            • Get all supplier risk assessments
          • Retrieve the history
        • Plot Risk Assessments
          • Create a Plot Risk Assessment
          • Update a Plot Risk Assessment
          • Retrieve Plot Risk Assessments
            • Get a plot risk assessment by id
            • Get all plot risk assessments
          • Retrieve the history
      • Survey responses
      • Health
      • Version
      • Specification
  • Additional Resources
    • FAQs
    • Contact Support
    • Terms and Conditions
Powered by GitBook
On this page
  1. Using the TradeAware API
  2. API reference
  3. Transactions
  4. Modify an existing Transaction

Update a Transaction

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

PreviousModify an existing TransactionNextAdd a Transaction Component

Last updated 3 months ago

Update a transaction.

patch

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

Authorizations
Path parameters
idstringRequired
Body
countryOfActivitystringOptional

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
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}
isGeoLocationConfidentialbooleanOptional

Whether the geolocation data is confidential.

Example: false
customIdstringOptional

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

Example: DEC-24-238620
Responses
200Success
application/json
400Error
401Error
403Error
404Error
patch
PATCH /transactions/{id} HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "countryOfActivity": "IT",
  "customData": {
    "key1": "someValue",
    "key2": true,
    "key3": 1234
  },
  "isGeoLocationConfidential": "false",
  "customId": "DEC-24-238620"
}
{
  "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": "user@example.com",
        "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"
      }
    }
  ],
  "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"
}