> ## Documentation Index
> Fetch the complete documentation index at: https://code.dcycle.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Period Country Sales

> Get country-level sales breakdown for a sold product period

# 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

<ParamField header="x-api-key" type="string" required>
  Your API key for authentication

  **Example:** `sk_live_1234567890abcdef`
</ParamField>

<ParamField header="x-organization-id" type="string" required>
  Your organization UUID

  **Example:** `a8315ef3-dd50-43f8-b7ce-d839e68d51fa`
</ParamField>

### Path Parameters

<ParamField path="sold_product_id" type="string" required>
  UUID of the sold product

  **Example:** `"550e8400-e29b-41d4-a716-446655440000"`
</ParamField>

<ParamField path="period_id" type="string" required>
  UUID of the period

  **Example:** `"11111111-1111-1111-1111-111111111111"`
</ParamField>

## Response

Returns country sales data with total quantity and optional file reference (HTTP 200).

<ResponseField name="items" type="array[object]">
  List of country-level sales entries.

  <Expandable title="Country Sale Object">
    <ResponseField name="id" type="string">
      Country sale record UUID.
    </ResponseField>

    <ResponseField name="quantity" type="number">
      Number of units sold in this country.
    </ResponseField>

    <ResponseField name="unit" type="object">
      Unit of measurement.

      <Expandable title="Unit Object">
        <ResponseField name="id" type="string">
          Unit UUID.
        </ResponseField>

        <ResponseField name="name" type="string">
          Unit name (e.g. `"unit"`, `"kilogram"`).
        </ResponseField>

        <ResponseField name="type" type="string">
          Unit type category.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="location" type="object">
      Country information.

      <Expandable title="Location Object">
        <ResponseField name="id" type="string">
          Location UUID.
        </ResponseField>

        <ResponseField name="name" type="string">
          Location name.
        </ResponseField>

        <ResponseField name="type" type="string">
          Location type (e.g. `"country"`).
        </ResponseField>

        <ResponseField name="iso_3" type="string">
          ISO 3166-1 alpha-3 country code.
        </ResponseField>

        <ResponseField name="country_name" type="string">
          Full country name.
        </ResponseField>

        <ResponseField name="area" type="string | null">
          Geographic area or region.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="total_quantity" type="number">
  Sum of quantities across all countries.
</ResponseField>

<ResponseField name="file" type="object | null">
  Reference to the uploaded CSV file, if data was imported via file. `null` if entered manually.
</ResponseField>

## Example

<CodeGroup>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl -X GET "https://api.dcycle.io/v1/sold-products/550e8400-e29b-41d4-a716-446655440000/periods/11111111-1111-1111-1111-111111111111/country-sales" \
    -H "x-api-key: ${DCYCLE_API_KEY}" \
    -H "x-organization-id: ${DCYCLE_ORG_ID}"
  ```

  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  import requests
  import os

  headers = {
      "x-api-key": os.getenv("DCYCLE_API_KEY"),
      "x-organization-id": os.getenv("DCYCLE_ORG_ID"),
  }

  product_id = "550e8400-e29b-41d4-a716-446655440000"
  period_id = "11111111-1111-1111-1111-111111111111"

  response = requests.get(
      f"https://api.dcycle.io/v1/sold-products/{product_id}/periods/{period_id}/country-sales",
      headers=headers,
  )

  data = response.json()
  print(f"Total quantity: {data['total_quantity']}")
  for sale in data["items"]:
      print(f"  {sale['location']['country_name']}: {sale['quantity']} {sale['unit']['symbol']}")
  ```

  ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
  const axios = require('axios');

  const headers = {
    'x-api-key': process.env.DCYCLE_API_KEY,
    'x-organization-id': process.env.DCYCLE_ORG_ID,
  };

  const productId = '550e8400-e29b-41d4-a716-446655440000';
  const periodId = '11111111-1111-1111-1111-111111111111';

  axios.get(
    `https://api.dcycle.io/v1/sold-products/${productId}/periods/${periodId}/country-sales`,
    { headers }
  )
  .then(response => {
    const { items, total_quantity } = response.data;
    console.log(`Total: ${total_quantity}`);
    items.forEach(s => console.log(`${s.location.country_name}: ${s.quantity}`));
  });
  ```
</CodeGroup>

### Successful Response

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "items": [
    {
      "id": "aaa11111-1111-1111-1111-111111111111",
      "quantity": 250.0,
      "unit": {
        "id": "unit-uuid-001",
        "name": "unit",
        "symbol": "u"
      },
      "location": {
        "country_code": "ES",
        "country_name": "Spain"
      }
    },
    {
      "id": "bbb22222-2222-2222-2222-222222222222",
      "quantity": 180.0,
      "unit": {
        "id": "unit-uuid-001",
        "name": "unit",
        "symbol": "u"
      },
      "location": {
        "country_code": "DE",
        "country_name": "Germany"
      }
    }
  ],
  "total_quantity": 430.0,
  "file": null
}
```

## Common Errors

### 401 Unauthorized

**Cause:** Missing or invalid API key

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}
```

### 403 Forbidden

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

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}
```

### 404 Not Found

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

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Not Found"}
```

## Related Endpoints

<CardGroup cols={2}>
  <Card title="Period Emissions" icon="smog" href="/api-reference/sold-products/emissions">
    View emissions calculated for this period
  </Card>

  <Card title="List Periods" icon="calendar" href="/api-reference/sold-products/list-periods">
    View all periods for a product
  </Card>
</CardGroup>