> For the complete documentation index, see [llms.txt](https://docs.live-eo.com/tradeaware/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.live-eo.com/tradeaware/using-the-tradeaware-api/api-reference/products.md).

# Products

Product-to-plot linking lets you work with EUDR data at the level you trade: products.&#x20;

User guides: <[link](https://docs.live-eo.com/tradeaware/using-the-tradeaware-api/manage-products-and-plot-links)>

## Create a product.

> Creates a product owned by the active business. Ownership is set server-side and can't be changed afterwards.

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"servers":[{"url":"https://api.tradeaware.live-eo.com"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreateProductDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the product."},"hsCode":{"type":"string","description":"HS code of the product, as listed in Annex I to Regulation (EEC) No 2658/87. Separators are optional: \"4403.12\" and \"440312\" are equivalent."},"buyerProductRef":{"type":"string","description":"The buyer's own reference for this product."},"description":{"type":"string","description":"Short description of the product."}},"required":["name","hsCode"]},"GetProductDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this product."},"name":{"type":"string","description":"Name of the product."},"hsCode":{"type":"string","nullable":true,"description":"HS code of the product, as a number string without separators."},"description":{"type":"string","nullable":true,"description":"Short description of the product."},"commodity":{"nullable":true,"description":"Commodity of the product, derived from its HS code.","allOf":[{"$ref":"#/components/schemas/Commodity"}]},"buyerProductRef":{"type":"string","nullable":true,"description":"The buyer's own reference for this product."},"ownerId":{"type":"string","description":"Id of the business owning this product."},"ownerName":{"type":"string","nullable":true,"description":"Name of the business owning this product."},"ownedByCaller":{"type":"boolean","description":"Whether the active business owns this product, as opposed to supplying it."},"suppliers":{"description":"The product's suppliers, alphabetically and limited to 3.\n      Only present with 'includes=suppliers'. The product owner sees every supplier, a product supplier sees only itself.","type":"array","items":{"$ref":"#/components/schemas/GetProductSupplierDto"}},"suppliersTotal":{"type":"number","description":"Total number of suppliers the product has.\n      Only present with 'includes=suppliers'. The product owner sees the full count, a product supplier sees 1."},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"}},"required":["id","name","hsCode","description","commodity","buyerProductRef","ownerId","ownerName","ownedByCaller","createdAt","updatedAt"]},"Commodity":{"type":"string","enum":["cattle","cocoa","coffee","oil palm","rubber","soya","timber"],"description":"What crops (among the relevant commodities) are grown on this field (currently)."},"GetProductSupplierDto":{"type":"object","properties":{"supplierId":{"type":"string","description":"Id of the supplier business this product is shared with."},"supplierName":{"type":"string","nullable":true,"description":"Name of the supplier business."},"plotsExpiryDate":{"type":"string","nullable":true,"description":"The date the supplier's whole assigned-plots set expires on, or null.\n      Informative only — expired assignments stay visible and editable."},"assignedPlotsCount":{"type":"number","description":"How many plots the supplier has assigned to this product, excluding deleted plots."}},"required":["supplierId","supplierName","plotsExpiryDate","assignedPlotsCount"]}}},"paths":{"/products":{"post":{"description":"Creates a product owned by the active business. Ownership is set server-side and can't be changed afterwards.","operationId":"ProductsController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProductDto"}}}},"401":{"description":""},"403":{"description":""}},"summary":"Create a product.","tags":["Products"]}}}}
```

## Create products in batch.

> Creates many products owned by the active business in one call.\
> \
> Every valid row is created; each rejected row is reported individually with its index, a machine parseable code and a message. Rows are validated with the same rules as \`POST /products\`. A row whose \`buyerProductRef\` is already used by a live product of the business, or by an earlier row in the request, is rejected; rows without a ref are never treated as duplicates.\
> \
> Always responds with 201, including when every row was rejected: inspect \`status\` rather than the HTTP code to determine the outcome.

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"servers":[{"url":"https://api.tradeaware.live-eo.com"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreateProductsBatchDto":{"type":"object","properties":{"products":{"description":"Products to create, each shaped like the `POST /products` body. Between 1 and 1000 rows.","minItems":1,"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/CreateProductDto"}}},"required":["products"]},"CreateProductDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the product."},"hsCode":{"type":"string","description":"HS code of the product, as listed in Annex I to Regulation (EEC) No 2658/87. Separators are optional: \"4403.12\" and \"440312\" are equivalent."},"buyerProductRef":{"type":"string","description":"The buyer's own reference for this product."},"description":{"type":"string","description":"Short description of the product."}},"required":["name","hsCode"]},"ResponseCreateProductsBatchDto":{"type":"object","properties":{"status":{"type":"string","description":"Overall result. FAILURE means no product was created; the per row detail is still present.","enum":["SUCCESS","PARTIAL_FAILURE","FAILURE"]},"summary":{"$ref":"#/components/schemas/CreateProductsBatchSummaryDto"},"created":{"type":"array","items":{"$ref":"#/components/schemas/CreatedProductEntryDto"}},"failed":{"type":"array","items":{"$ref":"#/components/schemas/FailedProductEntryDto"}}},"required":["status","summary","created","failed"]},"CreateProductsBatchSummaryDto":{"type":"object","properties":{"total":{"type":"number","description":"Number of rows in the request."},"created":{"type":"number","description":"Number of products created."},"failed":{"type":"number","description":"Number of rows rejected."}},"required":["total","created","failed"]},"CreatedProductEntryDto":{"type":"object","properties":{"index":{"type":"number","description":"Zero based position of the row in the request `products` array."},"product":{"description":"The created product.","allOf":[{"$ref":"#/components/schemas/GetProductDto"}]}},"required":["index","product"]},"GetProductDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this product."},"name":{"type":"string","description":"Name of the product."},"hsCode":{"type":"string","nullable":true,"description":"HS code of the product, as a number string without separators."},"description":{"type":"string","nullable":true,"description":"Short description of the product."},"commodity":{"nullable":true,"description":"Commodity of the product, derived from its HS code.","allOf":[{"$ref":"#/components/schemas/Commodity"}]},"buyerProductRef":{"type":"string","nullable":true,"description":"The buyer's own reference for this product."},"ownerId":{"type":"string","description":"Id of the business owning this product."},"ownerName":{"type":"string","nullable":true,"description":"Name of the business owning this product."},"ownedByCaller":{"type":"boolean","description":"Whether the active business owns this product, as opposed to supplying it."},"suppliers":{"description":"The product's suppliers, alphabetically and limited to 3.\n      Only present with 'includes=suppliers'. The product owner sees every supplier, a product supplier sees only itself.","type":"array","items":{"$ref":"#/components/schemas/GetProductSupplierDto"}},"suppliersTotal":{"type":"number","description":"Total number of suppliers the product has.\n      Only present with 'includes=suppliers'. The product owner sees the full count, a product supplier sees 1."},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"}},"required":["id","name","hsCode","description","commodity","buyerProductRef","ownerId","ownerName","ownedByCaller","createdAt","updatedAt"]},"Commodity":{"type":"string","enum":["cattle","cocoa","coffee","oil palm","rubber","soya","timber"],"description":"What crops (among the relevant commodities) are grown on this field (currently)."},"GetProductSupplierDto":{"type":"object","properties":{"supplierId":{"type":"string","description":"Id of the supplier business this product is shared with."},"supplierName":{"type":"string","nullable":true,"description":"Name of the supplier business."},"plotsExpiryDate":{"type":"string","nullable":true,"description":"The date the supplier's whole assigned-plots set expires on, or null.\n      Informative only — expired assignments stay visible and editable."},"assignedPlotsCount":{"type":"number","description":"How many plots the supplier has assigned to this product, excluding deleted plots."}},"required":["supplierId","supplierName","plotsExpiryDate","assignedPlotsCount"]},"FailedProductEntryDto":{"type":"object","properties":{"index":{"type":"number","description":"Zero based position of the row in the request `products` array."},"name":{"type":"string","description":"The row name, when it sent a string one.","nullable":true},"code":{"type":"string","description":"Machine parseable reason the row was rejected.","enum":["VALIDATION_FAILED","PRODUCT_ALREADY_EXISTS","DUPLICATE_IN_REQUEST","INTERNAL_ERROR"]},"message":{"type":"string","description":"Human readable detail for this failure."},"existingProductId":{"type":"string","description":"For PRODUCT_ALREADY_EXISTS, the id of the existing product with this buyerProductRef."},"duplicateOfIndex":{"type":"number","description":"For DUPLICATE_IN_REQUEST, the index of the earlier row with the same buyerProductRef."}},"required":["index","name","code","message"]}}},"paths":{"/products/batch":{"post":{"description":"Creates many products owned by the active business in one call.\n\nEvery valid row is created; each rejected row is reported individually with its index, a machine parseable code and a message. Rows are validated with the same rules as `POST /products`. A row whose `buyerProductRef` is already used by a live product of the business, or by an earlier row in the request, is rejected; rows without a ref are never treated as duplicates.\n\nAlways responds with 201, including when every row was rejected: inspect `status` rather than the HTTP code to determine the outcome.","operationId":"ProductsController_createInBatch","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductsBatchDto"}}}},"responses":{"201":{"description":"Per row outcome of the batch. Returned for full success, partial failure and total failure alike.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCreateProductsBatchDto"}}}},"400":{"description":"`products` is missing, not an array, empty, or longer than the limit."},"401":{"description":""},"403":{"description":""}},"summary":"Create products in batch.","tags":["Products"]}}}}
```

## Set a product's suppliers.

