diff --git a/docs/api/1-checkout-process/pay-later-payment.mdx b/docs/api/1-checkout-process/pay-later-payment.mdx index e031399..208f97b 100644 --- a/docs/api/1-checkout-process/pay-later-payment.mdx +++ b/docs/api/1-checkout-process/pay-later-payment.mdx @@ -52,7 +52,7 @@ Una vez que el comprador ha completado el proceso de pago satisfatoriamente, Apl [Ver descripción técnica de cómo confirmar un pedido](../../checkout-confirmation/) -### 4. Resultado de la solicitud" +### 4. Resultado de la solicitud Una vez completado el proceso de pago Aplazame mostrará el resultado de la solicitud de financiación al comprador. :::info diff --git a/docs/api/10-widget/10-widget.mdx b/docs/api/10-widget/10-widget.mdx index c6fee9e..81293dc 100644 --- a/docs/api/10-widget/10-widget.mdx +++ b/docs/api/10-widget/10-widget.mdx @@ -14,7 +14,7 @@ El widget de Aplazame te permite mostrar una simulación de las cuotas de una fi ## Carga de aplazame.js :::info - Debes incluir aplazame.js en las páginas donde deba aparecer el widget. Consulta todas las opciones de integración. + Debes incluir aplazame.js en las páginas donde deba aparecer el widget. Consulta todas las opciones de integración. ::: diff --git a/docs/api/10-widget/widget-v4/widget-v4.md b/docs/api/10-widget/widget-v4/widget-v4.md index 50def8f..3bc8ce6 100644 --- a/docs/api/10-widget/widget-v4/widget-v4.md +++ b/docs/api/10-widget/widget-v4/widget-v4.md @@ -50,7 +50,7 @@ Los valores por defecto en ese caso, son los que se muestran en esta documentaci |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| |data-price | [css selector](https://developer.mozilla.org/en/docs/Web/Guide/CSS/Getting_started/Selectors) | Sí | Selector CSS que indique el elemento que contiene el precio final. Se actualiza en vivo si hay cambios en el precio. Si se usa conjuntamente con `data-amount`, se mostrará el valor de este último y de data-price si el precio cambia. -|data-amount | decimal | Sí | Cantidad a financiar **en céntimos**. Este campo se puede omitir si se usa [`data-price`](#precio-variable). +|data-amount | decimal | Sí | Cantidad a financiar **en céntimos**. Este campo se puede omitir si se usa [`data-price`](../../widget#precio-variable). |data-type | enum | No | El diseño del widget cambiará en función del valor seleccionado. Los posibles valores son: `product`, `cart`. Por omisión se usará: `product`. |data-option-legal-advice | boolean | No | Indica si debe mostrarse el texto legal justo después del widget. El valor por omisión es `false`. |data-option-primary-color | [css color](https://developer.mozilla.org/es/docs/Web/CSS/color_value) | No | Establece el color del fondo del botón y del borde. diff --git a/docs/api/10-widget/widget-v5/widget-v5.md b/docs/api/10-widget/widget-v5/widget-v5.md index 75c5ada..329bdd7 100644 --- a/docs/api/10-widget/widget-v5/widget-v5.md +++ b/docs/api/10-widget/widget-v5/widget-v5.md @@ -47,7 +47,7 @@ Los valores por defecto en ese caso, son los que se muestran en esta documentaci |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| |data-option-slider | boolean | Sí | Muestra o esconde el slider para deslizar con el ratón la cantidad de cuotas deseadas. -|data-amount | decimal | Sí | Cantidad a financiar **en céntimos**. Este campo se puede omitir si se usa [`data-price`](#precio-variable). +|data-amount | decimal | Sí | Cantidad a financiar **en céntimos**. Este campo se puede omitir si se usa [`data-price`](../../widget#precio-variable). |data-option-legal-advice | boolean | No | Indica si debe mostrarse el texto legal justo después del widget. El valor por omisión es `false`. |data-option-default-instalments | decimal | No | Permite configurar el número de cuotas seleccionadas que mostrará el widget por defecto. |data-option-align | enum | No | Indica la alineación del widget. Se puede alinear a la izquierda `left` o a la derecha `right`. El valor por omisión es `center`. diff --git a/docs/api/11-api-orders/edit.mdx b/docs/api/11-api-orders/edit.mdx index c33cfb4..54f2ca5 100644 --- a/docs/api/11-api-orders/edit.mdx +++ b/docs/api/11-api-orders/edit.mdx @@ -252,7 +252,7 @@ dynamic result = client.Put($"/orders/{orderId}", payload); |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| :orderId | string | Sí | ID del pedido. -[order](#order) | object | Sí | Pedido a actualizar. +[order](../../checkout-creation/#order) | object | Sí | Pedido a actualizar. ### Respuesta @@ -419,7 +419,7 @@ dynamic result = client.Patch($"/orders/{orderId}", payload); |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| :orderId | string | Sí | ID del pedido. -[order](#order) | object | Sí | Pedido a actualizar. +[order](../../checkout-creation/#order) | object | Sí | Pedido a actualizar. ### Respuesta diff --git a/docs/api/11-api-orders/refund.mdx b/docs/api/11-api-orders/refund.mdx index 28caf0e..04dea86 100644 --- a/docs/api/11-api-orders/refund.mdx +++ b/docs/api/11-api-orders/refund.mdx @@ -292,7 +292,7 @@ X-Aplazame-Media-Type: aplazame.v1 amount | [decimal](../../api-reference#decimals) | Importe de la captura. id | string | `id` de la captura. created | string | Fecha de la captura. -[refunds](./#pago-en-15-dias) | object | Devoluciones realizadas a la captura. +refunds | object | Devoluciones realizadas a la captura. refunded_amount | [decimal](../../api-reference#decimals) | Cantidad devuelta de la captura. remaining_amount | [decimal](../../api-reference#decimals) | Cantidad restante de la captura. @@ -398,7 +398,6 @@ X-Aplazame-Media-Type: aplazame.v1 amount | [decimal](../../api-reference#decimals) | Importe de la captura. id | string | `id` de la captura. created | string | Fecha de la captura. -[refunds](./#pago-en-15-dias) | object | Devoluciones realizadas a la captura. +refunds | object | Devoluciones realizadas a la captura. refunded_amount | [decimal](../../api-reference#decimals) | Cantidad devuelta de la captura. remaining_amount | [decimal](../../api-reference#decimals) | Cantidad restante de la captura. - diff --git a/docs/api/8-checkout-confirmation/8-checkout-confirmation.mdx b/docs/api/8-checkout-confirmation/8-checkout-confirmation.mdx index c3662d2..9da9166 100644 --- a/docs/api/8-checkout-confirmation/8-checkout-confirmation.mdx +++ b/docs/api/8-checkout-confirmation/8-checkout-confirmation.mdx @@ -95,11 +95,11 @@ Content-Type: application/json } ``` -|Parámetro | Tipo | Requerido | Descripción| -|---------|---------|---------|---------| +|Parámetro | Tipo | Descripción| +|---------|---------|---------| id | string | Identificador del pedido de Aplazame (inmutable). -[status](#codigos-de-estado-del-pedido) | string |Estado del pedido (`ok`, `pending` o `ko`). -[status_reason](#codigos-de-estado-del-pedido) | string | Código de estado del pedido. +[status](#códigos-de-estado-del-pedido) | string |Estado del pedido (`ok`, `pending` o `ko`). +[status_reason](#códigos-de-estado-del-pedido) | string | Código de estado del pedido. sandbox | boolean | El pedido fue realizado en el entorno de pruebas. mid | string | Identificador del pedido generado por el comercio o autogenerado por Aplazame. total_amount | [decimal](../api-reference#decimals) | Cantidad a financiar. diff --git a/docs/api/9-checkout-capture/9-checkout-capture.mdx b/docs/api/9-checkout-capture/9-checkout-capture.mdx index 8cb84a6..2d556d9 100644 --- a/docs/api/9-checkout-capture/9-checkout-capture.mdx +++ b/docs/api/9-checkout-capture/9-checkout-capture.mdx @@ -31,7 +31,7 @@ Se ha de realizar una captura cuando se proceda al envío del producto o product amount | [decimal](../api-reference#decimals) | Sí | Importe de la captura. id | string | Sí | `id` de la captura. created | string | Sí | Fecha de la captura. -[refunds](./#pago-en-15-dias) | object | No | Devoluciones realizadas a la captura. +refunds | object | No | Devoluciones realizadas a la captura. refunded_amount | [decimal](../api-reference#decimals) | Sí | Cantidad devuelta de la captura. remaining_amount | [decimal](../api-reference#decimals) | Sí | Cantidad restante de la captura (Siempre será 0). @@ -121,7 +121,7 @@ X-Aplazame-Media-Type: aplazame.v1 |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| remaining_capture_amount | [decimal](../api-reference#decimals) | Cantidad restante del pedido sin capturar (Siempre será 0). -[results](./#captura) | object | Capturas del pedido. +results | object | Capturas del pedido. ## 02 - Solicitar captura @@ -217,6 +217,6 @@ remaining_capture_amount | [decimal](../api-reference#decimals) | Cantidad resta amount | [decimal](../api-reference#decimals) | Importe de la captura. id | string | `id` de la captura. created | string | Fecha de la captura. -[refunds](./#pago-en-15-dias) | object | Devoluciones realizadas a la captura. +refunds | object | Devoluciones realizadas a la captura. refunded_amount | [decimal](../api-reference#decimals) | Cantidad devuelta de la captura. remaining_amount | [decimal](../api-reference#decimals) | Cantidad restante de la captura (Siempre será 0). diff --git a/docs/plugins/6-vtex/6-vtex.mdx b/docs/plugins/6-vtex/6-vtex.mdx index 1d98936..5db2c34 100644 --- a/docs/plugins/6-vtex/6-vtex.mdx +++ b/docs/plugins/6-vtex/6-vtex.mdx @@ -32,7 +32,7 @@ Application Token: Disponemos de una [app para integrar nuestro widget en VTEX](https://github.com/aplazame/vtex-widget-app). ### Instalación -- [Instala](https://vtex.io/docs/recipes/development/installing-an-app/) la app `aplazame.aplazame-widget` en la cuenta VTEX con la que tengas tu tienda. +- [Instala](https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) la app `aplazame.aplazame-widget` en la cuenta VTEX con la que tengas tu tienda. - Añádela como dependencia en el `manifest.json` del tema de tu tienda. ```diff "peerDependencies": { diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/10-widget.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/10-widget.mdx index a4eeffc..960effc 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/10-widget.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/10-widget.mdx @@ -7,12 +7,12 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; # Widget integration -The Aplazame widget allows you to show a simulation of the financing instalments next to the price of your products. You can choose between [basic integration](installment-payment#integración-básica) that you control from your Aplazame control panel and [advanced integration](installment-payment#integración-avanzada) if you want maximum flexibility. +The Aplazame widget allows you to show a simulation of the financing instalments next to the price of your products. You can choose between [basic integration](installment-payment#basic-integration) that you control from your Aplazame control panel and [advanced integration](installment-payment#advanced-integration) if you want maximum flexibility. ## Loading aplazame.js :::info - You must include **aplazame.js** on the pages where the widget should appear. Check all the [integration options](../sdk-javascript/#integracion). + You must include **aplazame.js** on the pages where the widget should appear. Check all the [integration options](../sdk-javascript/#integration). ::: diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/installment-payment.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/installment-payment.mdx index 7ea91c0..258468e 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/installment-payment.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/installment-payment.mdx @@ -20,7 +20,7 @@ keywords: [installments widget] | Parameter | Type | Required | Description | |---------|---------|---------|---------| -|data-amount | decimal | Yes | Quantity to be financed **in cents**. This field can be omitted if the data-price is used.[`data-price`](../../widget#precio-variable). +|data-amount | decimal | Yes | Quantity to be financed **in cents**. This field can be omitted if the data-price is used.[`data-price`](../../widget#variable-price). |data-currency | [ISO 4217](https://es.wikipedia.org/wiki/ISO_4217) | Yes | Currency in which the item will be sold. |data-country | [ISO 3166-1](https://es.wikipedia.org/wiki/ISO_3166-1) | Yes | Country where the sale will apply. |data-view | enum | No | The view where the widget is included corresponds to the customisation tab of the [control panel](https://vendors.aplazame.com/). The possible values are: `product` (by default) and `cart`. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/pay-in-4.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/pay-in-4.mdx index f4c9e4e..db9e5a3 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/pay-in-4.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/pay-in-4.mdx @@ -12,7 +12,7 @@ In case the merchant supports the product 'Pay in 4', you can add the parameter |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| -|data-pay-in-4 | boolean | Yes | The attribute should be **true** or empty to work properly. This field causes a complete change in the rendering of the wdiget in case the merchant supports the product 'Pay in 4'. In case it does not support it or the total of the checkout does not meet the requirements for the product, it will behave exactly the same as the ['Payment in installments' widget](../installment-payment). +|data-pay-in-4 | boolean | Yes | The attribute should be **true** or empty to work properly. This field causes a complete change in the rendering of the widget in case the merchant supports the product 'Pay in 4'. In case it does not support it or the total of the checkout does not meet the requirements for the product, it will behave exactly the same as the ['Payment in installments' widget](../installment-payment). :::caution diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/widget-v4/widget-v4.md b/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/widget-v4/widget-v4.md index 45bf14b..f3d4178 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/widget-v4/widget-v4.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/widget-v4/widget-v4.md @@ -54,7 +54,7 @@ This version aims to simplify the integration for the installment payment widget |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| |data-price | [css selector](https://developer.mozilla.org/en/docs/Web/Guide/CSS/Getting_started/Selectors) | Yes | CSS selector that indicates the element that contains the final price. It is updated live if there are changes in the price. If used in conjunction with `data-amount`, the value of the latter and `data-price` will be shown if the price changes. -|data-amount | decimal | Yes| Quantity to be financed in cents. This field can be omitted if the [`data-price`](./#variable-price) is used. +|data-amount | decimal | Yes| Quantity to be financed in cents. This field can be omitted if the [`data-price`](../../widget#variable-price) is used. |data-type | enum | No | The widget layout will change based on the selected value. The possible values are: `product` (by default) and `cart`. |data-option-legal-advice | boolean | No | Indicates whether you should displaying the legal text after the widget. The default value is `false`. |data-option-primary-color | [css color](https://developer.mozilla.org/es/docs/Web/CSS/color_value) | No | Set the background colour of the button and the border. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/widget-v5/widget-v5.md b/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/widget-v5/widget-v5.md index 1920f18..3fec843 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/widget-v5/widget-v5.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/api/10-widget/widget-v5/widget-v5.md @@ -4,13 +4,13 @@ sidebar_position: 5 keywords: [widget V5] --- -# New widget v4 +# New widget v5 ## Integration There is the possibility of integrating a new version of the widget, for this, you must assign the value "v5" to the HTML attribute: `data-aplazame-widget-instalments="v5"` ```html
``` @@ -50,7 +50,7 @@ This version aims to simplify the integration for the installment payment widget |---------|---------|---------|---------| |data-option-slider | boolean | Yes | Shows of hides the slider that lets the customer select the amount of instalments. |data-price | [css selector](https://developer.mozilla.org/en/docs/Web/Guide/CSS/Getting_started/Selectors) | Yes | CSS selector that indicates the element that contains the final price. It is updated live if there are changes in the price. If used in conjunction with `data-amount`, the value of the latter and `data-price` will be shown if the price changes. -|data-amount | decimal | Yes| Quantity to be financed in cents. This field can be omitted if the [`data-price`](./#variable-price) is used. +|data-amount | decimal | Yes| Quantity to be financed in cents. This field can be omitted if the [`data-price`](../../widget#variable-price) is used. |data-option-legal-advice | boolean | No | Indicates whether you should displaying the legal text after the widget. The default value is `false`. |data-option-default-instalments | decimal | No | Allows you to configure the number of instalments that the widget will display by default. |data-option-border-product |boolean | Yes | Indicates whether you should displaying the color border if the type is `product`. The default value is `true`. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/cancel.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/cancel.mdx index 6814b9f..03b4ff5 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/cancel.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/cancel.mdx @@ -71,7 +71,7 @@ dynamic result = client.Post($"/orders/{orderId}/cancel", new {}); |Parámetro | Tipo | Descripción| |---------|---------|---------| -:orderId | string | Sí | Order `ID` +:orderId | string | Yes | Order `ID` #### Response diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/edit.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/edit.mdx index 9b94743..5cbb5dd 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/edit.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/edit.mdx @@ -249,8 +249,8 @@ dynamic result = client.Put($"/orders/{orderId}", payload); |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| -:orderId | string | Sí | Order ID. -[order](#order) | object | Sí | Order to update. +:orderId | string | Yes | Order ID. +[order](../../checkout-creation/#order) | object | Yes | Order to update. ### Response @@ -415,8 +415,8 @@ dynamic result = client.Patch($"/orders/{orderId}", payload); |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| -:orderId | string | Sí | Order ID. -[order](#order) | object | Sí | Order to update. +:orderId | string | Yes | Order ID. +[order](../../checkout-creation/#order) | object | Yes | Order to update. ### Response diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/refund.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/refund.mdx index f43d472..f6b6535 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/refund.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/refund.mdx @@ -77,7 +77,7 @@ dynamic result = client.Get($"/orders/{orderId}/refund"); |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| -:orderId | string | Sí | Order ID. +:orderId | string | Yes | Order ID. ### Response @@ -155,8 +155,8 @@ dynamic result = client.Post($"/orders/{orderId}/refund", new {amount = Aplazame |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| -:orderId | string | Sí | Order ID. -amount | [decimal](../../api-reference#decimals) | Sí | Amount to refund. +:orderId | string | Yes | Order ID. +amount | [decimal](../../api-reference#decimals) | Yes | Amount to refund. ### Response @@ -195,14 +195,14 @@ A capture of an order accepts several partial refunds only if the sum of the amo ``` |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| -id | string | Sí | Your refund `ID`. -amount | [decimal](../../api-reference#decimals) | Sí | Refund amount. -pending_amount | [decimal](../../api-reference#decimals) | Sí | Remaining capture amount. -accrual_date | string | Sí | Effective date of refund. -credit_to_customer | [decimal](../../api-reference#decimals) | Sí | Refund amount to customer. -completed | boolean | Sí | Order completed. -completed_but_defaults | boolean | Sí | Order completed but with defaults. -created | string | Sí | Date of refund. +id | string | Yes | Your refund `ID`. +amount | [decimal](../../api-reference#decimals) | Yes | Refund amount. +pending_amount | [decimal](../../api-reference#decimals) | Yes | Remaining capture amount. +accrual_date | string | Yes | Effective date of refund. +credit_to_customer | [decimal](../../api-reference#decimals) | Yes | Refund amount to customer. +completed | boolean | Yes | Order completed. +completed_but_defaults | boolean | Yes | Order completed but with defaults. +created | string | Yes | Date of refund. ### 01 - Check remaining amount @@ -264,8 +264,8 @@ dynamic result = client.Get($"/orders/{orderId}/captures/{captureId}/refunds"); |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| -:orderId | string | Sí | Order ID. -:captureId | string | Sí |ID de la captura. +:orderId | string | Yes | Order ID. +:captureId | string | Yes |ID de la captura. ### Response @@ -290,7 +290,7 @@ X-Aplazame-Media-Type: aplazame.v1 amount | [decimal](../../api-reference#decimals) | Capture amount id | string | Your capture `id` created | string | Date of the capture -[refunds](./#pago-en-15-dias) | object | Refunds on capture done +refunds | object | Refunds on capture done refunded_amount | [decimal](../../api-reference#decimals) | Refunded capture amount remaining_amount | [decimal](../../api-reference#decimals) | Remaining capture amount (It will always be 0) @@ -359,9 +359,9 @@ dynamic result = client.Post($"/orders/{orderId}/captures/{captureId}/refunds", |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| -:orderId | string | Sí | Order ID. -:captureId | string | Sí | Capture ID. -amount | [decimal](../../api-reference#decimals) | Sí | Amount to refund. +:orderId | string | Yes | Order ID. +:captureId | string | Yes | Capture ID. +amount | [decimal](../../api-reference#decimals) | Yes | Amount to refund. ### Response @@ -397,6 +397,6 @@ X-Aplazame-Media-Type: aplazame.v1 amount | [decimal](../../api-reference#decimals) | Capture amount. id | string | Your capture `ID`. created | string | Date of the capture. -[refunds](./#pago-en-15-dias) | object | Refunds on capture done. +refunds | object | Refunds on capture done. refunded_amount | [decimal](../../api-reference#decimals) | Remaining capture amount. remaining_amount | [decimal](../../api-reference#decimals) | Remaining capture amount. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/void.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/void.mdx index b8bcde0..5b32d95 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/void.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/api/11-api-orders/void.mdx @@ -70,7 +70,7 @@ dynamic result = client.Get($"/orders/{orderId}/void"); |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| -:orderId | string | Sí | Order ID. +:orderId | string | Yes | Order ID. ### Response @@ -165,8 +165,8 @@ dynamic result = client.Post($"/orders/{orderId}/void", new {amount = Aplazame.S |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| -:orderId | string | Sí | Order ID. -amount | [decimal](../../api-reference#decimals) | Sí | Amount to void. +:orderId | string | Yes | Order ID. +amount | [decimal](../../api-reference#decimals) | Yes | Amount to void. ### Response diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api/13-checkout-offline/13-checkout-offline.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api/13-checkout-offline/13-checkout-offline.mdx index 12cc959..740eb27 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/api/13-checkout-offline/13-checkout-offline.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/api/13-checkout-offline/13-checkout-offline.mdx @@ -108,8 +108,8 @@ Content-Type: application/json mid | string | Order identifier generated by the store or generated automatically by Aplazame total_amount | [decimal](../api-reference#decimals) | Quantity to be financed currency | [decimal](../api-reference#decimals) | Order currency -[status](../checkout-confirmation/#codigos-de-estado-del-pedido) | string | Order status (`ok`, `pending` o `ko`) -[status_reason](../checkout-confirmation/#codigos-de-estado-del-pedido) | string | Order status reason +[status](../checkout-confirmation/#order-status-codes) | string | Order status (`ok`, `pending` o `ko`) +[status_reason](../checkout-confirmation/#order-status-codes) | string | Order status reason sandbox | boolean | This order was placed in the sandbox environment ## IPN (Instant Payment Notification) @@ -140,8 +140,8 @@ Changes in checkout status will be notified at the URL given on creating the che mid | string | Order identifier generated by the store or generated automatically by Aplazame. total_amount | [decimal](../api-reference#decimals) | Quantity to be financed currency | [decimal](../api-reference#decimals) | Order currency. -[status](../checkout-confirmation/#codigos-de-estado-del-pedido) | string | Order status (`ok`, `pending` o `ko`) -[status_reason](../checkout-confirmation/#codigos-de-estado-del-pedido) | string | Order status reason. +[status](../checkout-confirmation/#order-status-codes) | string | Order status (`ok`, `pending` o `ko`) +[status_reason](../checkout-confirmation/#order-status-codes) | string | Order status reason. sandbox | boolean | The order was placed in the test environment. ### Status codes diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api/8-checkout-confirmation/8-checkout-confirmation.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api/8-checkout-confirmation/8-checkout-confirmation.mdx index 1f9efda..cbbecfb 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/api/8-checkout-confirmation/8-checkout-confirmation.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/api/8-checkout-confirmation/8-checkout-confirmation.mdx @@ -16,7 +16,7 @@ Specifically, when the buyer completes the payment process and the status of the The confirmation notification is the last step that occurs once Aplazame has accepted the buyer's financing request, and determines whether the order will finally be processed. Once the order has been confirmed by the store, the application process will be completed and the payment will be made to the store. ## Order confirmation -Once the financing request is completed, Aplazame will send a notification to the address [notification_url](../checkout-creation/#merchant). Aplazame expects the business to respond to all notifications sent in the appropriate [response format](#formato-de-respuesta). +Once the financing request is completed, Aplazame will send a notification to the address [notification_url](../checkout-creation/#merchant). Aplazame expects the business to respond to all notifications sent in the appropriate [response format](#response-format). There are three possible scenarios as a result of the buyer's financing request: @@ -93,12 +93,11 @@ Content-Type: application/json } ``` -|Parámetro | Tipo | Requerido | Descripción| -|---------|---------|---------|---------| +|Parámetro | Tipo | Descripción| +|---------|---------|---------| id | string | Aplazame’s order identifier (immutable). -[status](#codigos-de-estado-del-pedido) | string | Order status (`ok`, `pending` o `ko`). -Order status reason. -[status_reason](#codigos-de-estado-del-pedido) | string | Order status reason. +[status](#order-status-codes) | string | Order status (`ok`, `pending` o `ko`). +[status_reason](#order-status-codes) | string | Order status reason. sandbox | boolean | The order was placed in the test environment. mid | string | Order identifier generated by the store or generated automatically by Aplazame. total_amount | [decimal](../api-reference#decimals) | Quantity to be financed. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/api/9-checkout-capture/9-checkout-capture.mdx b/i18n/en/docusaurus-plugin-content-docs/current/api/9-checkout-capture/9-checkout-capture.mdx index 862e3b0..1b99992 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/api/9-checkout-capture/9-checkout-capture.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/api/9-checkout-capture/9-checkout-capture.mdx @@ -31,7 +31,7 @@ A capture must be made when the product or products are sent with the import of amount | [decimal](../api-reference#decimals) | Sí | Capture amount. id | string | Sí | Your capture `id`. created | string | Sí | Date of the capture. -[refunds](./#pago-en-15-dias) | object | No | Refunds on capture done. +refunds | object | No | Refunds on capture done. refunded_amount | [decimal](../api-reference#decimals) | Sí | Refunded capture amount. remaining_amount | [decimal](../api-reference#decimals) | Sí | Remaining capture amount (It will always be 0). @@ -122,7 +122,7 @@ X-Aplazame-Media-Type: aplazame.v1 |Parámetro | Tipo | Requerido | Descripción| |---------|---------|---------|---------| remaining_capture_amount | [decimal](../api-reference#decimals) | Remaining order amount without capture (It will always be 0). -[results](./#captura) | object | Captures of order. +results | object | Captures of order. ## 02 - Request capture @@ -216,6 +216,6 @@ remaining_capture_amount | [decimal](../api-reference#decimals) | Remaining ord amount | [decimal](../api-reference#decimals) | Capture amount. id | string | Your capture `id`. created | string | Date of the capture. -[refunds](./#pago-en-15-dias) | object | Refunds on capture done. +refunds | object | Refunds on capture done. refunded_amount | [decimal](../api-reference#decimals) | Refunded capture amount. remaining_amount | [decimal](../api-reference#decimals) | Remaining capture amount (It will always be 0). diff --git a/i18n/en/docusaurus-plugin-content-docs/current/plugins/2-woocommerce/config-woocommerce.mdx b/i18n/en/docusaurus-plugin-content-docs/current/plugins/2-woocommerce/config-woocommerce.mdx index 28fe21c..f7b5ae4 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/plugins/2-woocommerce/config-woocommerce.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/plugins/2-woocommerce/config-woocommerce.mdx @@ -24,16 +24,16 @@ Field | Description ----- | ----------- Default instalments | Allows you to configure the number of instalments that the widget will display by default. Place to show | Allows you to select with different options where the widget is displayed. -Pay in 4 | This field causes a complete change in the rendering of the wdiget in case the merchant supports the product **Pay in 4**. In case it does not support it or the total of the checkout does not meet the requirements for the product, it will behave exactly the same as the chosen widget version. +Pay in 4 | This field causes a complete change in the rendering of the widget in case the merchant supports the product **Pay in 4**. In case it does not support it or the total of the checkout does not meet the requirements for the product, it will behave exactly the same as the chosen widget version. Downpayment info | Indicates whether or not the down payment should be shown at the top of the widget. Product quantity CSS selector | CSS selector that indicates the element that contains the number of articles. It is updated live if there are changes in the number of articles. Product price CSS selector | CSS selector that indicates the element that contains the final price. It is updated live if there are changes in the price. Variable product price CSS selector | Same as `Product price CSS selector` but applied to variable products. Legal notice | Indicates whether you should displaying the legal text after the widget. -Widget version | Allows to choose between [widget v3](../../../api/widget/installment-payment#simulación), [widget v4](../../../api/widget/widget-v4) or [widget v5](../../../api/widget/widget-v5). +Widget version | Allows to choose between [widget v3](../../../api/widget/installment-payment#simulation), [widget v4](../../../api/widget/widget-v4) or [widget v5](../../../api/widget/widget-v5). Widget if Aplazame is not available | Allows you to show an alternative widget if the product/cart total does not meet the requirements to display the widget. :::tip - You can edit the style of the [**widget v3**](../../../api/widget/installment-payment#simulación) from the [control panel](https://vendors.aplazame.com/) in the section **Preferencias > Ajustes del widget** but keep in mind that, in the common settings with those of the plugin, those of the latter take priority. + You can edit the style of the [**widget v3**](../../../api/widget/installment-payment#simulation) from the [control panel](https://vendors.aplazame.com/) in the section **Preferencias > Ajustes del widget** but keep in mind that, in the common settings with those of the plugin, those of the latter take priority. ::: ### Widget v4 & v5 settings @@ -48,5 +48,5 @@ Layout | v4 | You can choose `Horizontal` (which will change automatically if yo Enter maximum instalment | v4 | Change the widget to allow the user to manually enter the maximum instalment they want to pay, or the closest. Border | v4 | **Only product widget.** Indicates whether you should displaying the color border. :::tip - The style of the [**widget v4**](../../../api/widget/widget-v4) and the [**widget v5**](../../../api/widget/widget-v5) is only editable from the plugin settings, the style of the [**widget v3**](../../../api/widget/installment-payment#simulación) configurable from the [control panel](https://vendors.aplazame.com/) does not apply. + The style of the [**widget v4**](../../../api/widget/widget-v4) and the [**widget v5**](../../../api/widget/widget-v5) is only editable from the plugin settings, the style of the [**widget v3**](../../../api/widget/installment-payment#simulation) configurable from the [control panel](https://vendors.aplazame.com/) does not apply. ::: diff --git a/i18n/en/docusaurus-plugin-content-docs/current/plugins/3-prestashop/config-prestashop.mdx b/i18n/en/docusaurus-plugin-content-docs/current/plugins/3-prestashop/config-prestashop.mdx index be2da6e..f9cb76d 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/plugins/3-prestashop/config-prestashop.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/plugins/3-prestashop/config-prestashop.mdx @@ -25,13 +25,13 @@ Field | Description Variable price CSS | CSS selector that indicates the element that contains the final price. It is updated live if there are changes in the price. Default instalments | Allows you to configure the number of instalments that the widget will display by default. Hook Product Widget | Allows you to select between different hooks where the widget will be displayed in the product template. -Pay in 4 | This field causes a complete change in the rendering of the wdiget in case the merchant supports the product **Pay in 4**. In case it does not support it or the total of the checkout does not meet the requirements for the product, it will behave exactly the same as the chosen widget version. +Pay in 4 | This field causes a complete change in the rendering of the widget in case the merchant supports the product **Pay in 4**. In case it does not support it or the total of the checkout does not meet the requirements for the product, it will behave exactly the same as the chosen widget version. Downpayment info | Indicates whether or not the down payment should be shown at the top of the widget. Legal notice | Indicates whether you should displaying the legal text after the widget. -Widget version | Allows to choose between [widget v3](../../../api/widget/installment-payment#simulación), [widget v4](../../../api/widget/widget-v4) or [widget v5](../../../api/widget/widget-v5). +Widget version | Allows to choose between [widget v3](../../../api/widget/installment-payment#simulation), [widget v4](../../../api/widget/widget-v4) or [widget v5](../../../api/widget/widget-v5). Widget if Aplazame is not available | Allows you to show an alternative widget if the product/cart total does not meet the requirements to display the widget. :::tip - You can edit the style of the [**widget v3**](../../../api/widget/installment-payment#simulación) from the [control panel](https://vendors.aplazame.com/) in the section **Preferencias > Ajustes del widget** but keep in mind that, in the common settings with those of the plugin, those of the latter take priority. + You can edit the style of the [**widget v3**](../../../api/widget/installment-payment#simulation) from the [control panel](https://vendors.aplazame.com/) in the section **Preferencias > Ajustes del widget** but keep in mind that, in the common settings with those of the plugin, those of the latter take priority. ::: ### Widget v4 & v5 settings @@ -46,5 +46,5 @@ Layout | v4 | You can choose `Horizontal` (which will change automatically if yo Enter maximum instalment | v4 | Change the widget to allow the user to manually enter the maximum instalment they want to pay, or the closest. Border | v4 | **Only product widget.** Indicates whether you should displaying the color border. :::tip - The style of the [**widget v4**](../../../api/widget/widget-v4) and the [**widget v5**](../../../api/widget/widget-v5) is only editable from the plugin settings, the style of the [**widget v3**](../../../api/widget/installment-payment#simulación) configurable from the [control panel](https://vendors.aplazame.com/) does not apply. + The style of the [**widget v4**](../../../api/widget/widget-v4) and the [**widget v5**](../../../api/widget/widget-v5) is only editable from the plugin settings, the style of the [**widget v3**](../../../api/widget/installment-payment#simulation) configurable from the [control panel](https://vendors.aplazame.com/) does not apply. ::: diff --git a/i18n/en/docusaurus-plugin-content-docs/current/plugins/4-magento/config-magento.mdx b/i18n/en/docusaurus-plugin-content-docs/current/plugins/4-magento/config-magento.mdx index c3e0f3d..84ab991 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/plugins/4-magento/config-magento.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/plugins/4-magento/config-magento.mdx @@ -22,14 +22,14 @@ Global settings for the widget. Field | Description ----- | ----------- Default instalments | Allows you to configure the number of instalments that the widget will display by default. -Force pay in 4 widget | This field causes a complete change in the rendering of the wdiget in case the merchant supports the product **Pay in 4**. In case it does not support it or the total of the checkout does not meet the requirements for the product, it will behave exactly the same as the chosen widget version. +Force pay in 4 widget | This field causes a complete change in the rendering of the widget in case the merchant supports the product **Pay in 4**. In case it does not support it or the total of the checkout does not meet the requirements for the product, it will behave exactly the same as the chosen widget version. Show downpayment info | Indicates whether or not the down payment should be shown at the top of the widget. Show legal notice | Indicates whether you should displaying the legal text after the widget. CSS price selector | CSS selector that indicates the element that contains the final price. It is updated live if there are changes in the price. -Widget version | Allows to choose between [widget v3](../../../api/widget/installment-payment#simulación), [widget v4](../../../api/widget/widget-v4) or [widget v5](../../../api/widget/widget-v5). +Widget version | Allows to choose between [widget v3](../../../api/widget/installment-payment#simulation), [widget v4](../../../api/widget/widget-v4) or [widget v5](../../../api/widget/widget-v5). Widget if Aplazame is not available | Allows you to show an alternative widget if the product/cart total does not meet the requirements to display the widget. :::tip - You can edit the style of the [**widget v3**](../../../api/widget/installment-payment#simulación) from the [control panel](https://vendors.aplazame.com/) in the section **Preferencias > Ajustes del widget** but keep in mind that, in the common settings with those of the plugin, those of the latter take priority. + You can edit the style of the [**widget v3**](../../../api/widget/installment-payment#simulation) from the [control panel](https://vendors.aplazame.com/) in the section **Preferencias > Ajustes del widget** but keep in mind that, in the common settings with those of the plugin, those of the latter take priority. ::: ### Widget v4 & v5 settings @@ -44,5 +44,5 @@ Enter maximum instalment | v4 | Change the widget to allow the user to manually Show slider | v5 | Shows of hides the slider that lets the customer select the amount of instalments. Show border | v4 | **Only product widget.** Indicates whether you should displaying the color border. :::tip - The style of the [**widget v4**](../../../api/widget/widget-v4) and the [**widget v5**](../../../api/widget/widget-v5) is only editable from the plugin settings, the style of the [**widget v3**](../../../api/widget/installment-payment#simulación) configurable from the [control panel](https://vendors.aplazame.com/) does not apply. + The style of the [**widget v4**](../../../api/widget/widget-v4) and the [**widget v5**](../../../api/widget/widget-v5) is only editable from the plugin settings, the style of the [**widget v3**](../../../api/widget/installment-payment#simulation) configurable from the [control panel](https://vendors.aplazame.com/) does not apply. ::: diff --git a/i18n/en/docusaurus-plugin-content-docs/current/plugins/5-shopify/widget-shopify.mdx b/i18n/en/docusaurus-plugin-content-docs/current/plugins/5-shopify/widget-shopify.mdx index 30f1ea9..2673182 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/plugins/5-shopify/widget-shopify.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/plugins/5-shopify/widget-shopify.mdx @@ -30,7 +30,7 @@ First of all, log in to your Shopify shop administration panel, go to **Online S Remember to configure each widget with your **public API key** and save the changes so that they are applied to your store. ::: :::tip - The style of the [**widget v4**](../../../api/widget/widget-v4) and the [**widget v5**](../../../api/widget/widget-v5) is editable from the plugin settings, but the style of the [**widget v3**](../../../api/widget/installment-payment#simulación) is edited from the [control panel](https://vendors.aplazame.com/) in the section **Preferencias > Ajustes del widget**. + The style of the [**widget v4**](../../../api/widget/widget-v4) and the [**widget v5**](../../../api/widget/widget-v5) is editable from the plugin settings, but the style of the [**widget v3**](../../../api/widget/installment-payment#simulation) is edited from the [control panel](https://vendors.aplazame.com/) in the section **Preferencias > Ajustes del widget**. ::: ## Additional settings @@ -43,7 +43,7 @@ CSS del precio | CSS selector that indicates the element that contains the final Texto legal | Indicates whether you should displaying the legal text after the widget. Cuotas por defecto | Allows you to configure the number of instalments that the widget will display by default. Si Aplazame no está disponible | Allows you to show an alternative widget if the product/cart total does not meet the requirements to display the widget. -Forzar widget paga en 4 | This field causes a complete change in the rendering of the wdiget in case the merchant supports the product **Pay in 4**. In case it does not support it or the total of the checkout does not meet the requirements for the product, it will behave exactly the same as the chosen widget version. +Forzar widget paga en 4 | This field causes a complete change in the rendering of the widget in case the merchant supports the product **Pay in 4**. In case it does not support it or the total of the checkout does not meet the requirements for the product, it will behave exactly the same as the chosen widget version. ### Widget v4 & v5 settings Exclusive settings for the [widget v4](../../../api/widget/widget-v4) and the [widget v5](../../../api/widget/widget-v5). @@ -56,5 +56,5 @@ Disposición | v4 | You can choose `Horizontal` (which will change automatically Introducir cuota máxima | v4 | Change the widget to allow the user to manually enter the maximum instalment they want to pay, or the closest. Marco | v4 | **Only product widget.** Indicates whether you should displaying the color border. :::tip - The style of the [**widget v4**](../../../api/widget/widget-v4) and the [**widget v5**](../../../api/widget/widget-v5) is only editable from the plugin settings, the style of the [**widget v3**](../../../api/widget/installment-payment#simulación) configurable from the [control panel](https://vendors.aplazame.com/) does not apply. + The style of the [**widget v4**](../../../api/widget/widget-v4) and the [**widget v5**](../../../api/widget/widget-v5) is only editable from the plugin settings, the style of the [**widget v3**](../../../api/widget/installment-payment#simulation) configurable from the [control panel](https://vendors.aplazame.com/) does not apply. ::: diff --git a/i18n/en/docusaurus-plugin-content-docs/current/plugins/6-vtex/6-vtex.mdx b/i18n/en/docusaurus-plugin-content-docs/current/plugins/6-vtex/6-vtex.mdx index f7760bb..1deb0af 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/plugins/6-vtex/6-vtex.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/plugins/6-vtex/6-vtex.mdx @@ -32,7 +32,7 @@ Application Token: We have an [app to display our widget in VTEX store](https://github.com/aplazame/vtex-widget-app). ### Installation -- [Install](https://vtex.io/docs/recipes/development/installing-an-app/) the `aplazame.aplazame-widget` app in the VTEX account which you are working on. +- [Install](https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) the `aplazame.aplazame-widget` app in the VTEX account which you are working on. - Add it as peer dependency in the `manifest.json` of your store theme. ```diff "peerDependencies": {