Skip to main content
Sign in with your store to see only the help that applies to you.

Pagination & Filtering

Most list endpoints return paginated results. Use query parameters to control the page size and navigate through results.


Pagination Parameters​

ParameterTypeDefaultMaxDescription
pageinteger1—Page number (1-indexed)
per_pageintegerDepends on endpoint100Results per page

Default page sizes:

EndpointDefault per_page
GET /api/v1/products25
GET /api/v1/customers25
GET /api/v1/sales50
GET /api/v1/purchase_orders50
GET /api/v1/stock_adjustments100

These list endpoints are not paginated and return their full result in one response: categories, brands, loyalty tiers, loyalty rewards (both capped at 500), and webhook subscriptions.

Example​

curl -H "X-API-Key: bpos_..." \
"https://yourstore.brotherpos.ca/api/v1/products?page=2&per_page=50"

Pagination Response​

Every paginated response includes a pagination object:

{
"data": [ ... ],
"pagination": {
"current_page": 2,
"per_page": 50,
"total_count": 342,
"total_pages": 7
}
}

Filtering​

EndpointParameterSearches
ProductssearchName, SKU, barcode, weight-preset barcodes, brand name
CustomersqName, email, phone, customer code, loyalty card number, RezWeed member code, status card number
SalessearchSale ID, receipt number, customer name, email, phone (and the name typed on the sale). When set, the date window is not applied.

Product search does not match additional_barcodes. For customers, each word of the query must match one of those fields, and a query containing 7 or more digits is also matched against phone numbers (and status card numbers) with formatting stripped, so (306) 555-1234 finds 3065551234.

# Search products by name
curl -H "X-API-Key: bpos_..." \
"https://yourstore.brotherpos.ca/api/v1/products?search=blue+dream"

# Search customers
curl -H "X-API-Key: bpos_..." \
"https://yourstore.brotherpos.ca/api/v1/customers?q=john"

Category Filtering​

Filter products by category slug:

curl -H "X-API-Key: bpos_..." \
"https://yourstore.brotherpos.ca/api/v1/products?category=edibles"

Brand Filtering​

Filter products by exact brand name:

curl -H "X-API-Key: bpos_..." \
"https://yourstore.brotherpos.ca/api/v1/products?brand=Broken+Coast"
Unknown brands match nothing

If no brand has exactly that name, the result is an empty list.

Date Filtering​

Filter sales by date range. Both start_date and end_date must be sent; if either is missing or unparseable, only today's sales are returned.

curl -H "X-API-Key: bpos_..." \
"https://yourstore.brotherpos.ca/api/v1/sales?start_date=2026-03-01&end_date=2026-03-22"

Both days are whole days in the store's timezone, and the end_date day itself is included (up to the end of that day). A sale is matched on completed_at if it has one, otherwise on created_at.

See Sales for the other sales filters.

Incremental Sync​

Products and customers support updated_since for incremental syncing; purchase orders support it too.

# Only get products updated since 11:00 UTC
curl -H "X-API-Key: bpos_..." \
"https://yourstore.brotherpos.ca/api/v1/products?updated_since=2026-03-22T11:00:00Z"

On products and customers, a value that cannot be parsed is ignored and the full list is returned. Purchase orders return 422 instead. The stock adjustment ledger uses since / until. See Recommended Sync Architecture.


What's Next?​