GoodRating

Calificación que un Client otorga a un Good tras recibir un ítem de la orden (OrderedGood). rate va de 1 a 5; comment es opcional. Un cliente solo puede editar la calificación mientras no tenga comentario.

Estructura de Datos

Atributo Tipo Descripción
id int
rate int Puntuación de 1 a 5
comment string\|null Comentario opcional de la calificación
created_at datetime\|null
updated_at datetime\|null
good_id int {@link Good} calificado
client_id int\|null {@link Client} que califica
ordered_good_id int\|null {@link OrderedGood} del que surge la calificación
company_id int {@link Company} de la calificación (oculto)
branch_id int\|null {@link Branch} donde se compró el producto
allLogs ApiLog>
client Client\|null {@link Client} que califica
good Good {@link Good} calificado
logs ApiLog>
orderedGood OrderedGood\|null {@link OrderedGood} del que surge la calificación
rated Good Entidad calificada (el {@link Good}) 
[]

Endpoints

Insertar GoodRating

Insertar GoodRating de OrderedGood

Calificar un producto de la orden

Crea una GoodRating para el Good del OrderedGood. La orden debe estar completada.

Método URI Cabeceras
POST /companies/{companyId}/ordered-goods/{orderedGoodId}/good-ratings Authorization 
{
    "rate": "required|integer|min:1|max:5",
    "comment": "string|max:255"
}

Listar GoodRating

Listar GoodRating de Client

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

Listar calificaciones de producto hechas por un cliente

GoodRating otorgadas por el Client indicado.

Método URI Cabeceras
GET /companies/{companyId}/clients/{clientId}/good-ratings Authorization

Listar GoodRating de Good

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

Listar calificaciones de un producto

GoodRating recibidas por el Good indicado.

Método URI Cabeceras
GET /companies/{companyId}/goods/{goodId}/good-ratings Authorization

Listar GoodRating de Order

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

Listar calificaciones de producto de una orden

GoodRating asociadas a la Order indicada.

Método URI Cabeceras
GET /companies/{companyId}/orders/{orderId}/good-ratings Authorization

Listar GoodRating de Branch

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

Listar calificaciones de producto de una sucursal

GoodRating de los productos vendidos por la Branch indicada.

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/good-ratings Authorization

Mostrar GoodRating

{info} Soporta: Carga dinámica

Mostrar calificación de producto

Devuelve la GoodRating por su id.

Método URI Cabeceras
GET /companies/{companyId}/good-ratings/{goodRatingId} Authorization

Actualizar GoodRating

Actualizar calificación de producto

Modifica rate y comment de la GoodRating. Un cliente solo puede editarla mientras no tenga comentario.

Método URI Cabeceras
PATCH /companies/{companyId}/good-ratings/{goodRatingId} Authorization 
{
    "comment": "required|string|max:255"
}

Errores de negocio

Código HTTP Cuándo ocurre
EE300 400 La calificación ya tiene un comentario.

Relaciones