Versions Compared

Version Old Version 1 New Version 2
Changes made by

Fadi Nasr (Unlicensed)

Fadi Nasr (Unlicensed)

Saved on

Key

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

General Information

...

ServiceAPIMethod
multitenant/productPOST


Data Model: Groups

Workflow:

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
codeBodyYESStringThe length is between 4 - 5Product code
nameBodyYESStringN/AProduct name
descriptionBodyNOStringN/A

Product description

Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{
    "result": true,
    "data": [
        {
            "name": "Fadi2",
            "code": "FADI2",
            "description": "Some",
            "scope": {
                "acl": {}
            },
            "packages": [],
            "_id": "5d6fedabbed68d11b6f54636"
        }
    ]
}


Invalid Response

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



Error Codes


Code
Description
468

Product already exists

469

Unable to add the product record

474

Missing required field: either id or code



Example (CURL)

...

Request

Code Block
languagebash
titleCalling List Products API
 > CURL -X GET http://127.0.0.1:4004/product -d {
    "code": "silver",
    "name": "Silver",
    "description": "product description"
}

Response

Code Block
languagejs
titleList Products API response
{
   "result": true,
   "data": [
      {
         
      }
   ]
}