REST API GUIDE

airbnb-propertycatalog-service

Version: 1.0.5

Service for management of property listings, calendars, amenities, and localization for a short-term rental marketplace. Hosts can manage listings, availability, multi-language descriptions, policies, pricing, and attributes, served for global search and discovery…

Architectural Design Credit and Contact Information

The architectural design of this microservice is credited to . For inquiries, feedback, or further information regarding the architecture, please direct your communication to:

Email:

We encourage open communication and welcome any questions or discussions related to the architectural aspects of this microservice.

Documentation Scope

Welcome to the official documentation for the PropertyCatalog Service’s REST API. This document is designed to provide a comprehensive guide to interfacing with our PropertyCatalog Service exclusively through RESTful API endpoints.

Intended Audience

This documentation is intended for developers and integrators who are looking to interact with the PropertyCatalog Service via HTTP requests for purposes such as creating, updating, deleting and querying PropertyCatalog objects.

Overview

Within these pages, you will find detailed information on how to effectively utilize the REST API, including authentication methods, request and response formats, endpoint descriptions, and examples of common use cases.

Beyond REST It’s important to note that the PropertyCatalog Service also supports alternative methods of interaction, such as gRPC and messaging via a Message Broker. These communication methods are beyond the scope of this document. For information regarding these protocols, please refer to their respective documentation.

Authentication And Authorization

To ensure secure access to the PropertyCatalog service’s protected endpoints, a project-wide access token is required. This token serves as the primary method for authenticating requests to our service. However, it’s important to note that access control varies across different routes:

Protected API: Certain API (routes) require specific authorization levels. Access to these routes is contingent upon the possession of a valid access token that meets the route-specific authorization criteria. Unauthorized requests to these routes will be rejected.

**Public API **: The service also includes public API (routes) that are accessible without authentication. These public endpoints are designed for open access and do not require an access token.

Token Locations

When including your access token in a request, ensure it is placed in one of the following specified locations. The service will sequentially search these locations for the token, utilizing the first one it encounters.

Location Token Name / Param Name
Query access_token
Authorization Header Bearer
Header airbnb3-access-token
Cookie airbnb3-access-token

Please ensure the token is correctly placed in one of these locations, using the appropriate label as indicated. The service prioritizes these locations in the order listed, processing the first token it successfully identifies.

Api Definitions

This section outlines the API endpoints available within the PropertyCatalog service. Each endpoint can receive parameters through various methods, meticulously described in the following definitions. It’s important to understand the flexibility in how parameters can be included in requests to effectively interact with the PropertyCatalog service.

This service is configured to listen for HTTP requests on port 3001, serving both the main API interface and default administrative endpoints.

The following routes are available by default:

This service is accessible via the following environment-specific URLs:

Parameter Inclusion Methods: Parameters can be incorporated into API requests in several ways, each with its designated location. Understanding these methods is crucial for correctly constructing your requests:

Query Parameters: Included directly in the URL’s query string.

Path Parameters: Embedded within the URL’s path.

Body Parameters: Sent within the JSON body of the request.

Session Parameters: Automatically read from the session object. This method is used for parameters that are intrinsic to the user’s session, such as userId. When using an API that involves session parameters, you can omit these from your request. The service will automatically bind them to the API layer, provided that a session is associated with your request.

Note on Session Parameters: Session parameters represent a unique method of parameter inclusion, relying on the context of the user’s session. A common example of a session parameter is userId, which the service automatically associates with your request when a session exists. This feature ensures seamless integration of user-specific data without manual input for each request.

By adhering to the specified parameter inclusion methods, you can effectively utilize the PropertyCatalog service’s API endpoints. For detailed information on each endpoint, including required parameters and their accepted locations, refer to the individual API definitions below.

Common Parameters

The PropertyCatalog service’s business API support several common parameters designed to modify and enhance the behavior of API requests. These parameters are not individually listed in the API route definitions to avoid repetition. Instead, refer to this section to understand how to leverage these common behaviors across different routes. Note that all common parameters should be included in the query part of the URL.

Supported Common Parameters:

By utilizing these common parameters, you can tailor the behavior of API requests to suit your specific requirements, ensuring optimal performance and usability of the PropertyCatalog service.

Error Response

If a request encounters an issue, whether due to a logical fault or a technical problem, the service responds with a standardized JSON error structure. The HTTP status code within this response indicates the nature of the error, utilizing commonly recognized codes for clarity:

Each error response is structured to provide meaningful insight into the problem, assisting in diagnosing and resolving issues efficiently.

{
  "result": "ERR",
  "status": 400,
  "message": "errMsg_organizationIdisNotAValidID",
  "errCode": 400,
  "date": "2024-03-19T12:13:54.124Z",
  "detail": "String"
}

Object Structure of a Successfull Response

