JSON API » products » products/taxes/list

Gets the fields of taxes applicable to a product.

Input parameters

Requires authentication and the administrator role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
productIntegerID of product.Yes
customerIntegerID of customer to get taxes for.NoCustomer of authentication user.

Responses

ProductDescription
200Success.
400Invalid customer or product specified.
401The authentication details provided are invalid.
402Your 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

VersionChanges
3.13Function added.