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. Retrieve Transactions

List all transactions

Retrieves all transactions of your business

PreviousGet a transaction by idNextModify an existing Transaction

Last updated 3 months ago

List all transactions.

get

Lists all transactions related to your business.

Authorizations
Query parameters
includesanyOptional

A comma-separated list of relations to be included in the response. Possible relations are: components, components.supplierBusiness, components.transaction, components.ddsReferences, dds, dds.ddsReference.

Example: components,components.supplierBusiness
Responses
200
A list of all transactions
application/json
401Error
403Error
get
GET /transactions HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer JWT
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": "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"
  }
]