Get Eco-Contributions for Producer Declarations

GET /producers/{ProducerNrn}/declarations/eco-contributions

Retrieve all eco-contributions for a producer's declaration, including quantities and calculated contributions (quantity × price). The itemWeight field is returned for information only.

Path parameters

  • ProducerNrn string Required

    Producer Unique NRN

Query parameters

  • EprCountryCode string Required

    FR, ES, etc.

  • DeclarationPeriodCode string Required

    2023, 2024, etc.

  • CodePeriod string

    Optional period code to filter results (e.g., JAN, SEP)

  • CodeVendor string

    Optional vendor code to filter results (e.g., AMAZ, CDIS)

Responses

  • 200 application/json

    Eco-contributions retrieved successfully

    Hide response attributes Show response attributes object
    • status string Required
    • count number Required
    • data array[object] Required
      Hide data attributes Show data attributes object
      • producerNrn string
      • eprCountryCode string
      • declarationPeriodCode string
      • codePeriod string | null
      • codeVendor string | null
      • schemeCode string
      • ecoOrganismName string
      • scaleCode string
      • ecoProductReference string
      • quantity number
      • itemWeight string | null

        Weight in KG extracted from product metadata. Used for weight-based pricing.

      • price number
      • priceUnit string

        If 'Poids (KG)', contribution = quantity × price × itemWeight. Otherwise, contribution = quantity × price.

      • ecoContribution number

        Calculated as: quantity × price (rounded to 2 decimals)

  • 400 application/json

    Bad request - Missing required parameters

    Hide response attribute Show response attribute object
    • error string
  • 500 application/json

    An error happenned during the request, refer to error code for more information

    Hide response attribute Show response attribute object
    • error string

      One of:

      The server encountered an unknown error!

      Default value is ALGOREP_001.

      Eco product could not be found

      Default value is ALGOREP_002.

      Dgraph Failed To Process The Request

      Default value is ALGOREP_003.

      Producer could not be found

      Default value is ALGOREP_004.

      Bad Request

      Default value is ALGOREP_005.

      Declaration already validated for this product

      Default value is ALGOREP_006.

      Producer Batch Process Failed: Invalid ContentType, Request Should Be Multipart/FormData.

      Default value is ALGOREP_007.

      No file found on request

      Default value is ALGOREP_008.

      Too many files found on request

      Default value is ALGOREP_009.

      Qualification Pipeline Failed: ExternalId Not Found

      Default value is ALGOREP_010.

      Qualification Pipeline Failed: ExternalIdType Not Found / Could Not Be Determined

      Default value is ALGOREP_011.

      Qualification Pipeline Failed: ProducerNrn Not Found

      Default value is ALGOREP_012.

      Qualification Pipeline Failed: Product 'Title' Or 'Image' Could Not Be Determined, But Necessary To Compute Contributions.

      Default value is ALGOREP_013.

      Qualification Pipeline Failed: EcoFeez Could Not Determine Contributions.

      Default value is ALGOREP_014.

      Qualification Pipeline Failed: EcoFeez Could Not Determine Some Necessary Field.

      Default value is ALGOREP_015.

      Producer Batch Pre Process Pipeline Failed: Could Not Find CSV File On S3.

      Default value is ALGOREP_016.

      Producer Batch Pre Process Pipeline Failed: CSV File Contains Errors

      Default value is ALGOREP_017.

      Producer Batch Pre Process Pipeline Failed: Did Not Find Any Product To Process In CSV File

      Default value is ALGOREP_018.

      Producer Batch Pre Process Pipeline Failed: Not Enough Credit Balance To Process All Products

      Default value is ALGOREP_019.

      Producer Batch Pre Process Pipeline Failed: ProducerId Not Found

      Default value is ALGOREP_020.

      Producer Batch Pre Process Pipeline Failed: Unable To Insert Pipeline Information Into Database

      Default value is ALGOREP_021.

      Producer Batch Pre Process Pipeline Failed: Another Running Pipeline Already Exists For This Producer

      Default value is ALGOREP_022.

      Producer Batch Process Pipeline Failed: ProducerId Not Found

      Default value is ALGOREP_023.

      Producer Batch Process Pipeline Failed: ProductId Not Found

      Default value is ALGOREP_024.

      Producer Batch Process Pipeline Failed: EprCountryCode Not Found Or Empty

      Default value is ALGOREP_025.

      Producer Batch Process Pipeline Failed: DeclarationPeriodCode Not Found

      Default value is ALGOREP_026.

      Producer Batch Process Pipeline Failed: Too Many Records Consumed At Once

      Default value is ALGOREP_027.

      No Company Found With This NRN

      Default value is ALGOREP_028.

GET /producers/{ProducerNrn}/declarations/eco-contributions
curl \
 --request GET 'https://b6l4r8pq7c.execute-api.eu-west-3.amazonaws.com/producers/34368801600504/declarations/eco-contributions?EprCountryCode=FR&DeclarationPeriodCode=2023' \
 --header "Authorization: $API_KEY"
Response examples (200)
{
  "status": "OK",
  "count": 18,
  "data": [
    {
      "producerNrn": "98181160700010",
      "eprCountryCode": "FR",
      "declarationPeriodCode": "2025",
      "codePeriod": "SEP",
      "codeVendor": "AMAZ",
      "schemeCode": "BAT",
      "ecoOrganismName": "BATRIBOX",
      "scaleCode": "BP-BAT-LIT",
      "ecoProductReference": "B07R59DMQR",
      "quantity": 200,
      "itemWeight": "0.5",
      "price": 2.561,
      "priceUnit": "Poids (KG)",
      "ecoContribution": 512.2
    }
  ]
}
Response examples (400)
{
  "error": "Missing required parameters: producerNrn, eprCountryCode, declarationPeriodCode"
}
Response examples (500)
{
  "error": "ALGOREP_001"
}