Developer Documentation
Platform Overview
Authentication
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Listing Updates IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: FloPlans Listings: Historical Listings: History Listings: Hot Sheet Parameters Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics Messages News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata Preferences Properties Properties: Clusters Properties Meta: Standard Fields Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
Terms of Use

Listing Carts: Portal Carts

Portal carts are consumer-only (e.g. VOW or Portal role) carts that are automatically generated for each consumer. While their contents can be modified, the carts themselves cannot be deleted or renamed.

  1. Supported Roles
  2. Available Services
    1. Portal Carts
    2. Favorites Cart
    3. Rejects Cart
  3. Portal Carts Description
  4. Expansions
  5. API Explorer
 

Supported Roles

Role Reads Writes Notes
IDX No No
Public No No
VOW Yes No
Portal Yes No
Private No No

More information about roles may be found here.

 

Available Services

Portal Carts

Portal carts as a subresource of contacts are only available in a private role.

/<API Version>/listingcarts/portal
/<API Version>/contacts/<Contact.Id>/listingcarts/portal

HTTP Method Description Notes
GET Returns all Portal carts associated with the current consumer
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:

 

GET Response

See the GET request section for listing carts.

Favorites Cart

Portal carts as a subresource of contacts are only available in a private role.

/<API Version>/listingcarts/portal/favorites
/<API Version>/contacts/<Contact.Id>/listingcarts/portal/favorites

HTTP Method Description Notes
GET Returns favorites cart associated with the current consumer
POST Adds listing IDs to current consumers favorites cart
PUT Returns HTTP 405 (Method Not Allowed) Not implemented
DELETE Remove listing IDs from current consumer favorites cart

POST Request Body

Example:

{
    "D": {
        "ListingIds": ["20100912153422758914000000", "20100912153422758914000001"]
    }
}
 

DELETE Request

Parameters:

Parameter Required Description
ListingIds Yes Comma separated list of listing IDs to be removed.

GET/POST/DELETE Response

{
    "D": {[{
      "ResourceURI": "/vX/listingcarts/20100912153422758914000000",
      "Id": "20100912153422758914000000",
      "Name": "Favorites",
      "ListingCount": 2,
      "CreatedBy": "20060412165917817933000000",
      "PortalCartType": "Favorites",
      "VowAdded": [],
      "VowRemoved": [],
      "ListingIds": ["20100912153422758914000000", "20100912153422758914000001"]
    }]}
}
 

Rejects Cart

Portal carts as a subresource of contacts are only available in a private role.

/<API Version>/listingcarts/portal/rejects
/<API Version>/contacts/<Contact.Id>/listingcarts/portal/rejects

HTTP Method Description Notes
GET Returns rejects cart associated with the current consumer
POST Adds listing IDs to current consumers rejects cart
PUT Returns HTTP 405 (Method Not Allowed) Not implemented
DELETE Remove listing IDs from current consumer rejects cart

POST Request Body

Example:

{
    "D": {
        "ListingIds": ["20100912153422758914000000", "20100912153422758914000001"]
    }
}
 

DELETE Request

Parameters:

Parameter Required Description
ListingIds Yes Comma separated list of listing IDs to be removed.

GET/POST/DELETE Response

{
    "D": {[{
      "ResourceURI": "/vX/listingcarts/20100912153422758914000000",
      "Id": "20100912153422758914000000",
      "Name": "Rejects",
      "ListingCount": 2,
      "CreatedBy": nil,
      "PortalCartType": "Rejects",
      "VowAdded": [],
      "VowRemoved": [],
      "ListingIds": ["20100912153422758914000000", "20100912153422758914000001"]
    }]}
}
 

Portal Cart Description

See the Listing Cart Description section for listing carts.

Expansions

Expansion Roles Single Record Only? Selection Support? Description
ListingIds Private, Portal, VOW No No An array of ListingIds contained in the cart. Favorites/Rejects routes will always return as if this were requested
 
 

API Explorer

The API Explorer does not currently support this service.