Listing Carts

Listing Carts are a personal collection of listings that can be modified or used as search criteria.
  1. Supported Roles
  2. Available Services
    1. Listing Carts
    2. Individual Listing Cart
    3. Carts for a Specified Listing
    4. Remove a Listing from a Cart
  3. Listing Cart Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads? Writes?
IDX Yes Yes
VOW (As Portal Group) Yes Yes
Private Yes Yes
More information about roles may be found here.

Available Services

Listing Carts

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

URI: /<API Version>/listingcarts

URI: /<API Version>/contacts/<Contact.Id>/listingcarts

HTTP Method Description Notes
GET Returns a list of all listing carts for the current user
POST Creates a new listing cart.
PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
Parameter Required
Standard paging syntax (_filter not supported.) No

GET Response

Example:
{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/vX/listingcarts/20100912153422758914000000",
                "Id": "20100912153422758914000000",
                "Name": "My Listing Cart",
                "ListingCount": 10 // number of listings in that cart
            },
            {
                "ResourceUri": "/vX/listingcarts/20110112133422752751000000",
                "Id": "20110112133422752751000000",
                "Name": "My Other Listing Cart",
                "ListingCount": 15
            }
        ]
    }
}

POST Request

Request body:
{
    "D": {
      "ListingCarts": [{
        "Name": "My Cart's Name",
        "ListingIds": [
            "20110112234857732941000000",
            "20110302120238448431000000",
            "20110510011212354751000000"
        ]
      }]
  }
}

POST Response

The standard success/fail response is returned.

Individual Listing Cart

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

URI: /<API Version>/listingcarts/<Id>

URI: /<API Version>/contacts/<Contact.Id>/listingcarts/<Id>

HTTP Method Description Notes
GET Returns the data for an individual listing cart
POST Add additional listings to an existing listing cart.
PUT Replace an existing set of listings for a listing cart.
DELETE Destroy an existing listing cart.

GET Request

Parameters:
  • None

GET Response

Example:
{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/vX/listingcarts/20100912153422758914000000",
                "Id": "20100912153422758914000000",
                "Name": "My Listing Cart",
                "ListingIds": [
                  "20110112234857732941000000",
                  "20110302120238448431000000",
                  "20110510011212354751000000"
                ]
            },
            {
                "ResourceUri": "/vX/listingcarts/20110112133422752751000000",
                "Id": "20110112133422752751000000",
                "Name": "My Other Listing Cart",
                "ListingIds": [
                  "20110112234854732941000000",
                  "20110302120128448431000000",
                  "20110410011212354751000000"
                ]
            }
        ]
    }
}

POST Request

Request body:
{
    "D": {
      "ListingIds": [
        "20110112234857732941000000",
        "20110302120238448431000000",
        "20110510011212354751000000"
      ]
  }
}

POST Response

The standard success/fail response is returned.

When posting to a listing cart as a subresource of a contact, a private role may reset the VowAdded or VowRemoved arrays to an empty state by posting a 0 for those attributes:

Request body:
{
    "D": {
      "ListingIds": [
        "20110112234857732941000000",
        "20110302120238448431000000",
        "20110510011212354751000000"
      ],
      "VowAdded": 0,
      "VowRemoved": 0
  }
}

PUT Request

Request body: See the POST response section above for the data format.

PUT Response

The standard success/fail response is returned.

DELETE Request

Parameters:
  • None

DELETE Response

The standard success/fail response is returned.

Carts for a Specified Listing

URI: /<API Version>/listingcarts/for/<Listing.Id>

HTTP Method Description Notes
GET Returns a list of all carts owned by the current user containing the specified listing
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

Remove a Listing from a Cart

URI: /<API Version>/listingcarts/<Id>/listings/<Listing.Id>

URI: /<API Version>/contacts/<Contact.Id>/listingcarts/<Id>/listings/<Listing.Id>

HTTP Method Description Notes
GET,POST,PUT Returns HTTP 405 (Method Not Allowed) Not implemented
DELETE Removes a listing from a cart

DELETE Request

Parameters:
None.

DELETE Response

The standard success/fail response is returned.

Listing Cart Description

Attribute Data Type Writeable? Required? Description
ResourceUri Character No No The URI to the particular cart.
Id Character No No The unique id for the cart.
Name Character Yes Yes The name of the cart. A user may not have two carts with the same name.
ListingIds Character List Yes Yes The listings in the listing cart. Present only on an individual listing cart retrieval.
ListingCount Character No No The number of listings in a listing cart.
VowAdded Character List Yes No Listings added to a cart by a VOW account. Present only when a private role retrieves carts for a contact.
VowRemoved Character List Yes No Listings removed from a cart by a VOW account. Present only when a private role retrieves carts for a contact.

Expansions

None.

API Explorer

Interact with this service using the API Explorer.