/v1. La fuente viva es
GET /v1/operations, que además
filtra por los permisos de tu clave.
Cada operación tiene un identificador (operationId) que usa el MCP, formado
por el método y la ruta: GET /campaigns/:id es get_campaigns_id. Los
parámetros de ruta van entre : y se reemplazan por el valor real.
Las operaciones marcadas con esquema publican el formato exacto de su
cuerpo o de sus parámetros de consulta: es el mismo validador que usa el
panel, convertido a JSON Schema. Lo ves con
describe_operation desde tu
asistente o en el OpenAPI. Para el resto, el cuerpo es el mismo que envía el
panel: leé el objeto actual y devolvé la misma forma.platform:read; Escritura es platform:write;
Mensajes, Facturación, Equipo e Integraciones son los permisos adicionales
(messages:send, billing:write, team:write, integrations:write), que
siempre van junto a Escritura.
Tienda
| Método | Ruta | Qué hace | Permisos |
|---|---|---|---|
GET | /store/information | Get the store record as persisted by Nubea. | Lectura |
GET | /store/branding | Get the agency branding shown in this store’s dashboard, if any. | Lectura |
PATCH | /store | Update store settings such as the WhatsApp connection type and preferences. | Escritura + Integraciones |
GET | /store | Get the store profile: name, domain, platform, plan and settings. | Lectura |
GET | /stores/team | List team members and pending invitations, with their roles. | Lectura |
POST | /stores/team/invitations | Invite someone to the team by email with a role (owner, member or agent). | Escritura + Equipo |
DELETE | /stores/team/invitations/:id | Revoke a pending team invitation. | Escritura + Equipo |
DELETE | /stores/team/members/:userId | Remove a member from the team. Their API keys stop working. | Escritura + Equipo |
GET | /onboarding | Get the onboarding checklist state. | Lectura |
POST | /onboarding | Save onboarding answers. | Escritura |
POST | /onboarding/activate-features | Turn on the features chosen during onboarding. | Escritura |
GET | /dashboard | Home metrics: recovered revenue, sales by channel and new subscribers for a period. · esquema | Lectura |
GET | /dashboard/overview | Home overview for a period (24h, 7d, 30d, 90d) with the previous period for comparison: recovered revenue, messages sent, conversion rate, carts recovered, new subscribers and stock-alert requests as series, revenue by channel, pending items, latest attributed sales and recent reviews. · esquema | Lectura |
GET | /tiendanube/products | Search the catalog on the ecommerce platform (products with variants, prices and stock). | Lectura |
GET | /tiendanube/categories | List the categories on the ecommerce platform. | Lectura |
Estadísticas y conversiones
| Método | Ruta | Qué hace | Permisos |
|---|---|---|---|
GET | /statistics/export | Email a CSV export of the statistics to the merchant. Queues a job. · esquema | Escritura |
GET | /statistics | Overview statistics for a period of up to 365 days: messages sent, conversions, revenue by feature. · esquema | Lectura |
GET | /statistics/products | Per-product table of the statistics overview, paginated. Period of up to 365 days. · esquema | Lectura |
GET | /conversions | List orders attributed to one source type, one row per order with its products. Big: pass a short range or page + limit. For totals per day use /conversions/summary. · esquema | Lectura |
GET | /conversions/summary | Attributed sales added up per day, week or month and per source, for up to two years. The operation for “which day sold most” or “how did September compare”. · esquema | Lectura |
GET | /conversions/recovered-total | Everything attributed to Nubea since the store joined, one number per currency. | Lectura |
GET | /conversions/export | Email a CSV export of attributed sales to the merchant. Queues a job. | Escritura |
GET | /analytics/orders | Orders from the ecommerce platform for a date range, as the statistics screens read them. | Lectura |
WhatsApp: conexión y plantillas
| Método | Ruta | Qué hace | Permisos |
|---|---|---|---|
POST | /whatsapp/session | Start a WhatsApp QR session. The merchant must scan the QR in the dashboard. | Escritura + Integraciones |
GET | /whatsapp/session | Current WhatsApp connection state for the store (QR, official API or shared number). | Lectura |
DELETE | /whatsapp/session | Disconnect the WhatsApp QR session. | Escritura + Integraciones |
POST | /whatsapp/send-message | Send one WhatsApp message to a phone number through the connected provider. | Escritura + Mensajes |
POST | /whatsapp/connect-nubea | Connect the store to Nubea’s shared official WhatsApp number. | Escritura + Integraciones |
POST | /whatsapp/disconnect-nubea | Disconnect the store from Nubea’s shared WhatsApp number. | Escritura + Integraciones |
GET | /whatsapp/templates | List WhatsApp message templates and their approval status. | Lectura |
GET | /whatsapp/templates/:id | Get one WhatsApp template. | Lectura |
POST | /whatsapp/templates | Create a WhatsApp template and submit it for approval (official API only). | Escritura |
PATCH | /whatsapp/templates/:id | Update a WhatsApp template; changes go back through approval. | Escritura |
DELETE | /whatsapp/templates/:id | Delete a WhatsApp template. | Escritura |
POST | /whatsapp/templates/header-media | Get an upload URL for a template header image or video. | Escritura |
POST | /whatsapp/templates/sync | Re-sync templates and their status from the provider. | Escritura |
POST | /whatsapp/templates/:id/test | Send a test message with a template to a phone number. | Escritura + Mensajes |
POST | /kapso/setup | Start connecting an official WhatsApp number. Returns a setup link to finish in the browser. | Escritura + Integraciones |
GET | /kapso/status | Cached status of the official WhatsApp API connection. | Lectura |
POST | /kapso/revalidate | Ask the provider for the real connection state and repair the cached one. | Escritura + Integraciones |
POST | /kapso/disconnect | Disconnect the official WhatsApp number. Templates are deleted and must be re-approved to reconnect. | Escritura + Integraciones |
POST | /kapso/confirm-redirect | Confirm the official API setup after the merchant returns from the provider. | Escritura + Integraciones |
GET | /kapso/phone-health | Quality and messaging limits of the official WhatsApp number. | Lectura |
GET | /whatsapp-button | Get the floating WhatsApp button widget settings. | Lectura |
POST | /whatsapp-button | Create the floating WhatsApp button widget. · esquema | Escritura |
PATCH | /whatsapp-button/:whatsappButtonId | Update the floating WhatsApp button widget. · esquema | Escritura |
POST | /chat-agent/connect-code | Issue a one-time code to pair a WhatsApp number with the store assistant. | Escritura + Integraciones |
GET | /chat-agent/bindings | List phone numbers paired with the store assistant. | Lectura |
DELETE | /chat-agent/bindings/:phone | Unpair a phone number from the store assistant. | Escritura + Integraciones |
GET | /chat-agent/usage | Usage of the store assistant for the current period. | Lectura |
Automatizaciones
| Método | Ruta | Qué hace | Permisos |
|---|---|---|---|
POST | /automations | Create an automation. It starts sending once active and a WhatsApp number is connected. | Escritura + Mensajes |
GET | /automations | List WhatsApp automations (abandoned cart, order shipped, payment reminder, cashback…). | Lectura |
PUT | /automations/:id | Update an automation: message, delay, conditions, active state, or its flow of extra steps (validated; a saved flow is versioned). | Escritura + Mensajes |
GET | /automations/:id | Get one automation with its message, timing, conditions and the extra steps in flow (waits, purchase check, coupon, follow-up messages). | Lectura |
DELETE | /automations/:id | Delete an automation. Scheduled messages for it are cancelled. | Escritura + Mensajes |
POST | /automations/:id/execute | Run the automation now over its current candidates. Sends real messages. | Escritura + Mensajes |
POST | /automations/:id/test | Send a test of the automation message to a phone number. | Escritura + Mensajes |
POST | /automations/executions/:automationExecutionId/run | Send one pending automation message now. | Escritura + Mensajes |
POST | /automations/executions/:automationExecutionId/cancel | Cancel one pending automation message. | Escritura + Mensajes |
GET | /automations/:automationId/report | Executions of an automation for a period: sent, delivered, failed, converted. | Lectura |
GET | /automations/:automationId/failures | Failure reasons of an automation, grouped and counted. | Lectura |
GET | /automations/:automationId/flow/stats | Per-step counters of the automation flow: customers waiting on each step and how its follow-up messages fared. | Lectura |
GET | /automations/:automationId/flow/versions | Saved versions of the automation flow steps, newest first (restore one by sending its flow back through PUT /automations/:id). | Lectura |
Campañas y listas de contactos
| Método | Ruta | Qué hace | Permisos |
|---|---|---|---|
GET | /campaigns/opt-outs | Phone numbers that opted out of campaigns. | Lectura |
GET | /campaigns/opt-outs/export | Email a CSV of the opt-outs to the merchant. Queues a job. | Escritura |
POST | /campaigns/opt-outs | Add a phone number to the opt-out list. | Escritura |
DELETE | /campaigns/opt-outs/:phone | Remove a phone number from the opt-out list. | Escritura |
GET | /campaigns/lists | List contact lists with their sizes. | Lectura |
POST | /campaigns/lists | Create an empty contact list. · esquema | Escritura |
GET | /campaigns/lists/:id | Get one contact list. | Lectura |
PUT | /campaigns/lists/:id | Rename a contact list. · esquema | Escritura |
DELETE | /campaigns/lists/:id | Delete a contact list and its contacts. | Escritura |
GET | /campaigns/lists/:id/contacts/export | Email a CSV of the list contacts to the merchant. Queues a job. | Escritura |
POST | /campaigns/lists/import/tiendanube | Create a list from ecommerce customers matching filters (orders, dates, amounts). Imports in the background. · esquema | Escritura |
POST | /campaigns/lists/import/csv | Create a list from CSV rows. · esquema | Escritura |
POST | /campaigns/lists/import/newsletter | Create a list from popup newsletter subscribers. · esquema | Escritura |
POST | /campaigns/lists/:id/sync | Re-run the platform import that built the list, adding new matching customers. | Escritura |
POST | /campaigns/lists/:id/import/csv | Add CSV rows to an existing list. · esquema | Escritura |
GET | /campaigns/lists/:id/contacts | Contacts in a list, paginated. | Lectura |
POST | /campaigns/lists/:id/contacts | Add one contact to a list. · esquema | Escritura |
DELETE | /campaigns/lists/:id/contacts/:contactId | Remove a contact from a list. | Escritura |
GET | /campaigns | List WhatsApp campaigns, filterable by status. · esquema | Lectura |
POST | /campaigns | Create a campaign draft for a contact list. Nothing is sent until send or schedule. · esquema | Escritura |
GET | /campaigns/:id | Get one campaign with its content, audience and counters. | Lectura |
PUT | /campaigns/:id | Update a campaign draft. · esquema | Escritura |
DELETE | /campaigns/:id | Delete a campaign that is not sending. | Escritura |
GET | /campaigns/:id/preview | Render the campaign message with sample contact data. | Lectura |
POST | /campaigns/:id/send | Send the campaign now to its list. Irreversible once messages leave. | Escritura + Mensajes |
POST | /campaigns/:id/schedule | Schedule the campaign for a date and time. · esquema | Escritura + Mensajes |
POST | /campaigns/:id/cancel | Cancel a scheduled, sending or paused campaign. It cannot be resumed afterwards. | Escritura |
POST | /campaigns/:id/pause | Pause a campaign that is sending. | Escritura |
POST | /campaigns/:id/resume | Resume a paused campaign. | Escritura + Mensajes |
POST | /campaigns/:id/duplicate | Duplicate a campaign into a new draft. | Escritura |
GET | /campaigns/:id/messages | Per-recipient messages of a campaign with delivery status. | Lectura |
POST | /campaigns/:id/messages/:messageId/retry | Retry one failed campaign message. | Escritura + Mensajes |
Inbox
| Método | Ruta | Qué hace | Permisos |
|---|---|---|---|
GET | /inbox/status | Whether the inbox is enabled and which provider feeds it. | Lectura |
POST | /inbox/enable | Enable the WhatsApp inbox (official API connections only). | Escritura |
POST | /inbox/disable | Disable the WhatsApp inbox. | Escritura |
GET | /inbox/conversations | List conversations with filters (status, assignee, tag, search) and pagination. · esquema | Lectura |
GET | /inbox/export | Email a CSV of inbox conversations to the merchant. Queues a job. | Escritura |
GET | /inbox/conversations/:id/messages | Messages of a conversation, paginated. · esquema | Lectura |
POST | /inbox/conversations/:id/messages | Send a WhatsApp message in a conversation. Outside the 24h window a template is required. · esquema | Escritura + Mensajes |
POST | /inbox/media/upload-url | Get an upload URL to attach media to an inbox message. · esquema | Escritura |
POST | /inbox/conversations/:id/read | Mark a conversation as read. | Escritura |
POST | /inbox/conversations/:id/unread | Mark a conversation as unread. | Escritura |
POST | /inbox/conversations/:id/pin | Pin or unpin a conversation. · esquema | Escritura |
POST | /inbox/conversations/:id/status | Open or close a conversation. · esquema | Escritura |
POST | /inbox/conversations/:id/name | Set the display name of the contact. · esquema | Escritura |
GET | /inbox/members | Team members a conversation can be assigned to. | Lectura |
POST | /inbox/conversations/:id/assign | Assign a conversation to a team member, or unassign it. · esquema | Escritura |
GET | /inbox/tags | List inbox tags. | Lectura |
POST | /inbox/tags | Create an inbox tag. · esquema | Escritura |
PATCH | /inbox/tags/:tagId | Rename or recolor an inbox tag. · esquema | Escritura |
DELETE | /inbox/tags/:tagId | Delete an inbox tag from every conversation. | Escritura |
POST | /inbox/conversations/:id/tags | Add a tag to a conversation. · esquema | Escritura |
DELETE | /inbox/conversations/:id/tags/:tagId | Remove a tag from a conversation. | Escritura |
GET | /inbox/conversations/:id/notes | Internal notes on a conversation. | Lectura |
POST | /inbox/conversations/:id/notes | Add an internal note to a conversation. · esquema | Escritura |
DELETE | /inbox/notes/:noteId | Delete an internal note. | Escritura |
GET | /inbox/conversations/:id/orders | The contact’s orders on the ecommerce platform. | Lectura |
GET | /inbox/conversations/:id/automations | Automation messages this contact received. | Lectura |
GET | /inbox/conversations/:id/reviews | Product reviews this contact left. | Lectura |
GET | /inbox/automations/available | Automations that can be triggered manually from a conversation. | Lectura |
POST | /inbox/conversations/:id/automations/trigger | Send an automation message to this contact now. · esquema | Escritura + Mensajes |
GET | /inbox/tier-settings | Thresholds that classify contacts into tiers by purchase history. | Lectura |
PUT | /inbox/tier-settings | Update the contact tier thresholds. · esquema | Escritura |
POST | /inbox/segments/recalculate | Recompute every contact tier from current orders. | Escritura |
POST | /inbox/conversations/:id/tier | Set a contact tier by hand. · esquema | Escritura |
POST | /inbox/reconcile | Re-sync conversations and messages from the WhatsApp provider. | Escritura |
GET | /inbox/quick-replies | List saved quick replies. | Lectura |
POST | /inbox/quick-replies | Create a quick reply. · esquema | Escritura |
DELETE | /inbox/quick-replies/:id | Delete a quick reply. | Escritura |
Notificaciones
| Método | Ruta | Qué hace | Permisos |
|---|---|---|---|
GET | /notifications | Dashboard notifications for the store. | Lectura |
POST | /notifications/create | Create a dashboard notification. | Escritura |
DELETE | /notifications/remove | Delete a notification. | Escritura |
POST | /notifications/read | Mark a notification as read. | Escritura |
POST | /notifications/read-all | Mark every notification as read. | Escritura |
Popup, newsletter y formularios
| Método | Ruta | Qué hace | Permisos |
|---|---|---|---|
GET | /newsletter/all-suscribers | Subscribers captured by the popup. | Lectura |
GET | /newsletter/settings | Popup settings: design, coupon, roulette and display rules. | Lectura |
POST | /newsletter/settings | Update the popup settings. Validates the full design. | Escritura |
GET | /newsletter/publication-status | Whether the popup script is live on the storefront. | Lectura |
POST | /newsletter/preview | Create a storefront preview link for the popup. | Escritura |
GET | /newsletter/metrics | Popup metrics: impressions, subscribers, conversion. | Lectura |
GET | /newsletter/export-subscribers | Email a CSV of popup subscribers to the merchant. Queues a job. | Escritura |
POST | /newsletter/upload-image | Upload an image for the popup design. | Escritura |
GET | /contact-form/settings | Contact form widget settings. | Lectura |
PUT | /contact-form/settings | Update the contact form widget settings. | Escritura |
GET | /contact-form/crm-lists | Contact lists a form submission can be added to. | Lectura |
GET | /contact-form/submissions | Submissions received through the contact form. | Lectura |
GET | /contact-form/submissions/export | Email a CSV of form submissions to the merchant. Queues a job. | Escritura |
POST | /contact-form/submissions/delete | Delete contact form submissions by id. | Escritura |
POST | /perfit/sync-contacts | Push subscribers to the connected Perfit list. | Escritura + Integraciones |
Reseñas y opiniones
| Método | Ruta | Qué hace | Permisos |
|---|---|---|---|
GET | /product-reviews/settings | Product reviews settings: request timing, channel, widget design. | Lectura |
POST | /product-reviews/settings | Update the product reviews settings. | Escritura |
GET | /product-reviews/metrics | Review metrics: requested, received, average rating. | Lectura |
GET | /product-reviews/list | List product reviews with filters and pagination. | Lectura |
GET | /product-reviews/export | Email a CSV of reviews to the merchant. Queues a job. | Escritura |
POST | /product-reviews/import | Import reviews from a CSV. | Escritura |
POST | /product-reviews/bulk-moderate | Approve or reject several reviews at once. | Escritura |
POST | /product-reviews/send-test-email | Send a test review-request email. | Escritura + Mensajes |
GET | /product-reviews/dispatches | Pending review requests scheduled to go out. | Lectura |
POST | /product-reviews/dispatches/cancel | Cancel pending review requests. | Escritura |
POST | /product-reviews/dispatches/send-now | Send pending review requests now. | Escritura + Mensajes |
POST | /product-reviews/admin/upload-url | Get an upload URL for review images. | Escritura |
POST | /product-reviews/admin/logo-upload-url | Get an upload URL for the logo in review emails. | Escritura |
GET | /product-reviews/:reviewId | Get one product review. | Lectura |
PATCH | /product-reviews/:reviewId/moderate | Approve or reject a review. | Escritura |
PATCH | /product-reviews/:reviewId/show-images | Show or hide the images of a review. | Escritura |
PATCH | /product-reviews/:reviewId/verified | Toggle the verified-purchase mark on a review. | Escritura |
PATCH | /product-reviews/:reviewId/featured | Feature or unfeature a review. | Escritura |
PATCH | /product-reviews/:reviewId/reply | Reply publicly to a review. | Escritura |
DELETE | /product-reviews/:reviewId | Delete a review. | Escritura |
GET | /store-testimonials | List testimonials shown by the testimonials widget. | Lectura |
POST | /store-testimonials | Create a testimonial. | Escritura |
PUT | /store-testimonials | Update a testimonial. | Escritura |
PATCH | /store-testimonials | Enable or disable a testimonial. | Escritura |
PATCH | /store-testimonials/reorder | Reorder testimonials. | Escritura |
DELETE | /store-testimonials/:id | Delete a testimonial. | Escritura |
PUT | /store-testimonials/settings | Update the testimonials widget settings. | Escritura |
POST | /store-testimonials/upload-url | Get an upload URL for a testimonial photo. | Escritura |
Stock
| Método | Ruta | Qué hace | Permisos |
|---|---|---|---|
GET | /stock-notifications/metrics | Back-in-stock metrics: subscribers, alerts sent, conversions. | Lectura |
GET | /stock-notifications/export | Email a CSV of back-in-stock subscribers to the merchant. Queues a job. | Escritura |
GET | /stock-notifications/list | People waiting for products to come back in stock. | Lectura |
GET | /stock-notifications/settings | Back-in-stock alert settings. | Lectura |
POST | /stock-notifications/send-single/:notificationId | Send one back-in-stock alert now. | Escritura + Mensajes |
POST | /stock-notifications/send-test-email | Send a test back-in-stock email. | Escritura + Mensajes |
POST | /stock-notifications/settings | Update the back-in-stock alert settings and register the platform webhook. | Escritura |
GET | /stock-notifications/:notificationId | Get one back-in-stock subscription. | Lectura |
DELETE | /stock-notifications/:notificationId | Delete a back-in-stock subscription. | Escritura |
GET | /stock-counter/settings | Stock counter widget settings. | Lectura |
POST | /stock-counter/settings | Update the stock counter widget settings. | Escritura |
Promociones, combos y regalos
| Método | Ruta | Qué hace | Permisos |
|---|---|---|---|
GET | /promotions/settings | Promotion widget settings (how promotions are shown on the storefront). | Lectura |
PUT | /promotions/settings | Update the promotion widget settings. · esquema | Escritura |
GET | /promotions | List quantity promotions (2x1, 3x2, buy N pay M). | Lectura |
POST | /promotions | Create a quantity promotion. It is applied at checkout by the platform. · esquema | Escritura |
PATCH | /promotions/:id | Update a quantity promotion. · esquema | Escritura |
PATCH | /promotions/:id/active | Activate or pause a promotion. | Escritura |
DELETE | /promotions/:id | Delete a promotion and remove it from the platform. | Escritura |
GET | /bundles | List product bundles. | Lectura |
POST | /bundles | Create a bundle of products with a discount. · esquema | Escritura |
PATCH | /bundles/:id | Update a bundle. | Escritura |
PATCH | /bundles/:id/active | Activate or pause a bundle. | Escritura |
DELETE | /bundles/:id | Delete a bundle. | Escritura |
GET | /cart-gifts | List gift-by-amount rules. | Lectura |
POST | /cart-gifts | Create a gift added to the cart above an amount. · esquema | Escritura |
PATCH | /cart-gifts/:id | Update a cart gift rule. · esquema | Escritura |
PATCH | /cart-gifts/:id/active | Activate or pause a cart gift rule. | Escritura |
DELETE | /cart-gifts/:id | Delete a cart gift rule. | Escritura |
GET | /installments | List installment rules shown on product pages. | Lectura |
POST | /installments | Create an installment rule. | Escritura |
PUT | /installments | Update an installment rule. | Escritura |
DELETE | /installments/:id | Delete an installment rule. | Escritura |
PUT | /installments/settings | Update the installments widget settings. | Escritura |
Barras y alertas en la tienda
| Método | Ruta | Qué hace | Permisos |
|---|---|---|---|
GET | /free-shipping-bar/settings | Free-shipping progress bar settings. | Lectura |
POST | /free-shipping-bar/settings | Update the free-shipping bar: threshold in whole currency units, texts and colors. · esquema | Escritura |
GET | /free-shipping-bar/threshold-suggestion | A threshold suggestion computed from recent order amounts. | Lectura |
POST | /flash-countdown-bar/settings | Update the top bar settings. | Escritura |
GET | /flash-countdown-bar/settings | Top bar settings: countdown and rotating announcements. | Lectura |
GET | /action-bar/settings | Action bar widget settings. | Lectura |
POST | /action-bar/settings | Update the action bar widget settings. · esquema | Escritura |
POST | /action-bar/deactivate | Turn the action bar off without validating its settings. | Escritura |
GET | /fomo-alerts | Social-proof alert settings for every alert type. | Lectura |
GET | /fomo-alerts/variables | Variables available in social-proof alert texts. | Lectura |
GET | /fomo-alerts/:alertType | Settings of one social-proof alert type. | Lectura |
POST | /fomo-alerts/create | Create a social-proof alert. | Escritura |
PUT | /fomo-alerts/update | Update a social-proof alert. | Escritura |
Ficha de producto
| Método | Ruta | Qué hace | Permisos |
|---|---|---|---|
GET | /product-content-blocks | List product page content blocks (warranty, FAQ, comparison, rich text…). | Lectura |
GET | /product-content-blocks/stats | Impressions and clicks per content block. | Lectura |
POST | /product-content-blocks/upload-url | Get an upload URL for a content block image. | Escritura |
POST | /product-content-blocks | Create a content block. It starts paused. | Escritura |
PUT | /product-content-blocks | Update a content block design. | Escritura |
PATCH | /product-content-blocks | Enable, disable or reprioritize a content block without resending its design. | Escritura |
PATCH | /product-content-blocks/reorder | Reorder content blocks by id list. | Escritura |
DELETE | /product-content-blocks/:id | Delete a content block. | Escritura |
GET | /product-stickers | List product stickers (OFERTA, 3x2…). | Lectura |
POST | /product-stickers | Create a product sticker. | Escritura |
PUT | /product-stickers | Update a product sticker. | Escritura |
DELETE | /product-stickers/:id | Delete a product sticker. | Escritura |
POST | /product-stickers/upload-url | Get an upload URL for a custom sticker image. | Escritura |
GET | /product-badges | List product badges and the featured price settings. | Lectura |
POST | /product-badges | Create a product badge. | Escritura |
PUT | /product-badges | Update a product badge. | Escritura |
DELETE | /product-badges/:id | Delete a product badge. | Escritura |
PUT | /product-badges/settings | Update badge settings, including the featured transfer price. | Escritura |
GET | /product-video-slider | Product video sliders. | Lectura |
PUT | /product-video-slider | Create or update the video slider of a product. | Escritura |
POST | /product-video-slider/upload-url | Get an upload URL for a slider video. | Escritura |
DELETE | /product-video-slider/product/:productId | Remove the video slider of a product. | Escritura |
GET | /product-video-slider/home | Home page video slider settings. | Lectura |
PUT | /product-video-slider/home | Update the home page video slider. | Escritura |
POST | /shop-the-look/settings | Update the shop-the-look widget settings. | Escritura |
GET | /shop-the-look/settings | Shop-the-look widget settings. | Lectura |
GET | /shop-the-look/home-sections | Looks shown on the home page. | Lectura |
GET | /shop-the-look/looks | List looks (sets of products bought together). | Lectura |
GET | /shop-the-look/looks/health | Looks with missing or unavailable products. | Lectura |
POST | /shop-the-look/looks/:id/revalidate | Re-check the products of a look against the platform. | Escritura |
POST | /shop-the-look/looks | Create or update a look. | Escritura |
DELETE | /shop-the-look/looks/:id | Delete a look. | Escritura |
GET | /size-guides | List size guides. | Lectura |
POST | /size-guides | Create a size guide. | Escritura |
PUT | /size-guides | Update a size guide. | Escritura |
DELETE | /size-guides/:id | Delete a size guide. | Escritura |
POST | /size-guides/upload-url | Get an upload URL for a size guide image. | Escritura |
GET | /wishlist/settings | Wishlist widget settings. | Lectura |
POST | /wishlist/settings | Update the wishlist widget settings. · esquema | Escritura |
GET | /wishlist/analytics | Most wished products and wishlist activity. | Lectura |
GET | /wishlist/export | Email a CSV of wishlist contacts to the merchant. Queues a job. | Escritura |
Cambios y devoluciones
| Método | Ruta | Qué hace | Permisos |
|---|---|---|---|
GET | /product-exchanges/settings | Exchanges and returns settings: window, conditions, texts. | Lectura |
POST | /product-exchanges/settings | Update the exchanges and returns settings. · esquema | Escritura |
GET | /product-exchanges/metrics | Exchange request metrics. | Lectura |
GET | /product-exchanges/requests | List exchange requests with status. | Lectura |
GET | /product-exchanges/requests/:id | Get one exchange request. | Lectura |
POST | /product-exchanges/requests/:id/approve | Approve an exchange request. Notifies the customer. | Escritura |
PATCH | /product-exchanges/requests/:id/address | Update the return address of an exchange. · esquema | Escritura |
POST | /product-exchanges/requests/:id/confirm | Confirm the exchange was completed. | Escritura |
POST | /product-exchanges/requests/:id/reject | Reject an exchange request with a reason. Notifies the customer. · esquema | Escritura |
DELETE | /product-exchanges/requests/:id | Delete an exchange request. | Escritura |
GET | /product-exchanges/export | Email a CSV of exchange requests to the merchant. Queues a job. | Escritura |
Suscripción
| Método | Ruta | Qué hace | Permisos |
|---|---|---|---|
GET | /subscription | Current subscription: plan, status, provider, next charge. | Lectura |
GET | /subscription/payments | Payment history. | Lectura |
GET | /subscription/checkout-result | Result of the last checkout. | Lectura |
GET | /subscription/trial | Free trial state and whether a payment failed recently. | Lectura |
GET | /subscription/usage | Message usage against the plan for the current cycle. | Lectura |
GET | /subscription/pre-approval | The recurring payment agreement at the provider. | Lectura |
POST | /subscription/cancel | Cancel the subscription at the provider. Access ends with the paid period. | Escritura + Facturación |
POST | /subscription/create-preapproval | Start a checkout for a plan. Returns a URL the merchant must open to pay. | Escritura + Facturación |
POST | /subscription/validate-coupon | Check whether a coupon code can be redeemed. | Escritura + Facturación |
POST | /subscription/update-plan | Change plan or billing cycle. May open a new checkout. | Escritura + Facturación |
POST | /subscription/resume | Resume a paused subscription through a new checkout. | Escritura + Facturación |