API Reference

getCurrentInventoryByPage

get
https://webservices-test.net-chef.com/inventory/currentinventory/v1/getCurrentInventoryByPage

Retrieve the current inventory for a product or subset of products.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The code that identifies the location in Crunchtime.

string

The code number for the product to retrieve. (case sensitive).

string

The Lot Number associated with the product in inventory.

boolean
Defaults to true

Flag to control whether products are summed for the entire location or separated by storage location. Valid values are 'true' or 'false'. When 'true', results are aggregated across all storage locations and ordered by locationCode and productNumber. When 'false', results are separated by storage location and ordered by locationCode, storageName and productNumber. If left blank, the default is 'true'.

string

The category name assigned to the product. Use 3 or more characters.

string

The subcategory name assigned to the product. Use 3 or more characters.

string

The microcategory name assigned to the product. Use 3 or more characters.

int32
Defaults to 1

Retrieve one or more records by pageNumber.
Use to retrieve data in smaller chunks.
If left blank, the default is 1.

int32

Number of items to display per page.

boolean

Specify 'true' to output null data elements.

Headers
string
required

Secure token for API authentication.

string
required

Password for the Crunchtime Application User.

string
required

Crunchtime site identifier. (test or production)

string
required

User ID for the Crunchtime Application User.

string

Optional trace identifier for troubleshooting.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated 3 months ago

Did this page help you?