JSON API » products » products/delete

Deletes a product.

Input parameters

Requires authentication and the commerce role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of product to delete.Yes

Responses

ProductDescription
204Success.
401The authentication details provided are invalid.
402Your role does not allow this.
404The product does not exist, or you do not have permission to delete it.

Data returned

No data is returned.

Example: With required parameters

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

{ "responses":[ { "product":204, "key":"", "message":"OK" } ] }

Change history

VersionChanges
3.13Function added.