Upsert Origin

POST /users/{UserBubbleId}/origins/{OriginCode}
App api authorizer

Path parameters

  • UserBubbleId string Required

    User Unique Bubble ID

  • OriginCode string Required

    Origin Unique Code

application/json

Body Required

Origin to upsert into database. 'id' should NOT be in the payload. If the given 'nrn' already exists, the Origin will be updated. If a field is not present in the payload, it won't be updated. If you want to erase a field, you have to send a nullish value.

  • bubbleId string

    Bubble unique ID of the Origin. It can be null if the Origin was not created on Bubble at first.

  • sellerBubbleId string

    Bubble unique ID of the Seller. It can be null if the Seller was not created on Bubble at first.

  • sellerId string
  • type string
  • code string
  • companyName string
  • companyAddress string
  • companyAddressComplement string
  • companyCity string
  • companyZipCode string
  • companyCountry string
  • companyCountryId string

    Database UUID of the country

  • brandName string
  • welcomeEN string
  • welcomeFR string
  • referralFeesPercentage number
  • creditsDiscountedPrice number
  • contact string
  • createdAt string
  • updatedAt string

Responses

  • 200 application/json

    Origins

    Hide response attributes Show response 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
  • 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.
POST /users/{UserBubbleId}/origins/{OriginCode} 
curl \
 --request POST 'https://b6l4r8pq7c.execute-api.eu-west-3.amazonaws.com/users/1708861331497x933611102973227500/origins/FDE789' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"bubbleId":"1708861331497x933611102973227500","sellerBubbleId":"1708861331497x933611102973227500","sellerId":"50658c1e-356e-4407-b120-d110552292d8","type":"Distributor","code":"C24O22M24","logo":"https://url-to-logo","companyName":"Coca-Cola","companyAddress":"54 RUE Voltaire","companyAddressComplement":"Bat A, Appt 124","companyCity":"Montpellier","companyZipCode":"34000","companyCountry":"France","companyCountryId":"50658c1e-356e-4407-b120-d110552292d8","brandName":"Coca-Cola Zero","welcomeEN":"Welcome To Coca Cola","welcomeFR":"Welcome To Coca Cola","referralFeesPercentage":20,"creditsDiscountedPrice":1.56,"contact":"https://my-contract.com","createdAt":"2024-01-19T12:45:04.147Z","updatedAt":"2024-01-19T12:45:04.147Z"}'
Request examples 
{
  "bubbleId": "1708861331497x933611102973227500",
  "sellerBubbleId": "1708861331497x933611102973227500",
  "sellerId": "50658c1e-356e-4407-b120-d110552292d8",
  "type": "Distributor",
  "code": "C24O22M24",
  "logo": "https://url-to-logo",
  "companyName": "Coca-Cola",
  "companyAddress": "54 RUE Voltaire",
  "companyAddressComplement": "Bat A, Appt 124",
  "companyCity": "Montpellier",
  "companyZipCode": "34000",
  "companyCountry": "France",
  "companyCountryId": "50658c1e-356e-4407-b120-d110552292d8",
  "brandName": "Coca-Cola Zero",
  "welcomeEN": "Welcome To Coca Cola",
  "welcomeFR": "Welcome To Coca Cola",
  "referralFeesPercentage": 20,
  "creditsDiscountedPrice": 1.56,
  "contact": "https://my-contract.com",
  "createdAt": "2024-01-19T12:45:04.147Z",
  "updatedAt": "2024-01-19T12:45:04.147Z"
}
Response examples (200) 
{
  "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"
}
Response examples (400) 
{
  "error": "ALGOREP_001"
}
Response examples (500) 
{
  "error": "ALGOREP_001"
}