PUT - /product

General Information

Service	API	Method	Data Model	Workflow
multitenant	/product	PUT	Products	N/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
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

Valid Response Sample

{
  "result": true,
  "data": true
}

Invalid Response

Error Response Sample

{
    "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