BranchGroup

Representa a grupo de sucursales para manejo interno del sistema. Esto permite agrupar Branches para otorgar privilegios a grupos de administradores fácilmente, cuando las Branches son administradas por el mismo grupo de Admins.

  • display_unavailable_goods: Indica que se deben mostrar los productos no disponibles a los Compradores.
  • display_spent_goods: Indica que se deben mostrar los productos agotados, es decir, su inventario llegó a cero.
  • enable_shoppers: Indica que las compras deben ser atendidas por Shoppers.
  • is_market: Indica que el comercio es de tipo mercado. La plataforma hará optimizaciones para manejar un gran número de SKU.
  • is_digital: Indica que los productos vendidos por el comercio son Digitales. Esto hará que el comercio sea visible en todos los lugares sin importar lo lejos que se encuentre el comprador.
  • promo_label: Muestra información promocional con el valor suministrado cuando el comercio no tiene promociones activas.
  • is_featured: El comercio aparecerá en la lista de destacados.
  • enable_pool: Las órdenes del comercio podrían ser enviadas al pool de repartidores (si el pool está habilitado).
  • keywords: Palabras clave para mejorar las búsquedas.

Modelo BranchGroup

{
    "id": 1,
    "name": "default",
    "created_at": "2020-04-17 01:07:30",
    "updated_at": "2020-12-18 03:44:08",
    "display_unavailable_goods": false,
    "enable_shoppers": false,
    "is_market": false,
    "logo_url": "http://127.0.0.1:8000/storage/static/default/branch_logo.png",
    "is_featured": false,
    "in_order": 65535,
    "promo_label": null,
    "enable_pool": true,
    "rating_e2": 500,
    "rating_sum": 0,
    "rating_count": 0,
    "display_spent_goods": true,
    "domain": "b1",
    "custom_domain": null,
    "logo_alt_url": "http://127.0.0.1:8000/storage/static/default/branch_logo.png",
    "is_digital": false,
    "description": "Store",
    "keywords": [
        "default"
    ],
    "cover_url": "http://127.0.0.1:8000/storage/static/default/cover_company.png",
    "group_description": null,
    "settings": {
        "template": "food_1",
        "color_primary": "/docs/3/branch_group#aaaaaa",
        "color_accent": "/docs/3/branch_group#777777",
        "is_venture": false,
        "is_food_vendor": false,
        "special_instructions_placeholder": null
    }
}
Atributo Tipo Descripción
id int -
name string -
created_at datetime\|null -
updated_at datetime\|null -
display_unavailable_goods bool -
enable_shoppers bool -
is_market bool -
logo_url string -
is_featured bool\|null -
in_order int -
enable_pool bool -
rating_e2 int -
rating_sum int -
rating_count int -
display_spent_goods bool -
domain string\|null -
logo_alt_url string -
is_digital bool -
description string -
keywords array\|null -
cover_url string -
settings array -

Insertar BranchGroup

Método URI Cabeceras
POST /companies/{companyId}/branch-groups Authorization 
{
    "name": "required|string|max:64",
    "description": "nullable|max:360|string",
    "group_description": "nullable|max:512|string",
    "keywords": [
        "string|max:64"
    ],
    "display_unavailable_goods": "boolean",
    "display_spent_goods": "boolean",
    "enable_shoppers": "boolean",
    "enable_pool": "boolean",
    "is_market": "boolean",
    "is_digital": "boolean",
    "in_order": "integer|min:1",
    "promo_label": "string|max:32",
    "domain": "required|max:32|domain",
    "custom_domain": "max:255|url"
}

Listar BranchGroup

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

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

Listar Setting

Método URI Cabeceras
GET /companies/{companyId}/branch-groups/{branchGroupId}/settings Authorization

Listar BranchGroup de BranchCategory

{info} Soporta: Paginación Filters

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

Mostrar BranchGroup

{info} Soporta: Carga dinámica

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

