JSON API » products » products/list

Gets the fields of all products available for purchase, or owned by the given customer.

Input parameters

Requires authentication. If listing products available for purchase, the administrator role privilege is required. If listing products owned by a customer, the commerce role privilege is required.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
available	Integer	1 to get list of products available to purchase, 0 to get list of owned products.	No	0
customer	Integer	ID of customer to get products owned by. Only used if available=0.	No	Customer of authentication user.

Responses

Product	Description
200	Success.
400	Invalid customer specified.
401	The authentication details provided are invalid.
402	Your role does not allow this.

Data returned

An array of fields, corresponding to the rows of the products table in the database.

Example: Products owned by this customer

http://enswitch.example.com/api/json/products/list/?auth_username=user;auth_password=password

{ "responses":[ { "product":200, "key":"", "message":"OK" } ], "data":[ { "id":1, "name":"example1", ... }, { "id":2, "name":"example2", ... } ] }

Change history

Version	Changes
4.0	available input parameter added.
3.13	Function added.