Upstream of the payment processus, the eligibility allows to estimate the trust level attributed to a payment request by a customer.
This involves a statistical processing of data relating to the customer, his purchase history and the contents of his shoppingcart. Sending this information is essential for the calculation of the elligibility, because it allows to have a better knowledge of the customer and his purchase.
There are three types of data to be provided concerning the customer and the order:
- Mandatory data: without this data the request is not valid.
- Necessary data: without this data the information provided to FLOA is not sufficient to guarantee an optimal calculation of the customer's eligibility. The data are not mandatory as such but are highly necessary to be able to return a relevant decision concerning the customer and his purchase. The list of these data will be validated and detailed with FLOA, who will contact the merchant before activation.
You can find below examples of the data required for different sectors of activity - Optional Data: This data concerns any additional information that the merchant may provide about the customer or his shoppingcart that may be relevant to the calculation of customer eligibility.
The eligibility is possibly reassessed using information contained in the National File of Personal Credit Repayment Incidents (FICP).
The eligibility returns a token needed to proceed to the payment processus.
The API route to use is the following :
-
Integration : POST https://eligibility.integration-cb4x.fr/api/v1/eligibilities?merchantId={{MerchantId}}&merchantSiteIds={{MerchantSiteId}}
-
Production : POST https://eligibility.cb4x.fr/api/v1/eligibilities?merchantId={{MerchantId}}&merchantSiteIds={{MerchantSiteId}}
- {{MerchantId}} : your merchant identifier provided by Floa
- {{MerchantSiteId}} : your merchant site identifier provided by Floa (determines the number of installments, the capture method and if there are fees for the customer)
Headers of the request :
- Content-type : application/json
- authToken : the token retrieved via the call to the authentication service
Usefull Fields (see complete descritpion in the swagger )
| Field | Description | Type | Mandatory ? France | Spain | Italy | Portugal | Belgium |
|---|---|---|---|---|---|---|---|
| presaleFolder | It is a folder containing a list of shopping cart. This is useful for multi-shipping (not managed for now: provide only one shopping cart). | Object | Yes | Yes | Yes | Yes | Yes |
| additionalInformation | Object of set ok Key-Value pair. Used to send specific informations to Floa is Floa needs it. | Object | No | No | No | No | No |
- presaleFolder
| Field | Description | Type | Mandatory ? France | Spain | Italy | Portugal | Belgium |
|---|---|---|---|---|---|---|---|
| shoppingCarts | Details of the order and customer. Provide only one shopping cart. | Array of object | Yes | Yes | Yes | Yes | Yes |
| customer | Object to send customer informations. | Object | Yes | Yes | Yes | Yes | Yes |
| shippingAddress | Object to send shipping address informations (see the swagger for full definition). | Object | No | No | No | No | No |
| billingAddress | Object to send billing address informations (see the swagger for full definition). | Object | No | No | No | No | No |
| saleChannel | The sale channel. Desktop Tablet Ipad IPhone AndroidSmartPhone SmartPhone * AndroidTablet | string | Yes | Yes | Yes | Yes | Yes |
| reportDelayInDays | Only for pay later payment - The number of days the payment must be done. | int32 | No | No | No | No | No |
| feesAmount | Only for 10X payment - Fees amount in cents, this value will be displayed on the line Management fee on the payment page if sent. | int32 | No | No | No | No | No |
| discountAmount | Only for 10X payment - Discount amount in cents, this value will be displayed on the line Voucher / promo code on the payment page if sent. | int32 | No | No | No | No | No |
| shippingAmount | Only for payment in 10X - Shipping amount in cents, this value will be displayed on the line Delivery on the payment page if sent. | int32 | No | No | No | No | No |
| merchantSite | Only for payment in 10X - Object to declare URLs used on the cusotmer journey. | Object | No | No | No | No | No |
- shoppingCarts
| Field | Description | Type | Mandatory ? France | Spain | Italy | Portugal | Belgium |
|---|---|---|---|---|---|---|---|
| reference | The unique identifier of the order. | string(30) Do not use special characters. Only letters, numbers and _. | Yes | Yes | Yes | Yes | Yes |
| rawAmount | Amount of the order in cents. | int32 | Yes | Yes | Yes | Yes | Yes |
| productsCount | The number of products in the shopping cart. | int32 | Yes | Yes | Yes | Yes | Yes |
| products | Details of the products in the shopping cart. Send at least one prouct. | array of objects | Yes | Yes | Yes | Yes | Yes |
- products
| Field | Description | Type | Mandatory ? France | Spain | Italy | Portugal | Belgium |
|---|---|---|---|---|---|---|---|
| name | The name of the product. Must be "Travel" for a travel context. Must be "Stay" for a stay context. | string | No | No | No | No | No |
| rawAmount | Amount of the product in cents | int32 | Yes | Yes | Yes | Yes | Yes |
| categories | Categories of the product. Parent category must be declared before its child. See example of a json content for a French order below. See the swagger for full description. | array of objects | Necessary | Necessary | Necessary | Necessary | Necessary |
| properties | Properties of the product. See the swagger for full description. | array of objects | No | No | No | No | No |
| shipping | Shipping informations of the product. | object | Yes | Yes | Yes | Yes | Yes |
- shipping
| Field | Description | Type | Mandatory ? France | Spain | Italy | Portugal | Belgium |
|---|---|---|---|---|---|---|---|
| method | Shipping method. CDS - Colissimo direct. CHR - Chronopost. COL - Colissimo. CRE - Chronopost/Chronorelais. KIA - Kiala. IMP - Printed and sent to home. LSP - Delivery service plus. MOR - Mory. RCD - Cdiscount relay. TNT - TNT. TRP - Transporter. AE1 - Easydis error. EA1 - Easydis. KIB - KIB. TNB - TNT Belgium. EXP - Express delivery. AGE - Agediss. EMP - Carried away. M30 - Carried away -30. ADX - Adrexo. EY1 - Carried away -30 Easydis. VIR - Virtuel. REG - Recommandé. STD - Normal. TRK - Followed. PRM - Premium Easydis. RDO - Confort (SOGEP) Easydis. RCO - Package relay (SOGEP) Cestas. SO1 - SoColissimo overseas zone 1. SO2 - SoColissimo overseas zone 2. RIM - Immediate pick up in store. LDR - LDR. MAG - Store delivery. RDE - Eco (SOGEP) Easydis. REL - Mondial Relay. FDR - Direct relay supplier. TNX - TNT express relay. EMX - Express. CHX - Carried away Chronopost relay. CSX - Carried away Chronopost deposit. LDS - Standard home delivery. LDE - Express home delivery. LCS - Standard center delivery. LCE - Express center delivery. GLS - GLS. STU - Stuart. UPS - UPS. LCK - Lockers. DRO - Drone delivery. OT1 - Other shipping method #1. OT2 - Other shipping method #2. OT3 - Other shipping method #3. | string | Yes | Yes | Yes | Yes | Yes |
| delayInDays | The shipping delay in days (in 2 days, in 14 days, etc.). | double | No | No | No | No | No |
| address | Shipping address. The the swagger for full definition. | object | No | No | No | No | No |
- customer
| Field | Description | Type | Mandatory ? France | Spain | Italy | Portugal | Belgium |
|---|---|---|---|---|---|---|---|
| civility | The civility. Mr (Mister) Mrs (Married woman) Ms (Woman) | string | Yes | Yes | Yes | Yes | Yes |
| lastName | The last name. | string | Yes | Yes | Yes | Yes | Yes |
| firstName | The first name. | string | Yes | Yes | Yes | Yes | Yes |
| birthName | The birth name. | string | Yes | Yes | Yes | Yes | Yes |
| secondLastName | Only for Spanish orders - The second last name. | string | NA | No | NA | NA | NA |
| birthDate | The birth date. Format "yyyy-MM-ddThh:mm:ss.SSSZ". | date-time | Yes | Yes | Yes | Yes | Yes |
| birthZipCode | The birth zip code. Must contain 2, 3 or 5 caracters. Must be "99" if not in France. Must be "972" for Martinique. Must be "06000" for Nice and not "6000". Always "99" for Portuguese order. | string | Yes | Yes | Yes | Yes | Yes |
| homePhoneNumber | The customer's home phone number. For Spanish and Portuguese orders, only numbers with 9 characters are accepted. For Italian orders, only numbers with 6 characters are accepted. | string (13) | Yes if the cellPhoneNumber is not specified. | Yes if the cellPhoneNumber is not specified. | Yes if the cellPhoneNumber is not specified. | Yes if the cellPhoneNumber is not specified. | Yes if the cellPhoneNumber is not specified. |
| cellPhoneNumber | The customer's cell phone number. For Spanish, Portuguese and Italian orders, only numbers with 9 characters are accepted. | string (13) | Yes if the homePhoneNumber is not specified. | Yes if the homePhoneNumber is not specified. | Yes if the homePhoneNumber is not specified. | Yes if the homePhoneNumber is not specified. | Yes if the homePhoneNumber is not specified. |
| reference | The unique identifier of the customer. | string (30) | Yes | Yes | Yes | Yes | Yes |
| The email address. | string (60) | Yes | Yes | Yes | Yes | YesYes | |
| homeAddress | Address of the customer | object | Yes | Yes | Yes | Yes | |
| history | The history of the customer on the merchant site. See the swagger for full definition. | object | No | No | No | No | No |
| aggregate | The customer aggregated data on the merchant site. See the swagger for full definition. | object | No | No | No | No | No |
| nationality | The nationality codes. Local - Local. EU - European union. OutsideEU - Outside European union. | string | No | No | No | No | No |
| trustLevel | Represents the trust level of a customer. Standard - Standard customer. No level defined yet. BlackListed - Black listed. * Trusted - Trusted. WhiteListed - White listed. | string | No | No | No | No | No |
| ipAddress | The IP address. | string (15) | No | No | No | No | No |
| nationalId | Only for Spanish, Italian and Portuguese order - The national identifier. This is a unique identifier of the customer on national level. | string | NA | Yes | Yes | Yes | NA |
- customer.history
| Field | Description | Type | Mandatory ? France | Spain | Italy | Portugal | Belgium |
|---|---|---|---|---|---|---|---|
| firstOrderDate | Date of the first order of the customer | date-time | Necessary | Necessary | Necessary | Necessary | Necessary |
| lastOrderDate | Date of the first order of the customer | date-time | Necessary | Necessary | Necessary | Necessary | Necessary |
- homeAddress
| Field | Description | Type | Mandatory ? France | Spain | Italy | Portugal | Belgium |
|---|---|---|---|---|---|---|---|
| line1 | The main address. | string (32) | Yes | Yes | Yes | Yes | Yes |
| line2 | Additional address 1 (building, apartment, door code). | string (32) | No | No | No | No | No |
| line3 | Additional address 2 (locality). | string (32) | No | No | No | No | No |
| line4 | Additional address 3 (use as little as possible). | string (32) | No | No | No | No | No |
| zipCode | The zip code. For Belgian orders, 4 characters. xxxx-xxx for Portuguese orders. | string (5) | Yes | Yes | Yes | Yes | Yes |
| city | The zip code. | string (50) | Yes | Yes | Yes | Yes | Yes |
| countryCode | The accepted country code. Must follow the ISO 3166-2 standards. | string | Yes | Yes | Yes | Yes | Yes |
- merchantSite
| Field | Description | Type | Mandatory ? France | Spain | Italy | Portugal | Belgium |
|---|---|---|---|---|---|---|---|
| backUrl | Only for payment in 10X - Link to the previous page. Will be the link behind BACK TO THE BASKET and Change payment method on the payment page. | uri | Yes for 10X payment | NA | NA | NA | NA |
| returnUrl | Only for payment in 10X - Url where we will redirect the customer after payment and POST payment result, see Payment Notification page. | uri | Yes for 10X payment | NA | NA | NA | NA |
| notificationUrl | Only for payment in 10X - Url where we will POST payment result, see Payment Notification page. | uri | Yes for 10X payment | NA | NA | NA | NA |
Example of a json content for a French order
{
"presaleFolder": {
"shoppingCarts": [
{
"reference": "REF0001",
"rawAmount": 50000,
"productsCount": 1,
"products": [
{
"rawAmount": 50000,
"categories": [
{
"name": "Travel",
"parent": ""
},
{
"name": "vol",
"parent": "Travel"
}
],
"shipping": {
"method": "UPS"
}
}
]
}
],
"customer": {
"reference": "00123456789",
"firstName": "Will",
"lastName": "Thompson",
"email": "[email protected]",
"birthDate": "1986-07-16T00:00:00.0000000+00:00",
"birthZipCode": "75",
"civility": "Mr",
"cellPhoneNumber": "0612345678",
"homeAddress": {
"line1": "8 Quai de Bacalan",
"zipCode": "33000",
"city": "Bordeaux",
"countryCode": "FR"
},
"history": {
"firstOrderDate": "2022-01-16T00:00:00.0000000+00:00",
"lastOrderDate": "2023-03-01T00:00:00.0000000+00:00"
}
},
"saleChannel": "Desktop"
}
}
Example of a json content for a Spanish order
{
"presaleFolder": {
"shoppingCarts": [
{
"reference": "REF0001",
"rawAmount": 50000,
"productsCount": 1,
"products": [
{
"rawAmount": 50000,
"shipping": {
"method": "UPS"
}
}
]
}
],
"customer": {
"reference": "00123456789",
"firstName": "Will",
"lastName": "Thompson",
"secondLastName" : "Garcia",
"email": "[email protected]",
"birthDate": "1986-07-16T00:00:00.0000000+00:00",
"birthZipCode": "99",
"civility": "Mr",
"cellPhoneNumber": "123456789",
"nationalId": "40919740A",
"homeAddress": {
"line1": "C. Bartolomé Ordóñez",
"zipCode": "09006",
"city": "Burgos",
"countryCode": "ES"
}
"history": {
"firstOrderDate": "2022-01-16T00:00:00.0000000+00:00",
"lastOrderDate": "2023-03-01T00:00:00.0000000+00:00"
}
},
"saleChannel": "Desktop"
}
}
Example of a json content for an Italian order
{
"presaleFolder": {
"shoppingCarts": [
{
"reference": "REF0001",
"rawAmount": 50000,
"productsCount": 1,
"products": [
{
"rawAmount": 50000,
"shipping": {
"method": "UPS"
}
}
]
}
],
"customer": {
"reference": "00123456789",
"firstName": "Will",
"lastName": "Rossi",
"email": "[email protected]",
"birthDate": "1986-07-16T00:00:00.0000000+00:00",
"birthZipCode": "99",
"civility": "Mr",
"cellPhoneNumber": "123456789",
"nationalId": "RSSMRA74D22A001Q",
"homeAddress": {
"line1": "Viale Donato Bramante",
"zipCode": "05100",
"city": "Terni TR",
"countryCode": "IT"
}
"history": {
"firstOrderDate": "2022-01-16T00:00:00.0000000+00:00",
"lastOrderDate": "2023-03-01T00:00:00.0000000+00:00"
}
},
"saleChannel": "Desktop"
}
}
Example of a json content for a Portuguese order
{
"presaleFolder": {
"shoppingCarts": [
{
"reference": "REF0001",
"rawAmount": 50000,
"productsCount": 1,
"products": [
{
"rawAmount": 50000,
"shipping": {
"method": "UPS"
}
}
]
}
],
"customer": {
"reference": "00123456789",
"firstName": "Will",
"lastName": "Santos",
"email": "[email protected]",
"birthDate": "1986-07-16T00:00:00.0000000+00:00",
"birthZipCode": "99",
"civility": "Mr",
"cellPhoneNumber": "123456789",
"nationalId": "999999999",
"homeAddress": {
"line1": "Avenida 5 de Outubro 197",
"zipCode": "1050-054",
"city": "Lisboa",
"countryCode": "PT"
}
"history": {
"firstOrderDate": "2022-01-16T00:00:00.0000000+00:00",
"lastOrderDate": "2023-03-01T00:00:00.0000000+00:00"
}
},
"saleChannel": "Desktop"
}
}
Example of a json content for a Belgian order
{
"presaleFolder": {
"shoppingCarts": [
{
"reference": "REF0001",
"rawAmount": 50000,
"productsCount": 1,
"products": [
{
"rawAmount": 50000,
"shipping": {
"method": "UPS"
}
}
]
}
],
"customer": {
"reference": "00123456789",
"firstName": "Will",
"lastName": "Janssens",
"email": "[email protected]",
"birthDate": "1986-07-16T00:00:00.0000000+00:00",
"birthZipCode": "99",
"civility": "Mr",
"cellPhoneNumber": "123456789",
"homeAddress": {
"line1": "Rue Brederode 16",
"zipCode": "1000",
"city": "Bruxelles",
"countryCode": "BE"
}
"history": {
"firstOrderDate": "2022-01-16T00:00:00.0000000+00:00",
"lastOrderDate": "2023-03-01T00:00:00.0000000+00:00"
}
},
"saleChannel": "Desktop"
}
}
Example of a OK response
{
"eligibilities": [
{
"token": "423715b6-5f65-4cfe-b12e-9cfa779ade2b",
"hasAgreement": true,
"totalAmount": 38232,
"requestId": 694035,
"paymentOptionReference": "63",
"purchaseType": "Cb4X",
"merchantSiteId": 7017,
"links": [
{
"href": "https://paymentgateway.integration-cb4x.fr/v1/payment-sessions",
"rel": "create-payment-session",
"method": "POST"
},
{
"href": "https://paymentgateway.integration-cb4x.fr/v1/payments/card-payment",
"rel": "pay-without-3d",
"method": "POST"
},
{
"href": "https://paymentgateway.integration-cb4x.fr/v1/payments/card3ds-payment",
"rel": "check-3d-enrollment",
"method": "POST"
},
{
"href": "https://eligibility.integration-cb4x.fr/api/v1/eligibility-installment-plans?merchantId=38&merchantSiteId=7017&requestId=694035",
"rel": "get-eligibility-installment-plan",
"method": "GET"
}
]
}
]
}
Response example of a non eligible customer
{
"eligibilities": [
{
"hasAgreement": false,
"totalAmount": 33129,
"requestId": 694038,
"purchaseType": "Cb4X",
"merchantSiteId": 71819
}
]
}
Example of a KO response
{
"eligibilities": [
{
"requestId": 694035,
"purchaseType": "Undefined",
"merchantSiteId": 7017,
"errors": [
"Zip code is mandatory. Length of characters accepted for country code FR: 5."
]
}
]
}
Response description
| Field | Descirption |
|---|---|
| eligibilities.hasAgreement | The customer is eligible is true, non-eligible is false Values : true false |
| eligibilities.token | Sent if the cutomer is eligible. This token has to be sent to the payment session call. |
| eligibilities.totalAmount | Amount to use in the payment session call (this amount is tour order amount + floa fees). |
| eligibilities.requestId | Floa id for the request, can be used if you want to contact our technical support. |
| eligibilities.paymentOptionReference | Value of the paymentOptionRefence to send to the payment session service. |
| eligibilities.purchaseType | Code for the payment method * Cb4X : 4 installments |
| eligibilities.merchantSiteId | Value of the merchantSiteId used for the call. |
| eligibilities.links | Links to guide you for the nexts steps. |
| eligibilities.errors | Message if there is an error in the request. The message tells you where the error is. If the message is not clear, you can contact our support and provide the value of eligibilities.requestId |
Requierements for specific activity sectors
Travel / Stay
Additionnal datas asked :
| Field | Description | Type |
|---|---|---|
| presaleFolder.shoppingCarts.products.name | For Travel and Stay. Need to create a product named "Travel" to use the Travel context properties. If necessary, create a second product named "Stay" to use the Stay context properties. | String |
| presaleFolder.shoppingCarts.products.categories.name | Product's category. Use one of the following items : AIRLINE TICKET TRAIN TICKET BUS TICKET HOTEL CAMPING STAY CRUISE CAR RENTAL * OTHER | String |
| presaleFolder.shoppingCarts.products.properties.name/value | For Travel : Name : Insurance Value : Insurance's name/code choosen by the customer. Or boolean yes/no the customer chooses an insurance Name : Type Value : "Unknown", "OneWay", "TwoWay", "Multiple" Name : DepartureDate Value : format YYYY-MM-DD Name : ReturnDate Value : format YYYY-MM-DD (default to 1970-01-01 in case of "OneWay") Name : DestinationCountryCode Value : Destination country code, format ISO 3166-2 (ex : "FR" for France) Name : TravelersCount Value : number of passengers Name : OwnTicket Value : boolean : does the payment card holder is part of the trip Name : MainDepartureCompany Value : Airline name of the first flight (IATA code) in case of travel with flight, empty otherway Name : DepartureAirport Value : IATA code of the airport/train or bus station if travel with transportation. Empty otherway Name : DestinationAirport Value : IATA code of the airport/train or bus station if travel with transportation. Else IATA code of the stay city For Stay : Name : RoomRange Value : Accommodation range if travel with stay. Empty otherway | Object of set ok Name-Value pair |
Example :
{
"presaleFolder": {
"shoppingCarts": [
{
"reference": "1679927342",
"rawAmount": 83786,
"productsCount": 1,
"products": [
{
"name": "Travel",
"raw_amount": 83786,
"categories": [
{
"name": "AIRLINE TICKET"
}
],
"properties": [
{
"name": "Insurance",
"value": false
},
{
"name": "Type",
"value": "OneWay"
},
{
"name": "DepartureDate",
"value": "2023-11-01"
},
{
"name": "ReturnDate",
"value": "1970-01-01"
},
{
"name": "DestinationCountryCode",
"value": "AN"
},
{
"name": "TravelersCount",
"value": "2"
},
{
"name": "OwnTicket",
"value": true
},
{
"name": "MainDepartureCompany",
"value": "Air France"
},
{
"name": "DepartureAirport",
"value": "CDG"
},
{
"name": "DestinationAirport",
"value": "AAM"
}
],
"shipping": {
"method": "VIR"
}
},
{
"name": "Stay",
"raw_amount": 83786,
"categories": [
{
"name": "HOTEL"
}
],
"properties": [
{
"name": "RoomRange",
"value": "2 stars"
}
],
"shipping": {
"method": "VIR"
}
}
]
}
],
"customer": {
"reference": "60128411000001321",
"firstName": "Prenom",
"lastName": "Nom",
"email": "[email protected]",
"birthDate": "1986-07-16T00:00:00.0000000+00:00",
"birthZipCode": "75",
"civility": "Mr",
"cellPhoneNumber": "9234567890",
"homeAddress": {
"line1": "8 Quai de Bacalan",
"zipCode": "33000",
"city": "Bordeaux",
"countryCode": "FR"
},
"history": {
"firstOrderDate": "2022-01-16T00:00:00.0000000+00:00",
"lastOrderDate": "2023-03-01T00:00:00.0000000+00:00"
}
},
"saleChannel": "Desktop"
}
}
Vehicle / Garage
Additionnal datas asked :
| Field | Description | Type |
|---|---|---|
| presaleFolder.shoppingCarts.products.categories.name | Product's categories. Depending on the available granularity, but at least the main category. If possible, add a sub-category | String |
| additionalInformation.key/value | Key : Text1 Value : Date of first registration of the vehicle Key : Text2 Value : Vehicle type (private vehicle, 2 wheels, caravan...) Key : Text3 Value : Vehicle's brand Key : Numeric1 Value : Fiscal power of the vehicle (if available) Key : Numeric2 Value : Flag customer type. 0 : New customer. 1 : Known customer Key : Numeric3 Value : Postal code of the vehicle | Object of set ok Key-Value pair If key is Text, then String If key is Numeric, then integer |
Example :
{
"additionalInformation": [
{
"key": "Text1",
"value": "2022-08-11"
},
{
"key": "Text2",
"value": "private vehicle"
},
{
"key": "Text3",
"value": "Mercedes"
},
{
"key": "Numeric1",
"value": "8"
},
{
"key": "Numeric2",
"value": "1"
},
{
"key": "Numeric3",
"value": "33000"
}
],
"presaleFolder": {
"shoppingCarts": [
{
"reference": "1679927342",
"rawAmount": 83786,
"productsCount": 1,
"products": [
{
"raw_amount": 83786,
"categories": [
{
"name": "CAR"
}
],
"shipping": {
"method": "VIR"
}
}
]
}
],
"customer": {
"reference": "60128411000001321",
"firstName": "Prenom",
"lastName": "Nom",
"email": "[email protected]",
"birthDate": "1986-07-16T00:00:00.0000000+00:00",
"birthZipCode": "75",
"civility": "Mr",
"cellPhoneNumber": "9234567890",
"homeAddress": {
"line1": "8 Quai de Bacalan",
"zipCode": "33000",
"city": "Bordeaux",
"countryCode": "FR"
}
},
"saleChannel": "Desktop"
}
}
Training courses
Additionnal datas asked :
| Field | Description | Type |
|---|---|---|
| presaleFolder.shoppingCarts.products.categories.name | course details: sector/subject (Art, Math, Computer science, marketing…) level/degree wording/name | String |
| additionalInformation.key/value | Key : Text2 Value : start date of the course (YYYY-MM-DD) Key : Text3 Value : end date of the course (YYYY-MM-DD) Key : Numeric1 Value : Flag if course is partially/totally funded by a third party organization (ex : CPF in France) : 0 : no 1 : yes Key : Numeric2 Value : Flag if course leads to a diploma : 0 : no 1 : yes Key : Numeric3 Value : Flag if course is a post-high school degree (post-bac in France) 0 : no 1 : yes | Object of set ok Key-Value pair If key is Text, then String If key is Numeric, then integer |
Example :
{
"additionalInformation": [
{
"key": "Text2",
"value": "2023-06-01"
},
{
"key": "Text3",
"value": "2023-06-05"
},
{
"key": "Numeric1",
"value": "1"
},
{
"key": "Numeric2",
"value": "0"
},
{
"key": "Numeric3",
"value": "0"
}
],
"presaleFolder": {
"shoppingCarts": [
{
"reference": "1679930534",
"rawAmount": 13181,
"productsCount": 1,
"products": [
{
"raw_amount": 13181,
"categories": [
{
"name": "Computer science"
},
{
"name": "Bachelor"
},
{
"name": "Bachelor in Comp. Science & AI"
}
],
"shipping": {
"method": "VIR"
}
}
]
}
],
"customer": {
"reference": "60128411000001321",
"firstName": "Prenom",
"lastName": "Nom",
"email": "[email protected]",
"birthDate": "1986-07-16T00:00:00.0000000+00:00",
"birthZipCode": "75",
"civility": "Mr",
"cellPhoneNumber": "9234567890",
"homeAddress": {
"line1": "8 Quai de Bacalan",
"zipCode": "33000",
"city": "Bordeaux",
"countryCode": "FR"
}
},
"saleChannel": "Desktop"
}
}
Second Hand
Additionnal datas asked :
| Field | Description | Type |
|---|---|---|
| presaleFolder.shoppingCarts.products.categories.name | product's categories. Depending on the available granularity, but at least the main category. If possible, add a sub-category | String |
| additionalInformation.key/value | Key : Text1 Value : Brand of the most expensive product Key : Text2 Value : Most expensive product model Key : Text3 Value : Version/year of the most expensive product Key : Text4 Value : Reconditioning status Key : Numeric1 Value : Flag customer type 0 : New customer 1 : Known customer Key : Numeric2 Value : Number of smartphones in the basket Key : Numeric3 Value : Guarantee Indicator/Additional Insurance | Object of set ok Key-Value pair If key is Text, then String If key is Numeric, then integer |
Example :
{
"additionalInformation": [
{
"key": "Text1",
"value": "Dior"
},
{
"key": "Text2",
"value": "Dress of the year"
},
{
"key": "Text3",
"value": "2023-01-01"
},
{
"key": "Text4",
"value": "SILVER"
},
{
"key": "Numeric1",
"value": "1"
},
{
"key": "Numeric2",
"value": "0"
},
{
"key": "Numeric3",
"value": "1"
}
],
"presaleFolder": {
"shoppingCarts": [
{
"reference": "1679932574",
"rawAmount": 53673,
"productsCount": 1,
"products": [
{
"raw_amount": 53673,
"categories": [
{
"name": "WOMAN"
},
{
"name": "DRESS",
"parent": "WOMAN"
}
],
"shipping": {
"method": "VIR"
}
}
]
}
],
"customer": {
"reference": "60128411000001321",
"firstName": "Prenom",
"lastName": "Nom",
"email": "[email protected]",
"birthDate": "1986-07-16T00:00:00.0000000+00:00",
"birthZipCode": "75",
"civility": "Mr",
"cellPhoneNumber": "9234567890",
"homeAddress": {
"line1": "8 Quai de Bacalan",
"zipCode": "33000",
"city": "Bordeaux",
"countryCode": "FR"
}
},
"saleChannel": "Desktop"
}
}
Telephony
Additionnal datas asked :
| Field | Description | Type |
|---|---|---|
| presaleFolder.shoppingCarts.products.categories.name | product's categories. Depending on the available granularity, but at least the main category. If possible, add a sub-category and the brand name. | String |
| additionalInformation.key/value | Key : Text2 Value : Purchase Type. Default to "BARE_PHONE" for purchase of a cell phone. Default to "PACKAGE_PHONE" for purchase of a cell phone with phone plan. Key : Text3 Value : Type of phone package. Only for purchase of a cell phone with phone plan. Key : Text4 Value : Phone brand Key : Text5 Value : Phone number of the subscrided line. Only if purchase without portability, empty otherway. Key : Text6 Value : Current phone provider. Only if purchase with portability, empty otherway. Key : Numeric1 Value : Phone number portability flag 0 : without portability 1 : with portability Key : Numeric2 Value : Flag if insurance have been subscrided 0 : without insurance 1 : with insurance Key : Numeric3 Value : Flag if aditionals options have been subscribed 0 : without options 1 : with options Key : Numeric4 Value : Advance on telephony consumption (in euros). Only for purchase of a cell phone with phone plan. | Object of set ok Key-Value pair If key is Text, then String If key is Numeric, then integer |
Example :
{
"additionalInformation": [
{
"key": "Text2",
"value": "BARE_PHONE"
},
{
"key": "Text4",
"value": "SAMSUNG"
},
{
"key": "Text5",
"value": ""
},
{
"key": "Text6",
"value": ""
},
{
"key": "Numeric1",
"value": "1"
},
{
"key": "Numeric2",
"value": "1"
},
{
"key": "Numeric3",
"value": "0"
}
],
"presaleFolder": {
"shoppingCarts": [
{
"reference": "1679933421",
"rawAmount": 30235,
"productsCount": 1,
"products": [
{
"raw_amount": 30235,
"categories": [
{
"name": "SMARTPHONE"
},
{
"name": "SAMSUNG",
"parent": "SMARTPHONE"
}
],
"shipping": {
"method": "VIR"
}
}
]
}
],
"customer": {
"reference": "60128411000001321",
"firstName": "Prenom",
"lastName": "Nom",
"email": "[email protected]",
"birthDate": "1986-07-16T00:00:00.0000000+00:00",
"birthZipCode": "75",
"civility": "Mr",
"cellPhoneNumber": "9234567890",
"homeAddress": {
"line1": "8 Quai de Bacalan",
"zipCode": "33000",
"city": "Bordeaux",
"countryCode": "FR"
}
},
"saleChannel": "Desktop"
}
}