Run

A phone or walk-in booking, made by the business

The business books a client itself (a phone call, a walk-in, a message): an existing client (clientId, their pets by petKey and address by addressKey from get_client) or a new one (name, phone and consentNote), the services, a time and the van or walker. It's placed where the van or walker is free (working hours don't bind the business's own bookings), ACCEPTED, cash due on the day or a Payfast pay link for the client. Without confirm: 409 CONFIRM_REQUIRED with the summary. South African businesses only (else NOT_AVAILABLE_IN_COUNTRY). Needs business:manage; the signed-in person must be an owner, manager or staff member of an approved NogPets business (bizId only if they run more than one).

post/v1/business/bookings

Request

  • Base URL: https://api.nogpets.com
  • URL: https://api.nogpets.com/v1/business/bookings
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://api.nogpets.com/oauth/authorize, token URL https://api.nogpets.com/oauth/token, scopes: business:manage)
    • HTTP bearer

Request body

bizIdstring
clientIdstring

An existing client (find_client).

consentNotestring

New client: how they agreed to be booked and to their details being kept, in the person's words.

categorystring required

A service line id: grooming, walking or sitting.

addressKeystring

One of the client's addresses (get_client).

startstring date-time required

From find_business_times (ISO).

resourceIdstring required
paymentMethod'CASH' | 'CARD'

CASH on the day, or CARD: a Payfast link for the client.

notesstring
confirmboolean

true only after the person saw the summary from the first call and said yes.

Example request

{
  "category": "grooming"
}

Response

OK

bookingIdstring required
statusstring
whenstring
startstring
resourceIdstring
paymentMethodstring
totalstring
totalCentsinteger
summarystring
payUrlstring nullable

CARD: the client's Payfast link (48 hours).

clientIdstring
repeatOfstring
nextstring

Changes

No recorded changes to this operation across all 1 revision of this API.