Skip to main content

Business Model

The Business model represents a business entity for which reviews will be collected.

Schema

{
"id": "string",
"name": "string",
"address": {
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
},
"phone": "string",
"description": "string",
"tags": ["string"]
}

Fields

FieldTypeRequiredDescription
idstringYesBusiness identifier
namestringYesBusiness name
addressobjectYesPhysical address object
phonestringYesContact number
descriptionstringYesBusiness details
tagsarrayYesAdditional categories

Address Object

The address object contains the physical location information for the business.

Schema

{
"street": "string",
"city": "string",
"state": "string",
"zip": "string",
"country": "string"
}

Address Fields

FieldTypeRequiredDescription
streetstringYesStreet address
citystringYesCity name
statestringYesState/province
zipstringYesPostal code
countrystringYes3-letter country code

Country Codes

The country field must use 3-letter ISO country codes:

CountryCode
United StatesUSA
United KingdomGBR
CanadaCAN
AustraliaAUS
GermanyDEU
FranceFRA
JapanJPN
ChinaCHN
IndiaIND
BrazilBRA

Examples

Restaurant Business

{
"id": "restaurant_001",
"name": "McDonald's",
"tags": [
"restaurant",
"pizza",
"italian",
"casual"
],
"phone": "+12123852066",
"address": {
"zip": "10038",
"city": "New York",
"state": "NY",
"street": "160 Broadway",
"country": "USA"
},
"description": "Classic, long-running fast-food chain known for its burgers & fries."
}

Hotel Business

{
"id": "hotel_002",
"name": "Grand Hotel",
"address": {
"street": "456 Luxury Avenue",
"city": "Los Angeles",
"state": "CA",
"zip": "90210",
"country": "USA"
},
"phone": "+1-555-987-6543",
"description": "Luxury 5-star hotel with premium amenities and services",
"tags": ["hotel", "luxury", "5-star", "accommodation"]
}

Healthcare Business

{
"id": "clinic_003",
"name": "City Medical Center",
"address": {
"street": "789 Health Boulevard",
"city": "Chicago",
"state": "IL",
"zip": "60601",
"country": "USA"
},
"phone": "+1-555-456-7890",
"description": "Comprehensive medical center providing primary and specialty care",
"tags": ["healthcare", "medical", "clinic", "primary-care"]
}

Validation Rules

Business ID

  • Format: Alphanumeric string
  • Length: 1-255 characters
  • Uniqueness: Should be unique within your system
  • Characters: Letters, numbers, underscores, hyphens

Business Name

  • Length: 1-255 characters
  • Format: Human-readable business name
  • Special Characters: Allowed

Phone Number

  • Format: International format recommended
  • Length: 1-50 characters
  • Examples: +1-555-123-4567, 555-123-4567, (555) 123-4567

Description

  • Length: 1-1000 characters
  • Purpose: Brief description of the business
  • Content: Should be informative and accurate

Tags

  • Type: Array of strings
  • Length: 0-50 tags per business
  • Format: Lowercase, hyphenated recommended
  • Examples: ["restaurant", "italian", "casual-dining"]

Usage in API Requests

The Business model is used in the request payload for the /submit/request-reviews/ endpoint:

{
"job": "App\\Jobs\\RequestReviews",
"data": {
"api_key": "your-api-key",
"foreign_key": "12345",
"lazy": true,
"business": {
"id": "business_001",
"name": "Example Business",
"address": {
"street": "123 Example Street",
"city": "Example City",
"state": "EX",
"zip": "12345",
"country": "USA"
},
"phone": "+1-555-123-4567",
"description": "An example business for demonstration",
"tags": ["example", "demo"]
},
"publishers": {
// ... publisher configurations
}
}
}

Business Data Usage

The business information is used for:

  1. Profile Lookup: When no profile_key is provided for a publisher
  2. Geolocation: For finding businesses on location-based platforms
  3. Verification: To ensure the correct business is being reviewed
  4. Categorization: Tags help with business classification
  5. Contact Information: Phone and address for verification

Best Practices

Business ID

  • Use consistent naming conventions
  • Include business type or category in ID
  • Avoid special characters that might cause issues
  • Keep IDs human-readable when possible

Business Name

  • Use the official business name
  • Include location if there are multiple locations
  • Be consistent with how the business appears online

Address

  • Use complete, accurate address information
  • Verify address format for each country
  • Include suite/unit numbers if applicable

Tags

  • Use relevant, descriptive tags
  • Include business category and specialties
  • Use consistent tag naming across your system

Phone Number

  • Use international format when possible
  • Include country code for international businesses
  • Verify phone number accuracy