API Reference

getSalesMixByPage

get
https://webservices-test.net-chef.com/salesmix/v1/getSalesMixByPage

Retrieve summarized sales mix data by GL by location by page number.

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

Use true to retrieve detailed information for one Sales Mix at a time.

string
required

The Code that identifies the Location in Crunchtime.

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.

string

The Register Number configured in Crunchtime for each location. Often configured as "1" or "POS" by default. Required to retrieve detailed records if 'includeDetails' param set to 'true'

string
required

Transaction date to retrieve in format DD-MMM-YY.

int32

Number of items to display per page.

boolean

Specify 'true' to output null data elements.

string

Numeric type of Sales Mix detail to filter relevant segments of data (e.g., 0=Sales, 1=Sales Tax, 3=Paid Outs, 5=Media Types, 6=Comps & Discounts, 7=Bank Deposits)

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 5 months ago

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

Updated 5 months ago