# YaVendio Business API ## Guías ### Primeros Pasos - [Introducción](https://docs.ya.works/introduction.md): Comienza a usar la YaVendio Business API en minutos - [Autenticación](https://docs.ya.works/authentication.md): Cómo autenticar peticiones usando API keys ### Conceptos - [Paginación](https://docs.ya.works/pagination.md): Navega por grandes conjuntos de resultados con paginación basada en páginas - [Rate Limiting](https://docs.ya.works/rate-limiting.md): Entiende los límites de peticiones y cómo manejar respuestas 429 - [Manejo de Errores](https://docs.ya.works/errors.md): Entiende las respuestas de error de la API y cómo manejarlas - [Request IDs](https://docs.ya.works/request-ids.md): Identifica cada petición para que un problema se pueda rastrear de punta a punta. - [Zonas horarias](https://docs.ya.works/timezones.md): Cómo la API maneja las fechas y zonas horarias. - [Webhooks](https://docs.ya.works/webhooks.md): Recibe eventos de órdenes en tiempo real mediante webhooks. ### Productos - [Modelo de Datos del Producto](https://docs.ya.works/products/data-model.md): Entiende la jerarquía de entidades de producto y el orden obligatorio de creación - [Categorías y Catálogos](https://docs.ya.works/products/categories-and-catalogs.md): Consulta catálogos y gestiona categorías antes de crear productos - [Gestionar Productos](https://docs.ya.works/products/manage-products.md): CRUD completo de productos, variantes, opciones, media y categorías ### Mensajería Saliente - [Mensajes de Plantilla](https://docs.ya.works/outbound/cart-abandonment.md): Envía un WhatsApp con una plantilla aprobada y consulta en qué estado quedó. - [Receta: Shopify (Flow)](https://docs.ya.works/outbound/shopify-flow.md): Dispara el envío de plantilla desde Shopify Flow, sin código y sin un servidor propio. ## API Reference ### Orders - [List orders](https://docs.ya.works/api-reference/orders/list-orders.md): Retrieve a paginated list of orders for the authenticated merchant. - [Get order by ID](https://docs.ya.works/api-reference/orders/get-order-by-id.md): Retrieve a single order by its ID for the authenticated merchant. - [Get order counts by status](https://docs.ya.works/api-reference/orders/get-order-counts-by-status.md): Retrieve the number of orders per status for the authenticated merchant. ### Conversations - [List conversations](https://docs.ya.works/api-reference/conversations/list-conversations.md): Retrieve a paginated list of WhatsApp conversations for the authenticated merchant. - [List messages of a conversation](https://docs.ya.works/api-reference/conversations/list-messages-of-a-conversation.md): Retrieve the messages of a conversation, newest page first. ### Contacts - [List contacts](https://docs.ya.works/api-reference/contacts/list-contacts.md): Retrieve a paginated list of campaign contacts for the authenticated merchant. ### Templates - [List approved templates](https://docs.ya.works/api-reference/templates/list-approved-templates.md): List the templates this merchant can send right now. ### Template Messages - [Send a template message](https://docs.ya.works/api-reference/template-messages/send-a-template-message.md): Send an approved WhatsApp template to a customer. - [Get template message status](https://docs.ya.works/api-reference/template-messages/get-template-message-status.md): Check where a template message got to, by your own `event_id`. ### Company - [Get company profile](https://docs.ya.works/api-reference/company/get-company-profile.md): Retrieve the authenticated merchant's company profile. ### Products - [List products](https://docs.ya.works/api-reference/products/list-products.md): Retrieve a paginated list of products for the authenticated merchant. - [Create product](https://docs.ya.works/api-reference/products/create-product.md): Create a new product for the authenticated merchant. - [Get product by ID](https://docs.ya.works/api-reference/products/get-product-by-id.md): Retrieve a single product by its ID for the authenticated merchant. - [Update product](https://docs.ya.works/api-reference/products/update-product.md): Update an existing product for the authenticated merchant. - [Delete product](https://docs.ya.works/api-reference/products/delete-product.md): Delete a product and remove it from search index. #### Variants - [Create variant](https://docs.ya.works/api-reference/product-variants/create-variant.md): Add a new variant to an existing product. - [Update variant](https://docs.ya.works/api-reference/product-variants/update-variant.md): Update an existing variant of a product. - [Delete variant](https://docs.ya.works/api-reference/product-variants/delete-variant.md): Remove a variant from a product. #### Options - [Create option](https://docs.ya.works/api-reference/product-options/create-option.md): Add a new option with values to an existing product. - [Update option](https://docs.ya.works/api-reference/product-options/update-option.md): Update an option name on a product. - [Delete option](https://docs.ya.works/api-reference/product-options/delete-option.md): Delete an option and all its values from a product. #### Option Values - [Create option value](https://docs.ya.works/api-reference/product-option-values/create-option-value.md): Create a new value for an existing product option. - [Update option value](https://docs.ya.works/api-reference/product-option-values/update-option-value.md): Update an option value label. - [Delete option value](https://docs.ya.works/api-reference/product-option-values/delete-option-value.md): Remove a value from a product option. #### Media - [Add media to variant](https://docs.ya.works/api-reference/product-media/add-media-to-variant.md): Add media (image, video, etc.) to a product variant. - [Update media](https://docs.ya.works/api-reference/product-media/update-media.md): Update media title or URL on a variant. - [Delete media](https://docs.ya.works/api-reference/product-media/delete-media.md): Remove a media file from a variant. #### Categories - [Assign categories to product](https://docs.ya.works/api-reference/product-categories/assign-categories-to-product.md): Assign existing categories to a product by their IDs. - [Remove category from product](https://docs.ya.works/api-reference/product-categories/remove-category-from-product.md): Remove a category from a product (does not delete the category). ### Categories - [List categories](https://docs.ya.works/api-reference/categories/list-categories.md): Retrieve the list of categories for the authenticated merchant. - [Create category](https://docs.ya.works/api-reference/categories/create-category.md): Create a new category (tag) for the merchant. - [Update category](https://docs.ya.works/api-reference/categories/update-category.md): Rename a category (tag). - [Delete category](https://docs.ya.works/api-reference/categories/delete-category.md): Delete a category globally. Removes it from all products. ### Catalogs - [List catalogs](https://docs.ya.works/api-reference/catalogs/list-catalogs.md): Retrieve the list of catalogs for the authenticated merchant. ### Webhooks - [Create webhook](https://docs.ya.works/api-reference/webhooks/create-webhook.md): Register a webhook endpoint to receive real-time order events. - [List webhooks](https://docs.ya.works/api-reference/webhooks/list-webhooks.md): List all registered webhook endpoints for the authenticated merchant. - [Get webhook by ID](https://docs.ya.works/api-reference/webhooks/get-webhook-by-id.md): Retrieve a specific webhook endpoint by its ID. - [Update webhook](https://docs.ya.works/api-reference/webhooks/update-webhook.md): Update a webhook endpoint (URL, events, active status, or description). - [Delete webhook](https://docs.ya.works/api-reference/webhooks/delete-webhook.md): Delete a webhook endpoint. - [Get delivery attempts](https://docs.ya.works/api-reference/webhooks/get-delivery-attempts.md): Check delivery attempts for a specific webhook message. ## Changelog ### Changelog - [Changelog](https://docs.ya.works/changelog.md): Historial de cambios y actualizaciones de la YaVendio Business API. ## OpenAPI Specs - [openapi](/openapi.json) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [English (54 pages)](https://docs.ya.works/_llms/en.txt): Documentation for English. - [Portuguese (54 pages)](https://docs.ya.works/_llms/pt.txt): Documentation for Portuguese. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.