Explore

Retrieve all product ranges

GET/store/ranges

Gets information about all product ranges within your store configuration.

Querystring	count	The number of records to return
Querystring	offset	The number of records from a collection to skip

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "total": 2501,
  "count": 2,
  "offset": 0,
  "results": [
    {
      "id": "576d2ce846fc51147cb00e22",
      "name": "Lewis Collection",
      "description": ""
    },
    {
      "id": "576d2cf546fc51147cb00e23",
      "name": "Rochester Collection",
      "description": ""
    }
  ]
}

Lookup a specific product range

GET/store/ranges/{id}

Gets information about a specific product range within your store configuration.

Parameters

The unique id for the product range

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "576d2ce846fc51147cb00e22",
  "name": "Lewis Collection",
  "description": ""
}

Create a new product range

POST/store/ranges

Creates a new product range within your store configuration.

Request body

Product Range

Example request

Content-Type: application/json; charset=utf-8

{
  "name": "Sample Collection",
  "description": ""
}

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "5ac392909b04b518607a604d",
  "name": "Sample Collection",
  "description": ""
}

Update a product range

PUT/store/ranges/{id}

Updates the settings for a specific product range.

Parameters	id	The unique id for the product range
Request body	Product Range

Example request

Content-Type: application/json; charset=utf-8

{
  "name": "Example Collection",
  "description": ""
}

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "5ac392909b04b518607a604d",
  "name": "Example Collection",
  "description": ""
}

Delete a product range

DELETE/store/ranges/{id}

Deletes a product range from your store configuration.

Parameters

The unique id for the product range

Example response

HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8