ShoppingApi
- GETGet all facilities
- POSTCreate a new lead
- GETValidate lead verification token
- PUTUpdate lead indicated, setting their personal information, facility, unit group, and services
- POSTCall when a lead exits the shopping experience, marking them as immediately visible in the FMS.
- POSTAction to take when a lead is fully filled out and is ready to generate a lease. Will mark a unit in the unit group they've selected as reserved.
- GETGet details for a converted lead
- POSTChecks if a tenant already exists with this email, sends a verfication code to their email they must retrieve if so
- POSTAuthenticates that the verification code matches the one sent to the tenants email. If successful, creates a new lead pre-assocatiated with this tenant.
- GETGet billing template for a lead
- GETGet unit groups for a facility
- GETGet facility details
- GETCheck if a lead has been converted
- GETGet rental flow configuration for a facility
- GETRetrieve access plans for a facility
- GETRetrieve shopping cart for a lead
- GETGet unit group details
- GETGet tax information for a unit group
- GETGet payment processor information
- GETRetrieve payment processor info for a given facility
- POSTCreate a payment profile for a lead to use for their initial and future payments
- GETGet Payrix public API key
- GETGet Unit by Lead UUID and Verify Code
- POSTGet Gate Access Code by Lead UUID and Verify Code
- GETGet private coverage information
- GETGet coverage options for a facility
ShoppingApi
Retrieve access plans for a facility
Returns the access plans for the specified facility with all related items.
GET
/
shopping
/
{portfolio}
/
v1
/
shopping-cart
/
access-plans
/
{facilityUuid}
Copy
[
{
"accessPlanUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemType": {
"itemTypeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemTypeName": "<string>",
"description": "<string>",
"category": "<string>",
"isRecurring": true,
"isRequiredAtMoveIn": true,
"isRequiredAtTransfer": true,
"isReadOnly": true,
"isTaxable": true,
"taxCode": "<string>",
"isActive": true,
"isProratedAtMoveIn": true,
"feeType": "<string>",
"fixedFeeAmount": 123,
"feePercentage": 123
},
"accessPlanDayRules": [
{
"isOpen": false,
"dayOfWeek": "Mon",
"accessStartTime": "<string>",
"accessEndTime": "<string>",
"accessPlanDayRuleUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accessPlanUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"name": "<string>",
"isDefault": true,
"isLegacy": true,
"planNameDescription": "<string>"
}
]Path Parameters
Response
200 - application/json
The access plans for the specified facility with all related items
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Indicates if the access plan day rule is active
Available options:
Mon, Tue, Wed, Thu, Fri, Sat, Sun Start time in HH:mm:ss format
End time in HH:mm:ss format
Previous
Retrieve shopping cart for a leadReturns the shopping cart with all items and related amounts for the specified lead. Requires verification token for authentication.
Next
⌘I
Copy
[
{
"accessPlanUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemType": {
"itemTypeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"itemTypeName": "<string>",
"description": "<string>",
"category": "<string>",
"isRecurring": true,
"isRequiredAtMoveIn": true,
"isRequiredAtTransfer": true,
"isReadOnly": true,
"isTaxable": true,
"taxCode": "<string>",
"isActive": true,
"isProratedAtMoveIn": true,
"feeType": "<string>",
"fixedFeeAmount": 123,
"feePercentage": 123
},
"accessPlanDayRules": [
{
"isOpen": false,
"dayOfWeek": "Mon",
"accessStartTime": "<string>",
"accessEndTime": "<string>",
"accessPlanDayRuleUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accessPlanUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"name": "<string>",
"isDefault": true,
"isLegacy": true,
"planNameDescription": "<string>"
}
]