# API V1

Descripción de los objetos correspondientes a los modelos de datos de cada entidad manejada en esta documentación.

## Orden

<table data-full-width="false"><thead><tr><th width="254">Clave</th><th width="224">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><strong><code>id</code></strong></td><td>String(32)</td><td>Identificador de la orden en Fenicio.</td></tr><tr><td><strong><code>moneda</code></strong></td><td>String(4)</td><td>Código ISO 4217 de la moneda. Ejemplo: UYU</td></tr><tr><td><strong><code>codigoTributario</code></strong></td><td>String(32) | null</td><td>Número de registro tributario de la empresa.</td></tr><tr><td><strong><code>razonSocial</code></strong></td><td>String(64) | null</td><td>Nombre legal de la empresa.</td></tr><tr><td><strong><code>comprador</code></strong></td><td><a href="#comprador"><strong>Comprador</strong></a></td><td>Datos del comprador.</td></tr><tr><td><strong><code>items</code></strong></td><td><a href="#item"><strong>Item</strong></a></td><td>Lista de ítems de la orden.</td></tr><tr><td><strong><code>pago</code></strong></td><td><strong>Pago</strong> | null</td><td>Datos del pago realizado para la orden.</td></tr><tr><td><strong><code>entrega</code></strong></td><td><a href="/pages/LjX6E6o8pT0EpYonxgLH#tipoentrega"><strong>TipoEntrega</strong></a> | null</td><td>Tipo de entrega para la orden. Posibles valores: <a href="#retiro"><strong>RETIRO</strong></a>, <a href="#envio"><strong>ENVIO</strong></a>.</td></tr><tr><td><strong><code>direccionFacturacion</code></strong></td><td><a href="#direccion"><strong>Direccion</strong></a> | null</td><td>Dirección de facturación de la orden.</td></tr><tr><td><strong><code>observaciones</code></strong></td><td>String (255) | null</td><td>Observaciones generales de la orden.</td></tr></tbody></table>

## Comprador

<table data-full-width="false"><thead><tr><th width="246">Clave</th><th width="223">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><strong><code>nombre</code></strong></td><td>String(255)</td><td>Nombre del comprador.</td></tr><tr><td><strong><code>apellido</code></strong></td><td>String(255) | null</td><td>Apellido del comprador.</td></tr><tr><td><strong><code>documento</code></strong></td><td><a href="#documento"><strong>Documento</strong></a> | null</td><td>Datos del documento del comprador.</td></tr><tr><td><strong><code>email</code></strong></td><td>String(255)</td><td>Email del comprador.</td></tr><tr><td><strong><code>telefono</code></strong></td><td>String(255)</td><td>Teléfono del comprador en formato <strong><code>+[CODIGOPAIS][NUMERO]</code></strong>.<br>Ejemplo: <strong><code>+59899123456</code></strong></td></tr></tbody></table>

## Documento

<table data-full-width="false"><thead><tr><th width="248.66666666666669">Clave</th><th width="225">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><strong><code>numero</code></strong></td><td>String(32)</td><td>Número de documento.</td></tr><tr><td><strong><code>tipo</code></strong></td><td>String</td><td>Tipo de documento. Valores posibles: <strong><code>PASAPORTE</code></strong>, <strong><code>DOCUMENTO_IDENTIDAD</code></strong>.</td></tr><tr><td><strong><code>pais</code></strong></td><td>String(2)</td><td>Código ISO 3166-1 del país.</td></tr></tbody></table>

## Item

<table><thead><tr><th>Clave</th><th width="211">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><strong><code>sku</code></strong></td><td>String(128)</td><td>Código único que identifica al artículo en el sistema externo.</td></tr><tr><td><strong><code>nombre</code></strong></td><td>String(255)</td><td>Nombre del artículo.</td></tr><tr><td><strong><code>cantidad</code></strong></td><td>Int(4)</td><td>Cantidad de unidades compradas.</td></tr><tr><td><strong><code>cantidadRegalo</code></strong></td><td>Int</td><td>Cantidad de ítems que seleccionaron para regalo.</td></tr><tr><td><strong><code>importe</code></strong></td><td>Numeric</td><td>Precio unitario de la línea.</td></tr></tbody></table>

## Pago

