General Information
...
| Service | API | Method | Data Model | Workflow |
|---|---|---|---|---|
| multitenant | /product/package | DELETE |
Data Model:
...
| Products | N/A |
Input
...
Type: application/json
Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| id | Query | YES | String | N/A | The product id |
| packageCode | Query | YES | String | N/A | The package 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: 'product package %package_code% deleted successfully'
} |
Invalid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"result":false,
"errors":{
"codes":[460],
"details":[
{
"code":460,
"message":"Unable to find products"
}
]
}
} |
Code | Description |
|---|---|
| 400 | Business logic required data are missing |
460 | Unable to find products |
461 | Unable to find package |
467 | Package already exists |
476 | Unable to update product record |
Example (CURL)
Request
| Code Block | ||||
|---|---|---|---|---|
| ||||
> CURL -X DELETE http://127.0.0.1:4004/product/package?id=%product_id%&packageCode=%package_code% |
Response
...
| language | js |
|---|---|
| title | List Products API response |
...
| 500 | You cannot modify or delete a locked record |
| 602 | Model error: + %model_error% |