API docs by Redocly

partnersApi documentation (1.0.0)

Download OpenAPI specification:Download

Terms of Service

Documentation and interface contract for the partnersApi, the API responsible for managing legal entities (partner management).

Organizations

addOrganization

Create an organization as a business object.

header Parameters
X-Correlation-ID
string

Correlation identifier

Request Body schema: application/json
id
string

Technical and unique identifier generated automatically, which identifies an organization.

name
required
string

Partner's name.

picture
string

Link to the partner's logo.

required
object (Address)
status
string
Enum: "MISSING_INFORMATIONS" "COMPLETED"

The partner's status.

  • By default, the organization is created with the status: "MISSING_INFORMATIONS".
  • At each login, check whether the status has changed to COMPLETED, in order to notify the legal representative that they must fill in their organization's information.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "picture": "string",
  • "address": {
    },
  • "status": "MISSING_INFORMATIONS"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "picture": "string",
  • "address": {
    },
  • "status": "MISSING_INFORMATIONS"
}

listOrganizations

List organizations.

query Parameters
currentPage
integer >= 0

Current page number. Do not send this attribute on the first call.

sizePage
integer >= 3

Number of elements per page.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "currentPage": 0,
  • "content": [
    ]
}

getOrganization

Retrieve organization information by its id.

path Parameters
organization-id
required
string

Technical id of the organization.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "picture": "string",
  • "address": {
    },
  • "status": "MISSING_INFORMATIONS"
}

putOrganization

Update an organization.

path Parameters
organization-id
required
string

Technical id of the organization.

header Parameters
X-Correlation-ID
string

Correlation identifier

Request Body schema: application/json
id
string

Technical and unique identifier generated automatically, which identifies an organization.

name
required
string

Partner's name.

picture
string

Link to the partner's logo.

required
object (Address)
status
string
Enum: "MISSING_INFORMATIONS" "COMPLETED"

The partner's status.

  • By default, the organization is created with the status: "MISSING_INFORMATIONS".
  • At each login, check whether the status has changed to COMPLETED, in order to notify the legal representative that they must fill in their organization's information.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "picture": "string",
  • "address": {
    },
  • "status": "MISSING_INFORMATIONS"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "picture": "string",
  • "address": {
    },
  • "status": "MISSING_INFORMATIONS"
}

deleteOrganization

Delete an organization.

path Parameters
organization-id
required
string

Technical id of the organization.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{ }

activateOrganization

Activate an organization.

path Parameters
organization-id
required
string

Technical id of the organization.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "picture": "string",
  • "address": {
    },
  • "status": "MISSING_INFORMATIONS"
}

deactivateOrganization

Deactivate an organization.

path Parameters
organization-id
required
string

Technical id of the organization.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "picture": "string",
  • "address": {
    },
  • "status": "MISSING_INFORMATIONS"
}

Establishments

addEstablishment

Create an establishment as a business object.

header Parameters
X-Correlation-ID
string

Correlation identifier

Request Body schema: application/json
id
string

Technical and unique identifier generated automatically, which identifies an establishment.

parentOrganism
required
string

Technical identifier of the parent organization.

name
required
string

Name of the establishment.

legalStatus
string
Enum: "EI" "SA" "SARL" "SAS" "SCS" "SCA" "SEP" "SNC" "GIE"

Legal form of the establishment:

  • Sole proprietorship (EI)
  • Public limited company (SA)
  • Limited liability company (SARL)
  • Simplified joint-stock company (SAS)
  • Limited partnership (SCS)
  • Partnership limited by shares (SCA)
  • Joint venture (SEP)
  • General partnership (SNC)
  • Economic interest grouping (GIE)
object (Address)
supportingDocumentsID
string

Technical identifier of the supporting document proving the establishment's identity.

status
string (establishmentStatus)
Enum: "MISSING_INFORMATIONS" "ACTIVATED" "DISABLED"

The establishment status.

  • By default, the establishment is created with the status: "MISSING_INFORMATIONS".
  • For the establishment to be active and able to operate on our platform, it must have the status: "ACTIVATED"
  • To move to "ACTIVATED" status, the following information must be provided:
    • legalStatus
    • address
    • supportingDocumentsID (provide a document justifying the company's identity)
    • companyInformation
    • have at least one natural person with (status = "ACTIVATED" and role = "ADMIN_PRO")
activities
Array of strings
Items Enum: "TRAVEL_SERVICE" "ACCOMMODATION_SERVICE"

List of activities the establishment can carry out:

  • for travel agencies, the type is: TRAVEL_SERVICE
  • for accommodation establishments (hotel, inn, etc.), the type is: ACCOMMODATION_SERVICE

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "parentOrganism": "string",
  • "name": "string",
  • "legalStatus": "EI",
  • "address": {
    },
  • "supportingDocumentsID": "string",
  • "status": "MISSING_INFORMATIONS",
  • "activities": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "parentOrganism": "string",
  • "name": "string",
  • "legalStatus": "EI",
  • "address": {
    },
  • "supportingDocumentsID": "string",
  • "status": "MISSING_INFORMATIONS",
  • "activities": [
    ]
}

