Update a Transaction Component

Change data of an individual component of a transaction.

Update a component.

patch

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

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

hsnstringOptional

HS Code of the product. The HS code consists of at least six digits and is used by customs to classify the product being shipped.

Example: 1201

quantitynumberOptional

Quantity of the product, measured in the specified unit.

Example: 123.45

unitall ofOptional

Measurement unit of the product quantity. Can be one of: LTR, MTR, MTRSQR, MTRCUBE, KGM, TNE, PCS, PR, SET, PKG.

Example: KGM

string · enumOptional

Measurement unit of the product quantity.

Possible values:

descriptionstringOptional

Short description of the product.

dateOfProductionstringOptional

ISO 8601. The time at which the product was produced., For time ranges, also specify the endDateOfProduction.

Example: 2021-01-01T00:00:00.000Z

endDateOfProductionstringOptional

ISO 8601. The time at which a time-ranged production was finalized.

Example: 2022-01-01T00:00:00.000Z

supplierBusinessIdstringOptional

Id of the supplier business for the transaction.

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

supplierBusinessIdsstring[]Optional

Ids of the supplier businesses for the transaction.

Example: ["02c36247-1aad-41ba-aa49-f114ca4c263f"]

plotIdsstring[]Optional

A list of plot IDs to be associated with this component. Omit this field to attach all plots of the supplier business.

Example: ["a78c1a68-d326-4217-a131-893f3c47a064","e8d2e3e6-2c7c-4c4e-98a9-3e3f4e2c1a68"]

Responses

200Success

application/json

idstringRequired

id of this entity

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

hsnstringRequired

HS Code of the product.

Example: 18010000

commodityall ofRequired

Commodity of the product.

Example: oil palm

string · enumOptional

What crops (among the relevant commodities) are grown on this field (currently).

Possible values:

quantitynumberRequired

Quantity of the product, measured in the specified unit.

Example: 123.45

unitall ofRequired

Measurement unit of the product quantity.

Example: KGM

string · enumOptional

Measurement unit of the product quantity.

Possible values:

descriptionstringRequired

Short description of the product.

transactionIdstringRequired

Id of the transaction that this component belongs to

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

dateOfProductionstringOptional

ISO 8601. The time at which the product was produced., Can be a time range if endDateOfProduction is specified.

Example: 2021-01-01T00:00:00.000Z

endDateOfProductionstringOptional

ISO 8601. The time at which a time-ranged production was finalized.

Example: 2021-01-01T00:00:00.000Z

createdAtstringRequired

ISO 8601

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

updatedAtstringRequired

ISO 8601

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

plotIdsstring[]Optional

Ids of the plots associated with this component.

Example: ["02c36247-1aad-41ba-aa49-f114ca4c263f","02c36247-1aad-41ba-aa49-f114ca4c263f"]

400Error

401Error

403Error

404Error

patch

/components/{id}

HTTPcURLJavaScriptPython

PATCH /components/{id} HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 587

{
  "hsn": "1201",
  "quantity": 123.45,
  "unit": "KGM",
  "description": "text",
  "namePairs": [
    {
      "commonName": "soybean",
      "scientificName": "Glycine max"
    },
    {
      "commonName": "edamame",
      "scientificName": "Glycine max var. viridis"
    }
  ],
  "dateOfProduction": "2021-01-01T00:00:00.000Z",
  "endDateOfProduction": "2022-01-01T00:00:00.000Z",
  "supplierBusinessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
  "supplierBusinessIds": [
    "02c36247-1aad-41ba-aa49-f114ca4c263f"
  ],
  "plotIds": [
    "a78c1a68-d326-4217-a131-893f3c47a064",
    "e8d2e3e6-2c7c-4c4e-98a9-3e3f4e2c1a68"
  ],
  "ddsReferences": [
    {
      "id": "24DKYIGLPU3439",
      "verificationNumber": "4NAB3QYM"
    }
  ]
}

