Documentation

  2. Home
  4. Docs
  6. Documentation
  8. Item catalogue APIs
  10. API: Item List

API: Item List

The purpose of this API is to list items.

Request

URL https://your_account.modulus.biz/api/itm/PublicItem?token=YOUR_TOKEN
API Name PublicItem
Method POST
Source Third Party Server
Recipient modulus® Server
Content Type application/json

Query String Parameters

Parameter Required Type Description
token Yes Text Your authentication token.
limit No Number Max number of items to return (default 100).

Payload Parameters

Parameter Required Type Description
load_options No Array Extra data to load in addition to item basic data. Acceptable values [units, categories, prices, attributes].
filter No Object To reduce the resulted data based on specific filtration details here.

Filter Parameter Details

Parameter Required Type Description
codes No Array One or more item codes.
attributes No Array Attributes to return with the item.

Responses

HTTP Status result title message object
Success Responses
200 OK true Success Item loaded successfully. 
{
      [{
        "intID": "1",
        "intBaseUnitID": "1",
        "intDisplayUnitID": "1",
        "intBkRevenueAccountID": -1,
        "intBkDiscountAccountID": -1,
        "intBkReturnAccountID": -1,
        "intBkExpenseAccountID": -1,
        "decDisplayUnitRatio": "1.00",
        "strName": "HR Module",
        "strAlias": "Personnel Module",
        "strCode": "1",
        "boolIsDisabled": "0",
        "strDescription": "moo",
        "strNotes": "NA",
        "strCustomAttributes": "",
        "strType": "product",
        "boolIsAsset": false,
        "boolIsProduction": false,
        "boolIsPurchasing": true,
        "boolIsSelling": true,
        "arrCustomAttribute": []
      }]
}
Failure Responses
500 Internal Server Error false Error Error message describe the problem.

Example

Request 
curl --request POST 'https://your_account.modulus.biz/api/itm/PublicItem?token=YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "load_options": ["prices", "attributes"],
    "filter": {
        "codes": [1,2,3,4],
        "attributes": ["test"]
    }
}'
200 OK 
{
    "result": true,
    "title": "Success",
    "message": "Item Loaded successfully.",
    "object": [
      {
        "intID": "1",
        "intBaseUnitID": "1",
        "intDisplayUnitID": "1",
        "intBkRevenueAccountID": -1,
        "intBkDiscountAccountID": -1,
        "intBkReturnAccountID": -1,
        "intBkExpenseAccountID": -1,
        "decDisplayUnitRatio": "1.00",
        "strName": "HR Module",
        "strAlias": "Personnel Module",
        "strCode": "1",
        "boolIsDisabled": "0",
        "strDescription": "moo",
        "strNotes": "N\/A",
        "strCustomAttributes": "",
        "strType": "product",
        "boolIsAsset": false,
        "boolIsProduction": false,
        "boolIsPurchasing": true,
        "boolIsSelling": true,
        "arrCustomAttribute": [],
        "arrPriceListItem": [
          {
            "intID": "1",
            "decPrice": 10,
            "intTaxTypeID": "15",
            "strAlias": "",
            "intUnitID": "1",
            "intPriceListID": "1",
            "boolIsDisabled": false,
            "boolIsUsed": true
          },
          {
            "intID": "1",
            "decPrice": 200,
            "intTaxTypeID": "3",
            "strAlias": "",
            "intUnitID": "1",
            "intPriceListID": "2",
            "boolIsDisabled": false,
            "boolIsUsed": true
          },
          {
            "intID": "1",
            "decPrice": 80,
            "intTaxTypeID": "2",
            "strAlias": "",
            "intUnitID": "1",
            "intPriceListID": "3",
            "boolIsDisabled": false,
            "boolIsUsed": true
          }
        ],
        "arrAttributes": {
          "test": "94"
        }
      },
      {
        "intID": "4",
        "intBaseUnitID": "1",
        "intDisplayUnitID": "1",
        "intBkRevenueAccountID": -1,
        "intBkDiscountAccountID": -1,
        "intBkReturnAccountID": -1,
        "intBkExpenseAccountID": -1,
        "decDisplayUnitRatio": "1.00",
        "strName": "INV Module",
        "strAlias": "Invoice Module",
        "strCode": "4",
        "boolIsDisabled": "0",
        "strDescription": "",
        "strNotes": "N\/A",
        "strCustomAttributes": "",
        "strType": "product",
        "boolIsAsset": false,
        "boolIsProduction": false,
        "boolIsPurchasing": false,
        "boolIsSelling": true,
        "arrCustomAttribute": [],
        "arrPriceListItem": [
          {
            "intID": "4",
            "decPrice": 5,
            "intTaxTypeID": "7",
            "strAlias": "",
            "intUnitID": "1",
            "intPriceListID": "1",
            "boolIsDisabled": false,
            "boolIsUsed": true
          }
        ],
        "arrAttributes": []
      }
    ]
  }}