{"id":4425,"date":"2025-02-26T14:19:15","date_gmt":"2025-02-26T12:19:15","guid":{"rendered":"https:\/\/modulus.help\/kb\/?post_type=docs&p=4425"},"modified":"2025-02-26T14:59:40","modified_gmt":"2025-02-26T12:59:40","slug":"api-list-item-balance","status":"publish","type":"docs","link":"https:\/\/modulus.help\/kb\/docs\/documentation\/warehouse-apis-v1\/api-list-item-balance\/","title":{"rendered":"API: List Item Balance"},"content":{"rendered":"\n

Request<\/h4>\n\n\n\n\n\n\n\n\n\n\n
URL<\/th>\nhttps:\/\/your_account.modulus.biz\/api\/wh\/v1\/ListWarehouseItemBalance?token=YOUR_TOKEN<\/a><\/td>\n<\/tr>\n
API Name<\/th>\n\n
\n
ListWarehouseItemBalance<\/div>\n<\/div>\n<\/td>\n<\/tr>\n
Method<\/th>\nGET<\/td>\n<\/tr>\n
Source<\/th>\nThird Party Server<\/td>\n<\/tr>\n
Recipient<\/th>\nmodulus\u00ae Server<\/td>\n<\/tr>\n
Content Type<\/th>\napplication\/json<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n

Query String Parameters<\/h4>\n\n\n\n\n\n\n\n\n\n\n\n
\n
Parameter<\/div>\n<\/th>\n
\n
Required<\/div>\n<\/th>\n
\n
Type<\/div>\n<\/th>\n
\n
Description<\/div>\n<\/th>\n<\/tr>\n
\n
token<\/strong><\/div>\n<\/td>\n
\n
Yes<\/div>\n<\/td>\n
\n
Text<\/div>\n<\/td>\n
\n
Your authentication token.<\/div>\n<\/td>\n<\/tr>\n
\n
warehouse_code <\/strong><\/div>\n<\/td>\n
\n
Yes<\/div>\n<\/td>\n
\n
Text<\/div>\n<\/td>\n
\n
The code of the warehouse.<\/div>\n<\/td>\n<\/tr>\n
\n
include_disabled <\/strong><\/div>\n<\/td>\n
\n
No<\/div>\n<\/td>\n
\n
boolean<\/div>\n<\/td>\n
\n
If false active<\/ins> items are only returned. If true, both active and inactive<\/ins> items are returned, default false.<\/div>\n<\/td>\n<\/tr>\n
\n
include_out_of_stock <\/strong><\/div>\n<\/td>\n
\n
No<\/div>\n<\/td>\n
\n
boolean<\/div>\n<\/td>\n
\n
If false stock items<\/ins> (balance greater than zero) are only returned. If true all items<\/ins> are returned, default false.<\/div>\n<\/td>\n<\/tr>\n
\n
page_size<\/div>\n<\/th>\n
\n
No<\/div>\n<\/td>\n
\n
Number<\/div>\n<\/td>\n
\n
The number of returned results. Default value is 100.<\/div>\n<\/td>\n<\/tr>\n
\n
page_number<\/div>\n<\/th>\n
\n
No<\/div>\n<\/td>\n
\n
Number<\/div>\n<\/td>\n
\n
The page number from which the entities will be returned. Default value is 1.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n

Responses<\/h4>\n\n\n\n\n\n\n\n\n\n
HTTP Status<\/th>\nresult<\/th>\ntitle<\/th>\nmessage<\/th>\nobject<\/th>\n<\/tr>\n
Success Responses<\/th>\n\u00a0<\/th>\n\u00a0<\/th>\n\u00a0<\/th>\n\u00a0<\/th>\n<\/tr>\n
200 OK<\/td>\ntrue<\/td>\nSuccess<\/td>\nItem balance
retrieved successfully.<\/td>\n		{<\/code> “meta_data”:

\n
\u00a0 \u00a0 \u00a0 \u00a0 {<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “record_count”: 20,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “page_count”: 20,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “page_size”: 100,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “page_number”: 1,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 },<\/div>\n
\u00a0 \u00a0 \u00a0 “data”:<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 [<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “item”: { “code”: “2”, “name”: “BK Module” },<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “warehouse”: { “code”: “1”, “name”: “\u0627\u0644\u062a\u0627\u0645” },<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “total_balance”:<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “unit_code”: “C62”,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “unit_name”: “Activity Unit Product”,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “quantity”: 2,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “reserved_balance”:<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “unit_code”: “C62”,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “unit_name”: “Activity Unit Product”,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “quantity”: 0,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “available_balances”:<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “unit_code”: “C62”,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “unit_name”: “Activity Unit Product”,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “quantity”: 2,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “is_disabled”: false,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “item”: { “code”: “3”, “name”: “SF Module” },<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “warehouse”: { “code”: “1”, “name”: “\u0627\u0644\u062a\u0627\u0645” },<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “total_balance”:<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “unit_code”: “C62”,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “unit_name”: “Activity Unit Product”,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “quantity”: 10,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “reserved_balance”:<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “unit_code”: “C62”,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “unit_name”: “Activity Unit Product”,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “quantity”: 0,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “available_balances”:<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “unit_code”: “C62”,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “unit_name”: “Activity Unit Product”,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “quantity”: 10,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 “is_disabled”: false,<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }<\/div>\n
\u00a0 \u00a0 \u00a0 \u00a0 ],<\/div>\n
\u00a0 \u00a0 }<\/div>\n

<\/code><\/code><\/td>\n<\/tr>\n
Failure Responses<\/th>\n\u00a0<\/th>\n\u00a0<\/th>\n\u00a0<\/th>\n\u00a0<\/th>\n<\/tr>\n
500 Internal Server Error<\/td>\nfalse<\/td>\nError<\/td>\nError message describe the problem.<\/td>\n\u00a0<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n

Example<\/h4>\n\n\n\n\n\n\n
Request<\/th>\n\n
curl --request GET 'https:\/\/your_account.modulus.biz\/api\/itm\/ListWarehouseItemBalance?token=YOUR_TOKEN&warehouse_code=warehouse_code' \\ --header 'Content-Type: application\/json'<\/code><\/pre>\n<\/td>\n<\/tr>\n
200 OK<\/th>\n\n
<\/code><\/pre>\n
\n
{

\u00a0 \"result\": true,

\u00a0 \"title\": \"Success\",

\u00a0 \"message\": \"Item balance listed successfully\",

\u00a0 \"object\":

\u00a0 \u00a0 {

\u00a0 \u00a0 \u00a0 \"meta_data\":

\u00a0 \u00a0 \u00a0 \u00a0 {

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"record_count\": 20,

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"page_count\": 20,

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"page_size\": 100,

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"page_number\": 1,

\u00a0 \u00a0 \u00a0 \u00a0 },

\u00a0 \u00a0 \u00a0 \"data\":

\u00a0 \u00a0 \u00a0 \u00a0 [

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"item\": { \"code\": \"2\", \"name\": \"BK Module\" },

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"warehouse\": { \"code\": \"1\", \"name\": \"\u0627\u0644\u062a\u0627\u0645\" },

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"total_balance\":

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"unit_code\": \"C62\",

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"unit_name\": \"Activity Unit Product\",

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"quantity\": 2,

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"reserved_balance\":

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"unit_code\": \"C62\",

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"unit_name\": \"Activity Unit Product\",

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"quantity\": 0,

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"available_balances\":

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"unit_code\": \"C62\",

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"unit_name\": \"Activity Unit Product\",

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"quantity\": 2,

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"is_disabled\": false,

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"item\": { \"code\": \"3\", \"name\": \"SF Module\" },

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"warehouse\": { \"code\": \"1\", \"name\": \"\u0627\u0644\u062a\u0627\u0645\" },

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"total_balance\":

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"unit_code\": \"C62\",

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"unit_name\": \"Activity Unit Product\",

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"quantity\": 10,

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"reserved_balance\":

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"unit_code\": \"C62\",

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"unit_name\": \"Activity Unit Product\",

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"quantity\": 0,

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"available_balances\":

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"unit_code\": \"C62\",

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"unit_name\": \"Activity Unit Product\",

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"quantity\": 10,

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 },

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"is_disabled\": false,

\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }

\u00a0 \u00a0 \u00a0 \u00a0 ],

\u00a0 \u00a0 },

}<\/pre>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>","protected":false},"featured_media":0,"parent":4423,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"comment_count":0,"_links":{"self":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4425"}],"collection":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/comments?post=4425"}],"version-history":[{"count":9,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4425\/revisions"}],"predecessor-version":[{"id":4434,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4425\/revisions\/4434"}],"up":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4423"}],"wp:attachment":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/media?parent=4425"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/doc_tag?post=4425"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}