Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

General Information

...

ServiceAPIMethodData ModelWorkflow
multitenant/productPUTProductsN/A

Description

This API updates the name and description of the product record that has an id that matches the one sent in the query.

Input

...

Type: application/json


Name
Source
Mandatory
Type
Special Format
Description
idQueryYESStringN/AThe product id
nameBodyYESStringN/AThe product name
descriptionBodyNOStringN/AThe 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
languagejs
titleValid Response Sample
linenumberstrue
collapsetrue
{
  "result": true,
  "data": true
}

Invalid Response

Code Block
languagejs
titleError Response Sample
linenumberstrue
collapsetrue
{
    "result":false,
    "errors":{
        "codes":[460],
        "details":[
            {
                "code":460,
                "message":"Unable to find products"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes



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


...