Skip to content

Career ​

Port: REST :3140 · gRPC :5140

The largest domain service, managing all business-side entities: businesses, branches, employees, customers, products, services, stores, and inventory stock.

Collections ​

CollectionPathPurpose
Businesses/career/businessesTop-level business or organization
Branches/career/branchesBusiness subdivisions
Employees/career/employeesStaff records
Customers/career/customersCustomer records
Products/career/productsProduct catalog items
Services/career/servicesService offerings
Stores/career/storesPhysical or logical stores / warehouses
Stocks/career/stocksInventory records per product

career/businesses ​

Top-level business or organization record.

Required Create Fields ​

FieldRequiredTypeDescription
name✅stringBusiness name
type✅BusinessTypeCHARITY, INSURANCE, GOVERNMENT, INDIVIDUAL, PARTNERSHIP, COOPERATIVE, CORPORATION, NONPROFIT
status✅StatusACTIVE, INACTIVE

Common Optional Fields ​

FieldTypeDescription
codestringShort identifier
aliasstringAlternative name
sloganstringSlogan
websiteURLWebsite URL
addressstringAddress
locationMongoIdlogistic/locations reference
categoriesstring[]Category labels
logo / coverMongoIdspecial/files references (raw, not populatable)
foundation_datedateFoundation date

Population ​

PathCollection
locationlogistic/locations

career/branches ​

Business subdivision — the business's origin branch or one of its other branches.

Required Create Fields ​

FieldRequiredTypeDescription
type✅BranchTypeORIGIN, BRANCH
business✅MongoIdParent business
status✅StatusACTIVE, INACTIVE

Population ​

PathCollection
parentcareer/branches
managercareer/employees
businesscareer/businesses
locationlogistic/locations

career/employees ​

Staff record linked to a business, optionally to a branch, manager, and services.

Required Create Fields ​

FieldRequiredTypeDescription
type✅EmployeeTypeCONTRACT, FULL_TIME, PART_TIME, TEMPORARY
job_title✅stringRole / job title
business✅MongoIdParent business
status✅StatusACTIVE, INACTIVE

Population ​

PathCollection
branchcareer/branches
managercareer/employees
businesscareer/businesses
locationlogistic/locations
currencyfinancial/currencies
profileidentity/profiles

career/customers ​

Customer record associated with a business.

Required Create Fields ​

FieldRequiredTypeDescription
type✅CustomerTypeVIP, LOYAL, REGULAR, OCCASIONAL
business✅MongoIdParent business

Population ​

PathCollection
profileidentity/profiles
storescareer/stores
branchcareer/branches
servicescareer/services
businesscareer/businesses
employeescareer/employees
location / addresseslogistic/locations
documents / certificationsspecial/files

career/products ​

Catalog item offered by a business, branch, or store.

Required Create Fields ​

FieldRequiredTypeDescription
name✅stringProduct name

Nested features Object ​

Products may have a features array of nested objects — each with type (ProductFeatureType: TEXT, RANGE, ORDINAL, DISCRETE, CATEGORICAL), title (e.g. Color), and value (boolean, number or string). Features are embedded objects, not referenced IDs.

Population ​

PathCollection
storecareer/stores
branchcareer/branches
businesscareer/businesses
cover / galleryspecial/files

career/services ​

Service offering attached to a business.

Required Create Fields ​

FieldRequiredTypeDescription
name✅stringService name
type✅ServiceTypePERIODIC, ON_DEMAND
status✅StatusACTIVE, INACTIVE
business✅MongoIdParent business

Population ​

PathCollection
branchcareer/branches
businesscareer/businesses
locationlogistic/locations

career/stores ​

Physical or logical store / warehouse.

Required Create Fields ​

FieldRequiredTypeDescription
name✅stringStore name
type✅StoreTypeRETAIL, WHOLESALE, FRANCHISE, MARKETPLACE, DISTRIBUTOR, DROPSHIPPING
fork✅StoreForkORIGIN, BRANCH
business✅MongoIdParent business

Population ​

PathCollection
parentcareer/stores
managercareer/employees
businesscareer/businesses
locationlogistic/locations

career/stocks ​

Inventory entry for a product.

Required Create Fields ​

FieldRequiredTypeDescription
type✅StockTypeCOLD, BULKY, NORMAL, FROZEN, FRAGILE, VALUABLE, HAZARDOUS
product✅MongoIdParent product
inventory✅numberCurrent inventory level

Population ​

PathCollection
storecareer/stores
branchcareer/branches
productcareer/products
businesscareer/businesses
locationlogistic/locations
currencyfinancial/currencies

Query Tips ​

  • Scope most branch, employee, service, store, customer, product, and stock queries by business.
  • Use branch for branch-local records.
  • Use store for retail- or warehouse-local products and stocks.