API ReferenceSupply Chain

Upstream Trade Traversal

Beta

Execute a traversal of the upstream trade network (supply chain) of an entity, returning a set of entities and edges between them.

Path parameters

idstringRequired
The root entity identifier.

Headers

AuthorizationstringRequired

OAuth authentication of the form <token>.

Query parameters

productlist of stringsOptional

Product root edge filter. Filters results to include only trade relationships where the associated component is part of the specified product’s blueprint or is a sub-component of that product.

-productlist of stringsOptional

Product root edge filter. Filters results to exclude any trade relationships where the associated component is part of the specified product’s blueprint or is a sub-component of that product.

risklist of enumsOptional

Risk leaf node filter. Only return supply chains that end with a supplier that has 1+ of the specified risk factors.

-risklist of enumsOptional
Risk leaf node filter. Only return supply chains that end with a supplier that has none of the specified risk factors.
countrieslist of enumsOptional

Country leaf node filter. Only return supply chains that end with a supplier in 1+ of the specified countries.

-countrieslist of enumsOptional
Country leaf node filter. Only return supply chains that end with a supplier in none of the specified countries.
shipment_countrylist of enumsOptional

Filters supply chain paths where 1+ shipment country from any tier matches the provided values.

-shipment_countrylist of enumsOptional
Filters supply chain paths where none of the shipment countries from any tier matches the provided values.
tier1_shipment_countrylist of enumsOptional

Filters supply chain paths where 1+ shipment country from tier 1 matches the provided values.

tier2_shipment_countrylist of enumsOptional

Filters supply chain paths where 1+ shipment country from tier 2 matches the provided values.

tier3_shipment_countrylist of enumsOptional

Filters supply chain paths where 1+ shipment country from tier 3 matches the provided values.

tier4_shipment_countrylist of enumsOptional

Filters supply chain paths where 1+ shipment country from tier 4 matches the provided values.

tier5_shipment_countrylist of enumsOptional

Filters supply chain paths where 1+ shipment country from tier 5 matches the provided values.

componentlist of stringsOptional

Component edge filter. Only return supply chains that contain at least one edge with 1+ of the specified HS codes.

-componentlist of stringsOptional
Component edge filter. Only return supply chains that contain no edges with any of the specified HS codes.
min_datestringOptional

Minimum date edge filter in <YYYY-MM-DD> format. Only return supply chains with edge dates that are greater than or equal to this date.

max_datestringOptional

Maximum date edge filter in <YYYY-MM-DD> format. Only return supply chains with edge dates that are less than or equal to this date.

max_depthintegerOptional
The maximum depth of the traversal, from 1 to 4 inclusive. Default is 4. Reduce if query is timing out.
limitintegerOptional
The maximum number of results to return. Default is no limit.

Response

This endpoint returns an object.
filtersobject
dataobject
explored_countinteger
Number of hops explored in the traversal
partial_resultsboolean
True if the traversal returned partial results
statusinteger or null
successboolean or null
messagestring or null

Errors