General Information
...
| Service | API | Method | Data Model | Workflow |
|---|---|---|---|---|
| multitenant | /product | PUT |
...
...
| N/A |
Input
...
Type: application/json
Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| id | Query | YES | String | N/A | The product id |
| name | Body | YES | String | N/A | The product name |
| description | Body | NO | String | N/A | The product description |
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": 1
} |
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"result":false,
"errors":{
"codes":[460],
"details":[
{
"code":460,
"message":"Unable to find products"
}
]
}
} |
Code | Description |
|---|---|
602 | Model error: + %model_error% |
460 | Unable to find products |
470 | Unable to update product |
500 | This record is locked. You cannot modify or delete it |
Example (CURL)
Request
| Code Block | ||||
|---|---|---|---|---|
| ||||
> CURL -X PUT http://127.0.0.1:4004/product?id=%product_id% |
Response
...
| language | js |
|---|---|
| title | Update Product API response |
...