Sold Products API
The Sold Products API enables you to manage downstream emissions from products your organization sells. Track products across time periods and geographic markets, with emissions automatically calculated per period for Scope 3 Category 11 (Use of Sold Products) reporting.New API: These endpoints are part of the new API architecture.
Key Features
- Product Lifecycle Tracking: Manage sold products with time-based periods and country-level sales data
- Geographic Breakdown: Track quantities sold per country with associated emission factors
- Period Management: Organize data by reporting periods with overlap detection
- Emissions Calculation: Automatic calculation of downstream emissions per period
- Deduplication: Check for existing product-country combinations before uploading
Authentication
All endpoints require authentication using an API key included in thex-api-key header.
Headers
All requests must include:string
required
Your organization UUIDExample:
a8315ef3-dd50-43f8-b7ce-d839e68d51fastring
required
Your API key for authenticationExample:
sk_live_1234567890abcdefAvailable Endpoints
Product Management
List Sold Products
Retrieve all sold products with optional name filter
Delete Sold Product
Remove a sold product and all related data
Existing Country Sales
Check existing product-country combinations for deduplication
Period Management
List Periods
Get all periods for a sold product
Check Period Overlap
Verify if a date range overlaps with existing periods
Delete Period
Remove a period from a sold product
Emissions & Sales Data
Period Country Sales
Get country-level sales breakdown for a period
Period Emissions
Get emissions data for a sold product period
Data Model
Sold Product Object
Period Object
Country Sales Object
Period Emissions Object
Sold Product Attributes
Period Attributes
Emissions Attributes
Error Handling
Common HTTP Status Codes
Common Use Cases
List all sold products and their periods
Check for existing data before upload
Get emissions breakdown for a period
Related Documentation
ISO 14064 Category 5
ISO 14064 downstream emissions from sold products
Purchases API
Track upstream purchased goods and services
GHG Protocol Scope 3
Complete Scope 3 emissions guide
Emissions API
View aggregated emissions summaries