| Type
|
List
|
| List
|
SKUs
|
| URL
|
http://{domain}/api/v2/SKUs/stock_level.json
|
| Accepts Filters
|
Yes
|
Output Attributes
|
No
|
List SKUs Stock Level
Gets the filtered LIST of SKUs stock level. Using this API one can retrieve limited data on the SKUs Stock Level which have been input into Lead Commerce. This LIST contains the fields ID, SKU, committed, available, backordered, in_stock, status, etc. for each SKU. The ID is the primary key identifier for SKUs in Lead Commerce. The SKU is the visual identifier which is customizable when "Use Custom SKUs" is checked in System Settings, Default Increment. The status is the status of the SKU. "Committed" indicates some items are reserved for an existing order, "Available" indicates the items are on hand and ready for new Orders, "Backordered" means the items have been ordered but are not on hand and available, "In Stock" means the items are on hand but possibly available or not available.
Filters
Filter the SKUs stock level into a list.
| Parameter
|
Type
|
Rules
|
Example
|
| status
|
int
|
0,1 or 2
|
1
|
| id
|
int
|
|
2
|
| product_type
|
array
|
|
array(2,4)
|
| warehouse
|
int
|
|
6
|
default_location
|
string
|
|
GHK
|
| max_backordered
|
float
|
Maximum backordered
|
100
|
| min_backordered
|
float
|
Minimum backordered
|
20
|
| max_committed
|
float
|
Maximum committed
|
100
|
| min_committed
|
float
|
Minimum committed
|
20
|
| max_available
|
float
|
Maximum available
|
410
|
| min_available
|
float
|
Minimum available
|
20
|
| max_in_stock
|
float
|
Maximum in stock
|
410
|
| min_in_stock
|
float
|
Minimum in stock
|
20
|
| available_modify_start
|
date
|
|
1431377356
|
| available_modify_end
|
date
|
|
1431377356
|
| in_stock_modify_start
|
date
|
|
1431377356
|
| in_stock_modify_end
|
date
|
|
1431377356
|
Pagination
Parameters can be added to the CURL call to paginate the List.
The maximum limit is 250. By default, this limit is set to 100.
| Parameter
|
Type
|
Default
|
Example
|
| limit
|
int
|
1
|
2
|
| page
|
int
|
1
|
5
|
Response
Example product JSON returned
{
"code": "200",
"data": {
"1": [
{
"id": "1",
"sku": "20000-0001",
"committed": "80",
"available": "40",
"backordered": "0",
"in_stock": "120",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"2": [
{
"id": "2",
"sku": "20000-0002BXW",
"committed": "71",
"available": "74",
"backordered": "0",
"in_stock": "145",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"3": [
{
"id": "3",
"sku": "20000-0003",
"committed": "55",
"available": "140",
"backordered": "0",
"in_stock": "195",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"4": [
{
"id": "4",
"sku": "20000-0004",
"committed": "5",
"available": "140",
"backordered": "0",
"in_stock": "145",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"5": [
{
"id": "5",
"sku": "20000-0005",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"6": [
{
"id": "6",
"sku": "20000-0006",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"7": [
{
"id": "7",
"sku": "20000-0007",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"8": [
{
"id": "8",
"sku": "20000-0008",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"9": [
{
"id": "9",
"sku": "20000-0009",
"committed": "100",
"available": "900",
"backordered": "0",
"in_stock": "1000",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"10": [
{
"id": "10",
"sku": "20000-0010",
"committed": "100",
"available": "900",
"backordered": "0",
"in_stock": "1000",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"11": [
{
"id": "11",
"sku": "20000-0011",
"committed": "100",
"available": "900",
"backordered": "0",
"in_stock": "1000",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"12": [
{
"id": "12",
"sku": "20000-0012",
"committed": "100",
"available": "900",
"backordered": "0",
"in_stock": "1000",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"13": [
{
"id": "13",
"sku": "20001-0001AXP",
"committed": "10",
"available": "90",
"backordered": "0",
"in_stock": "100",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"14": [
{
"id": "14",
"sku": "20001-0002BMT",
"committed": "10",
"available": "90",
"backordered": "0",
"in_stock": "100",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"15": [
{
"id": "15",
"sku": "20001-0003",
"committed": "22",
"available": "78",
"backordered": "0",
"in_stock": "100",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"16": [
{
"id": "16",
"sku": "20001-0004",
"committed": "21",
"available": "79",
"backordered": "0",
"in_stock": "100",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"17": [
{
"id": "17",
"sku": "20001-0005",
"committed": "20",
"available": "80",
"backordered": "0",
"in_stock": "100",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"18": [
{
"id": "18",
"sku": "20001-0006",
"committed": "20",
"available": "80",
"backordered": "0",
"in_stock": "100",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"19": [
{
"id": "19",
"sku": "20001-0007",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"20": [
{
"id": "20",
"sku": "20001-0008",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"21": [
{
"id": "21",
"sku": "20001-0009",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"22": [
{
"id": "22",
"sku": "20001-0010",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"23": [
{
"id": "23",
"sku": "20001-0011",
"committed": "100",
"available": "900",
"backordered": "0",
"in_stock": "1000",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"24": [
{
"id": "24",
"sku": "20001-0012",
"committed": "100",
"available": "900",
"backordered": "0",
"in_stock": "1000",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"25": [
{
"id": "25",
"sku": "20002",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"26": [
{
"id": "26",
"sku": "20003",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"27": [
{
"id": "27",
"sku": "20004",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"28": [
{
"id": "28",
"sku": "20005",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"29": [
{
"id": "29",
"sku": "20006",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"30": [
{
"id": "30",
"sku": "20007",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"31": [
{
"id": "31",
"sku": "20008",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"32": [
{
"id": "32",
"sku": "20009",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"33": [
{
"id": "33",
"sku": "20010",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"34": [
{
"id": "34",
"sku": "20011-0001",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"35": [
{
"id": "35",
"sku": "20011-0002",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"36": [
{
"id": "36",
"sku": "20011-0003",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"37": [
{
"id": "37",
"sku": "20012-0001",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"38": [
{
"id": "38",
"sku": "20012-0002",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"39": [
{
"id": "39",
"sku": "20012-0003",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
],
"40": [
{
"id": "40",
"sku": "20013",
"committed": "0",
"available": "0",
"backordered": "0",
"in_stock": "0",
"min_warning": "0",
"status": "1",
"attributes": ""
}
]
}
}
© 2017 Lead Commerce, LLC · All rights reserved · 
Made with ❤ in the USA.
