---
title: "Get a tree-structure of suppliers of the given collection"
method: GET
path: "/public/v3/alpha/suppliers/collection/{collectionId}/supplier-graph"
tags: ["Collections - Tier-N"]
deprecated: true
---

# Get a tree-structure of suppliers of the given collection

`GET /public/v3/alpha/suppliers/collection/{collectionId}/supplier-graph`

> **Deprecated.**

⚠️ **DEPRECATED** - This endpoint is deprecated and will be removed at the end of December 2026.

**Note**: Responses include a `Sunset` HTTP header (RFC 8594) indicating the removal date.

---

## Migration Required

This endpoint has been replaced by the v1 Collections Tier-N API. Please migrate to the new endpoint:

### Replacement Endpoint

| Old Endpoint | New Endpoint | Purpose |
|--------------|--------------|---------|
| `GET /public/v3/alpha/suppliers/collection/{collectionId}/supplier-graph` | `GET /public/v1/collections/{collectionId}/tier-n/data` | Get collection-based supplier graphs |

---

## Why Migrate?

The v1 Collections Tier-N API provides significant improvements:

### 1. Enhanced Functionality
- **v3**: Basic supplier graph with format options
- **v1**: Advanced filtering through collection settings and query parameters
- **v1**: Configurable data sources (customs, media, predictions)
- **v1**: Better control over scope (private, shared, public targets)

### 2. Better Performance
- **v1**: Optimized queries for large collections
- **v1**: More efficient data retrieval

### 3. Improved Documentation
- Comprehensive examples for all endpoints
- Detailed error response documentation
- Clear parameter descriptions

---

## Quick Migration Guide

### Step 1: Update Endpoint URL

**Before:**
```http
GET /public/v3/alpha/suppliers/collection/123/supplier-graph?format=JSON&tier=2
```

**After:**
```http
GET /public/v1/collections/123/tier-n/data?tier=2
```

### Step 2: Update Response Parsing

**Before:** Parse `PublicSupplierGraphEntry` structure (v3 format)

**After:** Parse `PublicTierNCollectionGraphEntry` structure (v1 format)

### Step 3: Handle Format Options

**v3**: Supports JSON and CSV via `format` parameter

**v1**: Returns JSON by default. For CSV export, use the response format directly or contact support for CSV export options.

---

**Required Permission**: `ACCESS_PUBLIC_SUPPLIER_GRAPH`

**Performance Impact**: High

For detailed API reference and examples, see the v1 Collections Tier-N API documentation.

## Path parameters

- `collectionId` integer, required

## Query parameters

- `format` 'JSON' | 'CSV' — Output format for supplier graph responses
- `includeHeaderMetadata` boolean
- `includeCommodityFilter` boolean
- `includeMediaSources` boolean
- `includeShipmentDetails` boolean
- `tier` integer
- `source` 'Customer' | 'Media' | 'Customs' | 'PrewavePrediction'
- `lastShipment` string, date
- `hsCodes` string[]

## Response `200`

Successful response.

- PublicSupplierGraphEntry[]
  - `tier` integer, required — Tier number of the relationship (1 = direct)
  - `supplierId` integer, required — Supplier node identifier
  - `customerId` integer, required — Customer/target node identifier
  - `source` 'Customer' | 'Media' | 'Customs' | 'PrewavePrediction', required
  - `probability` integer, nullable — Confidence or probability for the relationship in percent (0-100)
  - `mediaSources` string[], nullable — List of media source URLs used to derive MEDIA edges; present only when includeMediaSources=true
  - `nShipments` integer, nullable — Number of shipments observed for this supplier/target pair (if shipments filtering is active)
  - `shipments` PublicSupplierGraphShipment[], nullable — Detailed shipment information per HS code; present only when includeShipmentDetails=true
    - `hscode` integer, required — HS code (6 digits)
    - `nShipments` integer, nullable — Number of shipments observed for this HS code
    - `lastShipment` string, date, nullable — Date of the last observed shipment for this HS code
    - `nshipments` integer
  - `nshipments` integer

## Other responses

- `400` — Bad Request – invalid parameters
- `403` — 403 Forbidden - Authentication or authorization failure. This status code is returned when: (1) the request lacks valid authentication credentials (missing or invalid X-Auth-Token header), or (2) the authenticated user does not have the required permission to access this resource.
- `429` — 429 Too Many Requests - API rate limit exceeded. The request has been rejected because the rate limit for this endpoint has been exceeded. Default rate limits: GET requests - 100 per 10 seconds, 500 per minute; POST/PUT/PATCH/DELETE requests - 20 per 10 seconds, 100 per minute. For increased access, please contact customer success.
- `500` — 500 Internal Server Error - An unexpected error occurred on the server. The request may or may not have been processed.

---

[API](https://skmtc.net/prewave/apis/public-prewave-api.md) · [All operations](https://skmtc.net/prewave/apis/public-prewave-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/prewave/public-prewave-api/revisions/466169815b78/schema)