Sign in
Collections - Tier-N

Get a tree-structure of suppliers of the given collection

⚠️ 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 EndpointNew EndpointPurpose
GET /public/v3/alpha/suppliers/collection/{collectionId}/supplier-graphGET /public/v1/collections/{collectionId}/tier-n/dataGet 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:

GET /public/v3/alpha/suppliers/collection/123/supplier-graph?format=JSON&tier=2

After:

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.

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

Path parameters

collectionIdinteger required

Collection identifier

Query parameters

format'JSON' | 'CSV'

Output format for supplier graph responses

Output format: JSON (default) or CSV

includeHeaderMetadataboolean

Include metadata as response headers

includeCommodityFilterboolean

Include commodity filter in the response metadata

includeMediaSourcesboolean

Include media source URLs for MEDIA edges

includeShipmentDetailsboolean

Include shipment details where applicable

tierinteger

Restrict to a specific tier (1..n)

source'Customer' | 'Media' | 'Customs' | 'PrewavePrediction'

Restrict to a specific edge source

lastShipmentstring date

Only include suppliers with shipments since this date (YYYY-MM-DD)

hsCodesstring[]

Filter by HS codes

Response

Successful response.

tierinteger required

Tier number of the relationship (1 = direct)

supplierIdinteger required

Supplier node identifier

customerIdinteger required

Customer/target node identifier

source'Customer' | 'Media' | 'Customs' | 'PrewavePrediction' required
probabilityinteger nullable

Confidence or probability for the relationship in percent (0-100)

mediaSourcesstring[] nullable

List of media source URLs used to derive MEDIA edges; present only when includeMediaSources=true

nShipmentsinteger nullable

Number of shipments observed for this supplier/target pair (if shipments filtering is active)

nshipmentsinteger

Example response

[
  {
    "tier": 2,
    "supplierId": 4567,
    "customerId": 1234,
    "probability": 87,
    "mediaSources": [
      "https://example.com/article-1",
      "https://example.com/article-2"
    ],
    "nShipments": 3,
    "shipments": [
      {
        "hscode": 847330,
        "nShipments": 5,
        "lastShipment": "2024-03-15"
      }
    ]
  }
]