...
...
General Information
...
| Service | API | Method | Data Model | Workflow | Group |
|---|---|---|---|---|---|
| multitenant | /product | DELETE |
Data Model:
...
| Products | N/A | Product |
Description
Delete product
Input
...
Type: application/json
Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| id | Query | YESNO | String | N/A | The product id |
| code | Query | YESNO | String | The Length is 4 - 5 | The product code |
Output
...
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
Valid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{ result": true, "data": { "n": 1, "ok": 1 } } |
Invalid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"result":false,
"errors":{
"codes":[460],
"details":[
{
"code":460,
"message":"Unable to find products"
}
]
}
} |
Code | Description | ||
|---|---|---|---|
426 | Invalid Product ID provided400 | Business logic required data are missing | |
460 | Unable to find products | ||
466 | You are not allowed to remove the product you are currently logged in with | 474 | Missing required field: either id or code |
475 | Unable to remove product record | ||
477 | Invalid product code provided | ||
500 | This record is locked. You cannot modify or delete it |
Example (CURL)
Request
| Code Block | ||||
|---|---|---|---|---|
| ||||
> CURL -X DELETE http://127.0.0.1:4004/product?id=%product_id% |
Response
...
| language | js |
|---|---|
| title | List Products API response |
...
602 | Model error: + %model_error% |