items

List Items

Get a list of items based on search parameters.

get/items

Request

Base URL: https://app.allocadence.com/rest
URL: https://app.allocadence.com/rest/items
Auth: none declared

Query parameters

searchForstring

Searchs items' SKU, UPC, and description for exact or partial matches.

clientIdinteger

Filter for items belonging to the client matching this id.

clientNamestring

Filter for items belonging to the client with this name. Ignored if clientId is provided and is nonzero.

categorystring

Item category to filter by.

activeboolean

True to get active items. False to get inactive items.

createdFromstring date-time

Get items created at or after this time.

createdTostring date-time

Get items created at or before this time.

modifiedFromstring date-time

Get items modified at or after this time.

modifiedTostring date-time

Get items modified at or before this time.

nonInventoryboolean

True to include non-inventory items. False to exclude.

includeUnitsboolean

True to include the items' units of measurements in the additional fields.

includeBomboolean

True to include the items' bill of materials in the additional fields.

includeImageboolean

True to include the items' primary image in the additional fields as either a URL or base64 encoded string.

encodeImageboolean

True to return the image as a base64 encoded string instead of as a URL.

Field to order results by.

orderDir'asc' | 'desc'

Direction to order the results by. Only used if orderBy is not an empty string.

pageinteger

Page number of the results to get.

perPageinteger

Page number of the results to get.

Response

Success

Example response

{
  "items": [
    {
      "id": 2306,
      "sku": "FumoFumo-002",
      "upc": "",
      "description": "Marisa Kirisame",
      "category": "Fumo",
      "client": null,
      "baseUom": "Each",
      "unitCost": 10,
      "leadTime": 0,
      "defaultEconOrder": 0,
      "rrp": 0,
      "price": 50,
      "active": true,
      "kit": false,
      "assembly": false,
      "perishable": false,
      "trackLot": false,
      "serialized": false,
      "nonInventory": false,
      "weight": 0,
      "storageLength": 0,
      "storageWidth": 0,
      "storageHeight": 0,
      "storageVolume": 0,
      "safetyStock": 0,
      "userField1": "",
      "userField2": "",
      "userField3": "",
      "userField4": "",
      "userField5": "",
      "userField6": "",
      "createdDate": "2017-08-06T10:45:53-07:00",
      "modifiedDate": "2017-08-06T10:45:53-07:00",
      "notes": "",
      "additionalFields": {
        "units": [
          {
            "name": "Each",
            "quantity": 1
          }
        ]
      }
    },
    {
      "id": 2330,
      "sku": "FumoFumo-006",
      "upc": "",
      "description": "Alice Margatroid",
      "category": "Fumo",
      "client": null,
      "baseUom": "Each",
      "unitCost": 10,
      "leadTime": 0,
      "defaultEconOrder": 0,
      "rrp": 0,
      "price": 50,
      "active": true,
      "kit": false,
      "assembly": false,
      "perishable": false,
      "trackLot": false,
      "serialized": false,
      "nonInventory": false,
      "weight": 0,
      "storageLength": 0,
      "storageWidth": 0,
      "storageHeight": 0,
      "storageVolume": 0,
      "safetyStock": 0,
      "userField1": "",
      "userField2": "",
      "userField3": "",
      "userField4": "",
      "userField5": "",
      "userField6": "",
      "createdDate": "2017-08-07T10:45:53-07:00",
      "modifiedDate": "2017-08-07T10:45:53-07:00",
      "notes": "",
      "additionalFields": {
        "units": [
          {
            "name": "Each",
            "quantity": 1
          },
          {
            "name": "Case",
            "quantity": 6
          }
        ]
      }
    }
  ],
  "meta": {
    "count": 2,
    "page": 1,
    "perPage": 20,
    "totalPages": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.