GET /Sales - NowBookIt API

Retrieve paginated sales data linked to bookings. Filter by date range to narrow results.

X-API-KEY

string

required

Your API key

StartDate

string

Filter by sale date (start). Format: yyyy-MM-ddTHH:mm:ss.fffZ

EndDate

string

Filter by sale date (end). Format: yyyy-MM-ddTHH:mm:ss.fffZ

Limit

integer

Number of records to return

StartIndex

integer

Zero-based offset for pagination

curl --location '[BASE_URL]/Sales?StartDate=2024-03-20T00:00:00.000Z&EndDate=2024-03-20T23:59:59.000Z&Limit=20&StartIndex=0' \
--header 'X-API-KEY: your_api_key_here'

Response is a paginated result with from, to, length, and items (array of SalesDataReport). SalesDataReport fields

Field	Type	Description
`bookingId`	string	NowBookIt booking ID
`method`	string	Booking method (e.g. `online`)
`bookingTime`	string	UTC booking datetime
`duration`	integer	Duration in minutes
`people`	integer	Number of guests
`serviceId`	string	Service ID
`serviceName`	string	Service name
`serviceType`	string	Service type
`notes`	string	Booking notes
`lastModifiedDate`	string	UTC last modified datetime
`customer`	object	Customer details
`tables`	array	Assigned tables
`tags`	array	Booking tags
`status`	object	`{ statusType, code, name }`
`saleDetail`	object	POS sale data — see below

saleDetail fields

Field	Type	Description
`transactionId`	string	POS sale ID
`transactionDateTime`	string	UTC close time
`storeName`	string	Store/venue name
`posName`	string	POS system name
`posId`	string	POS system ID
`staffId`	string	Staff member ID
`staffName`	string	Staff member name
`total`	number	Total amount (dollars)
`totalExTax`	number	Total excluding tax
`tax`	number	Tax amount
`discount`	number	Discount amount
`tipAmount`	number	Tip amount
`status`	string	Sale status
`actualStartTime`	string	Actual start time
`actualEndTime`	string	Actual end time
`payments`	array	Payment records
`items`	array	Line items

Example 200 Response

{
  "from": 0,
  "to": 1,
  "length": 1,
  "items": [
    {
      "bookingId": "abc-123",
      "method": "online",
      "bookingTime": "2024-03-20T19:00:00Z",
      "duration": 90,
      "people": 4,
      "serviceId": "svc-101",
      "serviceName": "Dinner Service",
      "status": { "statusType": "standard", "code": "COMPLETED", "name": "Completed" },
      "saleDetail": {
        "transactionId": "pos-sale-9981",
        "transactionDateTime": "2024-03-20T20:45:00Z",
        "storeName": "Main Venue",
        "total": 185.00,
        "totalExTax": 168.18,
        "tax": 16.82,
        "payments": [{ "type": "EFTPOS", "amount": 185.00, "status": "APPROVED" }],
        "items": [{ "productName": "Wagyu Steak", "category": "food", "quantity": 2, "unitPrice": 65.00 }]
      }
    }
  ]
}

Status	Description
`200`	Sales returned
`400`	Filter dates null
`400`	`StartDate` invalid format
`400`	`EndDate` invalid format
`400`	`loggedInAppId`
`400`	`No Venue Subscribed to your App.`
`401`	X-API-KEY missing or invalid