Inventory Count Group

The Inventory Count Group API allows the user to manage inventory count information by group.

Security

jwt-bearer-token

apiKey	API Key
Name	Authorization
In	header

Endpoints

GET /inventory-count-group/schema

Summary

Inventory count group schema.

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	inventory_count_group_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

GET /inventory-count-group/{id}

Summary

Get an inventory count group by the identifier.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
path	`id`	string	Yes	`objectId`, the inventory count group's ID

Responses

Code	Description	Schema
200	Success	inventory_count_group_get_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

PATCH /inventory-count-group/{id}

Summary

Update the inventory count group.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
path	`id`	string	Yes	`objectId`, the inventory count group's ID
body	`body`	inventory_count_group_patch_body_5	Yes	The JSON formatted request

Responses

Code	Description	Schema
204	No content
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

GET /inventory-count-group

Summary

Get an inventory count group list.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
query	`$filter`	string	No	A filter expression in OData v4 format
query	`$top`	integer	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`	integer	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
query	`$orderby`	string	No	An order by expression in OData v4 format
query	`check_is_removable`	boolean	No

Responses

Code	Description	Schema
200	Success	inventory_count_group_get_response_3
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

POST /inventory-count-group

Summary

Create the inventory count group.

Request Parameters

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

Responses

Code	Description	Schema
201	Success	inventory_count_group_post_response_4
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

Data Models