When the PropertyCatalog service processes requests successfully, it wraps the requested resource(s) within a JSON envelope. This envelope not only contains the data but also includes essential metadata, such as configuration details and pagination information, to enrich the response and provide context to the client.

Key Characteristics of the Response Envelope:

Design Considerations: The structure of a API’s response data is meticulously crafted during the service’s architectural planning. This design ensures that responses adequately reflect the intended data relationships and service logic, providing clients with rich and meaningful information.

Brief Data: Certain API’s return a condensed version of the object data, intentionally selecting only specific fields deemed useful for that request. In such instances, the API documentation will detail the properties included in the response, guiding developers on what to expect.

API Response Structure

The API utilizes a standardized JSON envelope to encapsulate responses. This envelope is designed to consistently deliver both the requested data and essential metadata, ensuring that clients can efficiently interpret and utilize the response.

HTTP Status Codes:

Success Response Format:

For successful operations, the response includes a "status": "OK" property, signaling the successful execution of the request. The structure of a successful response is outlined below:

{
  "status":"OK",
  "statusCode": 200,   
  "elapsedMs":126,
  "ssoTime":120,
  "source": "db",
  "cacheKey": "hexCode",
  "userId": "ID",
  "sessionId": "ID",
  "requestId": "ID",
  "dataName":"products",
  "method":"GET",
  "action":"list",
  "appVersion":"Version",
  "rowCount":3
  "products":[{},{},{}],
  "paging": {
    "pageNumber":1, 
    "pageRowCount":25, 
    "totalRowCount":3,
    "pageCount":1
  },
  "filters": [],
  "uiPermissions": []
}

Handling Errors:

For details on handling error scenarios and understanding the structure of error responses, please refer to the “Error Response” section provided earlier in this documentation. It outlines how error conditions are communicated, including the use of HTTP status codes and standardized JSON structures for error messages.

Resources

PropertyCatalog service provides the following resources which are stored in its own database as a data object. Note that a resource for an api access is a data object for the service.

ListingCalendar resource

Resource Definition : Represents daily availability, pricing, and reservation state for a listing (i.e., a property calendar entry). ListingCalendar Resource Properties

Name Type Required Default Definition
priceOverride Double **
date Date **
minStay Integer **
listingId ID **
bookedBy ID **
iCalUrl String **
externalCalendarIds String **
isAvailable Boolean **

ListingAmenity resource

Resource Definition : Dictionary of possible amenities (wifi, pool, etc.) for hosts to reference in their listings. ListingAmenity Resource Properties

Name Type Required Default Definition
iconUrl String **
name String **

Listing resource

Resource Definition : Represents a property or space offered for short-term rental by a host. Includes host ref, core attributes, pricing, location, seasonal pricing, media, and booking/policy properties… Listing Resource Properties

Name Type Required Default Definition
title String **
amenityIds ID **
hostId ID **
mainPhoto String **
photos String **
address String **
pricePerNight Double **
description Text **
propertyType Enum **
location Object **
maxStay Integer **
minStay Integer **
currency String **
seasonalPricing Object **
approvalType Enum **
bookingPolicies Object **
cancellationPolicy Object **
languagesSupported String **
houseRules Text **
isPublished Boolean **
cityTaxPercent Double **

Enum Properties

Enum properties are represented as strings in the database. The values are mapped to their corresponding names in the application layer.

propertyType Enum Property

Enum Options

Name Value Index
apartment "apartment"" 0
house "house"" 1
villa "villa"" 2
room "room"" 3
condo "condo"" 4
loft "loft"" 5
studio "studio"" 6
other "other"" 7
approvalType Enum Property

Enum Options

Name Value Index
instant "instant"" 0
manual "manual"" 1

ListingLocaleText resource

Resource Definition : Localized title & description texts for a property listing, per language. ListingLocaleText Resource Properties

Name Type Required Default Definition
localizedDescription Text **
localizedTitle String **
listingId ID **
languageCode String **

Business Api

Update Listing API

Update an existing listing owned by the host or admin.

Rest Route

The updateListing API REST controller can be triggered via the following route:

/v1/listings/:listingId

Rest Request Parameters

The updateListing api has got 21 regular request parameters

