Add a Transaction Component
Add a component to an existing transaction.
Components can either be of type InternalSupplierComponent or DdsReferenceComponent.
InternalSupplierComponent: Use an
InternalSupplierComponentto select the neccessary geolocation information from a supplier.DdsReferenceComponent: If the product was already part of a previous dds, it can be references using a
DdsReferenceComponent.
Create a new component for the specified transaction.
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.
120190Quantity of the product, measured in the specified unit.
123.45Measurement unit of the product quantity.
A supplementary quantity in addition to quantity/unit (e.g. head count for live animals, cubic metres for wood), per the EUDR Guidance for Units of Measure (Annex I). Always optional - never required to create or update a component, so existing components/transactions are never blocked by it. Only meaningful alongside a resolvable supplementaryUnitQualifier (either provided explicitly, or defaulted from the HS code).
12The type of supplementaryUnit (e.g. "NAR" for head count, "MTQ" for cubic metres), per the EUDR Guidance for Units of Measure (Annex I). Required whenever supplementaryUnit is provided and the HS code has no built-in default qualifier; also usable to override the built-in default for HS codes that have one. Must be a valid EUDR SupplementaryUnitQualifier code.
NARPossible values: An optional percentage estimate or deviation for the declared quantity, per the EUDR Operator API Reference (GoodsMeasureType). Never required - purely informational for callers who want to provide it.
5Short description of the product.
ISO 8601. The time at which the product was produced., For time ranges, also specify the endDateOfProduction.
2021-01-01T00:00:00.000ZISO 8601. The time at which a time-ranged production was finalized.
2022-01-01T00:00:00.000ZId of the supplier business for the transaction.
02c36247-1aad-41ba-aa49-f114ca4c263fIds of the supplier businesses for the transaction.
["02c36247-1aad-41ba-aa49-f114ca4c263f"]A list of plot IDs to be associated with this component. Omit this field to attach all plots of the supplier business.
["a78c1a68-d326-4217-a131-893f3c47a064","e8d2e3e6-2c7c-4c4e-98a9-3e3f4e2c1a68"]Ids of the catalog Products this component represents. Optional — a component added from an HS code alone has no product link. May be provided together with plotIds; when both are set, DDS submission uses the union of plots derived from the products and the explicit plotIds.
["02c36247-1aad-41ba-aa49-f114ca4c263f"]id of this entity
02c36247-1aad-41ba-aa49-f114ca4c263fHS Code of the product.
18010000What crops (among the relevant commodities) are grown on this field (currently).
Quantity of the product, measured in the specified unit.
123.45Measurement unit of the product quantity.
A supplementary quantity in addition to quantity/unit (e.g. head count for live animals, cubic metres for wood), per the EUDR Guidance for Units of Measure (Annex I). Always optional.
12The type of supplementaryUnit (e.g. "NAR" for head count, "MTQ" for cubic metres), per the EUDR Guidance for Units of Measure (Annex I).
NARAn optional percentage estimate or deviation for the declared quantity, per the EUDR Operator API Reference (GoodsMeasureType). Never required - purely informational for callers who want to provide it.
5Short description of the product.
Id of the transaction that this component belongs to
02c36247-1aad-41ba-aa49-f114ca4c263fISO 8601. The time at which the product was produced., Can be a time range if endDateOfProduction is specified.
2021-01-01T00:00:00.000ZISO 8601. The time at which a time-ranged production was finalized.
2021-01-01T00:00:00.000ZISO 8601
2023-07-26T15:03:48ZISO 8601
2023-07-28T09:13:37ZIds of the plots associated with this component.
["02c36247-1aad-41ba-aa49-f114ca4c263f","02c36247-1aad-41ba-aa49-f114ca4c263f"]POST /transactions/{id}/components HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 737
{
"hsn": "120190",
"quantity": 123.45,
"unit": "KGM",
"supplementaryUnit": 12,
"supplementaryUnitQualifier": "NAR",
"percentageEstimationOrDeviation": 5,
"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"
],
"productIds": [
"02c36247-1aad-41ba-aa49-f114ca4c263f"
],
"ddsReferences": [
{
"id": "24DKYIGLPU3439",
"verificationNumber": "4NAB3QYM"
}
]
}{
"id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
"hsn": "18010000",
"commodity": "oil palm",
"quantity": 123.45,
"unit": "KGM",
"supplementaryUnit": 12,
"supplementaryUnitQualifier": "NAR",
"percentageEstimationOrDeviation": 5,
"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": [
{
"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",
"species": [
{
"scientificName": "Tectona grandis",
"commonName": "Teak"
}
],
"productionDateStart": {},
"productionDateEnd": {},
"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": "user@example.com",
"consentedAt": "2023-07-28T09:13:37Z",
"entitlements": {
"canTriggerPrecisionAnalysis": false,
"canManageTransactions": false,
"canViewCmsSurveyResponsesOfTier1Suppliers": false,
"canDownloadSurveyResponses": false,
"canDownloadCmsSurveyResponses": false,
"canManageWebhooks": false,
"canAccessApi": false,
"canManageCmsSupplierRiskAssessmentStatuses": false,
"canViewCmsSurveys": false,
"canViewSupplierRiskScore": 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": "user@example.com",
"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": "user@example.com",
"consentedAt": "2023-07-28T09:13:37Z",
"entitlements": {
"canTriggerPrecisionAnalysis": false,
"canManageTransactions": false,
"canViewCmsSurveyResponsesOfTier1Suppliers": false,
"canDownloadSurveyResponses": false,
"canDownloadCmsSurveyResponses": false,
"canManageWebhooks": false,
"canAccessApi": false,
"canManageCmsSupplierRiskAssessmentStatuses": false,
"canViewCmsSurveys": false,
"canViewSupplierRiskScore": false
}
},
"machineToMachineClientId": "1234567890asdfghjk",
"eori": "text",
"vat": "text",
"tracesEnvironment": "ACCEPTANCE"
},
"supplierBusinesses": [
{
"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": [
{
"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",
"species": [
{
"scientificName": "Tectona grandis",
"commonName": "Teak"
}
],
"productionDateStart": {},
"productionDateEnd": {},
"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": "user@example.com",
"consentedAt": "2023-07-28T09:13:37Z",
"entitlements": {
"canTriggerPrecisionAnalysis": false,
"canManageTransactions": false,
"canViewCmsSurveyResponsesOfTier1Suppliers": false,
"canDownloadSurveyResponses": false,
"canDownloadCmsSurveyResponses": false,
"canManageWebhooks": false,
"canAccessApi": false,
"canManageCmsSupplierRiskAssessmentStatuses": false,
"canViewCmsSurveys": false,
"canViewSupplierRiskScore": 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": "user@example.com",
"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": "user@example.com",
"consentedAt": "2023-07-28T09:13:37Z",
"entitlements": {
"canTriggerPrecisionAnalysis": false,
"canManageTransactions": false,
"canViewCmsSurveyResponsesOfTier1Suppliers": false,
"canDownloadSurveyResponses": false,
"canDownloadCmsSurveyResponses": false,
"canManageWebhooks": false,
"canAccessApi": false,
"canManageCmsSupplierRiskAssessmentStatuses": false,
"canViewCmsSurveys": false,
"canViewSupplierRiskScore": false
}
},
"machineToMachineClientId": "1234567890asdfghjk",
"eori": "text",
"vat": "text",
"tracesEnvironment": "ACCEPTANCE"
}
],
"plotIds": [
"02c36247-1aad-41ba-aa49-f114ca4c263f",
"02c36247-1aad-41ba-aa49-f114ca4c263f"
],
"products": [
{
"id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
"name": "Rough-sawn oak boards",
"hsCode": "440312"
}
],
"ddsReferences": [
{
"id": "24DKYIGLPU3439",
"verificationNumber": "4NAB3QYM"
}
]
}Last updated