Business

Start (or update) a pet business's sign-up

Step 1 of registering a pet-care business on NogPets, from any country. Creates a DRAFT application owned by the signed-in person, or updates its details when applicationId is given. country (ISO 3166) is required for a new one unless the phone's country code says it; currency (ISO 4217) and timezone (IANA) default from the country when it has one of each. Nothing is public until NogPets approves it. The order: startBusinessSignup → addBusinessServices → setServiceArea → addResources → setOperatingHours → inviteStaff (optional) → connectPayfast (optional, South Africa only) → getSignupStatus → submitBusinessForReview.

post/v1/business/applications

Request

  • Base URL: https://api.nogpets.com
  • URL: https://api.nogpets.com/v1/business/applications
  • 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:write)
    • HTTP bearer

Request body

applicationIdstring

Update this application instead of starting one.

businessNamestring

The registered or main business name.

tradingNamestring

The name clients know, if different.

contactNamestring

The owner or the person NogPets talks to.

phonestring

With its country code (+1 512 555 0100), or national for the business's country (082 555 0101 in South Africa); stored as E.164.

emailstring
websitestring
townstring

Where the business is based, e.g. Somerset West, Austin TX, Manchester.

countrystring

ISO 3166-1 alpha-2 code of the country the business is in: ZA, US, GB, AU, DE… Required for a new application unless the phone's country code says it.

currencystring

ISO 4217 code the business charges in (ZAR, USD, GBP, EUR…). Defaults from the country; prices are in its minor units.

timezonestring

IANA time zone of its hours, e.g. America/Chicago. Defaults when the country has one zone.

suburbsstring[]

Suburbs they serve, as they say them (set_service_area makes them bookable areas).

categoriesLineId[]
mode'MOBILE' | 'SALON' | 'BOTH'

MOBILE goes to the client (what NogPets books today); SALON is at their premises; BOTH.

vansinteger
staffinteger
aboutstring

One or two plain sentences about the business.

claimListingIdstring

A directory listing id (from possibleListings or find_pet_businesses) this business owns; "" unclaims.

whatsappOptInboolean

The owner agrees to NogPets WhatsApp messages about the application.

Response

The updated application

applicationIdstring required
status'DRAFT' | 'SUBMITTED' | 'APPROVED' | 'REJECTED' required

DRAFT while it's being filled in; SUBMITTED while NogPets reviews it; APPROVED (the business exists, bizId) or REJECTED (reviewNote says why; editing it makes it a DRAFT again).

businessobject required
servicesobject[]
areasobject[]

Proposed territories, PENDING until approved.

resourcesobject[]
invitesobject[]
whatsappOptInboolean
planunknown
readyToSubmitboolean required
reviewNotestring

Why NogPets asked for changes.

bizIdstring

The business, once approved.

possibleListingsobject[]

Directory listings that may be this business: offer to claim one.

payfastInfostring
summarystring
statusUrlstring uri nullable

A page the person can open to see the checklist and status.

welcomeUrlstring uri

What NogPets offers businesses, for the person to read.

nextstring required

What to do now.

Changes

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