Parameter Type Required Population
listingId ID true request.params?.[“listingId”]
title String false request.body?.[“title”]
amenityIds ID false request.body?.[“amenityIds”]
mainPhoto String false request.body?.[“mainPhoto”]
photos String false request.body?.[“photos”]
address String false request.body?.[“address”]
pricePerNight Double false request.body?.[“pricePerNight”]
description Text false request.body?.[“description”]
propertyType Enum false request.body?.[“propertyType”]
location Object false request.body?.[“location”]
maxStay Integer false request.body?.[“maxStay”]
minStay Integer false request.body?.[“minStay”]
currency String false request.body?.[“currency”]
seasonalPricing Object false request.body?.[“seasonalPricing”]
approvalType Enum false request.body?.[“approvalType”]
bookingPolicies Object false request.body?.[“bookingPolicies”]
cancellationPolicy Object false request.body?.[“cancellationPolicy”]
languagesSupported String false request.body?.[“languagesSupported”]
houseRules Text false request.body?.[“houseRules”]
isPublished Boolean false request.body?.[“isPublished”]
cityTaxPercent Double false request.body?.[“cityTaxPercent”]
listingId : This id paremeter is used to select the required data object that will be updated
title :
amenityIds :
mainPhoto :
photos :
address :
pricePerNight :
description :
propertyType :
location :
maxStay :
minStay :
currency :
seasonalPricing :
approvalType :
bookingPolicies :
cancellationPolicy :
languagesSupported :
houseRules :
isPublished :
cityTaxPercent :

