getCommissaryOrdersByPage

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

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

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

string

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

string

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

boolean
Defaults to false

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

string

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

string

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

string

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

string

Order Number for order to retrieve.

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).

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.

string

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

string

Reference Number for order to retrieve (optional).

string
enum

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

Allowed:
string
enum

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

Allowed:
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

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