Products API

API Authentication

See API Authentication article for details

Search Products

Request

https://{host}/api/v1/products?type={all|online}&active={true|false}

type: String (optional) - all|online - all is the default

active: Boolean (optional) - true|false - true is the default

As the total number of services is "small" there is currently no paging at this point.

Response

[
  {
    "id": 16,
    "name": "1 - Product One",
    "description": "Internal description",
    "onlineName": "Product One",
    "onlineDescription": "Online Description",
    "onlineHelp": "Detailed Online Description",
    "price": 149.00,
    "productCode": "STANDARD",
    "productCategory": "Category One",
    "companyId": 3,
    "availableOnline": true,
    "active": true,
    "forcedService": false
  },
...
]

Note: Additional work will be performed to standardize error responses from the server.