Divendo API 2.0

We’ve rebuilt our API from the ground up to be easier than ever to integrate our platform with your favourite software

Retrieve all products

GET/store/products

Gets information about all products within your store.

Querystring count The number of records to return
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": 11115,
  "count": 1,
  "offset": 0,
  "results": [
    {
      "id": "591d01009b04c2092c94e105",
      "created": "2017-05-18T03:03:44.573+01:00",
      "modified": "2019-08-20T12:00:14.961+01:00",
      "name": "Test Shirt Red Mens AW19",
      "displayname": "Test Shirt Mens",
      "active": true,
      "url": "https://www.example.com/mens/shirts/test-shirt-mens",
      "summary": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
      "description": "

In est neque, mattis lobortis posuere eget, accumsan nec nisi. Maecenas molestie odio eu est lacinia dapibus. Duis egestas erat ut nisi blandit, vel tristique felis cursus. Nunc euismod tellus velit, venenatis iaculis massa suscipit sed. Integer vitae mollis enim. Nam vitae nibh facilisis, dignissim purus vel, eleifend ante. Morbi in lacus dolor. In eros enim, scelerisque id erat quis, volutpat efficitur leo.

", "categories": [ { "id": "56ff6552f161b1933826a15b", "name": "Everyday", "url": "https://www.example.com/mens/shirts", "hierarchy": "Mens > Shirts" } ], "images": [ "https://www.example.com/products/mens/shirt-red-1.jpg", "https://www.example.com/products/mens/shirt-red-2.jpg" ], "gallery": [ "https://www.example.com/products/mens/shirt-red-gallery_1.jpg", "https://www.example.com/products/mens/shirt-red-gallery_2.jpg" ], "retailprice": 104.00, "saleprice": 75.0, "specifics": [ "colours", "sizes" ], "variations": [ { "id": "591d01009b04c2092c94e0fb", "sku": "MPB079-02S", "name": "Red, Small", "specifics": { "colours": "Red", "sizes": "Small" }, "active": true, "retailprice": 104.00, "saleprice": 75.00, "taxfree": false, "inventory": { "trackstock": true, "backorder": false, "preorder": false, "available": 2 }, "ean": "5052658231744", "mpn": "MPB079-02S", "condition": "new", "gender": "male", "agegroup": "adult", "dimensions": { "height": "", "width": "", "length": "", "depth": "", "weight": "0", "diameter": "" } }, { "id": "591d01009b04c2092c94e0fc", "sku": "MPB079-02L", "name": "Red, Large", "specifics": { "colours": "Red", "sizes": "Large" }, "active": true, "retailprice": 104.00, "saleprice": null, "taxfree": false, "inventory": { "trackstock": true, "backorder": false, "preorder": false, "available": 1 }, "ean": "5052658231751", "mpn": "MPB079-02L", "condition": "new", "gender": "male", "agegroup": "adult", "dimensions": { "height": "", "width": "", "length": "", "depth": "", "weight": "0", "diameter": "" } } ], "swatches": { "colours": [ { "name": "Red", "images": [ "https://www.example.com/products/mens/shirt-red-1.jpg", "https://www.example.com/products/mens/shirt-red-2.jpg" ], "gallery": [ "https://www.example.com/products/mens/shirt-red-gallery_1.jpg", "https://www.example.com/products/mens/shirt-red-gallery_2.jpg" ] } ] }, "tags": [ "lightweight", "shirt", "casual" ] } ] }

Lookup a specific product

GET/store/products/{id}

Gets information about a specific product within your store.

Parameters id The unique id of the product

Example response

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

{
  "id": "591d01009b04c2092c94e105",
  "created": "2017-05-18T03:03:44.573+01:00",
  "modified": "2019-08-20T12:00:14.961+01:00",
  "name": "Test Shirt Red Mens AW19",
  "displayname": "Test Shirt Mens",
  "active": true,
  "url": "https://www.example.com/mens/shirts/test-shirt-mens",
  "summary": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  "description": "

In est neque, mattis lobortis posuere eget, accumsan nec nisi. Maecenas molestie odio eu est lacinia dapibus. Duis egestas erat ut nisi blandit, vel tristique felis cursus. Nunc euismod tellus velit, venenatis iaculis massa suscipit sed. Integer vitae mollis enim. Nam vitae nibh facilisis, dignissim purus vel, eleifend ante. Morbi in lacus dolor. In eros enim, scelerisque id erat quis, volutpat efficitur leo.

", "categories": [ { "id": "56ff6552f161b1933826a15b", "name": "Everyday", "url": "https://www.example.com/mens/shirts", "hierarchy": "Mens > Shirts" } ], "images": [ "https://www.example.com/products/mens/shirt-red-1.jpg", "https://www.example.com/products/mens/shirt-red-2.jpg" ], "gallery": [ "https://www.example.com/products/mens/shirt-red-gallery_1.jpg", "https://www.example.com/products/mens/shirt-red-gallery_2.jpg" ], "retailprice": 104.00, "saleprice": 75.0, "specifics": [ "colours", "sizes" ], "variations": [ { "id": "591d01009b04c2092c94e0fb", "sku": "MPB079-02S", "name": "Red, Small", "specifics": { "colours": "Red", "sizes": "Small" }, "active": true, "retailprice": 104.00, "saleprice": 75.00, "taxfree": false, "inventory": { "trackstock": true, "backorder": false, "preorder": false, "available": 2 }, "ean": "5052658231744", "mpn": "MPB079-02S", "condition": "new", "gender": "male", "agegroup": "adult", "dimensions": { "height": "", "width": "", "length": "", "depth": "", "weight": "0", "diameter": "" } }, { "id": "591d01009b04c2092c94e0fc", "sku": "MPB079-02L", "name": "Red, Large", "specifics": { "colours": "Red", "sizes": "Large" }, "active": true, "retailprice": 104.00, "saleprice": null, "taxfree": false, "inventory": { "trackstock": true, "backorder": false, "preorder": false, "available": 1 }, "ean": "5052658231751", "mpn": "MPB079-02L", "condition": "new", "gender": "male", "agegroup": "adult", "dimensions": { "height": "", "width": "", "length": "", "depth": "", "weight": "0", "diameter": "" } } ], "swatches": { "colours": [ { "name": "Red", "images": [ "https://www.example.com/products/mens/shirt-red-1.jpg", "https://www.example.com/products/mens/shirt-red-2.jpg" ], "gallery": [ "https://www.example.com/products/mens/shirt-red-gallery_1.jpg", "https://www.example.com/products/mens/shirt-red-gallery_2.jpg" ] } ] }, "tags": [ "lightweight", "shirt", "casual" ] }