> Sets the product's supplier list, sharing the product with the suppliers in the\
> &#x20;     list and unsharing it from the suppliers no longer in the list. Sending an empty\
> &#x20;     list unshares the product from all suppliers. The caller must be the owner of the\
> &#x20;     product and have a business connection to each supplier sent.

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"servers":[{"url":"https://api.tradeaware.live-eo.com"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"SetProductSuppliersDto":{"type":"object","properties":{"supplierIds":{"maxItems":1000,"description":"The new product's supplier list. Each id must be a business the caller is connected to as buyer. An empty list removes all suppliers.","type":"array","items":{"type":"string"}}},"required":["supplierIds"]},"GetProductSupplierDto":{"type":"object","properties":{"supplierId":{"type":"string","description":"Id of the supplier business this product is shared with."},"supplierName":{"type":"string","nullable":true,"description":"Name of the supplier business."},"plotsExpiryDate":{"type":"string","nullable":true,"description":"The date the supplier's whole assigned-plots set expires on, or null.\n      Informative only — expired assignments stay visible and editable."},"assignedPlotsCount":{"type":"number","description":"How many plots the supplier has assigned to this product, excluding deleted plots."}},"required":["supplierId","supplierName","plotsExpiryDate","assignedPlotsCount"]}}},"paths":{"/products/{productId}/suppliers":{"put":{"description":"Sets the product's supplier list, sharing the product with the suppliers in the\n      list and unsharing it from the suppliers no longer in the list. Sending an empty\n      list unshares the product from all suppliers. The caller must be the owner of the\n      product and have a business connection to each supplier sent.","operationId":"ProductSuppliersController_set","parameters":[{"name":"productId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetProductSuppliersDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetProductSupplierDto"}}}}},"401":{"description":""},"403":{"description":""},"404":{"description":""}},"summary":"Set a product's suppliers.","tags":["Products"]}}}}
```

## Delete a product.

> Soft-deletes a product owned by the active business. Deleted products are excluded from the listing.

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"servers":[{"url":"https://api.tradeaware.live-eo.com"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/products/{id}":{"delete":{"description":"Soft-deletes a product owned by the active business. Deleted products are excluded from the listing.","operationId":"ProductsController_remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":""},"401":{"description":""},"403":{"description":""},"404":{"description":""}},"summary":"Delete a product.","tags":["Products"]}}}}
```

## Update a product.

> Partially updates a product owned by the active business. Ownership is immutable.

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"servers":[{"url":"https://api.tradeaware.live-eo.com"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateProductDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the product."},"hsCode":{"type":"string","description":"HS code of the product, as listed in Annex I to Regulation (EEC) No 2658/87. Separators are optional: \"4403.12\" and \"440312\" are equivalent."},"buyerProductRef":{"type":"string","description":"The buyer's own reference for this product."},"description":{"type":"string","description":"Short description of the product."}}},"GetProductDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this product."},"name":{"type":"string","description":"Name of the product."},"hsCode":{"type":"string","nullable":true,"description":"HS code of the product, as a number string without separators."},"description":{"type":"string","nullable":true,"description":"Short description of the product."},"commodity":{"nullable":true,"description":"Commodity of the product, derived from its HS code.","allOf":[{"$ref":"#/components/schemas/Commodity"}]},"buyerProductRef":{"type":"string","nullable":true,"description":"The buyer's own reference for this product."},"ownerId":{"type":"string","description":"Id of the business owning this product."},"ownerName":{"type":"string","nullable":true,"description":"Name of the business owning this product."},"ownedByCaller":{"type":"boolean","description":"Whether the active business owns this product, as opposed to supplying it."},"suppliers":{"description":"The product's suppliers, alphabetically and limited to 3.\n      Only present with 'includes=suppliers'. The product owner sees every supplier, a product supplier sees only itself.","type":"array","items":{"$ref":"#/components/schemas/GetProductSupplierDto"}},"suppliersTotal":{"type":"number","description":"Total number of suppliers the product has.\n      Only present with 'includes=suppliers'. The product owner sees the full count, a product supplier sees 1."},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"}},"required":["id","name","hsCode","description","commodity","buyerProductRef","ownerId","ownerName","ownedByCaller","createdAt","updatedAt"]},"Commodity":{"type":"string","enum":["cattle","cocoa","coffee","oil palm","rubber","soya","timber"],"description":"What crops (among the relevant commodities) are grown on this field (currently)."},"GetProductSupplierDto":{"type":"object","properties":{"supplierId":{"type":"string","description":"Id of the supplier business this product is shared with."},"supplierName":{"type":"string","nullable":true,"description":"Name of the supplier business."},"plotsExpiryDate":{"type":"string","nullable":true,"description":"The date the supplier's whole assigned-plots set expires on, or null.\n      Informative only — expired assignments stay visible and editable."},"assignedPlotsCount":{"type":"number","description":"How many plots the supplier has assigned to this product, excluding deleted plots."}},"required":["supplierId","supplierName","plotsExpiryDate","assignedPlotsCount"]}}},"paths":{"/products/{id}":{"patch":{"description":"Partially updates a product owned by the active business. Ownership is immutable.","operationId":"ProductsController_update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProductDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProductDto"}}}},"401":{"description":""},"403":{"description":""},"404":{"description":""},"409":{"description":""}},"summary":"Update a product.","tags":["Products"]}}}}
```

## List a product's suppliers.

> The product's full supplier list, alphabetically. The owner sees every supplier; a supplier sees only itself, never who else supplies the product.

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"servers":[{"url":"https://api.tradeaware.live-eo.com"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"GetProductSupplierDto":{"type":"object","properties":{"supplierId":{"type":"string","description":"Id of the supplier business this product is shared with."},"supplierName":{"type":"string","nullable":true,"description":"Name of the supplier business."},"plotsExpiryDate":{"type":"string","nullable":true,"description":"The date the supplier's whole assigned-plots set expires on, or null.\n      Informative only — expired assignments stay visible and editable."},"assignedPlotsCount":{"type":"number","description":"How many plots the supplier has assigned to this product, excluding deleted plots."}},"required":["supplierId","supplierName","plotsExpiryDate","assignedPlotsCount"]}}},"paths":{"/products/{productId}/suppliers":{"get":{"description":"The product's full supplier list, alphabetically. The owner sees every supplier; a supplier sees only itself, never who else supplies the product.","operationId":"ProductSuppliersController_findAll","parameters":[{"name":"productId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetProductSupplierDto"}}}}},"401":{"description":""},"403":{"description":""},"404":{"description":""}},"summary":"List a product's suppliers.","tags":["Products"]}}}}
```

## List the active business's products.

