BranchCategory

---

• Modelo
• Insertar
• Listar
• Mostrar
• Actualizar
• Vincular
• Desvincular
• Eliminar
• Acciones
• Enlaces

Representa a una Categoría para un Comercio (Branch). Útil para Marketplaces. Esto permite agrupar Branches de forma manual.

Modelo BranchCategory

{
    "id": 1,
    "name": "Mercado",
    "image_url": "http://127.0.0.1:8000/storage/companies/69/branch/branch_category_image_1_1738876875.png",
    "image_landscape_url": "http://127.0.0.1:8000/storage/static/default/product_category_logo.png",
    "created_at": "2020-05-03 18:55:46",
    "updated_at": "2025-02-06 21:21:15",
    "branch_category_id": null,
    "in_order": 2,
    "color": "/docs/3/branch_category#e7f6f4"
}

Atributo	Tipo	Descripción
id	int	-
name	string	-
image_url	string\|null	-
image_landscape_url	string\|null	-
created_at	datetime\|null	-
updated_at	datetime\|null	-
in_order	int	-
color	string\|null	-

Insertar BranchCategory

Método	URI	Cabeceras
POST	/companies/{companyId}/branch-categories	Authorization

{
    "name": "required|string|max:64",
    "color": "nullable|string|regex:/^#[0-9a-fA-F]{6}$/",
    "branch_category_id": "integer",
    "in_order": "integer|min:1"
}

Listar BranchCategory

{info} Soporta: Paginación Filters Carga dinámica

Método	URI	Cabeceras
GET	/companies/{companyId}/branch-categories	N/A

Listar BranchCategory de Branch

{info} Soporta: Paginación Filters

Método	URI	Cabeceras
GET	/companies/{companyId}/branches/{branchId}/branch-categories	N/A

Listar BranchCategory de BranchGroup

{info} Soporta: Paginación Filters Carga dinámica

Método	URI	Cabeceras
GET	/companies/{companyId}/branch-groups/{branchGroupId}/branch-categories	N/A

Mostrar BranchCategory

{info} Soporta: Carga dinámica

Método	URI	Cabeceras
GET	/companies/{companyId}/branch-categories/{branchCategoryId}	N/A

Actualizar BranchCategory

Método	URI	Cabeceras
PATCH	/companies/{companyId}/branch-categories/{branchCategoryId}	Authorization

{
    "name": "string|max:64",
    "color": "nullable|string|regex:/^#[0-9a-fA-F]{6}$/",
    "in_order": "integer|min:1"
}

Actualizar BranchGroup

Método	URI	Cabeceras
PATCH	/companies/{companyId}/branch-categories/{branchCategoryId}/branch-groups/{branchGroupId}	Authorization

{
    "in_order": "integer|min:1"
}

Vincular BranchCategory

Vincular BranchGroup

Método	URI	Cabeceras
PUT	/companies/{companyId}/branch-categories/{branchCategoryId}/branch-groups/{branchGroupId}	Authorization

{
    "in_order": "integer|min:1"
}

Desvincular BranchCategory

Desvincular BranchGroup

Método	URI	Cabeceras
DELETE	/companies/{companyId}/branch-categories/{branchCategoryId}/branch-groups/{branchGroupId}	Authorization

Eliminar BranchCategory

Método	URI	Cabeceras
DELETE	/companies/{companyId}/branch-categories/{branchCategoryId}	Authorization

Acciones de BranchCategory

Upload

Método	URI	Cabeceras
POST	/companies/{companyId}/branch-categories/{branchCategoryId}/upload-image	Authorization

{
    "image": "required|image|mimes:jpeg,png,bmp|max:8192|dimensions:min_width=600,ratio=1/1"
}

Upload

Método	URI	Cabeceras
POST	/companies/{companyId}/branch-categories/{branchCategoryId}/upload-image-landscape	Authorization

{
    "image": "required|image|mimes:jpeg,png,bmp|max:8192|dimensions:min_width=600,min_height=600"
}

Attach Compat

Método	URI	Cabeceras
PUT	/companies/{companyId}/branch-categories/{branchCategoryId}/branches/{branchId}	Authorization

Detach Compat

Método	URI	Cabeceras
DELETE	/companies/{companyId}/branch-categories/{branchCategoryId}/branches/{branchId}	Authorization

Enlaces de BranchCategory

• allLogs HasMany ApiLog
• branchGroups HasMany BranchGroup
• branches HasMany Branch
• children HasMany BranchCategory
• company BelongsTo Company
• directPivots HasMany PivotBranchCategory
• logs HasMany ApiLog
• parent BelongsTo BranchCategory
• parentPivots HasMany PivotBranchCategory
• promotedBanners HasMany PromotedBanner