This document describes a set of API that are public
Q: How to construct the full url from the endpoint ?
Q: How authentication is done generally ?
'Authorization': "Bearer (your token)"
Q: How to do an import ?
'x-amz-meta-import-origin': '(the choosen type MANUAL or BATCH)' 'x-amz-meta-name': '(the file name)' 'Content-Disposition': 'attachment; filename=(the file name)' 'Content-Type': 'text/csv'
Login API Reference
login to the application to get a token
Media type: application/json
Type: object
Properties
Example:
{
"email": "profile.test@gmail.com",
"password": "password",
"domain": "mybrand"
}
Media type: application/json
Type: string
Example:
toKenExaMpLEV1QiLCJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0..5nSmKnIc25de2uPrAkIT1w.qPtQPUb0ImquWxfrUyhx1NmfR6p8Md5Zv22pRDsFTYembnMhABtyO3ocx9CtQkxuoATQG41SO7SPJFojLNBzn_IRMzwNhCJcjKXL-YHz1iLY1GbIBEcKqXxJD6w9Q_5eu1wHQaBcrCPc3G6uF9XW7OlSgM2y8LoWdcstuxF2TBmQjFg2klE_q_EptbpnSKeE7JiqKJ2Plt_8y4PUbCqBMJ7CMFnMDSHMhK4wnr0dNsvSI19GtxgtQBPDZR444xXbe8ZqnnBkoGVM927MWSBVHxJvqt3b-vHv5c6FyuYM_WzNbu9Yhh2UZZQPJz_sxiAVoVQBSv_mthpmCYc-7CyGRajDaw60UtjC7iv7a2fw418K6N_eRzPs7Cb06aI3TFRU.RCbHoGVhi2mJYOylGM8O2A
Get current cart API Reference.
Gets the current cart of the connected user.
Media type: application/json
Type: object
Properties
Items: PublicCartLineResponseDTO
Items: items
Items: Warehouse
Example:
{
"price": {
"value": 30.8,
"currency": "EUR"
},
"returnablePrice": {
"value": 2.8,
"currency": "EUR"
},
"vatPrice": {
"value": 6.78,
"currency": "EUR"
},
"priceWithVat": {
"value": 37.58,
"currency": "EUR"
},
"cartLines": [
{
"part": {
"identifier": {
"kromeda": {
"partNumber": "16783",
"manufacturerId": "059",
"manufacturerLabel": "FEBI",
"origin": "IAM"
},
"tecdoc": {
"partNumber": "16783",
"manufacturerId": "0101",
"origin": "IAM"
},
"external": {
"partNumber": "Kit plaquettes avant"
}
},
"description": "Kit de plaquettes de frein, frein à disque"
},
"seller": {
"id": "5a058cb51eb961be11479e90",
"name": "Distributor Rocco No4 NomEtab",
"companyName": "Rocco Distribuzione4 RaisonSocEtab",
"vatIdentifier": "IT0000000054"
},
"pricing": {
"netPrice": 28,
"publicPrice": 28,
"currency": "EUR",
"vat": 0.22,
"corePrice": 2.8,
"promotion": {},
"fees": []
},
"availabilities": {
"primaryWarehouseId": "398401",
"warehouses": [
{
"externalId": "398401",
"externalName": "Warehouse Rocco No4 NomEntrepôt",
"availableQuantity": 10,
"dispatchQuantity": 1,
"delivery": {},
"hideStock": false,
"isPrimary": true
}
]
},
"urgent": true
}
]
}
Prices and Availabilities API Reference.
Get all prices and availabilities for the given list of parts. A token shoud be passed in the header of the request.
Media type: application/json
Type: array of part
Items: part
Example:
[
{
"part": {
"identifier": {
"tecdoc": {
"partNumber": "1234",
"manufacturerId": "0013",
"origin": "IAM"
},
"external": {
"partNumber": "1234WALKER"
}
}
}
}
]
Media type: application/json
Type: array of PriceAndAvailability
Items: PriceAndAvailability
Items: PriceAndAvailability
Items: items
Items: Warehouse
Example:
[
{
"part": {
"identifier": {
"tecdoc": {
"partNumber": "1234",
"manufacturerId": "0013",
"origin": "IAM"
},
"external": {
"partNumber": "1234WALKER"
}
}
},
"priceandavailabilities": [
{
"seller": {
"id": "58999f9373baed08e3bd10d0",
"name": "PiVi Ricambi S.r.l",
"companyName": "PiVi Ricambi S.r.l",
"vatIdentifier": "IT09568040969",
"establishmentNumber": "ESTITA18.000f97"
},
"pricing": {
"netPrice": 204.25,
"publicPrice": 215,
"currency": "EUR",
"vat": 45,
"corePrice": 120,
"promotion": {
"externalId": "Promo2018"
},
"fees": [
{
"label": "ecotaxe",
"price": 2.94
}
]
},
"availabilities": {
"primaryWarehouseId": "68",
"warehouses": [
{
"externalId": "68",
"externalName": "Milano",
"isPrimary": true,
"availableQuantity": 10,
"delivery": {
"information": "In 2 hours"
},
"hideStock": true
},
{
"externalId": "24",
"externalName": "Roma",
"availableQuantity": 3,
"hideStock": false
},
{
"externalId": "44",
"externalName": "Torino",
"availableQuantity": 10,
"hideStock": false
}
]
},
"availabilityExternalInfo": {
"link": "http://www.externalavailability.com",
"description": "Decription of the external availability"
}
}
]
}
]
Imports API Reference
Generate the presign URL in order to perform an upload to Amazon S3
Example:
file-to-upload.csv
Media type: application/json
Type: string
Example:
"https://valid-inventory-loader.s3.eu-west-1.amazonaws.com/workspace/stock/5a058cb51eb961be11479e81/STOCK_IMPORT_5a058cb51eb961be11479e81_2018-11-22_09-24-36-75.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20181122T092436Z&X-Amz-SignedHeaders=content-disposition%3Bcontent-type%3Bhost%3Bx-amz-meta-import-origin%3Bx-amz-meta-name&X-Amz-Expires=299&X-Amz-Credential=AKIAIVSNSHYEPJHZI3SQ%2F20181122%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=10d1fa7cc9120adab68e3ded8dc7702c7c17f102368d8fc82896974018ecb86b"
create a full customer
Media type: application/json
Type: object
Properties
map of (key -> string , value -> string)
Items: AddressRequestDTO
Items: items
Items: items
Example:
{
"establishment": {
"name": "ESTABLISHMENT_NAME",
"companyName": "COMPANY_NAME",
"vatIdentifier": "VAT_IDENTIFIER",
"email": "ESTABLISHMENT_EMAIL",
"catalogIssuers": [
"testcat1",
"testcat2"
],
"establishmentConfigs": {
"planId": "123456789"
},
"billingAddress": {
"street": "ADDRESS_STREET",
"complementaryStreet": "complementaryStreet",
"zipCode": "ZIP_CODE",
"city": "CITY",
"province": "IDF",
"country": "FRA",
"firstName": "firstName",
"lastName": "lastName",
"phone": "ADDRESS_PHONE"
},
"shippingAddresses": [
{
"street": "ADDRESS_STREET",
"complementaryStreet": "complementaryStreet",
"zipCode": "ZIP_CODE",
"city": "CITY",
"province": "IDF",
"country": "FRA",
"firstName": "firstName",
"lastName": "lastName",
"phone": "ADDRESS_PHONE",
"isDefault": true
}
],
"phone": "ADDRESS_PHONE",
"fax": "fax",
"role": "role",
"warehouse": {
"name": "WAREHOUSE_NAME",
"email": "WAREHOUSE_EMAIL",
"dispatchAddress": {
"street": "ADDRESS_STREET",
"complementaryStreet": "complementaryStreet",
"zipCode": "ZIP_CODE",
"city": "CITY",
"province": "IDF",
"country": "FRA",
"firstName": "firstName",
"lastName": "lastName",
"phone": "ADDRESS_PHONE"
},
"phone": "ADDRESS_PHONE",
"fax": "FAX",
"externalId": "EXTERNAL_ID",
"primary": true
},
"active": "1",
"bToC": "1",
"facebookUrl": "test.facebook.com",
"websiteUrl": "website.fr",
"bToCUrl": "bToC.fr",
"tresorId": "90425292",
"birId": "90425291",
"ratings": 4.95
},
"profile": {
"email": "USER_EMAIL@test.com",
"active": "1",
"firstName": "USER_FIRSTNAME",
"lastName": "USER_LASTNAME",
"phone": "phone",
"moderator": "1"
},
"pairing": {
"seller": {
"establishmentNumber": "ESTMAR18.00dd27"
},
"preferred": true,
"plateNumberCreditsRefillThreshold": 2000,
"externalBuyerNumber": "1102002399",
"forcePrimaryWarehouse": false,
"priorityBonus": 0,
"erpConnectorConfiguration": {
"endpoint": "",
"secretKey": "",
"signer": "",
"properties": {
"key1": "value1"
}
},
"networkSeller": false,
"segment": "PREMIUM",
"shippingConfig": {
"threshold": {
"value": 500.0,
"currency": "EUR"
},
"cost": {
"value": 10.0,
"currency": "EUR"
}
},
"warehouseConfigurations": [
{
"externalId": "50420049",
"primary": true,
"order": 1,
"deliveryInformation": "",
"colorCode": 1,
"hideStock": true
}
],
"virtualWarehouseConfigurations": [
{
"externalId": "mario1_virtual_ware",
"primary": true,
"order": 3,
"deliveryInformation": "Available in 2h",
"colorCode": 2,
"hideStock": false
}
],
"immediatePayment": false,
"prospect": {
"active": true,
"redirectionUrl": "www.partakus.com",
"tooltip": "tooltip"
}
},
"agentEmail": "agentEmail",
"tagLabel": "tagLabel",
"sendWelcomeEmail": true
}
Media type: application/json
Type: object
Properties
map of (key -> string , value -> string)
Items: AddressRequestDTO
Items: items
Items: items
Example:
{
"establishment": {
"establishmentNumber": "ESTMAR18.00dd27",
"name": "ESTABLISHMENT_NAME",
"companyName": "COMPANY_NAME",
"vatIdentifier": "VAT_IDENTIFIER",
"email": "ESTABLISHMENT_EMAIL",
"catalogIssuers": [
"testcat1",
"testcat2"
],
"establishmentConfigs": {
"planId": "123456789"
},
"billingAddress": {
"street": "ADDRESS_STREET",
"complementaryStreet": "complementaryStreet",
"zipCode": "ZIP_CODE",
"city": "CITY",
"province": "IDF",
"country": "FRA",
"firstName": "firstName",
"lastName": "lastName",
"phone": "ADDRESS_PHONE"
},
"phone": "ADDRESS_PHONE",
"fax": "fax",
"role": "role",
"warehouse": {
"name": "WAREHOUSE_NAME",
"email": "WAREHOUSE_EMAIL",
"dispatchAddress": {
"street": "ADDRESS_STREET",
"complementaryStreet": "complementaryStreet",
"zipCode": "ZIP_CODE",
"city": "CITY",
"province": "IDF",
"country": "FRA",
"firstName": "firstName",
"lastName": "lastName",
"phone": "ADDRESS_PHONE"
},
"phone": "ADDRESS_PHONE",
"fax": "FAX",
"externalId": "EXTERNAL_ID",
"primary": true
},
"active": "1",
"bToC": "1",
"facebookUrl": "test.facebook.com",
"websiteUrl": "website.fr",
"bToCUrl": "bToC.fr",
"tresorId": "90425292",
"birId": "90425291",
"ratings": 4.95
},
"profile": {
"email": "USER_EMAIL@test.com",
"active": "1",
"firstName": "USER_FIRSTNAME",
"lastName": "USER_LASTNAME",
"phone": "phone",
"moderator": "1"
},
"pairing": {
"seller": {
"establishmentNumber": "ESTMAR18.00dd27"
},
"customer": {
"establishmentNumber": "ESTMAR18.00dd27"
},
"preferred": true,
"plateNumberCreditsRefillThreshold": 2000,
"externalBuyerNumber": "1102002399",
"forcePrimaryWarehouse": false,
"priorityBonus": 0,
"erpConnectorConfiguration": {
"endpoint": "",
"secretKey": "",
"signer": "",
"properties": {
"key1": "value1"
}
},
"networkSeller": false,
"segment": "PREMIUM",
"warehouseConfigurations": [
{
"externalId": "50420049",
"primary": true,
"order": 1,
"deliveryInformation": "",
"colorCode": 1,
"hideStock": true
}
],
"virtualWarehouseConfigurations": [
{
"externalId": "mario1_virtual_ware",
"primary": true,
"order": 3,
"deliveryInformation": "Available in 2h",
"colorCode": 2,
"hideStock": false
}
],
"immediatePayment": false
},
"agentEmail": "agentEmail",
"tagLabel": "tagLabel"
}
Create or Update Pairing
create or update a pairing
Media type: application/json
Type: object
Properties
Items: items
Items: items
Example:
{
"seller": {
"establishmentNumber": "ESTMAR18.00dd27"
},
"customer": {
"establishmentNumber": "ESTMAR18.00dd27"
},
"preferred": true,
"priorityBonus": 0,
"networkSeller": true,
"segment": "PREMIUM",
"externalBuyerNumber": "RC43215",
"forcePrimaryWarehouse": false,
"plateNumberCreditsRefillThreshold": 1500,
"currentTurnoverForPlateNumberCredits": 1500,
"erpConnectorConfiguration": {
"properties": {
"key1": "value1",
"key2": "value2"
},
"secretKey": "mqlsdkjfqlksdjf",
"signer": "mqlkdjsfmljkkf",
"endpoint": "http://endpoint.com/"
},
"shippingConfig": {
"threshold": {
"value": 500.00,
"currency": "EUR"
},
"cost": {
"value": 10.00,
"currency": "EUR"
}
},
"warehouseConfigurations": [
{
"externalId": "50420049",
"primary": true,
"order": 1,
"deliveryInformation": "",
"colorCode": 1,
"hideStock": true
}
],
"virtualWarehouseConfigurations": [
{
"externalId": "mario1_virtual_ware",
"primary": true,
"order": 3,
"deliveryInformation": "Available in 2h",
"colorCode": 2,
"hideStock": false
}
],
"immediatePayment": false,
"prospect": {
"active": true,
"redirectionUrl": "www.partakus.com",
"tooltip": "tooltip"
}
}
patch pairing
Media type: application/json
Type: object
Properties
Reserved for admin
Reserved for admin
Reserved for admin
Items: items
Items: items
Example:
{
"seller": {
"establishmentNumber": "ESTMAR18.00dd27"
},
"customer": {
"establishmentNumber": "ESTMAR18.00dd27"
},
"preferred": true,
"priorityBonus": 0,
"networkSeller": true,
"segment": "PREMIUM",
"externalBuyerNumber": "RC43215",
"forcePrimaryWarehouse": false,
"plateNumberCreditsRefillThreshold": 1500,
"currentTurnoverForPlateNumberCredits": 1500,
"erpConnectorConfiguration": {
"properties": {
"key1": "value1",
"key2": "value2"
},
"secretKey": "mqlsdkjfqlksdjf",
"signer": "mqlkdjsfmljkkf",
"endpoint": "http://endpoint.com/"
},
"shippingConfig": {
"threshold": {
"value": 500.00,
"currency": "EUR"
},
"cost": {
"value": 10.00,
"currency": "EUR"
}
},
"warehouseConfigurations": [
{
"externalId": "50420049",
"primary": true,
"order": 1,
"deliveryInformation": "",
"colorCode": 1,
"hideStock": true
}
],
"virtualWarehouseConfigurations": [
{
"externalId": "mario1_virtual_ware",
"primary": true,
"order": 3,
"deliveryInformation": "Available in 2h",
"colorCode": 2,
"hideStock": false
}
],
"immediatePayment": false,
"prospect": {
"active": true,
"redirectionUrl": "www.partakus.com",
"tooltip": "tooltip"
}
}
create, close, un-close, ship or acknowledge a seller order
create a seller order
Media type: application/json
Type: object
Properties
Items: OrderItemDTO
Items: items
Items: items
Items: items
Example:
{
"orderNumber": "O3917.1234567",
"orderComment": "This is an emergency, need this in the morning. Thx.",
"shipping": {
"type": "COUNTER",
"address": {
"name": "Jacquie",
"street": "8 Avenue de la République",
"complements": "Bâtiment A",
"city": "Paris",
"zipCode": "75000",
"region": "ÃŽle de France",
"country": "FRA",
"phone": "1258"
}
},
"items": [
{
"isUrgent": true,
"seller": {
"id": "5bc7936202ca02b500c03888",
"name": "Ricambista Mario1 RaisonSocEta",
"companyName": "Ricambista Mario1 RaisonSocEtab",
"vatIdentifier": "IT0000000022",
"establishmentNumber": "ESTITA18.015755"
},
"part": {
"identifier": {
"catalog": {
"partNumber": "OC 1051",
"manufacturerId": "287",
"origin": "IAM",
"provider": "TECDOC",
"type": "PART"
},
"external": {
"partNumber": "MAHLEOC1051"
}
},
"description": "Filtro olio"
},
"vehicle": {
"brandLabel": "FORD",
"modelLabel": "B-MAX (JK)",
"versionLabel": "1.6 Ti",
"versionFromDate": "2012-10",
"versionToDate": "",
"versionBody": "MPV (Front-Wheel Drive).",
"engineCode": "IQJC4",
"vin": "",
"fuel": "1",
"plateNumber": "DD971JG"
},
"pricing": {
"netPrice": 100.05,
"publicPrice": 215,
"currency": "EUR",
"vat": 0.45,
"corePrice": 120,
"fees": [
{
"label": "ecotaxe",
"price": 2.94
}
]
},
"warehouses": [
{
"externalId": "68",
"orderedQuantity": 1
},
{
"externalId": "24",
"orderedQuantity": 2
}
]
}
],
"operator": {
"email": "qa1jacquie1@yopmail.com",
"firstName": "QA1edited",
"lastName": "Jacquie1"
},
"internalPurchaseOrderNumber": "0041989162",
"customer": {
"establishmentNumber": "ESTITA18.015721",
"name": "Officina Jacquie1 NomEtab",
"companyName": "Officina Jacquie1 NomEtab",
"vatIdentifier": "IT0000000022",
"email": "jacquie@yopmail.com",
"phone": "0787458541",
"active": "1",
"billingAddress": {
"name": "Jacquie",
"street": "8 Avenue de la République",
"complements": "Bâtiment A",
"city": "Paris",
"zipCode": "75000",
"region": "ÃŽle de France",
"country": "FRA",
"phone": "1234"
}
},
"preCheckoutFees": [
{
"name": "àāá!@$£",
"externalPartNumber": "MAHLEOC1051",
"value": 20.02
}
]
}
Media type: application/json
Type: object
Properties
Items: items
Items: WarehouseOfferResource
Items: items
Items: items
Example:
{
"id": "5f6c53b60b66374bb6617abb",
"seller": {
"id": "59789463a706ce9852a64fd0",
"establishmentNumber": "ESTITA18.0004d3",
"name": "Magazzino Mario No1 NomEtab",
"companyName": "I Ricambi di Mario1 RaisonSocEtab",
"email": "marioetab1@gmail.com",
"phone": "02 0000001",
"vatIdentifier": "IT0000000031",
"billingAddress": {
"street": "Via Mario FACTU étab1",
"zipCode": "20000",
"city": "Villeétablissement",
"province": "AN - Ancona",
"country": "ITA",
"firstName": "",
"lastName": "",
"phone": "111111",
"default": false,
"addressLine2": "",
"fullName": ""
},
"roles": [
"retailer"
]
},
"customer": {
"id": "5d1efc23f2db160ced03508d",
"email": "qa1jacquie1@yopmail.com",
"establishment": {
"id": "59789463a706ce9852a64fc4",
"establishmentNumber": "ESTITA18.000437",
"name": "Officina Jacquie1 NomEtab",
"companyName": "Officina Jacquie1 RaisonSocEtab",
"email": "jacquieetab1@gmail.com",
"phone": "123testphone",
"vatIdentifier": "IT0000000011",
"billingAddress": {
"street": "Via Jacquie FACTU étab1",
"zipCode": "20001",
"city": "Villeétablissement",
"province": "AB - Albacete",
"country": "ESP",
"firstName": "",
"lastName": "",
"phone": "1234",
"default": false,
"addressLine2": "",
"fullName": ""
},
"roles": [
"car_repairer"
]
}
},
"orderNumber": "OESP20.17F716",
"externalClientNumber": "jacquie1",
"createdByEmail": "qa1jacquie1@yopmail.com",
"createdByFirstName": "subdomain uat",
"createdByLastName": "jacquie1",
"validatedAt": "2020-09-24T10:07:18.789Z",
"shippingAddress": {
"id": "6b95ade1-f5cd-497a-b871-f480c2280abe",
"street": "addressA2",
"zipCode": "10242",
"city": "Riga",
"province": "AL - Alessandria",
"country": "ITA",
"firstName": "Karlis2",
"lastName": "test2",
"phone": "123412342",
"default": false,
"addressLine2": "212X2",
"fullName": "Karlis2 test2"
},
"shippingType": "USER",
"urgent": true,
"price": {
"value": 272.51,
"currency": "EUR"
},
"priceVat": {
"value": 37.95,
"currency": "EUR"
},
"priceFees": {
"value": 0.00,
"currency": "EUR"
},
"priceReturnable": {
"value": 67.95,
"currency": "EUR"
},
"shippingFees": {
"value": 100.00,
"currency": "EUR"
},
"eligibleForReturn": false,
"warehouseOrders": [
{
"id": "2875a9a7-3d8d-414e-bff3-a8dbb2ee3a7d",
"warehouseName": "Warehouse Mario No1_1",
"warehouseExternalId": "101",
"externalOrderNumber": "externalOrderNumberTest",
"externalOrderId": "externalOrderIdTest",
"externalOrderDate": "2020-09-23",
"offersWithShipped": [
{
"id": "8811462c-e8b3-4077-ad38-17e976cdc890",
"offerPrice": {
"value": 4.56,
"currency": "EUR"
},
"price": {
"value": 4.56,
"currency": "EUR"
},
"initialQuantity": 1,
"addedQuantity": 0,
"quantity": 1,
"shippedQuantity": 0,
"remainingQuantity": 1,
"cancelledQuantity": 0,
"returnable": {
"price": {
"value": 45.95,
"currency": "EUR"
}
},
"offerFees": [],
"offerTotalFees": {
"value": 0.00,
"currency": "EUR"
},
"part": {
"partNumber": "FM560/08",
"manufacturerId": "BMCX",
"description": "",
"manufacturerLabel": "BMC AirFilter"
},
"offer": {
"product": {
"seller": {
"__type__": "establishment",
"id": "59789463a706ce9852a64fd0",
"organization": {
"id": "59789463a706ce9852a64faf",
"companyName": "Mario No1 RaisonSocOrga",
"network": {
"id": "5991559d1b9b2636fe1eb383",
"name": "renault",
"unAuthorizedBrands": [
"157"
]
},
"vatIdentifier": "IT0000000011111",
"email": "marioorg@yopmail.com",
"active": true,
"billingAddress": {
"street": "Via Mario orga123",
"zipCode": "122122",
"city": "Milan",
"province": "AG - Agrigento",
"country": "ITA",
"firstName": "Ricambi",
"lastName": "Mario updated",
"phone": "1112222333334444",
"default": false,
"fullName": "Ricambi Mario updated"
},
"phone": "11223344",
"fax": "321321",
"testOrganization": true,
"organizationNumber": "ORGITA18.00061e"
},
"name": "Magazzino Mario No1 NomEtab",
"companyName": "I Ricambi di Mario1 RaisonSocEtab",
"vatIdentifier": "IT0000000031",
"email": "marioetab1@gmail.com",
"billingAddress": {
"street": "Via Mario FACTU étab1",
"zipCode": "20000",
"city": "Villeétablissement",
"province": "AN - Ancona",
"country": "ITA",
"firstName": "",
"lastName": "",
"phone": "111111",
"default": false,
"addressLine2": "",
"fullName": ""
},
"counterAddress": {
"street": "",
"zipCode": "",
"city": "",
"firstName": "",
"lastName": "",
"phone": "",
"default": false,
"addressLine2": "",
"fullName": ""
},
"shippingAddresses": [
{
"id": "73e82c35-9552-4a20-a5b0-4edda550781b",
"street": "1 rue Louis Rolland",
"zipCode": "92120",
"city": "Montrouge",
"province": "IDF - Île-de-France",
"country": "FRA",
"firstName": "Maxime",
"lastName": "Baubriau",
"phone": "0665083299",
"default": true,
"fullName": "Maxime Baubriau"
}
],
"phone": "02 0000001",
"fax": "02 9999991",
"roles": [
"retailer"
],
"catalogState": {
"state": "ACTIVE",
"scheduled": false
},
"vehicleSearchCredits": 94,
"defaultWarehouseId": "12",
"active": true,
"lastLoginTime": "2020-09-23T15:45:30.451Z",
"establishmentConfigs": {
"webLogoShort": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcT-PhvGGtu7Y3JTRpRKfksORvhh2rTDFsE5j8aBDV3DLBCS0x8z",
"webMainColor": "#ff69b3"
},
"forcePrimaryWarehouse": true,
"erpConnectorConfiguration": {
"properties": {},
"complete": false
},
"establishmentNumber": "ESTITA18.0004d3",
"shippingConfig": {
"threshold": {
"value": 100.50,
"currency": "EUR"
},
"cost": {
"value": 12.00,
"currency": "EUR"
}
},
"paymentAccountId": "QA1",
"repairJobsActive": true,
"returnTypes": [
"EXCHANGE",
"REFUND",
"CREDIT_NOTE"
],
"returnReasons": [
"NON_COMPLIANT",
"DAMAGED",
"DEFECTIVE",
"DELIVERY_DELAY"
],
"returnModes": [
"RETURN_BY_YOURSELF",
"REMOVAL_REQUEST",
"ADD_TO_COUNTER_PICKUP",
"ADD_TO_DELIVERY_DELAY"
],
"activeRequests": {
"searchAvailabilities": true,
"searchShippingPlans": true,
"createOrder": true,
"getOrder": true,
"createReturn": true,
"getReturn": true,
"preCheckout": false
},
"defaultShippingAddress": {
"id": "73e82c35-9552-4a20-a5b0-4edda550781b",
"street": "1 rue Louis Rolland",
"zipCode": "92120",
"city": "Montrouge",
"province": "IDF - Île-de-France",
"country": "FRA",
"firstName": "Maxime",
"lastName": "Baubriau",
"phone": "0665083299",
"default": true,
"fullName": "Maxime Baubriau"
},
"catalogActive": true,
"garage": false,
"retailer": true
},
"partNumber": "FM560/08",
"id": "5c6a7643a3c8ef11d814f84d",
"manufacturerId": "BMCX",
"externalPartNumber": "BMC|FM560/08",
"identifier": "NTk3ODk0NjNhNzA2Y2U5ODUyYTY0ZmQw-Rk01NjAvMDg=-Qk1DfEZNNTYwLzA4-Qk1DWA==",
"priority": 50
},
"netPrice": {
"value": 4.56,
"currency": "EUR"
},
"publicPrice": {
"value": 94.64,
"currency": "EUR"
},
"returnable": {
"price": {
"value": 45.95,
"currency": "EUR"
}
},
"price": {
"value": 4.56,
"currency": "EUR"
}
}
},
{
"id": "64082f41-f725-4aaa-ab15-0304c9b4961f",
"offerPrice": {
"value": 100.00,
"currency": "EUR"
},
"price": {
"value": 100.00,
"currency": "EUR"
},
"initialQuantity": 1,
"addedQuantity": 0,
"quantity": 1,
"shippedQuantity": 0,
"remainingQuantity": 1,
"cancelledQuantity": 0,
"returnable": {
"price": {
"value": 22.00,
"currency": "EUR"
}
},
"offerFees": [],
"offerTotalFees": {
"value": 0.00,
"currency": "EUR"
},
"part": {
"partNumber": "16783",
"manufacturerId": "059",
"description": "Kit de plaquettes de frein, frein à disque",
"manufacturerLabel": "FEBI"
},
"offer": {
"product": {
"seller": {
"__type__": "establishment",
"id": "59789463a706ce9852a64fd0",
"organization": {
"id": "59789463a706ce9852a64faf",
"companyName": "Mario No1 RaisonSocOrga",
"network": {
"id": "5991559d1b9b2636fe1eb383",
"name": "renault",
"unAuthorizedBrands": [
"157"
]
},
"vatIdentifier": "IT0000000011111",
"email": "marioorg@yopmail.com",
"active": true,
"billingAddress": {
"street": "Via Mario orga123",
"zipCode": "122122",
"city": "Milan",
"province": "AG - Agrigento",
"country": "ITA",
"firstName": "Ricambi",
"lastName": "Mario updated",
"phone": "1112222333334444",
"default": false,
"fullName": "Ricambi Mario updated"
},
"phone": "11223344",
"fax": "321321",
"testOrganization": true,
"organizationNumber": "ORGITA18.00061e"
},
"name": "Magazzino Mario No1 NomEtab",
"companyName": "I Ricambi di Mario1 RaisonSocEtab",
"vatIdentifier": "IT0000000031",
"email": "marioetab1@gmail.com",
"billingAddress": {
"street": "Via Mario FACTU étab1",
"zipCode": "20000",
"city": "Villeétablissement",
"province": "AN - Ancona",
"country": "ITA",
"firstName": "",
"lastName": "",
"phone": "111111",
"default": false,
"addressLine2": "",
"fullName": ""
},
"counterAddress": {
"street": "",
"zipCode": "",
"city": "",
"firstName": "",
"lastName": "",
"phone": "",
"default": false,
"addressLine2": "",
"fullName": ""
},
"shippingAddresses": [
{
"id": "73e82c35-9552-4a20-a5b0-4edda550781b",
"street": "1 rue Louis Rolland",
"zipCode": "92120",
"city": "Montrouge",
"province": "IDF - Île-de-France",
"country": "FRA",
"firstName": "Maxime",
"lastName": "Baubriau",
"phone": "0665083299",
"default": true,
"fullName": "Maxime Baubriau"
}
],
"phone": "02 0000001",
"fax": "02 9999991",
"roles": [
"retailer"
],
"catalogState": {
"state": "ACTIVE",
"scheduled": false
},
"vehicleSearchCredits": 94,
"defaultWarehouseId": "12",
"active": true,
"lastLoginTime": "2020-09-23T15:45:30.451Z",
"establishmentConfigs": {
"webLogoShort": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcT-PhvGGtu7Y3JTRpRKfksORvhh2rTDFsE5j8aBDV3DLBCS0x8z",
"webMainColor": "#ff69b3"
},
"forcePrimaryWarehouse": true,
"erpConnectorConfiguration": {
"properties": {},
"complete": false
},
"establishmentNumber": "ESTITA18.0004d3",
"shippingConfig": {
"threshold": {
"value": 100.50,
"currency": "EUR"
},
"cost": {
"value": 12.00,
"currency": "EUR"
}
},
"paymentAccountId": "QA1",
"repairJobsActive": true,
"returnTypes": [
"EXCHANGE",
"REFUND",
"CREDIT_NOTE"
],
"returnReasons": [
"NON_COMPLIANT",
"DAMAGED",
"DEFECTIVE",
"DELIVERY_DELAY"
],
"returnModes": [
"RETURN_BY_YOURSELF",
"REMOVAL_REQUEST",
"ADD_TO_COUNTER_PICKUP",
"ADD_TO_DELIVERY_DELAY"
],
"activeRequests": {
"searchAvailabilities": true,
"searchShippingPlans": true,
"createOrder": true,
"getOrder": true,
"createReturn": true,
"getReturn": true,
"preCheckout": false
},
"defaultShippingAddress": {
"id": "73e82c35-9552-4a20-a5b0-4edda550781b",
"street": "1 rue Louis Rolland",
"zipCode": "92120",
"city": "Montrouge",
"province": "IDF - Île-de-France",
"country": "FRA",
"firstName": "Maxime",
"lastName": "Baubriau",
"phone": "0665083299",
"default": true,
"fullName": "Maxime Baubriau"
},
"catalogActive": true,
"garage": false,
"retailer": true
},
"partNumber": "16783",
"id": "5c6a64e6a3c8ef2936dc441d",
"manufacturerId": "059",
"externalPartNumber": "0059|16783",
"identifier": "NTk3ODk0NjNhNzA2Y2U5ODUyYTY0ZmQw-MTY3ODM=-MDA1OXwxNjc4Mw==-MDU5",
"priority": 50
},
"netPrice": {
"value": 100.00,
"currency": "EUR"
},
"publicPrice": {
"value": 4991.00,
"currency": "EUR"
},
"returnable": {
"price": {
"value": 22.00,
"currency": "EUR"
}
},
"price": {
"value": 100.00,
"currency": "EUR"
}
}
}
],
"numberOfParcels": 0,
"allShipped": false,
"allCancelled": false,
"price": {
"value": 172.51,
"currency": "EUR"
},
"parcels": [],
"orderComment": ""
}
],
"additionalFees": [],
"totalNetPrice": {
"value": 272.51,
"currency": "EUR"
},
"status": "pending-for-handling",
"priceWithVat": {
"value": 310.46,
"currency": "EUR"
}
}
close, un-close, ship or acknowledge a seller order, the action can be "close", "unclose", "ship" or "acknowledge".
Media type: application/json
Type: object
Properties
Items: PublicParcelRequestDTO
Items: PublicWarehouseOrderRequestDTO
Items: PublicWarehouseOfferRequestDTO
Example:
{
"action": "ship",
"parcels": [
{
"trackingId": "trackingId11111",
"deliverySlipNumber": "deliverySlipNb1",
"comment": "comment12345",
"externalOrderNumber": "8dcbb145bf6c1b8072c6"
},
{
"trackingId": "trackingId22222",
"deliverySlipNumber": "deliverySlipNb2",
"comment": "comment222",
"externalOrderNumber": "56288f2c6dd8d2e52eb7"
}
],
"warehouseOrders": [
{
"externalOrderNumber": "externalOrderNumberTest",
"externalOrderId": "externalOrderIdTest",
"warehouseExternalId": "10",
"externalOrderDate": "2020-09-23",
"warehouseOffers": [
{
"externalPartNumber": "externalPartNumber10",
"externalLineNumber": "10"
}
]
}
]
}
Media type: application/json
Type: object
Properties
Items: items
Items: WarehouseOfferResource
Items: items
Items: items
Example:
{
"sellerOrder": {
"id": "5f6c53b60b66374bb6617abb",
"seller": {
"id": "59789463a706ce9852a64fd0",
"establishmentNumber": "ESTITA18.0004d3",
"name": "Magazzino Mario No1 NomEtab",
"companyName": "I Ricambi di Mario1 RaisonSocEtab",
"email": "marioetab1@gmail.com",
"phone": "02 0000001",
"vatIdentifier": "IT0000000031",
"billingAddress": {
"street": "Via Mario FACTU étab1",
"zipCode": "20000",
"city": "Villeétablissement",
"province": "AN - Ancona",
"country": "ITA",
"firstName": "",
"lastName": "",
"phone": "111111",
"default": false,
"addressLine2": "",
"fullName": ""
},
"roles": [
"retailer"
]
},
"customer": {
"id": "5d1efc23f2db160ced03508d",
"email": "qa1jacquie1@yopmail.com",
"establishment": {
"id": "59789463a706ce9852a64fc4",
"establishmentNumber": "ESTITA18.000437",
"name": "Officina Jacquie1 NomEtab",
"companyName": "Officina Jacquie1 RaisonSocEtab",
"email": "jacquieetab1@gmail.com",
"phone": "123testphone",
"vatIdentifier": "IT0000000011",
"billingAddress": {
"street": "Via Jacquie FACTU étab1",
"zipCode": "20001",
"city": "Villeétablissement",
"province": "AB - Albacete",
"country": "ESP",
"firstName": "",
"lastName": "",
"phone": "1234",
"default": false,
"addressLine2": "",
"fullName": ""
},
"roles": [
"car_repairer"
]
}
},
"orderNumber": "OESP20.17F716",
"externalClientNumber": "jacquie1",
"createdByEmail": "qa1jacquie1@yopmail.com",
"createdByFirstName": "subdomain uat",
"createdByLastName": "jacquie1",
"validatedAt": "2020-09-24T10:07:18.789Z",
"shippingAddress": {
"id": "6b95ade1-f5cd-497a-b871-f480c2280abe",
"street": "addressA2",
"zipCode": "10242",
"city": "Riga",
"province": "AL - Alessandria",
"country": "ITA",
"firstName": "Karlis2",
"lastName": "test2",
"phone": "123412342",
"default": false,
"addressLine2": "212X2",
"fullName": "Karlis2 test2"
},
"shippingType": "USER",
"urgent": true,
"price": {
"value": 272.51,
"currency": "EUR"
},
"priceVat": {
"value": 37.95,
"currency": "EUR"
},
"priceFees": {
"value": 0.00,
"currency": "EUR"
},
"priceReturnable": {
"value": 67.95,
"currency": "EUR"
},
"shippingFees": {
"value": 100.00,
"currency": "EUR"
},
"eligibleForReturn": false,
"warehouseOrders": [
{
"id": "2875a9a7-3d8d-414e-bff3-a8dbb2ee3a7d",
"warehouseName": "Warehouse Mario No1_1",
"warehouseExternalId": "101",
"externalOrderNumber": "externalOrderNumberTest",
"externalOrderId": "externalOrderIdTest",
"externalOrderDate": "2020-09-23",
"offersWithShipped": [
{
"id": "8811462c-e8b3-4077-ad38-17e976cdc890",
"offerPrice": {
"value": 4.56,
"currency": "EUR"
},
"price": {
"value": 4.56,
"currency": "EUR"
},
"initialQuantity": 1,
"addedQuantity": 0,
"quantity": 1,
"shippedQuantity": 0,
"remainingQuantity": 1,
"cancelledQuantity": 0,
"returnable": {
"price": {
"value": 45.95,
"currency": "EUR"
}
},
"offerFees": [],
"offerTotalFees": {
"value": 0.00,
"currency": "EUR"
},
"part": {
"partNumber": "FM560/08",
"manufacturerId": "BMCX",
"description": "",
"manufacturerLabel": "BMC AirFilter"
},
"offer": {
"product": {
"seller": {
"__type__": "establishment",
"id": "59789463a706ce9852a64fd0",
"organization": {
"id": "59789463a706ce9852a64faf",
"companyName": "Mario No1 RaisonSocOrga",
"network": {
"id": "5991559d1b9b2636fe1eb383",
"name": "renault",
"unAuthorizedBrands": [
"157"
]
},
"vatIdentifier": "IT0000000011111",
"email": "marioorg@yopmail.com",
"active": true,
"billingAddress": {
"street": "Via Mario orga123",
"zipCode": "122122",
"city": "Milan",
"province": "AG - Agrigento",
"country": "ITA",
"firstName": "Ricambi",
"lastName": "Mario updated",
"phone": "1112222333334444",
"default": false,
"fullName": "Ricambi Mario updated"
},
"phone": "11223344",
"fax": "321321",
"testOrganization": true,
"organizationNumber": "ORGITA18.00061e"
},
"name": "Magazzino Mario No1 NomEtab",
"companyName": "I Ricambi di Mario1 RaisonSocEtab",
"vatIdentifier": "IT0000000031",
"email": "marioetab1@gmail.com",
"billingAddress": {
"street": "Via Mario FACTU étab1",
"zipCode": "20000",
"city": "Villeétablissement",
"province": "AN - Ancona",
"country": "ITA",
"firstName": "",
"lastName": "",
"phone": "111111",
"default": false,
"addressLine2": "",
"fullName": ""
},
"counterAddress": {
"street": "",
"zipCode": "",
"city": "",
"firstName": "",
"lastName": "",
"phone": "",
"default": false,
"addressLine2": "",
"fullName": ""
},
"shippingAddresses": [
{
"id": "73e82c35-9552-4a20-a5b0-4edda550781b",
"street": "1 rue Louis Rolland",
"zipCode": "92120",
"city": "Montrouge",
"province": "IDF - Île-de-France",
"country": "FRA",
"firstName": "Maxime",
"lastName": "Baubriau",
"phone": "0665083299",
"default": true,
"fullName": "Maxime Baubriau"
}
],
"phone": "02 0000001",
"fax": "02 9999991",
"roles": [
"retailer"
],
"catalogState": {
"state": "ACTIVE",
"scheduled": false
},
"vehicleSearchCredits": 94,
"defaultWarehouseId": "12",
"active": true,
"lastLoginTime": "2020-09-23T15:45:30.451Z",
"establishmentConfigs": {
"webLogoShort": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcT-PhvGGtu7Y3JTRpRKfksORvhh2rTDFsE5j8aBDV3DLBCS0x8z",
"webMainColor": "#ff69b3"
},
"forcePrimaryWarehouse": true,
"erpConnectorConfiguration": {
"properties": {},
"complete": false
},
"establishmentNumber": "ESTITA18.0004d3",
"shippingConfig": {
"threshold": {
"value": 100.50,
"currency": "EUR"
},
"cost": {
"value": 12.00,
"currency": "EUR"
}
},
"paymentAccountId": "QA1",
"repairJobsActive": true,
"returnTypes": [
"EXCHANGE",
"REFUND",
"CREDIT_NOTE"
],
"returnReasons": [
"NON_COMPLIANT",
"DAMAGED",
"DEFECTIVE",
"DELIVERY_DELAY"
],
"returnModes": [
"RETURN_BY_YOURSELF",
"REMOVAL_REQUEST",
"ADD_TO_COUNTER_PICKUP",
"ADD_TO_DELIVERY_DELAY"
],
"activeRequests": {
"searchAvailabilities": true,
"searchShippingPlans": true,
"createOrder": true,
"getOrder": true,
"createReturn": true,
"getReturn": true,
"preCheckout": false
},
"defaultShippingAddress": {
"id": "73e82c35-9552-4a20-a5b0-4edda550781b",
"street": "1 rue Louis Rolland",
"zipCode": "92120",
"city": "Montrouge",
"province": "IDF - Île-de-France",
"country": "FRA",
"firstName": "Maxime",
"lastName": "Baubriau",
"phone": "0665083299",
"default": true,
"fullName": "Maxime Baubriau"
},
"catalogActive": true,
"garage": false,
"retailer": true
},
"partNumber": "FM560/08",
"id": "5c6a7643a3c8ef11d814f84d",
"manufacturerId": "BMCX",
"externalPartNumber": "BMC|FM560/08",
"identifier": "NTk3ODk0NjNhNzA2Y2U5ODUyYTY0ZmQw-Rk01NjAvMDg=-Qk1DfEZNNTYwLzA4-Qk1DWA==",
"priority": 50
},
"netPrice": {
"value": 4.56,
"currency": "EUR"
},
"publicPrice": {
"value": 94.64,
"currency": "EUR"
},
"returnable": {
"price": {
"value": 45.95,
"currency": "EUR"
}
},
"price": {
"value": 4.56,
"currency": "EUR"
}
}
},
{
"id": "64082f41-f725-4aaa-ab15-0304c9b4961f",
"offerPrice": {
"value": 100.00,
"currency": "EUR"
},
"price": {
"value": 100.00,
"currency": "EUR"
},
"initialQuantity": 1,
"addedQuantity": 0,
"quantity": 1,
"shippedQuantity": 0,
"remainingQuantity": 1,
"cancelledQuantity": 0,
"returnable": {
"price": {
"value": 22.00,
"currency": "EUR"
}
},
"offerFees": [],
"offerTotalFees": {
"value": 0.00,
"currency": "EUR"
},
"part": {
"partNumber": "16783",
"manufacturerId": "059",
"description": "Kit de plaquettes de frein, frein à disque",
"manufacturerLabel": "FEBI"
},
"offer": {
"product": {
"seller": {
"__type__": "establishment",
"id": "59789463a706ce9852a64fd0",
"organization": {
"id": "59789463a706ce9852a64faf",
"companyName": "Mario No1 RaisonSocOrga",
"network": {
"id": "5991559d1b9b2636fe1eb383",
"name": "renault",
"unAuthorizedBrands": [
"157"
]
},
"vatIdentifier": "IT0000000011111",
"email": "marioorg@yopmail.com",
"active": true,
"billingAddress": {
"street": "Via Mario orga123",
"zipCode": "122122",
"city": "Milan",
"province": "AG - Agrigento",
"country": "ITA",
"firstName": "Ricambi",
"lastName": "Mario updated",
"phone": "1112222333334444",
"default": false,
"fullName": "Ricambi Mario updated"
},
"phone": "11223344",
"fax": "321321",
"testOrganization": true,
"organizationNumber": "ORGITA18.00061e"
},
"name": "Magazzino Mario No1 NomEtab",
"companyName": "I Ricambi di Mario1 RaisonSocEtab",
"vatIdentifier": "IT0000000031",
"email": "marioetab1@gmail.com",
"billingAddress": {
"street": "Via Mario FACTU étab1",
"zipCode": "20000",
"city": "Villeétablissement",
"province": "AN - Ancona",
"country": "ITA",
"firstName": "",
"lastName": "",
"phone": "111111",
"default": false,
"addressLine2": "",
"fullName": ""
},
"counterAddress": {
"street": "",
"zipCode": "",
"city": "",
"firstName": "",
"lastName": "",
"phone": "",
"default": false,
"addressLine2": "",
"fullName": ""
},
"shippingAddresses": [
{
"id": "73e82c35-9552-4a20-a5b0-4edda550781b",
"street": "1 rue Louis Rolland",
"zipCode": "92120",
"city": "Montrouge",
"province": "IDF - Île-de-France",
"country": "FRA",
"firstName": "Maxime",
"lastName": "Baubriau",
"phone": "0665083299",
"default": true,
"fullName": "Maxime Baubriau"
}
],
"phone": "02 0000001",
"fax": "02 9999991",
"roles": [
"retailer"
],
"catalogState": {
"state": "ACTIVE",
"scheduled": false
},
"vehicleSearchCredits": 94,
"defaultWarehouseId": "12",
"active": true,
"lastLoginTime": "2020-09-23T15:45:30.451Z",
"establishmentConfigs": {
"webLogoShort": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcT-PhvGGtu7Y3JTRpRKfksORvhh2rTDFsE5j8aBDV3DLBCS0x8z",
"webMainColor": "#ff69b3"
},
"forcePrimaryWarehouse": true,
"erpConnectorConfiguration": {
"properties": {},
"complete": false
},
"establishmentNumber": "ESTITA18.0004d3",
"shippingConfig": {
"threshold": {
"value": 100.50,
"currency": "EUR"
},
"cost": {
"value": 12.00,
"currency": "EUR"
}
},
"paymentAccountId": "QA1",
"repairJobsActive": true,
"returnTypes": [
"EXCHANGE",
"REFUND",
"CREDIT_NOTE"
],
"returnReasons": [
"NON_COMPLIANT",
"DAMAGED",
"DEFECTIVE",
"DELIVERY_DELAY"
],
"returnModes": [
"RETURN_BY_YOURSELF",
"REMOVAL_REQUEST",
"ADD_TO_COUNTER_PICKUP",
"ADD_TO_DELIVERY_DELAY"
],
"activeRequests": {
"searchAvailabilities": true,
"searchShippingPlans": true,
"createOrder": true,
"getOrder": true,
"createReturn": true,
"getReturn": true,
"preCheckout": false
},
"defaultShippingAddress": {
"id": "73e82c35-9552-4a20-a5b0-4edda550781b",
"street": "1 rue Louis Rolland",
"zipCode": "92120",
"city": "Montrouge",
"province": "IDF - Île-de-France",
"country": "FRA",
"firstName": "Maxime",
"lastName": "Baubriau",
"phone": "0665083299",
"default": true,
"fullName": "Maxime Baubriau"
},
"catalogActive": true,
"garage": false,
"retailer": true
},
"partNumber": "16783",
"id": "5c6a64e6a3c8ef2936dc441d",
"manufacturerId": "059",
"externalPartNumber": "0059|16783",
"identifier": "NTk3ODk0NjNhNzA2Y2U5ODUyYTY0ZmQw-MTY3ODM=-MDA1OXwxNjc4Mw==-MDU5",
"priority": 50
},
"netPrice": {
"value": 100.00,
"currency": "EUR"
},
"publicPrice": {
"value": 4991.00,
"currency": "EUR"
},
"returnable": {
"price": {
"value": 22.00,
"currency": "EUR"
}
},
"price": {
"value": 100.00,
"currency": "EUR"
}
}
}
],
"numberOfParcels": 0,
"allShipped": false,
"allCancelled": false,
"price": {
"value": 172.51,
"currency": "EUR"
},
"parcels": [],
"orderComment": ""
}
],
"additionalFees": [],
"totalNetPrice": {
"value": 272.51,
"currency": "EUR"
},
"status": "pending-for-handling",
"priceWithVat": {
"value": 310.46,
"currency": "EUR"
}
}
}
Update partially the establishment. Can be used by moderator of the establishment or admin.
- All fields are optional, if the field is not present in the request or filled with empty string, it will be ignored.
- The email should contain '@' and '.extension'.
- All the addresses should be valid (with required fields completed) once not empty.
- The shippingAddresses can have one or zero defaultAddress, if there's no defaultAddress, the billingAddress will be added as default shippingAddress, otherwise, the billingAddress will be added to shippingAddresses but not as default.
- The returnTypes can contain one or more values in "EXCHANGE","REFUND" or "CREDIT_NOTE".
- The returnReasons can contain one or more values in "NON_COMPLIANT","DAMAGED","DEFECTIVE" or "DELIVERY_DELAY".
- The returnModes can contain one or more values in "RETURN_BY_YOURSELF","REMOVAL_REQUEST","ADD_TO_COUNTER_PICKUP", or "ADD_TO_DELIVERY_DELAY".
- Only Admin can use the fields "bToC" and "vehicleSearchCredits".
Media type: application/json
Type: object
Properties
map of (key -> string , value -> string)
Items: AddressRequestDTO
Example:
{
"name": "ESTABLISHMENT_NAME",
"companyName": "COMPANY_NAME",
"vatIdentifier": "VAT_IDENTIFIER",
"email": "ESTABLISHMENT_EMAIL@example.com",
"phone": "ADDRESS_PHONE",
"fax": "fax",
"bToC": true,
"bToCUrl": "bToC.fr",
"birId": "90425291",
"vehicleSearchCredits": 100,
"establishmentConfigs": {
"planId": "123456789"
},
"billingAddress": {
"street": "billing address street",
"complementaryStreet": "Test4",
"zipCode": "12345",
"city": "Test4",
"province": "IDF",
"country": "FRA",
"firstName": "Test FName4",
"lastName": "Test LName4",
"phone": "123123",
"default": false
},
"counterAddress": {
"street": "counter address",
"complementaryStreet": "Test4",
"zipCode": "12345",
"city": "Test4",
"province": "IDF",
"country": "FRA",
"firstName": "Test FName4",
"lastName": "Test LName4",
"phone": "123123",
"default": false
},
"shippingAddresses": [
{
"street": "shipping address street",
"complementaryStreet": "Test4",
"zipCode": "12345",
"city": "Test4",
"province": "IDF",
"country": "FRA",
"firstName": "Test FName4",
"lastName": "Test LName4",
"phone": "123123",
"default": true
}
],
"returnTypes": ["EXCHANGE", "REFUND", "CREDIT_NOTE"],
"returnReasons": [
"NON_COMPLIANT",
"DAMAGED",
"DEFECTIVE",
"DELIVERY_DELAY"
],
"returnModes": [
"RETURN_BY_YOURSELF",
"REMOVAL_REQUEST",
"ADD_TO_COUNTER_PICKUP",
"ADD_TO_DELIVERY_DELAY"
]
}
Media type: application/json
Type: object
Properties
map of (key -> string , value -> string)
Items: AddressRequestDTO
Example:
{
"name": "ESTABLISHMENT_NAME",
"companyName": "COMPANY_NAME",
"vatIdentifier": "VAT_IDENTIFIER",
"email": "ESTABLISHMENT_EMAIL@example.com",
"phone": "ADDRESS_PHONE",
"fax": "fax",
"establishmentConfigs": {
"planId": "123456789"
},
"billingAddress": {
"street": "billing address street",
"complementaryStreet": "Test4",
"zipCode": "12345",
"city": "Test4",
"province": "IDF - Île-de-France",
"country": "FRA",
"firstName": "Test FName4",
"lastName": "Test LName4",
"phone": "123123",
"default": false
},
"counterAddress": {
"street": "counter address",
"complementaryStreet": "Test4",
"zipCode": "12345",
"city": "Test4",
"province": "IDF - Île-de-France",
"country": "FRA",
"firstName": "Test FName4",
"lastName": "Test LName4",
"phone": "123123",
"default": false
},
"vehicleSearchCredits": 100,
"bToC": true,
"bToCUrl": "bToC.fr",
"birId": "90425291",
"shippingAddresses": [
{
"street": "shipping address street",
"complementaryStreet": "Test4",
"zipCode": "12345",
"city": "Test4",
"province": "IDF - Île-de-France",
"country": "FRA",
"firstName": "Test FName4",
"lastName": "Test LName4",
"phone": "123123",
"default": true
},
{
"street": "billing address street",
"complementaryStreet": "Test4",
"zipCode": "12345",
"city": "Test4",
"province": "IDF - Île-de-France",
"country": "FRA",
"firstName": "Test FName4",
"lastName": "Test LName4",
"phone": "123123",
"default": false
}
],
"returnTypes": ["EXCHANGE", "REFUND", "CREDIT_NOTE"],
"returnReasons": [
"NON_COMPLIANT",
"DAMAGED",
"DEFECTIVE",
"DELIVERY_DELAY"
],
"returnModes": [
"RETURN_BY_YOURSELF",
"REMOVAL_REQUEST",
"ADD_TO_COUNTER_PICKUP",
"ADD_TO_DELIVERY_DELAY"
]
}
upload banner picture for establishment
upload banner picture
Media type: multipart/form-data
Type: object
Properties
The banner picture to upload, support only for image file with content type image/jpeg, image/png, image/jpg, image/bmp
Trigger to send welcome email with init password link to user, can be triggered only by admin