Addock

Open-api’s documentation

Overview

Current version

The API is versioned using a version suffix in the URLs, the current version is the version 1 and is expressed by using a v1 prefix URL fragment.

Schemas

All API access is over HTTPS, and accessed from https://demo-openapi.addk.fr . All data is sent and received as JSON. The Addock API uses several data types, some of those types are expressed as standardized strings. The API is designed to use standards as much as possible because it facilitates integrations with other systems and migrations. The standards we currently use are the followings:

Country codes and territories : ISO 3166

Currencies : ISO 4217

Dates and times : RFC 3339

Languages : BCP 47 and / or ISO 639.

Time Zones : Taken from the IANA Time Zone Database.

Authorization

By default all API endpoints are protected and will return the following error.

The endpoints are protected using the OAuth 2.0 protocol. So, authorizations are granted when a specific OAuth 2.0 Access Token is provided. An OAuth 2.0 Access Token can be obtained using key / value credentials which should have been provided to you by Addock (if you do not have credentials please contact us at contact@addock.co). Here is a sample which shows how to retrieve an OAuth 2.0 access_token.

In this sample the OAuth 2.0 Access Token retrieved is acefad39-3afc-4e46-a6ea-9531a90804e8, you can then provide this value with the access_token URL parameter to authorize your requests.

Supported grant types WARNING currently the Addock API only supports the client_credentials grant type. To prevent security problems this grant type should only be used for server to server communications. So you should not use the client_credentials grant type to request the APIs from a browser for example. This is very important because Addock uses access tokens which have a farther expiration date with client_credentials. Because browsers could cache and expose the access tokens it is not advised to use a token which is valid during a long time in this case.

Token validity duration

To increase security the OAuth 2.0 Access Token provided by our servers are valid during 24 hours. It means that your source code should automatically refresh your access token before the 24 hours are elaspsed. Refreshing the access token is very simple and just requires a new request on the token endpoint the same way you did it to retrieve your first access token.

Rate Limiting

To prevent abuses the Addock API is rate limited. The first time you use the API your account is generally configured with default rate limits. The default rate limits allows 100 API calls during the last 10 minutes, if this limit is exceeded a 429 HTTP error like this one will be returned.

This error indicates that too many requests were executed, the metadata gives detailed about the rate limit rules which are configured on your account. For example the previous payload indicates that the account is configured with one rate limit rule allowing 100 calls during a sliding time window of 600 seconds (or 10 minutes). The rate limit configuration is generally configured in relation with the contract settled between Addock and your company. If you need a custom rate limit configuration please contact us at contact@addock.co).

Errors

The errors returned by the API use the API Problem standard, so all errors have the same structure, for example.

Embeddedd resources

When you send a GET request, you can ask to API to add specifics informations. Availables informations are specified for each Object.

For that, you need to add &embed=<resource1>,<resource2> at the end of your request.

Addresses 2

This section lists requests about addresses

Query
Key Value Description
access_token {token} company's token
Response
Get addresses | Code: 200
{ "_embedded": { "addresses": [ { "address1": "1", "address2": "Rue test", "city": "Paris", "country": "France", "externalPlatform": null, "externalPlatformItemId": null, "latitude": 48.8534, "longitude": 2.3488, "publicMetadata": null, "state": "Île-de-France", "timezone": "Europe/Paris", "zipCode": "75001", "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/addresses?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/addresses?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/addresses?page=1" } }, "pageCount": 1, "pageSize": 12, "totalItems": 1, "page": 1 }
Query
Key Value Description
access_token {token} company's token
Response
Get address | Code: 200
{ "address1": "1", "address2": "Rue test", "city": "Paris", "country": "France", "externalPlatform": null, "externalPlatformItemId": null, "latitude": 48.8534, "longitude": 2.3488, "publicMetadata": null, "state": "Île-de-France", "timezone": "Europe/Paris", "zipCode": "75001", "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" } } }

Bookings 8

This section lists requests about bookings

Embedded resources :

associated_bookings

booking_linked

beneficiary

commissions

order

merchant

product

promo_code_generated

promo_codes

term_cancel

time_ranges

Description

Request to get all bookings of connected company

