Versions Compared

Key

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

General Information

...

ServiceAPIMethod
multitenant/product/packageGET


Data Model: 

Workflow:

Input

...

Type: application/json


Name
Source
Mandatory
Type
Special Format
Description
productCodeQueryYESStringmax length is 6The product code
packageCodeQueryYESStringN/AThe package code


Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{

}


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
461

Unable to find package



Example (CURL)

...

Request

Code Block
languagebash
titleCalling List Products API
 > CURL -X GET http://127.0.0.1:4004/product/package?productCode=%product_code%&packageCode=%package_code%

Response

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