Fetch Summary For Given Producer

GET /producers/{ProducerNrn}/summary

App api authorizer

Path parameters

ProducerNrn string Required

Producer Unique NRN

Query parameters

DeclarationPeriodCode string Required

2023, 2024, etc.
EprCountryCode string Required

FR, ES, etc.

Responses

200 application/json

Producer Summary
Hide response attributes Show response attributes object
- countTotalRegistrations number | null
  
  Number of registrations, with or without UINs
- countRegistrationWithUin number | null
  
  Number of registrations with UINs only
- countTotalProducts number | null
  
  Total number of products in the producer catalog
- totalQuantity number | null
  
  Total number of products quantities in the producer catalog
- totalEcoContributionAmount number | null
  
  Total amount of eco-contribution to date. Can be null or a validated amount.
- declarationDeadline string | null
  
  Deadline to do declaration
- declarationCompletedAt string | null
  
  Date at which declaration was completed. Null or undefined if not completed.
- registrations array[object]
  
  Hide registrations attributes Show registrations attributes object
  
  id string
  
  Database UUID of the Registration
  
  bubbleId string
  
  Bubble unique ID of the Registration. It can be null if the Registration was not created on Bubble at first.
  
  producerBubbleId string
  
  Bubble unique ID of the Producer. It can be null if the Producer was not created on Bubble at first.
  
  producerId string
  
  Database UUID of the Producer
  
  schemeProBubbleId string
  
  Bubble unique ID of the SchemePro. It can be null if the SchemePro was not created on Bubble at first.
  
  schemeProId string
  
  Database UUID of the SchemePro
  
  uin string
  
  Uin given by ADEME or equivalent
  
  proMemberId string
  
  External id given by pro
  
  status string
  
  schemeDepositAmount number
  
  isExternalRegistration boolean
  
  uinReceivedAt string
  
  registrationSentToProAt string
  
  createdAt string
  
  updatedAt string
  
  schemePro object
  
  Additional properties are allowed.
  
  Hide schemePro attributes Show schemePro attributes object
  
  id string
  
  Database UUID of the SchemePro
  
  bubbleId string
  
  Bubble unique ID of the SchemePro. It can be null if the SchemePro was not created on Bubble at first.
  
  ecoOrganismName string
  
  eprCountryCode string
  
  schemeCode string
  
  ademeSchemeCode string
  
  currencyDeposit string
  
  declarationFrequency string
  
  proAddress string
  
  proCity string
  
  proZipCode string
  
  proCountryBubbleId string
  
  proCountryId string
  
  proLogo string
  
  registrationDeposit number
  
  schemeNameEn string
  
  schemeNameFr string
  
  schemePartner boolean
  
  createdAt string
  
  updatedAt string
  
  countProductsScheme number | null
  
  Number of Products for this Scheme if any
  
  country object
  
  Additional properties are allowed.
  
  Hide country attributes Show country attributes object
  
  id string
  
  Database UUID of the Country
  
  bubbleId string
  
  Bubble unique ID of the Country. It can be null if the Country was not created on Bubble at first.
  
  codeIso2 string
  
  isVat boolean
  
  nameEN string
  
  nameFR string
  
  nameZH string
  
  eprActivated boolean
  
  createdAt string
  
  updatedAt string
  
  schemePros
  
  seller object
  
  Additional properties are allowed.
  
  Hide seller attributes Show seller attributes object
  
  id string
  
  Database UUID of the Seller
  
  bubbleId string
  
  Bubble unique ID of the Seller
  
  companyName string
  
  nrn string
  
  vat string
  
  companyAddress string
  
  companyLogo string
  
  superAdminEmail string
  
  superAdminMobilePhone string
  
  superAdminFirstName string
  
  superAdminLastName string
  
  registrationFeesId string
  
  declarationBasicFeesId string
  
  declarationPremiumFeesId string
  
  connectAlgorepId string
  
  commissionPercentage string
  
  createdAt string
  
  updatedAt string
  
  sellerStripeConfig object
  
  Additional properties are allowed.
  
  Hide sellerStripeConfig attributes Show sellerStripeConfig attributes object
  
  id string
  
  Database UUID of the SellerSchemeProStripeConfig
  
  sellerId string
  
  Database UUID of the Seller
  
  schemeProId string
  
  Database UUID of the SchemePro
  
  depositPriceId string
  
  ecoContributionPriceId string
  
  connectId string
  
  createdAt string
  
  updatedAt string
  
  countProductsScheme number | null
  
  Number of Products for this Registration/Scheme
  
  totalQuantityScheme number | null
  
  Quantity of products for this Registration/Scheme
  
  totalAmountScheme number | null
  
  Amount estimated or paid for this Registration/Scheme
  
  producerPaidAt string | null
  
  Date at which producer paid for this declaration
400 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:
  string-1 string string-2 string string-3 string string-4 string string-5 string string-6 string string-7 string string-8 string string-9 string string-10 string string-11 string string-12 string string-13 string string-14 string string-15 string string-16 string string-17 string string-18 string string-19 string string-20 string string-21 string string-22 string string-23 string string-24 string string-25 string string-26 string string-27 string string-28 string
  
  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.
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:
  string-1 string string-2 string string-3 string string-4 string string-5 string string-6 string string-7 string string-8 string string-9 string string-10 string string-11 string string-12 string string-13 string string-14 string string-15 string string-16 string string-17 string string-18 string string-19 string string-20 string string-21 string string-22 string string-23 string string-24 string string-25 string string-26 string string-27 string string-28 string
  
  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}/summary

