Shopping Cart
Retrieve shopping cart for a lead
Returns the shopping cart with all items and related amounts for the specified lead. Requires verification token for authentication.
GET
/
shopping
/
{portfolio}
/
v1
/
shopping-cart
/
unitGroup
/
{unitGroupUuid}
/
lead
/
{leadUuid}
Retrieve shopping cart for a lead
curl --request GET \
--url https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/unitGroup/{unitGroupUuid}/lead/{leadUuid} \
--header 'x-api-key: <x-api-key>'import requests
url = "https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/unitGroup/{unitGroupUuid}/lead/{leadUuid}"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/unitGroup/{unitGroupUuid}/lead/{leadUuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/unitGroup/{unitGroupUuid}/lead/{leadUuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/unitGroup/{unitGroupUuid}/lead/{leadUuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/unitGroup/{unitGroupUuid}/lead/{leadUuid}")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/unitGroup/{unitGroupUuid}/lead/{leadUuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"leadUuid": "<string>",
"itemType": {
"itemTypeUuid": "<string>",
"itemTypeName": "<string>",
"description": "<string>",
"isTaxable": true,
"isRecurring": true,
"isRequiredAtMoveIn": true,
"isRequiredAtTransfer": true,
"isReadOnly": true,
"isActive": true,
"numberOfFacilities": 123,
"amount": "<string>",
"isProratedAtMoveIn": true,
"amountInPennies": 123,
"taxAmountInPennies": 123,
"entityAttributeOrganizationUuid": "<string>",
"entityAttributeOrganizationDescription": "<string>",
"fixedFeeAmount": 123,
"feePercentage": 123,
"fullNonProratedAmount": 123,
"glAccountTypeUuid": "<string>",
"promotion": {
"promotionUuid": "<string>",
"promotionName": "<string>",
"discountType": "<string>",
"discountAmountInPennies": 123,
"internalNote": "<string>"
},
"promotions": [
{
"promotionUuid": "<string>",
"promotionName": "<string>",
"discountType": "<string>",
"discountAmountInPennies": 123,
"internalNote": "<string>"
}
],
"feeConditions": [
{
"itemTypeFeeConditionUuid": "<string>",
"sortOrder": 123,
"rentRangeFrom": 123,
"rentRangeTo": 123,
"rateThreshold": 123
}
]
},
"shoppingCartItemUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dateDesiredMoveIn": "2023-11-07T05:31:56Z",
"amountInPennies": 123,
"preProrationAmountInPennies": 123,
"billingPeriod": 123
}
],
"dateDesiredMoveIn": "2023-11-07T05:31:56Z",
"surcharge": {
"isApplicable": true,
"effectivePercentage": 123,
"surchargeAmountInPennies": 123
}
}Headers
Api key required to authenticate your request. Please reach out to monument for a key.
Example:
"monument-2230012-2312321"
Query Parameters
Optional. When set to "ACH", the cart response will not include a credit-card surcharge. Omit to assume credit-card (default).
Available options:
ACH Response
The shopping cart for the provided lead, with all related amounts
⌘I
Retrieve shopping cart for a lead
curl --request GET \
--url https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/unitGroup/{unitGroupUuid}/lead/{leadUuid} \
--header 'x-api-key: <x-api-key>'import requests
url = "https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/unitGroup/{unitGroupUuid}/lead/{leadUuid}"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/unitGroup/{unitGroupUuid}/lead/{leadUuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/unitGroup/{unitGroupUuid}/lead/{leadUuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/unitGroup/{unitGroupUuid}/lead/{leadUuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/unitGroup/{unitGroupUuid}/lead/{leadUuid}")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.prd.monument.io/shopping/{portfolio}/v1/shopping-cart/unitGroup/{unitGroupUuid}/lead/{leadUuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"leadUuid": "<string>",
"itemType": {
"itemTypeUuid": "<string>",
"itemTypeName": "<string>",
"description": "<string>",
"isTaxable": true,
"isRecurring": true,
"isRequiredAtMoveIn": true,
"isRequiredAtTransfer": true,
"isReadOnly": true,
"isActive": true,
"numberOfFacilities": 123,
"amount": "<string>",
"isProratedAtMoveIn": true,
"amountInPennies": 123,
"taxAmountInPennies": 123,
"entityAttributeOrganizationUuid": "<string>",
"entityAttributeOrganizationDescription": "<string>",
"fixedFeeAmount": 123,
"feePercentage": 123,
"fullNonProratedAmount": 123,
"glAccountTypeUuid": "<string>",
"promotion": {
"promotionUuid": "<string>",
"promotionName": "<string>",
"discountType": "<string>",
"discountAmountInPennies": 123,
"internalNote": "<string>"
},
"promotions": [
{
"promotionUuid": "<string>",
"promotionName": "<string>",
"discountType": "<string>",
"discountAmountInPennies": 123,
"internalNote": "<string>"
}
],
"feeConditions": [
{
"itemTypeFeeConditionUuid": "<string>",
"sortOrder": 123,
"rentRangeFrom": 123,
"rentRangeTo": 123,
"rateThreshold": 123
}
]
},
"shoppingCartItemUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dateDesiredMoveIn": "2023-11-07T05:31:56Z",
"amountInPennies": 123,
"preProrationAmountInPennies": 123,
"billingPeriod": 123
}
],
"dateDesiredMoveIn": "2023-11-07T05:31:56Z",
"surcharge": {
"isApplicable": true,
"effectivePercentage": 123,
"surchargeAmountInPennies": 123
}
}
