Quantity On Hand

The Quantity On Hand API organizes inventory lists. It pulls and shares data with our other cloud services such as Data Management and the Portal.

Security

jwt-bearer-token

apiKey	API Key
Name	Authorization
In	header

Summary

The schema of the quantity on hand.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document

Responses

Code	Description	Schema
200	Success	quantity_on_hand_get_response_1
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

Summary

Get the quantity on hand data by search.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company to manage data for
query	`$top`	number	No	The maximum documents to return. For example, if `top` is 100, and `skip` is 0, the system returns documents 1 to 100.
query	`$skip`	number	No	The documents to skip before returning. For example, if `top` is 100, and `skip` is 100, the system returns documents 101 to 200.
query	`$select`	string	No
body	`body`	quantity_on_hand_put_body_2	Yes	The JSON formatted request

Responses

Code	Description	Schema
200	Success	quantity_on_hand_put_response_2
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

Field Name	Type	Description
`quantity_on_hand_get_response_1`	object	The definition of the quantity on hand schema

Field Name	Type	Required	Description
`items`	[ quantity_on_hand_put_body_2_items ]	Yes

Field Name	Type	Required	Description
`site_id`	string	Yes	The site identifier (ID)
`inventory_item_entity_ids`	[string]	Yes

Field Name	Type	Description
`items`	[ quantity_on_hand_put_response_2_items ]
`total`	number
`page_count`	number
`current_page`	number
`page_size`	number