getCustomerOrderEnhancedByPage

get

https://webservices-test.net-chef.com/customerorderenhanced/v1/getCustomerOrderEnhancedByPage

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

Query Params

cateringOrderFlag

boolean

Retrieve orders with Catering Order Flag enabled (Y/N) - optional.

customerCode

string

Code number of the Customer for orders to retrieve.

daypartCode

int64

Code number for the Daypart to retrieve (optional).

expectedDeliveryDate

string

Expected Delivery Date (DD-MMM-YY) for orders to retrieve (optional).

includeDetails

boolean

Defaults to false

Use true to retrieve detailed information for one Customer Order at a time (optional).

invoiceDate

string

Invoice Date (DD-MMM-YY) for orders to retrieve (optional).

locationCode

string

The Code that identifies the Location in Crunchtime. Required if orderNumber, orderDate and customerCode not provided.

orderDate

string

Order Date (DD-MMM-YY) for orders to retrieve. Required if Location Code, Order Number and Customer Code input not provided.

orderNumber

string

Order Number of order to retrieve. Required if Location Code, Customer Code and Order Date input not provided.

orderStatus

string

enum

Order Status (SUBMITTED [18], PICKLISTED [19], INVOICED [2], CANCELED [4], FINAL RECONCILED [3]) for orders to retrieve (optional).
Can use status description or code number

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

Post Date (DD-MMM-YY) for orders to retrieve (optional).

referenceNumber

string

Reference Number for order to retrieve (optional).

revenueCenter

string

Revenue Center for transactions to retrieve (optional).

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

404customer order enhanced not found

429Too Many Requests

500Unexpected Error

503System under maintenance

504Timeout