Actualizar BranchGroup

Método URI Cabeceras
PATCH /companies/{companyId}/branch-groups/{branchGroupId} Authorization 
{
    "name": "string|max:64",
    "description": "max:360|string",
    "group_description": "nullable|max:512|string",
    "keywords": [
        "string|max:64"
    ],
    "display_unavailable_goods": "boolean",
    "display_spent_goods": "boolean",
    "enable_shoppers": "boolean",
    "enable_pool": "boolean",
    "is_market": "boolean",
    "is_digital": "boolean",
    "in_order": "integer|min:1",
    "promo_label": "string|max:32",
    "domain": "max:32|domain",
    "custom_domain": "max:255|url"
}

Actualizar Setting

Método URI Cabeceras
PATCH /companies/{companyId}/branch-groups/{branchGroupId}/settings Authorization 
{
    "add_rating_sum": "integer|min:0",
    "add_rating_count": "integer|min:0",
    "import_config": "array",
    "color_primary": "string|regex:/^#(?:[0-9a-fA-F]{3}){1,2}$/",
    "color_accent": "string|regex:/^#(?:[0-9a-fA-F]{3}){1,2}$/",
    "is_venture": "boolean",
    "int_sku_enabled": "boolean",
    "enable_auto_image_search": "boolean",
    "enable_shopper_validation": "boolean",
    "is_food_vendor": "boolean",
    "special_instructions_placeholder": "nullable|string",
    "linked_branches": [
        {
            "id": "required|integer|min:1",
            "alias": "required|string|max:24"
        }
    ],
    "template": "string|in:store_1,food_1,market_1,digital_1",
    "taxes": [
        {
            "is_enabled": "boolean",
            "name": "required|string|max:32",
            "label": "string|max:32",
            "description": "string",
            "layer": "integer|min:0|max:255",
            "price_min_e2": "integer|min:0",
            "human_price_min_e2": "numeric|min:0.0",
            "price_max_e2": "integer",
            "human_price_max_e2": "numeric",
            "hour_beg": {
                "string": true,
                "regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
            },
            "hour_end": {
                "string": true,
                "regex": "/^([0-1][0-9]|2[0-3]):[0-5][0-9]$/"
            },
            "conditions": "array",
            "payment_methods": [
                "required|string"
            ],
            "payment_currencies": [
                "required|string"
            ]
        }
    ]
}

Eliminar BranchGroup

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

Acciones de BranchGroup

Store By Forwarder

Método URI Cabeceras
POST /companies/{companyId}/branch-groups/by-forwarder Authorization

Ver Json

Upload Logo

Método URI Cabeceras
POST /companies/{companyId}/branch-groups/{branchGroupId}/upload-logo Authorization 
{
    "image": "required|image|mimes:jpeg,png,bmp|max:8192|dimensions:min_width=600,ratio=1/1"
}

Upload Logo

Método URI Cabeceras
POST /companies/{companyId}/branch-groups/{branchGroupId}/upload-logo-alt Authorization 
{
    "image": "required|image|mimes:jpeg,png,bmp|max:8192|dimensions:min_width=600,ratio=2/1"
}

Upload Cover

Método URI Cabeceras
POST /companies/{companyId}/branch-groups/{branchGroupId}/upload-cover Authorization 
{
    "image": "required|image|mimes:jpeg,png,bmp|max:8192|dimensions:min_width=868,min_height=868"
}

Set Featured Enabled

Método URI Cabeceras
POST /companies/{companyId}/branch-groups/{branchGroupId}/set-featured-enabled Authorization

Set Featured Disabled

Método URI Cabeceras
POST /companies/{companyId}/branch-groups/{branchGroupId}/set-featured-disabled Authorization

Index Allowed

Método URI Cabeceras
GET /companies/{companyId}/branch-groups/{branchGroupId}/allowed-settings Authorization

Enlaces de BranchGroup