{
  "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": [
      {
        "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "suppliers": [
          "[Circular Reference]"
        ],
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                100,
                0
              ],
              [
                100.01,
                0
              ],
              [
                100.01,
                0.01
              ],
              [
                100,
                0.01
              ],
              [
                100,
                0
              ]
            ]
          ]
        },
        "commodities": [
          "oil palm",
          "rubber"
        ],
        "name": "text",
        "surfaceArea": 1,
        "countryCode": "text",
        "mostRecentAnalysis": {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "status": "PENDING",
          "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "analysedAt": "2023-07-28T09:13:37Z",
          "version": "open-source-1.0.0",
          "deforestedArea": 123.45,
          "deforestedGeometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  13,
                  52.5
                ],
                [
                  13.5,
                  52.5
                ],
                [
                  13.5,
                  52
                ],
                [
                  13,
                  52
                ],
                [
                  13,
                  52.5
                ]
              ]
            ]
          },
          "riskOfDeforestation": 0.3,
          "type": "OS",
          "customData": {
            "some": "metadata"
          },
          "name": "text"
        },
        "mostRecentAnalysesByType": {
          "EUFOROBS": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "PENDING",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "OS",
            "customData": {
              "some": "metadata"
            },
            "name": "text"
          },
          "PRECISION": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "PENDING",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "OS",
            "customData": {
              "some": "metadata"
            },
            "name": "text"
          }
        },
        "riskAssessmentStatus": "NEW",
        "riskLevel": "none",
        "filename": {},
        "description": "text",
        "ownerId": "text",
        "customData": {
          "key1": "someValue",
          "key2": true,
          "key3": 1234
        }
      }
    ],
    "newlyCreated": "true",
    "members": [
      {
        "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
        "business": "[Circular Reference]",
        "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "firstName": "Paul",
        "lastName": "Smith",
        "locale": "id-ID",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "completed": "false",
        "businessInvitations": [
          "[Circular Reference]"
        ],
        "userInvitations": [
          "[Circular Reference]"
        ],
        "email": "[email protected]",
        "consentedAt": "2023-07-28T09:13:37Z",
        "entitlements": {
          "canTriggerPrecisionAnalysis": false,
          "canManageTransactions": false,
          "canViewSurveys": false,
          "canViewOwnedSurveyResponses": true,
          "canViewSurveyResponsesOfTier1Suppliers": false,
          "canMutateOwnedSurveyResponses": false,
          "canDownloadSurveyResponses": false,
          "canManageWebhooks": false,
          "canAccessApi": false,
          "canManageCmsSupplierRiskAssessmentStatuses": false
        }
      }
    ],
    "connectionsAsSource": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "sourceBusiness": "[Circular Reference]",
        "targetBusiness": "[Circular Reference]",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "customData": {
          "foo": "bar"
        },
        "plotsCount": 1,
        "plotsCommodities": [
          "cattle",
          "cocoa"
        ]
      }
    ],
    "connectionsAsTarget": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "sourceBusiness": "[Circular Reference]",
        "targetBusiness": "[Circular Reference]",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "customData": {
          "foo": "bar"
        },
        "plotsCount": 1,
        "plotsCommodities": [
          "cattle",
          "cocoa"
        ]
      }
    ],
    "businessInvitations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "sentByUser": "[Circular Reference]",
        "business": "[Circular Reference]",
        "email": "[email protected]",
        "status": "PENDING",
        "createdAt": "2020-01-01T00:00:00.000Z",
        "updatedAt": "2020-01-01T00:00:00.000Z",
        "sourceIsInvitee": "true",
        "customData": {
          "key1": "someValue",
          "key2": true,
          "key3": 1234
        }
      }
    ],
    "contactPerson": {
      "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
      "business": "[Circular Reference]",
      "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "firstName": "Paul",
      "lastName": "Smith",
      "locale": "id-ID",
      "createdAt": "2023-07-26T15:03:48Z",
      "updatedAt": "2023-07-28T09:13:37Z",
      "completed": "false",
      "businessInvitations": [
        "[Circular Reference]"
      ],
      "userInvitations": [
        "[Circular Reference]"
      ],
      "email": "[email protected]",
      "consentedAt": "2023-07-28T09:13:37Z",
      "entitlements": {
        "canTriggerPrecisionAnalysis": false,
        "canManageTransactions": false,
        "canViewSurveys": false,
        "canViewOwnedSurveyResponses": true,
        "canViewSurveyResponsesOfTier1Suppliers": false,
        "canMutateOwnedSurveyResponses": false,
        "canDownloadSurveyResponses": false,
        "canManageWebhooks": false,
        "canAccessApi": false,
        "canManageCmsSupplierRiskAssessmentStatuses": false
      }
    },
    "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": [
        {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "suppliers": [
            "[Circular Reference]"
          ],
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  100,
                  0
                ],
                [
                  100.01,
                  0
                ],
                [
                  100.01,
                  0.01
                ],
                [
                  100,
                  0.01
                ],
                [
                  100,
                  0
                ]
              ]
            ]
          },
          "commodities": [
            "oil palm",
            "rubber"
          ],
          "name": "text",
          "surfaceArea": 1,
          "countryCode": "text",
          "mostRecentAnalysis": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "PENDING",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "OS",
            "customData": {
              "some": "metadata"
            },
            "name": "text"
          },
          "mostRecentAnalysesByType": {
            "EUFOROBS": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "PENDING",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "OS",
              "customData": {
                "some": "metadata"
              },
              "name": "text"
            },
            "PRECISION": {
              "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "createdAt": "2023-07-26T15:03:48Z",
              "updatedAt": "2023-07-28T09:13:37Z",
              "status": "PENDING",
              "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
              "analysedAt": "2023-07-28T09:13:37Z",
              "version": "open-source-1.0.0",
              "deforestedArea": 123.45,
              "deforestedGeometry": {
                "type": "Polygon",
                "coordinates": [
                  [
                    [
                      13,
                      52.5
                    ],
                    [
                      13.5,
                      52.5
                    ],
                    [
                      13.5,
                      52
                    ],
                    [
                      13,
                      52
                    ],
                    [
                      13,
                      52.5
                    ]
                  ]
                ]
              },
              "riskOfDeforestation": 0.3,
              "type": "OS",
              "customData": {
                "some": "metadata"
              },
              "name": "text"
            }
          },
          "riskAssessmentStatus": "NEW",
          "riskLevel": "none",
          "filename": {},
          "description": "text",
          "ownerId": "text",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "newlyCreated": "true",
      "members": [
        {
          "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
          "business": "[Circular Reference]",
          "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "firstName": "Paul",
          "lastName": "Smith",
          "locale": "id-ID",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "completed": "false",
          "businessInvitations": [
            "[Circular Reference]"
          ],
          "userInvitations": [
            "[Circular Reference]"
          ],
          "email": "[email protected]",
          "consentedAt": "2023-07-28T09:13:37Z",
          "entitlements": {
            "canTriggerPrecisionAnalysis": false,
            "canManageTransactions": false,
            "canViewSurveys": false,
            "canViewOwnedSurveyResponses": true,
            "canViewSurveyResponsesOfTier1Suppliers": false,
            "canMutateOwnedSurveyResponses": false,
            "canDownloadSurveyResponses": false,
            "canManageWebhooks": false,
            "canAccessApi": false,
            "canManageCmsSupplierRiskAssessmentStatuses": false
          }
        }
      ],
      "connectionsAsSource": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "connectionsAsTarget": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sourceBusiness": "[Circular Reference]",
          "targetBusiness": "[Circular Reference]",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "customData": {
            "foo": "bar"
          },
          "plotsCount": 1,
          "plotsCommodities": [
            "cattle",
            "cocoa"
          ]
        }
      ],
      "businessInvitations": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sentByUser": "[Circular Reference]",
          "business": "[Circular Reference]",
          "email": "[email protected]",
          "status": "PENDING",
          "createdAt": "2020-01-01T00:00:00.000Z",
          "updatedAt": "2020-01-01T00:00:00.000Z",
          "sourceIsInvitee": "true",
          "customData": {
            "key1": "someValue",
            "key2": true,
            "key3": 1234
          }
        }
      ],
      "contactPerson": {
        "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
        "business": "[Circular Reference]",
        "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "firstName": "Paul",
        "lastName": "Smith",
        "locale": "id-ID",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "completed": "false",
        "businessInvitations": [
          "[Circular Reference]"
        ],
        "userInvitations": [
          "[Circular Reference]"
        ],
        "email": "[email protected]",
        "consentedAt": "2023-07-28T09:13:37Z",
        "entitlements": {
          "canTriggerPrecisionAnalysis": false,
          "canManageTransactions": false,
          "canViewSurveys": false,
          "canViewOwnedSurveyResponses": true,
          "canViewSurveyResponsesOfTier1Suppliers": false,
          "canMutateOwnedSurveyResponses": false,
          "canDownloadSurveyResponses": false,
          "canManageWebhooks": false,
          "canAccessApi": false,
          "canManageCmsSupplierRiskAssessmentStatuses": false
        }
      },
      "machineToMachineClientId": "1234567890asdfghjk",
      "eori": "text",
      "vat": "text",
      "tracesEnvironment": "ACCEPTANCE"
    }
  ],
  "plotIds": [
    "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "02c36247-1aad-41ba-aa49-f114ca4c263f"
  ],
  "ddsReferences": [
    {
      "id": "24DKYIGLPU3439",
      "verificationNumber": "4NAB3QYM"
    }
  ]
}