getCommissaryOrdersByPage

get

https://webservices-test.net-chef.com/commissaryorder/v1/getCommissaryOrdersByPage

Retrieves all commissary orders with the accompanying information by page number.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

customerLocationCode

string

Code number for the Customer Location receiving the order (incoming commissary order).

expectedDeliveryDateStart

string

Retrieve orders with expected delivery date equal to this date or later (optional). Must be entered together with the end date.

expectedDeliveryDateEnd

string

Retrieve orders with expected delivery date equal to this date or earlier (optional). Must be entered together with the start date.

includeDetails

boolean

Defaults to false

Use true to retrieve detailed information for each Commissary Order (optional).

locationCode

string

Code number for the Commissary Location supplying the order (outgoing commissary order).

orderDateStart

string

Retrieve orders with entry date equal to this date or later. Must be entered together with the end date.

orderDateEnd

string

Retrieve orders with entry date equal to this date or earlier. Must be entered together with the start date.

orderNumber

string

Order Number for order to retrieve.

orderStatus

string

enum

Order Status (NEW ORDER [1], SUBMITTED [18], PICKLISTED [19], INVOICED [2], CANCELED [4], PHYSICAL RECONCILED [7], FINAL RECONCILED [3]) for orders to retrieve (optional).

pageNumber

int32

Defaults to 1

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

postDate

string

Retrieve orders with post date equal this date (optional).

referenceNumber

string

Reference Number for order to retrieve (optional).

sortBy

string

enum

Specifies the field used to sort the Commissary Orders. Default is 'orderNumber' if not provided (Optional).

Allowed:

sortOrder

string

enum

Specifies the sort direction for Commissary Orders: ascending (ASC) or descending (DESC). Default is ASC if not specified (Optional).

Allowed:

pageSize

int32

Number of items to display per page.

includeNull

boolean

Specify 'true' to output null data elements.

Headers

authenticationtoken

string

required

Secure token for API authentication.

password

string

required

Password for the Crunchtime Application User.

sitename

string

required

Crunchtime site identifier. (test or production)

userid

string

required

User ID for the Crunchtime Application User.

X-B3-TraceId

string

Optional trace identifier for troubleshooting.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Success

400Validation Error

401Authorization

404commissary order not found

429Too Many Requests

500Unexpected Error

503System under maintenance

504Timeout