<table data-full-width="false"><thead><tr><th width="255">Clave</th><th width="226">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><strong><code>id</code></strong></td><td>Int(32)</td><td>Identificador del pago en Fenicio.</td></tr><tr><td><strong><code>metodo</code></strong></td><td>String(32)</td><td>Método de pago utilizado.</td></tr><tr><td><strong><code>importe</code></strong></td><td>Numeric</td><td>Importe total del pago.</td></tr><tr><td><strong><code>cuotas</code></strong></td><td>Int(2)</td><td>Cantidad de cuotas en la que se realizó el pago.</td></tr><tr><td><strong><code>moneda</code></strong></td><td>String(4)</td><td>Código ISO 4217 de la moneda. Ejemplo: <strong><code>UYU</code></strong>.</td></tr><tr><td><strong><code>autorizacion</code></strong></td><td>String(128) | null</td><td>Código de autorización enviado por el medio de pago.</td></tr></tbody></table>

## Entrega

<table data-full-width="false"><thead><tr><th width="243">Clave</th><th width="224">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><strong><code>idTipoEnvio</code></strong></td><td>String(255) | null</td><td>Identificador del tipo de envío.</td></tr><tr><td><strong><code>destinatario</code></strong></td><td><a href="#franjahoraria"><strong>FranjaHoraria</strong></a> | null</td><td>Persona que recibirá la orden.</td></tr><tr><td><strong><code>franjaHoraria</code></strong></td><td><a href="#direccion"><strong>Direccion</strong></a> | null</td><td>Servicio de entrega.</td></tr><tr><td><strong><code>costo</code></strong></td><td>Numeric</td><td>Costo de la entrega.</td></tr><tr><td><strong><code>direccion</code></strong></td><td><a href="#direccion"><strong>Direccion</strong></a> | null</td><td>Dirección de entrega.</td></tr></tbody></table>

## Retiro

<table data-full-width="false"><thead><tr><th width="243">Clave</th><th width="224">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><strong><code>retira</code></strong></td><td>String | null</td><td>Nombre de la persona que retira el pedido. </td></tr><tr><td><strong><code>codigoSucursal</code></strong></td><td>String | null</td><td>Código de la sucursal donde se retira el pedido.</td></tr></tbody></table>

## FranjaHoraria

<table><thead><tr><th width="266.3333333333333">Clave</th><th width="219">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><strong><code>desde</code></strong></td><td><a href="/pages/LjX6E6o8pT0EpYonxgLH#datetime"><strong>DateTime</strong></a></td><td>Fecha y hora de inicio de la franja de entrega.</td></tr><tr><td><strong><code>hasta</code></strong></td><td><a href="/pages/LjX6E6o8pT0EpYonxgLH#datetime"><strong>DateTime</strong></a></td><td>Fecha y hora de fin de la franja de entrega.</td></tr></tbody></table>

## Direccion

<table data-full-width="false"><thead><tr><th width="252.66666666666669">Clave</th><th width="227">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><strong><code>idLocalidad</code></strong></td><td>Int</td><td>Identificador de la localidad.</td></tr><tr><td><strong><code>calle</code></strong></td><td>String(255)</td><td>Nombre de la calle.</td></tr><tr><td><strong><code>nroPuerta</code></strong></td><td>String(16)</td><td>Número de puerta.</td></tr><tr><td><strong><code>nroApartamento</code></strong></td><td>String(5) | null</td><td>Número de apartamento.</td></tr><tr><td><strong><code>codigoPostal</code></strong></td><td>String(16) | null</td><td>Código postal de la dirección.</td></tr><tr><td><strong><code>latitud</code></strong></td><td>Numeric | null</td><td>Latitud.</td></tr><tr><td><strong><code>longitud</code></strong></td><td>Numeric | null</td><td>Longitud.</td></tr><tr><td><strong><code>observaciones</code></strong></td><td>String(255) | null</td><td>Observaciones extra de la dirección.</td></tr></tbody></table>

## Catalogo

<table><thead><tr><th width="290">Clave</th><th width="225">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><strong><code>cod</code></strong></td><td>String</td><td>Código de la venta.</td></tr><tr><td><strong><code>nom</code></strong></td><td>String</td><td>Nombre completo del producto.</td></tr><tr><td><strong><code>moneda</code></strong></td><td>String(4)</td><td>Código ISO 4217 de la moneda. Ejemplo: <strong><code>UYU</code></strong>.</td></tr><tr><td><strong><code>categ</code></strong></td><td><a href="#categoria"><strong>Categoria</strong></a></td><td>ID y nombre completo de la categoría.</td></tr><tr><td><strong><code>marca</code></strong></td><td><a href="#marca"><strong>Marca</strong></a></td><td>ID y nombre completo de la marca.</td></tr><tr><td><strong><code>caracts</code></strong></td><td>String</td><td>Contiene las características activas del producto con valores asignados. Las claves corresponden al nombre interno de cada característica.</td></tr><tr><td><strong><code>vars</code></strong></td><td><a href="#varianteproducto"><strong>VarianteProducto</strong></a></td><td>Contiene las variantes del producto, incluyendo su código, nombre, y los enlaces a imágenes en tamaño completo y miniatura.</td></tr></tbody></table>