Query
Key Value Description
access_token {token} company's token
Response
Get bookings | Code: 200
{ "_embedded": { "bookings": [ { "associatedBookings": null, "balance": 100, "beneficiary": null, "beneficiaryEmailHasBeenSent": false, "beneficiaryMessage": null, "beneficiarySaved": null, "bookingLinked": null, "calledForBalance": null, "calledForBalanceOn": null, "cancelDate": null, "cancellationName": null, "cancellationRefundAmount": null, "cancellationRefundIncludesTax": null, "cancellationRefundNature": null, "cancellationRefundType": null, "cancellationStartDate": null, "cancellationStartDateUnit": null, "cancelReason": null, "discount": null, "discountDetails": null, "discountType": null, "downPayment": 50, "downPaymentCancelled": null, "downPaymentValidated": null, "externalPlatform": null, "externalPlatformItemId": null, "formsFilled": false, "note": "note", "openTicket": false, "order": null, "participants": null, "paysOnArrival": false, "privatized": false, "productPriceHt": 27.27, "productTax": 30, "productTotalTaxExcluded": 54.55, "promoCodeGenerated": null, "publicMetadata": null, "qrcode": "", "quantity": 2, "reference": "NPQZF50", "refundAmount": null, "startTime": "2016-04-03T07:20:00.000Z", "status": "DRAFT", "tax": 10, "taxAmount": 5.454546, "termCancel": null, "timeRanges": null, "token": "axPtyJVPhkgrHYpG", "totalPriceHt": 87.88, "totalTax": 100, "unitQuantityDeclarations": null, "updateDate": null, "creationDate": "2016-04-03T06:35:36+02:00", "id": 550, "_embedded": { "commissionsAmounts": { "bank": null, "activity": "2.50", "reseller": null }, "promoCodes": [] }, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1" }, "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/bookings/550" } } }, { "associatedBookings": null, "balance": 0, "beneficiary": null, "beneficiaryEmailHasBeenSent": false, "beneficiaryMessage": null, "beneficiarySaved": null, "bookingLinked": null, "calledForBalance": null, "calledForBalanceOn": null, "cancelDate": null, "cancellationName": null, "cancellationRefundAmount": null, "cancellationRefundIncludesTax": null, "cancellationRefundNature": null, "cancellationRefundType": null, "cancellationStartDate": null, "cancellationStartDateUnit": null, "cancelReason": null, "discount": null, "discountDetails": null, "discountType": null, "downPayment": 20, "downPaymentCancelled": null, "downPaymentValidated": true, "externalPlatform": null, "externalPlatformItemId": null, "formsFilled": false, "note": "note", "openTicket": false, "order": null, "participants": null, "paysOnArrival": false, "privatized": false, "productPriceHt": 18.18, "productTax": 20, "productTotalTaxExcluded": 36.36, "promoCodeGenerated": null, "publicMetadata": null, "qrcode": "", "quantity": 2, "reference": "MJDEK74", "refundAmount": null, "startTime": "2016-04-12T18:00:00.000Z", "status": "BOOKED", "tax": 10, "taxAmount": 3.636364, "termCancel": null, "timeRanges": null, "token": "RTFAzTg5YScgiMTP", "totalPriceHt": 36.36, "totalTax": 40, "unitQuantityDeclarations": null, "updateDate": null, "creationDate": "2016-04-05T19:07:03+02:00", "id": 574, "_embedded": { "commissionsAmounts": { "bank": "0.45", "activity": "2.50", "reseller": null }, "promoCodes": [] }, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/2" }, "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/bookings/574" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/bookings?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/bookings?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/bookings?page=1" } }, "pageCount": 1, "pageSize": 2, "totalItems": 2, "page": 1 }
Description

Request to get a particular booking of company connected

Query
Key Value Description
access_token {token} company's token
Response
Get booking | Code: 200
{ "associatedBookings": null, "balance": 100, "beneficiary": null, "beneficiaryEmailHasBeenSent": false, "beneficiaryMessage": null, "beneficiarySaved": null, "bookingLinked": null, "calledForBalance": null, "calledForBalanceOn": null, "cancelDate": null, "cancellationName": null, "cancellationRefundAmount": null, "cancellationRefundIncludesTax": null, "cancellationRefundNature": null, "cancellationRefundType": null, "cancellationStartDate": null, "cancellationStartDateUnit": null, "cancelReason": null, "discount": null, "discountDetails": null, "discountType": null, "downPayment": 50, "downPaymentCancelled": null, "downPaymentValidated": null, "externalPlatform": null, "externalPlatformItemId": null, "formsFilled": false, "note": "note", "openTicket": false, "order": null, "participants": null, "paysOnArrival": false, "privatized": false, "productPriceHt": 27.27, "productTax": 30, "productTotalTaxExcluded": 54.55, "promoCodeGenerated": null, "publicMetadata": null, "qrcode": "", "quantity": 2, "reference": "NPQZF50", "refundAmount": null, "startTime": "2016-04-03T07:20:00.000Z", "status": "DRAFT", "tax": 10, "taxAmount": 5.454546, "termCancel": null, "timeRanges": null, "token": "axPtyJVPhkgrHYpG", "totalPriceHt": 87.88, "totalTax": 100, "unitQuantityDeclarations": null, "updateDate": null, "creationDate": "2016-04-03T06:35:36+02:00", "id": 550, "_embedded": { "commissionsAmounts": { "bank": null, "activity": "2.50", "reseller": null }, "promoCodes": [] }, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1" }, "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/bookings/550" } } }
Description

Request to get booking’s participant clients data

Query
Key Value Description
access_token {token} company's token
Response
Get booking's participant client data | Code: 200
{ "_embedded": { "clientData": [ { "participantIndex": 2, "clientFormInputTypeSaved": null, "privateMetadata": null, "publicMetadata": null, "user": null, "value": "Jean", "id": 17, "_links": { "booking": { "href": "http://demo-openapi.addk.fr/v1/bookings/53" }, "clientFormInputType": { "href": "http://demo-openapi.addk.fr/v1/client_form_input_types/3" }, "self": { "href": "http://demo-openapi.addk.fr/v1/17" }, "company": { "href": "http://demo-openapi.addk.fr/v1/companies/1" } } }, { "participantIndex": 2, "clientFormInputTypeSaved": null, "privateMetadata": null, "publicMetadata": null, "user": null, "value": "Dupond", "id": 18, "_links": { "booking": { "href": "http://demo-openapi.addk.fr/v1/bookings/53" }, "clientFormInputType": { "href": "http://demo-openapi.addk.fr/v1/client_form_input_types/2" }, "self": { "href": "http://demo-openapi.addk.fr/v1/18" }, "company": { "href": "http://demo-openapi.addk.fr/v1/companies/1" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/bookings/53/client_data?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/bookings/53/client_data?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/bookings/53/client_data?page=1" } }, "pageCount": 1, "pageSize": 12, "totalItems": 2, "page": 1 }
Description

Request to get booking’s participant client form

Query
Key Value Description
access_token {token} company's token
Response
Get booking's participant client form | Code: 200
{ "infoPerParticipant": true, "name": "Bon cadeau", "status": 1, "updateDate": "2018-12-05T20:17:11+01:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 73, "_embedded": { "clientFormFields": [ { "mandatory": true, "id": 124, "_embedded": { "clientFormInputType": { "type": "MERCHANT", "code": null, "inputType": "TEXT", "label": "Numéro du bon cadeau (non obligatoire)", "options": null, "updateDate": "2018-12-05T20:17:11+01:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 28, "_links": { "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/client_form_input_types/1" } } } }, "_links": { "clientForm": { "href": "http://demo-openapi.addk.fr/v1/client_forms/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/client_form_fields/28" } } } ] }, "_links": { "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/client_forms/124" } } }
Description

Request to get booking’s participant client data

Query
Key Value Description
access_token {token} company's token
Response
Get particular booking's participant client data | Code: 200
{ "_embedded": { "clientData": [ { "participantIndex": 2, "clientFormInputTypeSaved": null, "privateMetadata": null, "publicMetadata": null, "user": null, "value": "Jean", "id": 17, "_links": { "booking": { "href": "http://demo-openapi.addk.fr/v1/bookings/1" }, "clientFormInputType": { "href": "http://demo-openapi.addk.fr/v1/client_form_input_types/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/17" }, "company": { "href": "http://demo-openapi.addk.fr/v1/companies/1" } } }, { "participantIndex": 2, "clientFormInputTypeSaved": null, "privateMetadata": null, "publicMetadata": null, "user": null, "value": "Dupond", "id": 18, "_links": { "booking": { "href": "http://demo-openapi.addk.fr/v1/bookings/1" }, "clientFormInputType": { "href": "http://demo-openapi.addk.fr/v1/client_form_input_types/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/18" }, "company": { "href": "http://demo-openapi.addk.fr/v1/companies/1" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/bookings/53/client_data?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/bookings/53/client_data?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/bookings/53/client_data?page=1" } }, "pageCount": 1, "pageSize": 12, "totalItems": 2, "page": 1 }
Headers
Key Value Description
Content-Type application/json
Query
Key Value Description
access_token {token} company's token
Body
{ "bookedFromWidget": 1, "startTime": "2019-01-23T13:00:00.000Z", "company": { "id": 1, "type": "MERCHANT" }, "order": { "id": 1 }, "product": { "id": 1, "type": "CLASSIC" }, "unitQuantityDeclarations": [ { "unit": { "id": 1, "type": "FORFAIT" }, "quantity": 2 } ] }
Response
Post Request with forfait unit | Code: 201
{ "associatedBookings": null, "balance": 49.9999995, "beneficiary": null, "beneficiaryEmailHasBeenSent": false, "beneficiaryMessage": null, "beneficiarySaved": null, "bookingLinked": null, "calledForBalance": false, "calledForBalanceOn": null, "cancelDate": null, "cancellationName": null, "cancellationRefundAmount": null, "cancellationRefundIncludesTax": null, "cancellationRefundNature": null, "cancellationRefundType": null, "cancellationStartDate": null, "cancellationStartDateUnit": null, "cancelReason": null, "discount": null, "discountDetails": null, "discountType": null, "downPayment": null, "downPaymentCancelled": null, "downPaymentValidated": null, "externalPlatform": null, "externalPlatformItemId": null, "formsFilled": false, "note": null, "openTicket": false, "participants": null, "paysOnArrival": false, "privatized": false, "productPriceHt": 45.454545, "productTax": 49.9999995, "productTotalTaxExcluded": 45.454545, "promoCodeGenerated": null, "promoCodes": null, "publicMetadata": null, "qrcode": "5352682313543", "quantity": 2, "reference": "DLZAM", "refundAmount": null, "startTime": "2019-01-23T13:00:00.000Z", "status": "DRAFT", "tax": 10, "taxAmount": 4.5454545, "termCancel": null, "token": "0KwQD1dfQiNLJW8q", "totalPriceHt": 45.454545, "totalTax": 49.9999995, "updateDate": "2019-01-23T14:16:28+01:00", "creationDate": "2019-01-23T14:16:27+01:00", "id": 98602, "_embedded": { "product": { "type": "CLASSIC", "activityDuration": 1800, "availableFromDate": null, "availableToDate": null, "barCode": null, "bookingManagement": "MANUAL", "bookingManagementManualLimit": null, "canBePrivatized": false, "color": "#ff0000", "delayBeforeBooking": 7200, "delayBetweenBooking": 0, "delayBetweenSessions": false, "description": "description", "directSales": true, "discount": null, "displayedStartingPrice": 50, "externalPlatform": null, "externalPlatformItemId": null, "images": null, "information": null, "marketplaceSales": true, "materialCombined": true, "maxParticipants": 86, "minBookings": 0, "minParticipants": 1, "minParticipantsToPrivatize": 0, "mostAttractiveDiscount": null, "name": "Transfert Court", "partnerSales": false, "prices": null, "pricingType": 1, "primaryImage": null, "publicMetadata": null, "reference": "Transfert Court", "reservationShowAvailabilityLeft": false, "scheduleType": "SHOP_HOURS", "sellingTarget": "PROFESSIONAL", "status": "PUBLISHED", "summary": "summary", "updateDate": null, "validityDuration": null, "webSales": false, "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_embedded": { "extraProducts": [], "productUnitResources": [], "giftProducts": [], "tags": [] }, "_links": { "subCategory": { "href": "http://demo-openapi.addk.fr/v1/product_sub_categories/1" }, "unit": { "href": "http://demo-openapi.addk.fr/v1/units/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/products/1" }, "tax": { "href": "http://demo-openapi.addk.fr/v1/taxes/1" }, "category": { "href": "http://demo-openapi.addk.fr/v1/product_categories/1" } } }, "commissionsAmounts": { "bank": 0.8999999910000002, "activity": 1.4545454400000002, "bank_fix": 0.25, "reseller": 0 }, "timeRanges": [ { "endTime": "2019-01-23T13:30:00.000Z", "sessionIndex": 1, "startTime": "2019-01-23T13:00:00.000Z", "status": null, "id": 1, "_embedded": { "unitQuantities": [ { "externalPlatform": null, "externalPlatformItemId": null, "priceHt": 45.454545, "publicMetadata": null, "quantity": 2, "sessionQuantity": 2, "tax": 10, "taxAmount": 4.5454545, "totalTaxExcluded": 45.454545, "id": 44243, "_embedded": { "unit": { "type": "FORFAIT", "name": "Personne(s)", "publicMetadata": null, "updateDate": "2018-12-05T20:17:11+01:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/units/1" } } }, "unitSaved": { "type": "FORFAIT", "name": "Personne(s)", "publicMetadata": null, "updateDate": "2018-12-05T20:17:11+01:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/units/1" } } }, "resources": [] }, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/booking_unit_quantites/44243" }, "bookingTimeRange": { "href": "http://demo-openapi.addk.fr/v1/booking_time_ranges/1" } } } ] }, "_links": { "booking": { "href": "http://demo-openapi.addk.fr/v1/bookings/98602" }, "self": { "href": "http://demo-openapi.addk.fr/v1/booking_time_ranges/1" } } } ], "unitQuantityDeclarations": [ { "metadata": null, "numberOfSessions": null, "quantity": 2, "id": null, "_links": { "unit": { "href": "http://demo-openapi.addk.fr/v1/units/9178" } } } ], "merchant": { "type": "MERCHANT", "activities": null, "active": true, "activityDescription": "activityDescription", "activityOther": "activityOther", "emailContact": "emailContact", "landLinePhone": "+landLinePhone", "languages": null, "mobilePhone": "+mobilePhone", "name": "name", "requestLimitRules": null, "taxes": null, "url": "url", "updateDate": "2018-12-05T20:17:11+01:00", "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_embedded": { "logo": { "product": null, "externalPlatform": null, "externalPlatformItemId": null, "privateMetadata": null, "publicMetadata": null, "updateDate": null, "title": null, "primary": null, "creationDate": null, "id": null, "_embedded": { "files": [ { "name": "ORIG", "path": "uploads/merchant-company/profile/1/logo/LOGO.PNG", "url": null, "id": "1918653f-a773-4b07-b051-78d31da8792a", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/1918653f-a773-4b07-b051-78d31da8792a" } } }, { "name": "200x200", "path": "uploads/merchant-company/profile/1/logo/200x200-LOGO.PNG", "url": null, "id": "e5bd47fc-7971-4b1e-91b7-5f0ef02c039c", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/e5bd47fc-7971-4b1e-91b7-5f0ef02c039c" } } } ] } } }, "_links": { "country": { "href": "http://demo-openapi.addk.fr/v1/countries/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "defaultLanguage": { "href": "http://demo-openapi.addk.fr/v1/languages/1" }, "defaultCurrency": { "href": "http://demo-openapi.addk.fr/v1/currencies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "legalForm": { "href": "http://demo-openapi.addk.fr/v1/legal_forms/1" } } }, "order": { "balance": 50, "bookings": null, "directSale": null, "externalPlatform": null, "externalPlatformItemId": null, "locale": "fr", "note": null, "origin": "OPEN_API", "promoCodes": null, "publicMetadata": { "timeoutElapsed": false }, "qrCode": "1176765510708", "reference": "ZKDOIVQVPYKX", "shopSession": null, "shopTicket": null, "status": "DRAFT", "totalDownPayment": null, "totalPrice": 50, "totalPriceHt": 45.45, "updateDate": "2019-01-23T14:16:28+01:00", "user": null, "userSaved": null, "creationDate": "2019-01-23T13:09:37+01:00", "id": 1, "_links": { "companySaved": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/orders/1" }, "company": { "href": "http://demo-openapi.addk.fr/v1/companies/1" } } } }, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/bookings/98602" } } }
Headers
Key Value Description
Content-Type application/json
Query
Key Value Description
access_token {token} company's token
Body
{ "bookedFromWidget": 1, "startTime": "2019-01-23T13:00:00.000Z", "company": { "id": 1, "type": "MERCHANT" }, "order": { "id": 1 }, "product": { "id": 1, "type": "CLASSIC" }, "unitQuantityDeclarations": [ { "unit": { "id": 2, "type": "TARGET" }, "quantity": 1 }, { "unit": { "id": 1, "type": "MAIN" }, "quantity": 2 } ] }
Response
Post Request with target units | Code: 201
{ "associatedBookings": null, "balance": 99.999999, "beneficiary": null, "beneficiaryEmailHasBeenSent": false, "beneficiaryMessage": null, "beneficiarySaved": null, "bookingLinked": null, "calledForBalance": false, "calledForBalanceOn": null, "cancelDate": null, "cancellationName": null, "cancellationRefundAmount": null, "cancellationRefundIncludesTax": null, "cancellationRefundNature": null, "cancellationRefundType": null, "cancellationStartDate": null, "cancellationStartDateUnit": null, "cancelReason": null, "discount": null, "discountDetails": null, "discountType": null, "downPayment": null, "downPaymentCancelled": null, "downPaymentValidated": null, "externalPlatform": null, "externalPlatformItemId": null, "formsFilled": false, "note": null, "openTicket": false, "participants": null, "paysOnArrival": false, "privatized": false, "productPriceHt": 45.454545, "productTax": 99.999999, "productTotalTaxExcluded": 90.90909, "promoCodeGenerated": null, "promoCodes": null, "publicMetadata": null, "qrcode": "8067904570712", "quantity": 3, "reference": "BKVTO", "refundAmount": null, "startTime": "2019-01-23T13:00:00.000Z", "status": "DRAFT", "tax": 10, "taxAmount": 9.090909, "termCancel": null, "token": "zCLC7xTGKomxReb1", "totalPriceHt": 90.90909, "totalTax": 99.999999, "updateDate": "2019-01-23T14:36:30+01:00", "creationDate": "2019-01-23T14:36:29+01:00", "id": 98603, "_embedded": { "product": { "type": "CLASSIC", "activityDuration": 1800, "availableFromDate": null, "availableToDate": null, "barCode": null, "bookingManagement": "MANUAL", "bookingManagementManualLimit": null, "canBePrivatized": false, "color": "#ff0000", "delayBeforeBooking": 7200, "delayBetweenBooking": 0, "delayBetweenSessions": false, "description": "description", "directSales": true, "discount": null, "displayedStartingPrice": 50, "externalPlatform": null, "externalPlatformItemId": null, "images": null, "information": null, "marketplaceSales": true, "materialCombined": true, "maxParticipants": 86, "minBookings": 0, "minParticipants": 1, "minParticipantsToPrivatize": 0, "mostAttractiveDiscount": null, "name": "Transfert Court", "partnerSales": false, "prices": null, "pricingType": 1, "primaryImage": null, "publicMetadata": null, "reference": "Transfert Court", "reservationShowAvailabilityLeft": false, "scheduleType": "SHOP_HOURS", "sellingTarget": "PROFESSIONAL", "status": "PUBLISHED", "summary": "summary", "updateDate": null, "validityDuration": null, "webSales": false, "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_embedded": { "extraProducts": [], "productUnitResources": [], "giftProducts": [], "tags": [] }, "_links": { "subCategory": { "href": "http://demo-openapi.addk.fr/v1/product_sub_categories/1" }, "unit": { "href": "http://demo-openapi.addk.fr/v1/units/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/products/1" }, "tax": { "href": "http://demo-openapi.addk.fr/v1/taxes/1" }, "category": { "href": "http://demo-openapi.addk.fr/v1/product_categories/1" } } }, "commissionsAmounts": { "bank": 1.7999999820000003, "activity": 2.9090908800000004, "bank_fix": 0.25, "reseller": 0 }, "timeRanges": [ { "endTime": "2019-01-23T13:30:00.000Z", "sessionIndex": 1, "startTime": "2019-01-23T13:00:00.000Z", "status": null, "id": 1, "_embedded": { "unitQuantities": [ { "externalPlatform": null, "externalPlatformItemId": null, "priceHt": 45.454545, "publicMetadata": null, "quantity": 1, "sessionQuantity": 1, "tax": 10, "taxAmount": 4.5454545, "totalTaxExcluded": 45.454545, "id": 44244, "_embedded": { "unit": { "type": "MAIN", "name": "name", "publicMetadata": null, "updateDate": "2018-12-05T20:17:11+01:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 2, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/units/2" } } }, "unitSaved": { "type": "MAIN", "name": "name", "publicMetadata": null, "updateDate": "2018-12-05T20:17:11+01:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/units/1" } } }, "resources": [] }, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/booking_unit_quantites/1" }, "bookingTimeRange": { "href": "http://demo-openapi.addk.fr/v1/booking_time_ranges/1" } } }, { "externalPlatform": null, "externalPlatformItemId": null, "priceHt": 45.454545, "publicMetadata": null, "quantity": 2, "sessionQuantity": 2, "tax": 10, "taxAmount": 4.5454545, "totalTaxExcluded": 45.454545, "id": 1, "_embedded": { "unit": { "type": "FORFAIT", "name": "Personne(s)", "publicMetadata": null, "updateDate": "2018-12-05T20:17:11+01:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/units/1" } } }, "unitSaved": { "type": "FORFAIT", "name": "Personne(s)", "publicMetadata": null, "updateDate": "2018-12-05T20:17:11+01:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/units/1" } } }, "resources": [] }, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/booking_unit_quantites/1" }, "bookingTimeRange": { "href": "http://demo-openapi.addk.fr/v1/booking_time_ranges/1" } } } ] }, "_links": { "booking": { "href": "http://demo-openapi.addk.fr/v1/bookings/98603" }, "self": { "href": "http://demo-openapi.addk.fr/v1/booking_time_ranges/1" } } } ], "unitQuantityDeclarations": [ { "metadata": null, "numberOfSessions": null, "quantity": 1, "id": null, "_links": { "unit": { "href": "http://demo-openapi.addk.fr/v1/units/1" } } }, { "metadata": null, "numberOfSessions": null, "quantity": 2, "id": null, "_links": { "unit": { "href": "http://demo-openapi.addk.fr/v1/units/1" } } } ], "merchant": { "type": "MERCHANT", "activities": null, "active": true, "activityDescription": "activityDescription", "activityOther": "activityOther", "emailContact": "emailContact", "landLinePhone": "+landLinePhone", "languages": null, "mobilePhone": "+mobilePhone", "name": "name", "requestLimitRules": null, "taxes": null, "url": "url", "updateDate": "2018-12-05T20:17:11+01:00", "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_embedded": { "logo": { "product": null, "externalPlatform": null, "externalPlatformItemId": null, "privateMetadata": null, "publicMetadata": null, "updateDate": null, "title": null, "primary": null, "creationDate": null, "id": null, "_embedded": { "files": [ { "name": "ORIG", "path": "uploads/merchant-company/profile/1/logo/LOGO.PNG", "url": null, "id": "7411b6e1-522b-49df-86e1-30ccb1f2b76e", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/7411b6e1-522b-49df-86e1-30ccb1f2b76e" } } }, { "name": "200x200", "path": "uploads/merchant-company/profile/1/logo/200x200-LOGO.PNG", "url": null, "id": "f3b706c1-29c5-4bdb-9c95-f30ad24675bd", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/f3b706c1-29c5-4bdb-9c95-f30ad24675bd" } } } ] } } }, "_links": { "country": { "href": "http://demo-openapi.addk.fr/v1/countries/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "defaultLanguage": { "href": "http://demo-openapi.addk.fr/v1/languages/1" }, "defaultCurrency": { "href": "http://demo-openapi.addk.fr/v1/currencies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "legalForm": { "href": "http://demo-openapi.addk.fr/v1/legal_forms/1" } } }, "order": { "balance": 100, "bookings": null, "directSale": null, "externalPlatform": null, "externalPlatformItemId": null, "locale": "fr", "note": null, "origin": "MYPAGE", "promoCodes": null, "publicMetadata": { "timeoutElapsed": false }, "qrCode": "4469486372522", "reference": "YUGLCJAPQPCC", "shopSession": null, "shopTicket": null, "status": "DRAFT", "totalDownPayment": null, "totalPrice": 100, "totalPriceHt": 90.91, "updateDate": "2019-01-23T14:36:30+01:00", "user": null, "userSaved": null, "creationDate": "2019-01-23T13:09:59+01:00", "id": 1, "_links": { "companySaved": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/orders/1" }, "company": { "href": "http://demo-openapi.addk.fr/v1/companies/1" } } } }, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/bookings/98603" } } }
Headers
Key Value Description
Content-Type application/json
Query
Key Value Description
access_token {token} company's token
Body
{ "bookedFromWidget": 1, "startTime": "2019-01-23T13:00:00.000Z", "company": { "id": 1, "type": "MERCHANT" }, "order": { "id": 1 }, "product": { "id": 1, "type": "CLASSIC" }, "unitQuantityDeclarations": [ { "unit": { "id": 1, "type": "SESSION" }, "quantity": 5 } ] }
Response
Post Request with session unit | Code: 201
{ "associatedBookings": null, "balance": 49.9999995, "beneficiary": null, "beneficiaryEmailHasBeenSent": false, "beneficiaryMessage": null, "beneficiarySaved": null, "bookingLinked": null, "calledForBalance": false, "calledForBalanceOn": null, "cancelDate": null, "cancellationName": null, "cancellationRefundAmount": null, "cancellationRefundIncludesTax": null, "cancellationRefundNature": null, "cancellationRefundType": null, "cancellationStartDate": null, "cancellationStartDateUnit": null, "cancelReason": null, "discount": null, "discountDetails": null, "discountType": null, "downPayment": null, "downPaymentCancelled": null, "downPaymentValidated": null, "externalPlatform": null, "externalPlatformItemId": null, "formsFilled": false, "note": null, "openTicket": false, "participants": null, "paysOnArrival": false, "privatized": false, "productPriceHt": 45.454545, "productTax": 49.9999995, "productTotalTaxExcluded": 45.454545, "promoCodeGenerated": null, "promoCodes": null, "publicMetadata": null, "qrcode": "8669698177827", "quantity": 5, "reference": "JYZZP", "refundAmount": null, "startTime": "2019-01-23T13:00:00.000Z", "status": "DRAFT", "tax": 10, "taxAmount": 4.5454545, "termCancel": null, "token": "R7s0iHvU7qaLXxwY", "totalPriceHt": 45.454545, "totalTax": 49.9999995, "updateDate": "2019-01-23T14:39:37+01:00", "creationDate": "2019-01-23T14:39:31+01:00", "id": 98604, "_embedded": { "product": { "type": "CLASSIC", "activityDuration": 1800, "availableFromDate": null, "availableToDate": null, "barCode": null, "bookingManagement": "MANUAL", "bookingManagementManualLimit": null, "canBePrivatized": false, "color": "#ff0000", "delayBeforeBooking": 7200, "delayBetweenBooking": 0, "delayBetweenSessions": false, "description": "description", "directSales": true, "discount": null, "displayedStartingPrice": 50, "externalPlatform": null, "externalPlatformItemId": null, "images": null, "information": null, "marketplaceSales": true, "materialCombined": true, "maxParticipants": 86, "minBookings": 0, "minParticipants": 1, "minParticipantsToPrivatize": 0, "mostAttractiveDiscount": null, "name": "Transfert Court", "partnerSales": false, "prices": null, "pricingType": 1, "primaryImage": null, "publicMetadata": null, "reference": "Transfert Court", "reservationShowAvailabilityLeft": false, "scheduleType": "SHOP_HOURS", "sellingTarget": "PROFESSIONAL", "status": "PUBLISHED", "summary": "summary", "updateDate": null, "validityDuration": null, "webSales": false, "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1010, "_embedded": { "extraProducts": [], "productUnitResources": [], "giftProducts": [], "tags": [] }, "_links": { "subCategory": { "href": "http://demo-openapi.addk.fr/v1/product_sub_categories/1" }, "unit": { "href": "http://demo-openapi.addk.fr/v1/units/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/products/1" }, "tax": { "href": "http://demo-openapi.addk.fr/v1/taxes/1" }, "category": { "href": "http://demo-openapi.addk.fr/v1/product_categories/1" } } }, "commissionsAmounts": { "bank": 0.8999999910000002, "activity": 1.4545454400000002, "bank_fix": 0.25, "reseller": 0 }, "timeRanges": [ { "endTime": "2019-01-23T13:30:00.000Z", "sessionIndex": 1, "startTime": "2019-01-23T13:00:00.000Z", "status": null, "id": 1, "_embedded": { "unitQuantities": [ { "externalPlatform": null, "externalPlatformItemId": null, "priceHt": 45.454545, "publicMetadata": null, "quantity": 5, "sessionQuantity": 5, "tax": 10, "taxAmount": 4.5454545, "totalTaxExcluded": 45.454545, "id": 1, "_embedded": { "unit": { "type": "FORFAIT", "name": "Personne(s)", "publicMetadata": null, "updateDate": "2018-12-05T20:17:11+01:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/units/1" } } }, "unitSaved": { "type": "FORFAIT", "name": "Personne(s)", "publicMetadata": null, "updateDate": "2018-12-05T20:17:11+01:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/units/1" } } }, "resources": [] }, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/booking_unit_quantites/1" }, "bookingTimeRange": { "href": "http://demo-openapi.addk.fr/v1/booking_time_ranges/1" } } } ] }, "_links": { "booking": { "href": "http://demo-openapi.addk.fr/v1/bookings/98604" }, "self": { "href": "http://demo-openapi.addk.fr/v1/booking_time_ranges/1" } } } ], "unitQuantityDeclarations": [ { "metadata": null, "numberOfSessions": null, "quantity": 5, "id": null, "_links": { "unit": { "href": "http://demo-openapi.addk.fr/v1/units/1" } } } ], "merchant": { "type": "MERCHANT", "activities": null, "active": true, "activityDescription": "activityDescription", "activityOther": "activityOther", "emailContact": "emailContact", "landLinePhone": "+landLinePhone", "languages": null, "mobilePhone": "+mobilePhone", "name": "name", "requestLimitRules": null, "taxes": null, "url": "url", "updateDate": "2018-12-05T20:17:11+01:00", "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_embedded": { "logo": { "product": null, "externalPlatform": null, "externalPlatformItemId": null, "privateMetadata": null, "publicMetadata": null, "updateDate": null, "title": null, "primary": null, "creationDate": null, "id": null, "_embedded": { "files": [ { "name": "ORIG", "path": "uploads/merchant-company/profile/1/logo/LOGO.PNG", "url": null, "id": "3df527a7-5bfb-4193-b02b-e847fc94f6e4", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/3df527a7-5bfb-4193-b02b-e847fc94f6e4" } } }, { "name": "200x200", "path": "uploads/merchant-company/profile/1/logo/200x200-LOGO.PNG", "url": null, "id": "c93da315-cd7c-422c-9761-f9e0bce04d76", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/c93da315-cd7c-422c-9761-f9e0bce04d76" } } } ] } } }, "_links": { "country": { "href": "http://demo-openapi.addk.fr/v1/countries/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "defaultLanguage": { "href": "http://demo-openapi.addk.fr/v1/languages/1" }, "defaultCurrency": { "href": "http://demo-openapi.addk.fr/v1/currencies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "legalForm": { "href": "http://demo-openapi.addk.fr/v1/legal_forms/1" } } }, "order": { "balance": 50, "bookings": null, "directSale": null, "externalPlatform": null, "externalPlatformItemId": null, "locale": "fr", "note": null, "origin": "OPEN_API", "promoCodes": null, "publicMetadata": { "timeoutElapsed": false }, "qrCode": "6591247848078", "reference": "QZFDBKAUAPHK", "shopSession": null, "shopTicket": null, "status": "DRAFT", "totalDownPayment": null, "totalPrice": 50, "totalPriceHt": 45.45, "updateDate": "2019-01-23T14:39:37+01:00", "creationDate": "2019-01-23T13:10:35+01:00", "id": 53955, "_embedded": { "userSaved": { "active": true, "address": null, "birthday": null, "clientDataList": null, "email": "email", "emailVerified": true, "firstName": "firstName", "lastConnection": "2019-01-08T15:40:25.000Z", "lastName": "lastName", "phone": null, "privateMetadata": null, "publicMetadata": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/users/1" }, "language": { "href": "http://demo-openapi.addk.fr/v1/languages/1" } } } }, "_links": { "companySaved": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/orders/1" }, "company": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "user": { "href": "http://demo-openapi.addk.fr/v1/users/1" } } } }, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/bookings/98604" } } }

Companies 2

This section lists requests about companies

Embedded resources :

activities

address

country

default_currency

default_language

languages

legal_form

reseller_type

tax

translations

Query
Key Value Description
access_token {token} company's token
Response
Get companies | Code: 200
{ "_embedded": { "companies": [ { "type": "MERCHANT", "activities": null, "active": true, "activityDescription": "activityDescription", "emailContact": "emailContact@yopmail.com", "landLinePhone": "+330123456789", "languages": null, "mobilePhone": "+330123456789", "name": "name", "requestLimitRules": null, "taxes": null, "url": "http://url", "updateDate": "2018-09-11T12:19:40+02:00", "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_embedded": { "logo": { "product": null, "externalPlatform": null, "externalPlatformItemId": null, "privateMetadata": null, "publicMetadata": null, "updateDate": null, "title": null, "primary": null, "creationDate": null, "id": null, "_embedded": { "files": [ { "name": "ORIG", "path": "uploads/merchant-company/profile/1/logo/20170718596db415afab3.PNG", "url": null, "id": "05383463-f0e0-48b9-9e23-ceb5e04a95bd", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/05383463-f0e0-48b9-9e23-ceb5e04a95bd" } } }, { "name": "200x200", "path": "uploads/merchant-company/profile/1/logo/200x200-20170718596db415afab3.PNG", "url": null, "id": "731626f5-98aa-448b-ae8a-e94d45c074ce", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/731626f5-98aa-448b-ae8a-e94d45c074ce" } } } ] } } }, "_links": { "country": { "href": "http://demo-openapi.addk.fr/v1/countries/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "defaultLanguage": { "href": "http://demo-openapi.addk.fr/v1/languages/1" }, "defaultCurrency": { "href": "http://demo-openapi.addk.fr/v1/currencies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "legalForm": { "href": "http://demo-openapi.addk.fr/v1/legal_forms/1" } } }, { "type": "RESELLER", "active": true, "activityDescription": "activityDescription2", "emailContact": "email2@yopmail.com", "landLinePhone": "+330223456789", "languages": null, "mobilePhone": "+33171182572", "name": "name2", "requestLimitRules": null, "taxes": null, "url": "http://url2/", "updateDate": "2018-09-11T12:19:40+02:00", "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1159, "_embedded": { "resellerType": { "name": null, "parent": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/1" } } }, "logo": { "product": null, "externalPlatform": null, "externalPlatformItemId": null, "privateMetadata": null, "publicMetadata": null, "updateDate": null, "title": null, "primary": null, "creationDate": null, "id": null, "_embedded": { "files": [ { "name": "ORIG", "path": "uploads/reseller-company/profile/2/logo/EVJFlogo.jpg", "url": null, "id": "b35c3939-bbfd-447a-ab4e-5955316beec5", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/b35c3939-bbfd-447a-ab4e-5955316beec5" } } }, { "name": "200x200", "path": "uploads/reseller-company/profile/2/logo/200x200-EVJFlogo.jpg", "url": null, "id": "2ce534c8-7b2f-407e-a67d-2a299dc59bb8", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/2ce534c8-7b2f-407e-a67d-2a299dc59bb8" } } } ] } } }, "_links": { "country": { "href": "http://demo-openapi.addk.fr/v1/countries/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/2" }, "defaultLanguage": { "href": "http://demo-openapi.addk.fr/v1/languages/1" }, "defaultCurrency": { "href": "http://demo-openapi.addk.fr/v1/currencies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/companies/2" }, "legalForm": { "href": "http://demo-openapi.addk.fr/v1/legal_forms/2" } } }, { "type": "RESELLER", "active": true, "activityDescription": "dsl dsqjd ljsqmdlkjsq lkdjsq kljdsqklj dklsqj dklsqjdklsqj kldqjskldj sqlkjdsqkljdksqml", "activityOther": null, "emailContact": "toto@toto.fr", "landLinePhone": null, "languages": null, "mobilePhone": "+33612891232", "name": "Test JK", "requestLimitRules": null, "taxes": null, "url": "http://www.yolo.com", "updateDate": "2018-11-13T15:09:04+01:00", "defaultLanguageCode": "fr", "translationLanguageCode": "fr", "translations": null, "id": 1219, "_embedded": { "resellerType": { "name": null, "parent": null, "id": 8, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/8" } } }, "logo": { "product": null, "externalPlatform": null, "externalPlatformItemId": null, "privateMetadata": null, "publicMetadata": null, "updateDate": null, "title": null, "primary": null, "creationDate": null, "id": null, "_embedded": { "files": [] } } }, "_links": { "country": { "href": "http://demo-openapi.addk.fr/v1/countries/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/3" }, "defaultLanguage": { "href": "http://demo-openapi.addk.fr/v1/languages/1" }, "defaultCurrency": { "href": "http://demo-openapi.addk.fr/v1/currencies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/companies/3" }, "legalForm": { "href": "http://demo-openapi.addk.fr/v1/legal_forms/1" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/companies/1/companies?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/companies/1/companies?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/companies/1/companies?page=1" } }, "pageCount": 1, "pageSize": 12, "totalItems": 3, "page": 1 }
Query
Key Value Description
access_token {token} company's token
Response
Get company | Code: 200
{ "type": "RESELLER", "active": true, "activityDescription": "activityDescription2", "emailContact": "email2@yopmail.com", "landLinePhone": "+330223456789", "languages": null, "mobilePhone": "+33171182572", "name": "name2", "requestLimitRules": null, "taxes": null, "url": "http://url2/", "updateDate": "2018-09-11T12:19:40+02:00", "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1159, "_embedded": { "resellerType": { "name": null, "parent": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/1" } } }, "logo": { "product": null, "externalPlatform": null, "externalPlatformItemId": null, "privateMetadata": null, "publicMetadata": null, "updateDate": null, "title": null, "primary": null, "creationDate": null, "id": null, "_embedded": { "files": [ { "name": "ORIG", "path": "uploads/reseller-company/profile/2/logo/EVJFlogo.jpg", "url": null, "id": "b35c3939-bbfd-447a-ab4e-5955316beec5", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/b35c3939-bbfd-447a-ab4e-5955316beec5" } } }, { "name": "200x200", "path": "uploads/reseller-company/profile/2/logo/200x200-EVJFlogo.jpg", "url": null, "id": "2ce534c8-7b2f-407e-a67d-2a299dc59bb8", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/2ce534c8-7b2f-407e-a67d-2a299dc59bb8" } } } ] } } }, "_links": { "country": { "href": "http://demo-openapi.addk.fr/v1/countries/73" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/841" }, "defaultLanguage": { "href": "http://demo-openapi.addk.fr/v1/languages/2" }, "defaultCurrency": { "href": "http://demo-openapi.addk.fr/v1/currencies/2" }, "self": { "href": "http://demo-openapi.addk.fr/v1/companies/1159" }, "legalForm": { "href": "http://demo-openapi.addk.fr/v1/legal_forms/3" } } }

Infos 1

You get informations about the company connected with the token.

Query
Key Value Description
access_token {token} company's token
Response
Get Infos | Code: 200
{ "type": "MERCHANT", "activities": null, "active": true, "activityDescription": "activity description.", "activityOther": "activity other.", "emailContact": "example@mail.com", "landLinePhone": "+33123456789", "languages": null, "mobilePhone": "+33123456789", "name": "Kanoak", "requestLimitRules": null, "taxes": null, "url": "http://www.company.fr", "updateDate": "2018-12-05T20:17:11+01:00", "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_embedded": { "logo": { "product": null, "externalPlatform": null, "externalPlatformItemId": null, "privateMetadata": null, "publicMetadata": null, "updateDate": null, "title": null, "primary": null, "creationDate": null, "id": null, "_embedded": { "files": [ { "name": "ORIG", "path": "uploads/merchant-company/profile/1/logo/image.PNG", "url": null, "id": "c9bcd00b-96b3-49e9-a0d0-045643ba6836", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/c9bcd00b-96b3-49e9-a0d0-045643ba6836" } } }, { "name": "200x200", "path": "uploads/merchant-company/profile/1/logo/200x200-20170718596db415afab3.PNG", "url": null, "id": "11aedd4b-5308-44d7-90e5-93760253d608", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/11aedd4b-5308-44d7-90e5-93760253d608" } } } ] } } }, "_links": { "country": { "href": "http://demo-openapi.addk.fr/v1/countries/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "defaultLanguage": { "href": "http://demo-openapi.addk.fr/v1/languages/1" }, "defaultCurrency": { "href": "http://demo-openapi.addk.fr/v1/currencies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "legalForm": { "href": "http://demo-openapi.addk.fr/v1/legal_forms/1" } } }

Languages 2

This section lists requests about languages

Description

List all languages availables for the connected company

Query
Key Value Description
access_token e89abf88-4428-4087-bb68-228bcc9cdb21
Response
Get languages | Code: 200
{ "_embedded": { "languages": [ { "active": true, "dateFormat": "d/m/Y", "dateTimeFormat": "d/m/Y H:i:s", "isoCode": "en-GB", "locale": "en", "name": "English", "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/languages/1" } } }, { "active": true, "dateFormat": "m/d/Y", "dateTimeFormat": "m/d/Y H:i:s", "isoCode": "fr-FR", "locale": "fr", "name": "Français", "id": 2, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/languages/2" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/languages?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/languages?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/languages?page=1" } }, "pageCount": 1, "pageSize": 12, "totalItems": 2, "page": 1 }
Description

Get a particular language

Query
Key Value Description
access_token e89abf88-4428-4087-bb68-228bcc9cdb21
Response
Get language | Code: 200
{ "active": true, "dateFormat": "m/d/Y", "dateTimeFormat": "m/d/Y H:i:s", "isoCode": "fr-FR", "locale": "fr", "name": "Français", "id": 2, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/languages/2" } } }

Orders 11

This section lists requests about orders

Embedded resources :

company

user

bookings

bookings_product

bookings_product_images

bookings_time_ranges

promo_codes

Description

Request to get all orders of connected company

Query
Key Value Description
access_token {token} company's token
Response
Get orders | Code: 200
{ "_embedded": { "orders": [ { "balance": 115, "bookings": null, "directSale": null, "externalPlatform": null, "externalPlatformItemId": null, "locale": "fr", "note": null, "origin": "WIDGET", "promoCodes": null, "publicMetadata": null, "qrCode": "", "reference": "FQKDRZAMINCB", "shopSession": null, "shopTicket": null, "status": "USER_FILLED", "totalDownPayment": 0, "totalPrice": 115, "totalPriceHt": 101.52, "updateDate": "2016-07-17T19:28:24+02:00", "creationDate": "2016-07-17T19:27:52+02:00", "id": 1, "_embedded": { "userSaved": { "active": false, "address": null, "birthday": null, "clientDataList": null, "email": "email", "emailVerified": true, "firstName": "firstName", "language": null, "lastConnection": null, "lastName": "phone", "phone": "0782818130", "privateMetadata": null, "publicMetadata": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/users/1" } } } }, "_links": { "companySaved": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/orders/1" }, "company": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "user": { "href": "http://demo-openapi.addk.fr/v1/users/1" } } }, { "balance": 75, "bookings": null, "directSale": null, "externalPlatform": null, "externalPlatformItemId": null, "locale": "fr", "note": null, "origin": "WIDGET", "promoCodes": null, "publicMetadata": null, "qrCode": "", "reference": "SEDHLLACISRY", "shopSession": null, "shopTicket": null, "status": "USER_FILLED", "totalDownPayment": 0, "totalPrice": 75, "totalPriceHt": 68.18, "updateDate": "2016-07-22T11:23:05+02:00", "creationDate": "2016-07-22T11:22:58+02:00", "id": 1, "_embedded": { "userSaved": { "active": false, "address": null, "birthday": null, "clientDataList": null, "email": "mail", "emailVerified": true, "firstName": "firstName", "language": null, "lastConnection": null, "lastName": "lastName", "phone": null, "privateMetadata": null, "publicMetadata": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/users/1" } } } }, "_links": { "companySaved": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/orders/1" }, "company": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "user": { "href": "http://demo-openapi.addk.fr/v1/users/1" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/orders?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/orders?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/orders?page=1" } }, "pageCount": 1, "pageSize": 1, "totalItems": 2, "page": 1 }
Description

Request to get a particular order of connected company

Query
Key Value Description
access_token {token} company's token
Response
Get order | Code: 200
{ "balance": 115, "bookings": null, "directSale": null, "externalPlatform": null, "externalPlatformItemId": null, "locale": "fr", "note": null, "origin": "WIDGET", "promoCodes": null, "publicMetadata": null, "qrCode": "", "reference": "FQKDRZAMINCB", "shopSession": null, "shopTicket": null, "status": "USER_FILLED", "totalDownPayment": 0, "totalPrice": 115, "totalPriceHt": 101.52, "updateDate": "2016-07-17T19:28:24+02:00", "creationDate": "2016-07-17T19:27:52+02:00", "id": 1, "_embedded": { "userSaved": { "active": false, "address": null, "birthday": null, "clientDataList": null, "email": "email", "emailVerified": true, "firstName": "firstName", "language": null, "lastConnection": null, "lastName": "lastName", "phone": "phone", "privateMetadata": null, "publicMetadata": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/users/1" } } } }, "_links": { "companySaved": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/orders/1" }, "company": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "user": { "href": "http://demo-openapi.addk.fr/v1/users/1" } } }
Query
Key Value Description
access_token {token} company's token
Response
Get order's linkpayment | Code: 200
{ "orderRef": "ORDERREF", "URL": "https://localhost:8080/checkout/ORDERREF" }
Description

Request to get all booking’s payment methods

Query
Key Value Description
access_token {token} company's token
Response
Get order's payment methods | Code: 200
{ "_embedded": { "paymentMethods": [ { "active": true, "label": "creditcard", "name": "Paiement CB", "id": 4, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/payment_methods/4" } } }, { "active": true, "label": "cash", "name": "Espèces", "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/payment_methods/1" } } }, { "active": true, "label": "bankwire", "name": "Virement bancaire", "id": 2, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/payment_methods/2" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/companies/204/payment_methods?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/companies/204/payment_methods?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/companies/204/payment_methods?page=1" } }, "pageCount": 1, "pageSize": 12, "totalItems": 3, "page": 1 }
Description

Request to get all booking’s promo codes

Query
Key Value Description
access_token {token} company's token
Response
Get order's promo codes | Code: 200
{ "_embedded": { "promoCodes": [ { "type": "PROMO_CODE", "availableQuantity": null, "availableQuantityPerUser": null, "discountFromQuantity": null, "discountTarget": null, "discountToQuantity": null, "displayIcon": null, "earlyBookingLimit": null, "iconPath": null, "lateBookingLimit": null, "linkedToCustomer": false, "orderMinimumAmountCurrency": 2, "orderMinimumAmountIncludingTaxes": null, "partialUse": false, "reductionAmountTaxExcluded": true, "reference": "OBRQK", "unlimitedQuantity": true, "voucher": true, "voucherCode": "OBRQK", "active": true, "applicable": 0, "applicableToAllProducts": false, "applicableToAllResellers": false, "applicableToProductTypes": null, "calculatedForProduct": null, "calculatedReductionAmount": null, "concernedProducts": null, "concernedResellers": null, "cumulable": false, "description": "vvjdmsmlds lfjflsm", "name": "Bon résa fête des pères", "orderMinimumAmount": null, "products": null, "reductionAmount": 100, "reductionType": "PERCENTAGE", "validityToDate": "2019-04-18T22:00:00.000Z", "validityEndTime": null, "validityFromDate": "2018-12-19T23:00:00.000Z", "validityStartTime": null, "visibilityAndApplicability": "MERCHANT_AND_CONCERNED_RESELLERS", "updateDate": "2018-03-26T00:00:00+02:00", "creationDate": "2018-03-26T00:00:00+02:00", "id": 36, "_embedded": { "days": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "_links": { "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/discounts/36" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/promo_codes?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/promo_codes?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/promo_codes?page=1" } }, "pageCount": 1, "pageSize": 1, "totalItems": 1, "page": 1 }
Headers
Key Value Description
Content-Type application/json
Query
Key Value Description
access_token {token} company's token
Body
{ "company": { "id": 1, "type": "MERCHANT" } }
Response
Post Request without origin or user | Code: 201
{ "balance": null, "bookings": null, "directSale": null, "externalPlatform": null, "externalPlatformItemId": null, "locale": "fr", "note": null, "origin": "OPEN_API", "promoCodes": null, "publicMetadata": { "timeoutElapsed": false }, "qrCode": "1176765510708", "reference": "ZKDOIVQVPYKX", "shopSession": null, "shopTicket": null, "status": "DRAFT", "totalDownPayment": null, "totalPrice": null, "totalPriceHt": null, "updateDate": "2019-01-23T13:09:37+01:00", "user": null, "userSaved": null, "creationDate": "2019-01-23T13:09:37+01:00", "id": 53952, "_embedded": { "company": { "type": "MERCHANT", "activities": null, "active": true, "activityDescription": "activityDescription", "activityOther": "activityOther", "emailContact": "emailContact", "landLinePhone": "+landLinePhone", "languages": null, "mobilePhone": "+mobilePhone", "name": "name", "requestLimitRules": null, "taxes": null, "url": "url", "updateDate": "2018-12-05T20:17:11+01:00", "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_embedded": { "logo": { "product": null, "externalPlatform": null, "externalPlatformItemId": null, "privateMetadata": null, "publicMetadata": null, "updateDate": null, "title": null, "primary": null, "creationDate": null, "id": null, "_embedded": { "files": [ { "name": "ORIG", "path": "uploads/merchant-company/profile/1/logo/LOGO.PNG", "url": null, "id": "d2fbb1c5-dfbc-4c37-8913-ddc52014ef88", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/d2fbb1c5-dfbc-4c37-8913-ddc52014ef88" } } }, { "name": "200x200", "path": "uploads/merchant-company/profile/1/logo/200x200-LOGO.PNG", "url": null, "id": "0995c1d6-1cba-4d4e-b06b-7fb7a113f1c2", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/0995c1d6-1cba-4d4e-b06b-7fb7a113f1c2" } } } ] } } }, "_links": { "country": { "href": "http://demo-openapi.addk.fr/v1/countries/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "defaultLanguage": { "href": "http://demo-openapi.addk.fr/v1/languages/1" }, "defaultCurrency": { "href": "http://demo-openapi.addk.fr/v1/currencies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "legalForm": { "href": "http://demo-openapi.addk.fr/v1/legal_forms/1" } } } }, "_links": { "companySaved": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/orders/53952" } } }
Headers
Key Value Description
Content-Type application/json
Query
Key Value Description
access_token {token} company's token
Body
{ "origin": "MYPAGE", "company": { "id": 1, "type": "MERCHANT" } }
Response
Post Request with origin | Code: 201
{ "balance": null, "bookings": null, "directSale": null, "externalPlatform": null, "externalPlatformItemId": null, "locale": "fr", "note": null, "origin": "MYPAGE", "promoCodes": null, "publicMetadata": { "timeoutElapsed": false }, "qrCode": "4469486372522", "reference": "YUGLCJAPQPCC", "shopSession": null, "shopTicket": null, "status": "DRAFT", "totalDownPayment": null, "totalPrice": null, "totalPriceHt": null, "updateDate": "2019-01-23T13:09:59+01:00", "user": null, "userSaved": null, "creationDate": "2019-01-23T13:09:59+01:00", "id": 53953, "_embedded": { "company": { "type": "MERCHANT", "activities": null, "active": true, "activityDescription": "activityDescription", "activityOther": "activityOther", "emailContact": "emailContact", "landLinePhone": "+landLinePhone", "languages": null, "mobilePhone": "+mobilePhone", "name": "name", "requestLimitRules": null, "taxes": null, "url": "url", "updateDate": "2018-12-05T20:17:11+01:00", "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_embedded": { "logo": { "product": null, "externalPlatform": null, "externalPlatformItemId": null, "privateMetadata": null, "publicMetadata": null, "updateDate": null, "title": null, "primary": null, "creationDate": null, "id": null, "_embedded": { "files": [ { "name": "ORIG", "path": "uploads/merchant-company/profile/1/logo/LOGO.PNG", "url": null, "id": "f241e3a8-f93a-4bde-be10-816c27685738", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/f241e3a8-f93a-4bde-be10-816c27685738" } } }, { "name": "200x200", "path": "uploads/merchant-company/profile/1/logo/200x200-LOGO.PNG", "url": null, "id": "f15d36ff-6689-49f9-b1ef-fa7fe5d2ba04", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/f15d36ff-6689-49f9-b1ef-fa7fe5d2ba04" } } } ] } } }, "_links": { "country": { "href": "http://demo-openapi.addk.fr/v1/countries/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "defaultLanguage": { "href": "http://demo-openapi.addk.fr/v1/languages/1" }, "defaultCurrency": { "href": "http://demo-openapi.addk.fr/v1/currencies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "legalForm": { "href": "http://demo-openapi.addk.fr/v1/legal_forms/1" } } } }, "_links": { "companySaved": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/orders/53953" } } }
Headers
Key Value Description
Content-Type application/json
Query
Key Value Description
access_token {token} company's token
Body
{ "company": { "id": 1, "type": "MERCHANT" }, "user": { "id": 1 } }
Response
Post Request with user having an id | Code: 201
{ "balance": null, "bookings": null, "directSale": null, "externalPlatform": null, "externalPlatformItemId": null, "locale": "fr", "note": null, "origin": "OPEN_API", "promoCodes": null, "publicMetadata": { "timeoutElapsed": false }, "qrCode": "6591247848078", "reference": "QZFDBKAUAPHK", "shopSession": null, "shopTicket": null, "status": "DRAFT", "totalDownPayment": null, "totalPrice": null, "totalPriceHt": null, "updateDate": "2019-01-23T13:10:35+01:00", "creationDate": "2019-01-23T13:10:35+01:00", "id": 53955, "_embedded": { "userSaved": { "active": true, "address": null, "birthday": null, "clientDataList": null, "email": "email", "emailVerified": true, "firstName": "firstName", "lastConnection": "2019-01-08T15:40:25.000Z", "lastName": "lastName", "phone": null, "privateMetadata": null, "publicMetadata": null, "id": 466, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/users/1" }, "language": { "href": "http://demo-openapi.addk.fr/v1/languages/1" } } }, "company": { "type": "MERCHANT", "activities": null, "active": true, "activityDescription": "activityDescription", "activityOther": "activityOther", "emailContact": "emailContact", "landLinePhone": "+landLinePhone", "languages": null, "mobilePhone": "+mobilePhone", "name": "name", "requestLimitRules": null, "taxes": null, "url": "url", "updateDate": "2018-12-05T20:17:11+01:00", "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_embedded": { "logo": { "product": null, "externalPlatform": null, "externalPlatformItemId": null, "privateMetadata": null, "publicMetadata": null, "updateDate": null, "title": null, "primary": null, "creationDate": null, "id": null, "_embedded": { "files": [ { "name": "ORIG", "path": "uploads/merchant-company/profile/1/logo/LOGO.PNG", "url": null, "id": "82d157ff-ad2f-4075-a180-49be755cc6a7", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/82d157ff-ad2f-4075-a180-49be755cc6a7" } } }, { "name": "200x200", "path": "uploads/merchant-company/profile/1/logo/200x200-LOGO.PNG", "url": null, "id": "31b5d2bc-bc2d-40a1-b74c-cfb65c421997", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/31b5d2bc-bc2d-40a1-b74c-cfb65c421997" } } } ] } } }, "_links": { "country": { "href": "http://demo-openapi.addk.fr/v1/countries/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "defaultLanguage": { "href": "http://demo-openapi.addk.fr/v1/languages/1" }, "defaultCurrency": { "href": "http://demo-openapi.addk.fr/v1/currencies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "legalForm": { "href": "http://demo-openapi.addk.fr/v1/legal_forms/1" } } }, "user": { "active": true, "address": null, "birthday": null, "clientDataList": null, "email": "email", "emailVerified": true, "firstName": "firstName", "lastConnection": "2019-01-08T15:40:25.000Z", "lastName": "lastName", "phone": null, "privateMetadata": null, "publicMetadata": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/users/1" }, "language": { "href": "http://demo-openapi.addk.fr/v1/languages/1" } } } }, "_links": { "companySaved": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/orders/53955" } } }
Headers
Key Value Description
Content-Type application/json
Query
Key Value Description
access_token {token} company's token
Body
{ "company": { "id": 1, "type": "MERCHANT" }, "user": { "emai": "exampleEmail@gmail.com" } }
Response
Post Request with user having an email | Code: 201
{ "balance": null, "bookings": null, "directSale": null, "externalPlatform": null, "externalPlatformItemId": null, "locale": "fr", "note": null, "origin": "OPEN_API", "promoCodes": null, "publicMetadata": { "timeoutElapsed": false }, "qrCode": "4762066057501", "reference": "UOKFGOZYMMPJ", "shopSession": null, "shopTicket": null, "status": "DRAFT", "totalDownPayment": null, "totalPrice": null, "totalPriceHt": null, "updateDate": "2019-01-23T13:10:52+01:00", "user": null, "userSaved": null, "creationDate": "2019-01-23T13:10:52+01:00", "id": 53956, "_embedded": { "company": { "type": "MERCHANT", "activities": null, "active": true, "activityDescription": "activityDescription", "activityOther": "activityOther", "emailContact": "emailContact", "landLinePhone": "+landLinePhone", "languages": null, "mobilePhone": "+mobilePhone", "name": "name", "requestLimitRules": null, "taxes": null, "url": "url", "updateDate": "2018-12-05T20:17:11+01:00", "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_embedded": { "logo": { "product": null, "externalPlatform": null, "externalPlatformItemId": null, "privateMetadata": null, "publicMetadata": null, "updateDate": null, "title": null, "primary": null, "creationDate": null, "id": null, "_embedded": { "files": [ { "name": "ORIG", "path": "uploads/merchant-company/profile/1/logo/LOGO.PNG", "url": null, "id": "36d34af2-4a2b-43e6-88f4-67cba75e112f", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/36d34af2-4a2b-43e6-88f4-67cba75e112f" } } }, { "name": "200x200", "path": "uploads/merchant-company/profile/1/logo/200x200-LOGO.PNG", "url": null, "id": "c4c2e3e4-9b6e-4e60-acae-c5824fa4c90b", "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/files/c4c2e3e4-9b6e-4e60-acae-c5824fa4c90b" } } } ] } } }, "_links": { "country": { "href": "http://demo-openapi.addk.fr/v1/countries/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "defaultLanguage": { "href": "http://demo-openapi.addk.fr/v1/languages/1" }, "defaultCurrency": { "href": "http://demo-openapi.addk.fr/v1/currencies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "legalForm": { "href": "http://demo-openapi.addk.fr/v1/legal_forms/1" } } } }, "_links": { "companySaved": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/orders/53956" } } }
Headers
Key Value Description
Content-Type application/json
Query
Key Value Description
access_token {token} company's token
Body
{ "user": { "id": 3394 } }
Response
Patch Order finalized | Code: 202
{ "balance": 50, "bookings": null, "directSale": null, "externalPlatform": null, "externalPlatformItemId": null, "locale": "fr", "note": null, "origin": "OPEN_API", "promoCodes": null, "publicMetadata": { "timeoutElapsed": false }, "qrCode": "1176765510708", "reference": "ZKDOIVQVPYKX", "shopSession": null, "shopTicket": null, "status": "USER_FILLED", "totalDownPayment": null, "totalPrice": 50, "totalPriceHt": 45.45, "updateDate": "2019-01-27T20:17:00+01:00", "creationDate": "2019-01-23T13:09:37+01:00", "id": 1, "_embedded": { "userSaved": { "active": false, "address": null, "birthday": null, "clientDataList": null, "email": "vivajarvis75@gmail.com", "emailVerified": true, "firstName": "Pascal Jarvis", "language": null, "lastConnection": null, "lastName": "Vivancos", "phone": "0142087325", "privateMetadata": null, "publicMetadata": null, "id": 3394, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/users/3394" } } } }, "_links": { "companySaved": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/orders/1" }, "company": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "user": { "href": "http://demo-openapi.addk.fr/v1/users/3394" } } }
Headers
Key Value Description
Content-Type application/json
Query
Key Value Description
access_token {token} company's token
Body
{ "user": { "email": "updatedEmail@gmail.com" } }
Response
Patch user's mail | Code: 202
{ "balance": 100, "bookings": null, "directSale": null, "externalPlatform": null, "externalPlatformItemId": null, "locale": "fr", "note": null, "origin": "MYPAGE", "promoCodes": null, "publicMetadata": { "timeoutElapsed": false }, "qrCode": "4469486372522", "reference": "YUGLCJAPQPCC", "shopSession": null, "shopTicket": null, "status": "USER_FILLED", "totalDownPayment": null, "totalPrice": 100, "totalPriceHt": 90.91, "updateDate": "2019-01-27T20:19:09+01:00", "creationDate": "2019-01-23T13:09:59+01:00", "id": 1, "_embedded": { "userSaved": { "active": false, "address": null, "birthday": null, "clientDataList": null, "email": "updatedEmail@gmail.com", "emailVerified": false, "firstName": "GENERATED_BY_OPEN_API", "language": null, "lastConnection": null, "lastName": "GENERATED_BY_OPEN_API", "phone": null, "privateMetadata": null, "publicMetadata": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/users/1" } } } }, "_links": { "companySaved": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/orders/1" }, "company": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "user": { "href": "http://demo-openapi.addk.fr/v1/users/1" } } }

Payment Methods 2

This section lists requests about payment methods

Description

Request to get all payment methods of connected company

Query
Key Value Description
access_token {token} company's token
Response
Get payment methods | Code: 200
{ "_embedded": { "paymentMethods": [ { "active": true, "label": "cash", "name": "Espèces", "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/payment_methods/1" } } }, { "active": true, "label": "bankwire", "name": "Virement bancaire", "id": 2, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/payment_methods/2" } } }, { "active": true, "label": "check", "name": "Chèque", "id": 3, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/payment_methods/3" } } }, { "active": true, "label": "creditcard", "name": "Paiement CB", "id": 4, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/payment_methods/4" } } }, { "active": true, "label": null, "name": "ANCV", "id": 7, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/payment_methods/7" } } }, { "active": true, "label": null, "name": "CBCompany", "id": 10, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/payment_methods/10" } } }, { "active": false, "label": null, "name": "Other", "id": 15, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/payment_methods/15" } } }, { "active": true, "label": null, "name": "Gift", "id": 16, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/payment_methods/16" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/payment_methods?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/payment_methods?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/payment_methods?page=1" } }, "pageCount": 1, "pageSize": 12, "totalItems": 8, "page": 1 }
Description

Request to get a payment method of connected company

Query
Key Value Description
access_token {token} company's token
Response
Get payment method | Code: 200
{ "active": true, "label": "check", "name": "Chèque", "id": 3, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/payment_methods/3" } } }

Products 4

This section lists requests about products
PricingType : 0 => Classic ; 1 => FORFAIT ; 2 => SESSION
For Session, the form asking for unit will be show after the date selection.

ScheduleType : OPEN_BILLET -> date
OPEN_BILLET_WITHOUT_DATE -> no date
EXACT_DATES_AND_TIMES -> date and hours
SHOP_HOURS -> date and hours

Embedded resources :

address

category

external_platform

extra_products

gift_products

merchant

images

prices

product_unit_resources

sub_category

tags

tax

unit

Description

Request to get all products of connected company

Query
Key Value Description
access_token {token} company's token
latitude (optional, longitude must be filled in if used) ex:46.647568100000 latitude to filter products
longitude (optional, latitude must be filled in if used) ex:-1.830143100000 longitude to filter products
radius (optional, longitude and latitude must be filled in if used) ex:7.8 radius to filter products (in km)
Response
Get products | Code: 200
{ "_embedded": { "products": [ { "type": "CLASSIC", "activityDuration": 1800, "availableFromDate": null, "availableToDate": null, "barCode": null, "bookingManagement": "MANUAL", "bookingManagementManualLimit": null, "canBePrivatized": false, "color": "#ff0000", "delayBeforeBooking": 7200, "delayBetweenBooking": 0, "delayBetweenSessions": false, "description": "<p><b>description</b><br/></p>", "directSales": true, "discount": null, "displayedStartingPrice": 50, "externalPlatform": null, "externalPlatformItemId": null, "images": null, "information": null, "marketplaceSales": true, "materialCombined": true, "maxParticipants": 86, "minBookings": 0, "minParticipants": 1, "minParticipantsToPrivatize": 0, "mostAttractiveDiscount": null, "name": "Transfert Court", "partnerSales": false, "prices": null, "pricingType": 1, "primaryImage": null, "publicMetadata": null, "reference": "Transfert Court", "reservationShowAvailabilityLeft": false, "scheduleType": "SHOP_HOURS", "sellingTarget": "PROFESSIONAL", "status": "PUBLISHED", "summary": "summary", "updateDate": null, "validityDuration": null, "webSales": false, "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": "fr", "translations": null, "id": 1, "_embedded": { "extraProducts": [], "productUnitResources": [], "giftProducts": [], "tags": [] }, "_links": { "subCategory": { "href": "http://demo-openapi.addk.fr/v1/product_sub_categories/1" }, "unit": { "href": "http://demo-openapi.addk.fr/v1/units/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/products/1" }, "tax": { "href": "http://demo-openapi.addk.fr/v1/taxes/1" }, "category": { "href": "http://demo-openapi.addk.fr/v1/product_categories/1" } } }, { "type": "CLASSIC", "activityDuration": 1800, "availableFromDate": null, "availableToDate": null, "barCode": null, "bookingManagement": "MANUAL", "bookingManagementManualLimit": null, "canBePrivatized": true, "color": "#ff0000", "delayBeforeBooking": 7200, "delayBetweenBooking": 0, "delayBetweenSessions": false, "description": "<p><b>description</b><br/></p>", "directSales": true, "discount": null, "displayedStartingPrice": 80, "externalPlatform": null, "externalPlatformItemId": null, "images": null, "information": null, "marketplaceSales": true, "materialCombined": true, "maxParticipants": 86, "minBookings": 0, "minParticipants": 1, "minParticipantsToPrivatize": 2, "mostAttractiveDiscount": null, "name": "Transfert Long", "partnerSales": false, "prices": null, "pricingType": 1, "primaryImage": null, "publicMetadata": null, "reference": "Transfert Long", "reservationShowAvailabilityLeft": false, "scheduleType": "SHOP_HOURS", "sellingTarget": "PROFESSIONAL", "status": "PUBLISHED", "summary": "summary", "updateDate": null, "validityDuration": null, "webSales": false, "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": "fr", "translations": null, "id": 1, "_embedded": { "extraProducts": [], "productUnitResources": [], "giftProducts": [], "tags": [] }, "_links": { "subCategory": { "href": "http://demo-openapi.addk.fr/v1/product_sub_categories/1" }, "unit": { "href": "http://demo-openapi.addk.fr/v1/units/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/products/1" }, "tax": { "href": "http://demo-openapi.addk.fr/v1/taxes/1" }, "category": { "href": "http://demo-openapi.addk.fr/v1/product_categories/1" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/products?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/products?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/products?page=1" } }, "pageCount": 1, "pageSize": 2, "totalItems": 2, "page": 1 }
Get products with geolocation | Code: 200
{ "_embedded": { "products": [ { "type": "CLASSIC", "activityDuration": 86400, "availableFromDate": null, "availableToDate": null, "barCode": null, "bookingManagement": "MANUAL", "bookingManagementManualLimit": null, "canBePrivatized": false, "color": "#ff00ff", "delayBeforeBooking": 0, "delayBetweenBooking": 0, "delayBetweenSessions": false, "description": "<p><b>description</b><br/></p>", "directSales": false, "discount": null, "displayedStartingPrice": 25, "externalPlatform": null, "externalPlatformItemId": null, "images": null, "information": null, "marketplaceSales": true, "materialCombined": true, "maxParticipants": 16, "minBookings": 0, "minParticipants": 1, "minParticipantsToPrivatize": null, "mostAttractiveDiscount": null, "name": "name", "partnerSales": true, "prices": null, "pricingType": 0, "primaryImage": null, "publicMetadata": null, "reference": "reference", "reservationShowAvailabilityLeft": false, "scheduleType": "OPEN_BILLET", "sellingTarget": "ALL", "status": "PUBLISHED", "summary": "summary", "updateDate": null, "validityDuration": null, "webSales": true, "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_embedded": { "extraProducts": [], "productUnitResources": [], "giftProducts": [], "tags": [] }, "_links": { "subCategory": { "href": "http://demo-openapi.addk.fr/v1/product_sub_categories/1" }, "unit": { "href": "http://demo-openapi.addk.fr/v1/units/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/products/1" }, "tax": { "href": "http://demo-openapi.addk.fr/v1/taxes/1" }, "category": { "href": "http://demo-openapi.addk.fr/v1/product_categories/1" } } } ] }, "_links": { "next": { "href": "http://demo-openapi.addk.fr/v1/products?page=2" }, "last": { "href": "http://demo-openapi.addk.fr/v1/products?page=17" }, "self": { "href": "http://demo-openapi.addk.fr/v1/products?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/products?page=1" } }, "pageCount": 1, "pageSize": 2, "totalItems": 2, "page": 1 }
Description

Request to get a particular product of connected company

Query
Key Value Description
access_token {token} company's token
Response
Get product | Code: 200
{ "type": "CLASSIC", "activityDuration": 1800, "availableFromDate": null, "availableToDate": null, "barCode": null, "bookingManagement": "MANUAL", "bookingManagementManualLimit": null, "canBePrivatized": true, "color": "#ff0000", "delayBeforeBooking": 7200, "delayBetweenBooking": 0, "delayBetweenSessions": false, "description": "<p><b>description</b><br/></p>", "directSales": true, "discount": null, "displayedStartingPrice": 80, "externalPlatform": null, "externalPlatformItemId": null, "images": null, "information": null, "marketplaceSales": true, "materialCombined": true, "maxParticipants": 86, "minBookings": 0, "minParticipants": 1, "minParticipantsToPrivatize": 2, "mostAttractiveDiscount": null, "name": "Transfert Long", "partnerSales": false, "prices": null, "pricingType": 1, "primaryImage": null, "publicMetadata": null, "reference": "Transfert Long", "reservationShowAvailabilityLeft": false, "scheduleType": "SHOP_HOURS", "sellingTarget": "PROFESSIONAL", "status": "PUBLISHED", "summary": "summary", "updateDate": null, "validityDuration": null, "webSales": false, "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": "fr", "translations": null, "id": 1011, "_embedded": { "extraProducts": [], "productUnitResources": [], "giftProducts": [], "tags": [] }, "_links": { "subCategory": { "href": "http://demo-openapi.addk.fr/v1/product_sub_categories/1" }, "unit": { "href": "http://demo-openapi.addk.fr/v1/units/1" }, "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/products/1011" }, "tax": { "href": "http://demo-openapi.addk.fr/v1/taxes/1" }, "category": { "href": "http://demo-openapi.addk.fr/v1/product_categories/1" } } }
Description

Request to get order’s day availabilities

Query
Key Value Description
access_token {token} company's token
from_date ex= 2019-01-17T01:00:00.000Z The research begin at 'from_date'
unit_quantities (optional) {unitID}:{quantities}; ex= unit_quantities=7664:4 unit linked with product
next_available_date (optional) True or False Continue to search after date given by from_date
Response
Get product's day availabilities | Code: 200
{ "_embedded": { "productDayAvailabilities": [ { "bookable": true, "date": "2019-01-21T11:00:00.000Z", "discount": null, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1010" }, "season": { "href": "http://demo-openapi.addk.fr/v1/seasons/0" } } }, { "bookable": true, "date": "2019-01-22T10:00:00.000Z", "discount": null, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1010" }, "season": { "href": "http://demo-openapi.addk.fr/v1/seasons/0" } } }, { "bookable": true, "date": "2019-01-23T10:00:00.000Z", "discount": null, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1010" }, "season": { "href": "http://demo-openapi.addk.fr/v1/seasons/0" } } }, { "bookable": true, "date": "2019-01-24T10:00:00.000Z", "discount": null, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1010" }, "season": { "href": "http://demo-openapi.addk.fr/v1/seasons/0" } } }, { "bookable": true, "date": "2019-01-25T10:00:00.000Z", "discount": null, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1010" }, "season": { "href": "http://demo-openapi.addk.fr/v1/seasons/0" } } }, { "bookable": true, "date": "2019-01-26T10:00:00.000Z", "discount": null, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1010" }, "season": { "href": "http://demo-openapi.addk.fr/v1/seasons/0" } } }, { "bookable": true, "date": "2019-01-27T10:00:00.000Z", "discount": null, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1010" }, "season": { "href": "http://demo-openapi.addk.fr/v1/seasons/0" } } }, { "bookable": true, "date": "2019-01-28T10:00:00.000Z", "discount": null, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1010" }, "season": { "href": "http://demo-openapi.addk.fr/v1/seasons/0" } } }, { "bookable": true, "date": "2019-01-29T10:00:00.000Z", "discount": null, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1010" }, "season": { "href": "http://demo-openapi.addk.fr/v1/seasons/0" } } }, { "bookable": true, "date": "2019-01-30T10:00:00.000Z", "discount": null, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1010" }, "season": { "href": "http://demo-openapi.addk.fr/v1/seasons/0" } } }, { "bookable": true, "date": "2019-01-31T10:00:00.000Z", "discount": null, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1010" }, "season": { "href": "http://demo-openapi.addk.fr/v1/seasons/0" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/products/1010/product_day_availabilities?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/products/1010/product_day_availabilities?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/products/1010/product_day_availabilities?page=1" } }, "pageCount": 1, "pageSize": 11, "totalItems": 11, "page": 1 }
Description

Request to get order’s time slot availabilities

Query
Key Value Description
access_token {token} company's token
on_date Date in ISO format, ex= 2019-01-21T01:00:00.000Z
unit_quantities (optional) {unitID}:{quantities}; ex= unit_quantities=7664:4 unit linked with product
Response
Get product's time slot availabilities | Code: 200
{ "_embedded": { "productTimeSlotAvailabilities": [ { "bookable": true, "bookedQuantity": 0, "discount": null, "superStaff": false, "currentlyUsed": 0, "publicMetadata": null, "remainingBookingCapacity": 86, "startDateTime": "2019-01-21T11:00:00.000Z", "creationDate": "2019-01-21T11:48:30+01:00", "_embedded": { "productUnitTimeSlotAvailabilities": [ { "canBePrivatized": true, "currentlyUsed": 0, "publicMetadata": null, "remainingBookingCapacity": 60, "startDateTime": "2019-01-21T11:00:00.000Z", "creationDate": "2019-01-21T11:48:30+01:00", "_embedded": { "unit": { "type": "FORFAIT", "name": "Personne(s)", "publicMetadata": null, "updateDate": "2018-12-05T20:17:11+01:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 9178, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/units/1" } } }, "resources": [ { "calendars": null, "capacity": 6, "closedTimeRanges": null, "divisible": false, "human": 0, "name": "name", "quantity": 10, "scheduleType": "CALENDAR_COMPANY", "staffType": 0, "user": null, "id": 663, "_links": { "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/resources/1" } } } ] }, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1" } } } ], "productResourceTimeSlotAvailabilities": [ { "available": true, "bookedQuantity": 0, "currentlyUsed": 0, "publicMetadata": null, "remainingBookingCapacity": 60, "startDateTime": "2019-01-21T11:00:00.000Z", "creationDate": null, "id": null, "_embedded": { "resource": { "calendars": null, "capacity": 6, "divisible": false, "human": 0, "name": "name", "quantity": 10, "scheduleType": "CALENDAR_COMPANY", "staffType": 0, "user": null, "id": 663, "_embedded": { "closedTimeRanges": [] }, "_links": { "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/resources/1" } } } }, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1" } } } ] }, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1" } } }, { "bookable": true, "bookedQuantity": 0, "discount": null, "superStaff": false, "currentlyUsed": 0, "publicMetadata": null, "remainingBookingCapacity": 86, "startDateTime": "2019-01-21T11:30:00.000Z", "creationDate": "2019-01-21T11:48:30+01:00", "_embedded": { "productUnitTimeSlotAvailabilities": [ { "canBePrivatized": true, "currentlyUsed": 0, "publicMetadata": null, "remainingBookingCapacity": 60, "startDateTime": "2019-01-21T11:30:00.000Z", "creationDate": "2019-01-21T11:48:30+01:00", "_embedded": { "unit": { "type": "FORFAIT", "name": "Personne(s)", "publicMetadata": null, "updateDate": "2018-12-05T20:17:11+01:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 9178, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/units/1" } } }, "resources": [ { "calendars": null, "capacity": 6, "closedTimeRanges": null, "divisible": false, "human": 0, "name": "name", "quantity": 10, "scheduleType": "CALENDAR_COMPANY", "staffType": 0, "user": null, "id": 663, "_links": { "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/resources/1" } } } ] }, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1" } } } ], "productResourceTimeSlotAvailabilities": [ { "available": true, "bookedQuantity": 0, "currentlyUsed": 0, "publicMetadata": null, "remainingBookingCapacity": 60, "startDateTime": "2019-01-21T11:30:00.000Z", "creationDate": null, "id": null, "_embedded": { "resource": { "calendars": null, "capacity": 6, "divisible": false, "human": 0, "name": "name", "quantity": 10, "scheduleType": "CALENDAR_COMPANY", "staffType": 0, "user": null, "id": 663, "_embedded": { "closedTimeRanges": [] }, "_links": { "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/resources/1" } } } }, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1" } } } ] }, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/products/1/product_time_slot_availabilities?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/products/1/product_time_slot_availabilities?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/products/1/product_time_slot_availabilities?page=1" } }, "pageCount": 1, "pageSize": 2, "totalItems": 2, "page": 1 }
Get product's time slot availabilities with unit quantities option | Code: 200
{ "_embedded": { "productTimeSlotAvailabilities": [ { "bookable": true, "bookedQuantity": 0, "discount": null, "superStaff": false, "currentlyUsed": 2, "publicMetadata": null, "remainingBookingCapacity": 999999, "startDateTime": "2019-02-04T10:00:00.000Z", "creationDate": "2019-02-04T10:32:55+01:00", "_embedded": { "productUnitTimeSlotAvailabilities": [ { "canBePrivatized": true, "currentlyUsed": 2, "publicMetadata": null, "remainingBookingCapacity": 5, "startDateTime": "2019-02-04T10:00:00.000Z", "creationDate": "2019-02-04T10:32:55+01:00", "_embedded": { "unit": { "type": "MAIN", "name": "Adulte(s)", "publicMetadata": null, "updateDate": "2018-09-11T12:20:53+02:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 7664, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/units/7664" } } }, "resources": [ { "calendars": null, "capacity": 5, "closedTimeRanges": null, "divisible": true, "human": 1, "name": null, "quantity": 1, "scheduleType": "CALENDAR_COMPANY", "staffType": 0, "id": 1452, "_links": { "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/resources/1452" }, "user": { "href": "http://demo-openapi.addk.fr/v1/users/1" } } } ] }, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1" } } } ], "productResourceTimeSlotAvailabilities": [ { "available": true, "bookedQuantity": 0, "currentlyUsed": 2, "publicMetadata": null, "remainingBookingCapacity": 5, "startDateTime": "2019-02-04T10:00:00.000Z", "creationDate": null, "id": null, "_embedded": { "resource": { "calendars": null, "capacity": 5, "divisible": true, "human": 1, "name": null, "quantity": 1, "scheduleType": "CALENDAR_COMPANY", "staffType": 0, "id": 1452, "_embedded": { "closedTimeRanges": [] }, "_links": { "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/resources/1452" }, "user": { "href": "http://demo-openapi.addk.fr/v1/users/1" } } } }, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1" } } } ] }, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1" } } }, { "bookable": true, "bookedQuantity": 0, "discount": null, "superStaff": false, "currentlyUsed": 2, "publicMetadata": null, "remainingBookingCapacity": 999999, "startDateTime": "2019-02-04T11:00:00.000Z", "creationDate": "2019-02-04T10:32:55+01:00", "_embedded": { "productUnitTimeSlotAvailabilities": [ { "canBePrivatized": true, "currentlyUsed": 2, "publicMetadata": null, "remainingBookingCapacity": 5, "startDateTime": "2019-02-04T11:00:00.000Z", "creationDate": "2019-02-04T10:32:55+01:00", "_embedded": { "unit": { "type": "MAIN", "name": "Adulte(s)", "publicMetadata": null, "updateDate": "2018-09-11T12:20:53+02:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 7664, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/units/7664" } } }, "resources": [ { "calendars": null, "capacity": 5, "closedTimeRanges": null, "divisible": true, "human": 1, "name": null, "quantity": 1, "scheduleType": "CALENDAR_COMPANY", "staffType": 0, "id": 1452, "_links": { "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/resources/1452" }, "user": { "href": "http://demo-openapi.addk.fr/v1/users/1" } } } ] }, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1" } } } ], "productResourceTimeSlotAvailabilities": [ { "available": true, "bookedQuantity": 0, "currentlyUsed": 2, "publicMetadata": null, "remainingBookingCapacity": 5, "startDateTime": "2019-02-04T11:00:00.000Z", "creationDate": null, "id": null, "_embedded": { "resource": { "calendars": null, "capacity": 5, "divisible": true, "human": 1, "name": null, "quantity": 1, "scheduleType": "CALENDAR_COMPANY", "staffType": 0, "id": 1452, "_embedded": { "closedTimeRanges": [] }, "_links": { "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/resources/1452" }, "user": { "href": "http://demo-openapi.addk.fr/v1/users/1" } } } }, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1" } } } ] }, "_links": { "product": { "href": "http://demo-openapi.addk.fr/v1/products/1" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/products/1/product_time_slot_availabilities?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/products/1/product_time_slot_availabilities?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/products/1/product_time_slot_availabilities?page=1" } }, "pageCount": 1, "pageSize": 2, "totalItems": 2, "page": 1 }

Product categories 2

This section lists requests about product categories

Query
Key Value Description
access_token {token} company's token
Response
Get product categories | Code: 200
{ "_embedded": { "productCategories": [ { "code": "water_sports", "description": null, "active": true, "name": "Sports nautiques", "updateDate": "2018-09-11T12:19:40+02:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 2, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/product_categories/2" } } }, { "code": "action", "description": null, "active": true, "name": "Action & Aventure", "updateDate": "2018-09-11T12:19:40+02:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/product_categories/1" } } }, { "code": "animation", "description": null, "active": true, "name": "Animations et artistes", "updateDate": "2018-09-11T12:19:40+02:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 13, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/product_categories/13" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/product_categories?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/product_categories?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/product_categories?page=1" } }, "pageCount": 1, "pageSize": 12, "totalItems": 3, "page": 1 }
Query
Key Value Description
access_token {token} company's token
Response
Get product category | Code: 200
{ "code": "water_sports", "description": null, "active": true, "name": "Sports nautiques", "updateDate": "2018-09-11T12:19:40+02:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 2, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/product_categories/2" } } }

Taxes 2

This section lists requests about taxes

Query
Key Value Description
access_token {token} company's token
Response
Get taxes | Code: 200
{ "_embedded": { "taxes": [ { "active": true, "name": "TVA 10%", "rate": 10, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/taxes/1" } } }, { "active": true, "name": "TVA 20%", "rate": 20, "id": 2, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/taxes/2" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/taxes?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/taxes?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/taxes?page=1" } }, "pageCount": 1, "pageSize": 12, "totalItems": 2, "page": 1 }
Query
Key Value Description
access_token {token} company's token
Response
Get taxe | Code: 200
{ "active": true, "name": "TVA 20%", "rate": 20, "id": 2, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/taxes/2" } } }

Product_sub_categories 2

This section lists requests about product sub categories

Embedded resources :

category

Query
Key Value Description
access_token {token} company's token
Response
Get product sub categories | Code: 200
{ "_embedded": { "productSubCategories": [ { "active": true, "name": "Canoë", "updateDate": "2018-09-11T12:19:40+02:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/product_sub_categories/1" }, "category": { "href": "http://demo-openapi.addk.fr/v1/product_categories/1" } } }, { "active": true, "name": "Accrobranche", "updateDate": "2018-09-11T12:19:40+02:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/product_sub_categories/1" }, "category": { "href": "http://demo-openapi.addk.fr/v1/product_categories/1" } } }, { "active": true, "name": "Artistes", "updateDate": "2018-09-11T12:19:40+02:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/product_sub_categories/1" }, "category": { "href": "http://demo-openapi.addk.fr/v1/product_categories/1" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/product_sub_categories?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/product_sub_categories?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/product_sub_categories?page=1" } }, "pageCount": 1, "pageSize": 12, "totalItems": 3, "page": 1 }
Query
Key Value Description
access_token {token} company's token
Response
Get product sub category | Code: 200
{ "active": true, "name": "Canoë", "updateDate": "2018-09-11T12:19:40+02:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/product_sub_categories/1" }, "category": { "href": "http://demo-openapi.addk.fr/v1/product_categories/1" } } }

Terms Sale 2

This section lists requests about terms sale

Description

List all terms sale availables for the connected company ( terms sale of connected company and terms sale of company’s partners )

Query
Key Value Description
access_token {token} company's token
Response
Get terms Sale | Code: 200
{ "_embedded": { "terms_sale": [ { "term": "Sales term.", "id": 458, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/458" }, "company": { "href": "http://demo-openapi.addk.fr/v1/companies/1" } } } ] }, "_links": { "next": { "href": "http://demo-openapi.addk.fr/v1/terms_sale/458/terms_sale?page=2" }, "last": { "href": "http://demo-openapi.addk.fr/v1/terms_sale/458/terms_sale?page=8" }, "self": { "href": "http://demo-openapi.addk.fr/v1/terms_sale/458/terms_sale?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/terms_sale/458/terms_sale?page=1" } }, "pageCount": 8, "pageSize": 12, "totalItems": 89, "page": 1 }
Description

Get a particular term sale

Query
Key Value Description
access_token {token} company's token
Response
Get term sale | Code: 200
{ "term": "Sales term.", "id": 458, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/458" }, "company": { "href": "http://demo-openapi.addk.fr/v1/companies/1" } } }

Units 2

This section lists requests about units

Embedded resources :

translations

Query
Key Value Description
access_token {token} company's token
Response
Get units | Code: 200
{ "_embedded": { "units": [ { "type": "MAIN", "name": "Adulte", "publicMetadata": null, "updateDate": "2018-09-11T12:19:40+02:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/units/1" } } } ] }, "_links": { "last": { "href": "http://demo-openapi.addk.fr/v1/units?page=1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/units?page=1" }, "first": { "href": "http://demo-openapi.addk.fr/v1/units?page=1" } }, "pageCount": 1, "pageSize": 12, "totalItems": 1, "page": 1 }
Query
Key Value Description
access_token {token} company's token
Response
Get unit | Code: 200
{ "type": "MAIN", "name": "Adulte", "publicMetadata": null, "updateDate": "2018-09-11T12:19:40+02:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/units/1" } } }

User Client Data 1

Requests about user client data

Headers
Key Value Description
Content-Type application/json
Query
Key Value Description
access_token {token} company's token
Body
{ "type": "USER", "clientFormInputType": { "id": 1, "default_language_code": "fr", "input_type": "text", "merchant_id": 1, "type": "MERCHANT" }, "company": { "id": 1, "type": "MERCHANT" }, "user": { "id": 1 }, "value": " test user_client_data" }
Response
POST user_client_data | Code: 201
{ "privateMetadata": null, "publicMetadata": null, "value": " test user_client_data", "id": 121824, "_embedded": { "clientFormInputType": { "type": "MERCHANT", "code": null, "inputType": "TEXT", "label": "Taille", "options": null, "updateDate": "2018-12-13T15:47:24+01:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/client_form_input_types/1" } } }, "clientFormInputTypeSaved": { "type": "MERCHANT", "code": null, "inputType": "TEXT", "label": "Taille", "options": null, "updateDate": "2018-12-13T15:47:24+01:00", "creationDate": null, "defaultLanguageCode": "fr", "translationLanguageCode": null, "translations": null, "id": 1, "_links": { "merchant": { "href": "http://demo-openapi.addk.fr/v1/companies/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/client_form_input_types/1" } } }, "user": { "active": true, "birthday": "1969-12-30T23:00:00.000Z", "clientDataList": null, "email": "email", "emailVerified": true, "firstName": "Ralph", "language": null, "lastConnection": "2019-01-08T12:15:12.000Z", "lastName": "lastName", "phone": "+phone", "privateMetadata": null, "publicMetadata": null, "id": 28641, "_links": { "address": { "href": "http://demo-openapi.addk.fr/v1/addresses/1" }, "self": { "href": "http://demo-openapi.addk.fr/v1/users/1" } } } }, "_links": { "self": { "href": "http://demo-openapi.addk.fr/v1/client_data/121824" }, "company": { "href": "http://demo-openapi.addk.fr/v1/companies/1" } } }