> Returns the products the active business owns and those shared with it as a\
> &#x20;     supplier in one flat array, newest first, each carrying 'ownedByCaller'. A\
> &#x20;     product with several suppliers appears exactly once. Not paginated.

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"servers":[{"url":"https://api.tradeaware.live-eo.com"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"GetProductDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this product."},"name":{"type":"string","description":"Name of the product."},"hsCode":{"type":"string","nullable":true,"description":"HS code of the product, as a number string without separators."},"description":{"type":"string","nullable":true,"description":"Short description of the product."},"commodity":{"nullable":true,"description":"Commodity of the product, derived from its HS code.","allOf":[{"$ref":"#/components/schemas/Commodity"}]},"buyerProductRef":{"type":"string","nullable":true,"description":"The buyer's own reference for this product."},"ownerId":{"type":"string","description":"Id of the business owning this product."},"ownerName":{"type":"string","nullable":true,"description":"Name of the business owning this product."},"ownedByCaller":{"type":"boolean","description":"Whether the active business owns this product, as opposed to supplying it."},"suppliers":{"description":"The product's suppliers, alphabetically and limited to 3.\n      Only present with 'includes=suppliers'. The product owner sees every supplier, a product supplier sees only itself.","type":"array","items":{"$ref":"#/components/schemas/GetProductSupplierDto"}},"suppliersTotal":{"type":"number","description":"Total number of suppliers the product has.\n      Only present with 'includes=suppliers'. The product owner sees the full count, a product supplier sees 1."},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"}},"required":["id","name","hsCode","description","commodity","buyerProductRef","ownerId","ownerName","ownedByCaller","createdAt","updatedAt"]},"Commodity":{"type":"string","enum":["cattle","cocoa","coffee","oil palm","rubber","soya","timber"],"description":"What crops (among the relevant commodities) are grown on this field (currently)."},"GetProductSupplierDto":{"type":"object","properties":{"supplierId":{"type":"string","description":"Id of the supplier business this product is shared with."},"supplierName":{"type":"string","nullable":true,"description":"Name of the supplier business."},"plotsExpiryDate":{"type":"string","nullable":true,"description":"The date the supplier's whole assigned-plots set expires on, or null.\n      Informative only — expired assignments stay visible and editable."},"assignedPlotsCount":{"type":"number","description":"How many plots the supplier has assigned to this product, excluding deleted plots."}},"required":["supplierId","supplierName","plotsExpiryDate","assignedPlotsCount"]}}},"paths":{"/products":{"get":{"description":"Returns the products the active business owns and those shared with it as a\n      supplier in one flat array, newest first, each carrying 'ownedByCaller'. A\n      product with several suppliers appears exactly once. Not paginated.","operationId":"ProductsController_findAll","parameters":[{"name":"includes","required":false,"in":"query","description":"A comma-separated list of relations to be included in the response. Possible relations are: suppliers.","schema":{}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetProductDto"}}}}},"401":{"description":""},"403":{"description":""}},"summary":"List the active business's products.","tags":["Products"]}}}}
```

## Set the caller's plots for a product.

> Replaces the whole set of plots the calling supplier assigned to the product,\
> &#x20;     assigning the plots in the list and unassigning those no longer in it. Sending an\
> &#x20;     empty list unassigns them all. Every plot sent must be owned by the active\
> &#x20;     business, otherwise nothing is written. Only a supplier of the product can call\
> &#x20;     this, never its owner.

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"servers":[{"url":"https://api.tradeaware.live-eo.com"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"SetProductSupplierPlotsDto":{"type":"object","properties":{"plotIds":{"maxItems":1000,"description":"The full set of plots the caller assigns to the product. Each id must be a\n      plot the caller's active business owns. An empty list unassigns every plot.","type":"array","items":{"type":"string"}},"plotsExpiryDate":{"type":"string","nullable":true,"description":"The date the whole assigned-plots set expires on. Omit to leave the stored\n      date alone, send null to clear it."}},"required":["plotIds"]},"GetProductSupplierPlotsDto":{"type":"object","properties":{"supplierId":{"type":"string","description":"Id of the supplier business the plots are assigned by."},"supplierName":{"type":"string","nullable":true,"description":"Name of the supplier business."},"plotsExpiryDate":{"type":"string","nullable":true,"description":"The date the whole assigned-plots set expires on, or null.\n      Informative only — expired assignments stay visible and editable."},"assignedPlots":{"description":"The plots the supplier assigned to the product, alphabetically. Empty when it has assigned none.","type":"array","items":{"$ref":"#/components/schemas/GetPlotBaseDto"}}},"required":["supplierId","supplierName","plotsExpiryDate","assignedPlots"]},"GetPlotBaseDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n    May be multiple if the plot is reachable in the supply chain\n    via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"geometry":{"oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}],"description":"The geometry of the plot."},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n      IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n      'includes'. If no analysis on this plot is available yet, this\n      property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n    Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesBaseDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n      IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n      If no analysis on this plot is available yet, this property may be null."},"species":{"description":"Timber species present on this plot, as scientific + common name pairs. Empty when none are set.","type":"array","items":{"$ref":"#/components/schemas/PlotSpeciesDto"}},"productionDateStart":{"type":"object","description":"ISO 8601 date marking the start of the plot's production/harvest period. Null when not set.","nullable":true},"productionDateEnd":{"type":"object","description":"ISO 8601 date marking the end of the plot's production/harvest period. Null when not set.","nullable":true}},"required":["id","createdAt","updatedAt","geometry","commodities","name","surfaceArea","countryCode","species","productionDateStart","productionDateEnd"]},"GetBusinessDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"email":{"type":"string","description":"email of the contact person in the business","nullable":true},"name":{"type":"string","description":"business's name","nullable":true},"username":{"type":"string","description":"Business's username","nullable":true},"addressStreet":{"type":"string","description":"street address of the business","nullable":true},"addressZip":{"type":"string","description":"country-specific area code or zip code of the business's address","nullable":true},"addressPostcode":{"type":"string","description":"country-specific postcode of the business's address","nullable":true},"addressArea":{"type":"string","description":"country region of the business's address","nullable":true},"addressCity":{"type":"string","description":"city of the business's address","nullable":true},"addressCountryCode":{"type":"string","description":"two-letter country code (ISO 3166 Alpha-2) of the business's address","nullable":true},"addressCountry":{"type":"string","description":"Country of the business's address","nullable":true},"addressLine1":{"type":"string","description":"first line of the business address","nullable":true},"addressLine2":{"type":"string","description":"second line of the business address","nullable":true},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"initialLocale":{"type":"object","description":"Locale that is used for the invitation email sent to the business"},"units":{"type":"string","description":"units of measurement used by the application"},"plots":{"description":"IMPORTANT: only set when 'plots' is provided in 'includes'. List of plots owned by the business","type":"array","items":{"$ref":"#/components/schemas/GetPlotFullDto"}},"newlyCreated":{"type":"boolean","default":true,"description":"whether the business was created recently"},"members":{"description":"users members of the business","type":"array","items":{"$ref":"#/components/schemas/GetUserDto"}},"connectionsAsSource":{"description":"connections where the business is the source","type":"array","items":{"$ref":"#/components/schemas/GetBusinessConnectionDto"}},"connectionsAsTarget":{"description":"connections where the business is the target","type":"array","items":{"$ref":"#/components/schemas/GetBusinessConnectionDto"}},"businessInvitations":{"description":"invitations sent by the business","type":"array","items":{"$ref":"#/components/schemas/GetBusinessInvitationDto"}},"contactPerson":{"description":"contact person of business","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"machineToMachineClientId":{"type":"string","description":"The machine-to-machine client created by user","nullable":true},"eori":{"type":"string","description":"EORI number of the business","nullable":true},"vat":{"type":"string","description":"VAT number of the business","nullable":true},"tracesEnvironment":{"type":"string","enum":["ACCEPTANCE","PRODUCTION"],"description":"The TRACES environment configured for the business. ACCEPTANCE for testing, PRODUCTION for live submissions."}},"required":["id","email","name","createdAt","updatedAt","initialLocale","newlyCreated","eori","vat"]},"GetPlotFullDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n    May be multiple if the plot is reachable in the supply chain\n    via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"geometry":{"oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}],"description":"The geometry of the plot."},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n      IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n      'includes'. If no analysis on this plot is available yet, this\n      property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n      Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesFullDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n      IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n      If no analysis on this plot is available yet, this property may be null."},"species":{"description":"Timber species present on this plot, as scientific + common name pairs. Empty when none are set.","type":"array","items":{"$ref":"#/components/schemas/PlotSpeciesDto"}},"productionDateStart":{"type":"object","description":"ISO 8601 date marking the start of the plot's production/harvest period. Null when not set.","nullable":true},"productionDateEnd":{"type":"object","description":"ISO 8601 date marking the end of the plot's production/harvest period. Null when not set.","nullable":true},"filename":{"type":"object","description":"Filename of the plot. Useful to know where is the Plot coming from on batch create.","nullable":true},"description":{"type":"string","description":"Free text descrption of the plot. Useful for to keep human friendly Plot names.","nullable":true},"ownerId":{"type":"string","description":"The id of the owning business. May be undefined for supplier masking."},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a plot in TradeAware.\n      This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n      The `customData` field is returned unchanged and is visible only to the owners of the plot.\n\n      Constraints:\n        - Up to 10 keys per object\n        - Key length: Maximum 255 characters\n        - String value length: Maximum 255 characters\n        - Values must be of type: string, number, or boolean\n        - Nested objects are not allowed\n        - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n      "}},"required":["id","createdAt","updatedAt","geometry","commodities","name","surfaceArea","countryCode","species","productionDateStart","productionDateEnd"]},"GetPolygonDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'Polygon' for polygons"},"coordinates":{"type":"array","description":"A Polygon's coordinates. Three-dimensional number array. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6","items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}},"required":["type","coordinates"]},"GetMultiPolygonDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'MultiPolygon' for multipolygons"},"coordinates":{"type":"array","description":"A MultiPolygon's coordinates. Four-dimensional number array. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.7","items":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}}},"required":["type","coordinates"]},"Commodity":{"type":"string","enum":["cattle","cocoa","coffee","oil palm","rubber","soya","timber"],"description":"What crops (among the relevant commodities) are grown on this field (currently)."},"GetAnalysisFullDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this analysis"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"status":{"description":"The overall status of the underlying analysis pipeline","allOf":[{"$ref":"#/components/schemas/AnalysisStatus"}]},"plotId":{"type":"string","description":"Id of the plot that this analysis belongs to and is performed on"},"analysedAt":{"type":"string","description":"ISO 8601"},"version":{"type":"string","description":"The version of the analysis pipeline that was run"},"deforestedArea":{"type":"number","description":"The deforested area in square meters"},"deforestedGeometry":{"description":"The deforested area as a GeoJSON Polygon","oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"riskOfDeforestation":{"type":"number","description":"The risk of deforestation in this area. 0.0 is no risk, 1.0 is certain deforestation."},"type":{"description":"The type of analysis that was requested","allOf":[{"$ref":"#/components/schemas/AnalysisType"}]},"customData":{"type":"object","description":"Additional custom data. We don't use it for any calculations."},"metadata":{"type":"object","description":"Additional metadata. We don't use it for any calculations.\n      This field is deprecated and will be removed in the future. Please use\n      customData instead.","deprecated":true},"name":{"type":"string","description":"A human-friendly name for this analysis"}},"required":["id","createdAt","updatedAt","status","plotId","type"]},"AnalysisStatus":{"type":"string","enum":["PENDING","RUNNING","SUCCEEDED","FAILED"],"description":"The overall status of the underlying analysis pipeline"},"AnalysisType":{"type":"string","enum":["OS","EUFOROBS","PRECISION"],"description":"The type of analysis that was requested"},"GetMostRecentAnalysesFullDto":{"type":"object","properties":{"EUFOROBS":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"PRECISION":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]}},"required":["EUFOROBS","PRECISION"]},"PlotRiskAssessmentStatus":{"type":"string","enum":["NEW","UNDER_REVIEW","IN_RISK_MITIGATION","EUDR_COMPLIANT","EUDR_NON_COMPLIANT"],"description":"The risk assessment status of this plot set by your business"},"PlotSpeciesDto":{"type":"object","properties":{"scientificName":{"type":"string","description":"Scientific name of the species (matches the EUDR Operator API ScientificNameType)."},"commonName":{"type":"string","description":"Common name of the species."}},"required":["scientificName","commonName"]},"GetUserDto":{"type":"object","properties":{"auth0UserId":{"type":"string","description":"id of this entity, ref to auth0"},"business":{"description":"business that this user is member of","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"businessId":{"type":"string","description":"business id that this user is member of"},"firstName":{"type":"string","description":"first name of user"},"lastName":{"type":"string","description":"last name of user"},"locale":{"type":"string","description":"locale that is used for the invitation email sent to the user"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"completed":{"type":"boolean","default":false,"description":"is onboarding process completed"},"businessInvitations":{"description":"business invitations with relation to","type":"array","items":{"$ref":"#/components/schemas/GetBusinessInvitationDto"}},"userInvitations":{"description":"user invitations with relation to","type":"array","items":{"$ref":"#/components/schemas/GetUserInvitationDto"}},"email":{"type":"string","description":"email of the user"},"consentedAt":{"type":"string","description":"ISO 8601 Date when user consented to terms and conditions. If undefined, then consent has not been given"},"entitlements":{"default":{"canTriggerPrecisionAnalysis":false},"description":"Entitlements of the user, e.g. can trigger precision analysis","allOf":[{"$ref":"#/components/schemas/GetEntitlementsDto"}]}},"required":["auth0UserId","locale","createdAt","updatedAt","completed","entitlements"]},"GetBusinessInvitationDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"sentByUser":{"description":"user that sent this invitation","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"business":{"description":"business that this invitation is for","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"email":{"type":"string","description":"email of the user that this invitation is for"},"status":{"description":"status of this invitation","allOf":[{"$ref":"#/components/schemas/BusinessInvitationStatus"}]},"createdAt":{"type":"string","description":"date this entity was created"},"updatedAt":{"type":"string","description":"date this entity was last updated"},"sourceIsInvitee":{"type":"boolean","description":"describes if the invited business will share or receive data"},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a business invitation in TradeAware.\n      This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n      The `customData` field is returned unchanged and is visible only to the owners of the business invitation.\n\n      Constraints:\n        - Up to 10 keys per object\n        - Key length: Maximum 255 characters\n        - String value length: Maximum 255 characters\n        - Values must be of type: string, number, or boolean\n        - Nested objects are not allowed\n        - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n\n      Server-owned namespaces may additionally appear in responses; the constraints above apply to client-supplied data only.\n      "}},"required":["id","sentByUser","email","status","createdAt","updatedAt","sourceIsInvitee"]},"BusinessInvitationStatus":{"type":"string","enum":["PENDING","ACCEPTED","REJECTED","EXPIRED","CANCELLED"],"description":"status of this invitation"},"GetUserInvitationDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"email":{"type":"string","description":"email of the user that this invitation is for"},"sentByUser":{"description":"user that sent this invitation. Undefined if the user has been deleted","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"inviteToBusiness":{"description":"business from which this invitation was sent","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"status":{"description":"status of this invitation","allOf":[{"$ref":"#/components/schemas/UserInvitationStatus"}]},"createdAt":{"type":"string","description":"date this entity was created"},"updatedAt":{"type":"string","description":"date this entity was last updated"}},"required":["id","email","inviteToBusiness","status","createdAt","updatedAt"]},"UserInvitationStatus":{"type":"string","enum":["ACCEPTED","CANCELLED","EXPIRED","PENDING","REJECTED"],"description":"status of this invitation"},"GetEntitlementsDto":{"type":"object","properties":{"canTriggerPrecisionAnalysis":{"type":"boolean","default":false,"description":"Indicates whether the user can request precision analysis for a plot"},"canManageTransactions":{"type":"boolean","default":false,"description":"Indicates whether the user can manage transactions"},"canViewCmsSurveyResponsesOfTier1Suppliers":{"type":"boolean","default":false,"description":"Indicates whether the user can view the CMS survey responses of their tier-1 suppliers. Non-CMS survey responses of tier-1 suppliers are visible to every user."},"canDownloadSurveyResponses":{"type":"boolean","default":false,"description":"Indicates whether the user can download their own non-CMS survey responses or the completed non-CMS survey responses of their tier-1 suppliers"},"canDownloadCmsSurveyResponses":{"type":"boolean","default":false,"description":"Indicates whether the user can download their own CMS survey responses or the completed CMS survey responses of their tier-1 suppliers"},"canManageWebhooks":{"type":"boolean","default":false,"description":"Indicates whether the user can manage webhooks"},"canAccessApi":{"type":"boolean","default":false,"description":"Indicates whether the user has programmatic access to the API"},"canManageCmsSupplierRiskAssessmentStatuses":{"type":"boolean","default":false,"description":"Indicates whether the user can manage CMS supplier risk assessment statuses"},"canViewCmsSurveys":{"type":"boolean","default":false,"description":"Indicates whether the user can view CMS surveys"},"canViewSupplierRiskScore":{"type":"boolean","default":false,"description":"Indicates whether the user can view information related to a supplier risk score"}},"required":["canTriggerPrecisionAnalysis","canManageTransactions","canViewCmsSurveyResponsesOfTier1Suppliers","canDownloadSurveyResponses","canDownloadCmsSurveyResponses","canManageWebhooks","canAccessApi","canManageCmsSupplierRiskAssessmentStatuses","canViewCmsSurveys","canViewSupplierRiskScore"]},"GetBusinessConnectionDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"sourceBusiness":{"description":"source business of this connection","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"targetBusiness":{"description":"target business of this connection","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"createdAt":{"type":"string","description":"date that this connection was created"},"updatedAt":{"type":"string","description":"date that this connection was last updated"},"customData":{"type":"object","description":"metadata for this business connection. Only visible to the buyer who set this. Server-owned namespaces may additionally appear here; they are stripped from client PATCH bodies, so echoing this object back is safe."},"plotsCount":{"type":"number","description":"Total number of plots in this supplier's supply chain","default":0},"plotsCommodities":{"description":"List of all commodities produced in this supplier's supply chain","type":"array","items":{"type":"string"}}},"required":["id","sourceBusiness","targetBusiness","createdAt","updatedAt","customData","plotsCount","plotsCommodities"]},"GetAnalysisBaseDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this analysis"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"status":{"description":"The overall status of the underlying analysis pipeline","allOf":[{"$ref":"#/components/schemas/AnalysisStatus"}]},"plotId":{"type":"string","description":"Id of the plot that this analysis belongs to and is performed on"},"analysedAt":{"type":"string","description":"ISO 8601"},"version":{"type":"string","description":"The version of the analysis pipeline that was run"},"deforestedArea":{"type":"number","description":"The deforested area in square meters"},"deforestedGeometry":{"description":"The deforested area as a GeoJSON Polygon","oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"riskOfDeforestation":{"type":"number","description":"The risk of deforestation in this area. 0.0 is no risk, 1.0 is certain deforestation."},"type":{"description":"The type of analysis that was requested","allOf":[{"$ref":"#/components/schemas/AnalysisType"}]}},"required":["id","createdAt","updatedAt","status","plotId","type"]},"GetMostRecentAnalysesBaseDto":{"type":"object","properties":{"EUFOROBS":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]},"PRECISION":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]}},"required":["EUFOROBS","PRECISION"]}}},"paths":{"/products/{productId}/plots":{"put":{"description":"Replaces the whole set of plots the calling supplier assigned to the product,\n      assigning the plots in the list and unassigning those no longer in it. Sending an\n      empty list unassigns them all. Every plot sent must be owned by the active\n      business, otherwise nothing is written. Only a supplier of the product can call\n      this, never its owner.","operationId":"ProductSupplierPlotsController_set","parameters":[{"name":"productId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetProductSupplierPlotsDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProductSupplierPlotsDto"}}}},"401":{"description":""},"403":{"description":""},"404":{"description":""}},"summary":"Set the caller's plots for a product.","tags":["Products"]}}}}
```

## List the plots assigned to a product, per supplier.

> The plots each supplier assigned to the product, alphabetically. The owner\
> &#x20;     sees every supplier's set; a supplier sees only its own. A supplier that\
> &#x20;     assigned nothing is still listed, with an empty set.

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"servers":[{"url":"https://api.tradeaware.live-eo.com"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"GetProductSupplierPlotsDto":{"type":"object","properties":{"supplierId":{"type":"string","description":"Id of the supplier business the plots are assigned by."},"supplierName":{"type":"string","nullable":true,"description":"Name of the supplier business."},"plotsExpiryDate":{"type":"string","nullable":true,"description":"The date the whole assigned-plots set expires on, or null.\n      Informative only — expired assignments stay visible and editable."},"assignedPlots":{"description":"The plots the supplier assigned to the product, alphabetically. Empty when it has assigned none.","type":"array","items":{"$ref":"#/components/schemas/GetPlotBaseDto"}}},"required":["supplierId","supplierName","plotsExpiryDate","assignedPlots"]},"GetPlotBaseDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n    May be multiple if the plot is reachable in the supply chain\n    via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"geometry":{"oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}],"description":"The geometry of the plot."},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n      IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n      'includes'. If no analysis on this plot is available yet, this\n      property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n    Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesBaseDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n      IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n      If no analysis on this plot is available yet, this property may be null."},"species":{"description":"Timber species present on this plot, as scientific + common name pairs. Empty when none are set.","type":"array","items":{"$ref":"#/components/schemas/PlotSpeciesDto"}},"productionDateStart":{"type":"object","description":"ISO 8601 date marking the start of the plot's production/harvest period. Null when not set.","nullable":true},"productionDateEnd":{"type":"object","description":"ISO 8601 date marking the end of the plot's production/harvest period. Null when not set.","nullable":true}},"required":["id","createdAt","updatedAt","geometry","commodities","name","surfaceArea","countryCode","species","productionDateStart","productionDateEnd"]},"GetBusinessDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"email":{"type":"string","description":"email of the contact person in the business","nullable":true},"name":{"type":"string","description":"business's name","nullable":true},"username":{"type":"string","description":"Business's username","nullable":true},"addressStreet":{"type":"string","description":"street address of the business","nullable":true},"addressZip":{"type":"string","description":"country-specific area code or zip code of the business's address","nullable":true},"addressPostcode":{"type":"string","description":"country-specific postcode of the business's address","nullable":true},"addressArea":{"type":"string","description":"country region of the business's address","nullable":true},"addressCity":{"type":"string","description":"city of the business's address","nullable":true},"addressCountryCode":{"type":"string","description":"two-letter country code (ISO 3166 Alpha-2) of the business's address","nullable":true},"addressCountry":{"type":"string","description":"Country of the business's address","nullable":true},"addressLine1":{"type":"string","description":"first line of the business address","nullable":true},"addressLine2":{"type":"string","description":"second line of the business address","nullable":true},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"initialLocale":{"type":"object","description":"Locale that is used for the invitation email sent to the business"},"units":{"type":"string","description":"units of measurement used by the application"},"plots":{"description":"IMPORTANT: only set when 'plots' is provided in 'includes'. List of plots owned by the business","type":"array","items":{"$ref":"#/components/schemas/GetPlotFullDto"}},"newlyCreated":{"type":"boolean","default":true,"description":"whether the business was created recently"},"members":{"description":"users members of the business","type":"array","items":{"$ref":"#/components/schemas/GetUserDto"}},"connectionsAsSource":{"description":"connections where the business is the source","type":"array","items":{"$ref":"#/components/schemas/GetBusinessConnectionDto"}},"connectionsAsTarget":{"description":"connections where the business is the target","type":"array","items":{"$ref":"#/components/schemas/GetBusinessConnectionDto"}},"businessInvitations":{"description":"invitations sent by the business","type":"array","items":{"$ref":"#/components/schemas/GetBusinessInvitationDto"}},"contactPerson":{"description":"contact person of business","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"machineToMachineClientId":{"type":"string","description":"The machine-to-machine client created by user","nullable":true},"eori":{"type":"string","description":"EORI number of the business","nullable":true},"vat":{"type":"string","description":"VAT number of the business","nullable":true},"tracesEnvironment":{"type":"string","enum":["ACCEPTANCE","PRODUCTION"],"description":"The TRACES environment configured for the business. ACCEPTANCE for testing, PRODUCTION for live submissions."}},"required":["id","email","name","createdAt","updatedAt","initialLocale","newlyCreated","eori","vat"]},"GetPlotFullDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n    May be multiple if the plot is reachable in the supply chain\n    via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"geometry":{"oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}],"description":"The geometry of the plot."},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n      IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n      'includes'. If no analysis on this plot is available yet, this\n      property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n      Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesFullDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n      IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n      If no analysis on this plot is available yet, this property may be null."},"species":{"description":"Timber species present on this plot, as scientific + common name pairs. Empty when none are set.","type":"array","items":{"$ref":"#/components/schemas/PlotSpeciesDto"}},"productionDateStart":{"type":"object","description":"ISO 8601 date marking the start of the plot's production/harvest period. Null when not set.","nullable":true},"productionDateEnd":{"type":"object","description":"ISO 8601 date marking the end of the plot's production/harvest period. Null when not set.","nullable":true},"filename":{"type":"object","description":"Filename of the plot. Useful to know where is the Plot coming from on batch create.","nullable":true},"description":{"type":"string","description":"Free text descrption of the plot. Useful for to keep human friendly Plot names.","nullable":true},"ownerId":{"type":"string","description":"The id of the owning business. May be undefined for supplier masking."},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a plot in TradeAware.\n      This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n      The `customData` field is returned unchanged and is visible only to the owners of the plot.\n\n      Constraints:\n        - Up to 10 keys per object\n        - Key length: Maximum 255 characters\n        - String value length: Maximum 255 characters\n        - Values must be of type: string, number, or boolean\n        - Nested objects are not allowed\n        - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n      "}},"required":["id","createdAt","updatedAt","geometry","commodities","name","surfaceArea","countryCode","species","productionDateStart","productionDateEnd"]},"GetPolygonDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'Polygon' for polygons"},"coordinates":{"type":"array","description":"A Polygon's coordinates. Three-dimensional number array. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6","items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}},"required":["type","coordinates"]},"GetMultiPolygonDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'MultiPolygon' for multipolygons"},"coordinates":{"type":"array","description":"A MultiPolygon's coordinates. Four-dimensional number array. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.7","items":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}}},"required":["type","coordinates"]},"Commodity":{"type":"string","enum":["cattle","cocoa","coffee","oil palm","rubber","soya","timber"],"description":"What crops (among the relevant commodities) are grown on this field (currently)."},"GetAnalysisFullDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this analysis"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"status":{"description":"The overall status of the underlying analysis pipeline","allOf":[{"$ref":"#/components/schemas/AnalysisStatus"}]},"plotId":{"type":"string","description":"Id of the plot that this analysis belongs to and is performed on"},"analysedAt":{"type":"string","description":"ISO 8601"},"version":{"type":"string","description":"The version of the analysis pipeline that was run"},"deforestedArea":{"type":"number","description":"The deforested area in square meters"},"deforestedGeometry":{"description":"The deforested area as a GeoJSON Polygon","oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"riskOfDeforestation":{"type":"number","description":"The risk of deforestation in this area. 0.0 is no risk, 1.0 is certain deforestation."},"type":{"description":"The type of analysis that was requested","allOf":[{"$ref":"#/components/schemas/AnalysisType"}]},"customData":{"type":"object","description":"Additional custom data. We don't use it for any calculations."},"metadata":{"type":"object","description":"Additional metadata. We don't use it for any calculations.\n      This field is deprecated and will be removed in the future. Please use\n      customData instead.","deprecated":true},"name":{"type":"string","description":"A human-friendly name for this analysis"}},"required":["id","createdAt","updatedAt","status","plotId","type"]},"AnalysisStatus":{"type":"string","enum":["PENDING","RUNNING","SUCCEEDED","FAILED"],"description":"The overall status of the underlying analysis pipeline"},"AnalysisType":{"type":"string","enum":["OS","EUFOROBS","PRECISION"],"description":"The type of analysis that was requested"},"GetMostRecentAnalysesFullDto":{"type":"object","properties":{"EUFOROBS":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"PRECISION":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]}},"required":["EUFOROBS","PRECISION"]},"PlotRiskAssessmentStatus":{"type":"string","enum":["NEW","UNDER_REVIEW","IN_RISK_MITIGATION","EUDR_COMPLIANT","EUDR_NON_COMPLIANT"],"description":"The risk assessment status of this plot set by your business"},"PlotSpeciesDto":{"type":"object","properties":{"scientificName":{"type":"string","description":"Scientific name of the species (matches the EUDR Operator API ScientificNameType)."},"commonName":{"type":"string","description":"Common name of the species."}},"required":["scientificName","commonName"]},"GetUserDto":{"type":"object","properties":{"auth0UserId":{"type":"string","description":"id of this entity, ref to auth0"},"business":{"description":"business that this user is member of","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"businessId":{"type":"string","description":"business id that this user is member of"},"firstName":{"type":"string","description":"first name of user"},"lastName":{"type":"string","description":"last name of user"},"locale":{"type":"string","description":"locale that is used for the invitation email sent to the user"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"completed":{"type":"boolean","default":false,"description":"is onboarding process completed"},"businessInvitations":{"description":"business invitations with relation to","type":"array","items":{"$ref":"#/components/schemas/GetBusinessInvitationDto"}},"userInvitations":{"description":"user invitations with relation to","type":"array","items":{"$ref":"#/components/schemas/GetUserInvitationDto"}},"email":{"type":"string","description":"email of the user"},"consentedAt":{"type":"string","description":"ISO 8601 Date when user consented to terms and conditions. If undefined, then consent has not been given"},"entitlements":{"default":{"canTriggerPrecisionAnalysis":false},"description":"Entitlements of the user, e.g. can trigger precision analysis","allOf":[{"$ref":"#/components/schemas/GetEntitlementsDto"}]}},"required":["auth0UserId","locale","createdAt","updatedAt","completed","entitlements"]},"GetBusinessInvitationDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"sentByUser":{"description":"user that sent this invitation","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"business":{"description":"business that this invitation is for","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"email":{"type":"string","description":"email of the user that this invitation is for"},"status":{"description":"status of this invitation","allOf":[{"$ref":"#/components/schemas/BusinessInvitationStatus"}]},"createdAt":{"type":"string","description":"date this entity was created"},"updatedAt":{"type":"string","description":"date this entity was last updated"},"sourceIsInvitee":{"type":"boolean","description":"describes if the invited business will share or receive data"},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a business invitation in TradeAware.\n      This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n      The `customData` field is returned unchanged and is visible only to the owners of the business invitation.\n\n      Constraints:\n        - Up to 10 keys per object\n        - Key length: Maximum 255 characters\n        - String value length: Maximum 255 characters\n        - Values must be of type: string, number, or boolean\n        - Nested objects are not allowed\n        - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n\n      Server-owned namespaces may additionally appear in responses; the constraints above apply to client-supplied data only.\n      "}},"required":["id","sentByUser","email","status","createdAt","updatedAt","sourceIsInvitee"]},"BusinessInvitationStatus":{"type":"string","enum":["PENDING","ACCEPTED","REJECTED","EXPIRED","CANCELLED"],"description":"status of this invitation"},"GetUserInvitationDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"email":{"type":"string","description":"email of the user that this invitation is for"},"sentByUser":{"description":"user that sent this invitation. Undefined if the user has been deleted","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"inviteToBusiness":{"description":"business from which this invitation was sent","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"status":{"description":"status of this invitation","allOf":[{"$ref":"#/components/schemas/UserInvitationStatus"}]},"createdAt":{"type":"string","description":"date this entity was created"},"updatedAt":{"type":"string","description":"date this entity was last updated"}},"required":["id","email","inviteToBusiness","status","createdAt","updatedAt"]},"UserInvitationStatus":{"type":"string","enum":["ACCEPTED","CANCELLED","EXPIRED","PENDING","REJECTED"],"description":"status of this invitation"},"GetEntitlementsDto":{"type":"object","properties":{"canTriggerPrecisionAnalysis":{"type":"boolean","default":false,"description":"Indicates whether the user can request precision analysis for a plot"},"canManageTransactions":{"type":"boolean","default":false,"description":"Indicates whether the user can manage transactions"},"canViewCmsSurveyResponsesOfTier1Suppliers":{"type":"boolean","default":false,"description":"Indicates whether the user can view the CMS survey responses of their tier-1 suppliers. Non-CMS survey responses of tier-1 suppliers are visible to every user."},"canDownloadSurveyResponses":{"type":"boolean","default":false,"description":"Indicates whether the user can download their own non-CMS survey responses or the completed non-CMS survey responses of their tier-1 suppliers"},"canDownloadCmsSurveyResponses":{"type":"boolean","default":false,"description":"Indicates whether the user can download their own CMS survey responses or the completed CMS survey responses of their tier-1 suppliers"},"canManageWebhooks":{"type":"boolean","default":false,"description":"Indicates whether the user can manage webhooks"},"canAccessApi":{"type":"boolean","default":false,"description":"Indicates whether the user has programmatic access to the API"},"canManageCmsSupplierRiskAssessmentStatuses":{"type":"boolean","default":false,"description":"Indicates whether the user can manage CMS supplier risk assessment statuses"},"canViewCmsSurveys":{"type":"boolean","default":false,"description":"Indicates whether the user can view CMS surveys"},"canViewSupplierRiskScore":{"type":"boolean","default":false,"description":"Indicates whether the user can view information related to a supplier risk score"}},"required":["canTriggerPrecisionAnalysis","canManageTransactions","canViewCmsSurveyResponsesOfTier1Suppliers","canDownloadSurveyResponses","canDownloadCmsSurveyResponses","canManageWebhooks","canAccessApi","canManageCmsSupplierRiskAssessmentStatuses","canViewCmsSurveys","canViewSupplierRiskScore"]},"GetBusinessConnectionDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"sourceBusiness":{"description":"source business of this connection","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"targetBusiness":{"description":"target business of this connection","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"createdAt":{"type":"string","description":"date that this connection was created"},"updatedAt":{"type":"string","description":"date that this connection was last updated"},"customData":{"type":"object","description":"metadata for this business connection. Only visible to the buyer who set this. Server-owned namespaces may additionally appear here; they are stripped from client PATCH bodies, so echoing this object back is safe."},"plotsCount":{"type":"number","description":"Total number of plots in this supplier's supply chain","default":0},"plotsCommodities":{"description":"List of all commodities produced in this supplier's supply chain","type":"array","items":{"type":"string"}}},"required":["id","sourceBusiness","targetBusiness","createdAt","updatedAt","customData","plotsCount","plotsCommodities"]},"GetAnalysisBaseDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this analysis"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"status":{"description":"The overall status of the underlying analysis pipeline","allOf":[{"$ref":"#/components/schemas/AnalysisStatus"}]},"plotId":{"type":"string","description":"Id of the plot that this analysis belongs to and is performed on"},"analysedAt":{"type":"string","description":"ISO 8601"},"version":{"type":"string","description":"The version of the analysis pipeline that was run"},"deforestedArea":{"type":"number","description":"The deforested area in square meters"},"deforestedGeometry":{"description":"The deforested area as a GeoJSON Polygon","oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"riskOfDeforestation":{"type":"number","description":"The risk of deforestation in this area. 0.0 is no risk, 1.0 is certain deforestation."},"type":{"description":"The type of analysis that was requested","allOf":[{"$ref":"#/components/schemas/AnalysisType"}]}},"required":["id","createdAt","updatedAt","status","plotId","type"]},"GetMostRecentAnalysesBaseDto":{"type":"object","properties":{"EUFOROBS":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]},"PRECISION":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]}},"required":["EUFOROBS","PRECISION"]}}},"paths":{"/products/{productId}/plots":{"get":{"description":"The plots each supplier assigned to the product, alphabetically. The owner\n      sees every supplier's set; a supplier sees only its own. A supplier that\n      assigned nothing is still listed, with an empty set.","operationId":"ProductSupplierPlotsController_findAll","parameters":[{"name":"productId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetProductSupplierPlotsDto"}}}}},"401":{"description":""},"403":{"description":""},"404":{"description":""}},"summary":"List the plots assigned to a product, per supplier.","tags":["Products"]}}}}
```

## The GetProductSupplierDto object

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"components":{"schemas":{"GetProductSupplierDto":{"type":"object","properties":{"supplierId":{"type":"string","description":"Id of the supplier business this product is shared with."},"supplierName":{"type":"string","nullable":true,"description":"Name of the supplier business."},"plotsExpiryDate":{"type":"string","nullable":true,"description":"The date the supplier's whole assigned-plots set expires on, or null.\n      Informative only — expired assignments stay visible and editable."},"assignedPlotsCount":{"type":"number","description":"How many plots the supplier has assigned to this product, excluding deleted plots."}},"required":["supplierId","supplierName","plotsExpiryDate","assignedPlotsCount"]}}}}
```

