Versions Compared

Key

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

General Information

...

ServiceAPIMethod
multitenant/productGET


Data Model: 

Workflow:

Input

...

Type: application/json


Name
Source
Mandatory
Type
Special Format
Description
idQueryYESStringN/Athe product id


Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{
	"result": true,
	"data": [{
		_id: "5c9e2466ab9d56e06a390b81",
		code: "TESTP",
		name: "test product",
		description: null,
		scope: {
			acl: {
				manual: {
					endpointservice: {
						"1": {
							access: false
						}
					}
				}
			}
		},
		packages: [
			{
				code: "TESTP_TESTP",
				name: "test package",
				description: null,
				acl: {
					manual: {
						endpointservice: [
							{
								version: "1"
							}
						]
					}
				},
				_TTL: 604800000
			}
		]
	}]
}


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
460
Unable to find products
474

Missing required field: either id or code

426

Invalid Product ID provided



Example (CURL)

...

Request

Code Block
languagebash
titleCalling List Products API
 > CURL -X GET http://127.0.0.1:4004/product?id=%product_id%

Response

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