LearnGraph LoginRequest a Demo
HomeAPIBulk DataSayari LibraryChange Log
  • Key Concepts
    • Introduction
    • Endpoint Overview
    • Authentication
    • Requests
    • Pagination
    • Response Status Codes
    • Data Types
    • Rate Limits
  • API Clients
    • Overview
    • Open API
    • Postman
    • Go
    • Python
    • Node
  • API Reference
  • Guides
    • Getting Started
    • Understanding Project Entity
    • Risk Factors
    • Entity Search
    • Advanced Entity Search
    • Resolution
    • Trade Search - Shipments
    • Trade Search - Suppliers & Buyers
    • v0 Migration
  • Implementation Patterns
    • Project Entity Supply Chain
  • Use Cases
    • Entity Screening & Verification
    • Investigations
LogoLogo
LearnGraph LoginRequest a Demo
API ReferenceProject Entity

Beta
GET
/v1/projects/:project_id/entities/:project_entity_id/supply_chain/upstream
GET
/v1/projects/:project_id/entities/:project_entity_id/supply_chain/upstream
1curl -G https://api.sayari.com/v1/projects/0n4473/entities/yebNPJ/supply_chain/upstream \
2 -H "Authorization: Bearer <token>" \
3 -d product=6004 \
4 -d limit=1
Try it
200SupplierExample
1{
2 "filters": {
3 "product": [
4 "6004"
5 ],
6 "limit": 1
7 },
8 "data": {
9 "paths": [
10 {
11 "source_entity_id": "e0WEtIhAvDUjWs-hg12jSA",
12 "path": [
13 {
14 "tier": 2,
15 "entity_id": "bWbImzpaFHN-4tj9n8JXzg",
16 "components": [
17 {
18 "hs_code": "6004",
19 "arrival_countries": [
20 "KHM"
21 ],
22 "departure_countries": [
23 "VNM"
24 ],
25 "min_date": "2023-01-01",
26 "max_date": "2024-12-31"
27 }
28 ]
29 },
30 {
31 "tier": 3,
32 "entity_id": "_jCU70ygP5Vx0kheGGxniw",
33 "components": [
34 {
35 "hs_code": "5402",
36 "arrival_countries": [
37 "VNM"
38 ],
39 "departure_countries": [
40 "VNM"
41 ],
42 "min_date": "2023-01-01",
43 "max_date": "2025-01-17"
44 }
45 ]
46 },
47 {
48 "tier": 4,
49 "entity_id": "dRvTdx1af-XrFqh9L3Y4-Q",
50 "components": [
51 {
52 "hs_code": "3907",
53 "arrival_countries": [
54 "VNM"
55 ],
56 "departure_countries": [
57 "JPN"
58 ],
59 "min_date": "2023-01-16",
60 "max_date": "2025-01-24"
61 }
62 ]
63 },
64 {
65 "tier": 5,
66 "entity_id": "FFXyR4N57IZuQDTH2pzYTQ",
67 "components": [
68 {
69 "hs_code": "2909",
70 "arrival_countries": [
71 "JPN"
72 ],
73 "departure_countries": [
74 "USA"
75 ],
76 "min_date": "2023-06-24",
77 "max_date": "2023-08-11"
78 }
79 ]
80 }
81 ]
82 }
83 ],
84 "entities": {
85 "FFXyR4N57IZuQDTH2pzYTQ": {
86 "id": "FFXyR4N57IZuQDTH2pzYTQ",
87 "type": "company",
88 "label": "Dow Chemical Co",
89 "risk_factors": [
90 "law_enforcement_action",
91 "psa_forced_labor_xinjiang_origin_subtier",
92 "reputational_risk_other",
93 "reputational_risk_financial_crime",
94 "forced_labor_xinjiang_origin_subtier",
95 "regulatory_action",
96 "psa_forced_labor_aspi_origin_subtier"
97 ],
98 "countries": [
99 "BEL",
100 "CAN",
101 "ECU",
102 "USA"
103 ]
104 },
105 "dRvTdx1af-XrFqh9L3Y4-Q": {
106 "id": "dRvTdx1af-XrFqh9L3Y4-Q",
107 "type": "company",
108 "label": "NAGASE & CO LTD",
109 "risk_factors": [
110 "psa_forced_labor_uflpa_origin_subtier",
111 "exports_ilab_forced_labor",
112 "psa_forced_labor_xinjiang_origin_subtier",
113 "psa_export_to_soe",
114 "forced_labor_sheffield_hallam_university_reports_origin_subtier",
115 "psa_forced_labor_sheffield_hallam_university_reports_origin_subtier",
116 "psa_exports_ilab_forced_labor",
117 "forced_labor_uflpa_origin_subtier",
118 "forced_labor_xinjiang_origin_subtier",
119 "psa_forced_labor_aspi_origin_subtier"
120 ],
121 "countries": [
122 "BRA",
123 "CAN",
124 "CHN",
125 "DEU",
126 "ESP",
127 "GBR",
128 "ISR",
129 "JPN",
130 "KOR",
131 "NLD",
132 "SGP",
133 "TCD",
134 "THA",
135 "TUR",
136 "TWN",
137 "USA",
138 "VNM"
139 ]
140 },
141 "_jCU70ygP5Vx0kheGGxniw": {
142 "id": "_jCU70ygP5Vx0kheGGxniw",
143 "type": "company",
144 "label": "CôNG TY TRáCH NHIệM HữU HạN HYOSUNG VIệT NAM",
145 "risk_factors": [
146 "psa_forced_labor_uflpa_origin_subtier",
147 "exports_ilab_forced_labor",
148 "psa_forced_labor_xinjiang_origin_subtier",
149 "eu_high_risk_third",
150 "psa_export_to_soe",
151 "forced_labor_sheffield_hallam_university_reports_origin_subtier",
152 "psa_exports_ilab_child_labor",
153 "psa_exports_eudr_shipment_wood",
154 "exports_eudr_shipment_wood",
155 "psa_exports_eudr_shipment_rubber",
156 "exports_ilab_child_labor",
157 "psa_forced_labor_sheffield_hallam_university_reports_origin_subtier",
158 "psa_exports_ilab_forced_labor",
159 "exports_eudr_shipment_rubber",
160 "forced_labor_uflpa_origin_subtier",
161 "export_to_soe",
162 "forced_labor_xinjiang_origin_subtier",
163 "psa_forced_labor_aspi_origin_subtier"
164 ],
165 "countries": [
166 "ARE",
167 "ARG",
168 "AUT",
169 "BEL",
170 "BRA",
171 "CHE",
172 "CHN",
173 "CYP",
174 "CZE",
175 "DEU",
176 "ECU",
177 "ESP",
178 "FIN",
179 "FRA",
180 "GBR",
181 "GEO",
182 "GRC",
183 "HKG",
184 "HUN",
185 "IDN",
186 "IND",
187 "ITA",
188 "JPN",
189 "KHM",
190 "KOR",
191 "LTU",
192 "LUX",
193 "LVA",
194 "MEX",
195 "MYS",
196 "NAM",
197 "PHL",
198 "POL",
199 "PRT",
200 "ROU",
201 "SAU",
202 "SEN",
203 "SGP",
204 "SRB",
205 "SVN",
206 "SWE",
207 "THA",
208 "TUR",
209 "TWN",
210 "USA",
211 "VIR",
212 "VNM"
213 ]
214 },
215 "bWbImzpaFHN-4tj9n8JXzg": {
216 "id": "bWbImzpaFHN-4tj9n8JXzg",
217 "type": "company",
218 "label": "Công ty TNHH GAIN LUCKY (Việt Nam)",
219 "risk_factors": [
220 "psa_forced_labor_uflpa_origin_subtier",
221 "exports_ilab_forced_labor",
222 "psa_forced_labor_xinjiang_origin_subtier",
223 "eu_high_risk_third",
224 "sheffield_hallam_university_forced_labor_reports_intermediary_entity",
225 "forced_labor_sheffield_hallam_university_reports_origin_subtier",
226 "psa_exports_ilab_child_labor",
227 "psa_exports_eudr_shipment_wood",
228 "exports_eudr_shipment_wood",
229 "exports_ilab_child_labor",
230 "psa_forced_labor_sheffield_hallam_university_reports_origin_subtier",
231 "psa_exports_ilab_forced_labor",
232 "forced_labor_uflpa_origin_subtier",
233 "forced_labor_xinjiang_origin_subtier",
234 "psa_forced_labor_aspi_origin_subtier"
235 ],
236 "countries": [
237 "CHE",
238 "CHN",
239 "DEU",
240 "GEO",
241 "HKG",
242 "JPN",
243 "KHM",
244 "KOR",
245 "THA",
246 "VIR",
247 "VNM"
248 ]
249 },
250 "e0WEtIhAvDUjWs-hg12jSA": {
251 "id": "e0WEtIhAvDUjWs-hg12jSA",
252 "type": "company",
253 "label": "MARVEL GARMENT CO LTD",
254 "risk_factors": [
255 "psa_forced_labor_uflpa_origin_subtier",
256 "exports_ilab_forced_labor",
257 "psa_forced_labor_xinjiang_origin_subtier",
258 "eu_high_risk_third",
259 "forced_labor_sheffield_hallam_university_reports_origin_subtier",
260 "psa_exports_ilab_child_labor",
261 "psa_exports_eudr_shipment_wood",
262 "exports_eudr_shipment_wood",
263 "exports_ilab_child_labor",
264 "psa_forced_labor_wro_origin_subtier",
265 "psa_forced_labor_sheffield_hallam_university_reports_origin_subtier",
266 "psa_exports_ilab_forced_labor",
267 "forced_labor_uflpa_origin_subtier",
268 "forced_labor_xinjiang_origin_subtier",
269 "psa_forced_labor_aspi_origin_subtier"
270 ],
271 "countries": [
272 "CAN",
273 "COL",
274 "HKG",
275 "KHM",
276 "MAC",
277 "USA"
278 ]
279 }
280 }
281 },
282 "explored_count": 70357,
283 "partial_results": false
284}
Was this page helpful?
Previous

Get Project Entity Risk Summary

Next
Built with
Execute a traversal of the upstream trade network (supply chain) for all matched entities of a project entity, returning a set of entities and edges between them.
Project Entity Supply Chain

Authentication

AuthorizationBearer
OAuth authentication of the form `<token>`.

Path Parameters

project_idstringRequired
The project Identifier
project_entity_idstringRequired
The project entity Identifier

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

Risk leaf node filter. Only return supply chains that end with a supplier that has none of the specified risk factors.
Country leaf node filter. Only return supply chains that end with a supplier in none of the specified countries.
Filters supply chain paths where none of the shipment countries from any tier matches the provided values.
Component edge filter. Only return supply chains that contain no edges with any of the specified HS codes.
The maximum depth of the traversal, from 1 to 4 inclusive. Default is 4. Reduce if query is timing out.
The maximum number of results to return. Default is no limit.

OAuth authentication of the form <token>.

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

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.

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.

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

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

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

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.

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.

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

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

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

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

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

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