## The SetProductSuppliersDto object

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"components":{"schemas":{"SetProductSuppliersDto":{"type":"object","properties":{"supplierIds":{"maxItems":1000,"description":"The new product's supplier list. Each id must be a business the caller is connected to as buyer. An empty list removes all suppliers.","type":"array","items":{"type":"string"}}},"required":["supplierIds"]}}}}
```

## The GetProductSupplierPlotsDto object

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"components":{"schemas":{"GetProductSupplierPlotsDto":{"type":"object","properties":{"supplierId":{"type":"string","description":"Id of the supplier business the plots are assigned by."},"supplierName":{"type":"string","nullable":true,"description":"Name of the supplier business."},"plotsExpiryDate":{"type":"string","nullable":true,"description":"The date the whole assigned-plots set expires on, or null.\n      Informative only — expired assignments stay visible and editable."},"assignedPlots":{"description":"The plots the supplier assigned to the product, alphabetically. Empty when it has assigned none.","type":"array","items":{"$ref":"#/components/schemas/GetPlotBaseDto"}}},"required":["supplierId","supplierName","plotsExpiryDate","assignedPlots"]},"GetPlotBaseDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n    May be multiple if the plot is reachable in the supply chain\n    via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"geometry":{"oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}],"description":"The geometry of the plot."},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n      IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n      'includes'. If no analysis on this plot is available yet, this\n      property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n    Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesBaseDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n      IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n      If no analysis on this plot is available yet, this property may be null."},"species":{"description":"Timber species present on this plot, as scientific + common name pairs. Empty when none are set.","type":"array","items":{"$ref":"#/components/schemas/PlotSpeciesDto"}},"productionDateStart":{"type":"object","description":"ISO 8601 date marking the start of the plot's production/harvest period. Null when not set.","nullable":true},"productionDateEnd":{"type":"object","description":"ISO 8601 date marking the end of the plot's production/harvest period. Null when not set.","nullable":true}},"required":["id","createdAt","updatedAt","geometry","commodities","name","surfaceArea","countryCode","species","productionDateStart","productionDateEnd"]},"GetBusinessDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"email":{"type":"string","description":"email of the contact person in the business","nullable":true},"name":{"type":"string","description":"business's name","nullable":true},"username":{"type":"string","description":"Business's username","nullable":true},"addressStreet":{"type":"string","description":"street address of the business","nullable":true},"addressZip":{"type":"string","description":"country-specific area code or zip code of the business's address","nullable":true},"addressPostcode":{"type":"string","description":"country-specific postcode of the business's address","nullable":true},"addressArea":{"type":"string","description":"country region of the business's address","nullable":true},"addressCity":{"type":"string","description":"city of the business's address","nullable":true},"addressCountryCode":{"type":"string","description":"two-letter country code (ISO 3166 Alpha-2) of the business's address","nullable":true},"addressCountry":{"type":"string","description":"Country of the business's address","nullable":true},"addressLine1":{"type":"string","description":"first line of the business address","nullable":true},"addressLine2":{"type":"string","description":"second line of the business address","nullable":true},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"initialLocale":{"type":"object","description":"Locale that is used for the invitation email sent to the business"},"units":{"type":"string","description":"units of measurement used by the application"},"plots":{"description":"IMPORTANT: only set when 'plots' is provided in 'includes'. List of plots owned by the business","type":"array","items":{"$ref":"#/components/schemas/GetPlotFullDto"}},"newlyCreated":{"type":"boolean","default":true,"description":"whether the business was created recently"},"members":{"description":"users members of the business","type":"array","items":{"$ref":"#/components/schemas/GetUserDto"}},"connectionsAsSource":{"description":"connections where the business is the source","type":"array","items":{"$ref":"#/components/schemas/GetBusinessConnectionDto"}},"connectionsAsTarget":{"description":"connections where the business is the target","type":"array","items":{"$ref":"#/components/schemas/GetBusinessConnectionDto"}},"businessInvitations":{"description":"invitations sent by the business","type":"array","items":{"$ref":"#/components/schemas/GetBusinessInvitationDto"}},"contactPerson":{"description":"contact person of business","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"machineToMachineClientId":{"type":"string","description":"The machine-to-machine client created by user","nullable":true},"eori":{"type":"string","description":"EORI number of the business","nullable":true},"vat":{"type":"string","description":"VAT number of the business","nullable":true},"tracesEnvironment":{"type":"string","enum":["ACCEPTANCE","PRODUCTION"],"description":"The TRACES environment configured for the business. ACCEPTANCE for testing, PRODUCTION for live submissions."}},"required":["id","email","name","createdAt","updatedAt","initialLocale","newlyCreated","eori","vat"]},"GetPlotFullDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"suppliers":{"description":"The suppliers of the plot with respect to the current business.\n    May be multiple if the plot is reachable in the supply chain\n    via multiple different direct suppliers of the current business.","type":"array","items":{"$ref":"#/components/schemas/GetBusinessDto"}},"geometry":{"oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}],"description":"The geometry of the plot."},"commodities":{"type":"array","description":"What crops (among the relevant commodities) are grown on this field (currently).","items":{"$ref":"#/components/schemas/Commodity"}},"name":{"type":"string","description":"Free text name of the plot. Useful for easily finding and identifying the plot as an enduser."},"surfaceArea":{"type":"number","description":"Surface area in square meters"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of where the plot is located"},"mostRecentAnalysis":{"description":"The latest analysis of this plot by createdAt.\n      IMPORTANT: only set when 'mostRecentAnalysis' is provided in\n      'includes'. If no analysis on this plot is available yet, this\n      property may be missing even when provided in 'includes'.","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"mostRecentAnalysesByType":{"description":"The latest analyses of this plot by createdAt.\n      Contains one analysis per analysis type, or null if no analysis of that type is available.","allOf":[{"$ref":"#/components/schemas/GetMostRecentAnalysesFullDto"}]},"riskAssessmentStatus":{"description":"The risk assessment status of this plot set by your business","allOf":[{"$ref":"#/components/schemas/PlotRiskAssessmentStatus"}]},"riskLevel":{"type":"string","enum":["none","low","medium","high"],"nullable":true,"description":"The risk level of deforestation in this plot.\n      IMPORTANT: only set when 'riskLevel' is provided in 'includes'.\n      If no analysis on this plot is available yet, this property may be null."},"species":{"description":"Timber species present on this plot, as scientific + common name pairs. Empty when none are set.","type":"array","items":{"$ref":"#/components/schemas/PlotSpeciesDto"}},"productionDateStart":{"type":"object","description":"ISO 8601 date marking the start of the plot's production/harvest period. Null when not set.","nullable":true},"productionDateEnd":{"type":"object","description":"ISO 8601 date marking the end of the plot's production/harvest period. Null when not set.","nullable":true},"filename":{"type":"object","description":"Filename of the plot. Useful to know where is the Plot coming from on batch create.","nullable":true},"description":{"type":"string","description":"Free text descrption of the plot. Useful for to keep human friendly Plot names.","nullable":true},"ownerId":{"type":"string","description":"The id of the owning business. May be undefined for supplier masking."},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a plot in TradeAware.\n      This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n      The `customData` field is returned unchanged and is visible only to the owners of the plot.\n\n      Constraints:\n        - Up to 10 keys per object\n        - Key length: Maximum 255 characters\n        - String value length: Maximum 255 characters\n        - Values must be of type: string, number, or boolean\n        - Nested objects are not allowed\n        - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n      "}},"required":["id","createdAt","updatedAt","geometry","commodities","name","surfaceArea","countryCode","species","productionDateStart","productionDateEnd"]},"GetPolygonDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'Polygon' for polygons"},"coordinates":{"type":"array","description":"A Polygon's coordinates. Three-dimensional number array. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6","items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}},"required":["type","coordinates"]},"GetMultiPolygonDto":{"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Always 'MultiPolygon' for multipolygons"},"coordinates":{"type":"array","description":"A MultiPolygon's coordinates. Four-dimensional number array. Should follow https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.7","items":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}}},"required":["type","coordinates"]},"Commodity":{"type":"string","enum":["cattle","cocoa","coffee","oil palm","rubber","soya","timber"],"description":"What crops (among the relevant commodities) are grown on this field (currently)."},"GetAnalysisFullDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this analysis"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"status":{"description":"The overall status of the underlying analysis pipeline","allOf":[{"$ref":"#/components/schemas/AnalysisStatus"}]},"plotId":{"type":"string","description":"Id of the plot that this analysis belongs to and is performed on"},"analysedAt":{"type":"string","description":"ISO 8601"},"version":{"type":"string","description":"The version of the analysis pipeline that was run"},"deforestedArea":{"type":"number","description":"The deforested area in square meters"},"deforestedGeometry":{"description":"The deforested area as a GeoJSON Polygon","oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"riskOfDeforestation":{"type":"number","description":"The risk of deforestation in this area. 0.0 is no risk, 1.0 is certain deforestation."},"type":{"description":"The type of analysis that was requested","allOf":[{"$ref":"#/components/schemas/AnalysisType"}]},"customData":{"type":"object","description":"Additional custom data. We don't use it for any calculations."},"metadata":{"type":"object","description":"Additional metadata. We don't use it for any calculations.\n      This field is deprecated and will be removed in the future. Please use\n      customData instead.","deprecated":true},"name":{"type":"string","description":"A human-friendly name for this analysis"}},"required":["id","createdAt","updatedAt","status","plotId","type"]},"AnalysisStatus":{"type":"string","enum":["PENDING","RUNNING","SUCCEEDED","FAILED"],"description":"The overall status of the underlying analysis pipeline"},"AnalysisType":{"type":"string","enum":["OS","EUFOROBS","PRECISION"],"description":"The type of analysis that was requested"},"GetMostRecentAnalysesFullDto":{"type":"object","properties":{"EUFOROBS":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]},"PRECISION":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GetAnalysisFullDto"}]}},"required":["EUFOROBS","PRECISION"]},"PlotRiskAssessmentStatus":{"type":"string","enum":["NEW","UNDER_REVIEW","IN_RISK_MITIGATION","EUDR_COMPLIANT","EUDR_NON_COMPLIANT"],"description":"The risk assessment status of this plot set by your business"},"PlotSpeciesDto":{"type":"object","properties":{"scientificName":{"type":"string","description":"Scientific name of the species (matches the EUDR Operator API ScientificNameType)."},"commonName":{"type":"string","description":"Common name of the species."}},"required":["scientificName","commonName"]},"GetUserDto":{"type":"object","properties":{"auth0UserId":{"type":"string","description":"id of this entity, ref to auth0"},"business":{"description":"business that this user is member of","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"businessId":{"type":"string","description":"business id that this user is member of"},"firstName":{"type":"string","description":"first name of user"},"lastName":{"type":"string","description":"last name of user"},"locale":{"type":"string","description":"locale that is used for the invitation email sent to the user"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"completed":{"type":"boolean","default":false,"description":"is onboarding process completed"},"businessInvitations":{"description":"business invitations with relation to","type":"array","items":{"$ref":"#/components/schemas/GetBusinessInvitationDto"}},"userInvitations":{"description":"user invitations with relation to","type":"array","items":{"$ref":"#/components/schemas/GetUserInvitationDto"}},"email":{"type":"string","description":"email of the user"},"consentedAt":{"type":"string","description":"ISO 8601 Date when user consented to terms and conditions. If undefined, then consent has not been given"},"entitlements":{"default":{"canTriggerPrecisionAnalysis":false},"description":"Entitlements of the user, e.g. can trigger precision analysis","allOf":[{"$ref":"#/components/schemas/GetEntitlementsDto"}]}},"required":["auth0UserId","locale","createdAt","updatedAt","completed","entitlements"]},"GetBusinessInvitationDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"sentByUser":{"description":"user that sent this invitation","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"business":{"description":"business that this invitation is for","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"email":{"type":"string","description":"email of the user that this invitation is for"},"status":{"description":"status of this invitation","allOf":[{"$ref":"#/components/schemas/BusinessInvitationStatus"}]},"createdAt":{"type":"string","description":"date this entity was created"},"updatedAt":{"type":"string","description":"date this entity was last updated"},"sourceIsInvitee":{"type":"boolean","description":"describes if the invited business will share or receive data"},"customData":{"type":"object","description":"A customizable metadata field for storing additional information related to a business invitation in TradeAware.\n      This field allows customers to associate their own identifiers or data with TradeAware's system.\n\n      The `customData` field is returned unchanged and is visible only to the owners of the business invitation.\n\n      Constraints:\n        - Up to 10 keys per object\n        - Key length: Maximum 255 characters\n        - String value length: Maximum 255 characters\n        - Values must be of type: string, number, or boolean\n        - Nested objects are not allowed\n        - Keys cannot contain: '__proto__', 'constructor', or 'prototype'\n\n      Server-owned namespaces may additionally appear in responses; the constraints above apply to client-supplied data only.\n      "}},"required":["id","sentByUser","email","status","createdAt","updatedAt","sourceIsInvitee"]},"BusinessInvitationStatus":{"type":"string","enum":["PENDING","ACCEPTED","REJECTED","EXPIRED","CANCELLED"],"description":"status of this invitation"},"GetUserInvitationDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"email":{"type":"string","description":"email of the user that this invitation is for"},"sentByUser":{"description":"user that sent this invitation. Undefined if the user has been deleted","allOf":[{"$ref":"#/components/schemas/GetUserDto"}]},"inviteToBusiness":{"description":"business from which this invitation was sent","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"status":{"description":"status of this invitation","allOf":[{"$ref":"#/components/schemas/UserInvitationStatus"}]},"createdAt":{"type":"string","description":"date this entity was created"},"updatedAt":{"type":"string","description":"date this entity was last updated"}},"required":["id","email","inviteToBusiness","status","createdAt","updatedAt"]},"UserInvitationStatus":{"type":"string","enum":["ACCEPTED","CANCELLED","EXPIRED","PENDING","REJECTED"],"description":"status of this invitation"},"GetEntitlementsDto":{"type":"object","properties":{"canTriggerPrecisionAnalysis":{"type":"boolean","default":false,"description":"Indicates whether the user can request precision analysis for a plot"},"canManageTransactions":{"type":"boolean","default":false,"description":"Indicates whether the user can manage transactions"},"canViewCmsSurveyResponsesOfTier1Suppliers":{"type":"boolean","default":false,"description":"Indicates whether the user can view the CMS survey responses of their tier-1 suppliers. Non-CMS survey responses of tier-1 suppliers are visible to every user."},"canDownloadSurveyResponses":{"type":"boolean","default":false,"description":"Indicates whether the user can download their own non-CMS survey responses or the completed non-CMS survey responses of their tier-1 suppliers"},"canDownloadCmsSurveyResponses":{"type":"boolean","default":false,"description":"Indicates whether the user can download their own CMS survey responses or the completed CMS survey responses of their tier-1 suppliers"},"canManageWebhooks":{"type":"boolean","default":false,"description":"Indicates whether the user can manage webhooks"},"canAccessApi":{"type":"boolean","default":false,"description":"Indicates whether the user has programmatic access to the API"},"canManageCmsSupplierRiskAssessmentStatuses":{"type":"boolean","default":false,"description":"Indicates whether the user can manage CMS supplier risk assessment statuses"},"canViewCmsSurveys":{"type":"boolean","default":false,"description":"Indicates whether the user can view CMS surveys"},"canViewSupplierRiskScore":{"type":"boolean","default":false,"description":"Indicates whether the user can view information related to a supplier risk score"}},"required":["canTriggerPrecisionAnalysis","canManageTransactions","canViewCmsSurveyResponsesOfTier1Suppliers","canDownloadSurveyResponses","canDownloadCmsSurveyResponses","canManageWebhooks","canAccessApi","canManageCmsSupplierRiskAssessmentStatuses","canViewCmsSurveys","canViewSupplierRiskScore"]},"GetBusinessConnectionDto":{"type":"object","properties":{"id":{"type":"string","description":"id of this entity"},"sourceBusiness":{"description":"source business of this connection","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"targetBusiness":{"description":"target business of this connection","allOf":[{"$ref":"#/components/schemas/GetBusinessDto"}]},"createdAt":{"type":"string","description":"date that this connection was created"},"updatedAt":{"type":"string","description":"date that this connection was last updated"},"customData":{"type":"object","description":"metadata for this business connection. Only visible to the buyer who set this. Server-owned namespaces may additionally appear here; they are stripped from client PATCH bodies, so echoing this object back is safe."},"plotsCount":{"type":"number","description":"Total number of plots in this supplier's supply chain","default":0},"plotsCommodities":{"description":"List of all commodities produced in this supplier's supply chain","type":"array","items":{"type":"string"}}},"required":["id","sourceBusiness","targetBusiness","createdAt","updatedAt","customData","plotsCount","plotsCommodities"]},"GetAnalysisBaseDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this analysis"},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"},"status":{"description":"The overall status of the underlying analysis pipeline","allOf":[{"$ref":"#/components/schemas/AnalysisStatus"}]},"plotId":{"type":"string","description":"Id of the plot that this analysis belongs to and is performed on"},"analysedAt":{"type":"string","description":"ISO 8601"},"version":{"type":"string","description":"The version of the analysis pipeline that was run"},"deforestedArea":{"type":"number","description":"The deforested area in square meters"},"deforestedGeometry":{"description":"The deforested area as a GeoJSON Polygon","oneOf":[{"$ref":"#/components/schemas/GetPolygonDto"},{"$ref":"#/components/schemas/GetMultiPolygonDto"}]},"riskOfDeforestation":{"type":"number","description":"The risk of deforestation in this area. 0.0 is no risk, 1.0 is certain deforestation."},"type":{"description":"The type of analysis that was requested","allOf":[{"$ref":"#/components/schemas/AnalysisType"}]}},"required":["id","createdAt","updatedAt","status","plotId","type"]},"GetMostRecentAnalysesBaseDto":{"type":"object","properties":{"EUFOROBS":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]},"PRECISION":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/GetAnalysisBaseDto"}]}},"required":["EUFOROBS","PRECISION"]}}}}
```

