JSON API » products » products/get

Gets the fields of a product.

Input parameters

Normally requires authentication and the administrator role privilege if getting a product available to purchase, else the commerce role privilege. If called without authentication, only the information field is returned.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Recommended	None.
auth_password	String	Authentication password.	Recommended	None.
id	Integer	ID of product to get.	Yes

Responses

Product	Description
200	Success.
402	Your role does not allow this.
404	The product does not exist, or you do not have permission to view it.

Data returned

Fields of product.

Example: With required and recommended parameters

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

{ "responses":[ { "product":200, "key":"", "message":"OK" } ], "data":{ "id":123, "name":"example", ... } }

Change history

Version	Changes
3.13	Function added.