Skip to main content
GET
Retrieve shopping cart for a lead

Headers

x-api-key
any
required

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

leadUuid
string
required
unitGroupUuid
string<uuid>
required

Query Parameters

verifyToken
string
required
paymentType
enum<string>

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

items
object[]
required
dateDesiredMoveIn
string<date-time> | null
surcharge
object | null

Optional surcharge summary used by the rental flow. Only present on responses produced by the rental-flow path; legacy callers may safely ignore this field.