## Categoria

| Clave     | Tipo   | Descripción                    |
| --------- | ------ | ------------------------------ |
| **`id`**  | number | Identificador de la categoría. |
| **`nom`** | string | Nombre de la categoría.        |

## Marca

| Clave     | Tipo   | Descripción                |
| --------- | ------ | -------------------------- |
| **`id`**  | number | Identificador de la marca. |
| **`nom`** | string | Nombre de la marca.        |

## VarianteProducto

| Clave         | Tipo                                              | Descripción                                 |
| ------------- | ------------------------------------------------- | ------------------------------------------- |
| **`cod`**     | number                                            | Código de la variante.                      |
| **`nom`**     | string                                            | Nombre de la variante.                      |
| **`desc`**    | string                                            | Descripción de la variante.                 |
| **`imgs`**    | string                                            | URLs de imágenes.                           |
| **`thumbs`**  | string                                            | URLs de thumbnails.                         |
| **`pres`**    | [**PresentacionProducto**](#presentacionproducto) | Presentaciones disponibles.                 |
| **`caracts`** | object                                            | Características específicas de la variante. |

## PresentacionProducto

| Clave                 | Tipo   | Descripción                  |
| --------------------- | ------ | ---------------------------- |
| **`sku`**             | string | Código de la variante.       |
| **`sku_fn`**          | string | SKU interno Fenicio.         |
| **`stock`**           | string | Stock disponible.            |
| **`pr_normal`**       | Precio | Precio normal.               |
| **`pr_promo`**        | Precio | Precio promocional.          |
| **`pr_lista`**        | Precio | Precio de lista.             |
| **`identificadores`** | string | Identificadores adicionales. |
| **`sku_cm`**          | string |                              |
| **`cod`**             | string |                              |
| **`nom`**             | string |                              |

## Precio

| Clave     | Tipo   | Descripción                |
| --------- | ------ | -------------------------- |
| **`UYU`** | number | Precio en pesos uruguayos. |
| **`USD`** | number | Precio en dólares.         |

## Alertas

<table><thead><tr><th width="234">Clave</th><th>Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><strong><code>id</code></strong></td><td>String(32)</td><td>Identificador de la orden en Fenicio.</td></tr><tr><td><strong><code>resuelta</code></strong></td><td>Bool</td><td>Estado de la alerta.</td></tr><tr><td><strong><code>resueltaInfo</code></strong></td><td>String</td><td>Información del estado de la alerta.</td></tr><tr><td><strong><code>asunto</code></strong></td><td>String</td><td>Asunto general de la alerta.</td></tr><tr><td><strong><code>desc</code></strong></td><td>String</td><td>Descripción detallada de la alerta.</td></tr><tr><td><strong><code>tipo</code></strong></td><td>String</td><td>Tipo de alerta.</td></tr><tr><td><strong><code>ico</code></strong></td><td>String</td><td>Tipo de clase CSS.</td></tr><tr><td><strong><code>totalIncidencias</code></strong></td><td>Integrar</td><td>Cantidad de incidencias en la alerta.</td></tr><tr><td><strong><code>tiempo</code></strong></td><td>String</td><td>Máximo de tiempo.</td></tr><tr><td><strong><code>fechas</code></strong></td><td><a href="/pages/LjX6E6o8pT0EpYonxgLH#datetime"><strong>DateTime</strong></a>  | null</td><td>Fecha de inicio y fin del incidentes resueltos.</td></tr><tr><td><strong><code>_link</code></strong></td><td>String</td><td>Link con redirección a la alerta</td></tr><tr><td><strong><code>adm</code></strong></td><td>String</td><td>Link con redirección al administrador en alertas</td></tr></tbody></table>

## Sucursales

<table><thead><tr><th width="280">Clave</th><th>Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><strong><code>id</code></strong></td><td>String(32)</td><td>Identificador de la orden en Fenicio.</td></tr><tr><td><strong><code>hab</code></strong></td><td>Boolean</td><td>Sucursal habilitada.</td></tr><tr><td><strong><code>nom</code></strong></td><td>String</td><td>Nombre de sucursal.</td></tr><tr><td><strong><code>email</code></strong></td><td>String</td><td>Correo electrónico de sucursal.</td></tr><tr><td><strong><code>cod</code></strong></td><td>String</td><td>Código de sucursal.</td></tr><tr><td><strong><code>pais</code></strong></td><td>String</td><td>Nombre del País.</td></tr><tr><td><strong><code>dpto</code></strong></td><td>String</td><td>Nombre del departamento.</td></tr><tr><td><strong><code>dir</code></strong></td><td>String</td><td>Dirección de sucursal.</td></tr><tr><td><strong><code>hor</code></strong></td><td>String</td><td>Horario de sucursal.</td></tr><tr><td><strong><code>tel</code></strong></td><td>String</td><td>Teléfono de sucursal.</td></tr><tr><td><strong><code>pickUp</code></strong></td><td>Boolean</td><td>Definido como PickUp.</td></tr><tr><td><strong><code>lat</code></strong></td><td>Float | null</td><td>Latitud. </td></tr><tr><td><strong><code>long</code></strong></td><td>Float | null</td><td>Longitud. </td></tr><tr><td><strong><code>localidad</code></strong></td><td>String</td><td>Nombre de la localidad.</td></tr><tr><td><strong><code>pagoContraEntrega</code></strong></td><td>Boolean</td><td>Acepta pago contra entrega.</td></tr><tr><td><strong><code>publico</code></strong></td><td>Boolean</td><td>Permite atención al público.</td></tr><tr><td><strong><code>esStorePickUp</code></strong></td><td>Boolean</td><td>Deinido como PickUp.</td></tr></tbody></table>

## Tipos-envio

<table><thead><tr><th width="284">Clave</th><th width="230">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><strong><code>id</code></strong></td><td>String(32)</td><td>Identificador de la orden en Fenicio.</td></tr><tr><td><strong><code>hab</code></strong></td><td>Boolean</td><td>Estado de habilitación del tipo de envío.</td></tr><tr><td><strong><code>nom</code></strong></td><td>String</td><td>Nombre del integrador.</td></tr><tr><td><strong><code>integrador</code></strong></td><td>Array</td><td>Nombre del integrador y ID.</td></tr></tbody></table>

## Ventas

<table><thead><tr><th width="290">Clave</th><th width="225">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><strong><code>id</code></strong></td><td>Int</td><td>Identificador de la orden en Fenicio.</td></tr><tr><td><strong><code>v</code></strong></td><td>String</td><td>Representa el número de versión de la plataforma.</td></tr><tr><td><strong><code>cod</code></strong></td><td>String</td><td>Código total de la venta</td></tr><tr><td><strong><code>cv</code></strong></td><td>String</td><td>Identificador único de la venta.</td></tr><tr><td><strong><code>url</code></strong></td><td>String</td><td>URL del detalle de la venta</td></tr><tr><td><strong><code>fecha</code></strong></td><td><a href="/pages/LjX6E6o8pT0EpYonxgLH#datetime"><strong>DateTime</strong></a> </td><td>Fecha de la venta.</td></tr><tr><td><strong><code>pendienteRegistrar</code></strong></td><td>Boolean</td><td>Estado del proceso de pago pendiente de confirmación</td></tr><tr><td><strong><code>obs</code></strong></td><td>String</td><td>Observaciones</td></tr><tr><td><strong><code>fechas</code></strong></td><td><a href="/pages/LjX6E6o8pT0EpYonxgLH#datetime"><strong>DateTime</strong></a>  | null</td><td>Muestra las fechas en los distintos estados de la venta.</td></tr><tr><td><strong><code>moneda</code></strong></td><td>String(4)</td><td>Código ISO 4217 de la moneda. Ejemplo: <strong><code>UYU</code></strong></td></tr><tr><td><strong><code>importes</code></strong></td><td>Numeric</td><td>Detalle del importe de la venta.</td></tr><tr><td><strong><code>estado</code></strong></td><td>Boolean</td><td>Estado de la entrega.</td></tr><tr><td><strong><code>entrega</code></strong></td><td>String</td><td>Método de entrega de la venta.</td></tr><tr><td><strong><code>cliente</code></strong></td><td>String</td><td>Datos completos del cliente.</td></tr><tr><td><strong><code>pago</code></strong></td><td>String</td><td>Detalle del pago de la venta.</td></tr><tr><td><strong><code>ítems</code></strong></td><td>String</td><td>Detalle de los ítems en la venta.</td></tr><tr><td><strong><code>promos</code></strong></td><td>String</td><td>Detalle de las promos aplicadas a la venta.</td></tr><tr><td><strong><code>cupones</code></strong></td><td>String</td><td>Detalle de los cupones aplicadas a la venta.</td></tr><tr><td><strong><code>_link</code></strong></td><td>String</td><td>URL de la venta.</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://guia.fenicio.help/developers/referencia/modelos-de-datos/api-v1.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.