List all the business connections with your suppliers in your commercial network.
get
List all the business connections between your business and your suppliers in your commercial network.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200
Returns the list of business connections.
application/json
idstringRequired
id of this entity
Example: 123e4567-e89b-12d3-a456-426614174000
createdAtstringRequired
date that this connection was created
Example: 2021-01-01T00:00:00.000Z
updatedAtstringRequired
date that this connection was last updated
Example: 2021-01-01T00:00:00.000Z
customDataobjectRequired
metadata for this business connection. Only visible to the buyer who set this.
Example: {"foo":"bar"}
plotsCountnumberRequired
Total number of plots in this supplier's supply chain
Default: 0Example: 1
plotsCommoditiesstring[]Required
List of all commodities produced in this supplier's supply chain
Example: ["cattle","cocoa"]
401Error
403Error
get
/business-connections/suppliers
List all the business connections with your buyers in your commercial network.
get
List all the business connections between your business and your
buyers in your commercial network.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200
Returns the list of business connections.
application/json
idstringRequired
id of this entity
Example: 123e4567-e89b-12d3-a456-426614174000
createdAtstringRequired
date that this connection was created
Example: 2021-01-01T00:00:00.000Z
updatedAtstringRequired
date that this connection was last updated
Example: 2021-01-01T00:00:00.000Z
customDataobjectRequired
metadata for this business connection. Only visible to the buyer who set this.
Example: {"foo":"bar"}
plotsCountnumberRequired
Total number of plots in this supplier's supply chain
Default: 0Example: 1
plotsCommoditiesstring[]Required
List of all commodities produced in this supplier's supply chain
Example: ["cattle","cocoa"]
401Error
403Error
get
/business-connections/buyers
Update the custom data of a business connection
patch
Update the custom data of a business connection if you are the buyer (source business)
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
customDataobjectRequired
A customizable metadata field for storing additional information related to a business invitation in TradeAware.
This field allows customers to associate their own identifiers or data with TradeAware's system.
The `customData` field is returned unchanged and is visible only to the owners of the business invitation.
Constraints:
- Up to 10 keys per object
- Key length: Maximum 255 characters
- String value length: Maximum 255 characters
- Values must be of type: string, number, or boolean
- Nested objects are not allowed
- Keys cannot contain: '__proto__', 'constructor', or 'prototype'
