Skip to content
AI-ready version:

Retrieve Eco Club Offering List

Description

This API enables users to retrieve a list of eco club offerings associated with a specified application or offering. It provides detailed information about the offerings, such as their configurations and claim details.

Endpoint

GET https://impact.dots.eco/api/v1/eco-club-offering/list/{app_token}

Refer to Headers and Authorization for details about required headers and token authentication.

Parameters

Name Required Type Description
app_token Yes string The unique token identifying the application. Can be found in the app dashboard.
uuid No string The specific UUID of the eco club offering (if filtering by UUID).
external-unique-id No string The external unique ID of the eco club offering (if provided).

Example Request

Minimal Request

curl --location 'https://impact.dots.eco/api/v1/eco-club-offering/list/APP_TOKEN' \
--header 'Content-Type: application/json' \
--header 'auth-token: YOUR_AUTH_TOKEN'

Responses

Successful Response

Returns a JSON array containing eco club offering details.

Response Body Example

[
    {
        "uuid": "229ca556-14e5-408f-8ed3-08eac72f8996",
        "title": null,
        "quantity": "6",
        "limit_allocations": "139",
        "name_on_certificate": null,
        "activation_date": null,
        "expiration_date": null,
        "code": "nulla aliquam",
        "max_claims_total": 1,
        "claim_url": "https://impact.dots.eco/app/123/eco-club/claim",
        "no_of_claims": 0
    },
    {
        "uuid": "12332e-123-4c06-1323-87f72184e720",
        "title": null,
        "quantity": "6",
        "limit_allocations": "139",
        "name_on_certificate": null,
        "activation_date": null,
        "expiration_date": null,
        "code": "doloremque",
        "max_claims_total": 1,
        "claim_url": "https://impact.dots.eco/app/123/eco-club/claim",
        "no_of_claims": 0
    }
]

Response Fields

Field Type Description
uuid string The UUID identifying the eco club offering entity.
quantity string Impact quantity allocated to the offering.
limit_allocations string Comma-separated allocation IDs for this offering.
name_on_certificate string The name shown on the certificate (if provided).
activation_date string GMT activation date for the offering (YYYY-MM-DD).
expiration_date string GMT expiration date for the offering (YYYY-MM-DD).
code string The activation code for the offering.
title string The title of the eco club offering.
max_claims_total integer The maximum number of claims allowed for the offering.
claim_url string The claim URL for this eco club offering.
no_of_claims integer The number of claims made against this offering.

HTTP Status Codes

Code Description
200 Request completed successfully.
403 Forbidden. Check app configuration or permissions.

Errors

403 Forbidden

Indicates the application or user is not authorized to perform this request.

Common Error Messages

Message Cause
"Auth user not associated with the application." The auth-token does not belong to an authorized user for the application.
"Provided app is not of type Eco Club." The app is not configured as an eco club application.
"Your company is not yet activated..." The company account is not activated for production requests.

422 Unprocessable Entity

Occurs when required parameters are missing or invalid.

Common Error Messages

Message Cause
"Please provide a app_token." Missing app_token parameter.
"Please provide a valid app_token." The provided app_token is invalid or not recognized.
"Please provide a uuid." Missing or invalid uuid parameter.
"Eco Club Offerings not found." No offerings match the provided uuid or criteria.

Error Response Examples

Missing app_token

{
  "message": "Please provide a app_token."
}

Unauthorized User or Application

{
  "message": "Auth user not associated with the application."
}

Invalid Application Type

{
  "message": "Provided app is not of type Eco Club."
}

Offering Not Found

{
  "message": "Eco Club Offerings not found."
}

Notes

  • Localized Claim URLs: Use the langcode field within the app settings to access claim URLs in the desired language.
  • Permissions: Ensure the auth-token and app_token provided match the eco club application configuration.
  • Refer to Headers and Authorization for more information about authentication and required headers.