BranchProperty

Representa a una Asociación de un Property con un Branch. Esto permite modificar los precios de las variantes de tipo Range y Options para la sucursal en cuestión. Además, permite manejar disponibilidad y stock de cada variante. Las consultas de precios para el cliente final se realizan sobre esta entidad.

  • salable_type: Tipo de Property al cual hace referencia. Puede ser property_option o property_range
  • base_price_e2: Precio mínimo. Valor base para la Lista de Precios
  • step_price_e2: Precio de cambio en las propiedades property_range. No se utiliza en property_range.
  • available: Controla la disponibilidad de la Propiedad.
  • quantity: Controla el stock de la Propiedad.

Estructura de Datos

Atributo Tipo Descripción
id int
base_price_e2 int Precio base de la variante para esta sucursal (céntimos); base de cálculo de la lista de precios.
step_price_e2 int Precio por paso en variantes de tipo range (céntimos).
available bool true si la variante está disponible en esta sucursal.
quantity int\|null Stock de la variante en esta sucursal; null si no controla stock.
created_at datetime\|null Fecha de creación.
updated_at datetime\|null Fecha de última modificación.
branch_id int Sucursal a la que aplica el precio/stock.
property_id int Variante ({@link \App\Property}) a la que aplica.
salable_type string Tipo de valor de la variante: property_option o property_range.
salable_id int ID de la opción o del rango concreto (salable).
allLogs ApiLog> Registros de auditoría de la API, incluidos los internos.
branchGoodProperties BranchGoodProperty> Variantes de producto de la sucursal que usan este precio/stock.
custom_data array Datos de la variante ya combinados con los ajustes del cliente.
logs ApiLog> Registros de auditoría de la API visibles.
property Property Variante a la que aplica.
salable Model\|Eloquent Opción ({@link \App\PropertyOption}) o rango ({@link \App\PropertyRange}) concreto. 
{
    "id": 58,
    "base_price_e2": 223234500,
    "step_price_e2": 0,
    "available": true,
    "quantity": null,
    "created_at": "2020-05-04 17:47:21",
    "updated_at": "2020-05-04 17:47:21",
    "branch_id": 22,
    "property_id": 46,
    "salable_type": "property_option",
    "salable_id": 580
}

Endpoints

Listar BranchProperty

Listar BranchProperty de Branch

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

Listar el precio/stock de variantes de una sucursal

Devuelve las BranchProperty (precio y stock por opción/rango) de la sucursal indicada.

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

Mostrar BranchProperty

Ver el precio/stock de una variante en una sucursal

{info} Soporta: Carga dinámica

Devuelve la BranchProperty de la variante indicada en la sucursal. Endpoint en desuso porque una variante de opciones tiene varias coincidencias.

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/properties/{propertyId} N/A

Actualizar BranchProperty

Actualizar el precio/stock de una variante en una sucursal

Modifica base_price_e2, step_price_e2, available o quantity de la BranchProperty indicada.

Método URI Cabeceras
PATCH /companies/{companyId}/branch-properties/{branchPropertyId} Authorization 
{
    "base_price_e2": "integer",
    "step_price_e2": "integer",
    "quantity": "integer",
    "available": "boolean"
}

Acciones de BranchProperty

Actualizar el precio/stock de una variante en una sucursal (compat.)

Variante por branchId + propertyId del endpoint de actualización de BranchProperty.

Método URI Cabeceras
PATCH /companies/{companyId}/branches/{branchId}/properties/{propertyId} Authorization 
{
    "base_price_e2": "integer",
    "step_price_e2": "integer",
    "quantity": "integer",
    "available": "boolean"
}

Relaciones