Category

Representa a una Categoría de Productos de una Company. Una Category puede ser asociada a uno o varios Goods. Los registros de esta entidad son mostradas a los compradores como un menú o catálogo; es decir, los Goods que no estén asociados a ninguna Category no serán listados a los compradores.

Modelo Category

{
    "id": 2,
    "name": "Muffins",
    "picture_url": "http://127.0.0.1:8000/storage/companies/46/category/category_2_1581537984.png",
    "pinned": true,
    "in_order": 65535,
    "created_at": "2019-02-13 15:38:13",
    "updated_at": "2020-08-06 03:07:02",
    "type": 1,
    "visible": true,
    "branch_group_id": 2,
    "branch_id": 0
}

Insertar Category

Método URI Cabeceras
POST /companies/{companyId}/categories Authorization 
{
    "name": "required|string|max:64",
    "type": "integer|min:1",
    "visible": "boolean",
    "pinned": "boolean",
    "in_order": "integer"
}

Insertar Category de BranchGroup

Método URI Cabeceras
POST /companies/{companyId}/branch-groups/{branchGroupId}/categories Authorization 
{
    "name": "required|string|max:64",
    "type": "integer|min:1",
    "visible": "boolean",
    "pinned": "boolean",
    "in_order": "integer"
}

Listar Category

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

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

Listar Category de Good

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

Método URI Cabeceras
GET /companies/{companyId}/goods/{goodId}/categories N/A

Listar Branch All

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

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

Listar Branch All

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

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

Listar Category de BranchGroup

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

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

Mostrar Category

{info} Soporta: Carga dinámica

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

Actualizar Category

Método URI Cabeceras
PATCH /companies/{companyId}/categories/{categoryId} Authorization 
{
    "name": "string|max:64",
    "type": "integer|min:1",
    "visible": "boolean",
    "pinned": "boolean",
    "in_order": "integer"
}

Sincronizar Category

Sincronizar Category de Good

Método URI Cabeceras
POST /companies/{companyId}/goods/{goodId}/categories Authorization 
[
    "integer"
]

Eliminar Category

Método URI Cabeceras
DELETE /companies/{companyId}/categories/{categoryId} Authorization

Acciones de Category

Upload Picture

Método URI Cabeceras
POST /companies/{companyId}/categories/{categoryId}/upload-picture Authorization 
{
    "image": "required|image|mimes:jpeg,png|max:2048"
}

Index Preview

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

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

Enlaces de Category