Get collections

Shop API v1
GET*base*/collections
GET*base*/collections/*collectionId*
Authentication:API key

Fetches a specific collection referenced by its ID, or the full list of collections.

If the collection-id parameter is specified, one collection is fetched, otherwise all collections in the catalog are fetched.

Parameters

collectionId

int
optional
Collection ID as integer.

Response

200 Content-type: application/json

object key

collection object
required

The collectionId for the collection object.

"19": {"name": "Collection X"} for collection ID 19.

name

string
The name of the collection.

collection

string
The ID of the collection.

uri

string
The URI for this collection.

Response example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
HTTP/1.1 200 OK
Content-type: application/json

{
  "20": {
    "name" : "AW15",
    "collection" : "20",
    "uri" : "aw15"
  }
}

Fetching a specific collection using collectionId:

1
2
3
4
5
6
7
8
HTTP/1.1 200 OK
Content-type: application/json

{
   "name" : "AW15",
   "collection" : "20",
   "uri" : "aw15"
}

Error example

1
2
3
4
5
6
7
8
HTTP/1.1 404 Not Found
Content-type: application/json

{
   "errors" : {
      "collection" : "not found"
   }
}