curl \
 --request GET 'https://b6l4r8pq7c.execute-api.eu-west-3.amazonaws.com/producers/34368801600504/summary?DeclarationPeriodCode=2023&EprCountryCode=FR' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "countTotalRegistrations": 42,
  "countRegistrationWithUin": 4,
  "countTotalProducts": 5642,
  "totalQuantity": 898756,
  "totalEcoContributionAmount": 1222.54,
  "declarationDeadline": "2024-01-19T12:45:04.147Z",
  "declarationCompletedAt": "2024-01-19T12:45:04.147Z",
  "registrations": [
    {
      "id": "50658c1e-356e-4407-b120-d110552292d8",
      "bubbleId": "1708861331497x933611102973227500",
      "producerBubbleId": "1708861331497x933611102973227500",
      "producerId": "50658c1e-356e-4407-b120-d110552292d8",
      "schemeProBubbleId": "1708861331497x933611102973227500",
      "schemeProId": "50658c1e-356e-4407-b120-d110552292d8",
      "uin": "5raeztrytegrfezrgtrhytuy",
      "proMemberId": "AGJYRTYH987",
      "status": "4 - PendingPro",
      "schemeDepositAmount": 42,
      "isExternalRegistration": false,
      "uinReceivedAt": "2024-01-19T12:45:04.147Z",
      "registrationSentToProAt": "2024-01-19T12:45:04.147Z",
      "createdAt": "2024-01-19T12:45:04.147Z",
      "updatedAt": "2024-01-19T12:45:04.147Z",
      "schemePro": {
        "id": "50658c1e-356e-4407-b120-d110552292d8",
        "bubbleId": "1708861331497x933611102973227500",
        "ecoOrganismName": "LEKO",
        "eprCountryCode": "FR",
        "schemeCode": "EMPAP",
        "ademeSchemeCode": "PCHIM",
        "currencyDeposit": "€",
        "declarationFrequency": "Annuel",
        "proAddress": "14, Boulevard de la Chapelle",
        "proCity": "Paris",
        "proZipCode": "75018",
        "proCountryBubbleId": "1699973781289x474882884422860800",
        "proCountryId": "a3bf6503-426b-43da-a2ac-37f8d8305a78",
        "proLogo": "https://my-logo",
        "registrationDeposit": 77,
        "schemeNameEn": "Clothing textiles, household linens and shoes",
        "schemeNameFr": "Textiles d'habillement, Linge de maison et Chaussures",
        "schemePartner": true,
        "createdAt": "2024-01-19T12:45:04.147Z",
        "updatedAt": "2024-01-19T12:45:04.147Z",
        "countProductsScheme": 72,
        "country": {
          "id": "50658c1e-356e-4407-b120-d110552292d8",
          "bubbleId": "1708861331497x933611102973227500",
          "codeIso2": "FR",
          "isVat": true,
          "nameEN": "United-Kingdom",
          "nameFR": "Royaume-Uni",
          "nameZH": "英国",
          "eprActivated": true,
          "createdAt": "2024-01-19T12:45:04.147Z",
          "updatedAt": "2024-01-19T12:45:04.147Z"
        },
        "seller": {
          "id": "50658c1e-356e-4407-b120-d110552292d8",
          "bubbleId": "1708861331497x933611102973227500",
          "companyName": "Coca-Cola",
          "nrn": "45649879465",
          "vat": "FR95645645678",
          "companyAddress": "42 RUE VICTOR HUGO",
          "companyLogo": "https://my-url",
          "superAdminEmail": "super-admin@email.com",
          "superAdminMobilePhone": "0609921214",
          "superAdminFirstName": "Nicolas",
          "superAdminLastName": "Delalande",
          "registrationFeesId": "string",
          "declarationBasicFeesId": "string",
          "declarationPremiumFeesId": "string",
          "connectAlgorepId": "string",
          "commissionPercentage": "string",
          "createdAt": "2024-01-19T12:45:04.147Z",
          "updatedAt": "2024-01-19T12:45:04.147Z"
        },
        "sellerStripeConfig": {
          "id": "50658c1e-356e-4407-b120-d110552292d8",
          "sellerId": "50658c1e-356e-4407-b120-d110552292d8",
          "schemeProId": "50658c1e-356e-4407-b120-d110552292d8",
          "depositPriceId": "some-id",
          "ecoContributionPriceId": "some-id",
          "connectId": "some-id",
          "createdAt": "2024-01-19T12:45:04.147Z",
          "updatedAt": "2024-01-19T12:45:04.147Z"
        }
      },
      "countProductsScheme": 72,
      "totalQuantityScheme": 654,
      "totalAmountScheme": 72522.45,
      "producerPaidAt": "2024-01-19T12:45:04.147Z"
    }
  ]
}

Response examples (400)

{
  "error": "ALGOREP_001"
}

Response examples (500)

{
  "error": "ALGOREP_001"
}

Fetch Summary For Given Producer

Path parameters

Query parameters

Responses

error string

error string