INVENTORY_ITEMS

This API returns CAS Inventory Item information based on request.

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/erp/fs/inventory_items

Version: v1

Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/* GET

Paths

GET /*

description

Description

query string (1 to 200 chars)
cas_id

CAS Registry Number

query string (1 to 60 chars)
item_id

Item ID

query string (1 to 30 chars)
category_code

Category

query string (1 to 30 chars)
item_group

Item Group

query string (1 to 30 chars)

Uses default content-types: application/json

200 OK

The default response type is JSON. Add an Accept header with value=application/xml to return an XML response.

Example for application/json
{
"inventory_items": {
"inventory_information": [
{
"cas_registry_number": "100-66-3",
"category_code": "CH01",
"item_current_price": "17.62",
"item_description": "ANISOLE (250 ML)",
"item_group": "CHEMS CH",
"item_id": "000000000000005724",
"item_quantity_available": "1",
"item_unit_of_measure": "ML"
},
{
"cas_registry_number": "100-52-7",
"category_code": "CH01",
"item_current_price": "53.12",
"item_description": "BENZALDEHYDE (100 GM)",
"item_group": "CHEMS CH",
"item_id": "000000000000005751",
"item_quantity_available": "1",
"item_unit_of_measure": "GM"
},
{
"cas_registry_number": "100-52-7",
"category_code": "CH01",
"item_current_price": "48.65",
"item_description": "BENZALDEHYDE (1 KG)",
"item_group": "CHEMS CH",
"item_id": "000000000000005752",
"item_quantity_available": "1",
"item_unit_of_measure": "KG"
}
]
}
}

Schema definitions

cas_registry_number: string (up to 20 chars)

category_code: string (up to 18 chars)

inventory_information: object

item_id: item_id
item_description: item_description
category_code: category_code
item_group: item_group
cas_registry_number: cas_registry_number
item_quantity_available: item_quantity_available
item_current_price: item_current_price
item_unit_of_measure: item_unit_of_measure

inventory_items: object[]

item_current_price: number (double)

item_description: string (up to 60 chars)

item_group: string (up to 15 chars)

item_id: string (up to 18 chars)

item_quantity_available: number (double)

item_unit_of_measure: string (up to 3 chars)

Service Path: 
/domains/erp/fs/inventory_items
Domain or University API: 
/domains/erp/fs/inventory_items

Community

 

Don't see your question listed here? Ask!