## The SetProductSupplierPlotsDto object

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"components":{"schemas":{"SetProductSupplierPlotsDto":{"type":"object","properties":{"plotIds":{"maxItems":1000,"description":"The full set of plots the caller assigns to the product. Each id must be a\n      plot the caller's active business owns. An empty list unassigns every plot.","type":"array","items":{"type":"string"}},"plotsExpiryDate":{"type":"string","nullable":true,"description":"The date the whole assigned-plots set expires on. Omit to leave the stored\n      date alone, send null to clear it."}},"required":["plotIds"]}}}}
```

## The GetProductBaseDto object

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"components":{"schemas":{"GetProductBaseDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this product."},"name":{"type":"string","description":"Name of the product."},"hsCode":{"type":"string","nullable":true,"description":"HS code of the product, as a number string without separators."}},"required":["id","name","hsCode"]}}}}
```

## The GetProductDto object

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"components":{"schemas":{"GetProductDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this product."},"name":{"type":"string","description":"Name of the product."},"hsCode":{"type":"string","nullable":true,"description":"HS code of the product, as a number string without separators."},"description":{"type":"string","nullable":true,"description":"Short description of the product."},"commodity":{"nullable":true,"description":"Commodity of the product, derived from its HS code.","allOf":[{"$ref":"#/components/schemas/Commodity"}]},"buyerProductRef":{"type":"string","nullable":true,"description":"The buyer's own reference for this product."},"ownerId":{"type":"string","description":"Id of the business owning this product."},"ownerName":{"type":"string","nullable":true,"description":"Name of the business owning this product."},"ownedByCaller":{"type":"boolean","description":"Whether the active business owns this product, as opposed to supplying it."},"suppliers":{"description":"The product's suppliers, alphabetically and limited to 3.\n      Only present with 'includes=suppliers'. The product owner sees every supplier, a product supplier sees only itself.","type":"array","items":{"$ref":"#/components/schemas/GetProductSupplierDto"}},"suppliersTotal":{"type":"number","description":"Total number of suppliers the product has.\n      Only present with 'includes=suppliers'. The product owner sees the full count, a product supplier sees 1."},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"}},"required":["id","name","hsCode","description","commodity","buyerProductRef","ownerId","ownerName","ownedByCaller","createdAt","updatedAt"]},"Commodity":{"type":"string","enum":["cattle","cocoa","coffee","oil palm","rubber","soya","timber"],"description":"What crops (among the relevant commodities) are grown on this field (currently)."},"GetProductSupplierDto":{"type":"object","properties":{"supplierId":{"type":"string","description":"Id of the supplier business this product is shared with."},"supplierName":{"type":"string","nullable":true,"description":"Name of the supplier business."},"plotsExpiryDate":{"type":"string","nullable":true,"description":"The date the supplier's whole assigned-plots set expires on, or null.\n      Informative only — expired assignments stay visible and editable."},"assignedPlotsCount":{"type":"number","description":"How many plots the supplier has assigned to this product, excluding deleted plots."}},"required":["supplierId","supplierName","plotsExpiryDate","assignedPlotsCount"]}}}}
```

## The CreateProductDto object

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"components":{"schemas":{"CreateProductDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the product."},"hsCode":{"type":"string","description":"HS code of the product, as listed in Annex I to Regulation (EEC) No 2658/87. Separators are optional: \"4403.12\" and \"440312\" are equivalent."},"buyerProductRef":{"type":"string","description":"The buyer's own reference for this product."},"description":{"type":"string","description":"Short description of the product."}},"required":["name","hsCode"]}}}}
```

## The CreateProductsBatchDto object

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"components":{"schemas":{"CreateProductsBatchDto":{"type":"object","properties":{"products":{"description":"Products to create, each shaped like the `POST /products` body. Between 1 and 1000 rows.","minItems":1,"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/CreateProductDto"}}},"required":["products"]},"CreateProductDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the product."},"hsCode":{"type":"string","description":"HS code of the product, as listed in Annex I to Regulation (EEC) No 2658/87. Separators are optional: \"4403.12\" and \"440312\" are equivalent."},"buyerProductRef":{"type":"string","description":"The buyer's own reference for this product."},"description":{"type":"string","description":"Short description of the product."}},"required":["name","hsCode"]}}}}
```

## The CreateProductsBatchSummaryDto object

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"components":{"schemas":{"CreateProductsBatchSummaryDto":{"type":"object","properties":{"total":{"type":"number","description":"Number of rows in the request."},"created":{"type":"number","description":"Number of products created."},"failed":{"type":"number","description":"Number of rows rejected."}},"required":["total","created","failed"]}}}}
```

