ConsumerApi

<back to all web services

NextToAcceptBusinessInviteRequest

ConsumerBusiness
The following routes are available for this service:
POST/business/next-to-accept-invite
NextToAcceptBusinessInviteRequest Parameters:
NameParameterData TypeRequiredDescription
InviteKeybodystringYes
NextToAcceptBusinessInviteResponse Parameters:
NameParameterData TypeRequiredDescription
NextStepformNextInviteStepNo
UserformClaimUserInfoYes
PlaceformPlaceBasicApiDtoYes
InviteformInviteInfoYes
NextInviteStep Enum:
Authenticate
AuthenticateWithVipps
InviteIsForAnotherUser
CreatePassword
AcceptBusinessTermsOfService
AcceptInvite
ClaimUserInfo Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
EmailformstringYes
LegalIdentityVerifiedformboolNo
PhoneNumberformstringYes
PlaceBasicApiDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
GuidformGuidNo
OverviewformstringNo
NameformstringYes
LongitudeformfloatNo
LatitudeformfloatNo
ClaimedformboolNo
OrganizationNumberformstringNo
CountryCodeformstringYes
OpeningHoursformOpeningHoursNo
WheelchairAccessibleformbool?No
Wififormbool?No
OutdoorSeatingformbool?No
SaveFoodAndMoneyformbool?No
PlaceTypeformPlaceTypeNo
PriceMainDishformPriceMainDishApiDtoNo
TimeZoneDtoformTimeZoneDtoYes
BusinessIdformlong?No
ContactformPlaceContactYes
AddressformPlaceAddressYes
CategoriesformList<CategoryTreeApiDto>Yes
LogoUrlformImageUrlsNo
ImageUrlformImageUrlsNo
WearPriceProfilesformList<WearPriceProfileEsDto>Yes
BrandsformList<PlaceSelectedBrandApiDto>Yes
FloorformstringNo
OpeningHours Parameters:
NameParameterData TypeRequiredDescription
WeeklyformWeeklyOpeningHoursYes
WeeklyOpeningHours Parameters:
NameParameterData TypeRequiredDescription
MondayformOpeningHourNo
TuesdayformOpeningHourNo
WednesdayformOpeningHourNo
ThursdayformOpeningHourNo
FridayformOpeningHourNo
SaturdayformOpeningHourNo
SundayformOpeningHourNo
OpeningHour Parameters:
NameParameterData TypeRequiredDescription
OpenAtHourformintNo
OpenAtMinuteformintNo
CloseAtHourformintNo
CloseAtMinuteformintNo
PlaceType Enum:
Mall
Regular
PriceMainDishApiDto Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYes
SlugformPriceMainDishNo
PriceMainDish Enum:
Value
Medium
High
FineDining
TimeZoneDto Parameters:
NameParameterData TypeRequiredDescription
BaseUtcOffsetformTimeSpanNo
DaylightNameformstringYes
DisplayNameformstringYes
IdformstringYes
StandardNameformstringYes
SupportsDaylightSavingTimeformboolNo
PlaceContact Parameters:
NameParameterData TypeRequiredDescription
PhoneformstringNo
EmailformstringNo
WebsiteformstringNo
WebShopformstringNo
PlaceAddress Parameters:
NameParameterData TypeRequiredDescription
StreetformstringYes
PostalCodeformstringYes
RegionformstringYes
CountryCodeformstringYes
CategoryTreeApiDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
SlugformstringYes
AbsoluteSlugformstringYes
ImageUrlformstringNo
AllImageUrlformstringNo
IconImageUrlformstringNo
PositionformintNo
ChildrenformList<CategoryTreeApiDto>No
ImageUrls Parameters:
NameParameterData TypeRequiredDescription
PreviewformstringYes
SmallformstringYes
MediumformstringYes
LargeformstringYes
WearPriceProfileEsDto Parameters:
NameParameterData TypeRequiredDescription
SlugformstringYes
LabelformstringYes
PlaceSelectedBrandApiDto Parameters:
NameParameterData TypeRequiredDescription
BrandformBrandApiDtoNo
CategoryAbsoluteSlugsformstring[]No
PlaceCustomBrandformPlaceCustomBrandApiDtoNo
BrandApiDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
PlaceCustomBrandApiDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
InviteInfo Parameters:
NameParameterData TypeRequiredDescription
StaffRoleformStaffRoleNo
BusinessRoleformBusinessRoleNo
InvitingUserformBusinessInviteUserInfoYes
StaffRole Enum:
Owner
Admin
Regular
BusinessRole Enum:
Owner
Manager
Sales
Marketing
Other
BusinessInviteUserInfo Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringYes
LastNameformstringYes

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /business/next-to-accept-invite HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"inviteKey":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"nextStep":"Authenticate","user":{"firstName":"String","lastName":"String","email":"String","legalIdentityVerified":false,"phoneNumber":"String"},"place":{"id":0,"overview":"String","name":"String","longitude":0,"latitude":0,"claimed":false,"organizationNumber":"String","countryCode":"String","openingHours":{"weekly":{"monday":{"openAtHour":0,"openAtMinute":0,"closeAtHour":0,"closeAtMinute":0},"tuesday":{"openAtHour":0,"openAtMinute":0,"closeAtHour":0,"closeAtMinute":0},"wednesday":{"openAtHour":0,"openAtMinute":0,"closeAtHour":0,"closeAtMinute":0},"thursday":{"openAtHour":0,"openAtMinute":0,"closeAtHour":0,"closeAtMinute":0},"friday":{"openAtHour":0,"openAtMinute":0,"closeAtHour":0,"closeAtMinute":0},"saturday":{"openAtHour":0,"openAtMinute":0,"closeAtHour":0,"closeAtMinute":0},"sunday":{"openAtHour":0,"openAtMinute":0,"closeAtHour":0,"closeAtMinute":0}}},"wheelchairAccessible":false,"wifi":false,"outdoorSeating":false,"saveFoodAndMoney":false,"placeType":"Mall","priceMainDish":{"title":"String","slug":"Value"},"timeZoneDto":{"baseUtcOffset":"PT0S","daylightName":"String","displayName":"String","id":"String","standardName":"String","supportsDaylightSavingTime":false},"businessId":0,"contact":{"phone":"String","email":"String","website":"String","webShop":"String"},"address":{"street":"String","postalCode":"String","region":"String","countryCode":"String"},"categories":[{"name":"String","slug":"String","absoluteSlug":"String","imageUrl":"String","allImageUrl":"String","iconImageUrl":"String","position":0,"children":[{"name":"String","slug":"String","absoluteSlug":"String","imageUrl":"String","allImageUrl":"String","iconImageUrl":"String","position":0,"children":[{"name":"String","slug":"String","absoluteSlug":"String","imageUrl":"String","allImageUrl":"String","iconImageUrl":"String","position":0}]}]}],"logoUrl":{"preview":"String","small":"String","medium":"String","large":"String"},"imageUrl":{"preview":"String","small":"String","medium":"String","large":"String"},"wearPriceProfiles":[{"slug":"String","label":"String"}],"brands":[{"brand":{"name":"String"},"categoryAbsoluteSlugs":["String"],"placeCustomBrand":{"name":"String"}}],"floor":"String"},"invite":{"staffRole":"Owner","businessRole":"Owner","invitingUser":{"firstName":"String","lastName":"String"}}}