# Retrieve Products

A product is any purchasable compensation option SQUAKE offers.
In the simplest case, a product maps to a single climate project such as "Sustainable
Biofuel for Shipping". Depending on client need, SQUAKE also offers bundles
of multiple climate projects; these can be centered around specific goals,
e.g.,"carbon reduction", "location", or what is desired to achieve a particular
price point or sustainability goal. Feel free to contact us for more information
or custom products.


Endpoint: GET /v2/products
Security: Bearer-Auth

## Query parameters:

  - `locale` (string)
    Descriptions of products can be localized.
    Enum: "de", "en", "es", "fr", "hi", "it", "ja", "pt", "pt-BR", "zh-CN"

  - `page` (number)
    An optional parameter that enables pagination, by default the amount of items per page is 25

  - `items` (number)
    An optional parameter that enables pagination, this controls the amount of items per page. Can be used separetly or in conjunction with

  - `category` (string)
    Allows filtering of the categories of a product, filters by

  - `class` (string)
    Allows filtering of the classes of a product, filters by

  - `impact_type` (string)
    Allows filtering of the impact types of a product, filters by

## Response 200 fields (application/json):

  - `id` (string, required)

  - `locations` (array)
    List of all locations impacted by the projects used in this product.

  - `locations.country` (string, required)
    Two-letter or three-letter code as defined in ISO 3166-1 alpha-2 and alpha-3 respectively.

  - `locations.sub_region` (string)
    One to Three-digit UN M49 sub region code.

  - `locations.region` (string)
    One to Three-digit UN M49 region code.

  - `certifications` (array)
    List of all certifications the projects for this product hold.
    Enum: "American Carbon Registry", "Australian Biodiversity Unit", "BAFU VER", "Clean Development Mechanism", "DNV", "Ernst & Young", "European Biochar Certification", "Gold Standard CER", "Gold Standard VER", "I-REC", "International Sustainability & Carbon Certification (ISCC)", "ISO 14064", "Moor Futures", "Müller BBM", "Plan Vivo", "TÜV", "Verified Carbon Standard"

  - `title` (string)
    A short human readable summary of the description.

  - `description` (string)
    A human readable description.

  - `sdgs` (array)
    The Sustainable Development Goals (SDGs) aim to transform our world. They are a call to action to end poverty and inequality, protect the planet, and ensure that all people enjoy health, justice and prosperity.

  - `files` (array)
    Images attached to the product.

  - `files.filename` (string, required)

  - `files.purpose` (string, required)
    Enum: "confirmation_document", "certificate_document", "project_image"

  - `files.size` (integer, required)
    Byte size of the object

  - `files.type` (string, required)
    Enum: "csv", "jpg", "pdf", "png", "webp"

  - `files.download_url` (string)
    The link will expire after 1 year. If blank, the document has not been created yet. Please poll until a link is included.

  - `files.notification` (string)
    Information pertaining to the file, e.g., when the file will be available

  - `prices` (array)
    Multiple prices may exist, for example, when future price changes are already known.

  - `prices.product` (string, required)

  - `prices.unit_amount` (integer, required)
    The total amount in the lower denomination of the currency; e.g. 12.34 USD would be 1234.

  - `prices.carbon_unit` (string, required)
    SQUAKE uses The International System of Units (SI), commonly referred to as "metric system".
    Enum: "tonne", "kilogram", "gram"

  - `prices.currency` (string, required)
    3-letter ISO 4217 alpha code of the currency.
    Enum: "AED", "AMD", "ARS", "AUD", "AZN", "BAM", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "DZD", "EGP", "ETB", "EUR", "GBP", "GEL", "HKD", "HUF", "IDR", "INR", "ISK", "JMD", "JOD", "JPY", "KES", "KRW", "KWD", "KZT", "LKR", "LYD", "MAD", "MUR", "MXN", "MYR", "NOK", "NZD", "OMR", "PHP", "PKR", "PLN", "QAR", "RSD", "RUB", "SAR", "SEK", "SGD", "SYP", "THB", "TND", "TRY", "TTD", "TWD", "UAH", "USD", "VND", "XAF", "XOF", "ZAR"

  - `prices.valid_from` (string, required)
    Date in ISO 8601 notation.

  - `categories` (array)

  - `categories.code` (string, required)
    Unique identifier for a category

  - `categories.title` (string)
    English human-readable name of the category.

  - `impact_types` (array)

  - `impact_types.code` (string, required)
    Unique identifier for a impact type

  - `impact_types.title` (string)
    English human-readable name of the impact type

  - `classes` (array)

  - `classes.code` (string, required)
    Unique identifier for a project class

  - `classes.title` (string)
    English human-readable name of the project class

## Response 401 fields (application/json):

  - `errors` (array)

  - `errors.code` (string, required)
    An application-specific error code, expressed as a string value.
    Enum: "field_validation_error", "server_error", "not_authorized", "not_found", "invalid_methodology", "invalid_type"

  - `errors.detail` (string)
    A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized.

  - `errors.source` (object)
    An object containing references to the primary source of the error

  - `errors.source.id` (string)

  - `errors.source.attribute` (string, required)

  - `errors.source.model` (string)