## The UpdateProductDto object

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"components":{"schemas":{"UpdateProductDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the product."},"hsCode":{"type":"string","description":"HS code of the product, as listed in Annex I to Regulation (EEC) No 2658/87. Separators are optional: \"4403.12\" and \"440312\" are equivalent."},"buyerProductRef":{"type":"string","description":"The buyer's own reference for this product."},"description":{"type":"string","description":"Short description of the product."}}}}}}
```

## The CreatedProductEntryDto object

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"components":{"schemas":{"CreatedProductEntryDto":{"type":"object","properties":{"index":{"type":"number","description":"Zero based position of the row in the request `products` array."},"product":{"description":"The created product.","allOf":[{"$ref":"#/components/schemas/GetProductDto"}]}},"required":["index","product"]},"GetProductDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this product."},"name":{"type":"string","description":"Name of the product."},"hsCode":{"type":"string","nullable":true,"description":"HS code of the product, as a number string without separators."},"description":{"type":"string","nullable":true,"description":"Short description of the product."},"commodity":{"nullable":true,"description":"Commodity of the product, derived from its HS code.","allOf":[{"$ref":"#/components/schemas/Commodity"}]},"buyerProductRef":{"type":"string","nullable":true,"description":"The buyer's own reference for this product."},"ownerId":{"type":"string","description":"Id of the business owning this product."},"ownerName":{"type":"string","nullable":true,"description":"Name of the business owning this product."},"ownedByCaller":{"type":"boolean","description":"Whether the active business owns this product, as opposed to supplying it."},"suppliers":{"description":"The product's suppliers, alphabetically and limited to 3.\n      Only present with 'includes=suppliers'. The product owner sees every supplier, a product supplier sees only itself.","type":"array","items":{"$ref":"#/components/schemas/GetProductSupplierDto"}},"suppliersTotal":{"type":"number","description":"Total number of suppliers the product has.\n      Only present with 'includes=suppliers'. The product owner sees the full count, a product supplier sees 1."},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"}},"required":["id","name","hsCode","description","commodity","buyerProductRef","ownerId","ownerName","ownedByCaller","createdAt","updatedAt"]},"Commodity":{"type":"string","enum":["cattle","cocoa","coffee","oil palm","rubber","soya","timber"],"description":"What crops (among the relevant commodities) are grown on this field (currently)."},"GetProductSupplierDto":{"type":"object","properties":{"supplierId":{"type":"string","description":"Id of the supplier business this product is shared with."},"supplierName":{"type":"string","nullable":true,"description":"Name of the supplier business."},"plotsExpiryDate":{"type":"string","nullable":true,"description":"The date the supplier's whole assigned-plots set expires on, or null.\n      Informative only — expired assignments stay visible and editable."},"assignedPlotsCount":{"type":"number","description":"How many plots the supplier has assigned to this product, excluding deleted plots."}},"required":["supplierId","supplierName","plotsExpiryDate","assignedPlotsCount"]}}}}
```