listEstablishments

List establishments.

query Parameters
organization-id
string

Technical id of the organization.

search
string
Example: search=Marrakech

Free-text search on (reference, title or destination).

status
string (establishmentStatus)
Enum: "MISSING_INFORMATIONS" "ACTIVATED" "DISABLED"

The establishment status.

  • By default, the establishment is created with the status: "MISSING_INFORMATIONS".
  • For the establishment to be active and able to operate on our platform, it must have the status: "ACTIVATED"
  • To move to "ACTIVATED" status, the following information must be provided:
    • legalStatus
    • address
    • supportingDocumentsID (provide a document justifying the company's identity)
    • companyInformation
    • have at least one natural person with (status = "ACTIVATED" and role = "ADMIN_PRO")
currentPage
integer >= 0

Current page number. Do not send this attribute on the first call.

sizePage
integer >= 3

Number of elements per page.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "currentPage": 0,
  • "content": [
    ]
}

getEstablishment

Retrieve establishment information by its id.

path Parameters
establishment-id
required
string

Technical id of the establishment.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "parentOrganism": "string",
  • "name": "string",
  • "legalStatus": "EI",
  • "address": {
    },
  • "supportingDocumentsID": "string",
  • "status": "MISSING_INFORMATIONS",
  • "activities": [
    ]
}

putEstablishment

Update an establishment.

path Parameters
establishment-id
required
string

Technical id of the establishment.

header Parameters
X-Correlation-ID
string

Correlation identifier

Request Body schema: application/json
id
string

Technical and unique identifier generated automatically, which identifies an establishment.

parentOrganism
required
string

Technical identifier of the parent organization.

name
required
string

Name of the establishment.

legalStatus
string
Enum: "EI" "SA" "SARL" "SAS" "SCS" "SCA" "SEP" "SNC" "GIE"

Legal form of the establishment:

  • Sole proprietorship (EI)
  • Public limited company (SA)
  • Limited liability company (SARL)
  • Simplified joint-stock company (SAS)
  • Limited partnership (SCS)
  • Partnership limited by shares (SCA)
  • Joint venture (SEP)
  • General partnership (SNC)
  • Economic interest grouping (GIE)
object (Address)
supportingDocumentsID
string

Technical identifier of the supporting document proving the establishment's identity.

status
string (establishmentStatus)
Enum: "MISSING_INFORMATIONS" "ACTIVATED" "DISABLED"

The establishment status.

  • By default, the establishment is created with the status: "MISSING_INFORMATIONS".
  • For the establishment to be active and able to operate on our platform, it must have the status: "ACTIVATED"
  • To move to "ACTIVATED" status, the following information must be provided:
    • legalStatus
    • address
    • supportingDocumentsID (provide a document justifying the company's identity)
    • companyInformation
    • have at least one natural person with (status = "ACTIVATED" and role = "ADMIN_PRO")
activities
Array of strings
Items Enum: "TRAVEL_SERVICE" "ACCOMMODATION_SERVICE"

List of activities the establishment can carry out:

  • for travel agencies, the type is: TRAVEL_SERVICE
  • for accommodation establishments (hotel, inn, etc.), the type is: ACCOMMODATION_SERVICE

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "parentOrganism": "string",
  • "name": "string",
  • "legalStatus": "EI",
  • "address": {
    },
  • "supportingDocumentsID": "string",
  • "status": "MISSING_INFORMATIONS",
  • "activities": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "parentOrganism": "string",
  • "name": "string",
  • "legalStatus": "EI",
  • "address": {
    },
  • "supportingDocumentsID": "string",
  • "status": "MISSING_INFORMATIONS",
  • "activities": [
    ]
}

deleteEstablishment

Delete an establishment.

path Parameters
establishment-id
required
string

Technical id of the establishment.

header Parameters
X-Correlation-ID
string

Correlation identifier

Responses

Response samples

Content type
application/json
{ }