/lists

The List API provides access to product collections that users have created. To view a list, you need to know it's ID. You can fetch all the lists created by a particular user to find their list IDs.

This method returns lists that the given user has created

http://api.shopstylecollective.com/api/v2/lists?pid=YOUR_API_KEY&userId=fred

Query Parameters

userId

Username of the user to look up lists for.

limit

Number of results to return. Optional; defaults to 10 lists

offset

The starting index to return results from. Optional; defaults to 0

includeProducts

Number of products to return with each list. Optional; defaults to 0, max value is 10. Products are ordered by how recently they were added to the list (most recent first)

prodid

Product ID. Optional; if present, only lists that contain this product and belong to the given user are returned.

SAMPLE RESPONSE

{
  "metadata": {
    "offset": 0,
    "limit": 10,
    "total": 3,
    "user": {...}
  },
  "lists": [
    {
      "id": 42597151,
      "owner": {...},
      "title": "Things I like",
      "favoriteCount": 3,
      "created": {
        "date": "2014-04-16",
        "timestamp": 1397682367,
        "friendly": "Apr 16, 2014"
      },
      "changed": {
        "date": "2015-04-21",
        "timestamp": 1429643588,
        "friendly": "Tue, Apr 21"
      },
      "favorites": [
        {
          "objectType": "Product",
          "id": "5536a1440956f44f05eab45d",
          "productId": 475538725,
          "imageId": "991b4e200160e3d6f1c949249dd822cc",
          "product": {...},
          "date": {
            date: "2015-04-21",
            timestamp: 1429643588,
            friendly: "Tue, Apr 21"
          },
          objectId: "475538725"
        },
        ...
      ],
      default: true
    },
    ...
  ]
}

Articles in this section

/LISTS