JSON API » products » products/taxes/list
Gets the fields of taxes applicable to a product.
Input parameters
Requires authentication and the administrator role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
product | Integer | ID of product. | Yes | |
customer | Integer | ID of customer to get taxes for. | No | Customer of authentication user. |
Responses
Product | Description |
---|---|
200 | Success. |
400 | Invalid customer or product specified. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
Data returned
An array of fields, corresponding to the taxes this customer is liable for if they purchase this product.
Example: With required parameters
http://enswitch.example.com/api/json/products/taxes/list/?auth_username=user;auth_password=password;product=123{ "responses":[ { "product":200, "key":"", "message":"OK" } ], "data":[ { "id":1, "name":"tax1", ... }, { "id":2, "name":"tax2", ... } ] }
Change history
Version | Changes |
---|---|
3.13 | Function added. |