Fetch List Of Purchasable UINs For This Producer And Country/Period

GET /producers/{ProducerNrn}/purchasable-uins

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

    SchemePros

    Hide response attributes Show response 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
    • 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
      • 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
  • 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:

      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:

      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}/purchasable-uins
curl \
 --request GET 'https://b6l4r8pq7c.execute-api.eu-west-3.amazonaws.com/producers/34368801600504/purchasable-uins?DeclarationPeriodCode=2023&EprCountryCode=FR' \
 --header "Authorization: $API_KEY"
Response examples (200)
{
  "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"
  }
}
Response examples (400)
{
  "error": "ALGOREP_001"
}
Response examples (500)
{
  "error": "ALGOREP_001"
}