Skip to main content
GET
Get POS Reports

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1

Page number (1-indexed). Defaults to 1.

page_size
integer
default:50

Number of items per page. Defaults to 50, capped at 100.

Required range: x <= 100
retailer_id
string<uuid>

Filter by retailer. Must be a retailer your brand is or was associated with.

start_date
string<date>

Inclusive lower bound on the report's start_date (YYYY-MM-DD).

end_date
string<date>

Inclusive upper bound on the report's end_date (YYYY-MM-DD).

Response

POS data retrieved successfully

message
string
Example:

"POS data retrieved successfully"

data
object