YOM Docs

Untitled

Untitled

Untitled

Endpoints a disponibilizar

Para una integración completa, se deben disponibilizar endpoints para las siguientes entidades:

<aside> <img src="/icons/shop_gray.svg" alt="/icons/shop_gray.svg" width="40px" /> Comercio

</aside>

<aside> <img src="/icons/credit-card_gray.svg" alt="/icons/credit-card_gray.svg" width="40px" /> Crédito

</aside>

<aside> <img src="/icons/tag_gray.svg" alt="/icons/tag_gray.svg" width="40px" /> Categoría

</aside>

<aside> <img src="/icons/hair-care_gray.svg" alt="/icons/hair-care_gray.svg" width="40px" /> Producto

</aside>

<aside> <img src="/icons/circle-three-eighths_gray.svg" alt="/icons/circle-three-eighths_gray.svg" width="40px" /> Segmento

</aside>

<aside> <img src="/icons/hashtag_gray.svg" alt="/icons/hashtag_gray.svg" width="40px" /> Stock

</aside>

<aside> <img src="/icons/official-document_gray.svg" alt="/icons/official-document_gray.svg" width="40px" /> Transacción

</aside>

<aside> <img src="/icons/cash_gray.svg" alt="/icons/cash_gray.svg" width="40px" /> Override

</aside>

<aside> <img src="/icons/atm_gray.svg" alt="/icons/atm_gray.svg" width="40px" /> Pago

</aside>

<aside> <img src="/icons/new-alert_gray.svg" alt="/icons/new-alert_gray.svg" width="40px" /> Promoción

</aside>

<aside> <img src="/icons/conceal_gray.svg" alt="/icons/conceal_gray.svg" width="40px" /> Supervisor

</aside>

<aside> <img src="/icons/profile_gray.svg" alt="/icons/profile_gray.svg" width="40px" /> Vendedor

</aside>

<aside> <img src="/icons/link_gray.svg" alt="/icons/link_gray.svg" width="40px" /> Asignación de Vendedor

</aside>

<aside> <img src="/icons/receipt_gray.svg" alt="/icons/receipt_gray.svg" width="40px" /> Documento Tributario

</aside>

<aside> <img src="/icons/home_gray.svg" alt="/icons/home_gray.svg" width="40px" /> Centro de Distribución

</aside>

<aside> <img src="/icons/first-aid-kit_gray.svg" alt="/icons/first-aid-kit_gray.svg" width="40px" /> Health Check

</aside>


Entidad Endpoint Descripción
Health Check /api/health-check Verifica el estado del API y asegura que los servicios están operativos.
Comercio /api/commerce Proporciona información detallada sobre los comercios asociados, incluyendo datos de contacto y direcciones.
Crédito /api/credit Contiene información sobre el crédito disponible para los comercios.
Categoría /api/category Ofrece datos sobre las diferentes categorías de productos.
Producto /api/product Proporciona información detallada sobre los productos disponibles, sus características y detalles relevantes para la comercialización.
Vendedor /api/seller Proporciona información sobre los vendedores, sus detalles y asignaciones.
Supervisor /api/supervisor Proporciona información sobre los supervisores.
Stock /api/stock Ofrece información sobre la disponibilidad y cantidad de productos en stock.
Asignación de Vendedores /api/seller-assignment Contiene información sobre las asignaciones de vendedores a diferentes comercios.
Sobrescritura /api/override Proporciona información sobre ajustes o modificaciones especiales aplicadas a los productos o precios.
Segmento /api/segment Ofrece información sobre los diferentes segmentos de clientes y productos.
Pago /api/payment Proporciona información sobre los pagos realizados y pendientes.
Promoción /api/promotion Contiene detalles sobre las promociones aplicables a los productos y comercios.
Documento Tributario /api/tax-document Ofrece información sobre los documentos financieros de revisión, aprobación o cobro.
Centro de Distribución /api/distribution-center Proporciona información sobre los centros de distribución, incluyendo sus ubicaciones y capacidades.
Orden /api/order Proporciona información sobre las órdenes de compra, incluyendo detalles de productos y estados de las órdenes.
Transacción /api/transaction Proporciona información sobre las transacciones realizadas, incluyendo detalles de los productos vendidos, precios y cantidades.

Pasos anteriores

<aside> <img src="/icons/arrow-left_gray.svg" alt="/icons/arrow-left_gray.svg" width="40px" /> Requisitos técnicos

</aside>

Siguientes pasos

<aside> <img src="/icons/arrow-right_gray.svg" alt="/icons/arrow-right_gray.svg" width="40px" /> Implementación

</aside>

Tabla de contenidos