GuidesAPI ReferenceSupport

List Products in Summary form

get https://secure.fusebill.com/v1/ProductSummary/?query=parameterName:value&pageSize=10&pageNumber=0

This function is used to retrieve a list of products from the catalog in summarized formats. This is a lightweight call which retrieves the core fields of each product and displays them in a list. This is particularly useful when you want to retrieve all priced products and display them for customers to purchase.

This call supports string filtering (Read More) and datetime/numeric range filtering (Read More)
&query=parameterName:Value

Parameter NameAcceptable ValuesParameter NameAcceptable Values
availableForPurchaseBooleanproductTypePhysicalGood, RecurringService, OneTimecharge
codeStringquantityDecimal Range
createdTimestampDateRangestatusActive, Retired
descriptionStringtaxExemptBoolean
nameString

This call supports pagination (Read More)
&pageSize=100&pageNumber=0
This call supports sorting (Read More)
&sortOrder=Ascending or &sortOrder=Descending
&sortExpression=expression

Examples
curl -X GET "https://secure.fusebill.com/v1/ProductSummary/?query=status:Active" \
	-H "Content-Type: application/json" \
	-H "Authorization: Basic {APIKey}"

//query parameter
string status = "Active";
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/ProductSummary/?query=status:" + status);
//Add Content type
request.ContentType = "application/json";
//Add Api key authorization
request.Headers.Add(HttpRequestHeader.Authorization, "Basic " + apiKey);
//Set request method
request.Method = "GET";
//Perform the request
var httpResponse = (HttpWebResponse)request.GetResponse();
//Record the response from our request
var result = "";
using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
{
  result = streamReader.ReadToEnd();
}

#Import library Requests
import requests
#Pass in a dictionary to the Headers parameter
headers = {'Authorization' : 'Basic {APIKey}', 'Content-Type' : 'application/json'}
#Pass in your URI and Headers
r = requests.get('https://secure.fusebill.com/v1/ProductSummary/?query=status:Active', headers=headers)
print(r.content)
Response
[ 
   { 
      "code":"users",
      "name":"Users",
      "description":null,
      "productType":"RecurringService",
      "status":"Active",
      "createdTimestamp":"2016-01-14T15:31:03",
      "taxExempt":false,
      "availableForPurchase":false,
      "quantity":null,
      "glCode":"",
      "id":14933,
      "uri":"https://secure.fusebill.com/v1/Products/14933"
   },
   { 
      "code":"monthlycharge",
      "name":"Monthly Charge",
      "description":null,
      "productType":"RecurringService",
      "status":"Active",
      "createdTimestamp":"2016-01-14T15:31:12",
      "taxExempt":false,
      "availableForPurchase":false,
      "quantity":null,
      "glCode":"",
      "id":14934,
      "uri":"https://secure.fusebill.com/v1/Products/14934"
   }
]

{
    "ErrorId": 0,
    "HttpStatusCode": 400,
    "Errors": [
        {
            "Key": "Api Error",
            "Value": "Bad request, the query is not valid.  Please check your request and try again."
        }
    ]
}
Language
Authorization