Business

Set where the business works

Step 3. Sets the whole service area (each call replaces it) as proposed territories, PENDING until NogPets approves them.

post/v1/business/applications/{applicationId}/area

Request

  • Base URL: https://api.nogpets.com
  • URL: https://api.nogpets.com/v1/business/applications/{applicationId}/area
  • 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

postalCodesstring[]
radiusKmnumber
centerAddressstring

Instead of center: a town, suburb or street in the business's country to measure radiusKm from, e.g. "Somerset West" or "Austin, TX".

centerNamestring

What to call the radius area, e.g. the town.

Response

The 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.