REST Request To access the api you can use the REST controller with the path PATCH /v1/listings/:listingId

  axios({
    method: 'PATCH',
    url: `/v1/listings/${listingId}`,
    data: {
            title:"String",  
            amenityIds:"ID",  
            mainPhoto:"String",  
            photos:"String",  
            address:"String",  
            pricePerNight:"Double",  
            description:"Text",  
            propertyType:"Enum",  
            location:"Object",  
            maxStay:"Integer",  
            minStay:"Integer",  
            currency:"String",  
            seasonalPricing:"Object",  
            approvalType:"Enum",  
            bookingPolicies:"Object",  
            cancellationPolicy:"Object",  
            languagesSupported:"String",  
            houseRules:"Text",  
            isPublished:"Boolean",  
            cityTaxPercent:"Double",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listing",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"listing": {
		"id": "ID",
		"title": "String",
		"amenityIds": "ID",
		"hostId": "ID",
		"mainPhoto": "String",
		"photos": "String",
		"address": "String",
		"pricePerNight": "Double",
		"description": "Text",
		"propertyType": "Enum",
		"propertyType_idx": "Integer",
		"location": "Object",
		"maxStay": "Integer",
		"minStay": "Integer",
		"currency": "String",
		"seasonalPricing": "Object",
		"approvalType": "Enum",
		"approvalType_idx": "Integer",
		"bookingPolicies": "Object",
		"cancellationPolicy": "Object",
		"languagesSupported": "String",
		"houseRules": "Text",
		"isPublished": "Boolean",
		"cityTaxPercent": "Double",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Create Listing API

Create a new rental property listing. Host must be the owner (session user).

Rest Route

The createListing API REST controller can be triggered via the following route:

/v1/listings

Rest Request Parameters

The createListing api has got 20 regular request parameters

Parameter Type Required Population
title String true request.body?.[“title”]
amenityIds ID false request.body?.[“amenityIds”]
mainPhoto String false request.body?.[“mainPhoto”]
photos String false request.body?.[“photos”]
address String true request.body?.[“address”]
pricePerNight Double true request.body?.[“pricePerNight”]
description Text true request.body?.[“description”]
propertyType Enum true request.body?.[“propertyType”]
location Object true request.body?.[“location”]
maxStay Integer false request.body?.[“maxStay”]
minStay Integer false request.body?.[“minStay”]
currency String true request.body?.[“currency”]
seasonalPricing Object false request.body?.[“seasonalPricing”]
approvalType Enum true request.body?.[“approvalType”]
bookingPolicies Object false request.body?.[“bookingPolicies”]
cancellationPolicy Object false request.body?.[“cancellationPolicy”]
languagesSupported String false request.body?.[“languagesSupported”]
houseRules Text false request.body?.[“houseRules”]
isPublished Boolean true request.body?.[“isPublished”]
cityTaxPercent Double false request.body?.[“cityTaxPercent”]
title :
amenityIds :
mainPhoto :
photos :
address :
pricePerNight :
description :
propertyType :
location :
maxStay :
minStay :
currency :
seasonalPricing :
approvalType :
bookingPolicies :
cancellationPolicy :
languagesSupported :
houseRules :
isPublished :
cityTaxPercent :

REST Request To access the api you can use the REST controller with the path POST /v1/listings

  axios({
    method: 'POST',
    url: '/v1/listings',
    data: {
            title:"String",  
            amenityIds:"ID",  
            mainPhoto:"String",  
            photos:"String",  
            address:"String",  
            pricePerNight:"Double",  
            description:"Text",  
            propertyType:"Enum",  
            location:"Object",  
            maxStay:"Integer",  
            minStay:"Integer",  
            currency:"String",  
            seasonalPricing:"Object",  
            approvalType:"Enum",  
            bookingPolicies:"Object",  
            cancellationPolicy:"Object",  
            languagesSupported:"String",  
            houseRules:"Text",  
            isPublished:"Boolean",  
            cityTaxPercent:"Double",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listing",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"listing": {
		"id": "ID",
		"title": "String",
		"amenityIds": "ID",
		"hostId": "ID",
		"mainPhoto": "String",
		"photos": "String",
		"address": "String",
		"pricePerNight": "Double",
		"description": "Text",
		"propertyType": "Enum",
		"propertyType_idx": "Integer",
		"location": "Object",
		"maxStay": "Integer",
		"minStay": "Integer",
		"currency": "String",
		"seasonalPricing": "Object",
		"approvalType": "Enum",
		"approvalType_idx": "Integer",
		"bookingPolicies": "Object",
		"cancellationPolicy": "Object",
		"languagesSupported": "String",
		"houseRules": "Text",
		"isPublished": "Boolean",
		"cityTaxPercent": "Double",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Listing API

Delete (soft-delete) a property listing. Host must be owner or admin.

Rest Route

The deleteListing API REST controller can be triggered via the following route:

/v1/listings/:listingId

Rest Request Parameters

The deleteListing api has got 1 regular request parameter

Parameter Type Required Population
listingId ID true request.params?.[“listingId”]
listingId : This id paremeter is used to select the required data object that will be deleted

REST Request To access the api you can use the REST controller with the path DELETE /v1/listings/:listingId

  axios({
    method: 'DELETE',
    url: `/v1/listings/${listingId}`,
    data: {
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listing",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"listing": {
		"id": "ID",
		"title": "String",
		"amenityIds": "ID",
		"hostId": "ID",
		"mainPhoto": "String",
		"photos": "String",
		"address": "String",
		"pricePerNight": "Double",
		"description": "Text",
		"propertyType": "Enum",
		"propertyType_idx": "Integer",
		"location": "Object",
		"maxStay": "Integer",
		"minStay": "Integer",
		"currency": "String",
		"seasonalPricing": "Object",
		"approvalType": "Enum",
		"approvalType_idx": "Integer",
		"bookingPolicies": "Object",
		"cancellationPolicy": "Object",
		"languagesSupported": "String",
		"houseRules": "Text",
		"isPublished": "Boolean",
		"cityTaxPercent": "Double",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Listings API

List all property listings (optionally filtered). Includes amenities and locales as joins for display search cards.

Rest Route

The listListings API REST controller can be triggered via the following route:

/v1/listings

Rest Request Parameters

Filter Parameters

The listListings api supports 7 optional filter parameters for filtering list results:

title (String): Filter by title

hostId (ID): Filter by hostId

address (String): Filter by address

pricePerNight (Double): Filter by pricePerNight

propertyType (Enum): Filter by propertyType

currency (String): Filter by currency

isPublished (Boolean): Filter by isPublished

REST Request To access the api you can use the REST controller with the path GET /v1/listings

  axios({
    method: 'GET',
    url: '/v1/listings',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // title: '<value>' // Filter by title
        // hostId: '<value>' // Filter by hostId
        // address: '<value>' // Filter by address
        // pricePerNight: '<value>' // Filter by pricePerNight
        // propertyType: '<value>' // Filter by propertyType
        // currency: '<value>' // Filter by currency
        // isPublished: '<value>' // Filter by isPublished
            }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listings",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"listings": [
		{
			"id": "ID",
			"title": "String",
			"amenityIds": "ID",
			"hostId": "ID",
			"mainPhoto": "String",
			"photos": "String",
			"address": "String",
			"pricePerNight": "Double",
			"description": "Text",
			"propertyType": "Enum",
			"propertyType_idx": "Integer",
			"location": "Object",
			"maxStay": "Integer",
			"minStay": "Integer",
			"currency": "String",
			"seasonalPricing": "Object",
			"approvalType": "Enum",
			"approvalType_idx": "Integer",
			"bookingPolicies": "Object",
			"cancellationPolicy": "Object",
			"languagesSupported": "String",
			"houseRules": "Text",
			"isPublished": "Boolean",
			"cityTaxPercent": "Double",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID",
			"reviews": {
				"rating": "Integer",
				"revieweeId": "ID"
			},
			"amenities": {
				"iconUrl": "String",
				"name": "String"
			}
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Update Listingcalendar API

Update a calendar entry (availablity, pricing, reservation) for a listing date.

Rest Route

The updateListingCalendar API REST controller can be triggered via the following route:

/v1/listingcalendars/:listingCalendarId

Rest Request Parameters

The updateListingCalendar api has got 7 regular request parameters

Parameter Type Required Population
listingCalendarId ID true request.params?.[“listingCalendarId”]
priceOverride Double false request.body?.[“priceOverride”]
minStay Integer false request.body?.[“minStay”]
bookedBy ID false request.body?.[“bookedBy”]
iCalUrl String false request.body?.[“iCalUrl”]
externalCalendarIds String false request.body?.[“externalCalendarIds”]
isAvailable Boolean false request.body?.[“isAvailable”]
listingCalendarId : This id paremeter is used to select the required data object that will be updated
priceOverride :
minStay :
bookedBy :
iCalUrl :
externalCalendarIds :
isAvailable :

REST Request To access the api you can use the REST controller with the path PATCH /v1/listingcalendars/:listingCalendarId

  axios({
    method: 'PATCH',
    url: `/v1/listingcalendars/${listingCalendarId}`,
    data: {
            priceOverride:"Double",  
            minStay:"Integer",  
            bookedBy:"ID",  
            iCalUrl:"String",  
            externalCalendarIds:"String",  
            isAvailable:"Boolean",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listingCalendar",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"listingCalendar": {
		"id": "ID",
		"priceOverride": "Double",
		"date": "Date",
		"minStay": "Integer",
		"listingId": "ID",
		"bookedBy": "ID",
		"iCalUrl": "String",
		"externalCalendarIds": "String",
		"isAvailable": "Boolean",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Create Listingcalendar API

Add a calendar entry for a listing/date—controls availability or booking info for that day.

Rest Route

The createListingCalendar API REST controller can be triggered via the following route:

/v1/listingcalendars

Rest Request Parameters

The createListingCalendar api has got 8 regular request parameters

Parameter Type Required Population
priceOverride Double false request.body?.[“priceOverride”]
date Date true request.body?.[“date”]
minStay Integer false request.body?.[“minStay”]
listingId ID true request.body?.[“listingId”]
bookedBy ID false request.body?.[“bookedBy”]
iCalUrl String false request.body?.[“iCalUrl”]
externalCalendarIds String false request.body?.[“externalCalendarIds”]
isAvailable Boolean true request.body?.[“isAvailable”]
priceOverride :
date :
minStay :
listingId :
bookedBy :
iCalUrl :
externalCalendarIds :
isAvailable :

REST Request To access the api you can use the REST controller with the path POST /v1/listingcalendars

  axios({
    method: 'POST',
    url: '/v1/listingcalendars',
    data: {
            priceOverride:"Double",  
            date:"Date",  
            minStay:"Integer",  
            listingId:"ID",  
            bookedBy:"ID",  
            iCalUrl:"String",  
            externalCalendarIds:"String",  
            isAvailable:"Boolean",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listingCalendar",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"listingCalendar": {
		"id": "ID",
		"priceOverride": "Double",
		"date": "Date",
		"minStay": "Integer",
		"listingId": "ID",
		"bookedBy": "ID",
		"iCalUrl": "String",
		"externalCalendarIds": "String",
		"isAvailable": "Boolean",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Listingcalendar API

Delete (soft-delete) a listing calendar entry (by host/admin).

Rest Route

The deleteListingCalendar API REST controller can be triggered via the following route:

/v1/listingcalendars/:listingCalendarId

Rest Request Parameters

The deleteListingCalendar api has got 1 regular request parameter

Parameter Type Required Population
listingCalendarId ID true request.params?.[“listingCalendarId”]
listingCalendarId : This id paremeter is used to select the required data object that will be deleted

REST Request To access the api you can use the REST controller with the path DELETE /v1/listingcalendars/:listingCalendarId

  axios({
    method: 'DELETE',
    url: `/v1/listingcalendars/${listingCalendarId}`,
    data: {
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listingCalendar",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"listingCalendar": {
		"id": "ID",
		"priceOverride": "Double",
		"date": "Date",
		"minStay": "Integer",
		"listingId": "ID",
		"bookedBy": "ID",
		"iCalUrl": "String",
		"externalCalendarIds": "String",
		"isAvailable": "Boolean",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Listingcalendar API

Get a calendar date entry for a listing.

Rest Route

The getListingCalendar API REST controller can be triggered via the following route:

/v1/listingcalendars/:listingCalendarId

Rest Request Parameters

The getListingCalendar api has got 1 regular request parameter

Parameter Type Required Population
listingCalendarId ID true request.params?.[“listingCalendarId”]
listingCalendarId : This id paremeter is used to query the required data object.

REST Request To access the api you can use the REST controller with the path GET /v1/listingcalendars/:listingCalendarId

  axios({
    method: 'GET',
    url: `/v1/listingcalendars/${listingCalendarId}`,
    data: {
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listingCalendar",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"listingCalendar": {
		"id": "ID",
		"priceOverride": "Double",
		"date": "Date",
		"minStay": "Integer",
		"listingId": "ID",
		"bookedBy": "ID",
		"iCalUrl": "String",
		"externalCalendarIds": "String",
		"isAvailable": "Boolean",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Listingcalendars API

List calendar entries for one or more listings/dates. Used for display and availability search.

Rest Route

The listListingCalendars API REST controller can be triggered via the following route:

/v1/listingcalendars

Rest Request Parameters

Filter Parameters

The listListingCalendars api supports 2 optional filter parameters for filtering list results:

date (Date): Filter by date

listingId (ID): Filter by listingId

REST Request To access the api you can use the REST controller with the path GET /v1/listingcalendars

  axios({
    method: 'GET',
    url: '/v1/listingcalendars',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // date: '<value>' // Filter by date
        // listingId: '<value>' // Filter by listingId
            }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listingCalendars",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"listingCalendars": [
		{
			"id": "ID",
			"priceOverride": "Double",
			"date": "Date",
			"minStay": "Integer",
			"listingId": "ID",
			"bookedBy": "ID",
			"iCalUrl": "String",
			"externalCalendarIds": "String",
			"isAvailable": "Boolean",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Get Listing API

Get a property listing, including enriched amenities and available locales.

Rest Route

The getListing API REST controller can be triggered via the following route:

/v1/listings/:listingId

Rest Request Parameters

The getListing api has got 1 regular request parameter

Parameter Type Required Population
listingId ID true request.params?.[“listingId”]
listingId : This id paremeter is used to query the required data object.

REST Request To access the api you can use the REST controller with the path GET /v1/listings/:listingId

  axios({
    method: 'GET',
    url: `/v1/listings/${listingId}`,
    data: {
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listing",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"listing": {
		"id": "ID",
		"title": "String",
		"amenityIds": "ID",
		"hostId": "ID",
		"mainPhoto": "String",
		"photos": "String",
		"address": "String",
		"pricePerNight": "Double",
		"description": "Text",
		"propertyType": "Enum",
		"propertyType_idx": "Integer",
		"location": "Object",
		"maxStay": "Integer",
		"minStay": "Integer",
		"currency": "String",
		"seasonalPricing": "Object",
		"approvalType": "Enum",
		"approvalType_idx": "Integer",
		"bookingPolicies": "Object",
		"cancellationPolicy": "Object",
		"languagesSupported": "String",
		"houseRules": "Text",
		"isPublished": "Boolean",
		"cityTaxPercent": "Double",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"amenities": {
			"iconUrl": "String",
			"name": "String"
		},
		"reviews": {
			"moderationStatus": "Enum",
			"moderationStatus_idx": "Integer",
			"isPublished": "Boolean",
			"reviewText": "Text",
			"rating": "Integer",
			"revieweeId": "ID",
			"reservationId": "ID",
			"reviewerId": "ID",
			"revieweeType": "Enum",
			"revieweeType_idx": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date"
		},
		"rezervations": [
			{
				"bookingStatus": "Enum",
				"bookingStatus_idx": "Integer",
				"guestId": "ID"
			},
			{},
			{}
		]
	}
}

Create Listinglocaletext API

Add a localized title & description for a listing/language pair.

Rest Route

The createListingLocaleText API REST controller can be triggered via the following route:

/v1/listinglocaletexts

Rest Request Parameters

The createListingLocaleText api has got 4 regular request parameters

Parameter Type Required Population
localizedDescription Text true request.body?.[“localizedDescription”]
localizedTitle String true request.body?.[“localizedTitle”]
listingId ID true request.body?.[“listingId”]
languageCode String true request.body?.[“languageCode”]
localizedDescription :
localizedTitle :
listingId :
languageCode :

REST Request To access the api you can use the REST controller with the path POST /v1/listinglocaletexts

  axios({
    method: 'POST',
    url: '/v1/listinglocaletexts',
    data: {
            localizedDescription:"Text",  
            localizedTitle:"String",  
            listingId:"ID",  
            languageCode:"String",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listingLocaleText",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"listingLocaleText": {
		"id": "ID",
		"localizedDescription": "Text",
		"localizedTitle": "String",
		"listingId": "ID",
		"languageCode": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Listingamenities API

List all amenity options (public for guests/hosts creating listings).

Rest Route

The listListingAmenities API REST controller can be triggered via the following route:

/v1/listingamenities

Rest Request Parameters

Filter Parameters

The listListingAmenities api supports 1 optional filter parameter for filtering list results:

name (String): Filter by name

REST Request To access the api you can use the REST controller with the path GET /v1/listingamenities

  axios({
    method: 'GET',
    url: '/v1/listingamenities',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // name: '<value>' // Filter by name
            }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listingAmenities",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"listingAmenities": [
		{
			"id": "ID",
			"iconUrl": "String",
			"name": "String",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Delete Listinglocaletext API

Delete (soft-delete) a locale text entry for a listing/language.

Rest Route

The deleteListingLocaleText API REST controller can be triggered via the following route:

/v1/listinglocaletexts/:listingLocaleTextId

Rest Request Parameters

The deleteListingLocaleText api has got 1 regular request parameter

Parameter Type Required Population
listingLocaleTextId ID true request.params?.[“listingLocaleTextId”]
listingLocaleTextId : This id paremeter is used to select the required data object that will be deleted

REST Request To access the api you can use the REST controller with the path DELETE /v1/listinglocaletexts/:listingLocaleTextId

  axios({
    method: 'DELETE',
    url: `/v1/listinglocaletexts/${listingLocaleTextId}`,
    data: {
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listingLocaleText",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"listingLocaleText": {
		"id": "ID",
		"localizedDescription": "Text",
		"localizedTitle": "String",
		"listingId": "ID",
		"languageCode": "String",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Listinglocaletexts API

List all localized texts for a given listing (multi-language support).

Rest Route

The listListingLocaleTexts API REST controller can be triggered via the following route:

/v1/listinglocaletexts

Rest Request Parameters

Filter Parameters

The listListingLocaleTexts api supports 2 optional filter parameters for filtering list results:

listingId (ID): Filter by listingId

languageCode (String): Filter by languageCode

REST Request To access the api you can use the REST controller with the path GET /v1/listinglocaletexts

  axios({
    method: 'GET',
    url: '/v1/listinglocaletexts',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // listingId: '<value>' // Filter by listingId
        // languageCode: '<value>' // Filter by languageCode
            }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listingLocaleTexts",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"listingLocaleTexts": [
		{
			"id": "ID",
			"localizedDescription": "Text",
			"localizedTitle": "String",
			"listingId": "ID",
			"languageCode": "String",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Update Listinglocaletext API

Update a localized title/description for a listing/language.

Rest Route

The updateListingLocaleText API REST controller can be triggered via the following route:

/v1/listinglocaletexts/:listingLocaleTextId

Rest Request Parameters

The updateListingLocaleText api has got 3 regular request parameters

Parameter Type Required Population
listingLocaleTextId ID true request.params?.[“listingLocaleTextId”]
localizedDescription Text false request.body?.[“localizedDescription”]
localizedTitle String false request.body?.[“localizedTitle”]
listingLocaleTextId : This id paremeter is used to select the required data object that will be updated
localizedDescription :
localizedTitle :

REST Request To access the api you can use the REST controller with the path PATCH /v1/listinglocaletexts/:listingLocaleTextId

  axios({
    method: 'PATCH',
    url: `/v1/listinglocaletexts/${listingLocaleTextId}`,
    data: {
            localizedDescription:"Text",  
            localizedTitle:"String",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listingLocaleText",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"listingLocaleText": {
		"id": "ID",
		"localizedDescription": "Text",
		"localizedTitle": "String",
		"listingId": "ID",
		"languageCode": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Update Listingamenity API

Update an amenity (admin only).

Rest Route

The updateListingAmenity API REST controller can be triggered via the following route:

/v1/listingamenities/:listingAmenityId

Rest Request Parameters

The updateListingAmenity api has got 2 regular request parameters

Parameter Type Required Population
listingAmenityId ID true request.params?.[“listingAmenityId”]
iconUrl String false request.body?.[“iconUrl”]
listingAmenityId : This id paremeter is used to select the required data object that will be updated
iconUrl :

REST Request To access the api you can use the REST controller with the path PATCH /v1/listingamenities/:listingAmenityId

  axios({
    method: 'PATCH',
    url: `/v1/listingamenities/${listingAmenityId}`,
    data: {
            iconUrl:"String",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listingAmenity",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"listingAmenity": {
		"id": "ID",
		"iconUrl": "String",
		"name": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Listingamenity API

Get information for a listed amenity (public).

Rest Route

The getListingAmenity API REST controller can be triggered via the following route:

/v1/listingamenities/:listingAmenityId

Rest Request Parameters

The getListingAmenity api has got 1 regular request parameter

Parameter Type Required Population
listingAmenityId ID true request.params?.[“listingAmenityId”]
listingAmenityId : This id paremeter is used to query the required data object.

REST Request To access the api you can use the REST controller with the path GET /v1/listingamenities/:listingAmenityId

  axios({
    method: 'GET',
    url: `/v1/listingamenities/${listingAmenityId}`,
    data: {
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listingAmenity",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"listingAmenity": {
		"id": "ID",
		"iconUrl": "String",
		"name": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Listinglocaletext API

Get localized listing title/description (by listing/language).

Rest Route

The getListingLocaleText API REST controller can be triggered via the following route:

/v1/listinglocaletexts/:listingLocaleTextId

Rest Request Parameters

The getListingLocaleText api has got 1 regular request parameter

Parameter Type Required Population
listingLocaleTextId ID true request.params?.[“listingLocaleTextId”]
listingLocaleTextId : This id paremeter is used to query the required data object.

REST Request To access the api you can use the REST controller with the path GET /v1/listinglocaletexts/:listingLocaleTextId

  axios({
    method: 'GET',
    url: `/v1/listinglocaletexts/${listingLocaleTextId}`,
    data: {
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listingLocaleText",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"listingLocaleText": {
		"id": "ID",
		"localizedDescription": "Text",
		"localizedTitle": "String",
		"listingId": "ID",
		"languageCode": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Create Listingamenity API

Add a new amenity to the master amenity list.

Rest Route

The createListingAmenity API REST controller can be triggered via the following route:

/v1/listingamenities

Rest Request Parameters

The createListingAmenity api has got 2 regular request parameters

Parameter Type Required Population
iconUrl String false request.body?.[“iconUrl”]
name String true request.body?.[“name”]
iconUrl :
name :

REST Request To access the api you can use the REST controller with the path POST /v1/listingamenities

  axios({
    method: 'POST',
    url: '/v1/listingamenities',
    data: {
            iconUrl:"String",  
            name:"String",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listingAmenity",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"listingAmenity": {
		"id": "ID",
		"iconUrl": "String",
		"name": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Listingamenity API

Delete (soft-delete) an amenity (admin only).

Rest Route

The deleteListingAmenity API REST controller can be triggered via the following route:

/v1/listingamenities/:listingAmenityId

Rest Request Parameters

The deleteListingAmenity api has got 1 regular request parameter

Parameter Type Required Population
listingAmenityId ID true request.params?.[“listingAmenityId”]
listingAmenityId : This id paremeter is used to select the required data object that will be deleted

REST Request To access the api you can use the REST controller with the path DELETE /v1/listingamenities/:listingAmenityId

  axios({
    method: 'DELETE',
    url: `/v1/listingamenities/${listingAmenityId}`,
    data: {
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "listingAmenity",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"listingAmenity": {
		"id": "ID",
		"iconUrl": "String",
		"name": "String",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Authentication Specific Routes

Common Routes

Route: currentuser

Route Definition: Retrieves the currently authenticated user’s session information.

Route Type: sessionInfo

Access Route: GET /currentuser

Parameters

This route does not require any request parameters.

Behavior

// Sample GET /currentuser call
axios.get("/currentuser", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});

Success Response Returns the session object, including user-related data and token information.

{
  "sessionId": "9cf23fa8-07d4-4e7c-80a6-ec6d6ac96bb9",
  "userId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
  "email": "user@example.com",
  "fullname": "John Doe",
  "roleId": "user",
  "tenantId": "abc123",
  "accessToken": "jwt-token-string",
  ...
}

Error Response 401 Unauthorized: No active session found.

{
  "status": "ERR",
  "message": "No login found"
}

Notes

Route: permissions

*Route Definition*: Retrieves all effective permission records assigned to the currently authenticated user.

*Route Type*: permissionFetch

Access Route: GET /permissions

Parameters

This route does not require any request parameters.

Behavior

// Sample GET /permissions call
axios.get("/permissions", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});

Success Response

Returns an array of permission objects.

[
  {
    "id": "perm1",
    "permissionName": "adminPanel.access",
    "roleId": "admin",
    "subjectUserId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
    "subjectUserGroupId": null,
    "objectId": null,
    "canDo": true,
    "tenantCodename": "store123"
  },
  {
    "id": "perm2",
    "permissionName": "orders.manage",
    "roleId": null,
    "subjectUserId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
    "subjectUserGroupId": null,
    "objectId": null,
    "canDo": true,
    "tenantCodename": "store123"
  }
]

Each object reflects a single permission grant, aligned with the givenPermissions model:

Error Responses

{
  "status": "ERR",
  "message": "No login found"
}

Notes

Tip: Applications can cache permission results client-side or server-side, but should occasionally refresh by calling this endpoint, especially after login or permission-changing operations.

Route: permissions/:permissionName

Route Definition: Checks whether the current user has access to a specific permission, and provides a list of scoped object exceptions or inclusions.

Route Type: permissionScopeCheck

Access Route: GET /permissions/:permissionName

Parameters

Parameter Type Required Population
permissionName String Yes request.params.permissionName

Behavior

// Sample GET /permissions/orders.manage
axios.get("/permissions/orders.manage", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});

Success Response

{
  "canDo": true,
  "exceptions": [
    "a1f2e3d4-xxxx-yyyy-zzzz-object1",
    "b2c3d4e5-xxxx-yyyy-zzzz-object2"
  ]
}

All sources, documents and other digital materials are copyright of .

About Us

For more information please visit our website: .

. .