POST /Sales - NowBookIt API

Submit a POS sale transaction to NowBookIt, optionally linking it to an existing booking. All monetary amounts are in cents (e.g. 2500 = $25.00).

X-API-KEY

string

required

Your API key

Content-Type

string

required

Must be application/json

Required body fields

Field	Type	Description
`origin.saleId`	string	POS-generated unique sale ID
`source.type`	string	e.g. `POS`, `ONLINE`
`type`	string	`SALE`, `REFUND`, or `VOID`
`openedZonedDateTime`	string	UTC datetime the sale was opened
`staff.id`	string	Staff member ID
`table.seats`	integer	Number of seats

Optional body fields

Field	Type	Description
`origin.originalSaleId`	string	Parent sale ID for refunds
`origin.locationId`	string	POS location ID
`origin.locationName`	string	POS location name
`locationId`	string	NowBookIt integration location ID (required if configured)
`closedZonedDateTime`	string	UTC datetime the sale was closed
`bookingId`	string	NowBookIt booking ID to link this sale to
`table.number`	string	Table number or label
`customer.id`	string	Customer ID
`customer.name`	string	Customer name
`customer.notes`	string	Customer notes
`register.id`	string	POS register ID
`register.name`	string	POS register name
`section.id`	string	Section ID
`section.name`	string	Section name
`items`	array	Line items — see below
`payments`	array	Payment records — see below
`total`	Price	Total amount
`subtotal`	Price	Subtotal before tax
`tax`	Price	Tax amount
`discounts`	Price	Discount amount
`surcharges`	Price	Surcharge amount

Price object: { "amount": integer (cents), "currency": "AUD" } Item fields: id, name, category, quantity, unitPrice (Price), unitPriceTax (Price), total (Price), tax (Price) Payment fields: method, goodsAndServicesAmount (Price), status

curl --location '[BASE_URL]/Sales' \
--header 'X-API-KEY: your_api_key_here' \
--header 'Content-Type: application/json' \
--data '{ "origin": { "saleId": "pos-sale-9981" }, "source": { "type": "POS" }, "type": "SALE", "openedZonedDateTime": "2024-03-20T19:05:00Z", "staff": { "id": "staff-7" }, "table": { "seats": 4, "number": "5" } }'

Full Example Request Body

{
  "origin": { "saleId": "pos-sale-9981", "locationId": "loc-1", "locationName": "Main Venue" },
  "source": { "type": "POS" },
  "type": "SALE",
  "openedZonedDateTime": "2024-03-20T19:05:00Z",
  "closedZonedDateTime": "2024-03-20T20:45:00Z",
  "bookingId": "abc-123",
  "staff": { "id": "staff-7" },
  "table": { "seats": 4, "number": "5" },
  "total": { "amount": 18500, "currency": "AUD" },
  "items": [
    {
      "id": "item-1",
      "name": "Wagyu Steak",
      "category": "food",
      "quantity": 2,
      "unitPrice": { "amount": 6500, "currency": "AUD" },
      "unitPriceTax": { "amount": 591, "currency": "AUD" },
      "total": { "amount": 13000, "currency": "AUD" },
      "tax": { "amount": 1182, "currency": "AUD" }
    }
  ],
  "payments": [
    { "method": "EFTPOS", "goodsAndServicesAmount": { "amount": 18500, "currency": "AUD" }, "status": "APPROVED" }
  ]
}

Status	Description
`200`	Sale submitted
`400`	`Sales Record '{saleId}' previously processed.` — duplicate sale
`400`	`Invalid Location Id {locationId}`
`400`	`No Venue Subscribed to your App.`
`401`	X-API-KEY missing or invalid
`409`	`TransactionId - {saleId} currently being processed.` — retry after ~1 min