## The ResponseCreateProductsBatchDto object

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"components":{"schemas":{"ResponseCreateProductsBatchDto":{"type":"object","properties":{"status":{"type":"string","description":"Overall result. FAILURE means no product was created; the per row detail is still present.","enum":["SUCCESS","PARTIAL_FAILURE","FAILURE"]},"summary":{"$ref":"#/components/schemas/CreateProductsBatchSummaryDto"},"created":{"type":"array","items":{"$ref":"#/components/schemas/CreatedProductEntryDto"}},"failed":{"type":"array","items":{"$ref":"#/components/schemas/FailedProductEntryDto"}}},"required":["status","summary","created","failed"]},"CreateProductsBatchSummaryDto":{"type":"object","properties":{"total":{"type":"number","description":"Number of rows in the request."},"created":{"type":"number","description":"Number of products created."},"failed":{"type":"number","description":"Number of rows rejected."}},"required":["total","created","failed"]},"CreatedProductEntryDto":{"type":"object","properties":{"index":{"type":"number","description":"Zero based position of the row in the request `products` array."},"product":{"description":"The created product.","allOf":[{"$ref":"#/components/schemas/GetProductDto"}]}},"required":["index","product"]},"GetProductDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of this product."},"name":{"type":"string","description":"Name of the product."},"hsCode":{"type":"string","nullable":true,"description":"HS code of the product, as a number string without separators."},"description":{"type":"string","nullable":true,"description":"Short description of the product."},"commodity":{"nullable":true,"description":"Commodity of the product, derived from its HS code.","allOf":[{"$ref":"#/components/schemas/Commodity"}]},"buyerProductRef":{"type":"string","nullable":true,"description":"The buyer's own reference for this product."},"ownerId":{"type":"string","description":"Id of the business owning this product."},"ownerName":{"type":"string","nullable":true,"description":"Name of the business owning this product."},"ownedByCaller":{"type":"boolean","description":"Whether the active business owns this product, as opposed to supplying it."},"suppliers":{"description":"The product's suppliers, alphabetically and limited to 3.\n      Only present with 'includes=suppliers'. The product owner sees every supplier, a product supplier sees only itself.","type":"array","items":{"$ref":"#/components/schemas/GetProductSupplierDto"}},"suppliersTotal":{"type":"number","description":"Total number of suppliers the product has.\n      Only present with 'includes=suppliers'. The product owner sees the full count, a product supplier sees 1."},"createdAt":{"type":"string","description":"ISO 8601"},"updatedAt":{"type":"string","description":"ISO 8601"}},"required":["id","name","hsCode","description","commodity","buyerProductRef","ownerId","ownerName","ownedByCaller","createdAt","updatedAt"]},"Commodity":{"type":"string","enum":["cattle","cocoa","coffee","oil palm","rubber","soya","timber"],"description":"What crops (among the relevant commodities) are grown on this field (currently)."},"GetProductSupplierDto":{"type":"object","properties":{"supplierId":{"type":"string","description":"Id of the supplier business this product is shared with."},"supplierName":{"type":"string","nullable":true,"description":"Name of the supplier business."},"plotsExpiryDate":{"type":"string","nullable":true,"description":"The date the supplier's whole assigned-plots set expires on, or null.\n      Informative only — expired assignments stay visible and editable."},"assignedPlotsCount":{"type":"number","description":"How many plots the supplier has assigned to this product, excluding deleted plots."}},"required":["supplierId","supplierName","plotsExpiryDate","assignedPlotsCount"]},"FailedProductEntryDto":{"type":"object","properties":{"index":{"type":"number","description":"Zero based position of the row in the request `products` array."},"name":{"type":"string","description":"The row name, when it sent a string one.","nullable":true},"code":{"type":"string","description":"Machine parseable reason the row was rejected.","enum":["VALIDATION_FAILED","PRODUCT_ALREADY_EXISTS","DUPLICATE_IN_REQUEST","INTERNAL_ERROR"]},"message":{"type":"string","description":"Human readable detail for this failure."},"existingProductId":{"type":"string","description":"For PRODUCT_ALREADY_EXISTS, the id of the existing product with this buyerProductRef."},"duplicateOfIndex":{"type":"number","description":"For DUPLICATE_IN_REQUEST, the index of the earlier row with the same buyerProductRef."}},"required":["index","name","code","message"]}}}}
```

## The FailedProductEntryDto object

```json
{"openapi":"3.0.0","info":{"title":"TradeAware API","version":"0.58.1"},"components":{"schemas":{"FailedProductEntryDto":{"type":"object","properties":{"index":{"type":"number","description":"Zero based position of the row in the request `products` array."},"name":{"type":"string","description":"The row name, when it sent a string one.","nullable":true},"code":{"type":"string","description":"Machine parseable reason the row was rejected.","enum":["VALIDATION_FAILED","PRODUCT_ALREADY_EXISTS","DUPLICATE_IN_REQUEST","INTERNAL_ERROR"]},"message":{"type":"string","description":"Human readable detail for this failure."},"existingProductId":{"type":"string","description":"For PRODUCT_ALREADY_EXISTS, the id of the existing product with this buyerProductRef."},"duplicateOfIndex":{"type":"number","description":"For DUPLICATE_IN_REQUEST, the index of the earlier row with the same buyerProductRef."}},"required":["index","name","code","message"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.live-eo.com/tradeaware/using-the-tradeaware-api/api-reference/products.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
