Skip to main content
GET
Period Country Sales

Period Country Sales

Retrieve the country-level sales breakdown for a specific period of a sold product. Each entry represents the quantity sold in a specific country, along with the unit of measurement and location details.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

string
required
UUID of the sold productExample: "550e8400-e29b-41d4-a716-446655440000"
string
required
UUID of the periodExample: "11111111-1111-1111-1111-111111111111"

Response

Returns country sales data with total quantity and optional file reference (HTTP 200).
array[object]
List of country-level sales entries.
number
Sum of quantities across all countries.
object | null
Reference to the uploaded CSV file, if data was imported via file. null if entered manually.

Example

Successful Response

Common Errors

401 Unauthorized

Cause: Missing or invalid API key

403 Forbidden

Cause: The authenticated user is not a member of the organization

404 Not Found

Cause: The sold product or period does not exist or belongs to another organization

Period Emissions

View emissions calculated for this period

List Periods

View all periods for a product