From d8be9e5a9e5a18acb12de5c94bd2aa1d47aeddde Mon Sep 17 00:00:00 2001 From: hgaldino Date: Tue, 23 Jul 2024 17:38:34 -0300 Subject: [PATCH 01/20] 1 --- reference/api-json/pos.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/reference/api-json/pos.json b/reference/api-json/pos.json index 79567d26c9..226ca84660 100644 --- a/reference/api-json/pos.json +++ b/reference/api-json/pos.json @@ -31,8 +31,8 @@ "type": "boolean", "description": { "en": "Define if the customer can insert the amount to be paid.", - "pt": "Determine se o cliente pode inserir o valor a ser pago", - "es": "Determina si el cliente puede insertar el monto a pagar" + "pt": "Determine se o cliente pode inserir o valor a ser pago.", + "es": "Determina si el cliente puede insertar el monto a pagar." }, "example": false }, @@ -40,8 +40,8 @@ "type": "string", "description": { "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o caixa pertence", - "es": "Identificador de la sucursal a la que pertenece el Punto de Venta" + "pt": "Identificador da loja à qual o caixa pertence.", + "es": "Identificador de la sucursal a la que pertenece el Punto de Venta." }, "example": 1234567 }, @@ -58,8 +58,8 @@ "type": "string", "description": { "en": "Unique identifier of the pos defined by integrator system.", - "pt": "Identificador único da caixa definido pelo sistema integrador", - "es": "Identificador único de la caja definido por el integrador" + "pt": "Identificador único da caixa definido pelo sistema integrador.", + "es": "Identificador único de la caja definido por el integrado.r" }, "example": "SUC001POS001" }, From 99a9a4653640d0beef6d8ac98ae3d102cb2ace91 Mon Sep 17 00:00:00 2001 From: hgaldino Date: Thu, 25 Jul 2024 18:43:37 -0300 Subject: [PATCH 02/20] 5 --- guides/secure_payments/integration.en.md | 8 ++++---- guides/secure_payments/integration.es.md | 8 ++++---- guides/secure_payments/integration.pt.md | 9 +++++---- reference/api-json/chargebacks.json | 2 +- 4 files changed, 14 insertions(+), 13 deletions(-) diff --git a/guides/secure_payments/integration.en.md b/guides/secure_payments/integration.en.md index 334596410f..73a17cf58c 100644 --- a/guides/secure_payments/integration.en.md +++ b/guides/secure_payments/integration.en.md @@ -1,13 +1,13 @@ +# Integrate Secure Payments + +To use Secure Payments, you will need to make requests to the following APIs. Please note that you will need to include both the card data and the necessary information for the payment in the request body. + > WARNING > > Importante > > This documentation is for internal team use only, as it is an exclusive product or has been deprecated. For more details, please contact the sales or integration team. -# Integrate Secure Payments - -To use Secure Payments, you will need to make requests to the following APIs. Please note that you will need to include both the card data and the necessary information for the payment in the request body. - | Environment | URL | |---|---| | Staging (testing) | `https://api.mercadopago.com/v1/secure_payments/zeta` | diff --git a/guides/secure_payments/integration.es.md b/guides/secure_payments/integration.es.md index 8c99f11ca4..a4d85ab066 100644 --- a/guides/secure_payments/integration.es.md +++ b/guides/secure_payments/integration.es.md @@ -1,13 +1,13 @@ +# Integrar Secure Payments + +Para utilizar Secure Payments, deberás hacerlo a través de pedidos a las siguientes APIs. Ten en cuenta que deberás adicionar en el body de la petición tanto los datos de la tarjeta como la información necesaria para realizar el pago. + > WARNING > > Importante > > Esta documentación es sólo para uso por parte del equipo interno, ya que es un producto exclusivo o fue deprecado. Para más detalles, comunícate con el equipo comercial o de integraciones. -# Integrar Secure Payments - -Para utilizar Secure Payments, deberás hacerlo a través de pedidos a las siguientes APIs. Ten en cuenta que deberás adicionar en el body de la petición tanto los datos de la tarjeta como la información necesaria para realizar el pago. - | Ambiente | URL | |---|---| | Staging (pruebas) | `https://api.mercadopago.com/v1/secure_payments/zeta` | diff --git a/guides/secure_payments/integration.pt.md b/guides/secure_payments/integration.pt.md index c57c25b967..64f67bdaca 100644 --- a/guides/secure_payments/integration.pt.md +++ b/guides/secure_payments/integration.pt.md @@ -1,13 +1,14 @@ + +# Integrar Secure Payments + +Para utilizar Secure Payments, é necessário fazer chamadas para as seguintes APIs. Lembre-se de adicionar no corpo da solicitação tanto os dados do cartão quanto as informações necessárias para realizar o pagamento. + > WARNING > > Importante > > Esta documentação é apenas para uso interno da equipe porque é um produto exclusivo ou que foi desativado. Para mais detalhes, entre em contato com a equipe comercial ou de integrações. -# Integrar Secure Payments - -Para utilizar Secure Payments, é necessário fazer chamadas para as seguintes APIs. Lembre-se de adicionar no corpo da solicitação tanto os dados do cartão quanto as informações necessárias para realizar o pagamento. - | Ambiente | URL | |---|---| | Staging (testes) | `https://api.mercadopago.com/v1/secure_payments/zeta` | diff --git a/reference/api-json/chargebacks.json b/reference/api-json/chargebacks.json index 4c05d88260..e8484f9cfd 100644 --- a/reference/api-json/chargebacks.json +++ b/reference/api-json/chargebacks.json @@ -74,7 +74,7 @@ "type": "number", "example": "108.43", "description": { - "en": "Chergeback amount.", + "en": "Chargeback amount.", "pt": "Valor do estorno.", "es": "Monto de la contracargo." } From 0bc79e4cd10bbba4edf8d93340d2a649ef93877d Mon Sep 17 00:00:00 2001 From: Heitor Date: Fri, 26 Jul 2024 11:26:14 -0300 Subject: [PATCH 03/20] Update reference/api-json/pos.json Co-authored-by: Gabrielly Pereira --- reference/api-json/pos.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/api-json/pos.json b/reference/api-json/pos.json index 226ca84660..4d14a880b0 100644 --- a/reference/api-json/pos.json +++ b/reference/api-json/pos.json @@ -59,7 +59,7 @@ "description": { "en": "Unique identifier of the pos defined by integrator system.", "pt": "Identificador único da caixa definido pelo sistema integrador.", - "es": "Identificador único de la caja definido por el integrado.r" + "es": "Identificador único de la caja definido por el integrador." }, "example": "SUC001POS001" }, From c1624baf4e1bafbb498aec3fd93b6dcc3f15a82f Mon Sep 17 00:00:00 2001 From: hgaldino Date: Fri, 26 Jul 2024 19:31:06 -0300 Subject: [PATCH 04/20] final1 --- .../brand-brick/default-rendering.en.md | 2 + .../brand-brick/default-rendering.es.md | 2 + .../default-rendering.en.md | 2 + .../default-rendering.es.md | 3 +- .../payment-brick/default-rendering.en.md | 2 + .../payment-brick/default-rendering.es.md | 2 + .../default-rendering.en.md | 2 + .../default-rendering.es.md | 2 + reference/api-json/pos.json | 140 +++++++++--------- 9 files changed, 86 insertions(+), 71 deletions(-) diff --git a/guides/checkout-bricks/brand-brick/default-rendering.en.md b/guides/checkout-bricks/brand-brick/default-rendering.en.md index 0a16c47832..693ff27270 100644 --- a/guides/checkout-bricks/brand-brick/default-rendering.en.md +++ b/guides/checkout-bricks/brand-brick/default-rendering.en.md @@ -1,5 +1,7 @@ # Default rendering +See below the necessary information for you to configure and render the Brand Brick. + > WARNING > > Important diff --git a/guides/checkout-bricks/brand-brick/default-rendering.es.md b/guides/checkout-bricks/brand-brick/default-rendering.es.md index caae19ce00..858449c1aa 100644 --- a/guides/checkout-bricks/brand-brick/default-rendering.es.md +++ b/guides/checkout-bricks/brand-brick/default-rendering.es.md @@ -1,5 +1,7 @@ # Renderizado por defecto +Ve a continuación la información necesaria para configurar y renderizar el Brand Brick. + > WARNING > > Importante diff --git a/guides/checkout-bricks/card-payment-brick/default-rendering.en.md b/guides/checkout-bricks/card-payment-brick/default-rendering.en.md index a5fd96d298..6c8614f255 100644 --- a/guides/checkout-bricks/card-payment-brick/default-rendering.en.md +++ b/guides/checkout-bricks/card-payment-brick/default-rendering.en.md @@ -1,5 +1,7 @@ # Default rendering +See below the necessary information for you to configure and render the Card Payment Brick. + > WARNING > > Important diff --git a/guides/checkout-bricks/card-payment-brick/default-rendering.es.md b/guides/checkout-bricks/card-payment-brick/default-rendering.es.md index b8a57a1cb3..d7f285e7e2 100644 --- a/guides/checkout-bricks/card-payment-brick/default-rendering.es.md +++ b/guides/checkout-bricks/card-payment-brick/default-rendering.es.md @@ -1,12 +1,13 @@ # Renderizado por defecto +Ve a continuación la información necesaria para configurar y renderizar el Card Payment Brick. + > NOTE > > Importante > > Para realizar el renderizado del Card Payment Brick, primero realice los [pasos de inicialización](/developers/es/docs/checkout-bricks/common-initialization) compartidos entre todos los Bricks. Una vez hecho esto, realice la configuración a continuación. - ## Configurar el Brick Crea la configuración de inicio del Brick. diff --git a/guides/checkout-bricks/payment-brick/default-rendering.en.md b/guides/checkout-bricks/payment-brick/default-rendering.en.md index d91e22d9d1..d28bd66476 100644 --- a/guides/checkout-bricks/payment-brick/default-rendering.en.md +++ b/guides/checkout-bricks/payment-brick/default-rendering.en.md @@ -1,5 +1,7 @@ # Default rendering +See below the necessary information for you to configure and render the Payment Brick. + > WARNING > > Important diff --git a/guides/checkout-bricks/payment-brick/default-rendering.es.md b/guides/checkout-bricks/payment-brick/default-rendering.es.md index ffcb531bc4..1fc1cce9b8 100644 --- a/guides/checkout-bricks/payment-brick/default-rendering.es.md +++ b/guides/checkout-bricks/payment-brick/default-rendering.es.md @@ -1,5 +1,7 @@ # Renderizado por defecto +Ve a continuación la información necesaria para configurar y renderizar el Payment Brick. + > WARNING > > Importante diff --git a/guides/checkout-bricks/status-screen-brick/default-rendering.en.md b/guides/checkout-bricks/status-screen-brick/default-rendering.en.md index 056d2e602e..bb56b5c2b6 100644 --- a/guides/checkout-bricks/status-screen-brick/default-rendering.en.md +++ b/guides/checkout-bricks/status-screen-brick/default-rendering.en.md @@ -1,5 +1,7 @@ # Default rendering +See below the necessary information for you to configure and render the Status Screen Brick. + > WARNING > > Important diff --git a/guides/checkout-bricks/status-screen-brick/default-rendering.es.md b/guides/checkout-bricks/status-screen-brick/default-rendering.es.md index a32d3aa94f..595ac5a0c5 100644 --- a/guides/checkout-bricks/status-screen-brick/default-rendering.es.md +++ b/guides/checkout-bricks/status-screen-brick/default-rendering.es.md @@ -1,5 +1,7 @@ # Renderizado por defecto +Ve a continuación la información necesaria para configurar y renderizar el Status Screen Brick. + > WARNING > > Importante diff --git a/reference/api-json/pos.json b/reference/api-json/pos.json index 226ca84660..6c9b5959e9 100644 --- a/reference/api-json/pos.json +++ b/reference/api-json/pos.json @@ -22,8 +22,8 @@ "type": "string", "description": { "en": "Name of the POS.", - "pt": "Nome da caixa", - "es": "Nombre de la caja" + "pt": "Nome do ponto de venda.", + "es": "Nombre del punto de venta." }, "example": "First POS" }, @@ -40,8 +40,8 @@ "type": "string", "description": { "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o caixa pertence.", - "es": "Identificador de la sucursal a la que pertenece el Punto de Venta." + "pt": "Identificador da loja à qual o ponto de venda pertence.", + "es": "Identificador de la sucursal a la que pertenece el punto de venta." }, "example": 1234567 }, @@ -1079,8 +1079,8 @@ "type": "boolean", "description": { "en": "Define if the customer can insert the amount to be paid.", - "pt": "Determine se o cliente pode inserir o valor a ser pago", - "es": "Determina si el cliente puede insertar el monto a pagar" + "pt": "Determine se o cliente pode inserir o valor a ser pago.", + "es": "Determina si el cliente puede insertar el monto a pagar." }, "example": false }, @@ -1307,136 +1307,136 @@ "title": "MISSING_BODY", "description": { "en": "HTTP body is required to modify pos.", - "es": "HTTP body is required to modify pos.", - "pt": "HTTP body is required to modify pos." + "es": "El cuerpo del HTTP es requerido para modificar el punto de venta.", + "pt": "O corpo do HTTP é necessário para modificar o ponto de venda." } }, { "title": "UNKNOWN_FIELD_EXCEPTION", "description": { "en": "The indicated field is not allowed for this operation or is unknown.", - "es": "The indicated field is not allowed for this operation or is unknown.", - "pt": "The indicated field is not allowed for this operation or is unknown." + "es": "El campo indicado no está permitido para esta operación o es desconocido.", + "pt": "O campo indicado não é permitido para esta operação ou é desconhecido." } }, { "title": "INVALID_POS_ID", "description": { "en": "The ID of the pos is invalid, it must be numeric.", - "es": "The ID of the pos is invalid, it must be numeric.", - "pt": "The ID of the pos is invalid, it must be numeric." + "es": "El ID del punto de venta es inválida, debe ser numérica.", + "pt": "O ID do ponto de venda é inválida, deve ser numérica." } }, { "title": "INVALID_NAME", "description": { "en": "NAME must be string.", - "es": "NAME must be string.", - "pt": "NAME must be string." + "es": "NOMBRE debe ser string.", + "pt": "NAME deve ser string." } }, { "title": "NAME_TOO_LONG", "description": { "en": "The NAME must be less than 45 characters.", - "es": "The NAME must be less than 45 characters.", - "pt": "The NAME must be less than 45 characters." + "es": "NAME debe ser menor de 45 caracteres.", + "pt": "NAME deve ter menos de 45 caracteres." } }, { "title": "INVALID_FIXED_AMOUNT", "description": { "en": "FIXED_AMOUNT must be boolean.", - "es": "FIXED_AMOUNT must be boolean.", - "pt": "FIXED_AMOUNT must be boolean." + "es": "FIXED_AMOUNT debe ser boolean.", + "pt": "FIXED_AMOUNT deve ser boolean." } }, { "title": "INVALID_CATEGORY", "description": { "en": "CATEGORY must be numeric.", - "es": "CATEGORY must be numeric.", - "pt": "CATEGORY must be numeric." + "es": "CATEGORY debe ser numérico.", + "pt": "CATEGORY deve ser numérico." } }, { "title": "POS_UNKNOWN_MCC", "description": { - "en": "The CATEGORY must be valid for the user's site.", - "es": "The CATEGORY must be valid for the user's site.", - "pt": "The CATEGORY must be valid for the user's site." + "en": "CATEGORY must be valid for the user's site.", + "es": "CATEGORY debe ser válida para el sitio del usuario.", + "pt": "CATEGORY deve ser válida para o site do usuário." } }, { "title": "POS_INVALID_STORE_ID", "description": { "en": "STORE_ID must be numeric.", - "es": "STORE_ID must be numeric.", - "pt": "STORE_ID must be numeric." + "es": "STORE_ID debe ser numérico.", + "pt": "STORE_ID deve ser numérico." } }, { "title": "INVALID_EXTERNAL_STORE_ID", "description": { - "en": "EXTERNAL_STORE_ID muste be string.", - "es": "EXTERNAL_STORE_ID muste be string.", - "pt": "EXTERNAL_STORE_ID muste be string." + "en": "EXTERNAL_STORE_ID must be string.", + "es": "EXTERNAL_STORE_ID debe ser string.", + "pt": "EXTERNAL_STORE_ID deve ser string." } }, { "title": "EXTERNAL_STORE_ID_NOT_MATCH", "description": { "en": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID.", - "es": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID.", - "pt": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID." + "es": "El EXTERNAL_STORE_ID no hace referencia al STORE_ID indicado.", + "pt": "O EXTERNAL_STORE_ID não se refere ao STORE_ID indicado." } }, { "title": "INEXISTENT_EXTERNAL_STORE_ID", "description": { "en": "The EXTERNAL STORE_ID does not refer to an existing Store.", - "es": "The EXTERNAL STORE_ID does not refer to an existing Store.", - "pt": "The EXTERNAL STORE_ID does not refer to an existing Store." + "es": "El EXTERNAL_STORE_ID no hace referencia a una tienda existente.", + "pt": "O EXTERNAL_STORE_ID não se refere a uma loja existente." } }, { "title": "INVALID_EXTERNAL_ID", "description": { - "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "es": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "pt": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters." + "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces, hyphens or special characters.", + "es": "El campo EXTERNAL_ID debe ser alfanumérico, solo letras y números. Sin espacios, guiones o caracteres especiales.", + "pt": "O campo EXTERNAL_ID deve ser alfanumérico, apenas letras e números. Sem espaços, hífens ou caracteres especiais." } }, { "title": "EXTERNAL_ID_TOO_LONG", "description": { "en": "The EXTERNAL_ID must be less than 40 characters.", - "es": "The EXTERNAL_ID must be less than 40 characters.", - "pt": "The EXTERNAL_ID must be less than 40 characters." + "es": "El EXTERNAL_ID debe ser menor de 40 caracteres.", + "pt": "O EXTERNAL_ID deve ter menos de 40 caracteres." } }, { "title": "INVALID_URL", "description": { "en": "The URL must be string and muste have the format of a valid url", - "es": "The URL must be string and muste have the format of a valid url", - "pt": "The URL must be string and muste have the format of a valid url" + "es": "La URL debe ser una cadena y debe tener el formato de una URL válida.", + "pt": "A URL deve ser uma string e deve ter o formato de uma URL válida." } }, { "title": "URL_TOO_LONG", "description": { "en": "The URL must be less than 300 characters.", - "es": "The URL must be less than 300 characters.", - "pt": "The URL must be less than 300 characters." + "es": "La URL debe ser menor de 300 caracteres.", + "pt": "A URL deve ter menos de 300 caracteres." } }, { "title": "FIXED_AMOUNT_FALSE", "description": { "en": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case.", - "es": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case.", - "pt": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case." + "es": "Si se indica el campo URL, el campo FIXED_AMOUNT debe ser verdadero. No soportamos la modalidad de monto abierto en este caso.", + "pt": "Se o campo URL estiver indicado, o campo FIXED_AMOUNT deve ser verdadeiro. Não suportamos a modalidade de valor aberto nesse caso." } } ] @@ -1464,8 +1464,8 @@ "title": "1", "description": { "en": "If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor.", - "es": "If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor.", - "pt": "If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor." + "es": "Si está utilizando el campo URL, el host debe estar habilitado por Mercado Pago. Si no lo está, recibirá este error. Por favor, comuníquese con su asesor técnico asignado.", + "pt": "Se você estiver usando o campo URL, o host deve ser habilitado pelo Mercado Pago. Se não for, você receberá este erro. Por favor, entre em contato com seu assessor técnico designado." } } ] @@ -1492,9 +1492,9 @@ { "title": "1", "description": { - "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", - "es": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", - "pt": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user." + "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and to the user.", + "es": "Si el punto de venta no existe para un ID o EXTERNAL_ID indicado y para el usuario.", + "pt": "Se o ponto de venda não existir para um ID ou EXTERNAL_ID indicado e para o usuário." } } ] @@ -1521,9 +1521,9 @@ { "title": "1", "description": { - "en": "A pos with the same EXTERNAL_ID already exists.", - "es": "A pos with the same EXTERNAL_ID already exists.", - "pt": "A pos with the same EXTERNAL_ID already exists." + "en": "A pont of sale with the same EXTERNAL_ID already exists.", + "es": "Ya existe un punto de venta con el mismo EXTERNAL_ID.", + "pt": "Já existe um ponto de venda com o mesmo EXTERNAL_ID." } } ] @@ -1546,7 +1546,7 @@ "mp-point" ], "description": { - "en": "Delete a Point of Sale whenever you need it with the ID of the POS", + "en": "Delete a point of sale whenever you need it with the ID of the POS", "pt": "Exclua um ponto de venda sempre que for necessário com o ID da caixa", "es": "Elimina un punto de venta siempre que lo necesites con el ID de la caja" }, @@ -1585,8 +1585,8 @@ "title": "INVALID_POS_ID", "description": { "en": "The ID of the pos is invalid, it must be numeric.", - "es": "The ID of the pos is invalid, it must be numeric.", - "pt": "The ID of the pos is invalid, it must be numeric." + "es": "El ID del punto de venta es inválida, debe ser numérica.", + "pt": "O ID do ponto de venda é inválida, deve ser numérica." } } ] @@ -1640,17 +1640,17 @@ "type": "number", "example": 621102, "description": { - "en": "MCC code that indicates the category of the Point of Sale. If not specified, it remains as a generic category.", - "pt": "Código MCC que indica a categoria do ponto de venda. Se não especificado, ele permanece como uma categoria genérica", - "es": "Código MCC que indica el rubro del Punto de Venta. Si no se especifica, queda como categoría genérica" + "en": "MCC code that indicates the category of the point of sale. If not specified, it remains as a generic category.", + "pt": "Código MCC que indica a categoria do ponto de venda. Se não especificado, ele permanece como uma categoria genérica.", + "es": "Código MCC que indica el rubro del punto de venta. Si no se especifica, queda como categoría genérica." }, "enum": [ { "title": "Gastronomy", "description": { - "en": "", - "es": "", - "pt": "" + "en": "Gastronomy", + "es": "Gastronomía", + "pt": "Gastronomia" } }, { @@ -1665,16 +1665,16 @@ "title": "5611203", "description": { "en": "Brazil", - "es": "Brazil", - "pt": "Brazil" + "es": "Brasil", + "pt": "Brasil" } }, { "title": "5812", "description": { "en": "Mexico", - "es": "Mexico", - "pt": "Mexico" + "es": "México", + "pt": "México" } }, { @@ -1682,14 +1682,14 @@ "description": { "en": "Colombia", "es": "Colombia", - "pt": "Colombia" + "pt": "Colômbia" } }, { "title": "5520", "description": { "en": "Peru", - "es": "Peru", + "es": "Perú", "pt": "Peru" } }, @@ -1698,7 +1698,7 @@ "description": { "en": "Uruguay", "es": "Uruguay", - "pt": "Uruguay" + "pt": "Uruguai" } }, { @@ -1712,9 +1712,9 @@ { "title": "Gas station", "description": { - "en": "", - "es": "", - "pt": "" + "en": "Gas station", + "es": "Estación de servicio", + "pt": "posto de gasolina" } }, { From dc5acc2bc1e02fd38f5b0d08887267304091cb7a Mon Sep 17 00:00:00 2001 From: hgaldino Date: Mon, 29 Jul 2024 15:05:35 -0300 Subject: [PATCH 05/20] final1 --- guides/zero-dollar-auth/prerequisites.en.md | 2 +- guides/zero-dollar-auth/prerequisites.es.md | 2 +- guides/zero-dollar-auth/prerequisites.pt.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/guides/zero-dollar-auth/prerequisites.en.md b/guides/zero-dollar-auth/prerequisites.en.md index 595a537a31..704f04d2a1 100644 --- a/guides/zero-dollar-auth/prerequisites.en.md +++ b/guides/zero-dollar-auth/prerequisites.en.md @@ -6,7 +6,7 @@ To use the Zero Dollar Auth validation, you must meet the following requirements > > Important > -> The Zero Dollar Auth validation is only available for **Mastercard** and **Visa** credit card brands. +> The Zero Dollar Auth validation is only available for credit and debit cards from the **Visa** and **Mastercard** brands. | Requirement | Description | |---|---| diff --git a/guides/zero-dollar-auth/prerequisites.es.md b/guides/zero-dollar-auth/prerequisites.es.md index 308e94f581..72931869a0 100644 --- a/guides/zero-dollar-auth/prerequisites.es.md +++ b/guides/zero-dollar-auth/prerequisites.es.md @@ -6,7 +6,7 @@ Para utilizar la validación Zero Dollar Auth, debes cumplir con los siguientes > > Importante > -> La validación Zero Dollar Auth solo está disponible para las banderas de tarjetas de crédito **Mastercard** y **Visa**. +> La validación Zero Dollar Auth solo está disponible para tarjetas de crédito y débito de las banderas **Visa** y **Mastercard**. | Requisito | Descripción | |---|---| diff --git a/guides/zero-dollar-auth/prerequisites.pt.md b/guides/zero-dollar-auth/prerequisites.pt.md index 35f8bb870f..6312932857 100644 --- a/guides/zero-dollar-auth/prerequisites.pt.md +++ b/guides/zero-dollar-auth/prerequisites.pt.md @@ -6,7 +6,7 @@ Para utilizar a validação Zero Dollar Auth é preciso atender aos requisitos l > > Importante > -> A validação Zero Dollar Auth está disponível somente para as bandeiras de cartão de crédito **Mastercard** e **Visa**. +> A validação Zero Dollar Auth está disponível somente para cartões de crédito e débito das bandeiras **Visa** e **Mastercard**. | Requisito | Descrição | |---|---| From 19252e6e00f89f005677e4652218175313e9a3b9 Mon Sep 17 00:00:00 2001 From: hgaldino Date: Mon, 29 Jul 2024 15:39:26 -0300 Subject: [PATCH 06/20] bricks1 --- guides/checkout-bricks/brand-brick/default-rendering.en.md | 4 ++-- guides/checkout-bricks/brand-brick/default-rendering.es.md | 4 ++-- guides/checkout-bricks/brand-brick/default-rendering.pt.md | 4 ++-- .../card-payment-brick/default-rendering.en.md | 4 ++-- .../card-payment-brick/default-rendering.es.md | 6 +++--- .../card-payment-brick/default-rendering.pt.md | 4 ++-- .../checkout-bricks/payment-brick/default-rendering.en.md | 4 ++-- .../checkout-bricks/payment-brick/default-rendering.es.md | 4 ++-- .../checkout-bricks/payment-brick/default-rendering.pt.md | 4 ++-- .../status-screen-brick/default-rendering.en.md | 4 ++-- .../status-screen-brick/default-rendering.es.md | 4 ++-- .../status-screen-brick/default-rendering.pt.md | 5 +++-- guides/checkout-bricks/wallet-brick/default-rendering.en.md | 4 +++- guides/checkout-bricks/wallet-brick/default-rendering.es.md | 4 +++- guides/checkout-bricks/wallet-brick/default-rendering.pt.md | 5 +++-- 15 files changed, 35 insertions(+), 29 deletions(-) diff --git a/guides/checkout-bricks/brand-brick/default-rendering.en.md b/guides/checkout-bricks/brand-brick/default-rendering.en.md index 693ff27270..e996061c62 100644 --- a/guides/checkout-bricks/brand-brick/default-rendering.en.md +++ b/guides/checkout-bricks/brand-brick/default-rendering.en.md @@ -1,12 +1,12 @@ # Default rendering -See below the necessary information for you to configure and render the Brand Brick. +Before rendering the Brand Brick, first execute the [initialization steps](/developers/en/docs/checkout-bricks/common-initialization) shared among all Bricks. From there, see below the necessary information to configure and render the Brand Brick. > WARNING > > Important > -> To perform Brand Brick rendering, first perform the [initialization steps](/developers/en/docs/checkout-bricks/common-initialization) shared among all Bricks. +> To consult the types and specifications of the parameters and responses of the Brick functions, refer to the [technical documentation](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/brand.md). ## Configure the Brick diff --git a/guides/checkout-bricks/brand-brick/default-rendering.es.md b/guides/checkout-bricks/brand-brick/default-rendering.es.md index 858449c1aa..ceeb48e93c 100644 --- a/guides/checkout-bricks/brand-brick/default-rendering.es.md +++ b/guides/checkout-bricks/brand-brick/default-rendering.es.md @@ -1,12 +1,12 @@ # Renderizado por defecto -Ve a continuación la información necesaria para configurar y renderizar el Brand Brick. +Antes de realizar la renderización del Brand Brick, primero ejecute los [pasos de inicialización](/developers/es/docs/checkout-bricks/common-initialization) compartidos entre todos los Bricks. A partir de esto, a continuación se presentan las informaciones necesarias para que configures y renderices el Brand Brick. > WARNING > > Importante > -> Para realizar el renderizado de Brand Brick, primero realice los [pasos de inicialización](/developers/es/docs/checkout-bricks/common-initialization) compartidos entre todos los Bricks. +> Para consultar los tipos y especificaciones de los parámetros y respuestas de las funciones del Brick, consulte la [documentación técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/brand.md). ## Configurar el Brick diff --git a/guides/checkout-bricks/brand-brick/default-rendering.pt.md b/guides/checkout-bricks/brand-brick/default-rendering.pt.md index 16dadbc7ff..2707b0f25d 100644 --- a/guides/checkout-bricks/brand-brick/default-rendering.pt.md +++ b/guides/checkout-bricks/brand-brick/default-rendering.pt.md @@ -1,12 +1,12 @@ # Renderização padrão -Veja abaixo as informações necessárias para você configurar e renderizar o Brand Brick. +Antes de realizar a renderização do Brand Brick, primeiro execute os [passos de inicialização](/developers/pt/docs/checkout-bricks/common-initialization) compartilhados entre todos os Bricks. A partir disso, veja abaixo as informações necessárias para você configurar e renderizar o Brand Brick. > WARNING > > Importante > -> Para realizar a renderização do Brand Brick, primeiro execute os [passos de inicialização](/developers/pt/docs/checkout-bricks/common-initialization) compartilhados entre todos os Brick. +> Para consultar tipagens e especificações dos parâmetros e respostas de funções do Brick, consulte a [documentação técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/brand.md). ## Configurar o Brick diff --git a/guides/checkout-bricks/card-payment-brick/default-rendering.en.md b/guides/checkout-bricks/card-payment-brick/default-rendering.en.md index 6c8614f255..b0bbcf6814 100644 --- a/guides/checkout-bricks/card-payment-brick/default-rendering.en.md +++ b/guides/checkout-bricks/card-payment-brick/default-rendering.en.md @@ -1,12 +1,12 @@ # Default rendering -See below the necessary information for you to configure and render the Card Payment Brick. +Before rendering the Card Payment Brick, first execute the [initialization steps](/developers/en/docs/checkout-bricks/common-initialization) shared among all Bricks. From there, see below the necessary information to configure and render the Card Payment Brick. > WARNING > > Important > -> To perform the Card Payment Brick rendering, first perform the [initialization steps](/developers/en/docs/checkout-bricks/common-initialization) shared among all Bricks. Once this is done, perform the settings below. +> To consult the types and specifications of the parameters and responses of the Brick functions, refer to the [technical documentation](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/card-payment.md). ## Configure the Brick diff --git a/guides/checkout-bricks/card-payment-brick/default-rendering.es.md b/guides/checkout-bricks/card-payment-brick/default-rendering.es.md index d7f285e7e2..e48d409132 100644 --- a/guides/checkout-bricks/card-payment-brick/default-rendering.es.md +++ b/guides/checkout-bricks/card-payment-brick/default-rendering.es.md @@ -1,12 +1,12 @@ # Renderizado por defecto -Ve a continuación la información necesaria para configurar y renderizar el Card Payment Brick. +Antes de realizar la renderización del Card Payment Brick, primero ejecute los [pasos de inicialización](/developers/es/docs/checkout-bricks/common-initialization) compartidos entre todos los Bricks. A partir de esto, a continuación se presentan las informaciones necesarias para que configures y renderices el Card Payment Brick. -> NOTE +> WARNING > > Importante > -> Para realizar el renderizado del Card Payment Brick, primero realice los [pasos de inicialización](/developers/es/docs/checkout-bricks/common-initialization) compartidos entre todos los Bricks. Una vez hecho esto, realice la configuración a continuación. +> Para consultar los tipos y especificaciones de los parámetros y respuestas de las funciones del Brick, consulte la [documentación técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/card-payment.md). ## Configurar el Brick diff --git a/guides/checkout-bricks/card-payment-brick/default-rendering.pt.md b/guides/checkout-bricks/card-payment-brick/default-rendering.pt.md index e08a69d462..ddad72944a 100644 --- a/guides/checkout-bricks/card-payment-brick/default-rendering.pt.md +++ b/guides/checkout-bricks/card-payment-brick/default-rendering.pt.md @@ -1,12 +1,12 @@ # Renderização padrão -Veja abaixo as informações necessárias para você configurar e renderizar o Card Payment Brick. +Antes de realizar a renderização do Card Payment Brick, primeiro execute os [passos de inicialização](/developers/pt/docs/checkout-bricks/common-initialization) compartilhados entre todos os Bricks. A partir disso, veja abaixo as informações necessárias para você configurar e renderizar o Card Payment Brick. > WARNING > > Importante > -> Para realizar a renderização do Card Payment Brick, primeiro execute os [passos de inicialização](/developers/pt/docs/checkout-bricks/common-initialization) compartilhados entre todos os Brick. +> Para consultar tipagens e especificações dos parâmetros e respostas de funções do Brick, consulte a [documentação técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/card-payment.md). ## Configurar o Brick diff --git a/guides/checkout-bricks/payment-brick/default-rendering.en.md b/guides/checkout-bricks/payment-brick/default-rendering.en.md index d28bd66476..a230aa5dff 100644 --- a/guides/checkout-bricks/payment-brick/default-rendering.en.md +++ b/guides/checkout-bricks/payment-brick/default-rendering.en.md @@ -1,12 +1,12 @@ # Default rendering -See below the necessary information for you to configure and render the Payment Brick. +Before rendering the Payment Brick, first execute the [initialization steps](/developers/en/docs/checkout-bricks/common-initialization) shared among all Bricks. From there, see below the necessary information to configure and render the Payment Brick. > WARNING > > Important > -> To perform Payment Brick rendering, first perform the [initialization steps](/developers/en/docs/checkout-bricks/common-initialization) shared among all Bricks. +> To consult the types and specifications of the parameters and responses of the Brick functions, refer to the [technical documentation](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/payment.md). ## Configure the Brick diff --git a/guides/checkout-bricks/payment-brick/default-rendering.es.md b/guides/checkout-bricks/payment-brick/default-rendering.es.md index 1fc1cce9b8..d100281943 100644 --- a/guides/checkout-bricks/payment-brick/default-rendering.es.md +++ b/guides/checkout-bricks/payment-brick/default-rendering.es.md @@ -1,12 +1,12 @@ # Renderizado por defecto -Ve a continuación la información necesaria para configurar y renderizar el Payment Brick. +Antes de realizar la renderización del Payment Brick, primero ejecute los [pasos de inicialización](/developers/es/docs/checkout-bricks/common-initialization) compartidos entre todos los Bricks. A partir de esto, a continuación se presentan las informaciones necesarias para que configures y renderices el Payment Brick. > WARNING > > Importante > -> Para realizar el renderizado de Payment Brick, primero realice los [pasos de inicialización](/developers/es/docs/checkout-bricks/common-initialization) compartidos entre todos los Bricks. +> Para consultar los tipos y especificaciones de los parámetros y respuestas de las funciones del Brick, consulte la [documentación técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/payment.md). ## Configurar el Brick diff --git a/guides/checkout-bricks/payment-brick/default-rendering.pt.md b/guides/checkout-bricks/payment-brick/default-rendering.pt.md index 8bfe5fe862..e1318ddc7e 100644 --- a/guides/checkout-bricks/payment-brick/default-rendering.pt.md +++ b/guides/checkout-bricks/payment-brick/default-rendering.pt.md @@ -1,12 +1,12 @@ # Renderização padrão -Veja abaixo as informações necessárias para você configurar e renderizar o Payment Brick. +Antes de realizar a renderização do Payment Brick, primeiro execute os [passos de inicialização](/developers/pt/docs/checkout-bricks/common-initialization) compartilhados entre todos os Bricks. A partir disso, veja abaixo as informações necessárias para você configurar e renderizar o Payment Brick. > WARNING > > Importante > -> Para realizar a renderização do Payment Brick, primeiro execute os [passos de inicialização](/developers/pt/docs/checkout-bricks/common-initialization) compartilhados entre todos os Brick. +> Para consultar tipagens e especificações dos parâmetros e respostas de funções do Brick, consulte a [documentação técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/payment.md). ## Configurar o Brick diff --git a/guides/checkout-bricks/status-screen-brick/default-rendering.en.md b/guides/checkout-bricks/status-screen-brick/default-rendering.en.md index bb56b5c2b6..f33f4725a6 100644 --- a/guides/checkout-bricks/status-screen-brick/default-rendering.en.md +++ b/guides/checkout-bricks/status-screen-brick/default-rendering.en.md @@ -1,12 +1,12 @@ # Default rendering -See below the necessary information for you to configure and render the Status Screen Brick. +Before rendering the Status Screen Brick, first execute the [initialization steps](/developers/en/docs/checkout-bricks/common-initialization) shared among all Bricks. From there, see below the necessary information to configure and render the Status Screen Brick. > WARNING > > Important > -> To perform Status Screen Brick rendering, first perform the [initialization steps](/developers/en/docs/checkout-bricks/common-initialization) shared among all Bricks. +> To consult the types and specifications of the parameters and responses of the Brick functions, refer to the [technical documentation](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/status-screen.md). ## Configure the Brick diff --git a/guides/checkout-bricks/status-screen-brick/default-rendering.es.md b/guides/checkout-bricks/status-screen-brick/default-rendering.es.md index 595ac5a0c5..be646c5273 100644 --- a/guides/checkout-bricks/status-screen-brick/default-rendering.es.md +++ b/guides/checkout-bricks/status-screen-brick/default-rendering.es.md @@ -1,12 +1,12 @@ # Renderizado por defecto -Ve a continuación la información necesaria para configurar y renderizar el Status Screen Brick. +Antes de realizar la renderización del Status Screen Brick, primero ejecute los [pasos de inicialización](/developers/es/docs/checkout-bricks/common-initialization) compartidos entre todos los Bricks. A partir de esto, a continuación se presentan las informaciones necesarias para que configures y renderices el Status Screen Brick. > WARNING > > Importante > -> Para realizar el renderizado de Status Screen Brick, primero realice los [pasos de inicialización](/developers/es/docs/checkout-bricks/common-initialization) compartidos entre todos los Bricks. +> Para consultar los tipos y especificaciones de los parámetros y respuestas de las funciones del Brick, consulte la [documentación técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/status-screen.md). ## Configurar el Brick diff --git a/guides/checkout-bricks/status-screen-brick/default-rendering.pt.md b/guides/checkout-bricks/status-screen-brick/default-rendering.pt.md index 8c5db0141c..1435e76fb7 100644 --- a/guides/checkout-bricks/status-screen-brick/default-rendering.pt.md +++ b/guides/checkout-bricks/status-screen-brick/default-rendering.pt.md @@ -1,12 +1,13 @@ # Renderização padrão -Veja abaixo as informações necessárias para você configurar e renderizar o Status Screen Brick. +Antes de realizar a renderização do Status Screen Brick, primeiro execute os [passos de inicialização](/developers/pt/docs/checkout-bricks/common-initialization) compartilhados entre todos os Bricks. A partir disso, veja abaixo as informações necessárias para você configurar e renderizar o Status Screen Brick. > WARNING > > Importante > -> Para realizar a renderização do Status Screen Brick, primeiro execute os [passos de inicialização](/developers/pt/docs/checkout-bricks/common-initialization) compartilhados entre todos os Brick. +> Para consultar tipagens e especificações dos parâmetros e respostas de funções do Brick, consulte a [documentação técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/status-screen.md). + ## Configurar o Brick diff --git a/guides/checkout-bricks/wallet-brick/default-rendering.en.md b/guides/checkout-bricks/wallet-brick/default-rendering.en.md index 82c8801e9e..287823b9a0 100644 --- a/guides/checkout-bricks/wallet-brick/default-rendering.en.md +++ b/guides/checkout-bricks/wallet-brick/default-rendering.en.md @@ -1,10 +1,12 @@ # Default rendering +Before rendering the Wallet Brick, first execute the [initialization steps](/developers/en/docs/checkout-bricks/common-initialization) shared among all Bricks. From there, see below the necessary information to configure and render the Wallet Brick. + > WARNING > > Important > -> To perform Wallet Brick rendering, first perform the [initialization steps](/developers/en/docs/checkout-bricks/common-initialization) shared among all Bricks. +> To consult the types and specifications of the parameters and responses of the Brick functions, refer to the [technical documentation](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/wallet.md). ## Configure the Brick diff --git a/guides/checkout-bricks/wallet-brick/default-rendering.es.md b/guides/checkout-bricks/wallet-brick/default-rendering.es.md index 8ec6fcf84e..0b366c8fac 100644 --- a/guides/checkout-bricks/wallet-brick/default-rendering.es.md +++ b/guides/checkout-bricks/wallet-brick/default-rendering.es.md @@ -1,10 +1,12 @@ # Renderizado por defecto +Antes de realizar la renderización del Wallet Brick, primero ejecute los [pasos de inicialización](/developers/es/docs/checkout-bricks/common-initialization) compartidos entre todos los Bricks. A partir de esto, a continuación se presentan las informaciones necesarias para que configures y renderices el Wallet Brick. + > WARNING > > Importante > -> Para realizar el renderizado de Wallet Brick, primero ejecuta los [pasos de inicialización](/developers/es/docs/checkout-bricks/common-initialization) compartidos entre todos los Bricks. +> Para consultar los tipos y especificaciones de los parámetros y respuestas de las funciones del Brick, consulte la [documentación técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/wallet.md). ## Configurar el Brick diff --git a/guides/checkout-bricks/wallet-brick/default-rendering.pt.md b/guides/checkout-bricks/wallet-brick/default-rendering.pt.md index 89e9ccee80..89d565a4e0 100644 --- a/guides/checkout-bricks/wallet-brick/default-rendering.pt.md +++ b/guides/checkout-bricks/wallet-brick/default-rendering.pt.md @@ -1,12 +1,13 @@ # Renderização padrão -Veja abaixo as informações necessárias para você configurar e renderizar o Wallet Brick. +Antes de realizar a renderização do Wallet Brick, primeiro execute os [passos de inicialização](/developers/pt/docs/checkout-bricks/common-initialization) compartilhados entre todos os Bricks. A partir disso, veja abaixo as informações necessárias para você configurar e renderizar o Wallet Brick. > WARNING > > Importante > -> Para realizar a renderização do Wallet Brick, primeiro execute os [passos de inicialização](/developers/pt/docs/checkout-bricks/common-initialization) compartilhados entre todos os Brick. +> Para consultar tipagens e especificações dos parâmetros e respostas de funções do Brick, consulte a [documentação técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/wallet.md). + ## Configurar o Brick From 8bd03ef0580a37a0813efbc3c801e36d4be104fc Mon Sep 17 00:00:00 2001 From: hgaldino Date: Mon, 29 Jul 2024 16:18:50 -0300 Subject: [PATCH 07/20] bricks2 --- .../brand-brick/default-rendering.en.md | 6 +++--- .../brand-brick/default-rendering.es.md | 6 +++--- .../brand-brick/default-rendering.pt.md | 6 +++--- .../card-payment-brick/default-rendering.en.md | 6 +++--- .../card-payment-brick/default-rendering.es.md | 6 +++--- .../card-payment-brick/default-rendering.pt.md | 6 +++--- .../card-payment-brick/payment-submission.en.md | 10 ++++++++-- .../card-payment-brick/payment-submission.es.md | 10 ++++++++-- .../card-payment-brick/payment-submission.pt.md | 10 ++++++++-- .../status-screen-brick/default-rendering.en.md | 6 +++--- .../status-screen-brick/default-rendering.es.md | 6 +++--- .../status-screen-brick/default-rendering.pt.md | 7 +++---- .../wallet-brick/default-rendering.en.md | 4 ++-- .../wallet-brick/default-rendering.es.md | 8 ++++---- .../wallet-brick/default-rendering.pt.md | 9 ++++----- 15 files changed, 61 insertions(+), 45 deletions(-) diff --git a/guides/checkout-bricks/brand-brick/default-rendering.en.md b/guides/checkout-bricks/brand-brick/default-rendering.en.md index e996061c62..3dff30c6b5 100644 --- a/guides/checkout-bricks/brand-brick/default-rendering.en.md +++ b/guides/checkout-bricks/brand-brick/default-rendering.en.md @@ -2,9 +2,9 @@ Before rendering the Brand Brick, first execute the [initialization steps](/developers/en/docs/checkout-bricks/common-initialization) shared among all Bricks. From there, see below the necessary information to configure and render the Brand Brick. -> WARNING +> NOTE > -> Important +> Note > > To consult the types and specifications of the parameters and responses of the Brick functions, refer to the [technical documentation](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/brand.md). @@ -24,7 +24,7 @@ bricksBuilder.create( Once the configurations are created, enter the code below to render the Brick. -> NOTE +> WARNING > > Important > diff --git a/guides/checkout-bricks/brand-brick/default-rendering.es.md b/guides/checkout-bricks/brand-brick/default-rendering.es.md index ceeb48e93c..74b3c57fc8 100644 --- a/guides/checkout-bricks/brand-brick/default-rendering.es.md +++ b/guides/checkout-bricks/brand-brick/default-rendering.es.md @@ -2,9 +2,9 @@ Antes de realizar la renderización del Brand Brick, primero ejecute los [pasos de inicialización](/developers/es/docs/checkout-bricks/common-initialization) compartidos entre todos los Bricks. A partir de esto, a continuación se presentan las informaciones necesarias para que configures y renderices el Brand Brick. -> WARNING +> NOTE > -> Importante +> Nota > > Para consultar los tipos y especificaciones de los parámetros y respuestas de las funciones del Brick, consulte la [documentación técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/brand.md). @@ -24,7 +24,7 @@ bricksBuilder.create( Una vez creadas las configuraciones, ingrese el código a continuación para renderizar el Brick. -> NOTE +> WARNING > > Importante > diff --git a/guides/checkout-bricks/brand-brick/default-rendering.pt.md b/guides/checkout-bricks/brand-brick/default-rendering.pt.md index 2707b0f25d..d9e0b04c2a 100644 --- a/guides/checkout-bricks/brand-brick/default-rendering.pt.md +++ b/guides/checkout-bricks/brand-brick/default-rendering.pt.md @@ -2,9 +2,9 @@ Antes de realizar a renderização do Brand Brick, primeiro execute os [passos de inicialização](/developers/pt/docs/checkout-bricks/common-initialization) compartilhados entre todos os Bricks. A partir disso, veja abaixo as informações necessárias para você configurar e renderizar o Brand Brick. -> WARNING +> NOTE > -> Importante +> Nota > > Para consultar tipagens e especificações dos parâmetros e respostas de funções do Brick, consulte a [documentação técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/brand.md). @@ -24,7 +24,7 @@ bricksBuilder.create( Uma vez criadas as configurações, insira o código abaixo para renderizar o Brick. -> NOTE +> WARNING > > Importante > diff --git a/guides/checkout-bricks/card-payment-brick/default-rendering.en.md b/guides/checkout-bricks/card-payment-brick/default-rendering.en.md index b0bbcf6814..39b81f8f35 100644 --- a/guides/checkout-bricks/card-payment-brick/default-rendering.en.md +++ b/guides/checkout-bricks/card-payment-brick/default-rendering.en.md @@ -2,9 +2,9 @@ Before rendering the Card Payment Brick, first execute the [initialization steps](/developers/en/docs/checkout-bricks/common-initialization) shared among all Bricks. From there, see below the necessary information to configure and render the Card Payment Brick. -> WARNING +> NOTE > -> Important +> Note > > To consult the types and specifications of the parameters and responses of the Brick functions, refer to the [technical documentation](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/card-payment.md). @@ -115,7 +115,7 @@ const onReady = async () => { Once the configurations are created, enter the code below to render the Brick. -> NOTE +> WARNING > > Important > diff --git a/guides/checkout-bricks/card-payment-brick/default-rendering.es.md b/guides/checkout-bricks/card-payment-brick/default-rendering.es.md index e48d409132..8278fedc84 100644 --- a/guides/checkout-bricks/card-payment-brick/default-rendering.es.md +++ b/guides/checkout-bricks/card-payment-brick/default-rendering.es.md @@ -2,9 +2,9 @@ Antes de realizar la renderización del Card Payment Brick, primero ejecute los [pasos de inicialización](/developers/es/docs/checkout-bricks/common-initialization) compartidos entre todos los Bricks. A partir de esto, a continuación se presentan las informaciones necesarias para que configures y renderices el Card Payment Brick. -> WARNING +> NOTe > -> Importante +> Nota > > Para consultar los tipos y especificaciones de los parámetros y respuestas de las funciones del Brick, consulte la [documentación técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/card-payment.md). @@ -115,7 +115,7 @@ const onReady = async () => { Una vez creadas las configuraciones, ingresa el código a continuación para renderizar el Brick. -> NOTE +> WARNING > > Importante > diff --git a/guides/checkout-bricks/card-payment-brick/default-rendering.pt.md b/guides/checkout-bricks/card-payment-brick/default-rendering.pt.md index ddad72944a..d3b8e0fbec 100644 --- a/guides/checkout-bricks/card-payment-brick/default-rendering.pt.md +++ b/guides/checkout-bricks/card-payment-brick/default-rendering.pt.md @@ -2,9 +2,9 @@ Antes de realizar a renderização do Card Payment Brick, primeiro execute os [passos de inicialização](/developers/pt/docs/checkout-bricks/common-initialization) compartilhados entre todos os Bricks. A partir disso, veja abaixo as informações necessárias para você configurar e renderizar o Card Payment Brick. -> WARNING +> NOTE > -> Importante +> Nota > > Para consultar tipagens e especificações dos parâmetros e respostas de funções do Brick, consulte a [documentação técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/card-payment.md). @@ -112,7 +112,7 @@ const onReady = async () => { Uma vez criadas as configurações, insira o código abaixo para renderizar o Brick. -> NOTE +> WARNING > > Importante > diff --git a/guides/checkout-bricks/card-payment-brick/payment-submission.en.md b/guides/checkout-bricks/card-payment-brick/payment-submission.en.md index 36a2285227..ebd8ec0e17 100644 --- a/guides/checkout-bricks/card-payment-brick/payment-submission.en.md +++ b/guides/checkout-bricks/card-payment-brick/payment-submission.en.md @@ -2,15 +2,21 @@ > > h1 > -> Payment submission to Mercado Pago +> Payment submission to Mercado Pago To continue with the Mercado Pago payment process, your backend should know how to receive form information with the generated token and the filled out data. Your backend should make available a `/process_payment` endpoint to receive all the data. Once the request –with all the collected information– is in your backend, it should be submitted to Mercado Pago through our APIs. The minimum mandatory fields to submit are: `token`, `transaction_amount`, `installments`, `payment_method_id` and `payer.email`. +> NOTE +> +> Note +> +> To consult the types and specifications that can be sent and received by the Brick in the onSubmit callback, check the [technical documentation](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/card-payment.md). + For this to work, you should configure your [private key](/developers/en/guides/additional-content/your-integrations/credentials). Also, to interact with our APIs, you should use [Mercado Pago official SDK](/developers/en/docs/sdks-library/landing). -> NOTE +> WARNING > > Important > diff --git a/guides/checkout-bricks/card-payment-brick/payment-submission.es.md b/guides/checkout-bricks/card-payment-brick/payment-submission.es.md index ca99478a38..7c73b027da 100644 --- a/guides/checkout-bricks/card-payment-brick/payment-submission.es.md +++ b/guides/checkout-bricks/card-payment-brick/payment-submission.es.md @@ -2,15 +2,21 @@ > > h1 > -> Envia el pago a Mercado Pago +> Envia el pago a Mercado Pago Para continuar el proceso de pago hacia Mercado Pago, es necesario que tu backend sepa recibir la información del formulario con el token generado y los datos completados. Su backend debe disponibilizar un endpoint `/process_payment` para recibir allí todos los datos luego de realizar la acción submit. Ya estando en tu backend con toda la información recolectada, es momento de enviar la solicitud a Mercado Pago a través de nuestras APIs. Los campos mínimos requeridos a enviar son: `token`, `transaction_amount`, `installments`, `payment_method_id` y el `payer.email`. +> NOTE +> +> Nota +> +> Para consultar los tipos y especificaciones que podrán ser enviados y recibidos por el Brick en el _callback_ de _onSubmit_, consulta la [documentación técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/card-payment.md). + Ten en cuenta que para que este paso funcione es necesario que configures tu [clave privada](/developers/es/guides/additional-content/your-integrations/credentials) y que para interactuar con nuestras APIs recomendamos utilizar la [SDK oficial de Mercado Pago](/developers/es/docs/sdks-library/landing). -> NOTE +> WARNING > > Importante > diff --git a/guides/checkout-bricks/card-payment-brick/payment-submission.pt.md b/guides/checkout-bricks/card-payment-brick/payment-submission.pt.md index 287a5d9ed1..cba98b934a 100644 --- a/guides/checkout-bricks/card-payment-brick/payment-submission.pt.md +++ b/guides/checkout-bricks/card-payment-brick/payment-submission.pt.md @@ -2,15 +2,21 @@ > > h1 > -> Envie pagamento ao Mercado Pago +> Envie pagamento ao Mercado Pago Para continuar o processo de pagamento ao Mercado Pago, é necessário que seu backend possa receber a informação do formulário com o token gerado e os dados completos. O seu backend deverá disponibilizar um endpoint `/process_payment` para receber ali todos os dados depois de realizar a ação submit. Já estando no seu backend com toda a informação coletada, é o momento de enviar a solicitação ao Mercado Pago através das nossas APIs. Os campos mínimos requeridos para enviar são: `token`, `transaction_amount`, `installments`, `payment_method_id` e o `payer.email`. +> NOTE +> +> Nota +> +> Para consultar tipagens e especificações que poderão ser enviados e recebidos pelo Brick no _callback_ de _onSubmit_, consulte a [documentação técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/card-payment.md). + Tenha em conta que para que esse passo funcione é necessário que configure sua [chave privada](/developers/pt/guides/additional-content/your-integrations/credentials) e que para interagir com nossas APIs, recomendamos utilizar o [SDK oficial do Mercado Pago](/developers/pt/docs/sdks-library/landing). -> NOTE +> WARNING > > Importante > diff --git a/guides/checkout-bricks/status-screen-brick/default-rendering.en.md b/guides/checkout-bricks/status-screen-brick/default-rendering.en.md index f33f4725a6..ad9ec965b2 100644 --- a/guides/checkout-bricks/status-screen-brick/default-rendering.en.md +++ b/guides/checkout-bricks/status-screen-brick/default-rendering.en.md @@ -2,9 +2,9 @@ Before rendering the Status Screen Brick, first execute the [initialization steps](/developers/en/docs/checkout-bricks/common-initialization) shared among all Bricks. From there, see below the necessary information to configure and render the Status Screen Brick. -> WARNING +> NOTE > -> Important +> Note > > To consult the types and specifications of the parameters and responses of the Brick functions, refer to the [technical documentation](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/status-screen.md). @@ -69,7 +69,7 @@ The `paymentId` that must be sent to Brick for its initialization is the ID retu Once the configurations are created, enter the code below to render the Brick. -> NOTE +> WARNING > > Important > diff --git a/guides/checkout-bricks/status-screen-brick/default-rendering.es.md b/guides/checkout-bricks/status-screen-brick/default-rendering.es.md index be646c5273..ba3c1bfe42 100644 --- a/guides/checkout-bricks/status-screen-brick/default-rendering.es.md +++ b/guides/checkout-bricks/status-screen-brick/default-rendering.es.md @@ -2,9 +2,9 @@ Antes de realizar la renderización del Status Screen Brick, primero ejecute los [pasos de inicialización](/developers/es/docs/checkout-bricks/common-initialization) compartidos entre todos los Bricks. A partir de esto, a continuación se presentan las informaciones necesarias para que configures y renderices el Status Screen Brick. -> WARNING +> NOTE > -> Importante +> Nota > > Para consultar los tipos y especificaciones de los parámetros y respuestas de las funciones del Brick, consulte la [documentación técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/status-screen.md). @@ -69,7 +69,7 @@ El `paymentId` que se debe enviar a Brick para su inicialización es el ID que d Una vez creadas las configuraciones, ingrese el código a continuación para renderizar el Brick. -> NOTE +> WARNING > > Importante > diff --git a/guides/checkout-bricks/status-screen-brick/default-rendering.pt.md b/guides/checkout-bricks/status-screen-brick/default-rendering.pt.md index 1435e76fb7..32bfd04928 100644 --- a/guides/checkout-bricks/status-screen-brick/default-rendering.pt.md +++ b/guides/checkout-bricks/status-screen-brick/default-rendering.pt.md @@ -2,13 +2,12 @@ Antes de realizar a renderização do Status Screen Brick, primeiro execute os [passos de inicialização](/developers/pt/docs/checkout-bricks/common-initialization) compartilhados entre todos os Bricks. A partir disso, veja abaixo as informações necessárias para você configurar e renderizar o Status Screen Brick. -> WARNING +> NOTE > -> Importante +> Nota > > Para consultar tipagens e especificações dos parâmetros e respostas de funções do Brick, consulte a [documentação técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/status-screen.md). - ## Configurar o Brick Crie a configuração de inicialização do Brick. @@ -70,7 +69,7 @@ O `paymentId` que deve ser enviado ao Brick para a sua inicialização é o ID r Uma vez criadas as configurações, insira o código abaixo para renderizar o Brick. -> NOTE +> WARNING > > Importante > diff --git a/guides/checkout-bricks/wallet-brick/default-rendering.en.md b/guides/checkout-bricks/wallet-brick/default-rendering.en.md index 287823b9a0..d009b0bfbc 100644 --- a/guides/checkout-bricks/wallet-brick/default-rendering.en.md +++ b/guides/checkout-bricks/wallet-brick/default-rendering.en.md @@ -2,9 +2,9 @@ Before rendering the Wallet Brick, first execute the [initialization steps](/developers/en/docs/checkout-bricks/common-initialization) shared among all Bricks. From there, see below the necessary information to configure and render the Wallet Brick. -> WARNING +> NOTE > -> Important +> Note > > To consult the types and specifications of the parameters and responses of the Brick functions, refer to the [technical documentation](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/wallet.md). diff --git a/guides/checkout-bricks/wallet-brick/default-rendering.es.md b/guides/checkout-bricks/wallet-brick/default-rendering.es.md index 0b366c8fac..83c6183e5b 100644 --- a/guides/checkout-bricks/wallet-brick/default-rendering.es.md +++ b/guides/checkout-bricks/wallet-brick/default-rendering.es.md @@ -2,9 +2,9 @@ Antes de realizar la renderización del Wallet Brick, primero ejecute los [pasos de inicialización](/developers/es/docs/checkout-bricks/common-initialization) compartidos entre todos los Bricks. A partir de esto, a continuación se presentan las informaciones necesarias para que configures y renderices el Wallet Brick. -> WARNING +> NOTE > -> Importante +> Nota > > Para consultar los tipos y especificaciones de los parámetros y respuestas de las funciones del Brick, consulte la [documentación técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/wallet.md). @@ -70,7 +70,7 @@ Este flujo está pensado para tiendas que utilizan Wallet Brick al final del pro Una vez creadas las configuraciones, ingrese el código a continuación. -> NOTE +> WARNING > > Importante > @@ -307,7 +307,7 @@ curl -X POST \ ``` ]]] -> NOTE +> WARNING > > Importante > diff --git a/guides/checkout-bricks/wallet-brick/default-rendering.pt.md b/guides/checkout-bricks/wallet-brick/default-rendering.pt.md index 89d565a4e0..74422c9aa2 100644 --- a/guides/checkout-bricks/wallet-brick/default-rendering.pt.md +++ b/guides/checkout-bricks/wallet-brick/default-rendering.pt.md @@ -2,13 +2,12 @@ Antes de realizar a renderização do Wallet Brick, primeiro execute os [passos de inicialização](/developers/pt/docs/checkout-bricks/common-initialization) compartilhados entre todos os Bricks. A partir disso, veja abaixo as informações necessárias para você configurar e renderizar o Wallet Brick. -> WARNING +> NOTE > -> Importante +> Nota > > Para consultar tipagens e especificações dos parâmetros e respostas de funções do Brick, consulte a [documentação técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/wallet.md). - ## Configurar o Brick Crie a configuração de inicialização do Brick. @@ -71,7 +70,7 @@ Esse fluxo é pensado para lojas que utilizam o Wallet Brick no final do process Uma vez criadas as configurações, insira o código abaixo para renderizar o Brick. -> NOTE +> WARNING > > Importante > @@ -307,7 +306,7 @@ curl -X POST \ ``` ]]] -> NOTE +> WARNING > > Importante > From b5e622ec60a4103d57d4fa55eb964913b9c31e58 Mon Sep 17 00:00:00 2001 From: hgaldino Date: Mon, 29 Jul 2024 16:25:53 -0300 Subject: [PATCH 08/20] bricks3 --- .../payment-brick/payment-submission.en.md | 10 ++++++++-- .../payment-brick/payment-submission.es.md | 8 +++++++- .../payment-brick/payment-submission.pt.md | 8 +++++++- 3 files changed, 22 insertions(+), 4 deletions(-) diff --git a/guides/checkout-bricks/payment-brick/payment-submission.en.md b/guides/checkout-bricks/payment-brick/payment-submission.en.md index b359adf79e..1323092166 100644 --- a/guides/checkout-bricks/payment-brick/payment-submission.en.md +++ b/guides/checkout-bricks/payment-brick/payment-submission.en.md @@ -6,11 +6,17 @@ To continue with the Mercado Pago payment process, your backend should know how to receive form information with the generated token and the filled out data. Your backend should make available a `/process_payment` endpoint to receive all the data. -Once the request –with all the collected information– is in your backend, it should be submitted to Mercado Pago through our APIs. +Once the request –with all the collected information– is in your backend, it should be submitted to Mercado Pago through our APIs. + +> NOTE +> +> Note +> +> To consult the types and specifications that can be sent and received by the Brick in the onSubmit callback, check the [technical documentation](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/card-payment.md). For this to work, you should configure your [private key](/developers/en/guides/additional-content/your-integrations/credentials). Also, to interact with our APIs, you should use [Mercado Pago official SDK](/developers/en/docs/sdks-library/landing). -> NOTE +> WARNING > > Important > diff --git a/guides/checkout-bricks/payment-brick/payment-submission.es.md b/guides/checkout-bricks/payment-brick/payment-submission.es.md index 4e97eec35b..d184087f5a 100644 --- a/guides/checkout-bricks/payment-brick/payment-submission.es.md +++ b/guides/checkout-bricks/payment-brick/payment-submission.es.md @@ -8,9 +8,15 @@ Para continuar el proceso de pago hacia Mercado Pago, es necesario que tu backen Ya estando en tu backend con toda la información recolectada, es momento de enviar la solicitud a Mercado Pago a través de nuestras APIs. +> NOTE +> +> Nota +> +> Para consultar los tipos y especificaciones que podrán ser enviados y recibidos por el Brick en el _callback_ de _onSubmit_, consulta la [documentación técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/card-payment.md). + Ten en cuenta que para que este paso funcione es necesario que configures tu [clave privada](/developers/es/guides/additional-content/your-integrations/credentials) y que para interactuar con nuestras APIs recomendamos utilizar la [SDK oficial de Mercado Pago](/developers/es/docs/sdks-library/landing). -> NOTE +> WARNING > > Importante > diff --git a/guides/checkout-bricks/payment-brick/payment-submission.pt.md b/guides/checkout-bricks/payment-brick/payment-submission.pt.md index e3bfa48588..2df00667e6 100644 --- a/guides/checkout-bricks/payment-brick/payment-submission.pt.md +++ b/guides/checkout-bricks/payment-brick/payment-submission.pt.md @@ -8,9 +8,15 @@ Para continuar o processo de pagamento ao Mercado Pago, é necessário que seu b Já estando no seu backend com toda a informação coletada, é o momento de enviar a solicitação ao Mercado Pago através das nossas APIs. +> NOTE +> +> Nota +> +> Para consultar tipagens e especificações que poderão ser enviados e recebidos pelo Brick no _callback_ de _onSubmit_, consulte a [documentação técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/card-payment.md). + Tenha em conta que para que esse passo funcione é necessário que configure sua [chave privada](/developers/pt/guides/additional-content/your-integrations/credentials) e que para interagir com nossas APIs, recomendamos utilizar o [SDK oficial do Mercado Pago](/developers/pt/docs/sdks-library/landing). -> NOTE +> WARNING > > Importante > From 0526eca5ad8dee3b97894bdcd7f1c307e6a0aa8a Mon Sep 17 00:00:00 2001 From: hgaldino Date: Mon, 29 Jul 2024 16:28:29 -0300 Subject: [PATCH 09/20] bricks4 --- guides/checkout-bricks/payment-brick/payment-submission.en.md | 2 +- guides/checkout-bricks/payment-brick/payment-submission.es.md | 2 +- guides/checkout-bricks/payment-brick/payment-submission.pt.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/guides/checkout-bricks/payment-brick/payment-submission.en.md b/guides/checkout-bricks/payment-brick/payment-submission.en.md index 1323092166..048bdac2a7 100644 --- a/guides/checkout-bricks/payment-brick/payment-submission.en.md +++ b/guides/checkout-bricks/payment-brick/payment-submission.en.md @@ -12,7 +12,7 @@ Once the request –with all the collected information– is in your backend, it > > Note > -> To consult the types and specifications that can be sent and received by the Brick in the onSubmit callback, check the [technical documentation](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/card-payment.md). +> To consult the types and specifications that can be sent and received by the Brick in the onSubmit callback, check the [technical documentation](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/payment.md). For this to work, you should configure your [private key](/developers/en/guides/additional-content/your-integrations/credentials). Also, to interact with our APIs, you should use [Mercado Pago official SDK](/developers/en/docs/sdks-library/landing). diff --git a/guides/checkout-bricks/payment-brick/payment-submission.es.md b/guides/checkout-bricks/payment-brick/payment-submission.es.md index d184087f5a..62be7ed340 100644 --- a/guides/checkout-bricks/payment-brick/payment-submission.es.md +++ b/guides/checkout-bricks/payment-brick/payment-submission.es.md @@ -12,7 +12,7 @@ Ya estando en tu backend con toda la información recolectada, es momento de env > > Nota > -> Para consultar los tipos y especificaciones que podrán ser enviados y recibidos por el Brick en el _callback_ de _onSubmit_, consulta la [documentación técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/card-payment.md). +> Para consultar los tipos y especificaciones que podrán ser enviados y recibidos por el Brick en el _callback_ de _onSubmit_, consulta la [documentación técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/payment.md). Ten en cuenta que para que este paso funcione es necesario que configures tu [clave privada](/developers/es/guides/additional-content/your-integrations/credentials) y que para interactuar con nuestras APIs recomendamos utilizar la [SDK oficial de Mercado Pago](/developers/es/docs/sdks-library/landing). diff --git a/guides/checkout-bricks/payment-brick/payment-submission.pt.md b/guides/checkout-bricks/payment-brick/payment-submission.pt.md index 2df00667e6..7e564c81ae 100644 --- a/guides/checkout-bricks/payment-brick/payment-submission.pt.md +++ b/guides/checkout-bricks/payment-brick/payment-submission.pt.md @@ -12,7 +12,7 @@ Já estando no seu backend com toda a informação coletada, é o momento de env > > Nota > -> Para consultar tipagens e especificações que poderão ser enviados e recebidos pelo Brick no _callback_ de _onSubmit_, consulte a [documentação técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/card-payment.md). +> Para consultar tipagens e especificações que poderão ser enviados e recebidos pelo Brick no _callback_ de _onSubmit_, consulte a [documentação técnica](https://github.com/mercadopago/sdk-js/blob/main/API/bricks/payment.md). Tenha em conta que para que esse passo funcione é necessário que configure sua [chave privada](/developers/pt/guides/additional-content/your-integrations/credentials) e que para interagir com nossas APIs, recomendamos utilizar o [SDK oficial do Mercado Pago](/developers/pt/docs/sdks-library/landing). From 635c09cfcc5fdbf6ba21b8d04d705d1f51d34207 Mon Sep 17 00:00:00 2001 From: hgaldino Date: Mon, 29 Jul 2024 17:36:00 -0300 Subject: [PATCH 10/20] claims --- reference/api-json/claims.json | 8612 +++++++++++++++-------------- reference/api-json/claims_v2.json | 5047 ----------------- 2 files changed, 4522 insertions(+), 9137 deletions(-) delete mode 100644 reference/api-json/claims_v2.json diff --git a/reference/api-json/claims.json b/reference/api-json/claims.json index fb3f6baefc..618b87b1eb 100644 --- a/reference/api-json/claims.json +++ b/reference/api-json/claims.json @@ -1,2523 +1,2933 @@ { - "url": "https://api.mercadopago.com", - "paths": { - "/v1/claims/{claim_id}": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows you to obtain, through a valid token, details of claims such as, for example, information about the users involved and the order that generated the claim", - "pt": "Este endpoint permite obter, por meio de um token válido, detalhes das reclamações como, por exemplo, informaçõees sobre as pessoas usuárias envolvidas e sobre o pedido que gerou a reclamação", - "es": "Este endpoint permite obtener, a través de un token válido, detalles de los reclamos como, por ejemplo, información sobre las personas usuarias involucradas y el pedido que generó el reclamo" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } + "url": "https://api.mercadopago.com", + "paths": { + "/post-purchase/v1/claims/{claim_id}": { + "get": { + "tags": [ + "checkout-pro" + ], + "description": { + "en": "This endpoint allows you to obtain, through a valid token, details of claims such as, for example, information about the users involved and the order that generated the claim", + "pt": "Este endpoint permite obter, por meio de um token válido, detalhes das reclamações como, por exemplo, informaçõees sobre as pessoas usuárias envolvidas e sobre o pedido que gerou a reclamação", + "es": "Este endpoint permite obtener, a través de un token válido, detalles de los reclamos como, por ejemplo, información sobre las personas usuarias involucradas y el pedido que generó el reclamo" + }, + "parameters": [ + { + "in": "path", + "name": "claim_id", + "required": true, + "schema": { + "type": "number", + "example": 5039218470 + }, + "description": { + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number", - "example": 5033102536, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } + } + ], + "responses": { + "200": { + "description": { + "es": "Success", + "pt": "Sucesso", + "en": "Éxito" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number", + "example": 5033102536, + "description": { + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." + } + }, + "resource_id": { + "type": "number", + "example": 7138572864, + "description": { + "en": "ID of the resource on which the claim is created and depends on the 'resource' parameter.", + "pt": "ID do recurso sobre o qual a reclamação é criada e depende do parâmetro 'resource'.", + "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro 'resource'." + } + }, + "status": { + "type": "string", + "example": "closed", + "description": { + "en": "Specifies the current state of the claim, indicating whether it is open or closed. It can take one of the following values:", + "pt": "Especifica o estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", + "es": "Especifica el estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" }, - "type": { - "type": "string", - "example": "mediations", - "description": { - "en": "Defines the nature of the claim being processed. It can take one of the following values:", - "pt": "Define a natureza da reclamação em processamento. Pode assumir um dos seguintes valores:", - "es": "Define la naturaleza del reclamo que se está procesando. Puede tomar alguno de los siguientes valores:" + "enum": [ + { + "title": "opened", + "description": { + "en": "Indicates that the claim is open.", + "pt": "Indica que a reclamação está aberta.", + "es": "Indica que el reclamo está abierto." + } }, - "enum": [ - { - "title": "mediations", - "description": { - "en": "Refers to the process of mediating between parties in a claim.", - "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", - "es": "Se refiere al proceso de mediación entre las partes en un reclamo." - } - }, - { - "title": "cancel_purchase", - "description": { - "en": "Involves the process of cancelling a previously made purchase.", - "pt": "Envolve o processo de cancelar uma compra previamente realizada.", - "es": "Involucra el proceso de cancelar una compra previamente realizada." - } - }, - { - "title": "return", - "description": { - "en": "Pertains to the process of returning a purchased item.", - "pt": "Refere-se ao processo de devolução de um item comprado.", - "es": "Se refiere al proceso de devolver un artículo comprado." - } - }, - { - "title": "cancel_sale", - "description": { - "en": "oncerns the process of cancelling a sale that has been made.", - "pt": "Refere-se ao processo de cancelar uma venda realizada.", - "es": "Se ocupa del proceso de cancelar una venta realizada." - } - }, - { - "title": "change", - "description": { - "en": "Refers to the alteration or modification of the details or status of a claim.", - "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", - "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." - } + { + "title": "closed", + "description": { + "en": "Indicates that the claim is closed.", + "pt": "Indica que a reclamação está fechada.", + "es": "Indica que el reclamo está cerrado." } - ] + } + ] + }, + "type": { + "type": "string", + "example": "mediations", + "description": { + "en": "Defines the nature of the claim being processed. It can take one of the following values:", + "pt": "Define a natureza da reclamação em processamento. Pode assumir um dos seguintes valores:", + "es": "Define la naturaleza del reclamo que se está procesando. Puede tomar alguno de los siguientes valores:" }, - "stage": { - "type": "string", - "example": "dispute", - "description": { - "en": "Indicates the current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", - "pt": "Indica a fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", - "es": "Indica la fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" + "enum": [ + { + "title": "mediations", + "description": { + "en": "Refers to the process of mediating between parties in a claim.", + "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", + "es": "Se refiere al proceso de mediación entre las partes en un reclamo." + } }, - "enum": [ - { - "title": "claim", - "description": { - "en": "Initial stage of the claim process in which both the buyer and seller are involved.", - "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", - "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." - } - }, - { - "title": "dispute", - "description": { - "en": "Phase where the claim is under dispute or disagreement.", - "pt": "Fase em que a reclamação está em disputa ou desacordo.", - "es": "Fase donde el reclamo está en disputa o desacuerdo." - } - }, - { - "title": "recontact", - "description": { - "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", - "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", - "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." - } - }, - { - "title": "none", - "description": { - "en": "Indicates no specific stage is currently applicable.", - "pt": "Indica que nenhuma etapa específica é aplicável.", - "es": "Indica que no se aplica ninguna etapa específica." - } + { + "title": "cancel_purchase", + "description": { + "en": "Involves the process of cancelling a previously made purchase.", + "pt": "Envolve o processo de cancelar uma compra previamente realizada.", + "es": "Involucra el proceso de cancelar una compra previamente realizada." } - ] - }, - "status": { - "type": "string", - "example": "closed", - "description": { - "en": "Specifies the current state of the claim, indicating whether it is open or closed. It can take one of the following values:", - "pt": "Especifica o estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", - "es": "Especifica el estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" }, - "enum": [ - { - "title": "opened", - "description": { - "en": "Indicates that the claim is open.", - "pt": "Indica que a reclamação está aberta.", - "es": "Indica que el reclamo está abierto." - } - }, - { - "title": "closed", - "description": { - "en": "Indicates that the claim is closed.", - "pt": "Indica que a reclamação está fechada.", - "es": "Indica que el reclamo está cerrado." - } + { + "title": "return", + "description": { + "en": "Pertains to the process of returning a purchased item.", + "pt": "Refere-se ao processo de devolução de um item comprado.", + "es": "Se refiere al proceso de devolver un artículo comprado." + } + }, + { + "title": "cancel_sale", + "description": { + "en": "oncerns the process of cancelling a sale that has been made.", + "pt": "Refere-se ao processo de cancelar uma venda realizada.", + "es": "Se ocupa del proceso de cancelar una venta realizada." + } + }, + { + "title": "change", + "description": { + "en": "Refers to the alteration or modification of the details or status of a claim.", + "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", + "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." } - ] - }, - "parent_id": { - "type": "string", - "example": null, - "description": { - "en": "ID of another claim on which it depends.", - "pt": "ID de outra reclamação da qual esta depende.", - "es": "ID de otro reclamo del que depende." - } - }, - "client_id": { - "type": "number", - "example": 1569196570216262, - "description": { - "en": "ID of the app that created the claim.", - "pt": "ID do aplicativo que criou a reclamação.", - "es": "ID de la app que creo el reclamo" } + ] + }, + "stage": { + "type": "string", + "example": "dispute", + "description": { + "en": "Indicates the current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", + "pt": "Indica a fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", + "es": "Indica la fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" }, - "resource_id": { - "type": "number", - "example": 7138572864, - "description": { - "en": "ID of the resource on which the claim is created and depends on the 'resource' parameter.", - "pt": "ID do recurso sobre o qual a reclamação é criada e depende do parâmetro 'resource'.", - "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro 'resource'." + "enum": [ + { + "title": "claim", + "description": { + "en": "Initial stage of the claim process in which both the buyer and seller are involved.", + "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", + "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." + } + }, + { + "title": "dispute", + "description": { + "en": "Phase where the claim is under dispute or disagreement.", + "pt": "Fase em que a reclamação está em disputa ou desacordo.", + "es": "Fase donde el reclamo está en disputa o desacuerdo." + } + }, + { + "title": "recontact", + "description": { + "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", + "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", + "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." + } + }, + { + "title": "none", + "description": { + "en": "Indicates no specific stage is currently applicable.", + "pt": "Indica que nenhuma etapa específica é aplicável.", + "es": "Indica que no se aplica ninguna etapa específica." + } } + ] + }, + "parent_id": { + "type": "string", + "example": null, + "description": { + "en": "ID of another claim on which it depends.", + "pt": "ID de outra reclamação da qual esta depende.", + "es": "ID de otro reclamo del que depende." + } + }, + "resource": { + "type": "string", + "example": "shipment", + "description": { + "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase.", + "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra.", + "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra." }, - "resource": { - "type": "string", - "example": "shipment", - "description": { - "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase.", - "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra.", - "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra." + "enum": [ + { + "title": "payment", + "description": { + "en": "Related to claims involving payment transactions.", + "pt": "Relacionado a reclamações envolvendo transações de pagamento.", + "es": "Relacionado con reclamos que involucran transacciones de pago." + } }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Related to claims involving payment transactions.", - "pt": "Relacionado a reclamações envolvendo transações de pagamento.", - "es": "Relacionado con reclamos que involucran transacciones de pago." - } - }, - { - "title": "order", - "description": { - "en": "Pertains to claims arising from order processing issues.", - "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", - "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." - } - }, - { - "title": "shipment", - "description": { - "en": "Concerns claims related to shipping or delivery matters.", - "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", - "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." - } - }, - { - "title": "purchase", - "description": { - "en": "Involves claims associated with the purchase process.", - "pt": "Envolve reclamações associadas ao processo de compra.", - "es": "Involucra reclamos asociados con el proceso de compra." - } + { + "title": "order", + "description": { + "en": "Pertains to claims arising from order processing issues.", + "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", + "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." } - ] - }, - "reason_id": { - "type": "string", - "example": "PNR4071", - "description": { - "en": "Reason ID of the claim. A claim can be created for three general reasons:", - "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", - "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" }, - "enum": [ - { - "title": "PNR", - "description": { - "en": "Product not received.", - "pt": "Produto não recebido.", - "es": "Producto no recibido." - } - }, - { - "title": "PDD", - "description": { - "en": "Different or defective product.", - "pt": "Produto diferente ou defeituoso", - "es": "Producto diferente o defectuoso." - } - }, - { - "title": "CS", - "description": { - "en": "Purchase cancellation.", - "pt": "Cancelamento de compra.", - "es": "Cancelación de la compra." - } + { + "title": "shipment", + "description": { + "en": "Concerns claims related to shipping or delivery matters.", + "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", + "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." + } + }, + { + "title": "purchase", + "description": { + "en": "Involves claims associated with the purchase process.", + "pt": "Envolve reclamações associadas ao processo de compra.", + "es": "Involucra reclamos asociados con el proceso de compra." } - ] - }, - "quantity_type": { - "type": "string", - "example": "total", - "description": { - "en": "Indica si una devolución corresponde a todos los productos de la orden o solo algunos. Inicialmente sólo mostrará el valor 'total' y en el futuro se visualizará el valor 'partial'.", - "pt": "Indica se um reembolso corresponde a todos os produtos do pedido ou apenas alguns. Inicialmente, mostrará apenas o valor 'total' e, no futuro, será exibido o valor 'partial'.", - "es": "Indicates whether a return corresponds to all products in the order or only some. Initially, it will only show the value 'total', and in the future, the value 'partial' will be displayed." } + ] + }, + "reason_id": { + "type": "string", + "example": "PNR4071", + "description": { + "en": "Reason ID of the claim. A claim can be created for three general reasons:", + "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", + "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" }, - "players": { - "type": "array", - "description": { - "en": "People who are participating in the complaint.", - "pt": "Pessoas que estão participando da reclamação.", - "es": "Personas que están participando en el reclamo." + "enum": [ + { + "title": "PNR", + "description": { + "en": "Product not received.", + "pt": "Produto não recebido.", + "es": "Producto no recibido." + } }, - "items": { - "type": "object", - "properties": { - "role": { - "type": "string", - "example": "mediator", - "description": { - "en": "Indicates the person's role within the claim. It can take one of the following values:", - "pt": "Indica o papel da pessoa dentro da reclamação. Pode assumir um dos seguintes valores:", - "es": "Indica el rol de la persona dentro del reclamo. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "complainant", - "description": { - "en": "Person who claims", - "pt": "Pessoa que reclama.", - "es": "Persona que reclama." - } - }, - { - "title": "respondent", - "description": { - "en": "Person to whom they are complaining.", - "pt": "Pessoa a quem estão reclamando.", - "es": "Persona a quién le reclaman." - } - }, - { - "title": "mediator", - "description": { - "en": "Person who intervenes to help solve the problem.", - "pt": "Pessoa que intervém para ajudar a resolver o problema.", - "es": "Persona que interviene para ayudar a solucionar el problema." - } - } - ] - }, - "type": { - "type": "string", - "example": "payer", - "description": { - "en": "Role that the person occupies in the operation that is being claimed and may vary according to the 'resource'. It can take one of the following values:", - "pt": "Papel que a pessoa ocupa na operação que está sendo reivindicada e pode variar de acordo com o 'resource'. Pode assumir um dos seguintes valores:", - "es": "Rol que ocupa la persona sobre la operación que se está reclamando y puede variar de acuerdo con el 'resource'. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Indicates that the person is the buyer or collector.", - "pt": "Indica que a pessoa é compradora ou cobradora.", - "es": "Indica que la persona es el comprador o collector." - } - }, - { - "title": "order", - "description": { - "en": "Indicates that the person is the buyer or seller.", - "pt": "Indica que a pessoa é compradora ou vendedora.", - "es": "Indica que la persona es el comprador o vendedor." - } - }, - { - "title": "shipment", - "description": { - "en": "Indicates that the person is the receiver or sender.", - "pt": "Indica que a pessoa é o destinatário ou remetente.", - "es": "Indica que la persona es el receptor o remitente." - } - } - ] - }, - "user_id": { - "type": "number", - "example": 242829175, - "description": { - "en": "ID of the 'type' indicated in the previous parameter.", - "pt": "ID do 'type' indicado no parâmetro anterior.", - "es": "ID del 'type' indicado en el parámetro anterior." - } - }, - "available_actions": { - "type": "array", - "description": { - "en": "Provides information about the actions that each of the involved parties can execute.", - "pt": "Exibe informações sobre as ações que cada uma das partes envolvidas pode executar.", - "es": "Presenta información sobre las acciones que pueden ejecutar cada una de las partes intervinientes." - }, - "items": { - "type": "object", - "properties": { - "action": { - "type": "string", - "example": "recontact", - "description": { - "es": "List of actions that each of the involved parties can execute.", - "pt": "Lista de ações que cada uma das partes envolvidas pode executar.", - "en": "Lista de acciones que pueden ejecutar cada una de las partes intervinientes." - }, - "enum": [ - { - "title": "send_message_to_complainant", - "description": { - "en": "Send a message to the buyer (with or without attachments).", - "pt": "Enviar mensagem para o comprador (com ou sem anexos).", - "es": "Enviar mensaje para el comprador (con o sin anexos)." - } - }, - { - "title": "send_message_to_mediator", - "description": { - "en": "Send a message to the mediator (with or without attachments).", - "pt": "Enviar mensagem para o mediador (com ou sem anexos).", - "es": "Enviar mensaje para el mediador (con o sin anexos)." - } - }, - { - "title": "recontact (no disponible aún)", - "description": { - "en": "Reopen a closed complaint through an interaction, such as a message.", - "pt": "Reabrir uma reclamação já fechada, por meio de uma interação, como uma mensagem.", - "es": "Reabrir un reclamo ya cerrado, por medio de una interacción, como un mensaje." - } - }, - { - "title": "refund", - "description": { - "en": "Refund the buyer's money. Must be performed by the Mercado Pago front end.", - "pt": "Devolver o dinheiro do comprador. Deve ser realizado pelo front do Mercado Pago.", - "es": "Devolver el dinero del comprado. Debe ser realizado por el front de Mercado Pago." - } - }, - { - "title": "open_dispute", - "description": { - "en": "Initiate mediation.", - "pt": "Iniciar uma mediação.", - "es": "Iniciar una mediación." - } - }, - { - "title": "send_potential_shipping", - "description": { - "en": "Send a promise of shipment, indicating a date.", - "pt": "Enviar uma promessa de postagem, indicando uma data.", - "es": "Enviar una promesa de post, indicando una fecha." - } - }, - { - "title": "add_shipping_evidence", - "description": { - "en": "Publish evidence that the product has been shipped.", - "pt": "Publicar uma evidência de que o produto foi enviado.", - "es": "Publicar una evidencia de que el producto fue enviado." - } - }, - { - "title": "send_attachments", - "description": { - "en": "Send message with attached images.", - "pt": "Enviar mensagem com imagens anexadas.", - "es": "Enviar mensaje con imágenes adjuntas." - } - }, - { - "title": "allow_return_label", - "description": { - "en": "Generate a return label.", - "pt": "Gerar etiqueta de devolução.", - "es": "Generar etiqueta de devolución." - } - }, - { - "title": "send_tracking_number", - "description": { - "en": "Send the shipping tracking number.", - "pt": "Enviar o número de rastreamento de envio (tracking number).", - "es": "Enviar el número de rastreo de envío (tracking number)." - } - } - ] - }, - "due_date": { - "type": "string", - "example": "2020-11-16T22:36:59.000-04:00", - "description": { - "en": "Deadline to perform the action.", - "pt": "Prazo limite para realizar a ação.", - "es": "Tiempo límite para realizar la acción." - } - }, - "mandatory": { - "type": "boolean", - "example": true, - "description": { - "en": "This field being 'true' indicates that the action is mandatory and must be performed within the specified time.", - "pt": "Este campo como 'true' indica que a ação é obrigatória e deve ser realizada dentro do tempo informado.", - "es": "Este campo en 'true' indica que la acción es obligatoria y debe ser realizada dentro del tiempo informado." - } - } - } - } - } + { + "title": "PDD", + "description": { + "en": "Different or defective product.", + "pt": "Produto diferente ou defeituoso.", + "es": "Producto diferente o defectuoso." + } + }, + { + "title": "CS", + "description": { + "en": "Purchase cancellation.", + "pt": "Cancelamento de compra.", + "es": "Cancelación de la compra." } } + ] + }, + "fulfilled": { + "type": "boolean", + "example": true, + "description": { + "en": "Indicate whether the claim is for a delivered or undelivered product.", + "pt": "Indique se o reclamação é sobre um produto entregue ou não entregue.", + "es": "Indica si el reclamo se inicia por un producto entregado o no." + } + }, + "quantity_type": { + "type": "string", + "example": "total", + "description": { + "en": "Indica si una devolución corresponde a todos los productos de la orden o solo algunos. Inicialmente sólo mostrará el valor 'total' y en el futuro se visualizará el valor 'partial'.", + "pt": "Indica se um reembolso corresponde a todos os produtos do pedido ou apenas alguns. Inicialmente, mostrará apenas o valor 'total' e, no futuro, será exibido o valor 'partial'.", + "es": "Indicates whether a return corresponds to all products in the order or only some. Initially, it will only show the value 'total', and in the future, the value 'partial' will be displayed." + } + }, + "players": { + "type": "array", + "description": { + "en": "People who are participating in the complaint.", + "pt": "Pessoas que estão participando da reclamação.", + "es": "Personas que están participando en el reclamo." }, - "resolution": { + "items": { "type": "object", - "description": { - "en": "Provides information about claim resolution.", - "pt": "Exibe informações sobre a resolução da reclamação.", - "es": "Presenta información sobre la resolución del reclamo." - }, "properties": { - "reason": { + "role": { "type": "string", - "example": "already_shipped", + "example": "mediator", "description": { - "en": "Reason for resolution/closure.", - "pt": "Motivo de resolução/encerramento.", - "es": "Motivo de resolucion/cierre." - } + "en": "Indicates the person's role within the claim. It can take one of the following values:", + "pt": "Indica o papel da pessoa dentro da reclamação. Pode assumir um dos seguintes valores:", + "es": "Indica el rol de la persona dentro del reclamo. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "complainant", + "description": { + "en": "Person who claims", + "pt": "Pessoa que reclama.", + "es": "Persona que reclama." + } + }, + { + "title": "respondent", + "description": { + "en": "Person to whom they are complaining.", + "pt": "Pessoa a quem estão reclamando.", + "es": "Persona a quién le reclaman." + } + }, + { + "title": "mediator", + "description": { + "en": "Person who intervenes to help solve the problem.", + "pt": "Pessoa que intervém para ajudar a resolver o problema.", + "es": "Persona que interviene para ayudar a solucionar el problema." + } + } + ] }, - "date_created": { + "type": { "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", + "example": "payer", "description": { - "en": "Date of resolution/closure of the claim.", - "pt": "Data de resolução/encerramento da reclamação.", - "es": "Fecha de la resolucion/cierre del reclamo." - } - }, - "decision": { - "type": "array", - "items": { - "type": "string", - "example": "complainant", - "description": { - "en": "Person who defined the resolution of the claim.", - "pt": "Pessoa que definiu a resolução da reclamação.", - "es": "Persona que definió la resolución del reclamo." + "en": "Role that the person occupies in the operation that is being claimed and may vary according to the 'resource'. It can take one of the following values:", + "pt": "Papel que a pessoa ocupa na operação que está sendo reivindicada e pode variar de acordo com o 'resource'. Pode assumir um dos seguintes valores:", + "es": "Rol que ocupa la persona sobre la operación que se está reclamando y puede variar de acuerdo con el 'resource'. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "payment", + "description": { + "en": "Indicates that the person is the buyer or collector.", + "pt": "Indica que a pessoa é compradora ou cobradora.", + "es": "Indica que la persona es el comprador o collector." + } + }, + { + "title": "order", + "description": { + "en": "Indicates that the person is the buyer or seller.", + "pt": "Indica que a pessoa é compradora ou vendedora.", + "es": "Indica que la persona es el comprador o vendedor." + } + }, + { + "title": "shipment", + "description": { + "en": "Indicates that the person is the receiver or sender.", + "pt": "Indica que a pessoa é o destinatário ou remetente.", + "es": "Indica que la persona es el receptor o remitente." + } } - } + ] }, - "closed_by": { - "type": "string", - "example": "mediator", + "user_id": { + "type": "number", + "example": 242829175, "description": { - "en": "Person who closed the claim.", - "pt": "Pessoa que encerrou a reclamação.", - "es": "Persona que cerró el reclamo." + "en": "ID of the 'type' indicated in the previous parameter.", + "pt": "ID do 'type' indicado no parâmetro anterior.", + "es": "ID del 'type' indicado en el parámetro anterior." } - } - } - }, - "coverages": { - "type": "array", - "description": { - "en": "Represents the coverages applied to users in the claim.", - "pt": "Representa as coberturas aplicadas aos usuários na reclamação.", - "es": "Representa las coberturas aplicadas a usuarios en el reclamo." - }, - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "bpp", - "description": { - "en": "Type of coverage applied to users (e.g., 'bpp' - Buyer Protection Program).", - "pt": "Tipo de cobertura aplicada aos usuários (ex: 'bpp' - Buyer Protection Program).", - "es": "Tipo de cobertura aplicada a usuarios (ej: 'bpp' - Buyer Protection Program)." - } - }, - "benefited": { - "type": "string", - "example": "complainant", - "description": { - "en": "It will indicate who will benefit from resolving the claim.", - "pt": "Indicará quem for beneficiado pela resolução da reclamação.", - "es": "Indicará quién se beneficiará de resolver el reclamo." - } - }, - "amount": { - "type": "number", - "example": 194.99, - "description": { - "en": "Total amount of the applied coverage.", - "pt": "Valor total da cobertura aplicada.", - "es": "Monto total de la cobertura aplicada" - } + }, + "available_actions": { + "type": "array", + "description": { + "en": "Provides information about the actions that each of the involved parties can execute.", + "pt": "Exibe informações sobre as ações que cada uma das partes envolvidas pode executar.", + "es": "Presenta información sobre las acciones que pueden ejecutar cada una de las partes intervinientes." }, - "resource": { - "type": "string", - "example": "shipment", - "description": { - "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase.", - "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra.", - "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra." - }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Related to claims involving payment transactions.", - "pt": "Relacionado a reclamações envolvendo transações de pagamento.", - "es": "Relacionado con reclamos que involucran transacciones de pago." - } - }, - { - "title": "order", + "items": { + "type": "object", + "properties": { + "action": { + "type": "string", + "example": "recontact", "description": { - "en": "Pertains to claims arising from order processing issues.", - "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", - "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." - } + "es": "List of actions that each of the involved parties can execute.", + "pt": "Lista de ações que cada uma das partes envolvidas pode executar.", + "en": "Lista de acciones que pueden ejecutar cada una de las partes intervinientes." + }, + "enum": [ + { + "title": "send_message_to_complainant", + "description": { + "en": "Send a message to the buyer (with or without attachments).", + "pt": "Enviar mensagem para o comprador (com ou sem anexos).", + "es": "Enviar mensaje para el comprador (con o sin anexos)." + } + }, + { + "title": "send_message_to_mediator", + "description": { + "en": "Send a message to the mediator (with or without attachments).", + "pt": "Enviar mensagem para o mediador (com ou sem anexos).", + "es": "Enviar mensaje para el mediador (con o sin anexos)." + } + }, + { + "title": "recontact (no disponible aún)", + "description": { + "en": "Reopen a closed complaint through an interaction, such as a message.", + "pt": "Reabrir uma reclamação já fechada, por meio de uma interação, como uma mensagem.", + "es": "Reabrir un reclamo ya cerrado, por medio de una interacción, como un mensaje." + } + }, + { + "title": "refund", + "description": { + "en": "Refund the buyer's money. Must be performed by the Mercado Pago front end.", + "pt": "Devolver o dinheiro do comprador. Deve ser realizado pelo front do Mercado Pago.", + "es": "Devolver el dinero del comprado. Debe ser realizado por el front de Mercado Pago." + } + }, + { + "title": "open_dispute", + "description": { + "en": "Initiate mediation.", + "pt": "Iniciar uma mediação.", + "es": "Iniciar una mediación." + } + }, + { + "title": "send_potential_shipping", + "description": { + "en": "Send a promise of shipment, indicating a date.", + "pt": "Enviar uma promessa de postagem, indicando uma data.", + "es": "Enviar una promesa de post, indicando una fecha." + } + }, + { + "title": "add_shipping_evidence", + "description": { + "en": "Publish evidence that the product has been shipped.", + "pt": "Publicar uma evidência de que o produto foi enviado.", + "es": "Publicar una evidencia de que el producto fue enviado." + } + }, + { + "title": "send_attachments", + "description": { + "en": "Send message with attached images.", + "pt": "Enviar mensagem com imagens anexadas.", + "es": "Enviar mensaje con imágenes adjuntas." + } + }, + { + "title": "allow_return_label", + "description": { + "en": "Generate a return label.", + "pt": "Gerar etiqueta de devolução.", + "es": "Generar etiqueta de devolución." + } + }, + { + "title": "send_tracking_number", + "description": { + "en": "Send the shipping tracking number.", + "pt": "Enviar o número de rastreamento de envio (tracking number).", + "es": "Enviar el número de rastreo de envío (tracking number)." + } + } + ] }, - { - "title": "shipment", + "due_date": { + "type": "string", + "example": "2020-11-16T22:36:59.000-04:00", "description": { - "en": "Concerns claims related to shipping or delivery matters.", - "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", - "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." + "en": "Deadline to perform the action.", + "pt": "Prazo limite para realizar a ação.", + "es": "Tiempo límite para realizar la acción." } }, - { - "title": "purchase", + "mandatory": { + "type": "boolean", + "example": true, "description": { - "en": "Involves claims associated with the purchase process.", - "pt": "Envolve reclamações associadas ao processo de compra.", - "es": "Involucra reclamos asociados con el proceso de compra." - } - } - ] - }, - "resource_id": { - "type": "number", - "example": 7138572864, - "description": { - "en": "ID of the resource on which the claim is created and depends on the 'resource' parameter.", - "pt": "ID do recurso sobre o qual a reclamação é criada e depende do parâmetro 'resource'.", - "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro 'resource'." - } - }, - "date_created": { - "type": "string", - "example": "2018-03-08T10:35:30.000-0400", - "description": { - "en": "Date the claim was created.", - "pt": "Data em que a reclamação foi criada.", - "es": "Fecha en la que se creó el reclamo." - } - }, - "costs": { - "type": "array", - "description": { - "en": "Represents the breakdown of costs related to the coverage.", - "pt": "Representa a divisão dos custos relacionados à cobertura.", - "es": "Representa la división de los costos relacionados a la cobertura." - }, - "items": { - "type": "object", - "properties": { - "role": { - "type": "string", - "example": "respondent", - "description": { - "en": "The player in the claim responsible for the cost.", - "pt": "O 'player' da reclamação responsável pelo custo.", - "es": "El 'player' del reclamo a cargo del costo." - } - }, - "amount": { - "type": "number", - "example": 194.99, - "description": { - "en": "Amount of the cost borne by the player in the 'role' parameter.", - "pt": "Valor do custo sob responsabilidade do participante no parâmetro 'role'.", - "es": "Monto del costo a cargo del player del parámetro 'role'." - } - }, - "date_created": { - "type": "string", - "example": "2018-03-08T10:35:30.000-0400", - "description": { - "en": "Date of cost creation.", - "pt": "Data de criação do custo.", - "es": "Fecha de creación del costo." - } + "en": "This field being 'true' indicates that the action is mandatory and must be performed within the specified time.", + "pt": "Este campo como 'true' indica que a ação é obrigatória e deve ser realizada dentro do tempo informado.", + "es": "Este campo en 'true' indica que la acción es obligatoria y debe ser realizada dentro del tiempo informado." } } } } } } + } + }, + "resolution": { + "type": "object", + "description": { + "en": "Provides information about claim resolution.", + "pt": "Exibe informações sobre a resolução da reclamação.", + "es": "Presenta información sobre la resolución del reclamo." }, - "labels": { - "type": "array", - "description": { - "en": "Presents information about the labels associated with the claim, indicating, for example, whether the complaint affects the seller's reputation or not.", - "pt": "Apresenta informações sobre as estiquetas associadas à reclamação, indicando, por exemplo, se a reclamação afeta ou não a reputação do vendedor.", - "es": "Presenta información sobre las etiquetas asociadas al reclamo, indicando, por ejemplo, si la reclamación afecta o no la reputación del vendedor." + "properties": { + "reason": { + "type": "string", + "example": "already_shipped", + "description": { + "en": "Reason for resolution/closure.", + "pt": "Motivo de resolução/encerramento.", + "es": "Motivo de resolucion/cierre." + } }, - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "reputation", - "description": { - "en": "Name of the label associated with the claim.", - "pt": "Nome da etiqueta associada à reclamação.", - "es": "Nombre de la etiqueta asociada al reclamo." - } - }, - "value": { - "type": "string", - "example": "avoid", - "description": { - "en": "Value of the label.", - "pt": "Valor da etiqueta.", - "es": "Valor de la etiqueta." - } - }, - "admin_id": { - "type": "string", - "example": null, - "description": { - "en": "ID of the user managing the claim and who associated the label.", - "pt": "ID da pessoa usuária que está administrando a reclamação e associou a etiqueta.", - "es": "ID de la persona usuaria que está gestionando el reclamo y ha asociado la etiqueta." - } - }, - "date_created": { - "type": "string", - "example": "2018-03-08T09:56:00.078-0400", - "description": { - "en": "Date on which the label was associated with the claim.", - "pt": "Data em que a etiqueta foi associada à reclamação.", - "es": "Fecha en que la etiqueta fue asociada al reclamo." - } + "date_created": { + "type": "string", + "example": "2020-10-02T01:12:31.000-04:00", + "description": { + "en": "Date of resolution/closure of the claim.", + "pt": "Data de resolução/encerramento da reclamação.", + "es": "Fecha de la resolucion/cierre del reclamo." + } + }, + "decision": { + "type": "array", + "items": { + "type": "string", + "example": "complainant", + "description": { + "en": "Person who defined the resolution of the claim.", + "pt": "Pessoa que definiu a resolução da reclamação.", + "es": "Persona que definió la resolución del reclamo." } } + }, + "closed_by": { + "type": "string", + "example": "mediator", + "description": { + "en": "Person who closed the claim.", + "pt": "Pessoa que encerrou a reclamação.", + "es": "Persona que cerró el reclamo." + } } + } + }, + "site_id": { + "type": "string", + "example": "MLA", + "description": { + "en": "ID of the site where the claim occurs.", + "pt": "ID do site em que ocorre a reclamação.", + "es": "ID del sitio donde se desarrolla el reclamo." }, - "site_id": { - "type": "string", - "example": "MLA", - "description": { - "en": "ID of the site where the claim occurs.", - "pt": "ID do site em que ocorre a reclamação.", - "es": "ID del sitio donde se desarrolla el reclamo." + "enum": [ + { + "title": "MCO", + "description": { + "en": "Mercado Libre Colombia", + "pt": "Mercado Livre Colômbia", + "es": "Mercado Libre Colombia" + } }, - "enum": [ - { - "title": "MCO", - "description": { - "en": "Mercado Libre Colombia", - "pt": "Mercado Livre Colômbia", - "es": "Mercado Libre Colombia" - } - }, - { - "title": "MLA", - "description": { - "en": "Mercado Livre Argentina", - "pt": "Mercado Libre Argentina", - "es": "Mercado Libre Argentina" - } - }, - { - "title": "MLB", - "description": { - "en": "Mercado Libre Brasil", - "pt": "Mercado Livre Brasil", - "es": "Mercado Libre Brasil" - } - }, - { - "title": "MLC", - "description": { - "en": "Mercado Libre Chile", - "pt": "Mercado Livre Chile", - "es": "Mercado Libre Chile" - } - }, - { - "title": "MLM", - "description": { - "en": "Mercado Libre México", - "pt": "Mercado Livre México", - "es": "Mercado Libre México" - } - }, - { - "title": "MLU", - "description": { - "en": "Mercado Libre Uruguay", - "pt": "Mercado Livre Uruguai", - "es": "Mercado Libre Uruguay" - } - }, - { - "title": "MPE", - "description": { - "en": "Mercado Libre Perú", - "pt": "Mercado Livre Perú", - "es": "Mercado Libre Perú" - } + { + "title": "MLA", + "description": { + "en": "Mercado Livre Argentina", + "pt": "Mercado Libre Argentina", + "es": "Mercado Libre Argentina" + } + }, + { + "title": "MLB", + "description": { + "en": "Mercado Libre Brasil", + "pt": "Mercado Livre Brasil", + "es": "Mercado Libre Brasil" + } + }, + { + "title": "MLC", + "description": { + "en": "Mercado Libre Chile", + "pt": "Mercado Livre Chile", + "es": "Mercado Libre Chile" + } + }, + { + "title": "MLM", + "description": { + "en": "Mercado Libre México", + "pt": "Mercado Livre México", + "es": "Mercado Libre México" + } + }, + { + "title": "MLU", + "description": { + "en": "Mercado Libre Uruguay", + "pt": "Mercado Livre Uruguai", + "es": "Mercado Libre Uruguay" + } + }, + { + "title": "MPE", + "description": { + "en": "Mercado Libre Perú", + "pt": "Mercado Livre Perú", + "es": "Mercado Libre Perú" } - ] - }, - "date_created": { - "type": "string", - "example": "2020-09-30T09:48:06.000-04:00", - "description": { - "en": "Date the claim was created.", - "pt": "Data em que a reclamação foi criada.", - "es": "Fecha en la que se creó el reclamo." - } - }, - "last_updated": { - "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", - "description": { - "en": "Date of the last update to the claim.", - "pt": "Data da última atualização da reclamação.", - "es": "Fecha de última actualización reclamo." } + ] + }, + "date_created": { + "type": "string", + "example": "2020-09-30T09:48:06.000-04:00", + "description": { + "en": "Date the claim was created.", + "pt": "Data em que a reclamação foi criada.", + "es": "Fecha en la que se creó el reclamo." + } + }, + "last_updated": { + "type": "string", + "example": "2020-10-02T01:12:31.000-04:00", + "description": { + "en": "Date of the last update to the claim.", + "pt": "Data da última atualização da reclamação.", + "es": "Fecha de última actualización reclamo." } } } } } } - }, - "title": { - "en": "Get claim details", - "pt": "Obter detalhes da reclamação", - "es": "Obtener detalles del reclamo" } + }, + "title": { + "en": "Get claim details", + "pt": "Obter detalhes da reclamação", + "es": "Obtener detalles del reclamo" } - }, - "/v1/claims/search": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows searching, through a valid token, which claims belong to a certain user", - "pt": "Este endpoint permite buscar, por meio de um token válido, quais reclamações pertencem a determinado usuário", - "es": "Este endpoint permite buscar, mediante un token válido, qué reclamos pertenecen a un usuario determinado" + } + }, + "/post-purchase/v1/claims/search": { + "get": { + "tags": [ + "checkout-pro" + ], + "description": { + "en": "This endpoint allows searching, through a valid token, which claims belong to a certain user", + "pt": "Este endpoint permite buscar, por meio de um token válido, quais reclamações pertencem a determinado usuário", + "es": "Este endpoint permite buscar, mediante un token válido, qué reclamos pertenecen a un usuario determinado" + }, + "parameters": [ + { + "in": "query", + "name": "id", + "required": false, + "schema": { + "type": "number", + "example": 5039218470 + }, + "description": { + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." + } }, - "parameters": [ - { - "in": "query", - "name": "id", - "required": false, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } + { + "in": "query", + "name": "type", + "required": false, + "schema": { + "type": "string", + "example": "mediations" }, - { - "in": "query", - "name": "type", - "required": false, - "schema": { - "type": "string", - "example": "mediations" - }, - "description": { - "en": "Defines the nature of the claim being processed. It can take one of the following values:", - "pt": "Define a natureza da reclamação em processamento. Pode assumir um dos seguintes valores:", - "es": "Define la naturaleza del reclamo que se está procesando. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "mediations", - "description": { - "en": "Refers to the process of mediating between parties in a claim.", - "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", - "es": "Se refiere al proceso de mediación entre las partes en un reclamo." - } - }, - { - "title": "cancel_purchase", - "description": { - "en": "Involves the process of cancelling a previously made purchase.", - "pt": "Envolve o processo de cancelar uma compra previamente realizada.", - "es": "Involucra el proceso de cancelar una compra previamente realizada." - } - }, - { - "title": "return", - "description": { - "en": "Pertains to the process of returning a purchased item.", - "pt": "Refere-se ao processo de devolução de um item comprado.", - "es": "Se refiere al proceso de devolver un artículo comprado." - } - }, - { - "title": "cancel_sale", - "description": { - "en": "oncerns the process of cancelling a sale that has been made.", - "pt": "Refere-se ao processo de cancelar uma venda realizada.", - "es": "Se ocupa del proceso de cancelar una venta realizada." - } - }, - { - "title": "change", - "description": { - "en": "Refers to the alteration or modification of the details or status of a claim.", - "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", - "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." - } - } - ] + "description": { + "en": "Defines the nature of the claim being processed. It can take one of the following values:", + "pt": "Define a natureza da reclamação em processamento. Pode assumir um dos seguintes valores:", + "es": "Define la naturaleza del reclamo que se está procesando. Puede tomar alguno de los siguientes valores:" }, - { - "in": "query", - "name": "stage", - "required": false, - "schema": { - "type": "string", - "example": "claim" + "enum": [ + { + "title": "mediations", + "description": { + "en": "Refers to the process of mediating between parties in a claim.", + "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", + "es": "Se refiere al proceso de mediación entre las partes en un reclamo." + } }, - "description": { - "en": "he current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", - "pt": "Fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", - "es": "La fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" + { + "title": "cancel_purchase", + "description": { + "en": "Involves the process of cancelling a previously made purchase.", + "pt": "Envolve o processo de cancelar uma compra previamente realizada.", + "es": "Involucra el proceso de cancelar una compra previamente realizada." + } }, - "enum": [ - { - "title": "claim", - "description": { - "en": "Initial stage of the claim process in which both the buyer and seller are involved.", - "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", - "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." - } - }, - { - "title": "dispute", - "description": { - "en": "Phase where the claim is under dispute or disagreement.", - "pt": "Fase em que a reclamação está em disputa ou desacordo.", - "es": "Fase donde el reclamo está en disputa o desacuerdo." - } - }, - { - "title": "recontact", - "description": { - "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", - "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", - "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." - } - }, - { - "title": "none", - "description": { - "en": "Indicates no specific stage is currently applicable.", - "pt": "Indica que nenhuma etapa específica é aplicável.", - "es": "Indica que no se aplica ninguna etapa específica." - } + { + "title": "return", + "description": { + "en": "Pertains to the process of returning a purchased item.", + "pt": "Refere-se ao processo de devolução de um item comprado.", + "es": "Se refiere al proceso de devolver un artículo comprado." } - ] - }, - { - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string", - "example": "closed" }, - "description": { - "en": "The current state of the claim, indicating whether it is open or closed. It can take one of the following values:", - "pt": "Estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", - "es": "El estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" + { + "title": "cancel_sale", + "description": { + "en": "oncerns the process of cancelling a sale that has been made.", + "pt": "Refere-se ao processo de cancelar uma venda realizada.", + "es": "Se ocupa del proceso de cancelar una venta realizada." + } }, - "enum": [ - { - "title": "opened", - "description": { - "en": "Indicates that the claim is open.", - "pt": "Indica que a reclamação está aberta.", - "es": "Indica que el reclamo está abierto." - } - }, - { - "title": "closed", - "description": { - "en": "Indicates that the claim is closed.", - "pt": "Indica que a reclamação está fechada.", - "es": "Indica que el reclamo está cerrado." - } + { + "title": "change", + "description": { + "en": "Refers to the alteration or modification of the details or status of a claim.", + "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", + "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." } - ] + } + ] + }, + { + "in": "query", + "name": "stage", + "required": false, + "schema": { + "type": "string", + "example": "claim" }, - { - "in": "query", - "name": "resource", - "required": false, - "schema": { - "type": "string", - "example": "shipment" + "description": { + "en": "he current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", + "pt": "Fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", + "es": "La fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "claim", + "description": { + "en": "Initial stage of the claim process in which both the buyer and seller are involved.", + "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", + "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." + } }, - "description": { - "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase. It can take one of the following values:", - "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra. Pode assumir um dos seguintes valores:", - "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra. Puede tomar alguno de los siguientes valores:" + { + "title": "dispute", + "description": { + "en": "Phase where the claim is under dispute or disagreement.", + "pt": "Fase em que a reclamação está em disputa ou desacordo.", + "es": "Fase donde el reclamo está en disputa o desacuerdo." + } }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Related to claims involving payment transactions.", - "pt": "Relacionado a reclamações envolvendo transações de pagamento.", - "es": "Relacionado con reclamos que involucran transacciones de pago." - } - }, - { - "title": "order", - "description": { - "en": "Pertains to claims arising from order processing issues.", - "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", - "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." - } - }, - { - "title": "shipment", - "description": { - "en": "Concerns claims related to shipping or delivery matters.", - "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", - "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." - } - }, - { - "title": "purchase", - "description": { - "en": "Involves claims associated with the purchase process.", - "pt": "Envolve reclamações associadas ao processo de compra.", - "es": "Involucra reclamos asociados con el proceso de compra." - } + { + "title": "recontact", + "description": { + "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", + "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", + "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." } - ] - }, - { - "in": "query", - "name": "resource_id", - "required": false, - "schema": { - "type": "number", - "example": 40128769543 }, - "description": { - "en": "ID of the resource on which the claim is created and depends on the previous parameter.", - "pt": "ID do recurso sobre o qual se cria a reclamação e depende do parâmetro anterior.", - "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro anterior." + { + "title": "none", + "description": { + "en": "Indicates no specific stage is currently applicable.", + "pt": "Indica que nenhuma etapa específica é aplicável.", + "es": "Indica que no se aplica ninguna etapa específica." + } } + ] + }, + { + "in": "query", + "name": "status", + "required": false, + "schema": { + "type": "string", + "example": "closed" }, - { - "in": "query", - "name": "date_created", - "required": false, - "schema": { - "type": "string", - "example": "2020-09-30T09:48:06.000-04:00" + "description": { + "en": "The current state of the claim, indicating whether it is open or closed. It can take one of the following values:", + "pt": "Estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", + "es": "El estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "opened", + "description": { + "en": "Indicates that the claim is open.", + "pt": "Indica que a reclamação está aberta.", + "es": "Indica que el reclamo está abierto." + } }, - "description": { - "en": "Date and time when the message was created, formatted in ISO 8601 standard. For example, 2020-09-30T09:48:06.000-04:00.", - "pt": "Data e hora em que a mensagem foi criada, formatada no padrão ISO 8601. Por exemplo, 2020-09-30T09:48:06.000-04:00.", - "es": "Fecha y hora en que se creó el mensaje, formateada según el estándar ISO 8601. Por ejemplo 2020-09-30T09:48:06.000-04:00." + { + "title": "closed", + "description": { + "en": "Indicates that the claim is closed.", + "pt": "Indica que a reclamação está fechada.", + "es": "Indica que el reclamo está cerrado." + } } + ] + }, + { + "in": "query", + "name": "resource", + "required": false, + "schema": { + "type": "string", + "example": "shipment" }, - { - "in": "query", - "name": "limit", - "required": false, - "schema": { - "type": "number", - "example": 5 + "description": { + "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase. It can take one of the following values:", + "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra. Pode assumir um dos seguintes valores:", + "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "payment", + "description": { + "en": "Related to claims involving payment transactions.", + "pt": "Relacionado a reclamações envolvendo transações de pagamento.", + "es": "Relacionado con reclamos que involucran transacciones de pago." + } + }, + { + "title": "order", + "description": { + "en": "Pertains to claims arising from order processing issues.", + "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", + "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." + } + }, + { + "title": "shipment", + "description": { + "en": "Concerns claims related to shipping or delivery matters.", + "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", + "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." + } }, - "description": { - "en": "Maximum number of claims to be retrieved. For example, setting this to '5' will return the top 5 claims.", - "pt": "Número máximo de reclamações a serem obtidas. Por exemplo, definir isso como '5' retornará as 5 principais reclamações.", - "es": "Número máximo de reclamos a obtener. Por ejemplo, establecer esto en '5' devolverá los 5 reclamos principales." + { + "title": "purchase", + "description": { + "en": "Involves claims associated with the purchase process.", + "pt": "Envolve reclamações associadas ao processo de compra.", + "es": "Involucra reclamos asociados con el proceso de compra." + } } + ] + }, + { + "in": "query", + "name": "resource_id", + "required": false, + "schema": { + "type": "number", + "example": 40128769543 + }, + "description": { + "en": "ID of the resource on which the claim is created and depends on the previous parameter.", + "pt": "ID do recurso sobre o qual se cria a reclamação e depende do parâmetro anterior.", + "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro anterior." } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "paging": { - "type": "object", - "description": { - "en": "Information for pagination of search results.", - "pt": "Informações para paginação dos resultados da pesquisa.", - "es": "Información para paginación de resultados de búsqueda." + }, + { + "in": "query", + "name": "date_created", + "required": false, + "schema": { + "type": "string", + "example": "2020-09-30T09:48:06.000-04:00" + }, + "description": { + "en": "Date and time when the message was created, formatted in ISO 8601 standard. For example, 2020-09-30T09:48:06.000-04:00.", + "pt": "Data e hora em que a mensagem foi criada, formatada no padrão ISO 8601. Por exemplo, 2020-09-30T09:48:06.000-04:00.", + "es": "Fecha y hora en que se creó el mensaje, formateada según el estándar ISO 8601. Por ejemplo 2020-09-30T09:48:06.000-04:00." + } + }, + { + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "number", + "example": 5 + }, + "description": { + "en": "Maximum number of claims to be retrieved. For example, setting this to '5' will return the top 5 claims.", + "pt": "Número máximo de reclamações a serem obtidas. Por exemplo, definir isso como '5' retornará as 5 principais reclamações.", + "es": "Número máximo de reclamos a obtener. Por ejemplo, establecer esto en '5' devolverá los 5 reclamos principales." + } + } + ], + "responses": { + "200": { + "description": { + "es": "Success", + "pt": "Sucesso", + "en": "Éxito" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "paging": { + "type": "object", + "description": { + "en": "Information for pagination of search results.", + "pt": "Informações para paginação dos resultados da pesquisa.", + "es": "Información para paginación de resultados de búsqueda." + }, + "properties": { + "offset": { + "type": "number", + "example": 0, + "description": { + "en": "Offset over the total set of data gathered by the search.", + "pt": "Deslocamento sobre o conjunto total de dados levantados pela busca.", + "es": "Desplazamiento sobre el conjunto total de datos levantados por la búsqueda." + } }, + "limit": { + "type": "number", + "example": 30, + "description": { + "en": "Limit of claims returned in the search.", + "pt": "Quantidade limite de reclamações que serão retornadas na busca.", + "es": "Cantidad límite de reclamos que se devolverán en la búsqueda." + } + }, + "total": { + "type": "number", + "example": 1, + "description": { + "en": "Number of claims found in the search.", + "pt": "Quantidade de reclamações encontradas na busca.", + "es": "Cantidad de reclamos encontrados en la búsqueda." + } + } + } + }, + "data": { + "type": "array", + "description": { + "en": "Presents the data of the complaint.", + "pt": "Exibe os dados da reclamação.", + "es": "Presenta los datos de la reclamación." + }, + "items": { + "type": "object", "properties": { - "offset": { + "id": { "type": "number", - "example": 0, + "example": 5033102536, "description": { - "en": "Offset over the total set of data gathered by the search.", - "pt": "Deslocamento sobre o conjunto total de dados levantados pela busca.", - "es": "Desplazamiento sobre el conjunto total de datos levantados por la búsqueda." + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." } }, - "limit": { + "resource_id": { "type": "number", - "example": 30, + "example": 7138572864, "description": { - "en": "Limit of claims returned in the search.", - "pt": "Quantidade limite de reclamações que serão retornadas na busca.", - "es": "Cantidad límite de reclamos que se devolverán en la búsqueda." + "en": "ID of the resource on which the claim is created and depends on the 'resource' parameter.", + "pt": "ID do recurso sobre o qual a reclamação é criada e depende do parâmetro 'resource'.", + "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro 'resource'." } }, - "total": { - "type": "number", - "example": 1, + "status": { + "type": "string", + "example": "closed", "description": { - "en": "Number of claims found in the search.", - "pt": "Quantidade de reclamações encontradas na busca.", - "es": "Cantidad de reclamos encontrados en la búsqueda." - } - } - } - }, - "data": { - "type": "array", - "description": { - "en": "Presents the data of the complaint.", - "pt": "Exibe os dados da reclamação.", - "es": "Presenta los datos de la reclamación." - }, - "items": { - "type": "object", - "properties": { - "id": { - "type": "number", - "example": 5033102536, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } + "en": "Specifies the current state of the claim, indicating whether it is open or closed. It can take one of the following values:", + "pt": "Especifica o estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", + "es": "Especifica el estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" }, - "type": { - "type": "string", - "example": "mediations", - "description": { - "en": "Defines the nature of the claim being processed. It can take one of the following values:", - "pt": "Define a natureza da reclamação em processamento. Pode assumir um dos seguintes valores:", - "es": "Define la naturaleza del reclamo que se está procesando. Puede tomar alguno de los siguientes valores:" + "enum": [ + { + "title": "opened", + "description": { + "en": "Indicates that the claim is open.", + "pt": "Indica que a reclamação está aberta.", + "es": "Indica que el reclamo está abierto." + } }, - "enum": [ - { - "title": "mediations", - "description": { - "en": "Refers to the process of mediating between parties in a claim.", - "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", - "es": "Se refiere al proceso de mediación entre las partes en un reclamo." - } - }, - { - "title": "cancel_purchase", - "description": { - "en": "Involves the process of cancelling a previously made purchase.", - "pt": "Envolve o processo de cancelar uma compra previamente realizada.", - "es": "Involucra el proceso de cancelar una compra previamente realizada." - } - }, - { - "title": "return", - "description": { - "en": "Pertains to the process of returning a purchased item.", - "pt": "Refere-se ao processo de devolução de um item comprado.", - "es": "Se refiere al proceso de devolver un artículo comprado." - } - }, - { - "title": "cancel_sale", - "description": { - "en": "oncerns the process of cancelling a sale that has been made.", - "pt": "Refere-se ao processo de cancelar uma venda realizada.", - "es": "Se ocupa del proceso de cancelar una venta realizada." - } - }, - { - "title": "change", - "description": { - "en": "Refers to the alteration or modification of the details or status of a claim.", - "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", - "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." - } + { + "title": "closed", + "description": { + "en": "Indicates that the claim is closed.", + "pt": "Indica que a reclamação está fechada.", + "es": "Indica que el reclamo está cerrado." } - ] + } + ] + }, + "type": { + "type": "string", + "example": "mediations", + "description": { + "en": "Defines the nature of the claim being processed. It can take one of the following values:", + "pt": "Define a natureza da reclamação em processamento. Pode assumir um dos seguintes valores:", + "es": "Define la naturaleza del reclamo que se está procesando. Puede tomar alguno de los siguientes valores:" }, - "stage": { - "type": "string", - "example": "dispute", - "description": { - "en": "Indicates the current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", - "pt": "Indica a fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", - "es": "Indica la fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" + "enum": [ + { + "title": "mediations", + "description": { + "en": "Refers to the process of mediating between parties in a claim.", + "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", + "es": "Se refiere al proceso de mediación entre las partes en un reclamo." + } }, - "enum": [ - { - "title": "claim", - "description": { - "en": "Initial stage of the claim process in which both the buyer and seller are involved.", - "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", - "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." - } - }, - { - "title": "dispute", - "description": { - "en": "Phase where the claim is under dispute or disagreement.", - "pt": "Fase em que a reclamação está em disputa ou desacordo.", - "es": "Fase donde el reclamo está en disputa o desacuerdo." - } - }, - { - "title": "recontact", - "description": { - "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", - "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", - "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." - } - }, - { - "title": "none", - "description": { - "en": "Indicates no specific stage is currently applicable.", - "pt": "Indica que nenhuma etapa específica é aplicável.", - "es": "Indica que no se aplica ninguna etapa específica." - } + { + "title": "cancel_purchase", + "description": { + "en": "Involves the process of cancelling a previously made purchase.", + "pt": "Envolve o processo de cancelar uma compra previamente realizada.", + "es": "Involucra el proceso de cancelar una compra previamente realizada." } - ] - }, - "status": { - "type": "string", - "example": "closed", - "description": { - "en": "Specifies the current state of the claim, indicating whether it is open or closed. It can take one of the following values:", - "pt": "Especifica o estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", - "es": "Especifica el estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" }, - "enum": [ - { - "title": "opened", - "description": { - "en": "Indicates that the claim is open.", - "pt": "Indica que a reclamação está aberta.", - "es": "Indica que el reclamo está abierto." - } - }, - { - "title": "closed", - "description": { - "en": "Indicates that the claim is closed.", - "pt": "Indica que a reclamação está fechada.", - "es": "Indica que el reclamo está cerrado." - } + { + "title": "return", + "description": { + "en": "Pertains to the process of returning a purchased item.", + "pt": "Refere-se ao processo de devolução de um item comprado.", + "es": "Se refiere al proceso de devolver un artículo comprado." + } + }, + { + "title": "cancel_sale", + "description": { + "en": "oncerns the process of cancelling a sale that has been made.", + "pt": "Refere-se ao processo de cancelar uma venda realizada.", + "es": "Se ocupa del proceso de cancelar una venta realizada." + } + }, + { + "title": "change", + "description": { + "en": "Refers to the alteration or modification of the details or status of a claim.", + "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", + "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." } - ] - }, - "parent_id": { - "type": "string", - "example": null, - "description": { - "en": "ID of another claim on which it depends.", - "pt": "ID de outra reclamação da qual esta depende.", - "es": "ID de otro reclamo del que depende." - } - }, - "client_id": { - "type": "number", - "example": 1569196570216262, - "description": { - "en": "ID of the app that created the claim.", - "pt": "ID do aplicativo que criou a reclamação.", - "es": "ID de la app que creo el reclamo" - } - }, - "resource_id": { - "type": "number", - "example": 7138572864, - "description": { - "en": "ID of the resource on which the claim is created and depends on the 'resource' parameter.", - "pt": "ID do recurso sobre o qual a reclamação é criada e depende do parâmetro 'resource'.", - "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro 'resource'." } + ] + }, + "stage": { + "type": "string", + "example": "dispute", + "description": { + "en": "Indicates the current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", + "pt": "Indica a fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", + "es": "Indica la fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" }, - "resource": { - "type": "string", - "example": "shipment", - "description": { - "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase.", - "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra.", - "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra." + "enum": [ + { + "title": "claim", + "description": { + "en": "Initial stage of the claim process in which both the buyer and seller are involved.", + "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", + "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." + } }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Related to claims involving payment transactions.", - "pt": "Relacionado a reclamações envolvendo transações de pagamento.", - "es": "Relacionado con reclamos que involucran transacciones de pago." - } - }, - { - "title": "order", - "description": { - "en": "Pertains to claims arising from order processing issues.", - "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", - "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." - } - }, - { - "title": "shipment", - "description": { - "en": "Concerns claims related to shipping or delivery matters.", - "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", - "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." - } - }, - { - "title": "purchase", - "description": { - "en": "Involves claims associated with the purchase process.", - "pt": "Envolve reclamações associadas ao processo de compra.", - "es": "Involucra reclamos asociados con el proceso de compra." - } + { + "title": "dispute", + "description": { + "en": "Phase where the claim is under dispute or disagreement.", + "pt": "Fase em que a reclamação está em disputa ou desacordo.", + "es": "Fase donde el reclamo está en disputa o desacuerdo." } - ] - }, - "reason_id": { - "type": "string", - "example": "PNR4071", - "description": { - "en": "Reason ID of the claim. A claim can be created for three general reasons:", - "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", - "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" }, - "enum": [ - { - "title": "PNR", - "description": { - "en": "Product not received.", - "pt": "Produto não recebido.", - "es": "Producto no recibido." - } - }, - { - "title": "PDD", - "description": { - "en": "Different or defective product.", - "pt": "Produto diferente ou defeituoso", - "es": "Producto diferente o defectuoso." - } - }, - { - "title": "CS", - "description": { - "en": "Purchase cancellation.", - "pt": "Cancelamento de compra.", - "es": "Cancelación de la compra." - } + { + "title": "recontact", + "description": { + "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", + "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", + "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." + } + }, + { + "title": "none", + "description": { + "en": "Indicates no specific stage is currently applicable.", + "pt": "Indica que nenhuma etapa específica é aplicável.", + "es": "Indica que no se aplica ninguna etapa específica." } - ] + } + ] + }, + "parent_id": { + "type": "string", + "example": null, + "description": { + "en": "ID of another claim on which it depends.", + "pt": "ID de outra reclamação da qual esta depende.", + "es": "ID de otro reclamo del que depende." + } + }, + "resource": { + "type": "string", + "example": "shipment", + "description": { + "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase.", + "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra.", + "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra." }, - "quantity_type": { - "type": "string", - "example": "total", - "description": { - "en": "Indica si una devolución corresponde a todos los productos de la orden o solo algunos. Inicialmente sólo mostrará el valor 'total' y en el futuro se visualizará el valor 'partial'.", - "pt": "Indica se um reembolso corresponde a todos os produtos do pedido ou apenas alguns. Inicialmente, mostrará apenas o valor 'total' e, no futuro, será exibido o valor 'partial'.", - "es": "Indicates whether a return corresponds to all products in the order or only some. Initially, it will only show the value 'total', and in the future, the value 'partial' will be displayed." + "enum": [ + { + "title": "payment", + "description": { + "en": "Related to claims involving payment transactions.", + "pt": "Relacionado a reclamações envolvendo transações de pagamento.", + "es": "Relacionado con reclamos que involucran transacciones de pago." + } + }, + { + "title": "order", + "description": { + "en": "Pertains to claims arising from order processing issues.", + "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", + "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." + } + }, + { + "title": "shipment", + "description": { + "en": "Concerns claims related to shipping or delivery matters.", + "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", + "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." + } + }, + { + "title": "purchase", + "description": { + "en": "Involves claims associated with the purchase process.", + "pt": "Envolve reclamações associadas ao processo de compra.", + "es": "Involucra reclamos asociados con el proceso de compra." + } } + ] + }, + "reason_id": { + "type": "string", + "example": "PNR4071", + "description": { + "en": "Reason ID of the claim. A claim can be created for three general reasons:", + "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", + "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" }, - "players": { - "type": "array", - "description": { - "en": "People who are participating in the complaint.", - "pt": "Pessoas que estão participando da reclamação.", - "es": "Personas que están participando en el reclamo." + "enum": [ + { + "title": "PNR", + "description": { + "en": "Product not received.", + "pt": "Produto não recebido.", + "es": "Producto no recibido." + } }, - "items": { - "type": "object", - "properties": { - "role": { - "type": "string", - "example": "mediator", - "description": { - "en": "Indicates the person's role within the claim. It can take one of the following values:", - "pt": "Indica o papel da pessoa dentro da reclamação. Pode assumir um dos seguintes valores:", - "es": "Indica el rol de la persona dentro del reclamo. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "complainant", - "description": { - "en": "Person who claims", - "pt": "Pessoa que reclama.", - "es": "Persona que reclama." - } - }, - { - "title": "respondent", - "description": { - "en": "Person to whom they are complaining.", - "pt": "Pessoa a quem estão reclamando.", - "es": "Persona a quién le reclaman." - } - }, - { - "title": "mediator", - "description": { - "en": "Person who intervenes to help solve the problem.", - "pt": "Pessoa que intervém para ajudar a resolver o problema.", - "es": "Persona que interviene para ayudar a solucionar el problema." - } - } - ] - }, - "type": { - "type": "string", - "example": "payer", - "description": { - "en": "Role that the person occupies in the operation that is being claimed and may vary according to the 'resource'. It can take one of the following values:", - "pt": "Papel que a pessoa ocupa na operação que está sendo reivindicada e pode variar de acordo com o 'resource'. Pode assumir um dos seguintes valores:", - "es": "Rol que ocupa la persona sobre la operación que se está reclamando y puede variar de acuerdo con el 'resource'. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Indicates that the person is the buyer or collector.", - "pt": "Indica que a pessoa é compradora ou cobradora.", - "es": "Indica que la persona es el comprador o collector." - } - }, - { - "title": "order", - "description": { - "en": "Indicates that the person is the buyer or seller.", - "pt": "Indica que a pessoa é compradora ou vendedora.", - "es": "Indica que la persona es el comprador o vendedor." - } - }, - { - "title": "shipment", - "description": { - "en": "Indicates that the person is the receiver or sender.", - "pt": "Indica que a pessoa é o destinatário ou remetente.", - "es": "Indica que la persona es el receptor o remitente." - } - } - ] - }, - "user_id": { - "type": "number", - "example": 242829175, - "description": { - "en": "ID of the 'type' indicated in the previous parameter.", - "pt": "ID do 'type' indicado no parâmetro anterior.", - "es": "ID del 'type' indicado en el parámetro anterior." - } - }, - "available_actions": { - "type": "array", - "description": { - "en": "Provides information about the actions that each of the involved parties can execute.", - "pt": "Exibe informações sobre as ações que cada uma das partes envolvidas pode executar.", - "es": "Presenta información sobre las acciones que pueden ejecutar cada una de las partes intervinientes." - }, - "items": { - "type": "object", - "properties": { - "action": { - "type": "string", - "example": "recontact", - "description": { - "es": "List of actions that each of the involved parties can execute.", - "pt": "Lista de ações que cada uma das partes envolvidas pode executar.", - "en": "Lista de acciones que pueden ejecutar cada una de las partes intervinientes." - }, - "enum": [ - { - "title": "send_message_to_complainant", - "description": { - "en": "Send a message to the buyer (with or without attachments).", - "pt": "Enviar mensagem para o comprador (com ou sem anexos).", - "es": "Enviar mensaje para el comprador (con o sin anexos)." - } - }, - { - "title": "send_message_to_mediator", - "description": { - "en": "Send a message to the mediator (with or without attachments).", - "pt": "Enviar mensagem para o mediador (com ou sem anexos).", - "es": "Enviar mensaje para el mediador (con o sin anexos)." - } - }, - { - "title": "recontact (no disponible aún)", - "description": { - "en": "Reopen a closed complaint through an interaction, such as a message.", - "pt": "Reabrir uma reclamação já fechada, por meio de uma interação, como uma mensagem.", - "es": "Reabrir un reclamo ya cerrado, por medio de una interacción, como un mensaje." - } - }, - { - "title": "refund", - "description": { - "en": "Refund the buyer's money. Must be performed by the Mercado Pago front end.", - "pt": "Devolver o dinheiro do comprador. Deve ser realizado pelo front do Mercado Pago.", - "es": "Devolver el dinero del comprado. Debe ser realizado por el front de Mercado Pago." - } - }, - { - "title": "open_dispute", - "description": { - "en": "Initiate mediation.", - "pt": "Iniciar uma mediação.", - "es": "Iniciar una mediación." - } - }, - { - "title": "send_potential_shipping", - "description": { - "en": "Send a promise of shipment, indicating a date.", - "pt": "Enviar uma promessa de postagem, indicando uma data.", - "es": "Enviar una promesa de post, indicando una fecha." - } - }, - { - "title": "add_shipping_evidence", - "description": { - "en": "Publish evidence that the product has been shipped.", - "pt": "Publicar uma evidência de que o produto foi enviado.", - "es": "Publicar una evidencia de que el producto fue enviado." - } - }, - { - "title": "send_attachments", - "description": { - "en": "Send message with attached images.", - "pt": "Enviar mensagem com imagens anexadas.", - "es": "Enviar mensaje con imágenes adjuntas." - } - }, - { - "title": "allow_return_label", - "description": { - "en": "Generate a return label.", - "pt": "Gerar etiqueta de devolução.", - "es": "Generar etiqueta de devolución." - } - }, - { - "title": "send_tracking_number", - "description": { - "en": "Send the shipping tracking number.", - "pt": "Enviar o número de rastreamento de envio (tracking number).", - "es": "Enviar el número de rastreo de envío (tracking number)." - } - } - ] - }, - "due_date": { - "type": "string", - "example": "2020-11-16T22:36:59.000-04:00", - "description": { - "en": "Deadline to perform the action.", - "pt": "Prazo limite para realizar a ação.", - "es": "Tiempo límite para realizar la acción." - } - }, - "mandatory": { - "type": "boolean", - "example": true, - "description": { - "en": "This field being 'true' indicates that the action is mandatory and must be performed within the specified time.", - "pt": "Este campo como 'true' indica que a ação é obrigatória e deve ser realizada dentro do tempo informado.", - "es": "Este campo en 'true' indica que la acción es obligatoria y debe ser realizada dentro del tiempo informado." - } - } - } - } - } + { + "title": "PDD", + "description": { + "en": "Different or defective product.", + "pt": "Produto diferente ou defeituoso", + "es": "Producto diferente o defectuoso." + } + }, + { + "title": "CS", + "description": { + "en": "Purchase cancellation.", + "pt": "Cancelamento de compra.", + "es": "Cancelación de la compra." } } + ] + }, + "fulfilled": { + "type": "boolean", + "example": true, + "description": { + "en": "Indicate whether the claim is for a delivered or undelivered product.", + "pt": "Indique se o reclamação é sobre um produto entregue ou não entregue.", + "es": "Indica si el reclamo se inicia por un producto entregado o no." + } + }, + "quantity_type": { + "type": "string", + "example": "total", + "description": { + "en": "Indica si una devolución corresponde a todos los productos de la orden o solo algunos. Inicialmente sólo mostrará el valor 'total' y en el futuro se visualizará el valor 'partial'.", + "pt": "Indica se um reembolso corresponde a todos os produtos do pedido ou apenas alguns. Inicialmente, mostrará apenas o valor 'total' e, no futuro, será exibido o valor 'partial'.", + "es": "Indicates whether a return corresponds to all products in the order or only some. Initially, it will only show the value 'total', and in the future, the value 'partial' will be displayed." + } + }, + "players": { + "type": "array", + "description": { + "en": "People who are participating in the complaint.", + "pt": "Pessoas que estão participando da reclamação.", + "es": "Personas que están participando en el reclamo." }, - "resolution": { + "items": { "type": "object", - "description": { - "en": "Provides information about claim resolution.", - "pt": "Exibe informações sobre a resolução da reclamação.", - "es": "Presenta información sobre la resolución del reclamo." - }, "properties": { - "reason": { + "role": { "type": "string", - "example": "already_shipped", + "example": "mediator", "description": { - "en": "Reason for resolution/closure.", - "pt": "Motivo de resolução/encerramento.", - "es": "Motivo de resolucion/cierre." - } + "en": "Indicates the person's role within the claim. It can take one of the following values:", + "pt": "Indica o papel da pessoa dentro da reclamação. Pode assumir um dos seguintes valores:", + "es": "Indica el rol de la persona dentro del reclamo. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "complainant", + "description": { + "en": "Person who claims", + "pt": "Pessoa que reclama.", + "es": "Persona que reclama." + } + }, + { + "title": "respondent", + "description": { + "en": "Person to whom they are complaining.", + "pt": "Pessoa a quem estão reclamando.", + "es": "Persona a quién le reclaman." + } + }, + { + "title": "mediator", + "description": { + "en": "Person who intervenes to help solve the problem.", + "pt": "Pessoa que intervém para ajudar a resolver o problema.", + "es": "Persona que interviene para ayudar a solucionar el problema." + } + } + ] }, - "date_created": { + "type": { "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", + "example": "payer", "description": { - "en": "Date of resolution/closure of the claim.", - "pt": "Data de resolução/encerramento da reclamação.", - "es": "Fecha de la resolucion/cierre del reclamo." - } + "en": "Role that the person occupies in the operation that is being claimed and may vary according to the 'resource'. It can take one of the following values:", + "pt": "Papel que a pessoa ocupa na operação que está sendo reivindicada e pode variar de acordo com o 'resource'. Pode assumir um dos seguintes valores:", + "es": "Rol que ocupa la persona sobre la operación que se está reclamando y puede variar de acuerdo con el 'resource'. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "payment", + "description": { + "en": "Indicates that the person is the buyer or collector.", + "pt": "Indica que a pessoa é compradora ou cobradora.", + "es": "Indica que la persona es el comprador o collector." + } + }, + { + "title": "order", + "description": { + "en": "Indicates that the person is the buyer or seller.", + "pt": "Indica que a pessoa é compradora ou vendedora.", + "es": "Indica que la persona es el comprador o vendedor." + } + }, + { + "title": "shipment", + "description": { + "en": "Indicates that the person is the receiver or sender.", + "pt": "Indica que a pessoa é o destinatário ou remetente.", + "es": "Indica que la persona es el receptor o remitente." + } + } + ] }, - "benefited": { - "type": "string", - "example": "complainant", + "user_id": { + "type": "number", + "example": 242829175, "description": { - "en": "It will indicate who will benefit from resolving the claim.", - "pt": "Indicará quem for beneficiado pela resolução da reclamação.", - "es": "Indicará quién se beneficiará de resolver el reclamo." + "en": "ID of the 'type' indicated in the previous parameter.", + "pt": "ID do 'type' indicado no parâmetro anterior.", + "es": "ID del 'type' indicado en el parámetro anterior." } }, - "closed_by": { - "type": "string", - "example": "mediator", + "available_actions": { + "type": "array", "description": { - "en": "Person who closed the claim.", - "pt": "Pessoa que encerrou a reclamação.", - "es": "Persona que cerró el reclamo." + "en": "Provides information about the actions that each of the involved parties can execute.", + "pt": "Exibe informações sobre as ações que cada uma das partes envolvidas pode executar.", + "es": "Presenta información sobre las acciones que pueden ejecutar cada una de las partes intervinientes." + }, + "items": { + "type": "object", + "properties": { + "action": { + "type": "string", + "example": "recontact", + "description": { + "es": "List of actions that each of the involved parties can execute.", + "pt": "Lista de ações que cada uma das partes envolvidas pode executar.", + "en": "Lista de acciones que pueden ejecutar cada una de las partes intervinientes." + }, + "enum": [ + { + "title": "send_message_to_complainant", + "description": { + "en": "Send a message to the buyer (with or without attachments).", + "pt": "Enviar mensagem para o comprador (com ou sem anexos).", + "es": "Enviar mensaje para el comprador (con o sin anexos)." + } + }, + { + "title": "send_message_to_mediator", + "description": { + "en": "Send a message to the mediator (with or without attachments).", + "pt": "Enviar mensagem para o mediador (com ou sem anexos).", + "es": "Enviar mensaje para el mediador (con o sin anexos)." + } + }, + { + "title": "recontact (no disponible aún)", + "description": { + "en": "Reopen a closed complaint through an interaction, such as a message.", + "pt": "Reabrir uma reclamação já fechada, por meio de uma interação, como uma mensagem.", + "es": "Reabrir un reclamo ya cerrado, por medio de una interacción, como un mensaje." + } + }, + { + "title": "refund", + "description": { + "en": "Refund the buyer's money. Must be performed by the Mercado Pago front end.", + "pt": "Devolver o dinheiro do comprador. Deve ser realizado pelo front do Mercado Pago.", + "es": "Devolver el dinero del comprado. Debe ser realizado por el front de Mercado Pago." + } + }, + { + "title": "open_dispute", + "description": { + "en": "Initiate mediation.", + "pt": "Iniciar uma mediação.", + "es": "Iniciar una mediación." + } + }, + { + "title": "send_potential_shipping", + "description": { + "en": "Send a promise of shipment, indicating a date.", + "pt": "Enviar uma promessa de postagem, indicando uma data.", + "es": "Enviar una promesa de post, indicando una fecha." + } + }, + { + "title": "add_shipping_evidence", + "description": { + "en": "Publish evidence that the product has been shipped.", + "pt": "Publicar uma evidência de que o produto foi enviado.", + "es": "Publicar una evidencia de que el producto fue enviado." + } + }, + { + "title": "send_attachments", + "description": { + "en": "Send message with attached images.", + "pt": "Enviar mensagem com imagens anexadas.", + "es": "Enviar mensaje con imágenes adjuntas." + } + }, + { + "title": "allow_return_label", + "description": { + "en": "Generate a return label.", + "pt": "Gerar etiqueta de devolução.", + "es": "Generar etiqueta de devolución." + } + }, + { + "title": "send_tracking_number", + "description": { + "en": "Send the shipping tracking number.", + "pt": "Enviar o número de rastreamento de envio (tracking number).", + "es": "Enviar el número de rastreo de envío (tracking number)." + } + } + ] + }, + "due_date": { + "type": "string", + "example": "2020-11-16T22:36:59.000-04:00", + "description": { + "en": "Deadline to perform the action.", + "pt": "Prazo limite para realizar a ação.", + "es": "Tiempo límite para realizar la acción." + } + }, + "mandatory": { + "type": "boolean", + "example": true, + "description": { + "en": "This field being 'true' indicates that the action is mandatory and must be performed within the specified time.", + "pt": "Este campo como 'true' indica que a ação é obrigatória e deve ser realizada dentro do tempo informado.", + "es": "Este campo en 'true' indica que la acción es obligatoria y debe ser realizada dentro del tiempo informado." + } + } + } } } } + } + }, + "resolution": { + "type": "object", + "description": { + "en": "Provides information about claim resolution.", + "pt": "Exibe informações sobre a resolução da reclamação.", + "es": "Presenta información sobre la resolución del reclamo." }, - "site_id": { - "type": "string", - "example": "MLA", - "description": { - "en": "ID of the site where the claim occurs.", - "pt": "ID do site em que ocorre a reclamação.", - "es": "ID del sitio donde se desarrolla el reclamo." + "properties": { + "reason": { + "type": "string", + "example": "already_shipped", + "description": { + "en": "Reason for resolution/closure.", + "pt": "Motivo de resolução/encerramento.", + "es": "Motivo de resolucion/cierre." + } }, - "enum": [ - { - "title": "MCO", - "description": { - "en": "Mercado Libre Colombia", - "pt": "Mercado Livre Colômbia", - "es": "Mercado Libre Colombia" - } - }, - { - "title": "MLA", - "description": { - "en": "Mercado Livre Argentina", - "pt": "Mercado Libre Argentina", - "es": "Mercado Libre Argentina" - } - }, - { - "title": "MLB", - "description": { - "en": "Mercado Libre Brasil", - "pt": "Mercado Livre Brasil", - "es": "Mercado Libre Brasil" - } - }, - { - "title": "MLC", - "description": { - "en": "Mercado Libre Chile", - "pt": "Mercado Livre Chile", - "es": "Mercado Libre Chile" - } - }, - { - "title": "MLM", - "description": { - "en": "Mercado Libre México", - "pt": "Mercado Livre México", - "es": "Mercado Libre México" - } - }, - { - "title": "MLU", - "description": { - "en": "Mercado Libre Uruguay", - "pt": "Mercado Livre Uruguai", - "es": "Mercado Libre Uruguay" - } - }, - { - "title": "MPE", - "description": { - "en": "Mercado Libre Perú", - "pt": "Mercado Livre Perú", - "es": "Mercado Libre Perú" - } + "date_created": { + "type": "string", + "example": "2020-10-02T01:12:31.000-04:00", + "description": { + "en": "Date of resolution/closure of the claim.", + "pt": "Data de resolução/encerramento da reclamação.", + "es": "Fecha de la resolucion/cierre del reclamo." + } + }, + "benefited": { + "type": "string", + "example": "complainant", + "description": { + "en": "It will indicate who will benefit from resolving the claim.", + "pt": "Indicará quem for beneficiado pela resolução da reclamação.", + "es": "Indicará quién se beneficiará de resolver el reclamo." + } + }, + "closed_by": { + "type": "string", + "example": "mediator", + "description": { + "en": "Person who closed the claim.", + "pt": "Pessoa que encerrou a reclamação.", + "es": "Persona que cerró el reclamo." } - ] - }, - "date_created": { - "type": "string", - "example": "2020-09-30T09:48:06.000-04:00", - "description": { - "en": "Date the claim was created.", - "pt": "Data em que a reclamação foi criada.", - "es": "Fecha en la que se creó el reclamo." } + } + }, + "site_id": { + "type": "string", + "example": "MLA", + "description": { + "en": "ID of the site where the claim occurs.", + "pt": "ID do site em que ocorre a reclamação.", + "es": "ID del sitio donde se desarrolla el reclamo." }, - "last_updated": { - "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", - "description": { - "en": "Date of the last update to the claim.", - "pt": "Data da última atualização da reclamação.", - "es": "Fecha de última actualización reclamo." + "enum": [ + { + "title": "MCO", + "description": { + "en": "Mercado Libre Colombia", + "pt": "Mercado Livre Colômbia", + "es": "Mercado Libre Colombia" + } + }, + { + "title": "MLA", + "description": { + "en": "Mercado Livre Argentina", + "pt": "Mercado Libre Argentina", + "es": "Mercado Libre Argentina" + } + }, + { + "title": "MLB", + "description": { + "en": "Mercado Libre Brasil", + "pt": "Mercado Livre Brasil", + "es": "Mercado Libre Brasil" + } + }, + { + "title": "MLC", + "description": { + "en": "Mercado Libre Chile", + "pt": "Mercado Livre Chile", + "es": "Mercado Libre Chile" + } + }, + { + "title": "MLM", + "description": { + "en": "Mercado Libre México", + "pt": "Mercado Livre México", + "es": "Mercado Libre México" + } + }, + { + "title": "MLU", + "description": { + "en": "Mercado Libre Uruguay", + "pt": "Mercado Livre Uruguai", + "es": "Mercado Libre Uruguay" + } + }, + { + "title": "MPE", + "description": { + "en": "Mercado Libre Perú", + "pt": "Mercado Livre Perú", + "es": "Mercado Libre Perú" + } } + ] + }, + "date_created": { + "type": "string", + "example": "2020-09-30T09:48:06.000-04:00", + "description": { + "en": "Date the claim was created.", + "pt": "Data em que a reclamação foi criada.", + "es": "Fecha en la que se creó el reclamo." } + }, + "last_updated": { + "type": "string", + "example": "2020-10-02T01:12:31.000-04:00", + "description": { + "en": "Date of the last update to the claim.", + "pt": "Data da última atualização da reclamação.", + "es": "Fecha de última actualización reclamo." + } + } + } + } + } + } + } + } + } + } + }, + "title": { + "en": "Claims search", + "pt": "Buscar reclamações", + "es": "Buscar reclamos" + } + } + }, + "/post-purchase/v1/claims/{claim_id}/messages": { + "get": { + "tags": [ + "checkout-pro" + ], + "description": { + "en": "This endpoint allows searching, through a valid token, messages associated with a claim", + "pt": "Este endpoint permite buscar, por meio de um token válido, as mensagens associados a uma reclamação", + "es": "Este endpoint permite buscar, mediante un token válido, los mensajes asociados a un reclamo" + }, + "parameters": [ + { + "in": "path", + "name": "claim_id", + "required": true, + "schema": { + "type": "number", + "example": 5039218470 + }, + "description": { + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." + } + } + ], + "responses": { + "200": { + "description": { + "es": "Success", + "pt": "Sucesso", + "en": "Éxito" + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sender_role": { + "type": "string", + "example": "complainant", + "description": { + "en": "Person who sent the message associated with the claim.", + "pt": "Pessoa que enviou a mensagem que está associada à reclamação.", + "es": "Persona que envió el mensaje asociado a la reclamación." + } + }, + "receiver_role": { + "type": "string", + "example": "respondent", + "description": { + "en": "Person to whom the message associated with the complaint was sent.", + "pt": "Pessoa para quem a mensagem associada à reclamação foi enviada.", + "es": "Persona a la que se envió el mensaje asociado al reclamo." + } + }, + "message": { + "type": "string", + "example": "Boa noite! A tampa veio com uma rachadura. Gostaria de anexar foto", + "description": { + "en": "Displays the message text associated with the complaim.", + "pt": "Exibe o texto da mensagem associada à reclamação.", + "es": "Muestra el texto del mensaje asociado con el reclamo." + } + }, + "translated_message": { + "type": "string", + "example": null, + "description": { + "en": "This displays the translated text of the message associated with the complaint.", + "pt": "Exibe o texto traduzido da mensagem associada à reclamação.", + "es": "Esto muestra el texto traducido del mensaje asociado con el reclamo" + } + }, + "date_created": { + "type": "string", + "example": "2020-09-30T09:48:06.000-04:00", + "description": { + "en": "Date the message was created.", + "pt": "Data em que a messagem foi criada.", + "es": "Fecha en que se creó el mensaje." + } + }, + "last_updated": { + "type": "string", + "example": "2020-10-02T01:12:31.000-04:00", + "description": { + "en": "Message Last Updated Date.", + "pt": "Data da última atualização da mensagem.", + "es": "Message Last Updated Date." + } + }, + "message_date": { + "type": "string", + "example": "2020-10-02T01:12:31.000-04:00", + "description": { + "en": "Date the message was sent.", + "pt": "Data que a mensagem foi enviada.", + "es": "Fecha en la que se envió el mensaje" + } + }, + "date_read": { + "type": "string", + "example": "2020-10-02T01:12:31.000-04:00", + "description": { + "en": "Date the message was read.", + "pt": "Data que a mensagem foi lida.", + "es": "Fecha en que se leyó el mensaje." + } + }, + "attachments": { + "type": "array", + "description": { + "en": "Presents information about the file attached to the message associated with the claim.", + "pt": "Apresenta informações sobre o arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Muestra información sobre el archivo de imagen adjunto al mensaje asociado al reclamo." + }, + "items": { + "type": "object", + "properties": { + "filename": { + "type": "string", + "example": "8007ee20-be67-471f-9e59-e32d9ba02fae_239628932.jpeg", + "description": { + "en": "Current name (hashed - used for retrieving the attachment) of the image file attached to the message associated with the claim.", + "pt": "Nome atual (hashado - utilizado para recuperar o anexo) do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Nombre actual (hasheado - utilizado para recuperar el attachment) del archivo de imagen adjunto al mensaje asociado al reclamo." + } + }, + "original_filename": { + "type": "string", + "example": "Captura de Tela 2019-07-30 a?s 09.45.40.png", + "description": { + "en": "Original name of the image file attached to the message associated with the claim.", + "pt": "Nome original do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Nombre original del archivo de imagen adjunto al mensaje asociado al reclamo." + } + }, + "size": { + "type": "number", + "example": 1880609, + "description": { + "en": "Size (in bytes) of the image file attached to the message associated with the claim.", + "pt": "Tamanho (em bytes) do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Tamaño (en bytes) del archivo de imagen adjunto al mensaje asociado al reclamo." + } + }, + "type": { + "type": "string", + "example": "image/jpeg", + "description": { + "en": "Type of image file attached to the message associated with the claim.", + "pt": "Tipo do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Tipo de archivo de imagen adjunto al mensaje asociado al reclamo." + } + }, + "date_created": { + "type": "string", + "example": "2020-07-22T20:43:15.000-04:00", + "description": { + "en": "Date when the image file was attached to the message associated with the complaint.", + "pt": "Data em que o arquivo de imagem foi anexado à mensagem que está associada à reclamação.", + "es": "Fecha en que se adjuntó el archivo de imagen al mensaje que está asociado al reclamo." + } + } + } + } + }, + "status": { + "type": "string", + "example": "available", + "description": { + "en": "Displays the status of the message associated with the claim. It can take one of the following values: 'available', 'moderated', 'rejected', 'pending_translation'.", + "pt": "Apresenta o estado em que se encontra a mensagem associada à reclamação. Pode assumir um dos seguintes valores: 'available', 'moderated', 'rejected', 'pending_translation'.", + "es": "Muestra el estado en que se encuentra el mensaje asociado al reclamo. Puede tomar alguno de los siguientes valores: 'available', 'moderated', 'rejected', 'pending_translation'." + } + }, + "stage": { + "type": "string", + "example": "claim", + "description": { + "en": "Stage at which the claim was at the time the message was sent. It can take one of the following values:", + "pt": "Estágio em que a reclamação se encontrava no momento em que a mensagem foi enviada. Pode assumir um dos seguintes valores:", + "es": "Etapa en la que se encontraba el reclamo al momento en que se envió el mensaje. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "claim", + "description": { + "en": "Initial stage of the claim process in which both the buyer and seller are involved.", + "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", + "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." + } + }, + { + "title": "dispute", + "description": { + "en": "Phase where the claim is under dispute or disagreement.", + "pt": "Fase em que a reclamação está em disputa ou desacordo.", + "es": "Fase donde el reclamo está en disputa o desacuerdo." + } + }, + { + "title": "recontact", + "description": { + "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", + "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", + "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." + } + }, + { + "title": "none", + "description": { + "en": "Indicates no specific stage is currently applicable.", + "pt": "Indica que nenhuma etapa específica é aplicável.", + "es": "Indica que no se aplica ninguna etapa específica." + } + } + ] + }, + "moderation": { + "type": "object", + "description": { + "en": "Presents information about the file attached to the message associated with the claim.", + "pt": "Apresenta informações sobre o arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Muestra información sobre el archivo de imagen adjunto al mensaje asociado al reclamo." + }, + "properties": { + "status": { + "type": "string", + "example": "clean", + "description": { + "en": "Result of the message moderation process. It can take one of the following values:", + "pt": "Resultado do processo de moderação da mensagem. Pode assumir um dos seguintes valores:", + "es": "Resultado del proceso de moderación de mensajes. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "clean", + "description": { + "en": "Indicates that the message is clean, without information.", + "pt": "Indica que a mensagem está limpa, sem informações.", + "es": "Indica que el mensaje está limpio, sin información." + } + }, + { + "title": "rejected", + "description": { + "en": "Indicates that the message has been moderated.", + "pt": "Indica que a mensagem foi moderada.", + "es": "Indica que el mensaje ha sido moderado." + } + }, + { + "title": "pending", + "description": { + "en": "Indicates that message moderation is in progress.", + "pt": "Indica que a moderação da mensagem está em processo.", + "es": "Indica que la moderación del mensaje está en proceso." + } + }, + { + "title": "non_moderated", + "description": { + "en": "Indicates that the message has not been moderated. For example: cases of old messages.", + "pt": "Indica que a mensagem não foi moderada. Por exemplo: casos de mensagens antigas.", + "es": "Indica que el mensaje no ha sido moderado. Por ejemplo: casos de mensajes antiguos." + } + } + ] + }, + "reason": { + "type": "string", + "example": "", + "description": { + "en": "Reason for moderating the message. Currently, this moderation can be due to inappropriate language.", + "pt": "Razão pela qual a mensagem foi moderada. Atualmente, essa moderação pode ser devido a linguagem inadequada.", + "es": "Razón por la cual se moderó el mensaje. Actualmente, esta moderación puede ser por lenguaje inapropiado." + } + }, + "source": { + "type": "string", + "example": "online", + "description": { + "en": "Displays the moderation mode. Currently, the only available mode is 'online,' where the message is moderated during its creation.", + "pt": "Exibe a modalidade da moderação. Atualmente, a única modalidade disponível é a 'online', em que se modera a mensagem durante a sua criação.", + "es": "Muestra la modalidad de moderación. Actualmente, la única modalidad disponible es la 'online', en la que se modera el mensaje durante su creación." + } + }, + "date_moderated": { + "type": "string", + "example": "2023-02-01T20:13:50Z", + "description": { + "en": "Date when the moderation information was impacted.", + "pt": "Data em que a informação de moderação foi impactada.", + "es": "Fecha en que se impactó la información de moderación." + } + }, + + "date_created": { + "type": "string", + "example": "2020-07-22T20:43:15.000-04:00", + "description": { + "en": "Date the message was created.", + "pt": "Data em que a mensagem foi criada.", + "es": "Fecha en la que se creó el mensaje." + } + } + } + }, + "repeated": { + "type": "boolean", + "example": false, + "description": { + "en": "", + "pt": "", + "es": "" + } + } + } + } + } + } + } + } + }, + "title": { + "en": "Get claim messages", + "pt": "Obter mensagens da reclamação", + "es": "Obtener mensajes del reclamo" + } + } + }, + "/post-purchase/v1/claims/{claim_id}/attachments": { + "post": { + "tags": [ + "checkout-pro" + ], + "description": { + "en": "This endpoint allows, through a valid token, attaching image files to the messages that will be associated with the complaint", + "pt": "Este endpoint permite anexar, por meio de um token válido, anexar arquivos de imagem as mensagens que serão associados à reclamação", + "es": "Este endpoint permite, mediante un token válido, adjuntar archivos de imagen a los mensajes que se asociarán con el reclamo" + }, + "parameters": [ + { + "in": "path", + "name": "claim_id", + "required": true, + "schema": { + "type": "number", + "example": 5039218470 + }, + "description": { + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." + } + }, + { + "in": "formData", + "name": "file", + "schema": { + "type": "string", + "example": "file=@/Users/user/Desktop/file.jpg" + }, + "description": { + "en": "Location of the image file that will be attached to the message associated with the claim. The file must be a maximum of 5 MB and be in JPG, PNG or PDF format. The file name cannot be more than 125 characters and be composed only of the following characters: letters, numbers, period, hyphen, underscore, etc.", + "pt": "Localização do arquivo de imagem que será anexado à mensagem associada à reclamação. O arquivo deverá ter, no máximo, 5 MB e estar nos formatos JPG, PNG ou PDF. O nome do arquivo não pode ter mais de 125 caracteres e ser composto apenas pelos seguintes caracteres: letras, números, ponto, hífen, sublinhado, etc.", + "es": "Ubicación del archivo de imagen que se adjuntará al mensaje asociado al reclamo. El archivo debe tener un tamaño máximo de 5 MB y estar en formato JPG, PNG o PDF. El nombre del archivo no puede tener más de 125 caracteres y estar compuesto solo por los siguientes caracteres: letras, números, punto, guion medio, guion bajo, etc." + } + } + ], + "responses": { + "200": { + "description": { + "es": "Success", + "pt": "Sucesso", + "en": "Éxito" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "user_id": { + "type": "number", + "example": 415836081, + "description": { + "en": "Presents the ID of the person who sent the image file that was attached to the message associated with the claim. It is necessary for this person to be a participant in the claim.", + "pt": "Apresenta o ID de quem enviou o arquivo de imagem que foi anexado à mensagem associada à reclamação. É necessário que seja uma pessoa participante da reclamação.", + "es": "Muestra el ID de la persona que envió el archivo de imagen que fue adjunto al mensaje asociado con el reclamo. Es necesario que sea una persona participante del reclamo." + } + }, + "filename": { + "type": "string", + "example": "44739b8c-592f-4fa3-bdc0-ed1905879eab.jpeg", + "description": { + "en": "Hashed file name (used for retrieving the attachment).", + "pt": "Nome do arquivo hashado (utilizado para recuperar o anexo).", + "es": "Nombre del archivo hasheado (utilizado para recuperar el attachment)." + } + }, + "render_url": { + "type": "string", + "example": "https://fury-storage-private-default.s3.amazonaws.com/mediations-api-core/attachment2/767b79a6-88c8-4fa4-8d95-2cb78fcd897f.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2W4YYFSFIIM7ONWJ%2F20201009%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20201009T174026Z&X-Amz-Expires=43200&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEA8aCXVzLWVhc3QtMSJHMEUCIBznL6LSjtxZx2rmNacevS3fkUtCntzn8hEERS3I9zGcAiEArLoRIu6slpEVHMaKK2%2B3LaXK5vJeEVlwmQ1en1xBlswqtAMIRxABGgw3MzYzNzAzNzE3MjIiDN38MnchbBVYZCS%2BfiqRA9sgC51NLCQ0stU6s2Dek7gt8JmSth7oYLHE8v1WhK3WaiBfe%2FV6LqnrqJcGIikCXr05GqQalWZQLITG1mwC%2Fkx6x5XL5jKFw67lXUvoZzmctRoQPpXpA6MJBTvdCZJKifAS2grLExBJ7KUrgGH6MCxiHpZwm5cO1VP9E5ETFcOTtVzgJtSU0TX70Z4%2BVZPwbxbuEnnqCuW61MZkMvT4dF6oVkZZBR8JuaaiM4w17FV%2B%2Bzt3l39EP9iZdv7NG6G6ZFjvL5UgkVfOm0Bn2w6JONEl8upiOqQN1voen8TugywgWm683isabg1LK2c5GNVWR4qEYbnpS2jZhd732IuDgl1De1V93O5WW2Xf0HGqXhIWYHf9ZDViwWrMXQc5VRQwDIukAgwIy5%2FiBUEwjNBavu4eiWcqtVIQ8OxH9CJIBrQMgPaB%2FtV9LZRGAH24ZwcBD%2FEu%2BEWEDPnR6giE24nAAkWAMlhPQI5NKGGy6y4SLxJ5KalD5yb4Twi0W%2Fvj7bUxfYBSebAn%2B4zldwvFPzWwJRxbMMTdgfwFOusBof6%2FydFCa12JdZERNpiC49pjSmal6DP7rl91JmwVKzG%2FIIENnlBIjZ1yvEtFWy2WcEDqnn2OfEeRc5vop%2FUHnRo3i1TEC8IHs7ECCwwWcf6UAB0%2FUXL8fGj6uQ7KuQ7DLphrZBMfpUz8JXRx1FVRKMWioszeYfL9dQ%2B24GDsESAN83y%2B19ZRdy727X7GsvnZQvdWo7zHQT4zXDmJB0RFtMHwHYtALsGHUyymyA%2FaQjfnbnccvesgGvLGpqdwmXZ0QFMmNobOlJA4STZY%2FejLulxq%2BNhmrvih83%2BSn5Q0043c2%2BzLYeSGs8jUJg%3D%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=cb9a006b693e4b4e17948be0ccbb28739627daf0766f521cb98a2e5643ab9229", + "description": { + "en": "URL where you can get the rendered image file.", + "pt": "URL em que será possível obter o arquivo de imagem renderizado.", + "es": "URL donde puede obtener el archivo de imagen renderizada." + } + } + } + } + } + } + } + }, + "title": { + "en": "Attach files to the message", + "pt": "Anexar arquivos à mensagem", + "es": "Adjuntar archivos al mensaje" + } + } + }, + "/post-purchase/v1/claims/{claim_id}/actions/send-message": { + "post": { + "tags": [ + "checkout-pro" + ], + "description": { + "en": "This endpoint allows, through a valid token, sending and associating messages with attached image files to the claim", + "pt": "Este endpoint permite enviar e associar à reclamação, por meio de um token válido, mensagens com arquivos de imagens anexados", + "es": "Este endpoint permite enviar y asociar al reclamo, mediante un token válido, mensajes con archivos de imágenes adjuntos." + }, + "parameters": [ + { + "in": "path", + "name": "claim_id", + "required": true, + "schema": { + "type": "number", + "example": 5039218470 + }, + "description": { + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." + } + }, + { + "in": "query", + "name": "application_id", + "schema": { + "type": "string", + "example": "123456789" + }, + "description": { + "en": "This is the client unique identificator who initiated the claim.", + "pt": "Identificador único do cliente que iniciou a reclamação.", + "es": "Identificador único del cliente que inició el reclamo." + } + } + ], + "requestBody": { + "description": "", + "content": { + "application/json": { + "schema": { + "required": ["receiver_role", "message"], + "type": "object", + "properties": { + "receiver_role": { + "type": "string", + "example": "respondent", + "description": { + "en": "Person to whom the message associated with the claim will be sent.", + "pt": "Pessoa para quem a mensagem associada à reclamação será enviada.", + "es": "Persona a quien se enviará el mensaje asociado al reclamo." + } + }, + "message": { + "type": "string", + "example": "Mensaje de prueba", + "description": { + "en": "Text of the message to be associated with the claim.", + "pt": "Texto da mensagem a ser associada à reclamação.", + "es": "Texto del mensaje que se asociará al reclamo." + } + }, + "attachments": { + "type": "string", + "example": "WhatsApp-Image-2020-09-22.jpeg", + "description": { + "en": "Image file attached to the message that will be associated with the claim.", + "pt": "Arquivo de imagem anexado à mensagem que será associada à reclamação.", + "es": "Archivo de imagen adjunto al mensaje que se asociará al reclamo." + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": { + "es": "Success", + "pt": "Sucesso", + "en": "Éxito" + } + } + }, + "title": { + "en": "Send message with file", + "pt": "Enviar mensagem com arquivo ", + "es": "Enviar mensaje con archivo" + } + } + }, + "/post-purchase/v1/claims/{claim_id}/attachments/{fileName}/download": { + "get": { + "tags": [ + "checkout-pro" + ], + "description": { + "en": "This endpoint allows, through a valid token, downloading image files attached to the messages associated with the claim", + "pt": "Este endpoint permite, por meio de um token válido, fazer download de arquivos de imagem anexados as mensagens associados à reclamação", + "es": "Este endpoint permite, mediante un token válido, descargar archivos de imagen adjuntos a los mensajes asociados al reclamo" + }, + "parameters": [ + { + "in": "path", + "name": "claim_id", + "required": true, + "schema": { + "type": "number", + "example": 5039218470 + }, + "description": { + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." + } + }, + { + "in": "path", + "name": "attach_id", + "required": true, + "schema": { + "type": "string", + "example": "0f2d81a2-c489-435e-96af-59688ad3d8f4_305860144.jpeg" + }, + "description": { + "en": "Identifier of the attached file.", + "pt": "Identificador do arquivo anexado.", + "es": "Identificador del archivo adjunto." + } + } + ], + "responses": { + "200": { + "description": { + "es": "Success", + "pt": "Sucesso", + "en": "Éxito" + } + } + }, + "title": { + "en": "Download attached files", + "pt": "Baixar arquivos anexados", + "es": "Descargar archivos adjuntos" + } + } + }, + "/post-purchase/v1/claims/{claim_id}/attachments/{fileName}": { + "get": { + "tags": [ + "checkout-pro" + ], + "description": { + "en": "This endpoint allows searching, through a valid token, for image files attached to the message associated with the complaint", + "pt": "Este endpoint permite buscar, mediante un token válido, arquivos de imagem anexados à mensagem associada à reclamaçao", + "es": "Este endpoint permite buscar, mediante un token válido, archivos de imagen adjuntos al mensaje asociado a la reclamación" + }, + "parameters": [ + { + "in": "path", + "name": "claim_id", + "required": true, + "schema": { + "type": "number", + "example": 5039218470 + }, + "description": { + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." + } + }, + { + "in": "path", + "name": "attach_id", + "required": true, + "schema": { + "type": "string", + "example": "0f2d81a2-c489-435e-96af-59688ad3d8f4_305860144.jpeg" + }, + "description": { + "en": "Identifier of the attached file.", + "pt": "Identificador do arquivo anexado.", + "es": "Identificador del archivo adjunto." + } + } + ], + "responses": { + "200": { + "description": { + "es": "Success", + "pt": "Sucesso", + "en": "Éxito" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "filename": { + "type": "string", + "example": "767b79a6-88c8-4fa4-8d95-2cb78fcd897f.jpeg", + "description": { + "en": "Current name (hashed - used for retrieving the attachment) of the image file attached to the message associated with the claim.", + "pt": "Nome atual (hashado - utilizado para recuperar o anexo) do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Nombre actual (hasheado - utilizado para recuperar el attachment) del archivo de imagen adjunto al mensaje asociado al reclamo." + } + }, + "original_filename": { + "type": "string", + "example": "WWhatsApp-Image-2020-09-22.jpeg", + "description": { + "en": "Original name of the image file attached to the message associated with the claim.", + "pt": "Nome original do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Nombre original del archivo de imagen adjunto al mensaje asociado al reclamo." + } + }, + "size": { + "type": "number", + "example": 1880609, + "description": { + "en": "Size (in bytes) of the image file attached to the message associated with the claim.", + "pt": "Tamanho (em bytes) do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Tamaño (en bytes) del archivo de imagen adjunto al mensaje asociado al reclamo." + } + }, + "date_created": { + "type": "string", + "example": "2020-07-22T20:43:15.000-04:00", + "description": { + "en": "Date when the image file was attached to the message associated with the complaint.", + "pt": "Data em que o arquivo de imagem foi anexado à mensagem que está associada à reclamação.", + "es": "Fecha en que se adjuntó el archivo de imagen al mensaje que está asociado al reclamo." + } + }, + "type": { + "type": "string", + "example": "image/jpeg", + "description": { + "en": "Type of image file attached to the message associated with the claim.", + "pt": "Tipo do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Tipo de archivo de imagen adjunto al mensaje asociado al reclamo." + } + } + } + } + } + } + } + }, + "title": { + "en": "Get file data", + "pt": "Obter dados do arquivo", + "es": "Obtener información del archivo" + } + } + }, + "/post-purchase/v1/claims/{claim_id}/actions/open-dispute": { + "post": { + "tags": [ + "checkout-pro" + ], + "description": { + "en": "This endpoint allows searching, through a valid token, requesting mediation in the claim opened by the user", + "pt": "Este endpoint permite solicitar, mediante um token válido, uma mediação na reclamação aberta pela pessoa usuária", + "es": "Este endpoint permite buscar, mediante un token válido, solicitar mediación en el reclamo abierto por la persona usuaria" + }, + "parameters": [ + { + "in": "path", + "name": "claim_id", + "required": true, + "schema": { + "type": "number", + "example": 5039218470 + }, + "description": { + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." + } + } + ], + "responses": { + "201": { + "description": { + "es": "Success", + "pt": "Sucesso", + "en": "Éxito" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number", + "example": 5033102536, + "description": { + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." + } + }, + "resource_id": { + "type": "number", + "example": 7138572864, + "description": { + "en": "ID of the resource on which the claim is created and depends on the 'resource' parameter.", + "pt": "ID do recurso sobre o qual a reclamação é criada e depende do parâmetro 'resource'.", + "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro 'resource'." + } + }, + "status": { + "type": "string", + "example": "closed", + "description": { + "en": "Specifies the current state of the claim, indicating whether it is open or closed. It can take one of the following values:", + "pt": "Especifica o estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", + "es": "Especifica el estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "opened", + "description": { + "en": "Indicates that the claim is open.", + "pt": "Indica que a reclamação está aberta.", + "es": "Indica que el reclamo está abierto." + } + }, + { + "title": "closed", + "description": { + "en": "Indicates that the claim is closed.", + "pt": "Indica que a reclamação está fechada.", + "es": "Indica que el reclamo está cerrado." + } + } + ] + }, + "type": { + "type": "string", + "example": "mediations", + "description": { + "en": "Defines the nature of the claim being processed. It can take one of the following values:", + "pt": "Define a natureza da reclamação em processamento. Pode assumir um dos seguintes valores:", + "es": "Define la naturaleza del reclamo que se está procesando. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "mediations", + "description": { + "en": "Refers to the process of mediating between parties in a claim.", + "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", + "es": "Se refiere al proceso de mediación entre las partes en un reclamo." + } + }, + { + "title": "cancel_purchase", + "description": { + "en": "Involves the process of cancelling a previously made purchase.", + "pt": "Envolve o processo de cancelar uma compra previamente realizada.", + "es": "Involucra el proceso de cancelar una compra previamente realizada." + } + }, + { + "title": "return", + "description": { + "en": "Pertains to the process of returning a purchased item.", + "pt": "Refere-se ao processo de devolução de um item comprado.", + "es": "Se refiere al proceso de devolver un artículo comprado." + } + }, + { + "title": "cancel_sale", + "description": { + "en": "oncerns the process of cancelling a sale that has been made.", + "pt": "Refere-se ao processo de cancelar uma venda realizada.", + "es": "Se ocupa del proceso de cancelar una venta realizada." + } + }, + { + "title": "change", + "description": { + "en": "Refers to the alteration or modification of the details or status of a claim.", + "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", + "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." + } + } + ] + }, + "stage": { + "type": "string", + "example": "dispute", + "description": { + "en": "Indicates the current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", + "pt": "Indica a fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", + "es": "Indica la fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "claim", + "description": { + "en": "Initial stage of the claim process in which both the buyer and seller are involved.", + "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", + "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." + } + }, + { + "title": "dispute", + "description": { + "en": "Phase where the claim is under dispute or disagreement.", + "pt": "Fase em que a reclamação está em disputa ou desacordo.", + "es": "Fase donde el reclamo está en disputa o desacuerdo." + } + }, + { + "title": "recontact", + "description": { + "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", + "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", + "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." + } + }, + { + "title": "none", + "description": { + "en": "Indicates no specific stage is currently applicable.", + "pt": "Indica que nenhuma etapa específica é aplicável.", + "es": "Indica que no se aplica ninguna etapa específica." + } + } + ] + }, + "parent_id": { + "type": "string", + "example": null, + "description": { + "en": "ID of another claim on which it depends.", + "pt": "ID de outra reclamação da qual esta depende.", + "es": "ID de otro reclamo del que depende." + } + }, + "resource": { + "type": "string", + "example": "shipment", + "description": { + "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase.", + "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra.", + "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra." + }, + "enum": [ + { + "title": "payment", + "description": { + "en": "Related to claims involving payment transactions.", + "pt": "Relacionado a reclamações envolvendo transações de pagamento.", + "es": "Relacionado con reclamos que involucran transacciones de pago." + } + }, + { + "title": "order", + "description": { + "en": "Pertains to claims arising from order processing issues.", + "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", + "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." + } + }, + { + "title": "shipment", + "description": { + "en": "Concerns claims related to shipping or delivery matters.", + "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", + "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." + } + }, + { + "title": "purchase", + "description": { + "en": "Involves claims associated with the purchase process.", + "pt": "Envolve reclamações associadas ao processo de compra.", + "es": "Involucra reclamos asociados con el proceso de compra." } } - } - } - } - } - } - } - }, - "title": { - "en": "Claims search", - "pt": "Buscar reclamações", - "es": "Buscar reclamos" - } - } - }, - "/v1/claims/{claim_id}/messages": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows searching, through a valid token, messages associated with a claim", - "pt": "Este endpoint permite buscar, por meio de um token válido, as mensagens associados a uma reclamação", - "es": "Este endpoint permite buscar, mediante un token válido, los mensajes asociados a un reclamo" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sender_role": { - "type": "string", - "example": "complainant", + ] + }, + "reason_id": { + "type": "string", + "example": "PNR4071", + "description": { + "en": "Reason ID of the claim. A claim can be created for three general reasons:", + "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", + "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" + }, + "enum": [ + { + "title": "PNR", "description": { - "en": "Person who sent the message associated with the claim.", - "pt": "Pessoa que enviou a mensagem que está associada à reclamação.", - "es": "Persona que envió el mensaje asociado a la reclamación." + "en": "Product not received.", + "pt": "Produto não recebido.", + "es": "Producto no recibido." } }, - "receiver_role": { - "type": "string", - "example": "respondent", + { + "title": "PDD", "description": { - "en": "Person to whom the message associated with the complaint was sent.", - "pt": "Pessoa para quem a mensagem associada à reclamação foi enviada.", - "es": "Persona a la que se envió el mensaje asociado al reclamo." + "en": "Different or defective product.", + "pt": "Produto diferente ou defeituoso", + "es": "Producto diferente o defectuoso." } }, - "attachments": { - "type": "array", + { + "title": "CS", "description": { - "en": "Presents information about the file attached to the message associated with the claim.", - "pt": "Apresenta informações sobre o arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Muestra información sobre el archivo de imagen adjunto al mensaje asociado al reclamo." - }, - "items": { - "type": "object", - "properties": { - "filename": { - "type": "string", - "example": "8007ee20-be67-471f-9e59-e32d9ba02fae_239628932.jpeg", + "en": "Purchase cancellation.", + "pt": "Cancelamento de compra.", + "es": "Cancelación de la compra." + } + } + ] + }, + "fulfilled": { + "type": "boolean", + "example": true, + "description": { + "en": "Indicate whether the claim is for a delivered or undelivered product.", + "pt": "Indique se o reclamação é sobre um produto entregue ou não entregue.", + "es": "Indica si el reclamo se inicia por un producto entregado o no." + } + }, + "quantity_type": { + "type": "string", + "example": "total", + "description": { + "en": "Indica si una devolución corresponde a todos los productos de la orden o solo algunos. Inicialmente sólo mostrará el valor 'total' y en el futuro se visualizará el valor 'partial'.", + "pt": "Indica se um reembolso corresponde a todos os produtos do pedido ou apenas alguns. Inicialmente, mostrará apenas o valor 'total' e, no futuro, será exibido o valor 'partial'.", + "es": "Indicates whether a return corresponds to all products in the order or only some. Initially, it will only show the value 'total', and in the future, the value 'partial' will be displayed." + } + }, + "players": { + "type": "array", + "description": { + "en": "People who are participating in the complaint.", + "pt": "Pessoas que estão participando da reclamação.", + "es": "Personas que están participando en el reclamo." + }, + "items": { + "type": "object", + "properties": { + "role": { + "type": "string", + "example": "mediator", + "description": { + "en": "Indicates the person's role within the claim. It can take one of the following values:", + "pt": "Indica o papel da pessoa dentro da reclamação. Pode assumir um dos seguintes valores:", + "es": "Indica el rol de la persona dentro del reclamo. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "complainant", "description": { - "en": "Current name (hashed - used for retrieving the attachment) of the image file attached to the message associated with the claim.", - "pt": "Nome atual (hashado - utilizado para recuperar o anexo) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre actual (hasheado - utilizado para recuperar el attachment) del archivo de imagen adjunto al mensaje asociado al reclamo." + "en": "Person who claims", + "pt": "Pessoa que reclama.", + "es": "Persona que reclama." } }, - "original_filename": { - "type": "string", - "example": "Captura de Tela 2019-07-30 a?s 09.45.40.png", + { + "title": "respondent", "description": { - "en": "Original name of the image file attached to the message associated with the claim.", - "pt": "Nome original do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre original del archivo de imagen adjunto al mensaje asociado al reclamo." + "en": "Person to whom they are complaining.", + "pt": "Pessoa a quem estão reclamando.", + "es": "Persona a quién le reclaman." } }, - "size": { - "type": "number", - "example": 1880609, + { + "title": "mediator", + "description": { + "en": "Person who intervenes to help solve the problem.", + "pt": "Pessoa que intervém para ajudar a resolver o problema.", + "es": "Persona que interviene para ayudar a solucionar el problema." + } + } + ] + }, + "type": { + "type": "string", + "example": "payer", + "description": { + "en": "Role that the person occupies in the operation that is being claimed and may vary according to the 'resource'. It can take one of the following values:", + "pt": "Papel que a pessoa ocupa na operação que está sendo reivindicada e pode variar de acordo com o 'resource'. Pode assumir um dos seguintes valores:", + "es": "Rol que ocupa la persona sobre la operación que se está reclamando y puede variar de acuerdo con el 'resource'. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "payment", "description": { - "en": "Size (in bytes) of the image file attached to the message associated with the claim.", - "pt": "Tamanho (em bytes) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tamaño (en bytes) del archivo de imagen adjunto al mensaje asociado al reclamo." + "en": "Indicates that the person is the buyer or collector.", + "pt": "Indica que a pessoa é compradora ou cobradora.", + "es": "Indica que la persona es el comprador o collector." } }, - "type": { - "type": "string", - "example": "image/jpeg", + { + "title": "order", "description": { - "en": "Type of image file attached to the message associated with the claim.", - "pt": "Tipo do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tipo de archivo de imagen adjunto al mensaje asociado al reclamo." + "en": "Indicates that the person is the buyer or seller.", + "pt": "Indica que a pessoa é compradora ou vendedora.", + "es": "Indica que la persona es el comprador o vendedor." } }, - "date_created": { - "type": "string", - "example": "2020-07-22T20:43:15.000-04:00", + { + "title": "shipment", "description": { - "en": "Date when the image file was attached to the message associated with the complaint.", - "pt": "Data em que o arquivo de imagem foi anexado à mensagem que está associada à reclamação.", - "es": "Fecha en que se adjuntó el archivo de imagen al mensaje que está asociado al reclamo." + "en": "Indicates that the person is the receiver or sender.", + "pt": "Indica que a pessoa é o destinatário ou remetente.", + "es": "Indica que la persona es el receptor o remitente." } } + ] + }, + "user_id": { + "type": "number", + "example": 242829175, + "description": { + "en": "ID of the 'type' indicated in the previous parameter.", + "pt": "ID do 'type' indicado no parâmetro anterior.", + "es": "ID del 'type' indicado en el parámetro anterior." } - } - }, - "status": { - "type": "string", - "example": "available", - "description": { - "en": "Displays the status of the message associated with the claim. It can take one of the following values: 'available', 'moderated', 'rejected', 'pending_translation'.", - "pt": "Apresenta o estado em que se encontra a mensagem associada à reclamação. Pode assumir um dos seguintes valores: 'available', 'moderated', 'rejected', 'pending_translation'.", - "es": "Muestra el estado en que se encuentra el mensaje asociado al reclamo. Puede tomar alguno de los siguientes valores: 'available', 'moderated', 'rejected', 'pending_translation'." - } - }, - "moderation": { - "type": "object", - "description": { - "en": "Presents information about the file attached to the message associated with the claim.", - "pt": "Apresenta informações sobre o arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Muestra información sobre el archivo de imagen adjunto al mensaje asociado al reclamo." }, - "properties": { - "status": { - "type": "string", - "example": "clean", - "description": { - "en": "Result of the message moderation process. It can take one of the following values:", - "pt": "Resultado do processo de moderação da mensagem. Pode assumir um dos seguintes valores:", - "es": "Resultado del proceso de moderación de mensajes. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "clean", - "description": { - "en": "Indicates that the message is clean, without information.", - "pt": "Indica que a mensagem está limpa, sem informações.", - "es": "Indica que el mensaje está limpio, sin información." - } - }, - { - "title": "rejected", - "description": { - "en": "Indicates that the message has been moderated.", - "pt": "Indica que a mensagem foi moderada.", - "es": "Indica que el mensaje ha sido moderado." - } - }, - { - "title": "pending", - "description": { - "en": "Indicates that message moderation is in progress.", - "pt": "Indica que a moderação da mensagem está em processo.", - "es": "Indica que la moderación del mensaje está en proceso." - } - }, - { - "title": "non_moderated", - "description": { - "en": "Indicates that the message has not been moderated. For example: cases of old messages.", - "pt": "Indica que a mensagem não foi moderada. Por exemplo: casos de mensagens antigas.", - "es": "Indica que el mensaje no ha sido moderado. Por ejemplo: casos de mensajes antiguos." - } - } - ] - }, - "reason": { - "type": "string", - "example": "", - "description": { - "en": "Reason for moderating the message. Currently, this moderation can be due to inappropriate language.", - "pt": "Razão pela qual a mensagem foi moderada. Atualmente, essa moderação pode ser devido a linguagem inadequada.", - "es": "Razón por la cual se moderó el mensaje. Actualmente, esta moderación puede ser por lenguaje inapropiado." - } - }, - "source": { - "type": "string", - "example": "online", - "description": { - "en": "Displays the moderation mode. Currently, the only available mode is 'online,' where the message is moderated during its creation.", - "pt": "Exibe a modalidade da moderação. Atualmente, a única modalidade disponível é a 'online', em que se modera a mensagem durante a sua criação.", - "es": "Muestra la modalidad de moderación. Actualmente, la única modalidad disponible es la 'online', en la que se modera el mensaje durante su creación." - } - }, - "date_moderated": { - "type": "string", - "example": "2023-02-01T20:13:50Z", - "description": { - "en": "Date when the moderation information was impacted.", - "pt": "Data em que a informação de moderação foi impactada.", - "es": "Fecha en que se impactó la información de moderación." - } + "available_actions": { + "type": "array", + "description": { + "en": "Provides information about the actions that each of the involved parties can execute.", + "pt": "Exibe informações sobre as ações que cada uma das partes envolvidas pode executar.", + "es": "Presenta información sobre las acciones que pueden ejecutar cada una de las partes intervinientes." }, - "stage": { - "type": "string", - "example": "claim", - "description": { - "en": "Stage at which the claim was at the time the message was sent. It can take one of the following values:", - "pt": "Estágio em que a reclamação se encontrava no momento em que a mensagem foi enviada. Pode assumir um dos seguintes valores:", - "es": "Etapa en la que se encontraba el reclamo al momento en que se envió el mensaje. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "claim", - "description": { - "en": "Initial stage of the claim process in which both the buyer and seller are involved.", - "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", - "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." - } - }, - { - "title": "dispute", + "items": { + "type": "object", + "properties": { + "action": { + "type": "string", + "example": "recontact", "description": { - "en": "Phase where the claim is under dispute or disagreement.", - "pt": "Fase em que a reclamação está em disputa ou desacordo.", - "es": "Fase donde el reclamo está en disputa o desacuerdo." - } + "es": "List of actions that each of the involved parties can execute.", + "pt": "Lista de ações que cada uma das partes envolvidas pode executar.", + "en": "Lista de acciones que pueden ejecutar cada una de las partes intervinientes." + }, + "enum": [ + { + "title": "send_message_to_complainant", + "description": { + "en": "Send a message to the buyer (with or without attachments).", + "pt": "Enviar mensagem para o comprador (com ou sem anexos).", + "es": "Enviar mensaje para el comprador (con o sin anexos)." + } + }, + { + "title": "send_message_to_mediator", + "description": { + "en": "Send a message to the mediator (with or without attachments).", + "pt": "Enviar mensagem para o mediador (com ou sem anexos).", + "es": "Enviar mensaje para el mediador (con o sin anexos)." + } + }, + { + "title": "recontact (no disponible aún)", + "description": { + "en": "Reopen a closed complaint through an interaction, such as a message.", + "pt": "Reabrir uma reclamação já fechada, por meio de uma interação, como uma mensagem.", + "es": "Reabrir un reclamo ya cerrado, por medio de una interacción, como un mensaje." + } + }, + { + "title": "refund", + "description": { + "en": "Refund the buyer's money. Must be performed by the Mercado Pago front end.", + "pt": "Devolver o dinheiro do comprador. Deve ser realizado pelo front do Mercado Pago.", + "es": "Devolver el dinero del comprado. Debe ser realizado por el front de Mercado Pago." + } + }, + { + "title": "open_dispute", + "description": { + "en": "Initiate mediation.", + "pt": "Iniciar uma mediação.", + "es": "Iniciar una mediación." + } + }, + { + "title": "send_potential_shipping", + "description": { + "en": "Send a promise of shipment, indicating a date.", + "pt": "Enviar uma promessa de postagem, indicando uma data.", + "es": "Enviar una promesa de post, indicando una fecha." + } + }, + { + "title": "add_shipping_evidence", + "description": { + "en": "Publish evidence that the product has been shipped.", + "pt": "Publicar uma evidência de que o produto foi enviado.", + "es": "Publicar una evidencia de que el producto fue enviado." + } + }, + { + "title": "send_attachments", + "description": { + "en": "Send message with attached images.", + "pt": "Enviar mensagem com imagens anexadas.", + "es": "Enviar mensaje con imágenes adjuntas." + } + }, + { + "title": "allow_return_label", + "description": { + "en": "Generate a return label.", + "pt": "Gerar etiqueta de devolução.", + "es": "Generar etiqueta de devolución." + } + }, + { + "title": "send_tracking_number", + "description": { + "en": "Send the shipping tracking number.", + "pt": "Enviar o número de rastreamento de envio (tracking number).", + "es": "Enviar el número de rastreo de envío (tracking number)." + } + } + ] }, - { - "title": "recontact", + "due_date": { + "type": "string", + "example": "2020-11-16T22:36:59.000-04:00", "description": { - "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", - "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", - "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." + "en": "Deadline to perform the action.", + "pt": "Prazo limite para realizar a ação.", + "es": "Tiempo límite para realizar la acción." } }, - { - "title": "none", + "mandatory": { + "type": "boolean", + "example": true, "description": { - "en": "Indicates no specific stage is currently applicable.", - "pt": "Indica que nenhuma etapa específica é aplicável.", - "es": "Indica que no se aplica ninguna etapa específica." + "en": "This field being 'true' indicates that the action is mandatory and must be performed within the specified time.", + "pt": "Este campo como 'true' indica que a ação é obrigatória e deve ser realizada dentro do tempo informado.", + "es": "Este campo en 'true' indica que la acción es obligatoria y debe ser realizada dentro del tiempo informado." } } - ] - }, - "date_created": { - "type": "string", - "example": "2020-07-22T20:43:15.000-04:00", - "description": { - "en": "Date the message was created.", - "pt": "Data em que a mensagem foi criada.", - "es": "Fecha en la que se creó el mensaje." - } - }, - "message": { - "type": "string", - "example": "Boa noite! A tampa veio com uma rachadura. Gostaria de anexar foto", - "description": { - "en": "Displays the message text associated with the complaim.", - "pt": "Exibe o texto da mensagem associada à reclamação.", - "es": "Muestra el texto del mensaje asociado con el reclamo." } } } } } - } - } - } - } - } - }, - "title": { - "en": "Get claim messages", - "pt": "Obter mensagens da reclamação", - "es": "Obtener mensajes del reclamo" - } - } - }, - "/v1/claims/{claim_id}/attachments": { - "post": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows, through a valid token, attaching image files to the messages that will be associated with the complaint", - "pt": "Este endpoint permite anexar, por meio de um token válido, anexar arquivos de imagem as mensagens que serão associados à reclamação", - "es": "Este endpoint permite, mediante un token válido, adjuntar archivos de imagen a los mensajes que se asociarán con el reclamo" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - }, - { - "in": "formData", - "name": "file", - "schema": { - "type": "string", - "example": "file=@/Users/user/Desktop/file.jpg" - }, - "description": { - "en": "Location of the image file that will be attached to the message associated with the claim. The file must be a maximum of 5 MB and be in JPG, PNG or PDF format. The file name cannot be more than 125 characters and be composed only of the following characters: letters, numbers, period, hyphen, underscore, etc.", - "pt": "Localização do arquivo de imagem que será anexado à mensagem associada à reclamação. O arquivo deverá ter, no máximo, 5 MB e estar nos formatos JPG, PNG ou PDF. O nome do arquivo não pode ter mais de 125 caracteres e ser composto apenas pelos seguintes caracteres: letras, números, ponto, hífen, sublinhado, etc.", - "es": "Ubicación del archivo de imagen que se adjuntará al mensaje asociado al reclamo. El archivo debe tener un tamaño máximo de 5 MB y estar en formato JPG, PNG o PDF. El nombre del archivo no puede tener más de 125 caracteres y estar compuesto solo por los siguientes caracteres: letras, números, punto, guion medio, guion bajo, etc." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "user_id": { - "type": "number", - "example": 415836081, - "description": { - "en": "Presents the ID of the person who sent the image file that was attached to the message associated with the claim. It is necessary for this person to be a participant in the claim.", - "pt": "Apresenta o ID de quem enviou o arquivo de imagem que foi anexado à mensagem associada à reclamação. É necessário que seja uma pessoa participante da reclamação.", - "es": "Muestra el ID de la persona que envió el archivo de imagen que fue adjunto al mensaje asociado con el reclamo. Es necesario que sea una persona participante del reclamo." - } - }, - "filename": { - "type": "string", - "example": "44739b8c-592f-4fa3-bdc0-ed1905879eab.jpeg", - "description": { - "en": "Hashed file name (used for retrieving the attachment).", - "pt": "Nome do arquivo hashado (utilizado para recuperar o anexo).", - "es": "Nombre del archivo hasheado (utilizado para recuperar el attachment)." - } + }, + "resolution": { + "type": "object", + "description": { + "en": "Provides information about claim resolution.", + "pt": "Exibe informações sobre a resolução da reclamação.", + "es": "Presenta información sobre la resolución del reclamo." }, - "render_url": { - "type": "string", - "example": "https://fury-storage-private-default.s3.amazonaws.com/mediations-api-core/attachment2/767b79a6-88c8-4fa4-8d95-2cb78fcd897f.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2W4YYFSFIIM7ONWJ%2F20201009%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20201009T174026Z&X-Amz-Expires=43200&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEA8aCXVzLWVhc3QtMSJHMEUCIBznL6LSjtxZx2rmNacevS3fkUtCntzn8hEERS3I9zGcAiEArLoRIu6slpEVHMaKK2%2B3LaXK5vJeEVlwmQ1en1xBlswqtAMIRxABGgw3MzYzNzAzNzE3MjIiDN38MnchbBVYZCS%2BfiqRA9sgC51NLCQ0stU6s2Dek7gt8JmSth7oYLHE8v1WhK3WaiBfe%2FV6LqnrqJcGIikCXr05GqQalWZQLITG1mwC%2Fkx6x5XL5jKFw67lXUvoZzmctRoQPpXpA6MJBTvdCZJKifAS2grLExBJ7KUrgGH6MCxiHpZwm5cO1VP9E5ETFcOTtVzgJtSU0TX70Z4%2BVZPwbxbuEnnqCuW61MZkMvT4dF6oVkZZBR8JuaaiM4w17FV%2B%2Bzt3l39EP9iZdv7NG6G6ZFjvL5UgkVfOm0Bn2w6JONEl8upiOqQN1voen8TugywgWm683isabg1LK2c5GNVWR4qEYbnpS2jZhd732IuDgl1De1V93O5WW2Xf0HGqXhIWYHf9ZDViwWrMXQc5VRQwDIukAgwIy5%2FiBUEwjNBavu4eiWcqtVIQ8OxH9CJIBrQMgPaB%2FtV9LZRGAH24ZwcBD%2FEu%2BEWEDPnR6giE24nAAkWAMlhPQI5NKGGy6y4SLxJ5KalD5yb4Twi0W%2Fvj7bUxfYBSebAn%2B4zldwvFPzWwJRxbMMTdgfwFOusBof6%2FydFCa12JdZERNpiC49pjSmal6DP7rl91JmwVKzG%2FIIENnlBIjZ1yvEtFWy2WcEDqnn2OfEeRc5vop%2FUHnRo3i1TEC8IHs7ECCwwWcf6UAB0%2FUXL8fGj6uQ7KuQ7DLphrZBMfpUz8JXRx1FVRKMWioszeYfL9dQ%2B24GDsESAN83y%2B19ZRdy727X7GsvnZQvdWo7zHQT4zXDmJB0RFtMHwHYtALsGHUyymyA%2FaQjfnbnccvesgGvLGpqdwmXZ0QFMmNobOlJA4STZY%2FejLulxq%2BNhmrvih83%2BSn5Q0043c2%2BzLYeSGs8jUJg%3D%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=cb9a006b693e4b4e17948be0ccbb28739627daf0766f521cb98a2e5643ab9229", - "description": { - "en": "URL where you can get the rendered image file.", - "pt": "URL em que será possível obter o arquivo de imagem renderizado.", - "es": "URL donde puede obtener el archivo de imagen renderizada." + "properties": { + "reason": { + "type": "string", + "example": "already_shipped", + "description": { + "en": "Reason for resolution/closure.", + "pt": "Motivo de resolução/encerramento.", + "es": "Motivo de resolucion/cierre." + } + }, + "date_created": { + "type": "string", + "example": "2020-10-02T01:12:31.000-04:00", + "description": { + "en": "Date of resolution/closure of the claim.", + "pt": "Data de resolução/encerramento da reclamação.", + "es": "Fecha de la resolucion/cierre del reclamo." + } + }, + "decision": { + "type": "array", + "items": { + "type": "string", + "example": "complainant", + "description": { + "en": "Person who defined the resolution of the claim.", + "pt": "Pessoa que definiu a resolução da reclamação.", + "es": "Persona que definió la resolución del reclamo." + } + } + }, + "closed_by": { + "type": "string", + "example": "mediator", + "description": { + "en": "Person who closed the claim.", + "pt": "Pessoa que encerrou a reclamação.", + "es": "Persona que cerró el reclamo." + } } } - } - } - } - } - } - }, - "title": { - "en": "Attach files to the message", - "pt": "Anexar arquivos à mensagem", - "es": "Adjuntar archivos al mensaje" - } - } - }, - "/v1/claims/{claim_id}/actions/message": { - "post": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows, through a valid token, sending and associating messages with attached image files to the claim", - "pt": "Este endpoint permite enviar e associar à reclamação, por meio de um token válido, mensagens com arquivos de imagens anexados", - "es": "Este endpoint permite enviar y asociar al reclamo, mediante un token válido, mensajes con archivos de imágenes adjuntos." - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - }, - { - "in": "query", - "name": "application_id", - "schema": { - "type": "string", - "example": "123456789" - }, - "description": { - "en": "This is the client unique identificator who initiated the claim.", - "pt": "Identificador único do cliente que iniciou a reclamação.", - "es": "Identificador único del cliente que inició el reclamo." - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "required": [ - "receiver_role", - "message" - ], - "type": "object", - "properties": { - "receiver_role": { + }, + "site_id": { "type": "string", - "example": "respondent", + "example": "MLA", "description": { - "en": "Person to whom the message associated with the claim will be sent.", - "pt": "Pessoa para quem a mensagem associada à reclamação será enviada.", - "es": "Persona a quien se enviará el mensaje asociado al reclamo." - } + "en": "ID of the site where the claim occurs.", + "pt": "ID do site em que ocorre a reclamação.", + "es": "ID del sitio donde se desarrolla el reclamo." + }, + "enum": [ + { + "title": "MCO", + "description": { + "en": "Mercado Libre Colombia", + "pt": "Mercado Livre Colômbia", + "es": "Mercado Libre Colombia" + } + }, + { + "title": "MLA", + "description": { + "en": "Mercado Livre Argentina", + "pt": "Mercado Libre Argentina", + "es": "Mercado Libre Argentina" + } + }, + { + "title": "MLB", + "description": { + "en": "Mercado Libre Brasil", + "pt": "Mercado Livre Brasil", + "es": "Mercado Libre Brasil" + } + }, + { + "title": "MLC", + "description": { + "en": "Mercado Libre Chile", + "pt": "Mercado Livre Chile", + "es": "Mercado Libre Chile" + } + }, + { + "title": "MLM", + "description": { + "en": "Mercado Libre México", + "pt": "Mercado Livre México", + "es": "Mercado Libre México" + } + }, + { + "title": "MLU", + "description": { + "en": "Mercado Libre Uruguay", + "pt": "Mercado Livre Uruguai", + "es": "Mercado Libre Uruguay" + } + }, + { + "title": "MPE", + "description": { + "en": "Mercado Libre Perú", + "pt": "Mercado Livre Perú", + "es": "Mercado Libre Perú" + } + } + ] }, - "message": { + "date_created": { "type": "string", - "example": "Mensaje de prueba", + "example": "2020-09-30T09:48:06.000-04:00", "description": { - "en": "Text of the message to be associated with the claim.", - "pt": "Texto da mensagem a ser associada à reclamação.", - "es": "Texto del mensaje que se asociará al reclamo." + "en": "Date the claim was created.", + "pt": "Data em que a reclamação foi criada.", + "es": "Fecha en la que se creó el reclamo." } }, - "attachments": { + "last_updated": { "type": "string", - "example": "WhatsApp-Image-2020-09-22.jpeg", + "example": "2020-10-02T01:12:31.000-04:00", "description": { - "en": "Image file attached to the message that will be associated with the claim.", - "pt": "Arquivo de imagem anexado à mensagem que será associada à reclamação.", - "es": "Archivo de imagen adjunto al mensaje que se asociará al reclamo." - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number", - "example": 62229132, - "description": { - "en": "Displays the ID of the message sent and associated with the claim.", - "pt": "Exibe o ID da mensagem enviada e associada à reclamação.", - "es": "Muestra el ID del mensaje enviado y asociado al reclamo." - } + "en": "Date of the last update to the claim.", + "pt": "Data da última atualização da reclamação.", + "es": "Fecha de última actualización reclamo." } } } } } } - }, - "title": { - "en": "Send message with file", - "pt": "Enviar mensagem com arquivo ", - "es": "Enviar mensaje con archivo" - } - } - }, - "/v1/claims/{claim_id}/attachments/{attach_id}/download": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows, through a valid token, downloading image files attached to the messages associated with the claim", - "pt": "Este endpoint permite, por meio de um token válido, fazer download de arquivos de imagem anexados as mensagens associados à reclamação", - "es": "Este endpoint permite, mediante un token válido, descargar archivos de imagen adjuntos a los mensajes asociados al reclamo" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - }, - { - "in": "path", - "name": "attach_id", - "required": true, - "schema": { - "type": "string", - "example": "0f2d81a2-c489-435e-96af-59688ad3d8f4_305860144.jpeg" - }, - "description": { - "en": "Identifier of the attached file.", - "pt": "Identificador do arquivo anexado.", - "es": "Identificador del archivo adjunto." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - } - } - }, - "title": { - "en": "Download attached files", - "pt": "Baixar arquivos anexados", - "es": "Descargar archivos adjuntos" } + }, + "title": { + "en": "Request claim mediation", + "pt": "Solicitar mediação da reclamação", + "es": "Solicitar mediación del reclamo" } - }, - "/v1/claims/{claim_id}/attachments/{attach_id}": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows searching, through a valid token, for image files attached to the message associated with the complaint", - "pt": "Este endpoint permite buscar, mediante un token válido, arquivos de imagem anexados à mensagem associada à reclamaçao", - "es": "Este endpoint permite buscar, mediante un token válido, archivos de imagen adjuntos al mensaje asociado a la reclamación" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } + } + }, + "/post-purchase/v1/claims/{claim_id}/expected-resolutions": { + "get": { + "tags": [ + "checkout-pro" + ], + "description": { + "en": "This endpoint allows, through a valid token, viewing the expected resolutions by the user in their claim", + "pt": "Este endpoint permite visualizar, mediante un token válido, resoluções esperadas pela pessoa usuária em sua reclamação", + "es": "Este endpoint permite visualizar, mediante un token válido, las resoluciones esperadas por la persona usuaria en su reclamo" + }, + "parameters": [ + { + "in": "path", + "name": "claim_id", + "required": true, + "schema": { + "type": "number", + "example": 5039218470 }, - { - "in": "path", - "name": "attach_id", - "required": true, - "schema": { - "type": "string", - "example": "0f2d81a2-c489-435e-96af-59688ad3d8f4_305860144.jpeg" - }, - "description": { - "en": "Identifier of the attached file.", - "pt": "Identificador do arquivo anexado.", - "es": "Identificador del archivo adjunto." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "filename": { - "type": "string", - "example": "767b79a6-88c8-4fa4-8d95-2cb78fcd897f.jpeg", - "description": { - - "en": "Current name (hashed - used for retrieving the attachment) of the image file attached to the message associated with the claim.", - "pt": "Nome atual (hashado - utilizado para recuperar o anexo) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre actual (hasheado - utilizado para recuperar el attachment) del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "original_filename": { - "type": "string", - "example": "WWhatsApp-Image-2020-09-22.jpeg", - "description": { - "en": "Original name of the image file attached to the message associated with the claim.", - "pt": "Nome original do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre original del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "size": { - "type": "number", - "example": 1880609, - "description": { - "en": "Size (in bytes) of the image file attached to the message associated with the claim.", - "pt": "Tamanho (em bytes) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tamaño (en bytes) del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "type": { - "type": "string", - "example": "image/jpeg", - "description": { - "en": "Type of image file attached to the message associated with the claim.", - "pt": "Tipo do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tipo de archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "date_created": { - "type": "string", - "example": "2020-07-22T20:43:15.000-04:00", - "description": { - "en": "Date when the image file was attached to the message associated with the complaint.", - "pt": "Data em que o arquivo de imagem foi anexado à mensagem que está associada à reclamação.", - "es": "Fecha en que se adjuntó el archivo de imagen al mensaje que está asociado al reclamo." - } - }, - "file_url": { - "type": "string", - "example": "https://fury-storage-private-default.s3.amazonaws.com/mediations-api-core/attachment2/767b79a6-88c8-4fa4-8d95-2cb78fcd897f.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2W4YYFSFIIM7ONWJ%2F20201009%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20201009T174026Z&X-Amz-Expires=43200&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEA8aCXVzLWVhc3QtMSJHMEUCIBznL6LSjtxZx2rmNacevS3fkUtCntzn8hEERS3I9zGcAiEArLoRIu6slpEVHMaKK2%2B3LaXK5vJeEVlwmQ1en1xBlswqtAMIRxABGgw3MzYzNzAzNzE3MjIiDN38MnchbBVYZCS%2BfiqRA9sgC51NLCQ0stU6s2Dek7gt8JmSth7oYLHE8v1WhK3WaiBfe%2FV6LqnrqJcGIikCXr05GqQalWZQLITG1mwC%2Fkx6x5XL5jKFw67lXUvoZzmctRoQPpXpA6MJBTvdCZJKifAS2grLExBJ7KUrgGH6MCxiHpZwm5cO1VP9E5ETFcOTtVzgJtSU0TX70Z4%2BVZPwbxbuEnnqCuW61MZkMvT4dF6oVkZZBR8JuaaiM4w17FV%2B%2Bzt3l39EP9iZdv7NG6G6ZFjvL5UgkVfOm0Bn2w6JONEl8upiOqQN1voen8TugywgWm683isabg1LK2c5GNVWR4qEYbnpS2jZhd732IuDgl1De1V93O5WW2Xf0HGqXhIWYHf9ZDViwWrMXQc5VRQwDIukAgwIy5%2FiBUEwjNBavu4eiWcqtVIQ8OxH9CJIBrQMgPaB%2FtV9LZRGAH24ZwcBD%2FEu%2BEWEDPnR6giE24nAAkWAMlhPQI5NKGGy6y4SLxJ5KalD5yb4Twi0W%2Fvj7bUxfYBSebAn%2B4zldwvFPzWwJRxbMMTdgfwFOusBof6%2FydFCa12JdZERNpiC49pjSmal6DP7rl91JmwVKzG%2FIIENnlBIjZ1yvEtFWy2WcEDqnn2OfEeRc5vop%2FUHnRo3i1TEC8IHs7ECCwwWcf6UAB0%2FUXL8fGj6uQ7KuQ7DLphrZBMfpUz8JXRx1FVRKMWioszeYfL9dQ%2B24GDsESAN83y%2B19ZRdy727X7GsvnZQvdWo7zHQT4zXDmJB0RFtMHwHYtALsGHUyymyA%2FaQjfnbnccvesgGvLGpqdwmXZ0QFMmNobOlJA4STZY%2FejLulxq%2BNhmrvih83%2BSn5Q0043c2%2BzLYeSGs8jUJg%3D%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=cb9a006b693e4b4e17948be0ccbb28739627daf0766f521cb98a2e5643ab9229", - "description": { - "en": "URL where you can get the rendered image file.", - "pt": "URL em que será possível obter o arquivo de imagem renderizado.", - "es": "URL donde puede obtener el archivo de imagen renderizada." - } - } - } - } - } - } - } - }, - "title": { - "en": "Get file data", - "pt": "Obter dados do arquivo", - "es": "Obtener información del archivo" - } - } - }, - "/v1/claims/{claim_id}/actions/open_dispute": { - "post": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows searching, through a valid token, requesting mediation in the claim opened by the user", - "pt": "Este endpoint permite solicitar, mediante um token válido, uma mediação na reclamação aberta pela pessoa usuária", - "es": "Este endpoint permite buscar, mediante un token válido, solicitar mediación en el reclamo abierto por la persona usuaria" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "type": "number", - "example": 201, - "description": { - "en": "Shows the status of the mediation requested in the claim opened by the user.", - "pt": "Exibe o status da mediação solicitada na reclamação aberta pela pessoa usuária.", - "es": "Exhibe el estado de la mediación solicitada en el reclamo abierto por la persona usuaria." - } - }, - "message": { - "type": "string", - "example": "DISPUTE_CREATED", - "description": { - "en": "Displays the message related to the status of the mediation requested in the claim.", - "pt": "Apresenta a mensagem relacionada à situação da mediação solicitada na reclamação.", - "es": "Muestra el mensaje relacionado con la situación de la mediación solicitada en el reclamo." - } - } - } - } - } - } + "description": { + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." } - }, - "title": { - "en": "Request claim mediation", - "pt": "Solicitar mediação da reclamação", - "es": "Solicitar mediación del reclamo" } - } - }, - "/v1/claims/{claim_id}/expected_resolutions": { - "get": { - "tags": [ - "checkout-pro" - ], + ], + "responses": { + "200": { "description": { - "en": "This endpoint allows, through a valid token, viewing the expected resolutions by the user in their claim", - "pt": "Este endpoint permite visualizar, mediante un token válido, resoluções esperadas pela pessoa usuária em sua reclamação", - "es": "Este endpoint permite visualizar, mediante un token válido, las resoluciones esperadas por la persona usuaria en su reclamo" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { + "es": "Success", + "pt": "Sucesso", + "en": "Éxito" + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "type": "object", "properties": { "player_role": { @@ -2619,605 +3029,248 @@ { "title": "accepted", "description": { - "en": "The resolution loaded by the person was accepted by their counterpart or, alternatively, by the Mercado", - "pt": "A resolução carregada pela pessoa foi aceita por sua contraparte ou, caso contrário, pelo mediador do Mercado Pago.", - "es": "La resolución cargada por la persona fue aceptada por su contraparte o, en su defecto, por el mediador de Mercado Pago." - } - }, - { - "title": "rejected", - "description": { - "en": "The resolution loaded by the person was rejected by the counterpart, and alternatively, they loaded a new resolution option.", - "pt": "A resolução carregada pela pessoa foi rejeitada pela contraparte e, em contra partida, ela carregou uma nova opção de resolução.", - "es": "La resolución cargada por la persona fue rechazada por su contraparte y, en su defecto, cargó una nueva opción de resolución." - } - } - ] - } - } - } - } - } - } - }, - "title": { - "en": "See expected resolutions at mediation", - "pt": "Ver resoluções esperadas na mediação", - "es": "Ver resoluciones esperadas en mediación" - } - } - }, - "/v1/claims/{claim_id}/evidences": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows, through a valid token, obtaining evidence of the the claim, such as order shipping information and attached image files associated with the claim", - "pt": "Este endpoint permite obter, mediante um token válido, evidências da reclamação como, por exemplo, informações de envio do pedido e de anexos de imagens associados à reclamação", - "es": "Este endpoint permite obtener, mediante un token válido, evidencias del reclamo, como información de envío del pedido y archivos de imágenes adjuntos asociados al reclamo" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "attachments": { - "type": "array", - "description": { - "en": "Presents information about the file attached to the message associated with the claim.", - "pt": "Apresenta informações sobre o arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Muestra información sobre el archivo de imagen adjunto al mensaje asociado al reclamo." - }, - "items": { - "type": "object", - "properties": { - "filename": { - "type": "string", - "example": "8007ee20-be67-471f-9e59-e32d9ba02fae_239628932.jpeg", - "description": { - "en": "Current name (hashed - used for retrieving the attachment) of the image file attached to the message associated with the claim.", - "pt": "Nome atual (hashado - utilizado para recuperar o anexo) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre actual (hasheado - utilizado para recuperar el attachment) del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "original_filename": { - "type": "string", - "example": "Captura-de-Tela-2019-07-30.png", - "description": { - "en": "Original name of the image file attached to the message associated with the claim.", - "pt": "Nome original do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre original del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "size": { - "type": "number", - "example": 1880609, - "description": { - "en": "Size (in bytes) of the image file attached to the message associated with the claim.", - "pt": "Tamanho (em bytes) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tamaño (en bytes) del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "type": { - "type": "string", - "example": "image/jpeg", - "description": { - "en": "Type of image file attached to the message associated with the claim.", - "pt": "Tipo do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tipo de archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "date_created": { - "type": "string", - "example": "2020-07-22T20:43:15.000-04:00", - "description": { - "en": "Date when the image file was attached to the message associated with the complaint.", - "pt": "Data em que o arquivo de imagem foi anexado à mensagem que está associada à reclamação.", - "es": "Fecha en que se adjuntó el archivo de imagen al mensaje que está asociado al reclamo." - } - }, - "file_url": { - "type": "string", - "example": "https://fury-storage-private-default.s3.amazonaws.com/mediations-api-core/attachment2/767b79a6-88c8-4fa4-8d95-2cb78fcd897f.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2W4YYFSFIIM7ONWJ%2F20201009%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20201009T174026Z&X-Amz-Expires=43200&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEA8aCXVzLWVhc3QtMSJHMEUCIBznL6LSjtxZx2rmNacevS3fkUtCntzn8hEERS3I9zGcAiEArLoRIu6slpEVHMaKK2%2B3LaXK5vJeEVlwmQ1en1xBlswqtAMIRxABGgw3MzYzNzAzNzE3MjIiDN38MnchbBVYZCS%2BfiqRA9sgC51NLCQ0stU6s2Dek7gt8JmSth7oYLHE8v1WhK3WaiBfe%2FV6LqnrqJcGIikCXr05GqQalWZQLITG1mwC%2Fkx6x5XL5jKFw67lXUvoZzmctRoQPpXpA6MJBTvdCZJKifAS2grLExBJ7KUrgGH6MCxiHpZwm5cO1VP9E5ETFcOTtVzgJtSU0TX70Z4%2BVZPwbxbuEnnqCuW61MZkMvT4dF6oVkZZBR8JuaaiM4w17FV%2B%2Bzt3l39EP9iZdv7NG6G6ZFjvL5UgkVfOm0Bn2w6JONEl8upiOqQN1voen8TugywgWm683isabg1LK2c5GNVWR4qEYbnpS2jZhd732IuDgl1De1V93O5WW2Xf0HGqXhIWYHf9ZDViwWrMXQc5VRQwDIukAgwIy5%2FiBUEwjNBavu4eiWcqtVIQ8OxH9CJIBrQMgPaB%2FtV9LZRGAH24ZwcBD%2FEu%2BEWEDPnR6giE24nAAkWAMlhPQI5NKGGy6y4SLxJ5KalD5yb4Twi0W%2Fvj7bUxfYBSebAn%2B4zldwvFPzWwJRxbMMTdgfwFOusBof6%2FydFCa12JdZERNpiC49pjSmal6DP7rl91JmwVKzG%2FIIENnlBIjZ1yvEtFWy2WcEDqnn2OfEeRc5vop%2FUHnRo3i1TEC8IHs7ECCwwWcf6UAB0%2FUXL8fGj6uQ7KuQ7DLphrZBMfpUz8JXRx1FVRKMWioszeYfL9dQ%2B24GDsESAN83y%2B19ZRdy727X7GsvnZQvdWo7zHQT4zXDmJB0RFtMHwHYtALsGHUyymyA%2FaQjfnbnccvesgGvLGpqdwmXZ0QFMmNobOlJA4STZY%2FejLulxq%2BNhmrvih83%2BSn5Q0043c2%2BzLYeSGs8jUJg%3D%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=cb9a006b693e4b4e17948be0ccbb28739627daf0766f521cb98a2e5643ab9229", - "description": { - "en": "URL where you can get the rendered image file.", - "pt": "URL em que será possível obter o arquivo de imagem renderizado.", - "es": "URL donde puede obtener el archivo de imagen renderizada." - } - } - } - } - }, - "type": { - "type": "string", - "example": "shipping_evidence", - "description": { - "en": "Presents the type of evidence of sending the request related to the claim. It can take one of the following values:", - "pt": "Apresenta o tipo de evidência de envio do pedido relacionado à reclamação. Pode assumir um dos seguintes valores:", - "es": "Muestra el tipo de evidencia de envío del pedido relacionado con el reclamo. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "shipping_evidence", - "description": { - "en": "The seller has an evidence that the order was shipped.", - "pt": "O vendedor tem uma prova referente ao envio do pedido.", - "es": "El vendedor tiene una prueba relacionada con el envío del pedido." - } - }, - { - "title": "handling_shipping_evidence", - "description": { - "en": "There is still no evidence of sending the order, but this information is expected.", - "pt": "Ainda não há uma prova de envio do pedido, mas há uma previsão desta informação.", - "es": "Aún no hay una prueba de envío del pedido, pero hay una previsión de esta información." - } - } - ] - }, - "date_shipped": { - "type": "string", - "example": "2018-03-07T05:00:00Z", - "description": { - "en": "Displays the shipping date of the order associated with the claim.", - "pt": "Apresenta a data de envio do pedido associado à reclamação.", - "es": "Muestra la fecha de envío del pedido asociado al reclamo." - } - }, - "date_delivered": { - "type": "string", - "example": null, - "description": { - "en": "Displays the delivery date of the order associated with the claim.", - "pt": "Exibe a data de entrega do pedido associado à reclamação.", - "es": "Muestra la fecha de entrega del pedido asociado al reclamo." - } - }, - "destination_agency": { - "type": "string", - "example": null, - "description": { - "en": "Informs the name of the agency to which the order is being sent.", - "pt": "Informa o nome da agência para a qual o pedido está sendo enviado.", - "es": "Informa el nombre de la agencia a la que se envía el pedido." - } - }, - "receiver_email": { - "type": "string", - "example": null, - "description": { - "en": "Email of the recipient of the order associated with the claim.", - "pt": "E-mail do destinatário do pedido associado à reclamação.", - "es": "Email del destinatario del pedido asociado al reclamo." - } - }, - "receiver_id": { - "type": "string", - "example": null, - "description": { - "en": "Displays a personal document number of the person who received the product.", - "pt": "Exibe um número de documento pessoal de quem recebeu o produto.", - "es": "Muestra un número de documento personal de quien recibió el producto." - } - }, - "receiver_name": { - "type": "string", - "example": null, - "description": { - "en": "Displays the name of the order recipient.", - "pt": "Apresenta o nome do destinatário do pedido.", - "es": "Presenta el nombre del destinatario del pedido." - } - }, - "shipping_company_name": { - "type": "string", - "example": "servientrega", - "description": { - "en": "Name of the company responsible for transporting the order.", - "pt": "Nome da empresa responsável pelo transporte do pedido.", - "es": "Nombre de la empresa responsable del transporte del pedido." - } - }, - "shipping_method": { - "type": "string", - "example": "mail", - "description": { - "en": "Refers to the method of shipping the product, which can be: order (by tracking), personal delivery (by person) or by email (e-mail).", - "pt": "Refere-se à forma de envio do produto, podendo ser: encomenda (por transportadora), entrega pessoal (por pessoa) ou por e-mail (e-mail).", - "es": "Refiere a cómo enviaron el producto, que puede ser: encomienda (por un transportista), entrega personal (por una persona) o por email (correo electrónico)." - } - }, - "tracking_number": { - "type": "string", - "example": "132456787", - "description": { - "en": "Provides the order delivery tracking number.", - "pt": "Informa o número de rastreio da entrega do pedido.", - "es": "Informa el número de seguimiento del envío del pedido." - } - } - } - } - } - } - } - } - }, - "title": { - "en": "Get claim evidence", - "pt": "Obter evidências da reclamação", - "es": "Obtener evidencias del reclamo" - } - } - }, - "/v1/claims/{claim_id}/actions/evidences": { - "post": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows you to upload, through a valid token, evidence of sending the order. For a delivery by mail the fields 'shipping_company_name' and 'date_shipped' are required, while for a delivery to order the required fields are 'shipping_company_name', 'destination_agency', 'date_shipped' and 'receiver_name'. For delivery by email, the 'receiver_email' and 'date_shipped' fields are mandatory", - "pt": "Este endpoint permite carregar, mediante um token válido, evidências de envio do pedido. Para uma entrega por correio, os campos 'shipping_company_name' e 'date_shipped' são obrigatórios, enquanto para uma entrega por encomenda os campos obrigatórios são 'shipping_company_name', 'destination_agency', 'date_shipped' e 'receiver_name'. Para entrega por e-mail, os campos 'receiver_email' e 'date_shipped' são obrigatórios", - "es": "Este endpoint permite cargar, mediante un token válido, evidencias de envío del pedido. Para una entrega por correo son obligatorios los campos 'shipping_company_name' y 'date_shipped', mientras una entrega por encomienda los campos obligatorios son 'shipping_company_name', 'destination_agency', 'date_shipped' y 'receiver_name'. Para entrega por email son obligatorios los campos 'receiver_email' y 'date_shipped'" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "attachments": { - "type": "string", - "example": "38f4e399-0f18-41e4-8f48-91aecd2dee1a_419059118.png", - "description": { - "en": "File attached to the message associated with the claim.", - "pt": "Arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "type": { - "type": "string", - "example": "shipping_evidence", - "description": { - "en": "The type of evidence of sending the request related to the claim. It can take one of the following values:", - "pt": "Tipo de evidência de envio do pedido relacionado à reclamação. Pode assumir um dos seguintes valores:", - "es": "Tipo de evidencia de envío del pedido relacionado con el reclamo. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "shipping_evidence", - "description": { - "en": "The seller has an evidence that the order was shipped.", - "pt": "O vendedor tem uma prova referente ao envio do pedido.", - "es": "El vendedor tiene una prueba relacionada con el envío del pedido." - } - }, - { - "title": "handling_shipping_evidence", - "description": { - "en": "There is still no evidence of sending the order, but this information is expected.", - "pt": "Ainda não há uma prova de envio do pedido, mas há uma previsão desta informação.", - "es": "Aún no hay una prueba de envío del pedido, pero hay una previsión de esta información." + "en": "The resolution loaded by the person was accepted by their counterpart or, alternatively, by the Mercado", + "pt": "A resolução carregada pela pessoa foi aceita por sua contraparte ou, caso contrário, pelo mediador do Mercado Pago.", + "es": "La resolución cargada por la persona fue aceptada por su contraparte o, en su defecto, por el mediador de Mercado Pago." + } + }, + { + "title": "rejected", + "description": { + "en": "The resolution loaded by the person was rejected by the counterpart, and alternatively, they loaded a new resolution option.", + "pt": "A resolução carregada pela pessoa foi rejeitada pela contraparte e, em contra partida, ela carregou uma nova opção de resolução.", + "es": "La resolución cargada por la persona fue rechazada por su contraparte y, en su defecto, cargó una nueva opción de resolución." + } } - } - ] - }, - "date_shipped": { - "type": "string", - "example": "2023-03-07T05:00:00Z", - "description": { - "en": "The shipping date of the order associated with the claim.", - "pt": "Data de envio do pedido associado à reclamação.", - "es": "Fecha de envío del pedido asociado al reclamo." - } - }, - "date_delivered": { - "type": "string", - "example": "2023-03-15T05:00:00Z", - "description": { - "en": "Delivery date of the order associated with the claim.", - "pt": "Data de entrega do pedido associado à reclamação.", - "es": "Fecha de entrega del pedido asociado al reclamo." - } - }, - "destination_agency": { - "type": "string", - "example": "Melicidade", - "description": { - "en": "Name of the agency to which the order is being sent.", - "pt": "Nome da agência para a qual o pedido está sendo enviado.", - "es": "Nombre de la agencia a la que se envía el pedido." - } - }, - "receiver_email": { - "type": "string", - "example": "test_user_123@testuser.com", - "description": { - "en": "Email of the recipient of the order associated with the claim.", - "pt": "E-mail do destinatário do pedido associado à reclamação.", - "es": "Email del destinatario del pedido asociado al reclamo." - } - }, - "receiver_id": { - "type": "string", - "example": 156762, - "description": { - "en": "Personal document number of the person who received the product.", - "pt": "Número de documento pessoal de quem recebeu o produto.", - "es": "Número de documento personal de quien recibió el producto." - } - }, - "receiver_name": { - "type": "string", - "example": "Tester", - "description": { - "en": "Name of the order recipient.", - "pt": "Nome do destinatário do pedido.", - "es": "Nombre del destinatario del pedido." - } - }, - "shipping_company_name": { - "type": "string", - "example": "servientrega", - "description": { - "en": "Name of the company responsible for transporting the order.", - "pt": "Nome da empresa responsável pelo transporte do pedido.", - "es": "Nombre de la empresa responsable del transporte del pedido." - } - }, - "shipping_method": { - "type": "string", - "example": "mail", - "description": { - "en": "Refers to the method of shipping the product, which can be: order (by tracking), personal delivery (by person) or by email (e-mail).", - "pt": "Refere-se à forma de envio do produto, podendo ser: encomenda (por transportadora), entrega pessoal (por pessoa) ou por e-mail (e-mail).", - "es": "Refiere a cómo enviaron el producto, que puede ser: encomienda (por un transportista), entrega personal (por una persona) o por email (correo electrónico)." - } - }, - "tracking_number": { - "type": "string", - "example": 132456787, - "description": { - "en": "The order delivery tracking number.", - "pt": "Número de rastreio da entrega do pedido.", - "es": "Número de seguimiento del envío del pedido." + ] } } } } } } - }, - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "attachments": { - "type": "array", - "description": { - "en": "Presents information about the file attached to the message associated with the claim.", - "pt": "Apresenta informações sobre o arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Muestra información sobre el archivo de imagen adjunto al mensaje asociado al reclamo." - }, - "items": { - "type": "object", - "properties": { - "filename": { - "type": "string", - "example": "8007ee20-be67-471f-9e59-e32d9ba02fae_239628932.jpeg", - "description": { - "en": "Current name (hashed - used for retrieving the attachment) of the image file attached to the message associated with the claim.", - "pt": "Nome atual (hashado - utilizado para recuperar o anexo) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre actual (hasheado - utilizado para recuperar el attachment) del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "original_filename": { - "type": "string", - "example": "Captura-de-Tela-2019-07-30.png", - "description": { - "en": "Original name of the image file attached to the message associated with the claim.", - "pt": "Nome original do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre original del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "size": { - "type": "number", - "example": 1880609, - "description": { - "en": "Size (in bytes) of the image file attached to the message associated with the claim.", - "pt": "Tamanho (em bytes) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tamaño (en bytes) del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "date_created": { - "type": "string", - "example": "2020-07-22T20:43:15.000-04:00", - "description": { - "en": "Date when the image file was attached to the message associated with the complaint.", - "pt": "Data em que o arquivo de imagem foi anexado à mensagem que está associada à reclamação.", - "es": "Fecha en que se adjuntó el archivo de imagen al mensaje que está asociado al reclamo." - } - }, - "type": { - "type": "string", - "example": "image/jpeg", - "description": { - "en": "Type of image file attached to the message associated with the claim.", - "pt": "Tipo do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tipo de archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "file_url": { - "type": "string", - "example": "https://fury-storage-private-default.s3.amazonaws.com/mediations-api-core/attachment2/767b79a6-88c8-4fa4-8d95-2cb78fcd897f.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2W4YYFSFIIM7ONWJ%2F20201009%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20201009T174026Z&X-Amz-Expires=43200&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEA8aCXVzLWVhc3QtMSJHMEUCIBznL6LSjtxZx2rmNacevS3fkUtCntzn8hEERS3I9zGcAiEArLoRIu6slpEVHMaKK2%2B3LaXK5vJeEVlwmQ1en1xBlswqtAMIRxABGgw3MzYzNzAzNzE3MjIiDN38MnchbBVYZCS%2BfiqRA9sgC51NLCQ0stU6s2Dek7gt8JmSth7oYLHE8v1WhK3WaiBfe%2FV6LqnrqJcGIikCXr05GqQalWZQLITG1mwC%2Fkx6x5XL5jKFw67lXUvoZzmctRoQPpXpA6MJBTvdCZJKifAS2grLExBJ7KUrgGH6MCxiHpZwm5cO1VP9E5ETFcOTtVzgJtSU0TX70Z4%2BVZPwbxbuEnnqCuW61MZkMvT4dF6oVkZZBR8JuaaiM4w17FV%2B%2Bzt3l39EP9iZdv7NG6G6ZFjvL5UgkVfOm0Bn2w6JONEl8upiOqQN1voen8TugywgWm683isabg1LK2c5GNVWR4qEYbnpS2jZhd732IuDgl1De1V93O5WW2Xf0HGqXhIWYHf9ZDViwWrMXQc5VRQwDIukAgwIy5%2FiBUEwjNBavu4eiWcqtVIQ8OxH9CJIBrQMgPaB%2FtV9LZRGAH24ZwcBD%2FEu%2BEWEDPnR6giE24nAAkWAMlhPQI5NKGGy6y4SLxJ5KalD5yb4Twi0W%2Fvj7bUxfYBSebAn%2B4zldwvFPzWwJRxbMMTdgfwFOusBof6%2FydFCa12JdZERNpiC49pjSmal6DP7rl91JmwVKzG%2FIIENnlBIjZ1yvEtFWy2WcEDqnn2OfEeRc5vop%2FUHnRo3i1TEC8IHs7ECCwwWcf6UAB0%2FUXL8fGj6uQ7KuQ7DLphrZBMfpUz8JXRx1FVRKMWioszeYfL9dQ%2B24GDsESAN83y%2B19ZRdy727X7GsvnZQvdWo7zHQT4zXDmJB0RFtMHwHYtALsGHUyymyA%2FaQjfnbnccvesgGvLGpqdwmXZ0QFMmNobOlJA4STZY%2FejLulxq%2BNhmrvih83%2BSn5Q0043c2%2BzLYeSGs8jUJg%3D%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=cb9a006b693e4b4e17948be0ccbb28739627daf0766f521cb98a2e5643ab9229", - "description": { - "en": "URL where you can get the rendered image file.", - "pt": "URL em que será possível obter o arquivo de imagem renderizado.", - "es": "URL donde puede obtener el archivo de imagen renderizada." - } - } - } - } + } + }, + "title": { + "en": "See expected resolutions at mediation", + "pt": "Ver resoluções esperadas na mediação", + "es": "Ver resoluciones esperadas en mediación" + } + } + }, + "/post-purchase/v1/claims/{claim_id}/evidences": { + "get": { + "tags": [ + "checkout-pro" + ], + "description": { + "en": "This endpoint allows, through a valid token, obtaining evidence of the the claim, such as order shipping information and attached image files associated with the claim", + "pt": "Este endpoint permite obter, mediante um token válido, evidências da reclamação como, por exemplo, informações de envio do pedido e de anexos de imagens associados à reclamação", + "es": "Este endpoint permite obtener, mediante un token válido, evidencias del reclamo, como información de envío del pedido y archivos de imágenes adjuntos asociados al reclamo" + }, + "parameters": [ + { + "in": "path", + "name": "claim_id", + "required": true, + "schema": { + "type": "number", + "example": 5039218470 + }, + "description": { + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." + } + } + ], + "responses": { + "200": { + "description": { + "es": "Success", + "pt": "Sucesso", + "en": "Éxito" + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "attachments": { + "type": "array", + "description": { + "en": "Presents information about the file attached to the message associated with the claim.", + "pt": "Apresenta informações sobre o arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Muestra información sobre el archivo de imagen adjunto al mensaje asociado al reclamo." }, - "type": { - "type": "string", - "example": "shipping_evidence", - "description": { - "en": "Presents the type of evidence of sending the request related to the claim. It can take one of the following values:", - "pt": "Apresenta o tipo de evidência de envio do pedido relacionado à reclamação. Pode assumir um dos seguintes valores:", - "es": "Muestra el tipo de evidencia de envío del pedido relacionado con el reclamo. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "shipping_evidence", + "items": { + "type": "object", + "properties": { + "filename": { + "type": "string", + "example": "8007ee20-be67-471f-9e59-e32d9ba02fae_239628932.jpeg", + "description": { + "en": "Current name (hashed - used for retrieving the attachment) of the image file attached to the message associated with the claim.", + "pt": "Nome atual (hashado - utilizado para recuperar o anexo) do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Nombre actual (hasheado - utilizado para recuperar el attachment) del archivo de imagen adjunto al mensaje asociado al reclamo." + } + }, + "original_filename": { + "type": "string", + "example": "Captura-de-Tela-2019-07-30.png", + "description": { + "en": "Original name of the image file attached to the message associated with the claim.", + "pt": "Nome original do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Nombre original del archivo de imagen adjunto al mensaje asociado al reclamo." + } + }, + "size": { + "type": "number", + "example": 1880609, + "description": { + "en": "Size (in bytes) of the image file attached to the message associated with the claim.", + "pt": "Tamanho (em bytes) do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Tamaño (en bytes) del archivo de imagen adjunto al mensaje asociado al reclamo." + } + }, + "type": { + "type": "string", + "example": "image/jpeg", + "description": { + "en": "Type of image file attached to the message associated with the claim.", + "pt": "Tipo do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Tipo de archivo de imagen adjunto al mensaje asociado al reclamo." + } + }, + "date_created": { + "type": "string", + "example": "2020-07-22T20:43:15.000-04:00", "description": { - "en": "The seller has an evidence that the order was shipped.", - "pt": "O vendedor tem uma prova referente ao envio do pedido.", - "es": "El vendedor tiene una prueba relacionada con el envío del pedido." + "en": "Date when the image file was attached to the message associated with the complaint.", + "pt": "Data em que o arquivo de imagem foi anexado à mensagem que está associada à reclamação.", + "es": "Fecha en que se adjuntó el archivo de imagen al mensaje que está asociado al reclamo." } }, - { - "title": "handling_shipping_evidence", + "file_url": { + "type": "string", + "example": "https://fury-storage-private-default.s3.amazonaws.com/mediations-api-core/attachment2/767b79a6-88c8-4fa4-8d95-2cb78fcd897f.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2W4YYFSFIIM7ONWJ%2F20201009%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20201009T174026Z&X-Amz-Expires=43200&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEA8aCXVzLWVhc3QtMSJHMEUCIBznL6LSjtxZx2rmNacevS3fkUtCntzn8hEERS3I9zGcAiEArLoRIu6slpEVHMaKK2%2B3LaXK5vJeEVlwmQ1en1xBlswqtAMIRxABGgw3MzYzNzAzNzE3MjIiDN38MnchbBVYZCS%2BfiqRA9sgC51NLCQ0stU6s2Dek7gt8JmSth7oYLHE8v1WhK3WaiBfe%2FV6LqnrqJcGIikCXr05GqQalWZQLITG1mwC%2Fkx6x5XL5jKFw67lXUvoZzmctRoQPpXpA6MJBTvdCZJKifAS2grLExBJ7KUrgGH6MCxiHpZwm5cO1VP9E5ETFcOTtVzgJtSU0TX70Z4%2BVZPwbxbuEnnqCuW61MZkMvT4dF6oVkZZBR8JuaaiM4w17FV%2B%2Bzt3l39EP9iZdv7NG6G6ZFjvL5UgkVfOm0Bn2w6JONEl8upiOqQN1voen8TugywgWm683isabg1LK2c5GNVWR4qEYbnpS2jZhd732IuDgl1De1V93O5WW2Xf0HGqXhIWYHf9ZDViwWrMXQc5VRQwDIukAgwIy5%2FiBUEwjNBavu4eiWcqtVIQ8OxH9CJIBrQMgPaB%2FtV9LZRGAH24ZwcBD%2FEu%2BEWEDPnR6giE24nAAkWAMlhPQI5NKGGy6y4SLxJ5KalD5yb4Twi0W%2Fvj7bUxfYBSebAn%2B4zldwvFPzWwJRxbMMTdgfwFOusBof6%2FydFCa12JdZERNpiC49pjSmal6DP7rl91JmwVKzG%2FIIENnlBIjZ1yvEtFWy2WcEDqnn2OfEeRc5vop%2FUHnRo3i1TEC8IHs7ECCwwWcf6UAB0%2FUXL8fGj6uQ7KuQ7DLphrZBMfpUz8JXRx1FVRKMWioszeYfL9dQ%2B24GDsESAN83y%2B19ZRdy727X7GsvnZQvdWo7zHQT4zXDmJB0RFtMHwHYtALsGHUyymyA%2FaQjfnbnccvesgGvLGpqdwmXZ0QFMmNobOlJA4STZY%2FejLulxq%2BNhmrvih83%2BSn5Q0043c2%2BzLYeSGs8jUJg%3D%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=cb9a006b693e4b4e17948be0ccbb28739627daf0766f521cb98a2e5643ab9229", "description": { - "en": "There is still no evidence of sending the order, but this information is expected.", - "pt": "Ainda não há uma prova de envio do pedido, mas há uma previsão desta informação.", - "es": "Aún no hay una prueba de envío del pedido, pero hay una previsión de esta información." + "en": "URL where you can get the rendered image file.", + "pt": "URL em que será possível obter o arquivo de imagem renderizado.", + "es": "URL donde puede obtener el archivo de imagen renderizada." } } - ] - }, - "date_shipped": { - "type": "string", - "example": "2023-03-07T05:00:00Z", - "description": { - "en": "Displays the shipping date of the order associated with the claim.", - "pt": "Apresenta a data de envio do pedido associado à reclamação.", - "es": "Muestra la fecha de envío del pedido asociado al reclamo." - } - }, - "date_delivered": { - "type": "string", - "example": "2023-03-15T05:00:00Z", - "description": { - "en": "Displays the delivery date of the order associated with the claim.", - "pt": "Exibe a data de entrega do pedido associado à reclamação.", - "es": "Muestra la fecha de entrega del pedido asociado al reclamo." - } - }, - "destination_agency": { - "type": "string", - "example": "Melicidade", - "description": { - "en": "Informs the name of the agency to which the order is being sent.", - "pt": "Informa o nome da agência para a qual o pedido está sendo enviado.", - "es": "Informa el nombre de la agencia a la que se envía el pedido." - } - }, - "receiver_email": { - "type": "string", - "example": "test_user_123@testuser.com", - "description": { - "en": "Email of the recipient of the order associated with the claim.", - "pt": "E-mail do destinatário do pedido associado à reclamação.", - "es": "Email del destinatario del pedido asociado al reclamo." - } - }, - "receiver_id": { - "type": "string", - "example": 156762, - "description": { - "en": "Displays a personal document number of the person who received the product.", - "pt": "Exibe um número de documento pessoal de quem recebeu o produto.", - "es": "Muestra un número de documento personal de quien recibió el producto." - } - }, - "receiver_name": { - "type": "string", - "example": "Teste", - "description": { - "en": "Displays the name of the order recipient.", - "pt": "Apresenta o nome do destinatário do pedido.", - "es": "Presenta el nombre del destinatario del pedido." - } - }, - "shipping_company_name": { - "type": "string", - "example": "servientrega", - "description": { - "en": "Name of the company responsible for transporting the order.", - "pt": "Nome da empresa responsável pelo transporte do pedido.", - "es": "Nombre de la empresa responsable del transporte del pedido." - } - }, - "shipping_method": { - "type": "string", - "example": "mail", - "description": { - "en": "Refers to the method of shipping the product, which can be: order (by tracking), personal delivery (by person) or by email (e-mail).", - "pt": "Refere-se à forma de envio do produto, podendo ser: encomenda (por transportadora), entrega pessoal (por pessoa) ou por e-mail (e-mail).", - "es": "Refiere a cómo enviaron el producto, que puede ser: encomienda (por un transportista), entrega personal (por una persona) o por email (correo electrónico)." } + } + }, + "type": { + "type": "string", + "example": "shipping_evidence", + "description": { + "en": "Presents the type of evidence of sending the request related to the claim. It can take one of the following values:", + "pt": "Apresenta o tipo de evidência de envio do pedido relacionado à reclamação. Pode assumir um dos seguintes valores:", + "es": "Muestra el tipo de evidencia de envío del pedido relacionado con el reclamo. Puede tomar alguno de los siguientes valores:" }, - "tracking_number": { - "type": "string", - "example": 132456787, - "description": { - "en": "Provides the order delivery tracking number.", - "pt": "Informa o número de rastreio da entrega do pedido.", - "es": "Informa el número de seguimiento del envío del pedido." + "enum": [ + { + "title": "shipping_evidence", + "description": { + "en": "The seller has an evidence that the order was shipped.", + "pt": "O vendedor tem uma prova referente ao envio do pedido.", + "es": "El vendedor tiene una prueba relacionada con el envío del pedido." + } + }, + { + "title": "handling_shipping_evidence", + "description": { + "en": "There is still no evidence of sending the order, but this information is expected.", + "pt": "Ainda não há uma prova de envio do pedido, mas há uma previsão desta informação.", + "es": "Aún no hay una prueba de envío del pedido, pero hay una previsión de esta información." + } } + ] + }, + "date_shipped": { + "type": "string", + "example": "2018-03-07T05:00:00Z", + "description": { + "en": "Displays the shipping date of the order associated with the claim.", + "pt": "Apresenta a data de envio do pedido associado à reclamação.", + "es": "Muestra la fecha de envío del pedido asociado al reclamo." + } + }, + "date_delivered": { + "type": "string", + "example": null, + "description": { + "en": "Displays the delivery date of the order associated with the claim.", + "pt": "Exibe a data de entrega do pedido associado à reclamação.", + "es": "Muestra la fecha de entrega del pedido asociado al reclamo." + } + }, + "destination_agency": { + "type": "string", + "example": null, + "description": { + "en": "Informs the name of the agency to which the order is being sent.", + "pt": "Informa o nome da agência para a qual o pedido está sendo enviado.", + "es": "Informa el nombre de la agencia a la que se envía el pedido." + } + }, + "receiver_email": { + "type": "string", + "example": null, + "description": { + "en": "Email of the recipient of the order associated with the claim.", + "pt": "E-mail do destinatário do pedido associado à reclamação.", + "es": "Email del destinatario del pedido asociado al reclamo." + } + }, + "receiver_id": { + "type": "string", + "example": null, + "description": { + "en": "Displays a personal document number of the person who received the product.", + "pt": "Exibe um número de documento pessoal de quem recebeu o produto.", + "es": "Muestra un número de documento personal de quien recibió el producto." + } + }, + "receiver_name": { + "type": "string", + "example": null, + "description": { + "en": "Displays the name of the order recipient.", + "pt": "Apresenta o nome do destinatário do pedido.", + "es": "Presenta el nombre del destinatario del pedido." + } + }, + "shipping_company_name": { + "type": "string", + "example": "servientrega", + "description": { + "en": "Name of the company responsible for transporting the order.", + "pt": "Nome da empresa responsável pelo transporte do pedido.", + "es": "Nombre de la empresa responsable del transporte del pedido." + } + }, + "shipping_method": { + "type": "string", + "example": "mail", + "description": { + "en": "Refers to the method of shipping the product, which can be: order (by tracking), personal delivery (by person) or by email (e-mail).", + "pt": "Refere-se à forma de envio do produto, podendo ser: encomenda (por transportadora), entrega pessoal (por pessoa) ou por e-mail (e-mail).", + "es": "Refiere a cómo enviaron el producto, que puede ser: encomienda (por un transportista), entrega personal (por una persona) o por email (correo electrónico)." + } + }, + "tracking_number": { + "type": "string", + "example": "132456787", + "description": { + "en": "Provides the order delivery tracking number.", + "pt": "Informa o número de rastreio da entrega do pedido.", + "es": "Informa el número de seguimiento del envío del pedido." } } } @@ -3225,167 +3278,356 @@ } } } - }, - "title": { - "en": "Upload shipping evidence", - "pt": "Carregar evidências de envio", - "es": "Cargar evidencias de envío" } + }, + "title": { + "en": "Get claim evidence", + "pt": "Obter evidências da reclamação", + "es": "Obtener evidencias del reclamo" } - }, - "/v1/claims/{claim_id}/status_history": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows you to view, through a valid token, the history of states and scenarios that the complaint has gone through. It will also be possible to consult the history of actions taken by the people responsible for the complaint", - "pt": "Este endpoint permite visualizar, por meio de um token válido, o histórico de estados e cenários pelos quais a reclamação passou. Também será possível consultar o histórico de ações tomadas pelas pessoas responsáveis pela reclamação", - "es": "Este endpoint permite visualizar, a través de un token válido, el historial de estados y escenarios por los que ha pasado el reclamo. También será posible consultar el historial de acciones tomadas por los responsables del reclamo" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, + } + }, + "/post-purchase/v1/claims/{claim_id}/actions/evidences": { + "post": { + "tags": [ + "checkout-pro" + ], + "description": { + "en": "This endpoint allows you to upload, through a valid token, evidence of sending the order. For a delivery by mail the fields 'shipping_company_name' and 'date_shipped' are required, while for a delivery to order the required fields are 'shipping_company_name', 'destination_agency', 'date_shipped' and 'receiver_name'. For delivery by email, the 'receiver_email' and 'date_shipped' fields are mandatory", + "pt": "Este endpoint permite carregar, mediante um token válido, evidências de envio do pedido. Para uma entrega por correio, os campos 'shipping_company_name' e 'date_shipped' são obrigatórios, enquanto para uma entrega por encomenda os campos obrigatórios são 'shipping_company_name', 'destination_agency', 'date_shipped' e 'receiver_name'. Para entrega por e-mail, os campos 'receiver_email' e 'date_shipped' são obrigatórios", + "es": "Este endpoint permite cargar, mediante un token válido, evidencias de envío del pedido. Para una entrega por correo son obligatorios los campos 'shipping_company_name' y 'date_shipped', mientras una entrega por encomienda los campos obligatorios son 'shipping_company_name', 'destination_agency', 'date_shipped' y 'receiver_name'. Para entrega por email son obligatorios los campos 'receiver_email' y 'date_shipped'" + }, + "parameters": [ + { + "in": "path", + "name": "claim_id", + "required": true, + "schema": { + "type": "number", + "example": 5039218470 + }, + "description": { + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." + } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." + "type": "object", + "properties": { + "attachments": { + "type": "string", + "example": "38f4e399-0f18-41e4-8f48-91aecd2dee1a_419059118.png", + "description": { + "en": "File attached to the message associated with the claim.", + "pt": "Arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Archivo de imagen adjunto al mensaje asociado al reclamo." + } + }, + "type": { + "type": "string", + "example": "shipping_evidence", + "description": { + "en": "The type of evidence of sending the request related to the claim. It can take one of the following values:", + "pt": "Tipo de evidência de envio do pedido relacionado à reclamação. Pode assumir um dos seguintes valores:", + "es": "Tipo de evidencia de envío del pedido relacionado con el reclamo. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "shipping_evidence", + "description": { + "en": "The seller has an evidence that the order was shipped.", + "pt": "O vendedor tem uma prova referente ao envio do pedido.", + "es": "El vendedor tiene una prueba relacionada con el envío del pedido." + } + }, + { + "title": "handling_shipping_evidence", + "description": { + "en": "There is still no evidence of sending the order, but this information is expected.", + "pt": "Ainda não há uma prova de envio do pedido, mas há uma previsão desta informação.", + "es": "Aún no hay una prueba de envío del pedido, pero hay una previsión de esta información." + } + } + ] + }, + "date_shipped": { + "type": "string", + "example": "2023-03-07T05:00:00Z", + "description": { + "en": "The shipping date of the order associated with the claim.", + "pt": "Data de envio do pedido associado à reclamação.", + "es": "Fecha de envío del pedido asociado al reclamo." + } + }, + "date_delivered": { + "type": "string", + "example": "2023-03-15T05:00:00Z", + "description": { + "en": "Delivery date of the order associated with the claim.", + "pt": "Data de entrega do pedido associado à reclamação.", + "es": "Fecha de entrega del pedido asociado al reclamo." + } + }, + "destination_agency": { + "type": "string", + "example": "Melicidade", + "description": { + "en": "Name of the agency to which the order is being sent.", + "pt": "Nome da agência para a qual o pedido está sendo enviado.", + "es": "Nombre de la agencia a la que se envía el pedido." + } + }, + "receiver_email": { + "type": "string", + "example": "test_user_123@testuser.com", + "description": { + "en": "Email of the recipient of the order associated with the claim.", + "pt": "E-mail do destinatário do pedido associado à reclamação.", + "es": "Email del destinatario del pedido asociado al reclamo." + } + }, + "receiver_id": { + "type": "string", + "example": 156762, + "description": { + "en": "Personal document number of the person who received the product.", + "pt": "Número de documento pessoal de quem recebeu o produto.", + "es": "Número de documento personal de quien recibió el producto." + } + }, + "receiver_name": { + "type": "string", + "example": "Tester", + "description": { + "en": "Name of the order recipient.", + "pt": "Nome do destinatário do pedido.", + "es": "Nombre del destinatario del pedido." + } + }, + "shipping_company_name": { + "type": "string", + "example": "servientrega", + "description": { + "en": "Name of the company responsible for transporting the order.", + "pt": "Nome da empresa responsável pelo transporte do pedido.", + "es": "Nombre de la empresa responsable del transporte del pedido." + } + }, + "shipping_method": { + "type": "string", + "example": "mail", + "description": { + "en": "Refers to the method of shipping the product, which can be: order (by tracking), personal delivery (by person) or by email (e-mail).", + "pt": "Refere-se à forma de envio do produto, podendo ser: encomenda (por transportadora), entrega pessoal (por pessoa) ou por e-mail (e-mail).", + "es": "Refiere a cómo enviaron el producto, que puede ser: encomienda (por un transportista), entrega personal (por una persona) o por email (correo electrónico)." + } + }, + "tracking_number": { + "type": "string", + "example": 132456787, + "description": { + "en": "The order delivery tracking number.", + "pt": "Número de rastreio da entrega do pedido.", + "es": "Número de seguimiento del envío del pedido." + } + } + } } } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "stage": { - "type": "string", - "example": "dispute", - "description": { - "en": "Indicates the current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", - "pt": "Indica a fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", - "es": "Indica la fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "claim", + } + }, + "responses": { + "201": { + "description": { + "es": "Success", + "pt": "Sucesso", + "en": "Éxito" + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "attachments": { + "type": "array", + "description": { + "en": "Presents information about the file attached to the message associated with the claim.", + "pt": "Apresenta informações sobre o arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Muestra información sobre el archivo de imagen adjunto al mensaje asociado al reclamo." + }, + "items": { + "type": "object", + "properties": { + "filename": { + "type": "string", + "example": "8007ee20-be67-471f-9e59-e32d9ba02fae_239628932.jpeg", "description": { - "en": "Initial stage of the claim process in which both the buyer and seller are involved.", - "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", - "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." + "en": "Current name (hashed - used for retrieving the attachment) of the image file attached to the message associated with the claim.", + "pt": "Nome atual (hashado - utilizado para recuperar o anexo) do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Nombre actual (hasheado - utilizado para recuperar el attachment) del archivo de imagen adjunto al mensaje asociado al reclamo." } }, - { - "title": "dispute", + "original_filename": { + "type": "string", + "example": "Captura-de-Tela-2019-07-30.png", "description": { - "en": "Phase where the claim is under dispute or disagreement.", - "pt": "Fase em que a reclamação está em disputa ou desacordo.", - "es": "Fase donde el reclamo está en disputa o desacuerdo." + "en": "Original name of the image file attached to the message associated with the claim.", + "pt": "Nome original do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Nombre original del archivo de imagen adjunto al mensaje asociado al reclamo." } }, - { - "title": "recontact", + "size": { + "type": "number", + "example": 1880609, "description": { - "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", - "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", - "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." + "en": "Size (in bytes) of the image file attached to the message associated with the claim.", + "pt": "Tamanho (em bytes) do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Tamaño (en bytes) del archivo de imagen adjunto al mensaje asociado al reclamo." } }, - { - "title": "none", + "date_created": { + "type": "string", + "example": "2020-07-22T20:43:15.000-04:00", "description": { - "en": "Indicates no specific stage is currently applicable.", - "pt": "Indica que nenhuma etapa específica é aplicável.", - "es": "Indica que no se aplica ninguna etapa específica." + "en": "Date when the image file was attached to the message associated with the complaint.", + "pt": "Data em que o arquivo de imagem foi anexado à mensagem que está associada à reclamação.", + "es": "Fecha en que se adjuntó el archivo de imagen al mensaje que está asociado al reclamo." } - } - ] - }, - "status": { - "type": "string", - "example": "closed", - "description": { - "en": "Specifies the current state of the claim, indicating whether it is open or closed. It can take one of the following values:", - "pt": "Especifica o estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", - "es": "Especifica el estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "opened", + }, + "type": { + "type": "string", + "example": "image/jpeg", "description": { - "en": "Indicates that the claim is open.", - "pt": "Indica que a reclamação está aberta.", - "es": "Indica que el reclamo está abierto." + "en": "Type of image file attached to the message associated with the claim.", + "pt": "Tipo do arquivo de imagem anexado à mensagem associada à reclamação.", + "es": "Tipo de archivo de imagen adjunto al mensaje asociado al reclamo." } }, - { - "title": "closed", + "file_url": { + "type": "string", + "example": "https://fury-storage-private-default.s3.amazonaws.com/mediations-api-core/attachment2/767b79a6-88c8-4fa4-8d95-2cb78fcd897f.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2W4YYFSFIIM7ONWJ%2F20201009%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20201009T174026Z&X-Amz-Expires=43200&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEA8aCXVzLWVhc3QtMSJHMEUCIBznL6LSjtxZx2rmNacevS3fkUtCntzn8hEERS3I9zGcAiEArLoRIu6slpEVHMaKK2%2B3LaXK5vJeEVlwmQ1en1xBlswqtAMIRxABGgw3MzYzNzAzNzE3MjIiDN38MnchbBVYZCS%2BfiqRA9sgC51NLCQ0stU6s2Dek7gt8JmSth7oYLHE8v1WhK3WaiBfe%2FV6LqnrqJcGIikCXr05GqQalWZQLITG1mwC%2Fkx6x5XL5jKFw67lXUvoZzmctRoQPpXpA6MJBTvdCZJKifAS2grLExBJ7KUrgGH6MCxiHpZwm5cO1VP9E5ETFcOTtVzgJtSU0TX70Z4%2BVZPwbxbuEnnqCuW61MZkMvT4dF6oVkZZBR8JuaaiM4w17FV%2B%2Bzt3l39EP9iZdv7NG6G6ZFjvL5UgkVfOm0Bn2w6JONEl8upiOqQN1voen8TugywgWm683isabg1LK2c5GNVWR4qEYbnpS2jZhd732IuDgl1De1V93O5WW2Xf0HGqXhIWYHf9ZDViwWrMXQc5VRQwDIukAgwIy5%2FiBUEwjNBavu4eiWcqtVIQ8OxH9CJIBrQMgPaB%2FtV9LZRGAH24ZwcBD%2FEu%2BEWEDPnR6giE24nAAkWAMlhPQI5NKGGy6y4SLxJ5KalD5yb4Twi0W%2Fvj7bUxfYBSebAn%2B4zldwvFPzWwJRxbMMTdgfwFOusBof6%2FydFCa12JdZERNpiC49pjSmal6DP7rl91JmwVKzG%2FIIENnlBIjZ1yvEtFWy2WcEDqnn2OfEeRc5vop%2FUHnRo3i1TEC8IHs7ECCwwWcf6UAB0%2FUXL8fGj6uQ7KuQ7DLphrZBMfpUz8JXRx1FVRKMWioszeYfL9dQ%2B24GDsESAN83y%2B19ZRdy727X7GsvnZQvdWo7zHQT4zXDmJB0RFtMHwHYtALsGHUyymyA%2FaQjfnbnccvesgGvLGpqdwmXZ0QFMmNobOlJA4STZY%2FejLulxq%2BNhmrvih83%2BSn5Q0043c2%2BzLYeSGs8jUJg%3D%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=cb9a006b693e4b4e17948be0ccbb28739627daf0766f521cb98a2e5643ab9229", "description": { - "en": "Indicates that the claim is closed.", - "pt": "Indica que a reclamação está fechada.", - "es": "Indica que el reclamo está cerrado." + "en": "URL where you can get the rendered image file.", + "pt": "URL em que será possível obter o arquivo de imagem renderizado.", + "es": "URL donde puede obtener el archivo de imagen renderizada." } } - ] - }, - "date": { - "type": "string", - "example": "2020-09-08T23:59:36.000-04:00", - "description": { - "en": "Date of change in claim status.", - "pt": "Data de alteração do estado da reclamação.", - "es": "Fecha de cambio en el estado del reclamo." } + } + }, + "type": { + "type": "string", + "example": "shipping_evidence", + "description": { + "en": "Presents the type of evidence of sending the request related to the claim. It can take one of the following values:", + "pt": "Apresenta o tipo de evidência de envio do pedido relacionado à reclamação. Pode assumir um dos seguintes valores:", + "es": "Muestra el tipo de evidencia de envío del pedido relacionado con el reclamo. Puede tomar alguno de los siguientes valores:" }, - "change_by": { - "type": "string", - "example": "mediator", - "description": { - "en": "Indicates the person who changed the claim. It can take one of the following values:", - "pt": "Apresenta a pessoa que alterou a reclamação. Pode assumir um dos seguintes valores:", - "es": "Indica la persona que cambió el reclamo. Puede tomar alguno de los siguientes valores:" + "enum": [ + { + "title": "shipping_evidence", + "description": { + "en": "The seller has an evidence that the order was shipped.", + "pt": "O vendedor tem uma prova referente ao envio do pedido.", + "es": "El vendedor tiene una prueba relacionada con el envío del pedido." + } }, - "enum": [ - { - "title": "complainant", - "description": { - "en": "Person who claims", - "pt": "Pessoa que reclama.", - "es": "Persona que reclama." - } - }, - { - "title": "respondent", - "description": { - "en": "Person to whom they are complaining.", - "pt": "Pessoa a quem estão reclamando.", - "es": "Persona a quién le reclaman." - } - }, - { - "title": "mediator", - "description": { - "en": "Person who intervenes to help solve the problem.", - "pt": "Pessoa que intervém para ajudar a resolver o problema.", - "es": "Persona que interviene para ayudar a solucionar el problema." - } + { + "title": "handling_shipping_evidence", + "description": { + "en": "There is still no evidence of sending the order, but this information is expected.", + "pt": "Ainda não há uma prova de envio do pedido, mas há uma previsão desta informação.", + "es": "Aún no hay una prueba de envío del pedido, pero hay una previsión de esta información." } - ] + } + ] + }, + "date_shipped": { + "type": "string", + "example": "2023-03-07T05:00:00Z", + "description": { + "en": "Displays the shipping date of the order associated with the claim.", + "pt": "Apresenta a data de envio do pedido associado à reclamação.", + "es": "Muestra la fecha de envío del pedido asociado al reclamo." + } + }, + "date_delivered": { + "type": "string", + "example": "2023-03-15T05:00:00Z", + "description": { + "en": "Displays the delivery date of the order associated with the claim.", + "pt": "Exibe a data de entrega do pedido associado à reclamação.", + "es": "Muestra la fecha de entrega del pedido asociado al reclamo." + } + }, + "destination_agency": { + "type": "string", + "example": "Melicidade", + "description": { + "en": "Informs the name of the agency to which the order is being sent.", + "pt": "Informa o nome da agência para a qual o pedido está sendo enviado.", + "es": "Informa el nombre de la agencia a la que se envía el pedido." + } + }, + "receiver_email": { + "type": "string", + "example": "test_user_123@testuser.com", + "description": { + "en": "Email of the recipient of the order associated with the claim.", + "pt": "E-mail do destinatário do pedido associado à reclamação.", + "es": "Email del destinatario del pedido asociado al reclamo." + } + }, + "receiver_id": { + "type": "string", + "example": 156762, + "description": { + "en": "Displays a personal document number of the person who received the product.", + "pt": "Exibe um número de documento pessoal de quem recebeu o produto.", + "es": "Muestra un número de documento personal de quien recibió el producto." + } + }, + "receiver_name": { + "type": "string", + "example": "Teste", + "description": { + "en": "Displays the name of the order recipient.", + "pt": "Apresenta o nome do destinatário do pedido.", + "es": "Presenta el nombre del destinatario del pedido." + } + }, + "shipping_company_name": { + "type": "string", + "example": "servientrega", + "description": { + "en": "Name of the company responsible for transporting the order.", + "pt": "Nome da empresa responsável pelo transporte do pedido.", + "es": "Nombre de la empresa responsable del transporte del pedido." + } + }, + "shipping_method": { + "type": "string", + "example": "mail", + "description": { + "en": "Refers to the method of shipping the product, which can be: order (by tracking), personal delivery (by person) or by email (e-mail).", + "pt": "Refere-se à forma de envio do produto, podendo ser: encomenda (por transportadora), entrega pessoal (por pessoa) ou por e-mail (e-mail).", + "es": "Refiere a cómo enviaron el producto, que puede ser: encomienda (por un transportista), entrega personal (por una persona) o por email (correo electrónico)." + } + }, + "tracking_number": { + "type": "string", + "example": 132456787, + "description": { + "en": "Provides the order delivery tracking number.", + "pt": "Informa o número de rastreio da entrega do pedido.", + "es": "Informa el número de seguimiento del envío del pedido." } } } @@ -3393,338 +3635,518 @@ } } } - }, - "title": { - "en": "Get claim history", - "pt": "Obter histórico da reclamação", - "es": "Obtener historial del reclamo" } + }, + "title": { + "en": "Upload shipping evidence", + "pt": "Carregar evidências de envio", + "es": "Cargar evidencias de envío" } - }, - "/post-purchase/sites/{site_id}/v2/reasons/{reason_id}": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows you to view, through a valid token, the 'reason' why the claim was created, so that based on its classification, certain behaviors are allowed.", - "pt": "Este endpoint permite visualizar, a través de un token válido, o motivo ('reason') pelo qual uma reclamação foi criada, de forma que com base na sua classificação sejam permitidos determinados comportamentos.", - "es": "Este endpoint permite visualizar, mediante un token válido, el motivo ('reason') por el cual se ha creado un reclamo, de manera que en base a su tipificación se permiten determinados comportamientos." - }, - "parameters": [ - { - "in": "path", - "name": "site_id", - "required": true, - "schema": { - "type": "string", - "example": "MLA" - }, - "description": { - "en": "ID of the site where the claim occurs.", - "pt": "ID do site em que ocorre a reclamação.", - "es": "ID del sitio donde se desarrolla el reclamo." - }, - "enum": [ - { - "title": "MCO", - "description": { - "en": "Mercado Libre Colombia", - "pt": "Mercado Livre Colômbia", - "es": "Mercado Libre Colombia" - } - }, - { - "title": "MLA", - "description": { - "en": "Mercado Livre Argentina", - "pt": "Mercado Libre Argentina", - "es": "Mercado Libre Argentina" - } - }, - { - "title": "MLB", - "description": { - "en": "Mercado Libre Brasil", - "pt": "Mercado Livre Brasil", - "es": "Mercado Libre Brasil" - } - }, - { - "title": "MLC", - "description": { - "en": "Mercado Libre Chile", - "pt": "Mercado Livre Chile", - "es": "Mercado Libre Chile" - } - }, - { - "title": "MLM", - "description": { - "en": "Mercado Libre México", - "pt": "Mercado Livre México", - "es": "Mercado Libre México" - } - }, - { - "title": "MLU", - "description": { - "en": "Mercado Libre Uruguay", - "pt": "Mercado Livre Uruguai", - "es": "Mercado Libre Uruguay" - } - }, - { - "title": "MPE", - "description": { - "en": "Mercado Libre Perú", - "pt": "Mercado Livre Perú", - "es": "Mercado Libre Perú" - } - } - ] + } + }, + "/post-purchase/v1/claims/{claim_id}/status_history": { + "get": { + "tags": [ + "checkout-pro" + ], + "description": { + "en": "This endpoint allows you to view, through a valid token, the history of states and scenarios that the complaint has gone through. It will also be possible to consult the history of actions taken by the people responsible for the complaint", + "pt": "Este endpoint permite visualizar, por meio de um token válido, o histórico de estados e cenários pelos quais a reclamação passou. Também será possível consultar o histórico de ações tomadas pelas pessoas responsáveis pela reclamação", + "es": "Este endpoint permite visualizar, a través de un token válido, el historial de estados y escenarios por los que ha pasado el reclamo. También será posible consultar el historial de acciones tomadas por los responsables del reclamo" + }, + "parameters": [ + { + "in": "path", + "name": "claim_id", + "required": true, + "schema": { + "type": "number", + "example": 5039218470 }, - { - "in": "path", - "name": "reason_id", - "required": true, - "schema": { - "type": "string", - "example": "PNR3430" - }, - "description": { - "en": "Reason ID of the claim. A claim can be created for three general reasons:", - "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", - "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" - }, - "enum": [ - { - "title": "PNR", - "description": { - "en": "Product not received.", - "pt": "Produto não recebido.", - "es": "Producto no recibido." - } - }, - { - "title": "PDD", - "description": { - "en": "Different or defective product.", - "pt": "Produto diferente ou defeituoso", - "es": "Producto diferente o defectuoso." - } - }, - { - "title": "CS", - "description": { - "en": "Purchase cancellation.", - "pt": "Cancelamento de compra.", - "es": "Cancelación de la compra." - } - } - ] + "description": { + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { + } + ], + "responses": { + "200": { + "description": { + "es": "Success", + "pt": "Sucesso", + "en": "Éxito" + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "type": "object", "properties": { - "id": { + "stage": { + "type": "string", + "example": "dispute", + "description": { + "en": "Indicates the current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", + "pt": "Indica a fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", + "es": "Indica la fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "claim", + "description": { + "en": "Initial stage of the claim process in which both the buyer and seller are involved.", + "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", + "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." + } + }, + { + "title": "dispute", + "description": { + "en": "Phase where the claim is under dispute or disagreement.", + "pt": "Fase em que a reclamação está em disputa ou desacordo.", + "es": "Fase donde el reclamo está en disputa o desacuerdo." + } + }, + { + "title": "recontact", + "description": { + "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", + "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", + "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." + } + }, + { + "title": "none", + "description": { + "en": "Indicates no specific stage is currently applicable.", + "pt": "Indica que nenhuma etapa específica é aplicável.", + "es": "Indica que no se aplica ninguna etapa específica." + } + } + ] + }, + "status": { + "type": "string", + "example": "closed", + "description": { + "en": "Specifies the current state of the claim, indicating whether it is open or closed. It can take one of the following values:", + "pt": "Especifica o estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", + "es": "Especifica el estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "opened", + "description": { + "en": "Indicates that the claim is open.", + "pt": "Indica que a reclamação está aberta.", + "es": "Indica que el reclamo está abierto." + } + }, + { + "title": "closed", + "description": { + "en": "Indicates that the claim is closed.", + "pt": "Indica que a reclamação está fechada.", + "es": "Indica que el reclamo está cerrado." + } + } + ] + }, + "date": { + "type": "string", + "example": "2020-09-08T23:59:36.000-04:00", + "description": { + "en": "Date of change in claim status.", + "pt": "Data de alteração do estado da reclamação.", + "es": "Fecha de cambio en el estado del reclamo." + } + }, + "change_by": { "type": "string", - "example": "PDD1", + "example": "mediator", "description": { - "en": "Reason ID of the claim. A claim can be created for three general reasons:", - "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", - "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" + "en": "Indicates the person who changed the claim. It can take one of the following values:", + "pt": "Apresenta a pessoa que alterou a reclamação. Pode assumir um dos seguintes valores:", + "es": "Indica la persona que cambió el reclamo. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "complainant", + "description": { + "en": "Person who claims", + "pt": "Pessoa que reclama.", + "es": "Persona que reclama." + } + }, + { + "title": "respondent", + "description": { + "en": "Person to whom they are complaining.", + "pt": "Pessoa a quem estão reclamando.", + "es": "Persona a quién le reclaman." + } + }, + { + "title": "mediator", + "description": { + "en": "Person who intervenes to help solve the problem.", + "pt": "Pessoa que intervém para ajudar a resolver o problema.", + "es": "Persona que interviene para ayudar a solucionar el problema." + } + } + ] + } + } + } + } + } + } + } + }, + "title": { + "en": "Get claim history", + "pt": "Obter histórico da reclamação", + "es": "Obtener historial del reclamo" + } + } + }, + "/post-purchase/v1/claims/reasons/{reason_id}": { + "get": { + "tags": [ + "checkout-pro" + ], + "description": { + "en": "This endpoint allows you to view, through a valid token, the 'reason' why the claim was created, so that based on its classification, certain behaviors are allowed", + "pt": "Este endpoint permite visualizar, a partir de um token válido, o motivo ('reason') pelo qual uma reclamação foi criada, de forma que com base na sua classificação sejam permitidos determinados comportamentos", + "es": "Este endpoint permite visualizar, mediante un token válido, el motivo ('reason') por el cual se ha creado un reclamo, de manera que en base a su tipificación se permiten determinados comportamientos" + }, + "parameters": [ + { + "in": "path", + "name": "reason_id", + "required": true, + "schema": { + "type": "string", + "example": "PNR3430" + }, + "description": { + "en": "Reason ID of the claim. A claim can be created for three general reasons:", + "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", + "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" + }, + "enum": [ + { + "title": "PNR", + "description": { + "en": "Product not received.", + "pt": "Produto não recebido.", + "es": "Producto no recibido." + } + }, + { + "title": "PDD", + "description": { + "en": "Different or defective product.", + "pt": "Produto diferente ou defeituoso.", + "es": "Producto diferente o defectuoso." + } + }, + { + "title": "CS", + "description": { + "en": "Purchase cancellation.", + "pt": "Cancelamento de compra.", + "es": "Cancelación de la compra." + } + } + ] + } + ], + "responses": { + "200": { + "description": { + "es": "Success", + "pt": "Sucesso", + "en": "Éxito" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "PDD1", + "description": { + "en": "Reason ID of the claim. A claim can be created for three general reasons:", + "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", + "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" + }, + "enum": [ + { + "title": "PNR", + "description": { + "en": "Product not received.", + "pt": "Produto não recebido.", + "es": "Producto no recibido." + } + }, + { + "title": "PDD", + "description": { + "en": "Different or defective product.", + "pt": "Produto diferente ou defeituoso.", + "es": "Producto diferente o defectuoso." + } + }, + { + "title": "CS", + "description": { + "en": "Purchase cancellation.", + "pt": "Cancelamento de compra.", + "es": "Cancelación de la compra." + } + } + ] + }, + "flow": { + "type": "string", + "example": "meadiations", + "description": { + "en": "Indicates which mediation flow the claim is currently in.", + "pt": "Indica em qual fluxo de mediação a reclamação se encontra no momento em questão.", + "es": "Indica en qué flujo de mediación se encuentra el reclamo en el momento en cuestión." + }, + "enum": [ + { + "title": "mediations", + "description": { + "en": "Refers to the process of mediating between parties in a claim.", + "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", + "es": "Se refiere al proceso de mediación entre las partes en un reclamo." + } + }, + { + "title": "cancel_purchase", + "description": { + "en": "Involves the process of cancelling a previously made purchase.", + "pt": "Envolve o processo de cancelar uma compra previamente realizada.", + "es": "Involucra el proceso de cancelar una compra previamente realizada." + } }, - "enum": [ - { - "title": "PNR", - "description": { - "en": "Product not received.", - "pt": "Produto não recebido.", - "es": "Producto no recibido." - } - }, - { - "title": "PDD", - "description": { - "en": "Different or defective product.", - "pt": "Produto diferente ou defeituoso", - "es": "Producto diferente o defectuoso." - } - }, - { - "title": "CS", - "description": { - "en": "Purchase cancellation.", - "pt": "Cancelamento de compra.", - "es": "Cancelación de la compra." - } + { + "title": "return", + "description": { + "en": "Pertains to the process of returning a purchased item.", + "pt": "Refere-se ao processo de devolução de um item comprado.", + "es": "Se refiere al proceso de devolver un artículo comprado." } - ] - }, - "flow": { - "type": "string", - "example": "meadiations", - "description": { - "en": "Indicates which mediation flow the claim is currently in.", - "pt": "Indica em qual fluxo de mediação a reclamação se encontra no momento em questão.", - "es": "Indica en qué flujo de mediación se encuentra el reclamo en el momento en cuestión." }, - "enum": [ - { - "title": "mediations", - "description": { - "en": "Refers to the process of mediating between parties in a claim.", - "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", - "es": "Se refiere al proceso de mediación entre las partes en un reclamo." - } - }, - { - "title": "cancel_purchase", + { + "title": "cancel_sale", + "description": { + "en": "oncerns the process of cancelling a sale that has been made.", + "pt": "Refere-se ao processo de cancelar uma venda realizada.", + "es": "Se ocupa del proceso de cancelar una venta realizada." + } + }, + { + "title": "change", + "description": { + "en": "Refers to the alteration or modification of the details or status of a claim.", + "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", + "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." + } + } + ] + }, + "name": { + "type": "string", + "example": "defective_item", + "description": { + "en": "Displays the description of the reason for the claim.", + "pt": "Exibe a descrição do motivo da reclamação.", + "es": "Presenta la descripción del motivo del reclamo." + } + }, + "detail": { + "type": "string", + "example": "El producto es defectuoso.", + "description": { + "en": "Displays details about the reason for the claim.", + "pt": "Exibe os detalhes sobre o motivo da reclamação.", + "es": "Muestra detalles sobre el motivo del reclamo." + } + }, + "position": { + "type": "number", + "example": 201, + "description": { + "en": "Position in which the reason for the complaint is found. It serves the same function as 'sort_by', but it is a default sorting type that will sort the reasons asynchronously.", + "pt": "Posição em que se encontra o motivo da reclamação. Cumpre a mesma função de 'sort_by', mas é um tipo de ordenação padrão que ordenará os motivos ('reason') de forma assíncrona.", + "es": "Posición en la que se encuentra el motivo de la reclamación. Cumple la misma función que 'sort_by', pero es un tipo de ordenación predeterminada que ordenará los motivos ('reason') de forma asíncrona." + } + }, + "filter": { + "type": "object", + "description": { + "en": "Filtering attributes of claim information.", + "pt": "Atributos de filtragem de informações da reclamação.", + "es": "Atributos de filtrado de información del reclamo." + }, + "items": { + "type": "array", + "properties": { + "group": { + "type": "string", + "exemple": "fashion", "description": { - "en": "Involves the process of cancelling a previously made purchase.", - "pt": "Envolve o processo de cancelar uma compra previamente realizada.", - "es": "Involucra el proceso de cancelar una compra previamente realizada." + "en": "List of groups to which 'reason' belongs.", + "pt": "Lista de grupos aos quais o 'reason' pertence.", + "es": "Listado de grupos al que pertenece el 'reason'." } }, - { - "title": "return", + "site_id": { + "type": "string", + "example": "MLA", "description": { - "en": "Pertains to the process of returning a purchased item.", - "pt": "Refere-se ao processo de devolução de um item comprado.", - "es": "Se refiere al proceso de devolver un artículo comprado." - } - }, - { - "title": "cancel_sale", + "en": "ID of the site where the claim occurs.", + "pt": "ID do site em que ocorre a reclamação.", + "es": "ID del sitio donde se desarrolla el reclamo." + }, + "enum": [ + { + "title": "MCO", + "description": { + "en": "Mercado Libre Colombia", + "pt": "Mercado Livre Colômbia", + "es": "Mercado Libre Colombia" + } + }, + { + "title": "MLA", + "description": { + "en": "Mercado Livre Argentina", + "pt": "Mercado Libre Argentina", + "es": "Mercado Libre Argentina" + } + }, + { + "title": "MLB", + "description": { + "en": "Mercado Libre Brasil", + "pt": "Mercado Livre Brasil", + "es": "Mercado Libre Brasil" + } + }, + { + "title": "MLC", + "description": { + "en": "Mercado Libre Chile", + "pt": "Mercado Livre Chile", + "es": "Mercado Libre Chile" + } + }, + { + "title": "MLM", + "description": { + "en": "Mercado Libre México", + "pt": "Mercado Livre México", + "es": "Mercado Libre México" + } + }, + { + "title": "MLU", + "description": { + "en": "Mercado Libre Uruguay", + "pt": "Mercado Livre Uruguai", + "es": "Mercado Libre Uruguay" + } + }, + { + "title": "MPE", + "description": { + "en": "Mercado Libre Perú", + "pt": "Mercado Livre Perú", + "es": "Mercado Libre Perú" + } + } + ] + } + } + } + }, + "settings": { + "type": "object", + "description": { + "en": "Filtering attributes of claim information.", + "pt": "Atributos de filtragem de informações da reclamação.", + "es": "Atributos de filtrado de información del reclamo." + }, + "items": { + "type": "array", + "properties": { + "allowed_flows": { + "type": "string", + "exemple": "claim", "description": { - "en": "oncerns the process of cancelling a sale that has been made.", - "pt": "Refere-se ao processo de cancelar uma venda realizada.", - "es": "Se ocupa del proceso de cancelar una venta realizada." + "en": "Indicate in which flows we can visualize this 'reason'.", + "pt": "Indica em quais fluxos podemos visualizar esta 'reason'.", + "es": "Indica en qué flujos podemos visualizar esta 'reason'." } }, - { - "title": "change", + "expected_resolution": { + "type": "string", + "exemple": "change_product", "description": { - "en": "Refers to the alteration or modification of the details or status of a claim.", - "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", - "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." - } - } - ] - }, - "name": { - "type": "string", - "example": "defective_item", - "description": { - "en": "Displays the description of the reason for the claim.", - "pt": "Exibe a descrição do motivo da reclamação.", - "es": "Presenta la descripción del motivo del reclamo." - } - }, - "detail": { - "type": "string", - "example": "El producto es defectuoso.", - "description": { - "en": "Displays details about the reason for the claim.", - "pt": "Exibe os detalhes sobre o motivo da reclamação.", - "es": "Muestra detalles sobre el motivo del reclamo." - } - }, - "filter": { - "type": "object", - "description": { - "en": "Filtering attributes of claim information.", - "pt": "Atributos de filtragem de informações da reclamação.", - "es": "Atributos de filtrado de información del reclamo." - }, - "items": { - "type": "array", - "properties": { - "group": { - "type": "string", - "description": { - "en": "List of groups to which 'reason' belongs.", - "pt": "Lista de grupos aos quais o 'reason' pertence", - "es": "Listado de grupos al que pertenece el 'reason'." - } + "en": "Presents possible resolutions expected by the complainant. It can take one of the following values:", + "pt": "Apresenta as possíveis resoluções esperadas por quem reclama. Pode assumir um dos seguintes valores:", + "es": "Muestra las posibles resoluciones esperadas por quien reclama. Puede tomar alguno de los siguientes valores:" }, - "site_id": { - "type": "string", - "example": "MLA", - "description": { - "en": "ID of the site where the claim occurs.", - "pt": "ID do site em que ocorre a reclamação.", - "es": "ID del sitio donde se desarrolla el reclamo." + "enum": [ + { + "title": "refund", + "description": { + "en": "The user expects the money to be refunded.", + "pt": "A pessoa usuária espera que o dinheiro seja devolvido.", + "es": "La persona usuaria espera que se le devuelva el dinero." + } }, - "enum": [ - { - "title": "MCO", - "description": { - "en": "Mercado Libre Colombia", - "pt": "Mercado Livre Colômbia", - "es": "Mercado Libre Colombia" - } - }, - { - "title": "MLA", - "description": { - "en": "Mercado Livre Argentina", - "pt": "Mercado Libre Argentina", - "es": "Mercado Libre Argentina" - } - }, - { - "title": "MLB", - "description": { - "en": "Mercado Libre Brasil", - "pt": "Mercado Livre Brasil", - "es": "Mercado Libre Brasil" - } - }, - { - "title": "MLC", - "description": { - "en": "Mercado Libre Chile", - "pt": "Mercado Livre Chile", - "es": "Mercado Libre Chile" - } - }, - { - "title": "MLM", - "description": { - "en": "Mercado Libre México", - "pt": "Mercado Livre México", - "es": "Mercado Libre México" - } - }, - { - "title": "MLU", - "description": { - "en": "Mercado Libre Uruguay", - "pt": "Mercado Livre Uruguai", - "es": "Mercado Libre Uruguay" - } - }, - { - "title": "MPE", - "description": { - "en": "Mercado Libre Perú", - "pt": "Mercado Livre Perú", - "es": "Mercado Libre Perú" - } + { + "title": "product", + "description": { + "en": "The user expects the product to be delivered.", + "pt": "A pessoa usuária espera que o produto seja entregue.", + "es": "La persona usuaria espera que el producto sea entregado." + } + }, + { + "title": "change_product", + "description": { + "en": "The user expects the product to be exchanged.", + "pt": "A pessoa usuária espera que o produto seja trocado.", + "es": "La persona usuaria espera que el producto sea cambiado." } - ] + }, + { + "title": "return_product", + "description": { + "en": "The user will wait for the return of the product to receive the refund.", + "pt": "A pessoa usuária irá esperar a devolução do produto para poder receber a devolução do dinheiro.", + "es": "La persona usuaria esperará la devolución del producto para poder recibir el dinero de vuelta." + } + } + ] + }, + "rules_engine_triage": { + "type": "string", + "exemple": "defective", + "description": { + "en": "Definition of the tag for triage categorization of the reason by which a complaint was created, with possible values including: 'repentant', 'defective', 'incomplete', 'different', or 'not_working'.", + "pt": "Definição da tag para categorização de triagem do motivo ('reason') pelo qual uma reclamação foi criada, podendo apresentar os seguintes valores: 'repentant', 'defective', 'incomplete', 'different' ou 'not_working'.", + "es": "Definición de la etiqueta para la categorización de triaje del motivo ('reason') por el cual se creó una queja, pudiendo presentar los siguientes valores: 'repentant', 'defective', 'incomplete', 'different' o 'not_working'." } } } @@ -3738,6 +4160,15 @@ "es": "ID de otro reclamo del que depende." } }, + "children_title": { + "type": "string", + "example": null, + "description": { + "en": "Used during post-purchase classification, where the value of the title is taken for the final reasons or sub-reasons of the reason that contain a value for this attribute.", + "pt": "Utilizado na hora de classificação no pós-venda, onde se pega o valor do título para as 'reason' finais ou as sub-razões de la 'reason' que contém um valor para este atributo.", + "es": "Utilizado en el momento de clasificación en la pos-venta, donde se toma el valor del título para las 'reason' finales o las subrazones de la 'reason' que contienen un valor para este atributo." + } + }, "status": { "type": "string", "example": "active", @@ -3770,846 +4201,847 @@ } } } - }, - "title": { - "en": "Get the reason for the claim", - "pt": "Obter motivo da reclamação", - "es": "Obtener motivo del reclamo" } + }, + "title": { + "en": "Get the reason for the claim", + "pt": "Obter motivo da reclamação", + "es": "Obtener motivo del reclamo" } - }, - "/claim_resource": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows, through a valid token, to obtain notifications of the complaint by making a 'get' request to the complaints resource using the 'resource' field of the 'data' parameter from the Webhook notifications received from the topic. For more information about Webhook notifications, visit: https://www.mercadopago.com/developers/en/docs/your-integrations/notifications/webhooks", - "pt": "Este endpoint permite, por meio de um token válido, obter notificações da reclamação realizando um 'get' ao recurso de reclamações utilizando o campo 'resource', do parâmetro 'data', das notificaçõees Webhook recebidas do tópico. Para mais informações sobre notificações Webhook, acesse: https://www.mercadopago.com/developers/pt/docs/your-integrations/notifications/webhooks", - "es": "Este endpoint permite, mediante un token válido, obtener notificaciones de la queja realizando una solicitud 'get' al recurso de reclamos utilizando el campo 'resource', del parámetro 'data', de las notificaciones Webhook recibidas del tema. Para obtener más información sobre las notificaciones de Webhook, visite: https://www.mercadopago.com/developers/es/docs/your-integrations/notifications/webhooks" - }, - "parameters": [ - { - "in": "path", - "name": "CLAIM_RESOURCE", - "required": true, - "schema": { - "type": "string", - "example": "/v1/claims/1041417027" - }, - "description": { - "en": "The 'data.resource' received in the claims notification, indicates the path that must be accessed to retrieve the information.", - "pt": "O 'data.resource' recebido na notificação da reclamação, indicando o path que deve ser acessado para recuperar suas informações.", - "es": "El 'data.resource' recibido en la notificación de reclamos, indicando el path al que se debe acceder para recuperar su información." - } + } + }, + "/claim_resource": { + "get": { + "tags": [ + "checkout-pro" + ], + "description": { + "en": "This endpoint allows, through a valid token, to obtain notifications of the complaint by making a 'get' request to the complaints resource using the 'resource' field of the 'data' parameter from the Webhook notifications received from the topic. For more information about Webhook notifications, visit: https://www.mercadopago.com/developers/en/docs/your-integrations/notifications/webhooks", + "pt": "Este endpoint permite, por meio de um token válido, obter notificações da reclamação realizando um 'get' ao recurso de reclamações utilizando o campo 'resource', do parâmetro 'data', das notificaçõees Webhook recebidas do tópico. Para mais informações sobre notificações Webhook, acesse: https://www.mercadopago.com/developers/pt/docs/your-integrations/notifications/webhooks", + "es": "Este endpoint permite, mediante un token válido, obtener notificaciones de la queja realizando una solicitud 'get' al recurso de reclamos utilizando el campo 'resource', del parámetro 'data', de las notificaciones Webhook recibidas del tema. Para obtener más información sobre las notificaciones de Webhook, visite: https://www.mercadopago.com/developers/es/docs/your-integrations/notifications/webhooks" + }, + "parameters": [ + { + "in": "path", + "name": "CLAIM_RESOURCE", + "required": true, + "schema": { + "type": "string", + "example": "/v1/claims/1041417027" + }, + "description": { + "en": "The 'data.resource' received in the claims notification, indicates the path that must be accessed to retrieve the information.", + "pt": "O 'data.resource' recebido na notificação da reclamação, indicando o path que deve ser acessado para recuperar suas informações.", + "es": "El 'data.resource' recibido en la notificación de reclamos, indicando el path al que se debe acceder para recuperar su información." } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number", - "example": 5033102536, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } + } + ], + "responses": { + "200": { + "description": { + "es": "Success", + "pt": "Sucesso", + "en": "Éxito" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number", + "example": 5033102536, + "description": { + "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", + "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", + "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." + } + }, + "type": { + "type": "string", + "example": "mediations", + "description": { + "en": "Defines the nature of the claim being processed. It can take one of the following values:", + "pt": "Define a natureza da reclamação em processamento. Pode assumir um dos seguintes valores:", + "es": "Define la naturaleza del reclamo que se está procesando. Puede tomar alguno de los siguientes valores:" }, - "type": { - "type": "string", - "example": "mediations", - "description": { - "en": "Defines the nature of the claim being processed. It can take one of the following values:", - "pt": "Define a natureza da reclamação em processamento. Pode assumir um dos seguintes valores:", - "es": "Define la naturaleza del reclamo que se está procesando. Puede tomar alguno de los siguientes valores:" + "enum": [ + { + "title": "mediations", + "description": { + "en": "Refers to the process of mediating between parties in a claim.", + "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", + "es": "Se refiere al proceso de mediación entre las partes en un reclamo." + } }, - "enum": [ - { - "title": "mediations", - "description": { - "en": "Refers to the process of mediating between parties in a claim.", - "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", - "es": "Se refiere al proceso de mediación entre las partes en un reclamo." - } - }, - { - "title": "cancel_purchase", - "description": { - "en": "Involves the process of cancelling a previously made purchase.", - "pt": "Envolve o processo de cancelar uma compra previamente realizada.", - "es": "Involucra el proceso de cancelar una compra previamente realizada." - } - }, - { - "title": "return", - "description": { - "en": "Pertains to the process of returning a purchased item.", - "pt": "Refere-se ao processo de devolução de um item comprado.", - "es": "Se refiere al proceso de devolver un artículo comprado." - } - }, - { - "title": "cancel_sale", - "description": { - "en": "oncerns the process of cancelling a sale that has been made.", - "pt": "Refere-se ao processo de cancelar uma venda realizada.", - "es": "Se ocupa del proceso de cancelar una venta realizada." - } - }, - { - "title": "change", - "description": { - "en": "Refers to the alteration or modification of the details or status of a claim.", - "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", - "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." - } + { + "title": "cancel_purchase", + "description": { + "en": "Involves the process of cancelling a previously made purchase.", + "pt": "Envolve o processo de cancelar uma compra previamente realizada.", + "es": "Involucra el proceso de cancelar una compra previamente realizada." } - ] - }, - "stage": { - "type": "string", - "example": "dispute", - "description": { - "en": "Indicates the current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", - "pt": "Indica a fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", - "es": "Indica la fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" }, - "enum": [ - { - "title": "claim", - "description": { - "en": "Initial stage of the claim process in which both the buyer and seller are involved.", - "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", - "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." - } - }, - { - "title": "dispute", - "description": { - "en": "Phase where the claim is under dispute or disagreement.", - "pt": "Fase em que a reclamação está em disputa ou desacordo.", - "es": "Fase donde el reclamo está en disputa o desacuerdo." - } - }, - { - "title": "recontact", - "description": { - "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", - "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", - "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." - } - }, - { - "title": "none", - "description": { - "en": "Indicates no specific stage is currently applicable.", - "pt": "Indica que nenhuma etapa específica é aplicável.", - "es": "Indica que no se aplica ninguna etapa específica." - } + { + "title": "return", + "description": { + "en": "Pertains to the process of returning a purchased item.", + "pt": "Refere-se ao processo de devolução de um item comprado.", + "es": "Se refiere al proceso de devolver un artículo comprado." + } + }, + { + "title": "cancel_sale", + "description": { + "en": "oncerns the process of cancelling a sale that has been made.", + "pt": "Refere-se ao processo de cancelar uma venda realizada.", + "es": "Se ocupa del proceso de cancelar una venta realizada." } - ] - }, - "status": { - "type": "string", - "example": "closed", - "description": { - "en": "Specifies the current state of the claim, indicating whether it is open or closed. It can take one of the following values:", - "pt": "Especifica o estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", - "es": "Especifica el estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" }, - "enum": [ - { - "title": "opened", - "description": { - "en": "Indicates that the claim is open.", - "pt": "Indica que a reclamação está aberta.", - "es": "Indica que el reclamo está abierto." - } - }, - { - "title": "closed", - "description": { - "en": "Indicates that the claim is closed.", - "pt": "Indica que a reclamação está fechada.", - "es": "Indica que el reclamo está cerrado." - } + { + "title": "change", + "description": { + "en": "Refers to the alteration or modification of the details or status of a claim.", + "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", + "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." } - ] - }, - "parent_id": { - "type": "string", - "example": null, - "description": { - "en": "ID of another claim on which it depends.", - "pt": "ID de outra reclamação da qual esta depende.", - "es": "ID de otro reclamo del que depende." } + ] + }, + "stage": { + "type": "string", + "example": "dispute", + "description": { + "en": "Indicates the current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", + "pt": "Indica a fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", + "es": "Indica la fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" }, - "client_id": { - "type": "number", - "example": 1569196570216262, - "description": { - "en": "ID of the app that created the claim.", - "pt": "ID do aplicativo que criou a reclamação.", - "es": "ID de la app que creo el reclamo" + "enum": [ + { + "title": "claim", + "description": { + "en": "Initial stage of the claim process in which both the buyer and seller are involved.", + "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", + "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." + } + }, + { + "title": "dispute", + "description": { + "en": "Phase where the claim is under dispute or disagreement.", + "pt": "Fase em que a reclamação está em disputa ou desacordo.", + "es": "Fase donde el reclamo está en disputa o desacuerdo." + } + }, + { + "title": "recontact", + "description": { + "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", + "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", + "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." + } + }, + { + "title": "none", + "description": { + "en": "Indicates no specific stage is currently applicable.", + "pt": "Indica que nenhuma etapa específica é aplicável.", + "es": "Indica que no se aplica ninguna etapa específica." + } } + ] + }, + "status": { + "type": "string", + "example": "closed", + "description": { + "en": "Specifies the current state of the claim, indicating whether it is open or closed. It can take one of the following values:", + "pt": "Especifica o estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", + "es": "Especifica el estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" }, - "resource_id": { - "type": "number", - "example": 7138572864, - "description": { - "en": "ID of the resource on which the claim is created and depends on the 'resource' parameter.", - "pt": "ID do recurso sobre o qual a reclamação é criada e depende do parâmetro 'resource'.", - "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro 'resource'." + "enum": [ + { + "title": "opened", + "description": { + "en": "Indicates that the claim is open.", + "pt": "Indica que a reclamação está aberta.", + "es": "Indica que el reclamo está abierto." + } + }, + { + "title": "closed", + "description": { + "en": "Indicates that the claim is closed.", + "pt": "Indica que a reclamação está fechada.", + "es": "Indica que el reclamo está cerrado." + } } + ] + }, + "parent_id": { + "type": "string", + "example": null, + "description": { + "en": "ID of another claim on which it depends.", + "pt": "ID de outra reclamação da qual esta depende.", + "es": "ID de otro reclamo del que depende." + } + }, + "client_id": { + "type": "number", + "example": 1569196570216262, + "description": { + "en": "ID of the app that created the claim.", + "pt": "ID do aplicativo que criou a reclamação.", + "es": "ID de la app que creo el reclamo" + } + }, + "resource_id": { + "type": "number", + "example": 7138572864, + "description": { + "en": "ID of the resource on which the claim is created and depends on the 'resource' parameter.", + "pt": "ID do recurso sobre o qual a reclamação é criada e depende do parâmetro 'resource'.", + "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro 'resource'." + } + }, + "resource": { + "type": "string", + "example": "shipment", + "description": { + "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase.", + "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra.", + "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra." }, - "resource": { - "type": "string", - "example": "shipment", - "description": { - "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase.", - "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra.", - "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra." + "enum": [ + { + "title": "payment", + "description": { + "en": "Related to claims involving payment transactions.", + "pt": "Relacionado a reclamações envolvendo transações de pagamento.", + "es": "Relacionado con reclamos que involucran transacciones de pago." + } }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Related to claims involving payment transactions.", - "pt": "Relacionado a reclamações envolvendo transações de pagamento.", - "es": "Relacionado con reclamos que involucran transacciones de pago." - } - }, - { - "title": "order", - "description": { - "en": "Pertains to claims arising from order processing issues.", - "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", - "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." - } - }, - { - "title": "shipment", - "description": { - "en": "Concerns claims related to shipping or delivery matters.", - "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", - "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." - } - }, - { - "title": "purchase", - "description": { - "en": "Involves claims associated with the purchase process.", - "pt": "Envolve reclamações associadas ao processo de compra.", - "es": "Involucra reclamos asociados con el proceso de compra." - } + { + "title": "order", + "description": { + "en": "Pertains to claims arising from order processing issues.", + "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", + "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." } - ] - }, - "reason_id": { - "type": "string", - "example": "PNR4071", - "description": { - "en": "Reason ID of the claim. A claim can be created for three general reasons:", - "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", - "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" }, - "enum": [ - { - "title": "PNR", - "description": { - "en": "Product not received.", - "pt": "Produto não recebido.", - "es": "Producto no recibido." - } - }, - { - "title": "PDD", - "description": { - "en": "Different or defective product.", - "pt": "Produto diferente ou defeituoso", - "es": "Producto diferente o defectuoso." - } - }, - { - "title": "CS", - "description": { - "en": "Purchase cancellation.", - "pt": "Cancelamento de compra.", - "es": "Cancelación de la compra." - } + { + "title": "shipment", + "description": { + "en": "Concerns claims related to shipping or delivery matters.", + "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", + "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." + } + }, + { + "title": "purchase", + "description": { + "en": "Involves claims associated with the purchase process.", + "pt": "Envolve reclamações associadas ao processo de compra.", + "es": "Involucra reclamos asociados con el proceso de compra." } - ] - }, - "quantity_type": { - "type": "string", - "example": "total", - "description": { - "en": "Indica si una devolución corresponde a todos los productos de la orden o solo algunos. Inicialmente sólo mostrará el valor 'total' y en el futuro se visualizará el valor 'partial'.", - "pt": "Indica se um reembolso corresponde a todos os produtos do pedido ou apenas alguns. Inicialmente, mostrará apenas o valor 'total' e, no futuro, será exibido o valor 'partial'.", - "es": "Indicates whether a return corresponds to all products in the order or only some. Initially, it will only show the value 'total', and in the future, the value 'partial' will be displayed." } + ] + }, + "reason_id": { + "type": "string", + "example": "PNR4071", + "description": { + "en": "Reason ID of the claim. A claim can be created for three general reasons:", + "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", + "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" }, - "players": { - "type": "array", - "description": { - "en": "People who are participating in the complaint.", - "pt": "Pessoas que estão participando da reclamação.", - "es": "Personas que están participando en el reclamo." + "enum": [ + { + "title": "PNR", + "description": { + "en": "Product not received.", + "pt": "Produto não recebido.", + "es": "Producto no recibido." + } }, - "items": { - "type": "object", - "properties": { - "role": { - "type": "string", - "example": "mediator", - "description": { - "en": "Indicates the person's role within the claim. It can take one of the following values:", - "pt": "Indica o papel da pessoa dentro da reclamação. Pode assumir um dos seguintes valores:", - "es": "Indica el rol de la persona dentro del reclamo. Puede tomar alguno de los siguientes valores:" + { + "title": "PDD", + "description": { + "en": "Different or defective product.", + "pt": "Produto diferente ou defeituoso", + "es": "Producto diferente o defectuoso." + } + }, + { + "title": "CS", + "description": { + "en": "Purchase cancellation.", + "pt": "Cancelamento de compra.", + "es": "Cancelación de la compra." + } + } + ] + }, + "quantity_type": { + "type": "string", + "example": "total", + "description": { + "en": "Indica si una devolución corresponde a todos los productos de la orden o solo algunos. Inicialmente sólo mostrará el valor 'total' y en el futuro se visualizará el valor 'partial'.", + "pt": "Indica se um reembolso corresponde a todos os produtos do pedido ou apenas alguns. Inicialmente, mostrará apenas o valor 'total' e, no futuro, será exibido o valor 'partial'.", + "es": "Indicates whether a return corresponds to all products in the order or only some. Initially, it will only show the value 'total', and in the future, the value 'partial' will be displayed." + } + }, + "players": { + "type": "array", + "description": { + "en": "People who are participating in the complaint.", + "pt": "Pessoas que estão participando da reclamação.", + "es": "Personas que están participando en el reclamo." + }, + "items": { + "type": "object", + "properties": { + "role": { + "type": "string", + "example": "mediator", + "description": { + "en": "Indicates the person's role within the claim. It can take one of the following values:", + "pt": "Indica o papel da pessoa dentro da reclamação. Pode assumir um dos seguintes valores:", + "es": "Indica el rol de la persona dentro del reclamo. Puede tomar alguno de los siguientes valores:" + }, + "enum": [ + { + "title": "complainant", + "description": { + "en": "Person who claims", + "pt": "Pessoa que reclama.", + "es": "Persona que reclama." + } }, - "enum": [ - { - "title": "complainant", - "description": { - "en": "Person who claims", - "pt": "Pessoa que reclama.", - "es": "Persona que reclama." - } - }, - { - "title": "respondent", - "description": { - "en": "Person to whom they are complaining.", - "pt": "Pessoa a quem estão reclamando.", - "es": "Persona a quién le reclaman." - } - }, - { - "title": "mediator", - "description": { - "en": "Person who intervenes to help solve the problem.", - "pt": "Pessoa que intervém para ajudar a resolver o problema.", - "es": "Persona que interviene para ayudar a solucionar el problema." - } + { + "title": "respondent", + "description": { + "en": "Person to whom they are complaining.", + "pt": "Pessoa a quem estão reclamando.", + "es": "Persona a quién le reclaman." } - ] - }, - "type": { - "type": "string", - "example": "payer", - "description": { - "en": "Role that the person occupies in the operation that is being claimed and may vary according to the 'resource'. It can take one of the following values:", - "pt": "Papel que a pessoa ocupa na operação que está sendo reivindicada e pode variar de acordo com o 'resource'. Pode assumir um dos seguintes valores:", - "es": "Rol que ocupa la persona sobre la operación que se está reclamando y puede variar de acuerdo con el 'resource'. Puede tomar alguno de los siguientes valores:" }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Indicates that the person is the buyer or collector.", - "pt": "Indica que a pessoa é compradora ou cobradora.", - "es": "Indica que la persona es el comprador o collector." - } - }, - { - "title": "order", - "description": { - "en": "Indicates that the person is the buyer or seller.", - "pt": "Indica que a pessoa é compradora ou vendedora.", - "es": "Indica que la persona es el comprador o vendedor." - } - }, - { - "title": "shipment", - "description": { - "en": "Indicates that the person is the receiver or sender.", - "pt": "Indica que a pessoa é o destinatário ou remetente.", - "es": "Indica que la persona es el receptor o remitente." - } + { + "title": "mediator", + "description": { + "en": "Person who intervenes to help solve the problem.", + "pt": "Pessoa que intervém para ajudar a resolver o problema.", + "es": "Persona que interviene para ayudar a solucionar el problema." } - ] - }, - "user_id": { - "type": "number", - "example": 242829175, - "description": { - "en": "ID of the 'type' indicated in the previous parameter.", - "pt": "ID do 'type' indicado no parâmetro anterior.", - "es": "ID del 'type' indicado en el parámetro anterior." } + ] + }, + "type": { + "type": "string", + "example": "payer", + "description": { + "en": "Role that the person occupies in the operation that is being claimed and may vary according to the 'resource'. It can take one of the following values:", + "pt": "Papel que a pessoa ocupa na operação que está sendo reivindicada e pode variar de acordo com o 'resource'. Pode assumir um dos seguintes valores:", + "es": "Rol que ocupa la persona sobre la operación que se está reclamando y puede variar de acuerdo con el 'resource'. Puede tomar alguno de los siguientes valores:" }, - "available_actions": { - "type": "array", - "description": { - "en": "Provides information about the actions that each of the involved parties can execute.", - "pt": "Exibe informações sobre as ações que cada uma das partes envolvidas pode executar.", - "es": "Presenta información sobre las acciones que pueden ejecutar cada una de las partes intervinientes." + "enum": [ + { + "title": "payment", + "description": { + "en": "Indicates that the person is the buyer or collector.", + "pt": "Indica que a pessoa é compradora ou cobradora.", + "es": "Indica que la persona es el comprador o collector." + } }, - "items": { - "type": "object", - "properties": { - "action": { - "type": "string", - "example": "recontact", - "description": { - "es": "List of actions that each of the involved parties can execute.", - "pt": "Lista de ações que cada uma das partes envolvidas pode executar.", - "en": "Lista de acciones que pueden ejecutar cada una de las partes intervinientes." - }, - "enum": [ - { - "title": "send_message_to_complainant", - "description": { - "en": "Send a message to the buyer (with or without attachments).", - "pt": "Enviar mensagem para o comprador (com ou sem anexos).", - "es": "Enviar mensaje para el comprador (con o sin anexos)." - } - }, - { - "title": "send_message_to_mediator", - "description": { - "en": "Send a message to the mediator (with or without attachments).", - "pt": "Enviar mensagem para o mediador (com ou sem anexos).", - "es": "Enviar mensaje para el mediador (con o sin anexos)." - } - }, - { - "title": "recontact (no disponible aún)", - "description": { - "en": "Reopen a closed complaint through an interaction, such as a message.", - "pt": "Reabrir uma reclamação já fechada, por meio de uma interação, como uma mensagem.", - "es": "Reabrir un reclamo ya cerrado, por medio de una interacción, como un mensaje." - } - }, - { - "title": "refund", - "description": { - "en": "Refund the buyer's money. Must be performed by the Mercado Pago front end.", - "pt": "Devolver o dinheiro do comprador. Deve ser realizado pelo front do Mercado Pago.", - "es": "Devolver el dinero del comprado. Debe ser realizado por el front de Mercado Pago." - } - }, - { - "title": "open_dispute", - "description": { - "en": "Initiate mediation.", - "pt": "Iniciar uma mediação.", - "es": "Iniciar una mediación." - } - }, - { - "title": "send_potential_shipping", - "description": { - "en": "Send a promise of shipment, indicating a date.", - "pt": "Enviar uma promessa de postagem, indicando uma data.", - "es": "Enviar una promesa de post, indicando una fecha." - } - }, - { - "title": "add_shipping_evidence", - "description": { - "en": "Publish evidence that the product has been shipped.", - "pt": "Publicar uma evidência de que o produto foi enviado.", - "es": "Publicar una evidencia de que el producto fue enviado." - } - }, - { - "title": "send_attachments", - "description": { - "en": "Send message with attached images.", - "pt": "Enviar mensagem com imagens anexadas.", - "es": "Enviar mensaje con imágenes adjuntas." - } - }, - { - "title": "allow_return_label", - "description": { - "en": "Generate a return label.", - "pt": "Gerar etiqueta de devolução.", - "es": "Generar etiqueta de devolución." - } - }, - { - "title": "send_tracking_number", - "description": { - "en": "Send the shipping tracking number.", - "pt": "Enviar o número de rastreamento de envio (tracking number).", - "es": "Enviar el número de rastreo de envío (tracking number)." - } - } - ] - }, - "due_date": { - "type": "string", - "example": "2020-11-16T22:36:59.000-04:00", - "description": { - "en": "Deadline to perform the action.", - "pt": "Prazo limite para realizar a ação.", - "es": "Tiempo límite para realizar la acción." - } + { + "title": "order", + "description": { + "en": "Indicates that the person is the buyer or seller.", + "pt": "Indica que a pessoa é compradora ou vendedora.", + "es": "Indica que la persona es el comprador o vendedor." + } + }, + { + "title": "shipment", + "description": { + "en": "Indicates that the person is the receiver or sender.", + "pt": "Indica que a pessoa é o destinatário ou remetente.", + "es": "Indica que la persona es el receptor o remitente." + } + } + ] + }, + "user_id": { + "type": "number", + "example": 242829175, + "description": { + "en": "ID of the 'type' indicated in the previous parameter.", + "pt": "ID do 'type' indicado no parâmetro anterior.", + "es": "ID del 'type' indicado en el parámetro anterior." + } + }, + "available_actions": { + "type": "array", + "description": { + "en": "Provides information about the actions that each of the involved parties can execute.", + "pt": "Exibe informações sobre as ações que cada uma das partes envolvidas pode executar.", + "es": "Presenta información sobre las acciones que pueden ejecutar cada una de las partes intervinientes." + }, + "items": { + "type": "object", + "properties": { + "action": { + "type": "string", + "example": "recontact", + "description": { + "es": "List of actions that each of the involved parties can execute.", + "pt": "Lista de ações que cada uma das partes envolvidas pode executar.", + "en": "Lista de acciones que pueden ejecutar cada una de las partes intervinientes." }, - "mandatory": { - "type": "boolean", - "example": true, - "description": { - "en": "This field being 'true' indicates that the action is mandatory and must be performed within the specified time.", - "pt": "Este campo como 'true' indica que a ação é obrigatória e deve ser realizada dentro do tempo informado.", - "es": "Este campo en 'true' indica que la acción es obligatoria y debe ser realizada dentro del tiempo informado." + "enum": [ + { + "title": "send_message_to_complainant", + "description": { + "en": "Send a message to the buyer (with or without attachments).", + "pt": "Enviar mensagem para o comprador (com ou sem anexos).", + "es": "Enviar mensaje para el comprador (con o sin anexos)." + } + }, + { + "title": "send_message_to_mediator", + "description": { + "en": "Send a message to the mediator (with or without attachments).", + "pt": "Enviar mensagem para o mediador (com ou sem anexos).", + "es": "Enviar mensaje para el mediador (con o sin anexos)." + } + }, + { + "title": "recontact (no disponible aún)", + "description": { + "en": "Reopen a closed complaint through an interaction, such as a message.", + "pt": "Reabrir uma reclamação já fechada, por meio de uma interação, como uma mensagem.", + "es": "Reabrir un reclamo ya cerrado, por medio de una interacción, como un mensaje." + } + }, + { + "title": "refund", + "description": { + "en": "Refund the buyer's money. Must be performed by the Mercado Pago front end.", + "pt": "Devolver o dinheiro do comprador. Deve ser realizado pelo front do Mercado Pago.", + "es": "Devolver el dinero del comprado. Debe ser realizado por el front de Mercado Pago." + } + }, + { + "title": "open_dispute", + "description": { + "en": "Initiate mediation.", + "pt": "Iniciar uma mediação.", + "es": "Iniciar una mediación." + } + }, + { + "title": "send_potential_shipping", + "description": { + "en": "Send a promise of shipment, indicating a date.", + "pt": "Enviar uma promessa de postagem, indicando uma data.", + "es": "Enviar una promesa de post, indicando una fecha." + } + }, + { + "title": "add_shipping_evidence", + "description": { + "en": "Publish evidence that the product has been shipped.", + "pt": "Publicar uma evidência de que o produto foi enviado.", + "es": "Publicar una evidencia de que el producto fue enviado." + } + }, + { + "title": "send_attachments", + "description": { + "en": "Send message with attached images.", + "pt": "Enviar mensagem com imagens anexadas.", + "es": "Enviar mensaje con imágenes adjuntas." + } + }, + { + "title": "allow_return_label", + "description": { + "en": "Generate a return label.", + "pt": "Gerar etiqueta de devolução.", + "es": "Generar etiqueta de devolución." + } + }, + { + "title": "send_tracking_number", + "description": { + "en": "Send the shipping tracking number.", + "pt": "Enviar o número de rastreamento de envio (tracking number).", + "es": "Enviar el número de rastreo de envío (tracking number)." + } } + ] + }, + "due_date": { + "type": "string", + "example": "2020-11-16T22:36:59.000-04:00", + "description": { + "en": "Deadline to perform the action.", + "pt": "Prazo limite para realizar a ação.", + "es": "Tiempo límite para realizar la acción." + } + }, + "mandatory": { + "type": "boolean", + "example": true, + "description": { + "en": "This field being 'true' indicates that the action is mandatory and must be performed within the specified time.", + "pt": "Este campo como 'true' indica que a ação é obrigatória e deve ser realizada dentro do tempo informado.", + "es": "Este campo en 'true' indica que la acción es obligatoria y debe ser realizada dentro del tiempo informado." } } } } } } + } + }, + "resolution": { + "type": "object", + "description": { + "en": "Provides information about claim resolution.", + "pt": "Exibe informações sobre a resolução da reclamação.", + "es": "Presenta información sobre la resolución del reclamo." }, - "resolution": { - "type": "object", - "description": { - "en": "Provides information about claim resolution.", - "pt": "Exibe informações sobre a resolução da reclamação.", - "es": "Presenta información sobre la resolución del reclamo." + "properties": { + "reason": { + "type": "string", + "example": "already_shipped", + "description": { + "en": "Reason for resolution/closure.", + "pt": "Motivo de resolução/encerramento.", + "es": "Motivo de resolucion/cierre." + } + }, + "date_created": { + "type": "string", + "example": "2020-10-02T01:12:31.000-04:00", + "description": { + "en": "Date of resolution/closure of the claim.", + "pt": "Data de resolução/encerramento da reclamação.", + "es": "Fecha de la resolucion/cierre del reclamo." + } + }, + "decision": { + "type": "array", + "items": { + "type": "string", + "example": "complainant", + "description": { + "en": "Person who defined the resolution of the claim.", + "pt": "Pessoa que definiu a resolução da reclamação.", + "es": "Persona que definió la resolución del reclamo." + } + } }, + "closed_by": { + "type": "string", + "example": "mediator", + "description": { + "en": "Person who closed the claim.", + "pt": "Pessoa que encerrou a reclamação.", + "es": "Persona que cerró el reclamo." + } + } + } + }, + "coverages": { + "type": "array", + "description": { + "en": "Represents the coverages applied to users in the claim.", + "pt": "Representa as coberturas aplicadas aos usuários na reclamação.", + "es": "Representa las coberturas aplicadas a usuarios en el reclamo." + }, + "items": { + "type": "object", "properties": { - "reason": { + "type": { "type": "string", - "example": "already_shipped", + "example": "bpp", "description": { - "en": "Reason for resolution/closure.", - "pt": "Motivo de resolução/encerramento.", - "es": "Motivo de resolucion/cierre." + "en": "Type of coverage applied to users (e.g., 'bpp' - Buyer Protection Program).", + "pt": "Tipo de cobertura aplicada aos usuários (ex: 'bpp' - Buyer Protection Program).", + "es": "Tipo de cobertura aplicada a usuarios (ej: 'bpp' - Buyer Protection Program)." } }, - "date_created": { + "benefited": { "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", + "example": "complainant", "description": { - "en": "Date of resolution/closure of the claim.", - "pt": "Data de resolução/encerramento da reclamação.", - "es": "Fecha de la resolucion/cierre del reclamo." + "en": "It will indicate who will benefit from resolving the claim.", + "pt": "Indicará quem for beneficiado pela resolução da reclamação.", + "es": "Indicará quién se beneficiará de resolver el reclamo." } }, - "decision": { - "type": "array", - "items": { - "type": "string", - "example": "complainant", - "description": { - "en": "Person who defined the resolution of the claim.", - "pt": "Pessoa que definiu a resolução da reclamação.", - "es": "Persona que definió la resolución del reclamo." - } + "amount": { + "type": "number", + "example": 194.99, + "description": { + "en": "Total amount of the applied coverage.", + "pt": "Valor total da cobertura aplicada.", + "es": "Monto total de la cobertura aplicada" } }, - "closed_by": { + "resource": { "type": "string", - "example": "mediator", + "example": "shipment", "description": { - "en": "Person who closed the claim.", - "pt": "Pessoa que encerrou a reclamação.", - "es": "Persona que cerró el reclamo." - } - } - } - }, - "coverages": { - "type": "array", - "description": { - "en": "Represents the coverages applied to users in the claim.", - "pt": "Representa as coberturas aplicadas aos usuários na reclamação.", - "es": "Representa las coberturas aplicadas a usuarios en el reclamo." - }, - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "bpp", - "description": { - "en": "Type of coverage applied to users (e.g., 'bpp' - Buyer Protection Program).", - "pt": "Tipo de cobertura aplicada aos usuários (ex: 'bpp' - Buyer Protection Program).", - "es": "Tipo de cobertura aplicada a usuarios (ej: 'bpp' - Buyer Protection Program)." - } - }, - "benefited": { - "type": "string", - "example": "complainant", - "description": { - "en": "It will indicate who will benefit from resolving the claim.", - "pt": "Indicará quem for beneficiado pela resolução da reclamação.", - "es": "Indicará quién se beneficiará de resolver el reclamo." - } + "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase.", + "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra.", + "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra." }, - "amount": { - "type": "number", - "example": 194.99, - "description": { - "en": "Total amount of the applied coverage.", - "pt": "Valor total da cobertura aplicada.", - "es": "Monto total de la cobertura aplicada" + "enum": [ + { + "title": "payment", + "description": { + "en": "Related to claims involving payment transactions.", + "pt": "Relacionado a reclamações envolvendo transações de pagamento.", + "es": "Relacionado con reclamos que involucran transacciones de pago." + } + }, + { + "title": "order", + "description": { + "en": "Pertains to claims arising from order processing issues.", + "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", + "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." + } + }, + { + "title": "shipment", + "description": { + "en": "Concerns claims related to shipping or delivery matters.", + "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", + "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." + } + }, + { + "title": "purchase", + "description": { + "en": "Involves claims associated with the purchase process.", + "pt": "Envolve reclamações associadas ao processo de compra.", + "es": "Involucra reclamos asociados con el proceso de compra." + } } + ] + }, + "resource_id": { + "type": "number", + "example": 7138572864, + "description": { + "en": "ID of the resource on which the claim is created and depends on the 'resource' parameter.", + "pt": "ID do recurso sobre o qual a reclamação é criada e depende do parâmetro 'resource'.", + "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro 'resource'." + } + }, + "date_created": { + "type": "string", + "example": "2018-03-08T10:35:30.000-0400", + "description": { + "en": "Date the claim was created.", + "pt": "Data em que a reclamação foi criada.", + "es": "Fecha en la que se creó el reclamo." + } + }, + "costs": { + "type": "array", + "description": { + "en": "Represents the breakdown of costs related to the coverage.", + "pt": "Representa a divisão dos custos relacionados à cobertura.", + "es": "Representa la división de los costos relacionados a la cobertura." }, - "resource": { - "type": "string", - "example": "shipment", - "description": { - "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase.", - "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra.", - "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra." - }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Related to claims involving payment transactions.", - "pt": "Relacionado a reclamações envolvendo transações de pagamento.", - "es": "Relacionado con reclamos que involucran transacciones de pago." - } - }, - { - "title": "order", + "items": { + "type": "object", + "properties": { + "role": { + "type": "string", + "example": "respondent", "description": { - "en": "Pertains to claims arising from order processing issues.", - "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", - "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." + "en": "The player in the claim responsible for the cost.", + "pt": "O 'player' da reclamação responsável pelo custo.", + "es": "El 'player' del reclamo a cargo del costo." } }, - { - "title": "shipment", + "amount": { + "type": "number", + "example": 194.99, "description": { - "en": "Concerns claims related to shipping or delivery matters.", - "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", - "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." + "en": "Amount of the cost borne by the player in the 'role' parameter.", + "pt": "Valor do custo sob responsabilidade do participante no parâmetro 'role'.", + "es": "Monto del costo a cargo del player del parámetro 'role'." } }, - { - "title": "purchase", + "date_created": { + "type": "string", + "example": "2018-03-08T10:35:30.000-0400", "description": { - "en": "Involves claims associated with the purchase process.", - "pt": "Envolve reclamações associadas ao processo de compra.", - "es": "Involucra reclamos asociados con el proceso de compra." - } - } - ] - }, - "resource_id": { - "type": "number", - "example": 7138572864, - "description": { - "en": "ID of the resource on which the claim is created and depends on the 'resource' parameter.", - "pt": "ID do recurso sobre o qual a reclamação é criada e depende do parâmetro 'resource'.", - "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro 'resource'." - } - }, - "date_created": { - "type": "string", - "example": "2018-03-08T10:35:30.000-0400", - "description": { - "en": "Date the claim was created.", - "pt": "Data em que a reclamação foi criada.", - "es": "Fecha en la que se creó el reclamo." - } - }, - "costs": { - "type": "array", - "description": { - "en": "Represents the breakdown of costs related to the coverage.", - "pt": "Representa a divisão dos custos relacionados à cobertura.", - "es": "Representa la división de los costos relacionados a la cobertura." - }, - "items": { - "type": "object", - "properties": { - "role": { - "type": "string", - "example": "respondent", - "description": { - "en": "The player in the claim responsible for the cost.", - "pt": "O 'player' da reclamação responsável pelo custo.", - "es": "El 'player' del reclamo a cargo del costo." - } - }, - "amount": { - "type": "number", - "example": 194.99, - "description": { - "en": "Amount of the cost borne by the player in the 'role' parameter.", - "pt": "Valor do custo sob responsabilidade do participante no parâmetro 'role'.", - "es": "Monto del costo a cargo del player del parámetro 'role'." - } - }, - "date_created": { - "type": "string", - "example": "2018-03-08T10:35:30.000-0400", - "description": { - "en": "Date of cost creation.", - "pt": "Data de criação do custo.", - "es": "Fecha de creación del costo." - } + "en": "Date of cost creation.", + "pt": "Data de criação do custo.", + "es": "Fecha de creación del costo." } } } } } } + } + }, + "labels": { + "type": "array", + "description": { + "en": "Presents information about the labels associated with the claim, indicating, for example, whether the complaint affects the seller's reputation or not.", + "pt": "Apresenta informações sobre as estiquetas associadas à reclamação, indicando, por exemplo, se a reclamação afeta ou não a reputação do vendedor.", + "es": "Presenta información sobre las etiquetas asociadas al reclamo, indicando, por ejemplo, si la reclamación afecta o no la reputación del vendedor." }, - "labels": { - "type": "array", - "description": { - "en": "Presents information about the labels associated with the claim, indicating, for example, whether the complaint affects the seller's reputation or not.", - "pt": "Apresenta informações sobre as estiquetas associadas à reclamação, indicando, por exemplo, se a reclamação afeta ou não a reputação do vendedor.", - "es": "Presenta información sobre las etiquetas asociadas al reclamo, indicando, por ejemplo, si la reclamación afecta o no la reputación del vendedor." - }, - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "reputation", - "description": { - "en": "Name of the label associated with the claim.", - "pt": "Nome da etiqueta associada à reclamação.", - "es": "Nombre de la etiqueta asociada al reclamo." - } - }, - "value": { - "type": "string", - "example": "avoid", - "description": { - "en": "Value of the label.", - "pt": "Valor da etiqueta.", - "es": "Valor de la etiqueta." - } - }, - "admin_id": { - "type": "string", - "example": null, - "description": { - "en": "ID of the user managing the claim and who associated the label.", - "pt": "ID da pessoa usuária que está administrando a reclamação e associou a etiqueta.", - "es": "ID de la persona usuaria que está gestionando el reclamo y ha asociado la etiqueta." - } - }, - "date_created": { - "type": "string", - "example": "2018-03-08T09:56:00.078-0400", - "description": { - "en": "Date on which the label was associated with the claim.", - "pt": "Data em que a etiqueta foi associada à reclamação.", - "es": "Fecha en que la etiqueta fue asociada al reclamo." - } - } - } - } - }, - "site_id": { - "type": "string", - "example": "MLA", - "description": { - "en": "ID of the site where the claim occurs.", - "pt": "ID do site em que ocorre a reclamação.", - "es": "ID del sitio donde se desarrolla el reclamo." - }, - "enum": [ - { - "title": "MCO", - "description": { - "en": "Mercado Libre Colombia", - "pt": "Mercado Livre Colômbia", - "es": "Mercado Libre Colombia" - } - }, - { - "title": "MLA", - "description": { - "en": "Mercado Livre Argentina", - "pt": "Mercado Libre Argentina", - "es": "Mercado Libre Argentina" - } - }, - { - "title": "MLB", - "description": { - "en": "Mercado Libre Brasil", - "pt": "Mercado Livre Brasil", - "es": "Mercado Libre Brasil" - } - }, - { - "title": "MLC", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "reputation", "description": { - "en": "Mercado Libre Chile", - "pt": "Mercado Livre Chile", - "es": "Mercado Libre Chile" + "en": "Name of the label associated with the claim.", + "pt": "Nome da etiqueta associada à reclamação.", + "es": "Nombre de la etiqueta asociada al reclamo." } }, - { - "title": "MLM", + "value": { + "type": "string", + "example": "avoid", "description": { - "en": "Mercado Libre México", - "pt": "Mercado Livre México", - "es": "Mercado Libre México" + "en": "Value of the label.", + "pt": "Valor da etiqueta.", + "es": "Valor de la etiqueta." } }, - { - "title": "MLU", + "admin_id": { + "type": "string", + "example": null, "description": { - "en": "Mercado Libre Uruguay", - "pt": "Mercado Livre Uruguai", - "es": "Mercado Libre Uruguay" + "en": "ID of the user managing the claim and who associated the label.", + "pt": "ID da pessoa usuária que está administrando a reclamação e associou a etiqueta.", + "es": "ID de la persona usuaria que está gestionando el reclamo y ha asociado la etiqueta." } }, - { - "title": "MPE", + "date_created": { + "type": "string", + "example": "2018-03-08T09:56:00.078-0400", "description": { - "en": "Mercado Libre Perú", - "pt": "Mercado Livre Perú", - "es": "Mercado Libre Perú" + "en": "Date on which the label was associated with the claim.", + "pt": "Data em que a etiqueta foi associada à reclamação.", + "es": "Fecha en que la etiqueta fue asociada al reclamo." } } - ] - }, - "date_created": { - "type": "string", - "example": "2020-09-30T09:48:06.000-04:00", - "description": { - "en": "Date the claim was created.", - "pt": "Data em que a reclamação foi criada.", - "es": "Fecha en la que se creó el reclamo." } + } + }, + "site_id": { + "type": "string", + "example": "MLA", + "description": { + "en": "ID of the site where the claim occurs.", + "pt": "ID do site em que ocorre a reclamação.", + "es": "ID del sitio donde se desarrolla el reclamo." }, - "last_updated": { - "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", - "description": { - "en": "Date of the last update to the claim.", - "pt": "Data da última atualização da reclamação.", - "es": "Fecha de última actualización reclamo." + "enum": [ + { + "title": "MCO", + "description": { + "en": "Mercado Libre Colombia", + "pt": "Mercado Livre Colômbia", + "es": "Mercado Libre Colombia" + } + }, + { + "title": "MLA", + "description": { + "en": "Mercado Livre Argentina", + "pt": "Mercado Libre Argentina", + "es": "Mercado Libre Argentina" + } + }, + { + "title": "MLB", + "description": { + "en": "Mercado Libre Brasil", + "pt": "Mercado Livre Brasil", + "es": "Mercado Libre Brasil" + } + }, + { + "title": "MLC", + "description": { + "en": "Mercado Libre Chile", + "pt": "Mercado Livre Chile", + "es": "Mercado Libre Chile" + } + }, + { + "title": "MLM", + "description": { + "en": "Mercado Libre México", + "pt": "Mercado Livre México", + "es": "Mercado Libre México" + } + }, + { + "title": "MLU", + "description": { + "en": "Mercado Libre Uruguay", + "pt": "Mercado Livre Uruguai", + "es": "Mercado Libre Uruguay" + } + }, + { + "title": "MPE", + "description": { + "en": "Mercado Libre Perú", + "pt": "Mercado Livre Perú", + "es": "Mercado Libre Perú" + } } + ] + }, + "date_created": { + "type": "string", + "example": "2020-09-30T09:48:06.000-04:00", + "description": { + "en": "Date the claim was created.", + "pt": "Data em que a reclamação foi criada.", + "es": "Fecha en la que se creó el reclamo." + } + }, + "last_updated": { + "type": "string", + "example": "2020-10-02T01:12:31.000-04:00", + "description": { + "en": "Date of the last update to the claim.", + "pt": "Data da última atualização da reclamação.", + "es": "Fecha de última actualización reclamo." } } } } } } - }, - "title": { - "en": "Get claim notifications", - "pt": "Obter notificações da reclamação", - "es": "Obtener notificaciones del reclamo" } + }, + "title": { + "en": "Get claim notifications", + "pt": "Obter notificações da reclamação", + "es": "Obtener notificaciones del reclamo" } } } - } \ No newline at end of file + } +} \ No newline at end of file diff --git a/reference/api-json/claims_v2.json b/reference/api-json/claims_v2.json deleted file mode 100644 index 618b87b1eb..0000000000 --- a/reference/api-json/claims_v2.json +++ /dev/null @@ -1,5047 +0,0 @@ -{ - "url": "https://api.mercadopago.com", - "paths": { - "/post-purchase/v1/claims/{claim_id}": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows you to obtain, through a valid token, details of claims such as, for example, information about the users involved and the order that generated the claim", - "pt": "Este endpoint permite obter, por meio de um token válido, detalhes das reclamações como, por exemplo, informaçõees sobre as pessoas usuárias envolvidas e sobre o pedido que gerou a reclamação", - "es": "Este endpoint permite obtener, a través de un token válido, detalles de los reclamos como, por ejemplo, información sobre las personas usuarias involucradas y el pedido que generó el reclamo" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number", - "example": 5033102536, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - }, - "resource_id": { - "type": "number", - "example": 7138572864, - "description": { - "en": "ID of the resource on which the claim is created and depends on the 'resource' parameter.", - "pt": "ID do recurso sobre o qual a reclamação é criada e depende do parâmetro 'resource'.", - "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro 'resource'." - } - }, - "status": { - "type": "string", - "example": "closed", - "description": { - "en": "Specifies the current state of the claim, indicating whether it is open or closed. It can take one of the following values:", - "pt": "Especifica o estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", - "es": "Especifica el estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "opened", - "description": { - "en": "Indicates that the claim is open.", - "pt": "Indica que a reclamação está aberta.", - "es": "Indica que el reclamo está abierto." - } - }, - { - "title": "closed", - "description": { - "en": "Indicates that the claim is closed.", - "pt": "Indica que a reclamação está fechada.", - "es": "Indica que el reclamo está cerrado." - } - } - ] - }, - "type": { - "type": "string", - "example": "mediations", - "description": { - "en": "Defines the nature of the claim being processed. It can take one of the following values:", - "pt": "Define a natureza da reclamação em processamento. Pode assumir um dos seguintes valores:", - "es": "Define la naturaleza del reclamo que se está procesando. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "mediations", - "description": { - "en": "Refers to the process of mediating between parties in a claim.", - "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", - "es": "Se refiere al proceso de mediación entre las partes en un reclamo." - } - }, - { - "title": "cancel_purchase", - "description": { - "en": "Involves the process of cancelling a previously made purchase.", - "pt": "Envolve o processo de cancelar uma compra previamente realizada.", - "es": "Involucra el proceso de cancelar una compra previamente realizada." - } - }, - { - "title": "return", - "description": { - "en": "Pertains to the process of returning a purchased item.", - "pt": "Refere-se ao processo de devolução de um item comprado.", - "es": "Se refiere al proceso de devolver un artículo comprado." - } - }, - { - "title": "cancel_sale", - "description": { - "en": "oncerns the process of cancelling a sale that has been made.", - "pt": "Refere-se ao processo de cancelar uma venda realizada.", - "es": "Se ocupa del proceso de cancelar una venta realizada." - } - }, - { - "title": "change", - "description": { - "en": "Refers to the alteration or modification of the details or status of a claim.", - "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", - "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." - } - } - ] - }, - "stage": { - "type": "string", - "example": "dispute", - "description": { - "en": "Indicates the current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", - "pt": "Indica a fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", - "es": "Indica la fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "claim", - "description": { - "en": "Initial stage of the claim process in which both the buyer and seller are involved.", - "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", - "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." - } - }, - { - "title": "dispute", - "description": { - "en": "Phase where the claim is under dispute or disagreement.", - "pt": "Fase em que a reclamação está em disputa ou desacordo.", - "es": "Fase donde el reclamo está en disputa o desacuerdo." - } - }, - { - "title": "recontact", - "description": { - "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", - "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", - "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." - } - }, - { - "title": "none", - "description": { - "en": "Indicates no specific stage is currently applicable.", - "pt": "Indica que nenhuma etapa específica é aplicável.", - "es": "Indica que no se aplica ninguna etapa específica." - } - } - ] - }, - "parent_id": { - "type": "string", - "example": null, - "description": { - "en": "ID of another claim on which it depends.", - "pt": "ID de outra reclamação da qual esta depende.", - "es": "ID de otro reclamo del que depende." - } - }, - "resource": { - "type": "string", - "example": "shipment", - "description": { - "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase.", - "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra.", - "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra." - }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Related to claims involving payment transactions.", - "pt": "Relacionado a reclamações envolvendo transações de pagamento.", - "es": "Relacionado con reclamos que involucran transacciones de pago." - } - }, - { - "title": "order", - "description": { - "en": "Pertains to claims arising from order processing issues.", - "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", - "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." - } - }, - { - "title": "shipment", - "description": { - "en": "Concerns claims related to shipping or delivery matters.", - "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", - "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." - } - }, - { - "title": "purchase", - "description": { - "en": "Involves claims associated with the purchase process.", - "pt": "Envolve reclamações associadas ao processo de compra.", - "es": "Involucra reclamos asociados con el proceso de compra." - } - } - ] - }, - "reason_id": { - "type": "string", - "example": "PNR4071", - "description": { - "en": "Reason ID of the claim. A claim can be created for three general reasons:", - "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", - "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" - }, - "enum": [ - { - "title": "PNR", - "description": { - "en": "Product not received.", - "pt": "Produto não recebido.", - "es": "Producto no recibido." - } - }, - { - "title": "PDD", - "description": { - "en": "Different or defective product.", - "pt": "Produto diferente ou defeituoso.", - "es": "Producto diferente o defectuoso." - } - }, - { - "title": "CS", - "description": { - "en": "Purchase cancellation.", - "pt": "Cancelamento de compra.", - "es": "Cancelación de la compra." - } - } - ] - }, - "fulfilled": { - "type": "boolean", - "example": true, - "description": { - "en": "Indicate whether the claim is for a delivered or undelivered product.", - "pt": "Indique se o reclamação é sobre um produto entregue ou não entregue.", - "es": "Indica si el reclamo se inicia por un producto entregado o no." - } - }, - "quantity_type": { - "type": "string", - "example": "total", - "description": { - "en": "Indica si una devolución corresponde a todos los productos de la orden o solo algunos. Inicialmente sólo mostrará el valor 'total' y en el futuro se visualizará el valor 'partial'.", - "pt": "Indica se um reembolso corresponde a todos os produtos do pedido ou apenas alguns. Inicialmente, mostrará apenas o valor 'total' e, no futuro, será exibido o valor 'partial'.", - "es": "Indicates whether a return corresponds to all products in the order or only some. Initially, it will only show the value 'total', and in the future, the value 'partial' will be displayed." - } - }, - "players": { - "type": "array", - "description": { - "en": "People who are participating in the complaint.", - "pt": "Pessoas que estão participando da reclamação.", - "es": "Personas que están participando en el reclamo." - }, - "items": { - "type": "object", - "properties": { - "role": { - "type": "string", - "example": "mediator", - "description": { - "en": "Indicates the person's role within the claim. It can take one of the following values:", - "pt": "Indica o papel da pessoa dentro da reclamação. Pode assumir um dos seguintes valores:", - "es": "Indica el rol de la persona dentro del reclamo. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "complainant", - "description": { - "en": "Person who claims", - "pt": "Pessoa que reclama.", - "es": "Persona que reclama." - } - }, - { - "title": "respondent", - "description": { - "en": "Person to whom they are complaining.", - "pt": "Pessoa a quem estão reclamando.", - "es": "Persona a quién le reclaman." - } - }, - { - "title": "mediator", - "description": { - "en": "Person who intervenes to help solve the problem.", - "pt": "Pessoa que intervém para ajudar a resolver o problema.", - "es": "Persona que interviene para ayudar a solucionar el problema." - } - } - ] - }, - "type": { - "type": "string", - "example": "payer", - "description": { - "en": "Role that the person occupies in the operation that is being claimed and may vary according to the 'resource'. It can take one of the following values:", - "pt": "Papel que a pessoa ocupa na operação que está sendo reivindicada e pode variar de acordo com o 'resource'. Pode assumir um dos seguintes valores:", - "es": "Rol que ocupa la persona sobre la operación que se está reclamando y puede variar de acuerdo con el 'resource'. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Indicates that the person is the buyer or collector.", - "pt": "Indica que a pessoa é compradora ou cobradora.", - "es": "Indica que la persona es el comprador o collector." - } - }, - { - "title": "order", - "description": { - "en": "Indicates that the person is the buyer or seller.", - "pt": "Indica que a pessoa é compradora ou vendedora.", - "es": "Indica que la persona es el comprador o vendedor." - } - }, - { - "title": "shipment", - "description": { - "en": "Indicates that the person is the receiver or sender.", - "pt": "Indica que a pessoa é o destinatário ou remetente.", - "es": "Indica que la persona es el receptor o remitente." - } - } - ] - }, - "user_id": { - "type": "number", - "example": 242829175, - "description": { - "en": "ID of the 'type' indicated in the previous parameter.", - "pt": "ID do 'type' indicado no parâmetro anterior.", - "es": "ID del 'type' indicado en el parámetro anterior." - } - }, - "available_actions": { - "type": "array", - "description": { - "en": "Provides information about the actions that each of the involved parties can execute.", - "pt": "Exibe informações sobre as ações que cada uma das partes envolvidas pode executar.", - "es": "Presenta información sobre las acciones que pueden ejecutar cada una de las partes intervinientes." - }, - "items": { - "type": "object", - "properties": { - "action": { - "type": "string", - "example": "recontact", - "description": { - "es": "List of actions that each of the involved parties can execute.", - "pt": "Lista de ações que cada uma das partes envolvidas pode executar.", - "en": "Lista de acciones que pueden ejecutar cada una de las partes intervinientes." - }, - "enum": [ - { - "title": "send_message_to_complainant", - "description": { - "en": "Send a message to the buyer (with or without attachments).", - "pt": "Enviar mensagem para o comprador (com ou sem anexos).", - "es": "Enviar mensaje para el comprador (con o sin anexos)." - } - }, - { - "title": "send_message_to_mediator", - "description": { - "en": "Send a message to the mediator (with or without attachments).", - "pt": "Enviar mensagem para o mediador (com ou sem anexos).", - "es": "Enviar mensaje para el mediador (con o sin anexos)." - } - }, - { - "title": "recontact (no disponible aún)", - "description": { - "en": "Reopen a closed complaint through an interaction, such as a message.", - "pt": "Reabrir uma reclamação já fechada, por meio de uma interação, como uma mensagem.", - "es": "Reabrir un reclamo ya cerrado, por medio de una interacción, como un mensaje." - } - }, - { - "title": "refund", - "description": { - "en": "Refund the buyer's money. Must be performed by the Mercado Pago front end.", - "pt": "Devolver o dinheiro do comprador. Deve ser realizado pelo front do Mercado Pago.", - "es": "Devolver el dinero del comprado. Debe ser realizado por el front de Mercado Pago." - } - }, - { - "title": "open_dispute", - "description": { - "en": "Initiate mediation.", - "pt": "Iniciar uma mediação.", - "es": "Iniciar una mediación." - } - }, - { - "title": "send_potential_shipping", - "description": { - "en": "Send a promise of shipment, indicating a date.", - "pt": "Enviar uma promessa de postagem, indicando uma data.", - "es": "Enviar una promesa de post, indicando una fecha." - } - }, - { - "title": "add_shipping_evidence", - "description": { - "en": "Publish evidence that the product has been shipped.", - "pt": "Publicar uma evidência de que o produto foi enviado.", - "es": "Publicar una evidencia de que el producto fue enviado." - } - }, - { - "title": "send_attachments", - "description": { - "en": "Send message with attached images.", - "pt": "Enviar mensagem com imagens anexadas.", - "es": "Enviar mensaje con imágenes adjuntas." - } - }, - { - "title": "allow_return_label", - "description": { - "en": "Generate a return label.", - "pt": "Gerar etiqueta de devolução.", - "es": "Generar etiqueta de devolución." - } - }, - { - "title": "send_tracking_number", - "description": { - "en": "Send the shipping tracking number.", - "pt": "Enviar o número de rastreamento de envio (tracking number).", - "es": "Enviar el número de rastreo de envío (tracking number)." - } - } - ] - }, - "due_date": { - "type": "string", - "example": "2020-11-16T22:36:59.000-04:00", - "description": { - "en": "Deadline to perform the action.", - "pt": "Prazo limite para realizar a ação.", - "es": "Tiempo límite para realizar la acción." - } - }, - "mandatory": { - "type": "boolean", - "example": true, - "description": { - "en": "This field being 'true' indicates that the action is mandatory and must be performed within the specified time.", - "pt": "Este campo como 'true' indica que a ação é obrigatória e deve ser realizada dentro do tempo informado.", - "es": "Este campo en 'true' indica que la acción es obligatoria y debe ser realizada dentro del tiempo informado." - } - } - } - } - } - } - } - }, - "resolution": { - "type": "object", - "description": { - "en": "Provides information about claim resolution.", - "pt": "Exibe informações sobre a resolução da reclamação.", - "es": "Presenta información sobre la resolución del reclamo." - }, - "properties": { - "reason": { - "type": "string", - "example": "already_shipped", - "description": { - "en": "Reason for resolution/closure.", - "pt": "Motivo de resolução/encerramento.", - "es": "Motivo de resolucion/cierre." - } - }, - "date_created": { - "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", - "description": { - "en": "Date of resolution/closure of the claim.", - "pt": "Data de resolução/encerramento da reclamação.", - "es": "Fecha de la resolucion/cierre del reclamo." - } - }, - "decision": { - "type": "array", - "items": { - "type": "string", - "example": "complainant", - "description": { - "en": "Person who defined the resolution of the claim.", - "pt": "Pessoa que definiu a resolução da reclamação.", - "es": "Persona que definió la resolución del reclamo." - } - } - }, - "closed_by": { - "type": "string", - "example": "mediator", - "description": { - "en": "Person who closed the claim.", - "pt": "Pessoa que encerrou a reclamação.", - "es": "Persona que cerró el reclamo." - } - } - } - }, - "site_id": { - "type": "string", - "example": "MLA", - "description": { - "en": "ID of the site where the claim occurs.", - "pt": "ID do site em que ocorre a reclamação.", - "es": "ID del sitio donde se desarrolla el reclamo." - }, - "enum": [ - { - "title": "MCO", - "description": { - "en": "Mercado Libre Colombia", - "pt": "Mercado Livre Colômbia", - "es": "Mercado Libre Colombia" - } - }, - { - "title": "MLA", - "description": { - "en": "Mercado Livre Argentina", - "pt": "Mercado Libre Argentina", - "es": "Mercado Libre Argentina" - } - }, - { - "title": "MLB", - "description": { - "en": "Mercado Libre Brasil", - "pt": "Mercado Livre Brasil", - "es": "Mercado Libre Brasil" - } - }, - { - "title": "MLC", - "description": { - "en": "Mercado Libre Chile", - "pt": "Mercado Livre Chile", - "es": "Mercado Libre Chile" - } - }, - { - "title": "MLM", - "description": { - "en": "Mercado Libre México", - "pt": "Mercado Livre México", - "es": "Mercado Libre México" - } - }, - { - "title": "MLU", - "description": { - "en": "Mercado Libre Uruguay", - "pt": "Mercado Livre Uruguai", - "es": "Mercado Libre Uruguay" - } - }, - { - "title": "MPE", - "description": { - "en": "Mercado Libre Perú", - "pt": "Mercado Livre Perú", - "es": "Mercado Libre Perú" - } - } - ] - }, - "date_created": { - "type": "string", - "example": "2020-09-30T09:48:06.000-04:00", - "description": { - "en": "Date the claim was created.", - "pt": "Data em que a reclamação foi criada.", - "es": "Fecha en la que se creó el reclamo." - } - }, - "last_updated": { - "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", - "description": { - "en": "Date of the last update to the claim.", - "pt": "Data da última atualização da reclamação.", - "es": "Fecha de última actualización reclamo." - } - } - } - } - } - } - } - }, - "title": { - "en": "Get claim details", - "pt": "Obter detalhes da reclamação", - "es": "Obtener detalles del reclamo" - } - } - }, - "/post-purchase/v1/claims/search": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows searching, through a valid token, which claims belong to a certain user", - "pt": "Este endpoint permite buscar, por meio de um token válido, quais reclamações pertencem a determinado usuário", - "es": "Este endpoint permite buscar, mediante un token válido, qué reclamos pertenecen a un usuario determinado" - }, - "parameters": [ - { - "in": "query", - "name": "id", - "required": false, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - }, - { - "in": "query", - "name": "type", - "required": false, - "schema": { - "type": "string", - "example": "mediations" - }, - "description": { - "en": "Defines the nature of the claim being processed. It can take one of the following values:", - "pt": "Define a natureza da reclamação em processamento. Pode assumir um dos seguintes valores:", - "es": "Define la naturaleza del reclamo que se está procesando. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "mediations", - "description": { - "en": "Refers to the process of mediating between parties in a claim.", - "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", - "es": "Se refiere al proceso de mediación entre las partes en un reclamo." - } - }, - { - "title": "cancel_purchase", - "description": { - "en": "Involves the process of cancelling a previously made purchase.", - "pt": "Envolve o processo de cancelar uma compra previamente realizada.", - "es": "Involucra el proceso de cancelar una compra previamente realizada." - } - }, - { - "title": "return", - "description": { - "en": "Pertains to the process of returning a purchased item.", - "pt": "Refere-se ao processo de devolução de um item comprado.", - "es": "Se refiere al proceso de devolver un artículo comprado." - } - }, - { - "title": "cancel_sale", - "description": { - "en": "oncerns the process of cancelling a sale that has been made.", - "pt": "Refere-se ao processo de cancelar uma venda realizada.", - "es": "Se ocupa del proceso de cancelar una venta realizada." - } - }, - { - "title": "change", - "description": { - "en": "Refers to the alteration or modification of the details or status of a claim.", - "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", - "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." - } - } - ] - }, - { - "in": "query", - "name": "stage", - "required": false, - "schema": { - "type": "string", - "example": "claim" - }, - "description": { - "en": "he current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", - "pt": "Fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", - "es": "La fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "claim", - "description": { - "en": "Initial stage of the claim process in which both the buyer and seller are involved.", - "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", - "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." - } - }, - { - "title": "dispute", - "description": { - "en": "Phase where the claim is under dispute or disagreement.", - "pt": "Fase em que a reclamação está em disputa ou desacordo.", - "es": "Fase donde el reclamo está en disputa o desacuerdo." - } - }, - { - "title": "recontact", - "description": { - "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", - "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", - "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." - } - }, - { - "title": "none", - "description": { - "en": "Indicates no specific stage is currently applicable.", - "pt": "Indica que nenhuma etapa específica é aplicável.", - "es": "Indica que no se aplica ninguna etapa específica." - } - } - ] - }, - { - "in": "query", - "name": "status", - "required": false, - "schema": { - "type": "string", - "example": "closed" - }, - "description": { - "en": "The current state of the claim, indicating whether it is open or closed. It can take one of the following values:", - "pt": "Estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", - "es": "El estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "opened", - "description": { - "en": "Indicates that the claim is open.", - "pt": "Indica que a reclamação está aberta.", - "es": "Indica que el reclamo está abierto." - } - }, - { - "title": "closed", - "description": { - "en": "Indicates that the claim is closed.", - "pt": "Indica que a reclamação está fechada.", - "es": "Indica que el reclamo está cerrado." - } - } - ] - }, - { - "in": "query", - "name": "resource", - "required": false, - "schema": { - "type": "string", - "example": "shipment" - }, - "description": { - "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase. It can take one of the following values:", - "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra. Pode assumir um dos seguintes valores:", - "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Related to claims involving payment transactions.", - "pt": "Relacionado a reclamações envolvendo transações de pagamento.", - "es": "Relacionado con reclamos que involucran transacciones de pago." - } - }, - { - "title": "order", - "description": { - "en": "Pertains to claims arising from order processing issues.", - "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", - "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." - } - }, - { - "title": "shipment", - "description": { - "en": "Concerns claims related to shipping or delivery matters.", - "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", - "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." - } - }, - { - "title": "purchase", - "description": { - "en": "Involves claims associated with the purchase process.", - "pt": "Envolve reclamações associadas ao processo de compra.", - "es": "Involucra reclamos asociados con el proceso de compra." - } - } - ] - }, - { - "in": "query", - "name": "resource_id", - "required": false, - "schema": { - "type": "number", - "example": 40128769543 - }, - "description": { - "en": "ID of the resource on which the claim is created and depends on the previous parameter.", - "pt": "ID do recurso sobre o qual se cria a reclamação e depende do parâmetro anterior.", - "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro anterior." - } - }, - { - "in": "query", - "name": "date_created", - "required": false, - "schema": { - "type": "string", - "example": "2020-09-30T09:48:06.000-04:00" - }, - "description": { - "en": "Date and time when the message was created, formatted in ISO 8601 standard. For example, 2020-09-30T09:48:06.000-04:00.", - "pt": "Data e hora em que a mensagem foi criada, formatada no padrão ISO 8601. Por exemplo, 2020-09-30T09:48:06.000-04:00.", - "es": "Fecha y hora en que se creó el mensaje, formateada según el estándar ISO 8601. Por ejemplo 2020-09-30T09:48:06.000-04:00." - } - }, - { - "in": "query", - "name": "limit", - "required": false, - "schema": { - "type": "number", - "example": 5 - }, - "description": { - "en": "Maximum number of claims to be retrieved. For example, setting this to '5' will return the top 5 claims.", - "pt": "Número máximo de reclamações a serem obtidas. Por exemplo, definir isso como '5' retornará as 5 principais reclamações.", - "es": "Número máximo de reclamos a obtener. Por ejemplo, establecer esto en '5' devolverá los 5 reclamos principales." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "paging": { - "type": "object", - "description": { - "en": "Information for pagination of search results.", - "pt": "Informações para paginação dos resultados da pesquisa.", - "es": "Información para paginación de resultados de búsqueda." - }, - "properties": { - "offset": { - "type": "number", - "example": 0, - "description": { - "en": "Offset over the total set of data gathered by the search.", - "pt": "Deslocamento sobre o conjunto total de dados levantados pela busca.", - "es": "Desplazamiento sobre el conjunto total de datos levantados por la búsqueda." - } - }, - "limit": { - "type": "number", - "example": 30, - "description": { - "en": "Limit of claims returned in the search.", - "pt": "Quantidade limite de reclamações que serão retornadas na busca.", - "es": "Cantidad límite de reclamos que se devolverán en la búsqueda." - } - }, - "total": { - "type": "number", - "example": 1, - "description": { - "en": "Number of claims found in the search.", - "pt": "Quantidade de reclamações encontradas na busca.", - "es": "Cantidad de reclamos encontrados en la búsqueda." - } - } - } - }, - "data": { - "type": "array", - "description": { - "en": "Presents the data of the complaint.", - "pt": "Exibe os dados da reclamação.", - "es": "Presenta los datos de la reclamación." - }, - "items": { - "type": "object", - "properties": { - "id": { - "type": "number", - "example": 5033102536, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - }, - "resource_id": { - "type": "number", - "example": 7138572864, - "description": { - "en": "ID of the resource on which the claim is created and depends on the 'resource' parameter.", - "pt": "ID do recurso sobre o qual a reclamação é criada e depende do parâmetro 'resource'.", - "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro 'resource'." - } - }, - "status": { - "type": "string", - "example": "closed", - "description": { - "en": "Specifies the current state of the claim, indicating whether it is open or closed. It can take one of the following values:", - "pt": "Especifica o estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", - "es": "Especifica el estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "opened", - "description": { - "en": "Indicates that the claim is open.", - "pt": "Indica que a reclamação está aberta.", - "es": "Indica que el reclamo está abierto." - } - }, - { - "title": "closed", - "description": { - "en": "Indicates that the claim is closed.", - "pt": "Indica que a reclamação está fechada.", - "es": "Indica que el reclamo está cerrado." - } - } - ] - }, - "type": { - "type": "string", - "example": "mediations", - "description": { - "en": "Defines the nature of the claim being processed. It can take one of the following values:", - "pt": "Define a natureza da reclamação em processamento. Pode assumir um dos seguintes valores:", - "es": "Define la naturaleza del reclamo que se está procesando. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "mediations", - "description": { - "en": "Refers to the process of mediating between parties in a claim.", - "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", - "es": "Se refiere al proceso de mediación entre las partes en un reclamo." - } - }, - { - "title": "cancel_purchase", - "description": { - "en": "Involves the process of cancelling a previously made purchase.", - "pt": "Envolve o processo de cancelar uma compra previamente realizada.", - "es": "Involucra el proceso de cancelar una compra previamente realizada." - } - }, - { - "title": "return", - "description": { - "en": "Pertains to the process of returning a purchased item.", - "pt": "Refere-se ao processo de devolução de um item comprado.", - "es": "Se refiere al proceso de devolver un artículo comprado." - } - }, - { - "title": "cancel_sale", - "description": { - "en": "oncerns the process of cancelling a sale that has been made.", - "pt": "Refere-se ao processo de cancelar uma venda realizada.", - "es": "Se ocupa del proceso de cancelar una venta realizada." - } - }, - { - "title": "change", - "description": { - "en": "Refers to the alteration or modification of the details or status of a claim.", - "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", - "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." - } - } - ] - }, - "stage": { - "type": "string", - "example": "dispute", - "description": { - "en": "Indicates the current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", - "pt": "Indica a fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", - "es": "Indica la fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "claim", - "description": { - "en": "Initial stage of the claim process in which both the buyer and seller are involved.", - "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", - "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." - } - }, - { - "title": "dispute", - "description": { - "en": "Phase where the claim is under dispute or disagreement.", - "pt": "Fase em que a reclamação está em disputa ou desacordo.", - "es": "Fase donde el reclamo está en disputa o desacuerdo." - } - }, - { - "title": "recontact", - "description": { - "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", - "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", - "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." - } - }, - { - "title": "none", - "description": { - "en": "Indicates no specific stage is currently applicable.", - "pt": "Indica que nenhuma etapa específica é aplicável.", - "es": "Indica que no se aplica ninguna etapa específica." - } - } - ] - }, - "parent_id": { - "type": "string", - "example": null, - "description": { - "en": "ID of another claim on which it depends.", - "pt": "ID de outra reclamação da qual esta depende.", - "es": "ID de otro reclamo del que depende." - } - }, - "resource": { - "type": "string", - "example": "shipment", - "description": { - "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase.", - "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra.", - "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra." - }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Related to claims involving payment transactions.", - "pt": "Relacionado a reclamações envolvendo transações de pagamento.", - "es": "Relacionado con reclamos que involucran transacciones de pago." - } - }, - { - "title": "order", - "description": { - "en": "Pertains to claims arising from order processing issues.", - "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", - "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." - } - }, - { - "title": "shipment", - "description": { - "en": "Concerns claims related to shipping or delivery matters.", - "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", - "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." - } - }, - { - "title": "purchase", - "description": { - "en": "Involves claims associated with the purchase process.", - "pt": "Envolve reclamações associadas ao processo de compra.", - "es": "Involucra reclamos asociados con el proceso de compra." - } - } - ] - }, - "reason_id": { - "type": "string", - "example": "PNR4071", - "description": { - "en": "Reason ID of the claim. A claim can be created for three general reasons:", - "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", - "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" - }, - "enum": [ - { - "title": "PNR", - "description": { - "en": "Product not received.", - "pt": "Produto não recebido.", - "es": "Producto no recibido." - } - }, - { - "title": "PDD", - "description": { - "en": "Different or defective product.", - "pt": "Produto diferente ou defeituoso", - "es": "Producto diferente o defectuoso." - } - }, - { - "title": "CS", - "description": { - "en": "Purchase cancellation.", - "pt": "Cancelamento de compra.", - "es": "Cancelación de la compra." - } - } - ] - }, - "fulfilled": { - "type": "boolean", - "example": true, - "description": { - "en": "Indicate whether the claim is for a delivered or undelivered product.", - "pt": "Indique se o reclamação é sobre um produto entregue ou não entregue.", - "es": "Indica si el reclamo se inicia por un producto entregado o no." - } - }, - "quantity_type": { - "type": "string", - "example": "total", - "description": { - "en": "Indica si una devolución corresponde a todos los productos de la orden o solo algunos. Inicialmente sólo mostrará el valor 'total' y en el futuro se visualizará el valor 'partial'.", - "pt": "Indica se um reembolso corresponde a todos os produtos do pedido ou apenas alguns. Inicialmente, mostrará apenas o valor 'total' e, no futuro, será exibido o valor 'partial'.", - "es": "Indicates whether a return corresponds to all products in the order or only some. Initially, it will only show the value 'total', and in the future, the value 'partial' will be displayed." - } - }, - "players": { - "type": "array", - "description": { - "en": "People who are participating in the complaint.", - "pt": "Pessoas que estão participando da reclamação.", - "es": "Personas que están participando en el reclamo." - }, - "items": { - "type": "object", - "properties": { - "role": { - "type": "string", - "example": "mediator", - "description": { - "en": "Indicates the person's role within the claim. It can take one of the following values:", - "pt": "Indica o papel da pessoa dentro da reclamação. Pode assumir um dos seguintes valores:", - "es": "Indica el rol de la persona dentro del reclamo. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "complainant", - "description": { - "en": "Person who claims", - "pt": "Pessoa que reclama.", - "es": "Persona que reclama." - } - }, - { - "title": "respondent", - "description": { - "en": "Person to whom they are complaining.", - "pt": "Pessoa a quem estão reclamando.", - "es": "Persona a quién le reclaman." - } - }, - { - "title": "mediator", - "description": { - "en": "Person who intervenes to help solve the problem.", - "pt": "Pessoa que intervém para ajudar a resolver o problema.", - "es": "Persona que interviene para ayudar a solucionar el problema." - } - } - ] - }, - "type": { - "type": "string", - "example": "payer", - "description": { - "en": "Role that the person occupies in the operation that is being claimed and may vary according to the 'resource'. It can take one of the following values:", - "pt": "Papel que a pessoa ocupa na operação que está sendo reivindicada e pode variar de acordo com o 'resource'. Pode assumir um dos seguintes valores:", - "es": "Rol que ocupa la persona sobre la operación que se está reclamando y puede variar de acuerdo con el 'resource'. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Indicates that the person is the buyer or collector.", - "pt": "Indica que a pessoa é compradora ou cobradora.", - "es": "Indica que la persona es el comprador o collector." - } - }, - { - "title": "order", - "description": { - "en": "Indicates that the person is the buyer or seller.", - "pt": "Indica que a pessoa é compradora ou vendedora.", - "es": "Indica que la persona es el comprador o vendedor." - } - }, - { - "title": "shipment", - "description": { - "en": "Indicates that the person is the receiver or sender.", - "pt": "Indica que a pessoa é o destinatário ou remetente.", - "es": "Indica que la persona es el receptor o remitente." - } - } - ] - }, - "user_id": { - "type": "number", - "example": 242829175, - "description": { - "en": "ID of the 'type' indicated in the previous parameter.", - "pt": "ID do 'type' indicado no parâmetro anterior.", - "es": "ID del 'type' indicado en el parámetro anterior." - } - }, - "available_actions": { - "type": "array", - "description": { - "en": "Provides information about the actions that each of the involved parties can execute.", - "pt": "Exibe informações sobre as ações que cada uma das partes envolvidas pode executar.", - "es": "Presenta información sobre las acciones que pueden ejecutar cada una de las partes intervinientes." - }, - "items": { - "type": "object", - "properties": { - "action": { - "type": "string", - "example": "recontact", - "description": { - "es": "List of actions that each of the involved parties can execute.", - "pt": "Lista de ações que cada uma das partes envolvidas pode executar.", - "en": "Lista de acciones que pueden ejecutar cada una de las partes intervinientes." - }, - "enum": [ - { - "title": "send_message_to_complainant", - "description": { - "en": "Send a message to the buyer (with or without attachments).", - "pt": "Enviar mensagem para o comprador (com ou sem anexos).", - "es": "Enviar mensaje para el comprador (con o sin anexos)." - } - }, - { - "title": "send_message_to_mediator", - "description": { - "en": "Send a message to the mediator (with or without attachments).", - "pt": "Enviar mensagem para o mediador (com ou sem anexos).", - "es": "Enviar mensaje para el mediador (con o sin anexos)." - } - }, - { - "title": "recontact (no disponible aún)", - "description": { - "en": "Reopen a closed complaint through an interaction, such as a message.", - "pt": "Reabrir uma reclamação já fechada, por meio de uma interação, como uma mensagem.", - "es": "Reabrir un reclamo ya cerrado, por medio de una interacción, como un mensaje." - } - }, - { - "title": "refund", - "description": { - "en": "Refund the buyer's money. Must be performed by the Mercado Pago front end.", - "pt": "Devolver o dinheiro do comprador. Deve ser realizado pelo front do Mercado Pago.", - "es": "Devolver el dinero del comprado. Debe ser realizado por el front de Mercado Pago." - } - }, - { - "title": "open_dispute", - "description": { - "en": "Initiate mediation.", - "pt": "Iniciar uma mediação.", - "es": "Iniciar una mediación." - } - }, - { - "title": "send_potential_shipping", - "description": { - "en": "Send a promise of shipment, indicating a date.", - "pt": "Enviar uma promessa de postagem, indicando uma data.", - "es": "Enviar una promesa de post, indicando una fecha." - } - }, - { - "title": "add_shipping_evidence", - "description": { - "en": "Publish evidence that the product has been shipped.", - "pt": "Publicar uma evidência de que o produto foi enviado.", - "es": "Publicar una evidencia de que el producto fue enviado." - } - }, - { - "title": "send_attachments", - "description": { - "en": "Send message with attached images.", - "pt": "Enviar mensagem com imagens anexadas.", - "es": "Enviar mensaje con imágenes adjuntas." - } - }, - { - "title": "allow_return_label", - "description": { - "en": "Generate a return label.", - "pt": "Gerar etiqueta de devolução.", - "es": "Generar etiqueta de devolución." - } - }, - { - "title": "send_tracking_number", - "description": { - "en": "Send the shipping tracking number.", - "pt": "Enviar o número de rastreamento de envio (tracking number).", - "es": "Enviar el número de rastreo de envío (tracking number)." - } - } - ] - }, - "due_date": { - "type": "string", - "example": "2020-11-16T22:36:59.000-04:00", - "description": { - "en": "Deadline to perform the action.", - "pt": "Prazo limite para realizar a ação.", - "es": "Tiempo límite para realizar la acción." - } - }, - "mandatory": { - "type": "boolean", - "example": true, - "description": { - "en": "This field being 'true' indicates that the action is mandatory and must be performed within the specified time.", - "pt": "Este campo como 'true' indica que a ação é obrigatória e deve ser realizada dentro do tempo informado.", - "es": "Este campo en 'true' indica que la acción es obligatoria y debe ser realizada dentro del tiempo informado." - } - } - } - } - } - } - } - }, - "resolution": { - "type": "object", - "description": { - "en": "Provides information about claim resolution.", - "pt": "Exibe informações sobre a resolução da reclamação.", - "es": "Presenta información sobre la resolución del reclamo." - }, - "properties": { - "reason": { - "type": "string", - "example": "already_shipped", - "description": { - "en": "Reason for resolution/closure.", - "pt": "Motivo de resolução/encerramento.", - "es": "Motivo de resolucion/cierre." - } - }, - "date_created": { - "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", - "description": { - "en": "Date of resolution/closure of the claim.", - "pt": "Data de resolução/encerramento da reclamação.", - "es": "Fecha de la resolucion/cierre del reclamo." - } - }, - "benefited": { - "type": "string", - "example": "complainant", - "description": { - "en": "It will indicate who will benefit from resolving the claim.", - "pt": "Indicará quem for beneficiado pela resolução da reclamação.", - "es": "Indicará quién se beneficiará de resolver el reclamo." - } - }, - "closed_by": { - "type": "string", - "example": "mediator", - "description": { - "en": "Person who closed the claim.", - "pt": "Pessoa que encerrou a reclamação.", - "es": "Persona que cerró el reclamo." - } - } - } - }, - "site_id": { - "type": "string", - "example": "MLA", - "description": { - "en": "ID of the site where the claim occurs.", - "pt": "ID do site em que ocorre a reclamação.", - "es": "ID del sitio donde se desarrolla el reclamo." - }, - "enum": [ - { - "title": "MCO", - "description": { - "en": "Mercado Libre Colombia", - "pt": "Mercado Livre Colômbia", - "es": "Mercado Libre Colombia" - } - }, - { - "title": "MLA", - "description": { - "en": "Mercado Livre Argentina", - "pt": "Mercado Libre Argentina", - "es": "Mercado Libre Argentina" - } - }, - { - "title": "MLB", - "description": { - "en": "Mercado Libre Brasil", - "pt": "Mercado Livre Brasil", - "es": "Mercado Libre Brasil" - } - }, - { - "title": "MLC", - "description": { - "en": "Mercado Libre Chile", - "pt": "Mercado Livre Chile", - "es": "Mercado Libre Chile" - } - }, - { - "title": "MLM", - "description": { - "en": "Mercado Libre México", - "pt": "Mercado Livre México", - "es": "Mercado Libre México" - } - }, - { - "title": "MLU", - "description": { - "en": "Mercado Libre Uruguay", - "pt": "Mercado Livre Uruguai", - "es": "Mercado Libre Uruguay" - } - }, - { - "title": "MPE", - "description": { - "en": "Mercado Libre Perú", - "pt": "Mercado Livre Perú", - "es": "Mercado Libre Perú" - } - } - ] - }, - "date_created": { - "type": "string", - "example": "2020-09-30T09:48:06.000-04:00", - "description": { - "en": "Date the claim was created.", - "pt": "Data em que a reclamação foi criada.", - "es": "Fecha en la que se creó el reclamo." - } - }, - "last_updated": { - "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", - "description": { - "en": "Date of the last update to the claim.", - "pt": "Data da última atualização da reclamação.", - "es": "Fecha de última actualización reclamo." - } - } - } - } - } - } - } - } - } - } - }, - "title": { - "en": "Claims search", - "pt": "Buscar reclamações", - "es": "Buscar reclamos" - } - } - }, - "/post-purchase/v1/claims/{claim_id}/messages": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows searching, through a valid token, messages associated with a claim", - "pt": "Este endpoint permite buscar, por meio de um token válido, as mensagens associados a uma reclamação", - "es": "Este endpoint permite buscar, mediante un token válido, los mensajes asociados a un reclamo" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sender_role": { - "type": "string", - "example": "complainant", - "description": { - "en": "Person who sent the message associated with the claim.", - "pt": "Pessoa que enviou a mensagem que está associada à reclamação.", - "es": "Persona que envió el mensaje asociado a la reclamación." - } - }, - "receiver_role": { - "type": "string", - "example": "respondent", - "description": { - "en": "Person to whom the message associated with the complaint was sent.", - "pt": "Pessoa para quem a mensagem associada à reclamação foi enviada.", - "es": "Persona a la que se envió el mensaje asociado al reclamo." - } - }, - "message": { - "type": "string", - "example": "Boa noite! A tampa veio com uma rachadura. Gostaria de anexar foto", - "description": { - "en": "Displays the message text associated with the complaim.", - "pt": "Exibe o texto da mensagem associada à reclamação.", - "es": "Muestra el texto del mensaje asociado con el reclamo." - } - }, - "translated_message": { - "type": "string", - "example": null, - "description": { - "en": "This displays the translated text of the message associated with the complaint.", - "pt": "Exibe o texto traduzido da mensagem associada à reclamação.", - "es": "Esto muestra el texto traducido del mensaje asociado con el reclamo" - } - }, - "date_created": { - "type": "string", - "example": "2020-09-30T09:48:06.000-04:00", - "description": { - "en": "Date the message was created.", - "pt": "Data em que a messagem foi criada.", - "es": "Fecha en que se creó el mensaje." - } - }, - "last_updated": { - "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", - "description": { - "en": "Message Last Updated Date.", - "pt": "Data da última atualização da mensagem.", - "es": "Message Last Updated Date." - } - }, - "message_date": { - "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", - "description": { - "en": "Date the message was sent.", - "pt": "Data que a mensagem foi enviada.", - "es": "Fecha en la que se envió el mensaje" - } - }, - "date_read": { - "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", - "description": { - "en": "Date the message was read.", - "pt": "Data que a mensagem foi lida.", - "es": "Fecha en que se leyó el mensaje." - } - }, - "attachments": { - "type": "array", - "description": { - "en": "Presents information about the file attached to the message associated with the claim.", - "pt": "Apresenta informações sobre o arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Muestra información sobre el archivo de imagen adjunto al mensaje asociado al reclamo." - }, - "items": { - "type": "object", - "properties": { - "filename": { - "type": "string", - "example": "8007ee20-be67-471f-9e59-e32d9ba02fae_239628932.jpeg", - "description": { - "en": "Current name (hashed - used for retrieving the attachment) of the image file attached to the message associated with the claim.", - "pt": "Nome atual (hashado - utilizado para recuperar o anexo) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre actual (hasheado - utilizado para recuperar el attachment) del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "original_filename": { - "type": "string", - "example": "Captura de Tela 2019-07-30 a?s 09.45.40.png", - "description": { - "en": "Original name of the image file attached to the message associated with the claim.", - "pt": "Nome original do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre original del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "size": { - "type": "number", - "example": 1880609, - "description": { - "en": "Size (in bytes) of the image file attached to the message associated with the claim.", - "pt": "Tamanho (em bytes) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tamaño (en bytes) del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "type": { - "type": "string", - "example": "image/jpeg", - "description": { - "en": "Type of image file attached to the message associated with the claim.", - "pt": "Tipo do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tipo de archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "date_created": { - "type": "string", - "example": "2020-07-22T20:43:15.000-04:00", - "description": { - "en": "Date when the image file was attached to the message associated with the complaint.", - "pt": "Data em que o arquivo de imagem foi anexado à mensagem que está associada à reclamação.", - "es": "Fecha en que se adjuntó el archivo de imagen al mensaje que está asociado al reclamo." - } - } - } - } - }, - "status": { - "type": "string", - "example": "available", - "description": { - "en": "Displays the status of the message associated with the claim. It can take one of the following values: 'available', 'moderated', 'rejected', 'pending_translation'.", - "pt": "Apresenta o estado em que se encontra a mensagem associada à reclamação. Pode assumir um dos seguintes valores: 'available', 'moderated', 'rejected', 'pending_translation'.", - "es": "Muestra el estado en que se encuentra el mensaje asociado al reclamo. Puede tomar alguno de los siguientes valores: 'available', 'moderated', 'rejected', 'pending_translation'." - } - }, - "stage": { - "type": "string", - "example": "claim", - "description": { - "en": "Stage at which the claim was at the time the message was sent. It can take one of the following values:", - "pt": "Estágio em que a reclamação se encontrava no momento em que a mensagem foi enviada. Pode assumir um dos seguintes valores:", - "es": "Etapa en la que se encontraba el reclamo al momento en que se envió el mensaje. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "claim", - "description": { - "en": "Initial stage of the claim process in which both the buyer and seller are involved.", - "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", - "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." - } - }, - { - "title": "dispute", - "description": { - "en": "Phase where the claim is under dispute or disagreement.", - "pt": "Fase em que a reclamação está em disputa ou desacordo.", - "es": "Fase donde el reclamo está en disputa o desacuerdo." - } - }, - { - "title": "recontact", - "description": { - "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", - "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", - "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." - } - }, - { - "title": "none", - "description": { - "en": "Indicates no specific stage is currently applicable.", - "pt": "Indica que nenhuma etapa específica é aplicável.", - "es": "Indica que no se aplica ninguna etapa específica." - } - } - ] - }, - "moderation": { - "type": "object", - "description": { - "en": "Presents information about the file attached to the message associated with the claim.", - "pt": "Apresenta informações sobre o arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Muestra información sobre el archivo de imagen adjunto al mensaje asociado al reclamo." - }, - "properties": { - "status": { - "type": "string", - "example": "clean", - "description": { - "en": "Result of the message moderation process. It can take one of the following values:", - "pt": "Resultado do processo de moderação da mensagem. Pode assumir um dos seguintes valores:", - "es": "Resultado del proceso de moderación de mensajes. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "clean", - "description": { - "en": "Indicates that the message is clean, without information.", - "pt": "Indica que a mensagem está limpa, sem informações.", - "es": "Indica que el mensaje está limpio, sin información." - } - }, - { - "title": "rejected", - "description": { - "en": "Indicates that the message has been moderated.", - "pt": "Indica que a mensagem foi moderada.", - "es": "Indica que el mensaje ha sido moderado." - } - }, - { - "title": "pending", - "description": { - "en": "Indicates that message moderation is in progress.", - "pt": "Indica que a moderação da mensagem está em processo.", - "es": "Indica que la moderación del mensaje está en proceso." - } - }, - { - "title": "non_moderated", - "description": { - "en": "Indicates that the message has not been moderated. For example: cases of old messages.", - "pt": "Indica que a mensagem não foi moderada. Por exemplo: casos de mensagens antigas.", - "es": "Indica que el mensaje no ha sido moderado. Por ejemplo: casos de mensajes antiguos." - } - } - ] - }, - "reason": { - "type": "string", - "example": "", - "description": { - "en": "Reason for moderating the message. Currently, this moderation can be due to inappropriate language.", - "pt": "Razão pela qual a mensagem foi moderada. Atualmente, essa moderação pode ser devido a linguagem inadequada.", - "es": "Razón por la cual se moderó el mensaje. Actualmente, esta moderación puede ser por lenguaje inapropiado." - } - }, - "source": { - "type": "string", - "example": "online", - "description": { - "en": "Displays the moderation mode. Currently, the only available mode is 'online,' where the message is moderated during its creation.", - "pt": "Exibe a modalidade da moderação. Atualmente, a única modalidade disponível é a 'online', em que se modera a mensagem durante a sua criação.", - "es": "Muestra la modalidad de moderación. Actualmente, la única modalidad disponible es la 'online', en la que se modera el mensaje durante su creación." - } - }, - "date_moderated": { - "type": "string", - "example": "2023-02-01T20:13:50Z", - "description": { - "en": "Date when the moderation information was impacted.", - "pt": "Data em que a informação de moderação foi impactada.", - "es": "Fecha en que se impactó la información de moderación." - } - }, - - "date_created": { - "type": "string", - "example": "2020-07-22T20:43:15.000-04:00", - "description": { - "en": "Date the message was created.", - "pt": "Data em que a mensagem foi criada.", - "es": "Fecha en la que se creó el mensaje." - } - } - } - }, - "repeated": { - "type": "boolean", - "example": false, - "description": { - "en": "", - "pt": "", - "es": "" - } - } - } - } - } - } - } - } - }, - "title": { - "en": "Get claim messages", - "pt": "Obter mensagens da reclamação", - "es": "Obtener mensajes del reclamo" - } - } - }, - "/post-purchase/v1/claims/{claim_id}/attachments": { - "post": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows, through a valid token, attaching image files to the messages that will be associated with the complaint", - "pt": "Este endpoint permite anexar, por meio de um token válido, anexar arquivos de imagem as mensagens que serão associados à reclamação", - "es": "Este endpoint permite, mediante un token válido, adjuntar archivos de imagen a los mensajes que se asociarán con el reclamo" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - }, - { - "in": "formData", - "name": "file", - "schema": { - "type": "string", - "example": "file=@/Users/user/Desktop/file.jpg" - }, - "description": { - "en": "Location of the image file that will be attached to the message associated with the claim. The file must be a maximum of 5 MB and be in JPG, PNG or PDF format. The file name cannot be more than 125 characters and be composed only of the following characters: letters, numbers, period, hyphen, underscore, etc.", - "pt": "Localização do arquivo de imagem que será anexado à mensagem associada à reclamação. O arquivo deverá ter, no máximo, 5 MB e estar nos formatos JPG, PNG ou PDF. O nome do arquivo não pode ter mais de 125 caracteres e ser composto apenas pelos seguintes caracteres: letras, números, ponto, hífen, sublinhado, etc.", - "es": "Ubicación del archivo de imagen que se adjuntará al mensaje asociado al reclamo. El archivo debe tener un tamaño máximo de 5 MB y estar en formato JPG, PNG o PDF. El nombre del archivo no puede tener más de 125 caracteres y estar compuesto solo por los siguientes caracteres: letras, números, punto, guion medio, guion bajo, etc." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "user_id": { - "type": "number", - "example": 415836081, - "description": { - "en": "Presents the ID of the person who sent the image file that was attached to the message associated with the claim. It is necessary for this person to be a participant in the claim.", - "pt": "Apresenta o ID de quem enviou o arquivo de imagem que foi anexado à mensagem associada à reclamação. É necessário que seja uma pessoa participante da reclamação.", - "es": "Muestra el ID de la persona que envió el archivo de imagen que fue adjunto al mensaje asociado con el reclamo. Es necesario que sea una persona participante del reclamo." - } - }, - "filename": { - "type": "string", - "example": "44739b8c-592f-4fa3-bdc0-ed1905879eab.jpeg", - "description": { - "en": "Hashed file name (used for retrieving the attachment).", - "pt": "Nome do arquivo hashado (utilizado para recuperar o anexo).", - "es": "Nombre del archivo hasheado (utilizado para recuperar el attachment)." - } - }, - "render_url": { - "type": "string", - "example": "https://fury-storage-private-default.s3.amazonaws.com/mediations-api-core/attachment2/767b79a6-88c8-4fa4-8d95-2cb78fcd897f.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2W4YYFSFIIM7ONWJ%2F20201009%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20201009T174026Z&X-Amz-Expires=43200&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEA8aCXVzLWVhc3QtMSJHMEUCIBznL6LSjtxZx2rmNacevS3fkUtCntzn8hEERS3I9zGcAiEArLoRIu6slpEVHMaKK2%2B3LaXK5vJeEVlwmQ1en1xBlswqtAMIRxABGgw3MzYzNzAzNzE3MjIiDN38MnchbBVYZCS%2BfiqRA9sgC51NLCQ0stU6s2Dek7gt8JmSth7oYLHE8v1WhK3WaiBfe%2FV6LqnrqJcGIikCXr05GqQalWZQLITG1mwC%2Fkx6x5XL5jKFw67lXUvoZzmctRoQPpXpA6MJBTvdCZJKifAS2grLExBJ7KUrgGH6MCxiHpZwm5cO1VP9E5ETFcOTtVzgJtSU0TX70Z4%2BVZPwbxbuEnnqCuW61MZkMvT4dF6oVkZZBR8JuaaiM4w17FV%2B%2Bzt3l39EP9iZdv7NG6G6ZFjvL5UgkVfOm0Bn2w6JONEl8upiOqQN1voen8TugywgWm683isabg1LK2c5GNVWR4qEYbnpS2jZhd732IuDgl1De1V93O5WW2Xf0HGqXhIWYHf9ZDViwWrMXQc5VRQwDIukAgwIy5%2FiBUEwjNBavu4eiWcqtVIQ8OxH9CJIBrQMgPaB%2FtV9LZRGAH24ZwcBD%2FEu%2BEWEDPnR6giE24nAAkWAMlhPQI5NKGGy6y4SLxJ5KalD5yb4Twi0W%2Fvj7bUxfYBSebAn%2B4zldwvFPzWwJRxbMMTdgfwFOusBof6%2FydFCa12JdZERNpiC49pjSmal6DP7rl91JmwVKzG%2FIIENnlBIjZ1yvEtFWy2WcEDqnn2OfEeRc5vop%2FUHnRo3i1TEC8IHs7ECCwwWcf6UAB0%2FUXL8fGj6uQ7KuQ7DLphrZBMfpUz8JXRx1FVRKMWioszeYfL9dQ%2B24GDsESAN83y%2B19ZRdy727X7GsvnZQvdWo7zHQT4zXDmJB0RFtMHwHYtALsGHUyymyA%2FaQjfnbnccvesgGvLGpqdwmXZ0QFMmNobOlJA4STZY%2FejLulxq%2BNhmrvih83%2BSn5Q0043c2%2BzLYeSGs8jUJg%3D%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=cb9a006b693e4b4e17948be0ccbb28739627daf0766f521cb98a2e5643ab9229", - "description": { - "en": "URL where you can get the rendered image file.", - "pt": "URL em que será possível obter o arquivo de imagem renderizado.", - "es": "URL donde puede obtener el archivo de imagen renderizada." - } - } - } - } - } - } - } - }, - "title": { - "en": "Attach files to the message", - "pt": "Anexar arquivos à mensagem", - "es": "Adjuntar archivos al mensaje" - } - } - }, - "/post-purchase/v1/claims/{claim_id}/actions/send-message": { - "post": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows, through a valid token, sending and associating messages with attached image files to the claim", - "pt": "Este endpoint permite enviar e associar à reclamação, por meio de um token válido, mensagens com arquivos de imagens anexados", - "es": "Este endpoint permite enviar y asociar al reclamo, mediante un token válido, mensajes con archivos de imágenes adjuntos." - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - }, - { - "in": "query", - "name": "application_id", - "schema": { - "type": "string", - "example": "123456789" - }, - "description": { - "en": "This is the client unique identificator who initiated the claim.", - "pt": "Identificador único do cliente que iniciou a reclamação.", - "es": "Identificador único del cliente que inició el reclamo." - } - } - ], - "requestBody": { - "description": "", - "content": { - "application/json": { - "schema": { - "required": ["receiver_role", "message"], - "type": "object", - "properties": { - "receiver_role": { - "type": "string", - "example": "respondent", - "description": { - "en": "Person to whom the message associated with the claim will be sent.", - "pt": "Pessoa para quem a mensagem associada à reclamação será enviada.", - "es": "Persona a quien se enviará el mensaje asociado al reclamo." - } - }, - "message": { - "type": "string", - "example": "Mensaje de prueba", - "description": { - "en": "Text of the message to be associated with the claim.", - "pt": "Texto da mensagem a ser associada à reclamação.", - "es": "Texto del mensaje que se asociará al reclamo." - } - }, - "attachments": { - "type": "string", - "example": "WhatsApp-Image-2020-09-22.jpeg", - "description": { - "en": "Image file attached to the message that will be associated with the claim.", - "pt": "Arquivo de imagem anexado à mensagem que será associada à reclamação.", - "es": "Archivo de imagen adjunto al mensaje que se asociará al reclamo." - } - } - } - } - } - } - }, - "responses": { - "201": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - } - } - }, - "title": { - "en": "Send message with file", - "pt": "Enviar mensagem com arquivo ", - "es": "Enviar mensaje con archivo" - } - } - }, - "/post-purchase/v1/claims/{claim_id}/attachments/{fileName}/download": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows, through a valid token, downloading image files attached to the messages associated with the claim", - "pt": "Este endpoint permite, por meio de um token válido, fazer download de arquivos de imagem anexados as mensagens associados à reclamação", - "es": "Este endpoint permite, mediante un token válido, descargar archivos de imagen adjuntos a los mensajes asociados al reclamo" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - }, - { - "in": "path", - "name": "attach_id", - "required": true, - "schema": { - "type": "string", - "example": "0f2d81a2-c489-435e-96af-59688ad3d8f4_305860144.jpeg" - }, - "description": { - "en": "Identifier of the attached file.", - "pt": "Identificador do arquivo anexado.", - "es": "Identificador del archivo adjunto." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - } - } - }, - "title": { - "en": "Download attached files", - "pt": "Baixar arquivos anexados", - "es": "Descargar archivos adjuntos" - } - } - }, - "/post-purchase/v1/claims/{claim_id}/attachments/{fileName}": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows searching, through a valid token, for image files attached to the message associated with the complaint", - "pt": "Este endpoint permite buscar, mediante un token válido, arquivos de imagem anexados à mensagem associada à reclamaçao", - "es": "Este endpoint permite buscar, mediante un token válido, archivos de imagen adjuntos al mensaje asociado a la reclamación" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - }, - { - "in": "path", - "name": "attach_id", - "required": true, - "schema": { - "type": "string", - "example": "0f2d81a2-c489-435e-96af-59688ad3d8f4_305860144.jpeg" - }, - "description": { - "en": "Identifier of the attached file.", - "pt": "Identificador do arquivo anexado.", - "es": "Identificador del archivo adjunto." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "filename": { - "type": "string", - "example": "767b79a6-88c8-4fa4-8d95-2cb78fcd897f.jpeg", - "description": { - "en": "Current name (hashed - used for retrieving the attachment) of the image file attached to the message associated with the claim.", - "pt": "Nome atual (hashado - utilizado para recuperar o anexo) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre actual (hasheado - utilizado para recuperar el attachment) del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "original_filename": { - "type": "string", - "example": "WWhatsApp-Image-2020-09-22.jpeg", - "description": { - "en": "Original name of the image file attached to the message associated with the claim.", - "pt": "Nome original do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre original del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "size": { - "type": "number", - "example": 1880609, - "description": { - "en": "Size (in bytes) of the image file attached to the message associated with the claim.", - "pt": "Tamanho (em bytes) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tamaño (en bytes) del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "date_created": { - "type": "string", - "example": "2020-07-22T20:43:15.000-04:00", - "description": { - "en": "Date when the image file was attached to the message associated with the complaint.", - "pt": "Data em que o arquivo de imagem foi anexado à mensagem que está associada à reclamação.", - "es": "Fecha en que se adjuntó el archivo de imagen al mensaje que está asociado al reclamo." - } - }, - "type": { - "type": "string", - "example": "image/jpeg", - "description": { - "en": "Type of image file attached to the message associated with the claim.", - "pt": "Tipo do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tipo de archivo de imagen adjunto al mensaje asociado al reclamo." - } - } - } - } - } - } - } - }, - "title": { - "en": "Get file data", - "pt": "Obter dados do arquivo", - "es": "Obtener información del archivo" - } - } - }, - "/post-purchase/v1/claims/{claim_id}/actions/open-dispute": { - "post": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows searching, through a valid token, requesting mediation in the claim opened by the user", - "pt": "Este endpoint permite solicitar, mediante um token válido, uma mediação na reclamação aberta pela pessoa usuária", - "es": "Este endpoint permite buscar, mediante un token válido, solicitar mediación en el reclamo abierto por la persona usuaria" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - } - ], - "responses": { - "201": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number", - "example": 5033102536, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - }, - "resource_id": { - "type": "number", - "example": 7138572864, - "description": { - "en": "ID of the resource on which the claim is created and depends on the 'resource' parameter.", - "pt": "ID do recurso sobre o qual a reclamação é criada e depende do parâmetro 'resource'.", - "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro 'resource'." - } - }, - "status": { - "type": "string", - "example": "closed", - "description": { - "en": "Specifies the current state of the claim, indicating whether it is open or closed. It can take one of the following values:", - "pt": "Especifica o estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", - "es": "Especifica el estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "opened", - "description": { - "en": "Indicates that the claim is open.", - "pt": "Indica que a reclamação está aberta.", - "es": "Indica que el reclamo está abierto." - } - }, - { - "title": "closed", - "description": { - "en": "Indicates that the claim is closed.", - "pt": "Indica que a reclamação está fechada.", - "es": "Indica que el reclamo está cerrado." - } - } - ] - }, - "type": { - "type": "string", - "example": "mediations", - "description": { - "en": "Defines the nature of the claim being processed. It can take one of the following values:", - "pt": "Define a natureza da reclamação em processamento. Pode assumir um dos seguintes valores:", - "es": "Define la naturaleza del reclamo que se está procesando. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "mediations", - "description": { - "en": "Refers to the process of mediating between parties in a claim.", - "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", - "es": "Se refiere al proceso de mediación entre las partes en un reclamo." - } - }, - { - "title": "cancel_purchase", - "description": { - "en": "Involves the process of cancelling a previously made purchase.", - "pt": "Envolve o processo de cancelar uma compra previamente realizada.", - "es": "Involucra el proceso de cancelar una compra previamente realizada." - } - }, - { - "title": "return", - "description": { - "en": "Pertains to the process of returning a purchased item.", - "pt": "Refere-se ao processo de devolução de um item comprado.", - "es": "Se refiere al proceso de devolver un artículo comprado." - } - }, - { - "title": "cancel_sale", - "description": { - "en": "oncerns the process of cancelling a sale that has been made.", - "pt": "Refere-se ao processo de cancelar uma venda realizada.", - "es": "Se ocupa del proceso de cancelar una venta realizada." - } - }, - { - "title": "change", - "description": { - "en": "Refers to the alteration or modification of the details or status of a claim.", - "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", - "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." - } - } - ] - }, - "stage": { - "type": "string", - "example": "dispute", - "description": { - "en": "Indicates the current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", - "pt": "Indica a fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", - "es": "Indica la fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "claim", - "description": { - "en": "Initial stage of the claim process in which both the buyer and seller are involved.", - "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", - "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." - } - }, - { - "title": "dispute", - "description": { - "en": "Phase where the claim is under dispute or disagreement.", - "pt": "Fase em que a reclamação está em disputa ou desacordo.", - "es": "Fase donde el reclamo está en disputa o desacuerdo." - } - }, - { - "title": "recontact", - "description": { - "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", - "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", - "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." - } - }, - { - "title": "none", - "description": { - "en": "Indicates no specific stage is currently applicable.", - "pt": "Indica que nenhuma etapa específica é aplicável.", - "es": "Indica que no se aplica ninguna etapa específica." - } - } - ] - }, - "parent_id": { - "type": "string", - "example": null, - "description": { - "en": "ID of another claim on which it depends.", - "pt": "ID de outra reclamação da qual esta depende.", - "es": "ID de otro reclamo del que depende." - } - }, - "resource": { - "type": "string", - "example": "shipment", - "description": { - "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase.", - "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra.", - "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra." - }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Related to claims involving payment transactions.", - "pt": "Relacionado a reclamações envolvendo transações de pagamento.", - "es": "Relacionado con reclamos que involucran transacciones de pago." - } - }, - { - "title": "order", - "description": { - "en": "Pertains to claims arising from order processing issues.", - "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", - "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." - } - }, - { - "title": "shipment", - "description": { - "en": "Concerns claims related to shipping or delivery matters.", - "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", - "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." - } - }, - { - "title": "purchase", - "description": { - "en": "Involves claims associated with the purchase process.", - "pt": "Envolve reclamações associadas ao processo de compra.", - "es": "Involucra reclamos asociados con el proceso de compra." - } - } - ] - }, - "reason_id": { - "type": "string", - "example": "PNR4071", - "description": { - "en": "Reason ID of the claim. A claim can be created for three general reasons:", - "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", - "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" - }, - "enum": [ - { - "title": "PNR", - "description": { - "en": "Product not received.", - "pt": "Produto não recebido.", - "es": "Producto no recibido." - } - }, - { - "title": "PDD", - "description": { - "en": "Different or defective product.", - "pt": "Produto diferente ou defeituoso", - "es": "Producto diferente o defectuoso." - } - }, - { - "title": "CS", - "description": { - "en": "Purchase cancellation.", - "pt": "Cancelamento de compra.", - "es": "Cancelación de la compra." - } - } - ] - }, - "fulfilled": { - "type": "boolean", - "example": true, - "description": { - "en": "Indicate whether the claim is for a delivered or undelivered product.", - "pt": "Indique se o reclamação é sobre um produto entregue ou não entregue.", - "es": "Indica si el reclamo se inicia por un producto entregado o no." - } - }, - "quantity_type": { - "type": "string", - "example": "total", - "description": { - "en": "Indica si una devolución corresponde a todos los productos de la orden o solo algunos. Inicialmente sólo mostrará el valor 'total' y en el futuro se visualizará el valor 'partial'.", - "pt": "Indica se um reembolso corresponde a todos os produtos do pedido ou apenas alguns. Inicialmente, mostrará apenas o valor 'total' e, no futuro, será exibido o valor 'partial'.", - "es": "Indicates whether a return corresponds to all products in the order or only some. Initially, it will only show the value 'total', and in the future, the value 'partial' will be displayed." - } - }, - "players": { - "type": "array", - "description": { - "en": "People who are participating in the complaint.", - "pt": "Pessoas que estão participando da reclamação.", - "es": "Personas que están participando en el reclamo." - }, - "items": { - "type": "object", - "properties": { - "role": { - "type": "string", - "example": "mediator", - "description": { - "en": "Indicates the person's role within the claim. It can take one of the following values:", - "pt": "Indica o papel da pessoa dentro da reclamação. Pode assumir um dos seguintes valores:", - "es": "Indica el rol de la persona dentro del reclamo. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "complainant", - "description": { - "en": "Person who claims", - "pt": "Pessoa que reclama.", - "es": "Persona que reclama." - } - }, - { - "title": "respondent", - "description": { - "en": "Person to whom they are complaining.", - "pt": "Pessoa a quem estão reclamando.", - "es": "Persona a quién le reclaman." - } - }, - { - "title": "mediator", - "description": { - "en": "Person who intervenes to help solve the problem.", - "pt": "Pessoa que intervém para ajudar a resolver o problema.", - "es": "Persona que interviene para ayudar a solucionar el problema." - } - } - ] - }, - "type": { - "type": "string", - "example": "payer", - "description": { - "en": "Role that the person occupies in the operation that is being claimed and may vary according to the 'resource'. It can take one of the following values:", - "pt": "Papel que a pessoa ocupa na operação que está sendo reivindicada e pode variar de acordo com o 'resource'. Pode assumir um dos seguintes valores:", - "es": "Rol que ocupa la persona sobre la operación que se está reclamando y puede variar de acuerdo con el 'resource'. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Indicates that the person is the buyer or collector.", - "pt": "Indica que a pessoa é compradora ou cobradora.", - "es": "Indica que la persona es el comprador o collector." - } - }, - { - "title": "order", - "description": { - "en": "Indicates that the person is the buyer or seller.", - "pt": "Indica que a pessoa é compradora ou vendedora.", - "es": "Indica que la persona es el comprador o vendedor." - } - }, - { - "title": "shipment", - "description": { - "en": "Indicates that the person is the receiver or sender.", - "pt": "Indica que a pessoa é o destinatário ou remetente.", - "es": "Indica que la persona es el receptor o remitente." - } - } - ] - }, - "user_id": { - "type": "number", - "example": 242829175, - "description": { - "en": "ID of the 'type' indicated in the previous parameter.", - "pt": "ID do 'type' indicado no parâmetro anterior.", - "es": "ID del 'type' indicado en el parámetro anterior." - } - }, - "available_actions": { - "type": "array", - "description": { - "en": "Provides information about the actions that each of the involved parties can execute.", - "pt": "Exibe informações sobre as ações que cada uma das partes envolvidas pode executar.", - "es": "Presenta información sobre las acciones que pueden ejecutar cada una de las partes intervinientes." - }, - "items": { - "type": "object", - "properties": { - "action": { - "type": "string", - "example": "recontact", - "description": { - "es": "List of actions that each of the involved parties can execute.", - "pt": "Lista de ações que cada uma das partes envolvidas pode executar.", - "en": "Lista de acciones que pueden ejecutar cada una de las partes intervinientes." - }, - "enum": [ - { - "title": "send_message_to_complainant", - "description": { - "en": "Send a message to the buyer (with or without attachments).", - "pt": "Enviar mensagem para o comprador (com ou sem anexos).", - "es": "Enviar mensaje para el comprador (con o sin anexos)." - } - }, - { - "title": "send_message_to_mediator", - "description": { - "en": "Send a message to the mediator (with or without attachments).", - "pt": "Enviar mensagem para o mediador (com ou sem anexos).", - "es": "Enviar mensaje para el mediador (con o sin anexos)." - } - }, - { - "title": "recontact (no disponible aún)", - "description": { - "en": "Reopen a closed complaint through an interaction, such as a message.", - "pt": "Reabrir uma reclamação já fechada, por meio de uma interação, como uma mensagem.", - "es": "Reabrir un reclamo ya cerrado, por medio de una interacción, como un mensaje." - } - }, - { - "title": "refund", - "description": { - "en": "Refund the buyer's money. Must be performed by the Mercado Pago front end.", - "pt": "Devolver o dinheiro do comprador. Deve ser realizado pelo front do Mercado Pago.", - "es": "Devolver el dinero del comprado. Debe ser realizado por el front de Mercado Pago." - } - }, - { - "title": "open_dispute", - "description": { - "en": "Initiate mediation.", - "pt": "Iniciar uma mediação.", - "es": "Iniciar una mediación." - } - }, - { - "title": "send_potential_shipping", - "description": { - "en": "Send a promise of shipment, indicating a date.", - "pt": "Enviar uma promessa de postagem, indicando uma data.", - "es": "Enviar una promesa de post, indicando una fecha." - } - }, - { - "title": "add_shipping_evidence", - "description": { - "en": "Publish evidence that the product has been shipped.", - "pt": "Publicar uma evidência de que o produto foi enviado.", - "es": "Publicar una evidencia de que el producto fue enviado." - } - }, - { - "title": "send_attachments", - "description": { - "en": "Send message with attached images.", - "pt": "Enviar mensagem com imagens anexadas.", - "es": "Enviar mensaje con imágenes adjuntas." - } - }, - { - "title": "allow_return_label", - "description": { - "en": "Generate a return label.", - "pt": "Gerar etiqueta de devolução.", - "es": "Generar etiqueta de devolución." - } - }, - { - "title": "send_tracking_number", - "description": { - "en": "Send the shipping tracking number.", - "pt": "Enviar o número de rastreamento de envio (tracking number).", - "es": "Enviar el número de rastreo de envío (tracking number)." - } - } - ] - }, - "due_date": { - "type": "string", - "example": "2020-11-16T22:36:59.000-04:00", - "description": { - "en": "Deadline to perform the action.", - "pt": "Prazo limite para realizar a ação.", - "es": "Tiempo límite para realizar la acción." - } - }, - "mandatory": { - "type": "boolean", - "example": true, - "description": { - "en": "This field being 'true' indicates that the action is mandatory and must be performed within the specified time.", - "pt": "Este campo como 'true' indica que a ação é obrigatória e deve ser realizada dentro do tempo informado.", - "es": "Este campo en 'true' indica que la acción es obligatoria y debe ser realizada dentro del tiempo informado." - } - } - } - } - } - } - } - }, - "resolution": { - "type": "object", - "description": { - "en": "Provides information about claim resolution.", - "pt": "Exibe informações sobre a resolução da reclamação.", - "es": "Presenta información sobre la resolución del reclamo." - }, - "properties": { - "reason": { - "type": "string", - "example": "already_shipped", - "description": { - "en": "Reason for resolution/closure.", - "pt": "Motivo de resolução/encerramento.", - "es": "Motivo de resolucion/cierre." - } - }, - "date_created": { - "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", - "description": { - "en": "Date of resolution/closure of the claim.", - "pt": "Data de resolução/encerramento da reclamação.", - "es": "Fecha de la resolucion/cierre del reclamo." - } - }, - "decision": { - "type": "array", - "items": { - "type": "string", - "example": "complainant", - "description": { - "en": "Person who defined the resolution of the claim.", - "pt": "Pessoa que definiu a resolução da reclamação.", - "es": "Persona que definió la resolución del reclamo." - } - } - }, - "closed_by": { - "type": "string", - "example": "mediator", - "description": { - "en": "Person who closed the claim.", - "pt": "Pessoa que encerrou a reclamação.", - "es": "Persona que cerró el reclamo." - } - } - } - }, - "site_id": { - "type": "string", - "example": "MLA", - "description": { - "en": "ID of the site where the claim occurs.", - "pt": "ID do site em que ocorre a reclamação.", - "es": "ID del sitio donde se desarrolla el reclamo." - }, - "enum": [ - { - "title": "MCO", - "description": { - "en": "Mercado Libre Colombia", - "pt": "Mercado Livre Colômbia", - "es": "Mercado Libre Colombia" - } - }, - { - "title": "MLA", - "description": { - "en": "Mercado Livre Argentina", - "pt": "Mercado Libre Argentina", - "es": "Mercado Libre Argentina" - } - }, - { - "title": "MLB", - "description": { - "en": "Mercado Libre Brasil", - "pt": "Mercado Livre Brasil", - "es": "Mercado Libre Brasil" - } - }, - { - "title": "MLC", - "description": { - "en": "Mercado Libre Chile", - "pt": "Mercado Livre Chile", - "es": "Mercado Libre Chile" - } - }, - { - "title": "MLM", - "description": { - "en": "Mercado Libre México", - "pt": "Mercado Livre México", - "es": "Mercado Libre México" - } - }, - { - "title": "MLU", - "description": { - "en": "Mercado Libre Uruguay", - "pt": "Mercado Livre Uruguai", - "es": "Mercado Libre Uruguay" - } - }, - { - "title": "MPE", - "description": { - "en": "Mercado Libre Perú", - "pt": "Mercado Livre Perú", - "es": "Mercado Libre Perú" - } - } - ] - }, - "date_created": { - "type": "string", - "example": "2020-09-30T09:48:06.000-04:00", - "description": { - "en": "Date the claim was created.", - "pt": "Data em que a reclamação foi criada.", - "es": "Fecha en la que se creó el reclamo." - } - }, - "last_updated": { - "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", - "description": { - "en": "Date of the last update to the claim.", - "pt": "Data da última atualização da reclamação.", - "es": "Fecha de última actualización reclamo." - } - } - } - } - } - } - } - }, - "title": { - "en": "Request claim mediation", - "pt": "Solicitar mediação da reclamação", - "es": "Solicitar mediación del reclamo" - } - } - }, - "/post-purchase/v1/claims/{claim_id}/expected-resolutions": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows, through a valid token, viewing the expected resolutions by the user in their claim", - "pt": "Este endpoint permite visualizar, mediante un token válido, resoluções esperadas pela pessoa usuária em sua reclamação", - "es": "Este endpoint permite visualizar, mediante un token válido, las resoluciones esperadas por la persona usuaria en su reclamo" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "player_role": { - "type": "string", - "example": "complainant", - "description": { - "en": "User who initiated the claim.", - "pt": "Pessoa usuária que iniciou a reclamação.", - "es": "Persona usuaria que inició el reclamo." - } - }, - "user_id": { - "type": "number", - "example": 40014151, - "description": { - "en": "User ID who initiated the claim.", - "pt": "ID da pessoa usuária que iniciou a reclamação.", - "es": "ID de al persona usuaria que inicia el reclamo." - } - }, - "expected_resolution": { - "type": "string", - "example": "product", - "description": { - "en": "Presents possible resolutions expected by the complainant. It can take one of the following values:", - "pt": "Apresenta as possíveis resoluções esperadas por quem reclama. Pode assumir um dos seguintes valores:", - "es": "Muestra las posibles resoluciones esperadas por quien reclama. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "refund", - "description": { - "en": "The user expects the money to be refunded.", - "pt": "A pessoa usuária espera que o dinheiro seja devolvido.", - "es": "La persona usuaria espera que se le devuelva el dinero." - } - }, - { - "title": "product", - "description": { - "en": "The user expects the product to be delivered.", - "pt": "A pessoa usuária espera que o produto seja entregue.", - "es": "La persona usuaria espera que el producto sea entregado." - } - }, - { - "title": "change_product", - "description": { - "en": "The user expects the product to be exchanged.", - "pt": "A pessoa usuária espera que o produto seja trocado.", - "es": "La persona usuaria espera que el producto sea cambiado." - } - }, - { - "title": "return_product", - "description": { - "en": "The user will wait for the return of the product to receive the refund.", - "pt": "A pessoa usuária irá esperar a devolução do produto para poder receber a devolução do dinheiro.", - "es": "La persona usuaria esperará la devolución del producto para poder recibir el dinero de vuelta." - } - } - ] - }, - "date_created": { - "type": "string", - "example": "2020-09-30T09:48:06.000-04:00", - "description": { - "en": "Date the claim was created.", - "pt": "Data em que a reclamação foi criada.", - "es": "Fecha en la que se creó el reclamo." - } - }, - "last_updated": { - "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", - "description": { - "en": "Date of the last update to the claim.", - "pt": "Data da última atualização da reclamação.", - "es": "Fecha de última actualización reclamo." - } - }, - "status": { - "type": "string", - "example": "pending", - "description": { - "en": "Displays the status of the expected resolution by the person who initiated the claim. It can take one of the following values:", - "pt": "Apresenta o estado da resolução esperada por quem iniciou a reclamação. Pode assumir um dos seguintes valores:", - "es": "Muestra el estado de la resolución esperada por quien inició el reclamo. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "pending", - "description": { - "en": "The person loaded the expected resolution but it has not been accepted by the counterpart yet.", - "pt": "A pessoa carregou a resolução esperada, mas ainda não foi aceita pela contraparte.", - "es": "La persona cargó la resolución esperada pero no aún no fue aceptada por la contraparte." - } - }, - { - "title": "accepted", - "description": { - "en": "The resolution loaded by the person was accepted by their counterpart or, alternatively, by the Mercado", - "pt": "A resolução carregada pela pessoa foi aceita por sua contraparte ou, caso contrário, pelo mediador do Mercado Pago.", - "es": "La resolución cargada por la persona fue aceptada por su contraparte o, en su defecto, por el mediador de Mercado Pago." - } - }, - { - "title": "rejected", - "description": { - "en": "The resolution loaded by the person was rejected by the counterpart, and alternatively, they loaded a new resolution option.", - "pt": "A resolução carregada pela pessoa foi rejeitada pela contraparte e, em contra partida, ela carregou uma nova opção de resolução.", - "es": "La resolución cargada por la persona fue rechazada por su contraparte y, en su defecto, cargó una nueva opción de resolución." - } - } - ] - } - } - } - } - } - } - } - }, - "title": { - "en": "See expected resolutions at mediation", - "pt": "Ver resoluções esperadas na mediação", - "es": "Ver resoluciones esperadas en mediación" - } - } - }, - "/post-purchase/v1/claims/{claim_id}/evidences": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows, through a valid token, obtaining evidence of the the claim, such as order shipping information and attached image files associated with the claim", - "pt": "Este endpoint permite obter, mediante um token válido, evidências da reclamação como, por exemplo, informações de envio do pedido e de anexos de imagens associados à reclamação", - "es": "Este endpoint permite obtener, mediante un token válido, evidencias del reclamo, como información de envío del pedido y archivos de imágenes adjuntos asociados al reclamo" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "attachments": { - "type": "array", - "description": { - "en": "Presents information about the file attached to the message associated with the claim.", - "pt": "Apresenta informações sobre o arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Muestra información sobre el archivo de imagen adjunto al mensaje asociado al reclamo." - }, - "items": { - "type": "object", - "properties": { - "filename": { - "type": "string", - "example": "8007ee20-be67-471f-9e59-e32d9ba02fae_239628932.jpeg", - "description": { - "en": "Current name (hashed - used for retrieving the attachment) of the image file attached to the message associated with the claim.", - "pt": "Nome atual (hashado - utilizado para recuperar o anexo) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre actual (hasheado - utilizado para recuperar el attachment) del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "original_filename": { - "type": "string", - "example": "Captura-de-Tela-2019-07-30.png", - "description": { - "en": "Original name of the image file attached to the message associated with the claim.", - "pt": "Nome original do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre original del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "size": { - "type": "number", - "example": 1880609, - "description": { - "en": "Size (in bytes) of the image file attached to the message associated with the claim.", - "pt": "Tamanho (em bytes) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tamaño (en bytes) del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "type": { - "type": "string", - "example": "image/jpeg", - "description": { - "en": "Type of image file attached to the message associated with the claim.", - "pt": "Tipo do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tipo de archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "date_created": { - "type": "string", - "example": "2020-07-22T20:43:15.000-04:00", - "description": { - "en": "Date when the image file was attached to the message associated with the complaint.", - "pt": "Data em que o arquivo de imagem foi anexado à mensagem que está associada à reclamação.", - "es": "Fecha en que se adjuntó el archivo de imagen al mensaje que está asociado al reclamo." - } - }, - "file_url": { - "type": "string", - "example": "https://fury-storage-private-default.s3.amazonaws.com/mediations-api-core/attachment2/767b79a6-88c8-4fa4-8d95-2cb78fcd897f.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2W4YYFSFIIM7ONWJ%2F20201009%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20201009T174026Z&X-Amz-Expires=43200&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEA8aCXVzLWVhc3QtMSJHMEUCIBznL6LSjtxZx2rmNacevS3fkUtCntzn8hEERS3I9zGcAiEArLoRIu6slpEVHMaKK2%2B3LaXK5vJeEVlwmQ1en1xBlswqtAMIRxABGgw3MzYzNzAzNzE3MjIiDN38MnchbBVYZCS%2BfiqRA9sgC51NLCQ0stU6s2Dek7gt8JmSth7oYLHE8v1WhK3WaiBfe%2FV6LqnrqJcGIikCXr05GqQalWZQLITG1mwC%2Fkx6x5XL5jKFw67lXUvoZzmctRoQPpXpA6MJBTvdCZJKifAS2grLExBJ7KUrgGH6MCxiHpZwm5cO1VP9E5ETFcOTtVzgJtSU0TX70Z4%2BVZPwbxbuEnnqCuW61MZkMvT4dF6oVkZZBR8JuaaiM4w17FV%2B%2Bzt3l39EP9iZdv7NG6G6ZFjvL5UgkVfOm0Bn2w6JONEl8upiOqQN1voen8TugywgWm683isabg1LK2c5GNVWR4qEYbnpS2jZhd732IuDgl1De1V93O5WW2Xf0HGqXhIWYHf9ZDViwWrMXQc5VRQwDIukAgwIy5%2FiBUEwjNBavu4eiWcqtVIQ8OxH9CJIBrQMgPaB%2FtV9LZRGAH24ZwcBD%2FEu%2BEWEDPnR6giE24nAAkWAMlhPQI5NKGGy6y4SLxJ5KalD5yb4Twi0W%2Fvj7bUxfYBSebAn%2B4zldwvFPzWwJRxbMMTdgfwFOusBof6%2FydFCa12JdZERNpiC49pjSmal6DP7rl91JmwVKzG%2FIIENnlBIjZ1yvEtFWy2WcEDqnn2OfEeRc5vop%2FUHnRo3i1TEC8IHs7ECCwwWcf6UAB0%2FUXL8fGj6uQ7KuQ7DLphrZBMfpUz8JXRx1FVRKMWioszeYfL9dQ%2B24GDsESAN83y%2B19ZRdy727X7GsvnZQvdWo7zHQT4zXDmJB0RFtMHwHYtALsGHUyymyA%2FaQjfnbnccvesgGvLGpqdwmXZ0QFMmNobOlJA4STZY%2FejLulxq%2BNhmrvih83%2BSn5Q0043c2%2BzLYeSGs8jUJg%3D%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=cb9a006b693e4b4e17948be0ccbb28739627daf0766f521cb98a2e5643ab9229", - "description": { - "en": "URL where you can get the rendered image file.", - "pt": "URL em que será possível obter o arquivo de imagem renderizado.", - "es": "URL donde puede obtener el archivo de imagen renderizada." - } - } - } - } - }, - "type": { - "type": "string", - "example": "shipping_evidence", - "description": { - "en": "Presents the type of evidence of sending the request related to the claim. It can take one of the following values:", - "pt": "Apresenta o tipo de evidência de envio do pedido relacionado à reclamação. Pode assumir um dos seguintes valores:", - "es": "Muestra el tipo de evidencia de envío del pedido relacionado con el reclamo. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "shipping_evidence", - "description": { - "en": "The seller has an evidence that the order was shipped.", - "pt": "O vendedor tem uma prova referente ao envio do pedido.", - "es": "El vendedor tiene una prueba relacionada con el envío del pedido." - } - }, - { - "title": "handling_shipping_evidence", - "description": { - "en": "There is still no evidence of sending the order, but this information is expected.", - "pt": "Ainda não há uma prova de envio do pedido, mas há uma previsão desta informação.", - "es": "Aún no hay una prueba de envío del pedido, pero hay una previsión de esta información." - } - } - ] - }, - "date_shipped": { - "type": "string", - "example": "2018-03-07T05:00:00Z", - "description": { - "en": "Displays the shipping date of the order associated with the claim.", - "pt": "Apresenta a data de envio do pedido associado à reclamação.", - "es": "Muestra la fecha de envío del pedido asociado al reclamo." - } - }, - "date_delivered": { - "type": "string", - "example": null, - "description": { - "en": "Displays the delivery date of the order associated with the claim.", - "pt": "Exibe a data de entrega do pedido associado à reclamação.", - "es": "Muestra la fecha de entrega del pedido asociado al reclamo." - } - }, - "destination_agency": { - "type": "string", - "example": null, - "description": { - "en": "Informs the name of the agency to which the order is being sent.", - "pt": "Informa o nome da agência para a qual o pedido está sendo enviado.", - "es": "Informa el nombre de la agencia a la que se envía el pedido." - } - }, - "receiver_email": { - "type": "string", - "example": null, - "description": { - "en": "Email of the recipient of the order associated with the claim.", - "pt": "E-mail do destinatário do pedido associado à reclamação.", - "es": "Email del destinatario del pedido asociado al reclamo." - } - }, - "receiver_id": { - "type": "string", - "example": null, - "description": { - "en": "Displays a personal document number of the person who received the product.", - "pt": "Exibe um número de documento pessoal de quem recebeu o produto.", - "es": "Muestra un número de documento personal de quien recibió el producto." - } - }, - "receiver_name": { - "type": "string", - "example": null, - "description": { - "en": "Displays the name of the order recipient.", - "pt": "Apresenta o nome do destinatário do pedido.", - "es": "Presenta el nombre del destinatario del pedido." - } - }, - "shipping_company_name": { - "type": "string", - "example": "servientrega", - "description": { - "en": "Name of the company responsible for transporting the order.", - "pt": "Nome da empresa responsável pelo transporte do pedido.", - "es": "Nombre de la empresa responsable del transporte del pedido." - } - }, - "shipping_method": { - "type": "string", - "example": "mail", - "description": { - "en": "Refers to the method of shipping the product, which can be: order (by tracking), personal delivery (by person) or by email (e-mail).", - "pt": "Refere-se à forma de envio do produto, podendo ser: encomenda (por transportadora), entrega pessoal (por pessoa) ou por e-mail (e-mail).", - "es": "Refiere a cómo enviaron el producto, que puede ser: encomienda (por un transportista), entrega personal (por una persona) o por email (correo electrónico)." - } - }, - "tracking_number": { - "type": "string", - "example": "132456787", - "description": { - "en": "Provides the order delivery tracking number.", - "pt": "Informa o número de rastreio da entrega do pedido.", - "es": "Informa el número de seguimiento del envío del pedido." - } - } - } - } - } - } - } - } - }, - "title": { - "en": "Get claim evidence", - "pt": "Obter evidências da reclamação", - "es": "Obtener evidencias del reclamo" - } - } - }, - "/post-purchase/v1/claims/{claim_id}/actions/evidences": { - "post": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows you to upload, through a valid token, evidence of sending the order. For a delivery by mail the fields 'shipping_company_name' and 'date_shipped' are required, while for a delivery to order the required fields are 'shipping_company_name', 'destination_agency', 'date_shipped' and 'receiver_name'. For delivery by email, the 'receiver_email' and 'date_shipped' fields are mandatory", - "pt": "Este endpoint permite carregar, mediante um token válido, evidências de envio do pedido. Para uma entrega por correio, os campos 'shipping_company_name' e 'date_shipped' são obrigatórios, enquanto para uma entrega por encomenda os campos obrigatórios são 'shipping_company_name', 'destination_agency', 'date_shipped' e 'receiver_name'. Para entrega por e-mail, os campos 'receiver_email' e 'date_shipped' são obrigatórios", - "es": "Este endpoint permite cargar, mediante un token válido, evidencias de envío del pedido. Para una entrega por correo son obligatorios los campos 'shipping_company_name' y 'date_shipped', mientras una entrega por encomienda los campos obligatorios son 'shipping_company_name', 'destination_agency', 'date_shipped' y 'receiver_name'. Para entrega por email son obligatorios los campos 'receiver_email' y 'date_shipped'" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "attachments": { - "type": "string", - "example": "38f4e399-0f18-41e4-8f48-91aecd2dee1a_419059118.png", - "description": { - "en": "File attached to the message associated with the claim.", - "pt": "Arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "type": { - "type": "string", - "example": "shipping_evidence", - "description": { - "en": "The type of evidence of sending the request related to the claim. It can take one of the following values:", - "pt": "Tipo de evidência de envio do pedido relacionado à reclamação. Pode assumir um dos seguintes valores:", - "es": "Tipo de evidencia de envío del pedido relacionado con el reclamo. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "shipping_evidence", - "description": { - "en": "The seller has an evidence that the order was shipped.", - "pt": "O vendedor tem uma prova referente ao envio do pedido.", - "es": "El vendedor tiene una prueba relacionada con el envío del pedido." - } - }, - { - "title": "handling_shipping_evidence", - "description": { - "en": "There is still no evidence of sending the order, but this information is expected.", - "pt": "Ainda não há uma prova de envio do pedido, mas há uma previsão desta informação.", - "es": "Aún no hay una prueba de envío del pedido, pero hay una previsión de esta información." - } - } - ] - }, - "date_shipped": { - "type": "string", - "example": "2023-03-07T05:00:00Z", - "description": { - "en": "The shipping date of the order associated with the claim.", - "pt": "Data de envio do pedido associado à reclamação.", - "es": "Fecha de envío del pedido asociado al reclamo." - } - }, - "date_delivered": { - "type": "string", - "example": "2023-03-15T05:00:00Z", - "description": { - "en": "Delivery date of the order associated with the claim.", - "pt": "Data de entrega do pedido associado à reclamação.", - "es": "Fecha de entrega del pedido asociado al reclamo." - } - }, - "destination_agency": { - "type": "string", - "example": "Melicidade", - "description": { - "en": "Name of the agency to which the order is being sent.", - "pt": "Nome da agência para a qual o pedido está sendo enviado.", - "es": "Nombre de la agencia a la que se envía el pedido." - } - }, - "receiver_email": { - "type": "string", - "example": "test_user_123@testuser.com", - "description": { - "en": "Email of the recipient of the order associated with the claim.", - "pt": "E-mail do destinatário do pedido associado à reclamação.", - "es": "Email del destinatario del pedido asociado al reclamo." - } - }, - "receiver_id": { - "type": "string", - "example": 156762, - "description": { - "en": "Personal document number of the person who received the product.", - "pt": "Número de documento pessoal de quem recebeu o produto.", - "es": "Número de documento personal de quien recibió el producto." - } - }, - "receiver_name": { - "type": "string", - "example": "Tester", - "description": { - "en": "Name of the order recipient.", - "pt": "Nome do destinatário do pedido.", - "es": "Nombre del destinatario del pedido." - } - }, - "shipping_company_name": { - "type": "string", - "example": "servientrega", - "description": { - "en": "Name of the company responsible for transporting the order.", - "pt": "Nome da empresa responsável pelo transporte do pedido.", - "es": "Nombre de la empresa responsable del transporte del pedido." - } - }, - "shipping_method": { - "type": "string", - "example": "mail", - "description": { - "en": "Refers to the method of shipping the product, which can be: order (by tracking), personal delivery (by person) or by email (e-mail).", - "pt": "Refere-se à forma de envio do produto, podendo ser: encomenda (por transportadora), entrega pessoal (por pessoa) ou por e-mail (e-mail).", - "es": "Refiere a cómo enviaron el producto, que puede ser: encomienda (por un transportista), entrega personal (por una persona) o por email (correo electrónico)." - } - }, - "tracking_number": { - "type": "string", - "example": 132456787, - "description": { - "en": "The order delivery tracking number.", - "pt": "Número de rastreio da entrega do pedido.", - "es": "Número de seguimiento del envío del pedido." - } - } - } - } - } - } - }, - "responses": { - "201": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "attachments": { - "type": "array", - "description": { - "en": "Presents information about the file attached to the message associated with the claim.", - "pt": "Apresenta informações sobre o arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Muestra información sobre el archivo de imagen adjunto al mensaje asociado al reclamo." - }, - "items": { - "type": "object", - "properties": { - "filename": { - "type": "string", - "example": "8007ee20-be67-471f-9e59-e32d9ba02fae_239628932.jpeg", - "description": { - "en": "Current name (hashed - used for retrieving the attachment) of the image file attached to the message associated with the claim.", - "pt": "Nome atual (hashado - utilizado para recuperar o anexo) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre actual (hasheado - utilizado para recuperar el attachment) del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "original_filename": { - "type": "string", - "example": "Captura-de-Tela-2019-07-30.png", - "description": { - "en": "Original name of the image file attached to the message associated with the claim.", - "pt": "Nome original do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Nombre original del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "size": { - "type": "number", - "example": 1880609, - "description": { - "en": "Size (in bytes) of the image file attached to the message associated with the claim.", - "pt": "Tamanho (em bytes) do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tamaño (en bytes) del archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "date_created": { - "type": "string", - "example": "2020-07-22T20:43:15.000-04:00", - "description": { - "en": "Date when the image file was attached to the message associated with the complaint.", - "pt": "Data em que o arquivo de imagem foi anexado à mensagem que está associada à reclamação.", - "es": "Fecha en que se adjuntó el archivo de imagen al mensaje que está asociado al reclamo." - } - }, - "type": { - "type": "string", - "example": "image/jpeg", - "description": { - "en": "Type of image file attached to the message associated with the claim.", - "pt": "Tipo do arquivo de imagem anexado à mensagem associada à reclamação.", - "es": "Tipo de archivo de imagen adjunto al mensaje asociado al reclamo." - } - }, - "file_url": { - "type": "string", - "example": "https://fury-storage-private-default.s3.amazonaws.com/mediations-api-core/attachment2/767b79a6-88c8-4fa4-8d95-2cb78fcd897f.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2W4YYFSFIIM7ONWJ%2F20201009%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20201009T174026Z&X-Amz-Expires=43200&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEA8aCXVzLWVhc3QtMSJHMEUCIBznL6LSjtxZx2rmNacevS3fkUtCntzn8hEERS3I9zGcAiEArLoRIu6slpEVHMaKK2%2B3LaXK5vJeEVlwmQ1en1xBlswqtAMIRxABGgw3MzYzNzAzNzE3MjIiDN38MnchbBVYZCS%2BfiqRA9sgC51NLCQ0stU6s2Dek7gt8JmSth7oYLHE8v1WhK3WaiBfe%2FV6LqnrqJcGIikCXr05GqQalWZQLITG1mwC%2Fkx6x5XL5jKFw67lXUvoZzmctRoQPpXpA6MJBTvdCZJKifAS2grLExBJ7KUrgGH6MCxiHpZwm5cO1VP9E5ETFcOTtVzgJtSU0TX70Z4%2BVZPwbxbuEnnqCuW61MZkMvT4dF6oVkZZBR8JuaaiM4w17FV%2B%2Bzt3l39EP9iZdv7NG6G6ZFjvL5UgkVfOm0Bn2w6JONEl8upiOqQN1voen8TugywgWm683isabg1LK2c5GNVWR4qEYbnpS2jZhd732IuDgl1De1V93O5WW2Xf0HGqXhIWYHf9ZDViwWrMXQc5VRQwDIukAgwIy5%2FiBUEwjNBavu4eiWcqtVIQ8OxH9CJIBrQMgPaB%2FtV9LZRGAH24ZwcBD%2FEu%2BEWEDPnR6giE24nAAkWAMlhPQI5NKGGy6y4SLxJ5KalD5yb4Twi0W%2Fvj7bUxfYBSebAn%2B4zldwvFPzWwJRxbMMTdgfwFOusBof6%2FydFCa12JdZERNpiC49pjSmal6DP7rl91JmwVKzG%2FIIENnlBIjZ1yvEtFWy2WcEDqnn2OfEeRc5vop%2FUHnRo3i1TEC8IHs7ECCwwWcf6UAB0%2FUXL8fGj6uQ7KuQ7DLphrZBMfpUz8JXRx1FVRKMWioszeYfL9dQ%2B24GDsESAN83y%2B19ZRdy727X7GsvnZQvdWo7zHQT4zXDmJB0RFtMHwHYtALsGHUyymyA%2FaQjfnbnccvesgGvLGpqdwmXZ0QFMmNobOlJA4STZY%2FejLulxq%2BNhmrvih83%2BSn5Q0043c2%2BzLYeSGs8jUJg%3D%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=cb9a006b693e4b4e17948be0ccbb28739627daf0766f521cb98a2e5643ab9229", - "description": { - "en": "URL where you can get the rendered image file.", - "pt": "URL em que será possível obter o arquivo de imagem renderizado.", - "es": "URL donde puede obtener el archivo de imagen renderizada." - } - } - } - } - }, - "type": { - "type": "string", - "example": "shipping_evidence", - "description": { - "en": "Presents the type of evidence of sending the request related to the claim. It can take one of the following values:", - "pt": "Apresenta o tipo de evidência de envio do pedido relacionado à reclamação. Pode assumir um dos seguintes valores:", - "es": "Muestra el tipo de evidencia de envío del pedido relacionado con el reclamo. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "shipping_evidence", - "description": { - "en": "The seller has an evidence that the order was shipped.", - "pt": "O vendedor tem uma prova referente ao envio do pedido.", - "es": "El vendedor tiene una prueba relacionada con el envío del pedido." - } - }, - { - "title": "handling_shipping_evidence", - "description": { - "en": "There is still no evidence of sending the order, but this information is expected.", - "pt": "Ainda não há uma prova de envio do pedido, mas há uma previsão desta informação.", - "es": "Aún no hay una prueba de envío del pedido, pero hay una previsión de esta información." - } - } - ] - }, - "date_shipped": { - "type": "string", - "example": "2023-03-07T05:00:00Z", - "description": { - "en": "Displays the shipping date of the order associated with the claim.", - "pt": "Apresenta a data de envio do pedido associado à reclamação.", - "es": "Muestra la fecha de envío del pedido asociado al reclamo." - } - }, - "date_delivered": { - "type": "string", - "example": "2023-03-15T05:00:00Z", - "description": { - "en": "Displays the delivery date of the order associated with the claim.", - "pt": "Exibe a data de entrega do pedido associado à reclamação.", - "es": "Muestra la fecha de entrega del pedido asociado al reclamo." - } - }, - "destination_agency": { - "type": "string", - "example": "Melicidade", - "description": { - "en": "Informs the name of the agency to which the order is being sent.", - "pt": "Informa o nome da agência para a qual o pedido está sendo enviado.", - "es": "Informa el nombre de la agencia a la que se envía el pedido." - } - }, - "receiver_email": { - "type": "string", - "example": "test_user_123@testuser.com", - "description": { - "en": "Email of the recipient of the order associated with the claim.", - "pt": "E-mail do destinatário do pedido associado à reclamação.", - "es": "Email del destinatario del pedido asociado al reclamo." - } - }, - "receiver_id": { - "type": "string", - "example": 156762, - "description": { - "en": "Displays a personal document number of the person who received the product.", - "pt": "Exibe um número de documento pessoal de quem recebeu o produto.", - "es": "Muestra un número de documento personal de quien recibió el producto." - } - }, - "receiver_name": { - "type": "string", - "example": "Teste", - "description": { - "en": "Displays the name of the order recipient.", - "pt": "Apresenta o nome do destinatário do pedido.", - "es": "Presenta el nombre del destinatario del pedido." - } - }, - "shipping_company_name": { - "type": "string", - "example": "servientrega", - "description": { - "en": "Name of the company responsible for transporting the order.", - "pt": "Nome da empresa responsável pelo transporte do pedido.", - "es": "Nombre de la empresa responsable del transporte del pedido." - } - }, - "shipping_method": { - "type": "string", - "example": "mail", - "description": { - "en": "Refers to the method of shipping the product, which can be: order (by tracking), personal delivery (by person) or by email (e-mail).", - "pt": "Refere-se à forma de envio do produto, podendo ser: encomenda (por transportadora), entrega pessoal (por pessoa) ou por e-mail (e-mail).", - "es": "Refiere a cómo enviaron el producto, que puede ser: encomienda (por un transportista), entrega personal (por una persona) o por email (correo electrónico)." - } - }, - "tracking_number": { - "type": "string", - "example": 132456787, - "description": { - "en": "Provides the order delivery tracking number.", - "pt": "Informa o número de rastreio da entrega do pedido.", - "es": "Informa el número de seguimiento del envío del pedido." - } - } - } - } - } - } - } - } - }, - "title": { - "en": "Upload shipping evidence", - "pt": "Carregar evidências de envio", - "es": "Cargar evidencias de envío" - } - } - }, - "/post-purchase/v1/claims/{claim_id}/status_history": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows you to view, through a valid token, the history of states and scenarios that the complaint has gone through. It will also be possible to consult the history of actions taken by the people responsible for the complaint", - "pt": "Este endpoint permite visualizar, por meio de um token válido, o histórico de estados e cenários pelos quais a reclamação passou. Também será possível consultar o histórico de ações tomadas pelas pessoas responsáveis pela reclamação", - "es": "Este endpoint permite visualizar, a través de un token válido, el historial de estados y escenarios por los que ha pasado el reclamo. También será posible consultar el historial de acciones tomadas por los responsables del reclamo" - }, - "parameters": [ - { - "in": "path", - "name": "claim_id", - "required": true, - "schema": { - "type": "number", - "example": 5039218470 - }, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "stage": { - "type": "string", - "example": "dispute", - "description": { - "en": "Indicates the current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", - "pt": "Indica a fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", - "es": "Indica la fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "claim", - "description": { - "en": "Initial stage of the claim process in which both the buyer and seller are involved.", - "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", - "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." - } - }, - { - "title": "dispute", - "description": { - "en": "Phase where the claim is under dispute or disagreement.", - "pt": "Fase em que a reclamação está em disputa ou desacordo.", - "es": "Fase donde el reclamo está en disputa o desacuerdo." - } - }, - { - "title": "recontact", - "description": { - "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", - "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", - "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." - } - }, - { - "title": "none", - "description": { - "en": "Indicates no specific stage is currently applicable.", - "pt": "Indica que nenhuma etapa específica é aplicável.", - "es": "Indica que no se aplica ninguna etapa específica." - } - } - ] - }, - "status": { - "type": "string", - "example": "closed", - "description": { - "en": "Specifies the current state of the claim, indicating whether it is open or closed. It can take one of the following values:", - "pt": "Especifica o estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", - "es": "Especifica el estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "opened", - "description": { - "en": "Indicates that the claim is open.", - "pt": "Indica que a reclamação está aberta.", - "es": "Indica que el reclamo está abierto." - } - }, - { - "title": "closed", - "description": { - "en": "Indicates that the claim is closed.", - "pt": "Indica que a reclamação está fechada.", - "es": "Indica que el reclamo está cerrado." - } - } - ] - }, - "date": { - "type": "string", - "example": "2020-09-08T23:59:36.000-04:00", - "description": { - "en": "Date of change in claim status.", - "pt": "Data de alteração do estado da reclamação.", - "es": "Fecha de cambio en el estado del reclamo." - } - }, - "change_by": { - "type": "string", - "example": "mediator", - "description": { - "en": "Indicates the person who changed the claim. It can take one of the following values:", - "pt": "Apresenta a pessoa que alterou a reclamação. Pode assumir um dos seguintes valores:", - "es": "Indica la persona que cambió el reclamo. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "complainant", - "description": { - "en": "Person who claims", - "pt": "Pessoa que reclama.", - "es": "Persona que reclama." - } - }, - { - "title": "respondent", - "description": { - "en": "Person to whom they are complaining.", - "pt": "Pessoa a quem estão reclamando.", - "es": "Persona a quién le reclaman." - } - }, - { - "title": "mediator", - "description": { - "en": "Person who intervenes to help solve the problem.", - "pt": "Pessoa que intervém para ajudar a resolver o problema.", - "es": "Persona que interviene para ayudar a solucionar el problema." - } - } - ] - } - } - } - } - } - } - } - }, - "title": { - "en": "Get claim history", - "pt": "Obter histórico da reclamação", - "es": "Obtener historial del reclamo" - } - } - }, - "/post-purchase/v1/claims/reasons/{reason_id}": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows you to view, through a valid token, the 'reason' why the claim was created, so that based on its classification, certain behaviors are allowed", - "pt": "Este endpoint permite visualizar, a partir de um token válido, o motivo ('reason') pelo qual uma reclamação foi criada, de forma que com base na sua classificação sejam permitidos determinados comportamentos", - "es": "Este endpoint permite visualizar, mediante un token válido, el motivo ('reason') por el cual se ha creado un reclamo, de manera que en base a su tipificación se permiten determinados comportamientos" - }, - "parameters": [ - { - "in": "path", - "name": "reason_id", - "required": true, - "schema": { - "type": "string", - "example": "PNR3430" - }, - "description": { - "en": "Reason ID of the claim. A claim can be created for three general reasons:", - "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", - "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" - }, - "enum": [ - { - "title": "PNR", - "description": { - "en": "Product not received.", - "pt": "Produto não recebido.", - "es": "Producto no recibido." - } - }, - { - "title": "PDD", - "description": { - "en": "Different or defective product.", - "pt": "Produto diferente ou defeituoso.", - "es": "Producto diferente o defectuoso." - } - }, - { - "title": "CS", - "description": { - "en": "Purchase cancellation.", - "pt": "Cancelamento de compra.", - "es": "Cancelación de la compra." - } - } - ] - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "PDD1", - "description": { - "en": "Reason ID of the claim. A claim can be created for three general reasons:", - "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", - "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" - }, - "enum": [ - { - "title": "PNR", - "description": { - "en": "Product not received.", - "pt": "Produto não recebido.", - "es": "Producto no recibido." - } - }, - { - "title": "PDD", - "description": { - "en": "Different or defective product.", - "pt": "Produto diferente ou defeituoso.", - "es": "Producto diferente o defectuoso." - } - }, - { - "title": "CS", - "description": { - "en": "Purchase cancellation.", - "pt": "Cancelamento de compra.", - "es": "Cancelación de la compra." - } - } - ] - }, - "flow": { - "type": "string", - "example": "meadiations", - "description": { - "en": "Indicates which mediation flow the claim is currently in.", - "pt": "Indica em qual fluxo de mediação a reclamação se encontra no momento em questão.", - "es": "Indica en qué flujo de mediación se encuentra el reclamo en el momento en cuestión." - }, - "enum": [ - { - "title": "mediations", - "description": { - "en": "Refers to the process of mediating between parties in a claim.", - "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", - "es": "Se refiere al proceso de mediación entre las partes en un reclamo." - } - }, - { - "title": "cancel_purchase", - "description": { - "en": "Involves the process of cancelling a previously made purchase.", - "pt": "Envolve o processo de cancelar uma compra previamente realizada.", - "es": "Involucra el proceso de cancelar una compra previamente realizada." - } - }, - { - "title": "return", - "description": { - "en": "Pertains to the process of returning a purchased item.", - "pt": "Refere-se ao processo de devolução de um item comprado.", - "es": "Se refiere al proceso de devolver un artículo comprado." - } - }, - { - "title": "cancel_sale", - "description": { - "en": "oncerns the process of cancelling a sale that has been made.", - "pt": "Refere-se ao processo de cancelar uma venda realizada.", - "es": "Se ocupa del proceso de cancelar una venta realizada." - } - }, - { - "title": "change", - "description": { - "en": "Refers to the alteration or modification of the details or status of a claim.", - "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", - "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." - } - } - ] - }, - "name": { - "type": "string", - "example": "defective_item", - "description": { - "en": "Displays the description of the reason for the claim.", - "pt": "Exibe a descrição do motivo da reclamação.", - "es": "Presenta la descripción del motivo del reclamo." - } - }, - "detail": { - "type": "string", - "example": "El producto es defectuoso.", - "description": { - "en": "Displays details about the reason for the claim.", - "pt": "Exibe os detalhes sobre o motivo da reclamação.", - "es": "Muestra detalles sobre el motivo del reclamo." - } - }, - "position": { - "type": "number", - "example": 201, - "description": { - "en": "Position in which the reason for the complaint is found. It serves the same function as 'sort_by', but it is a default sorting type that will sort the reasons asynchronously.", - "pt": "Posição em que se encontra o motivo da reclamação. Cumpre a mesma função de 'sort_by', mas é um tipo de ordenação padrão que ordenará os motivos ('reason') de forma assíncrona.", - "es": "Posición en la que se encuentra el motivo de la reclamación. Cumple la misma función que 'sort_by', pero es un tipo de ordenación predeterminada que ordenará los motivos ('reason') de forma asíncrona." - } - }, - "filter": { - "type": "object", - "description": { - "en": "Filtering attributes of claim information.", - "pt": "Atributos de filtragem de informações da reclamação.", - "es": "Atributos de filtrado de información del reclamo." - }, - "items": { - "type": "array", - "properties": { - "group": { - "type": "string", - "exemple": "fashion", - "description": { - "en": "List of groups to which 'reason' belongs.", - "pt": "Lista de grupos aos quais o 'reason' pertence.", - "es": "Listado de grupos al que pertenece el 'reason'." - } - }, - "site_id": { - "type": "string", - "example": "MLA", - "description": { - "en": "ID of the site where the claim occurs.", - "pt": "ID do site em que ocorre a reclamação.", - "es": "ID del sitio donde se desarrolla el reclamo." - }, - "enum": [ - { - "title": "MCO", - "description": { - "en": "Mercado Libre Colombia", - "pt": "Mercado Livre Colômbia", - "es": "Mercado Libre Colombia" - } - }, - { - "title": "MLA", - "description": { - "en": "Mercado Livre Argentina", - "pt": "Mercado Libre Argentina", - "es": "Mercado Libre Argentina" - } - }, - { - "title": "MLB", - "description": { - "en": "Mercado Libre Brasil", - "pt": "Mercado Livre Brasil", - "es": "Mercado Libre Brasil" - } - }, - { - "title": "MLC", - "description": { - "en": "Mercado Libre Chile", - "pt": "Mercado Livre Chile", - "es": "Mercado Libre Chile" - } - }, - { - "title": "MLM", - "description": { - "en": "Mercado Libre México", - "pt": "Mercado Livre México", - "es": "Mercado Libre México" - } - }, - { - "title": "MLU", - "description": { - "en": "Mercado Libre Uruguay", - "pt": "Mercado Livre Uruguai", - "es": "Mercado Libre Uruguay" - } - }, - { - "title": "MPE", - "description": { - "en": "Mercado Libre Perú", - "pt": "Mercado Livre Perú", - "es": "Mercado Libre Perú" - } - } - ] - } - } - } - }, - "settings": { - "type": "object", - "description": { - "en": "Filtering attributes of claim information.", - "pt": "Atributos de filtragem de informações da reclamação.", - "es": "Atributos de filtrado de información del reclamo." - }, - "items": { - "type": "array", - "properties": { - "allowed_flows": { - "type": "string", - "exemple": "claim", - "description": { - "en": "Indicate in which flows we can visualize this 'reason'.", - "pt": "Indica em quais fluxos podemos visualizar esta 'reason'.", - "es": "Indica en qué flujos podemos visualizar esta 'reason'." - } - }, - "expected_resolution": { - "type": "string", - "exemple": "change_product", - "description": { - "en": "Presents possible resolutions expected by the complainant. It can take one of the following values:", - "pt": "Apresenta as possíveis resoluções esperadas por quem reclama. Pode assumir um dos seguintes valores:", - "es": "Muestra las posibles resoluciones esperadas por quien reclama. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "refund", - "description": { - "en": "The user expects the money to be refunded.", - "pt": "A pessoa usuária espera que o dinheiro seja devolvido.", - "es": "La persona usuaria espera que se le devuelva el dinero." - } - }, - { - "title": "product", - "description": { - "en": "The user expects the product to be delivered.", - "pt": "A pessoa usuária espera que o produto seja entregue.", - "es": "La persona usuaria espera que el producto sea entregado." - } - }, - { - "title": "change_product", - "description": { - "en": "The user expects the product to be exchanged.", - "pt": "A pessoa usuária espera que o produto seja trocado.", - "es": "La persona usuaria espera que el producto sea cambiado." - } - }, - { - "title": "return_product", - "description": { - "en": "The user will wait for the return of the product to receive the refund.", - "pt": "A pessoa usuária irá esperar a devolução do produto para poder receber a devolução do dinheiro.", - "es": "La persona usuaria esperará la devolución del producto para poder recibir el dinero de vuelta." - } - } - ] - }, - "rules_engine_triage": { - "type": "string", - "exemple": "defective", - "description": { - "en": "Definition of the tag for triage categorization of the reason by which a complaint was created, with possible values including: 'repentant', 'defective', 'incomplete', 'different', or 'not_working'.", - "pt": "Definição da tag para categorização de triagem do motivo ('reason') pelo qual uma reclamação foi criada, podendo apresentar os seguintes valores: 'repentant', 'defective', 'incomplete', 'different' ou 'not_working'.", - "es": "Definición de la etiqueta para la categorización de triaje del motivo ('reason') por el cual se creó una queja, pudiendo presentar los siguientes valores: 'repentant', 'defective', 'incomplete', 'different' o 'not_working'." - } - } - } - }, - "parent_id": { - "type": "string", - "example": "PDD9501", - "description": { - "en": "ID of another claim on which it depends.", - "pt": "ID de outra reclamação da qual esta depende.", - "es": "ID de otro reclamo del que depende." - } - }, - "children_title": { - "type": "string", - "example": null, - "description": { - "en": "Used during post-purchase classification, where the value of the title is taken for the final reasons or sub-reasons of the reason that contain a value for this attribute.", - "pt": "Utilizado na hora de classificação no pós-venda, onde se pega o valor do título para as 'reason' finais ou as sub-razões de la 'reason' que contém um valor para este atributo.", - "es": "Utilizado en el momento de clasificación en la pos-venta, donde se toma el valor del título para las 'reason' finales o las subrazones de la 'reason' que contienen un valor para este atributo." - } - }, - "status": { - "type": "string", - "example": "active", - "description": { - "en": "The state of the 'reason' for the complaint.", - "pt": "Estado em que se encontra a 'reason' da reclamação.", - "es": "Estado en el que se encuentra la 'reason' del reclamo." - } - }, - "date_created": { - "type": "string", - "example": "2022-01-04T17:09:50.793Z", - "description": { - "en": "Creation date of the claim 'reason'.", - "pt": "Data de criação da 'reason' da reclamação.", - "es": "Fecha de creación de la 'reason' del reclamo." - } - }, - "last_updated": { - "type": "string", - "example": "2022-01-04T17:09:50.793Z", - "description": { - "en": "Date of the last update to the claim 'reason'.", - "pt": "Data da última atualização da 'reason' da reclamação.", - "es": "Fecha de la última actualización de la 'reason' del reclamo." - } - } - } - } - } - } - } - } - }, - "title": { - "en": "Get the reason for the claim", - "pt": "Obter motivo da reclamação", - "es": "Obtener motivo del reclamo" - } - } - }, - "/claim_resource": { - "get": { - "tags": [ - "checkout-pro" - ], - "description": { - "en": "This endpoint allows, through a valid token, to obtain notifications of the complaint by making a 'get' request to the complaints resource using the 'resource' field of the 'data' parameter from the Webhook notifications received from the topic. For more information about Webhook notifications, visit: https://www.mercadopago.com/developers/en/docs/your-integrations/notifications/webhooks", - "pt": "Este endpoint permite, por meio de um token válido, obter notificações da reclamação realizando um 'get' ao recurso de reclamações utilizando o campo 'resource', do parâmetro 'data', das notificaçõees Webhook recebidas do tópico. Para mais informações sobre notificações Webhook, acesse: https://www.mercadopago.com/developers/pt/docs/your-integrations/notifications/webhooks", - "es": "Este endpoint permite, mediante un token válido, obtener notificaciones de la queja realizando una solicitud 'get' al recurso de reclamos utilizando el campo 'resource', del parámetro 'data', de las notificaciones Webhook recibidas del tema. Para obtener más información sobre las notificaciones de Webhook, visite: https://www.mercadopago.com/developers/es/docs/your-integrations/notifications/webhooks" - }, - "parameters": [ - { - "in": "path", - "name": "CLAIM_RESOURCE", - "required": true, - "schema": { - "type": "string", - "example": "/v1/claims/1041417027" - }, - "description": { - "en": "The 'data.resource' received in the claims notification, indicates the path that must be accessed to retrieve the information.", - "pt": "O 'data.resource' recebido na notificação da reclamação, indicando o path que deve ser acessado para recuperar suas informações.", - "es": "El 'data.resource' recibido en la notificación de reclamos, indicando el path al que se debe acceder para recuperar su información." - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Sucesso", - "en": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number", - "example": 5033102536, - "description": { - "en": "Claim ID. Unique identifier used to reference a specific claim in the system, essential for tracking and managing these claims.", - "pt": "ID da reclamação. Identificador único usado para referenciar uma reclamação específica no sistema, sendo essencial para rastrear e gerenciar estas reclamações.", - "es": "ID del reclamo. Identificador único utilizado para hacer referencia a un reclamo específico en el sistema, esencial para rastrear y gestionar estos reclamos." - } - }, - "type": { - "type": "string", - "example": "mediations", - "description": { - "en": "Defines the nature of the claim being processed. It can take one of the following values:", - "pt": "Define a natureza da reclamação em processamento. Pode assumir um dos seguintes valores:", - "es": "Define la naturaleza del reclamo que se está procesando. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "mediations", - "description": { - "en": "Refers to the process of mediating between parties in a claim.", - "pt": "Refere-se ao processo de mediação entre as partes em uma reclamação.", - "es": "Se refiere al proceso de mediación entre las partes en un reclamo." - } - }, - { - "title": "cancel_purchase", - "description": { - "en": "Involves the process of cancelling a previously made purchase.", - "pt": "Envolve o processo de cancelar uma compra previamente realizada.", - "es": "Involucra el proceso de cancelar una compra previamente realizada." - } - }, - { - "title": "return", - "description": { - "en": "Pertains to the process of returning a purchased item.", - "pt": "Refere-se ao processo de devolução de um item comprado.", - "es": "Se refiere al proceso de devolver un artículo comprado." - } - }, - { - "title": "cancel_sale", - "description": { - "en": "oncerns the process of cancelling a sale that has been made.", - "pt": "Refere-se ao processo de cancelar uma venda realizada.", - "es": "Se ocupa del proceso de cancelar una venta realizada." - } - }, - { - "title": "change", - "description": { - "en": "Refers to the alteration or modification of the details or status of a claim.", - "pt": "Refere-se à alteração ou modificação dos detalhes ou status de uma reclamação.", - "es": "Se refiere a la alteración o modificación de los detalles o el estado de un reclamo." - } - } - ] - }, - "stage": { - "type": "string", - "example": "dispute", - "description": { - "en": "Indicates the current stage of the claim within the processing cycle involving the buyer and seller. It can take one of the following values:", - "pt": "Indica a fase atual da reclamação dentro do ciclo de processamento que envolve o comprador e o vendedor. Pode assumir um dos seguintes valores:", - "es": "Indica la fase actual del reclamo dentro del ciclo de procesamiento que involucra al comprador y al vendedor. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "claim", - "description": { - "en": "Initial stage of the claim process in which both the buyer and seller are involved.", - "pt": "Fase inicial do processo de reclamação na qual intervém o comprador e o vendedor.", - "es": "Fase inicial del proceso de reclamo en la que intervienen el comprador y el vendedor." - } - }, - { - "title": "dispute", - "description": { - "en": "Phase where the claim is under dispute or disagreement.", - "pt": "Fase em que a reclamação está em disputa ou desacordo.", - "es": "Fase donde el reclamo está en disputa o desacuerdo." - } - }, - { - "title": "recontact", - "description": { - "en": "Stage in which one of the parties makes contact after the claim/dispute has been closed.", - "pt": "Fase na qual uma das partes entra em contato após o encerramento da reclamação/disputa.", - "es": "Fase en la que alguna de las partes se contacta luego de cerrado el reclamo/disputa." - } - }, - { - "title": "none", - "description": { - "en": "Indicates no specific stage is currently applicable.", - "pt": "Indica que nenhuma etapa específica é aplicável.", - "es": "Indica que no se aplica ninguna etapa específica." - } - } - ] - }, - "status": { - "type": "string", - "example": "closed", - "description": { - "en": "Specifies the current state of the claim, indicating whether it is open or closed. It can take one of the following values:", - "pt": "Especifica o estado atual da reclamação, indicando se está aberta ou fechada. Pode assumir um dos seguintes valores:", - "es": "Especifica el estado actual del reclamo, indicando si está abierto o cerrado. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "opened", - "description": { - "en": "Indicates that the claim is open.", - "pt": "Indica que a reclamação está aberta.", - "es": "Indica que el reclamo está abierto." - } - }, - { - "title": "closed", - "description": { - "en": "Indicates that the claim is closed.", - "pt": "Indica que a reclamação está fechada.", - "es": "Indica que el reclamo está cerrado." - } - } - ] - }, - "parent_id": { - "type": "string", - "example": null, - "description": { - "en": "ID of another claim on which it depends.", - "pt": "ID de outra reclamação da qual esta depende.", - "es": "ID de otro reclamo del que depende." - } - }, - "client_id": { - "type": "number", - "example": 1569196570216262, - "description": { - "en": "ID of the app that created the claim.", - "pt": "ID do aplicativo que criou a reclamação.", - "es": "ID de la app que creo el reclamo" - } - }, - "resource_id": { - "type": "number", - "example": 7138572864, - "description": { - "en": "ID of the resource on which the claim is created and depends on the 'resource' parameter.", - "pt": "ID do recurso sobre o qual a reclamação é criada e depende do parâmetro 'resource'.", - "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro 'resource'." - } - }, - "resource": { - "type": "string", - "example": "shipment", - "description": { - "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase.", - "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra.", - "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra." - }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Related to claims involving payment transactions.", - "pt": "Relacionado a reclamações envolvendo transações de pagamento.", - "es": "Relacionado con reclamos que involucran transacciones de pago." - } - }, - { - "title": "order", - "description": { - "en": "Pertains to claims arising from order processing issues.", - "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", - "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." - } - }, - { - "title": "shipment", - "description": { - "en": "Concerns claims related to shipping or delivery matters.", - "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", - "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." - } - }, - { - "title": "purchase", - "description": { - "en": "Involves claims associated with the purchase process.", - "pt": "Envolve reclamações associadas ao processo de compra.", - "es": "Involucra reclamos asociados con el proceso de compra." - } - } - ] - }, - "reason_id": { - "type": "string", - "example": "PNR4071", - "description": { - "en": "Reason ID of the claim. A claim can be created for three general reasons:", - "pt": "ID da 'reason' da reclamação. Uma reclamação pode ser criada por três motivos gerais:", - "es": "ID de la 'reason' del reclamo. Se puede crear un reclamo por tres motivos generales:" - }, - "enum": [ - { - "title": "PNR", - "description": { - "en": "Product not received.", - "pt": "Produto não recebido.", - "es": "Producto no recibido." - } - }, - { - "title": "PDD", - "description": { - "en": "Different or defective product.", - "pt": "Produto diferente ou defeituoso", - "es": "Producto diferente o defectuoso." - } - }, - { - "title": "CS", - "description": { - "en": "Purchase cancellation.", - "pt": "Cancelamento de compra.", - "es": "Cancelación de la compra." - } - } - ] - }, - "quantity_type": { - "type": "string", - "example": "total", - "description": { - "en": "Indica si una devolución corresponde a todos los productos de la orden o solo algunos. Inicialmente sólo mostrará el valor 'total' y en el futuro se visualizará el valor 'partial'.", - "pt": "Indica se um reembolso corresponde a todos os produtos do pedido ou apenas alguns. Inicialmente, mostrará apenas o valor 'total' e, no futuro, será exibido o valor 'partial'.", - "es": "Indicates whether a return corresponds to all products in the order or only some. Initially, it will only show the value 'total', and in the future, the value 'partial' will be displayed." - } - }, - "players": { - "type": "array", - "description": { - "en": "People who are participating in the complaint.", - "pt": "Pessoas que estão participando da reclamação.", - "es": "Personas que están participando en el reclamo." - }, - "items": { - "type": "object", - "properties": { - "role": { - "type": "string", - "example": "mediator", - "description": { - "en": "Indicates the person's role within the claim. It can take one of the following values:", - "pt": "Indica o papel da pessoa dentro da reclamação. Pode assumir um dos seguintes valores:", - "es": "Indica el rol de la persona dentro del reclamo. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "complainant", - "description": { - "en": "Person who claims", - "pt": "Pessoa que reclama.", - "es": "Persona que reclama." - } - }, - { - "title": "respondent", - "description": { - "en": "Person to whom they are complaining.", - "pt": "Pessoa a quem estão reclamando.", - "es": "Persona a quién le reclaman." - } - }, - { - "title": "mediator", - "description": { - "en": "Person who intervenes to help solve the problem.", - "pt": "Pessoa que intervém para ajudar a resolver o problema.", - "es": "Persona que interviene para ayudar a solucionar el problema." - } - } - ] - }, - "type": { - "type": "string", - "example": "payer", - "description": { - "en": "Role that the person occupies in the operation that is being claimed and may vary according to the 'resource'. It can take one of the following values:", - "pt": "Papel que a pessoa ocupa na operação que está sendo reivindicada e pode variar de acordo com o 'resource'. Pode assumir um dos seguintes valores:", - "es": "Rol que ocupa la persona sobre la operación que se está reclamando y puede variar de acuerdo con el 'resource'. Puede tomar alguno de los siguientes valores:" - }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Indicates that the person is the buyer or collector.", - "pt": "Indica que a pessoa é compradora ou cobradora.", - "es": "Indica que la persona es el comprador o collector." - } - }, - { - "title": "order", - "description": { - "en": "Indicates that the person is the buyer or seller.", - "pt": "Indica que a pessoa é compradora ou vendedora.", - "es": "Indica que la persona es el comprador o vendedor." - } - }, - { - "title": "shipment", - "description": { - "en": "Indicates that the person is the receiver or sender.", - "pt": "Indica que a pessoa é o destinatário ou remetente.", - "es": "Indica que la persona es el receptor o remitente." - } - } - ] - }, - "user_id": { - "type": "number", - "example": 242829175, - "description": { - "en": "ID of the 'type' indicated in the previous parameter.", - "pt": "ID do 'type' indicado no parâmetro anterior.", - "es": "ID del 'type' indicado en el parámetro anterior." - } - }, - "available_actions": { - "type": "array", - "description": { - "en": "Provides information about the actions that each of the involved parties can execute.", - "pt": "Exibe informações sobre as ações que cada uma das partes envolvidas pode executar.", - "es": "Presenta información sobre las acciones que pueden ejecutar cada una de las partes intervinientes." - }, - "items": { - "type": "object", - "properties": { - "action": { - "type": "string", - "example": "recontact", - "description": { - "es": "List of actions that each of the involved parties can execute.", - "pt": "Lista de ações que cada uma das partes envolvidas pode executar.", - "en": "Lista de acciones que pueden ejecutar cada una de las partes intervinientes." - }, - "enum": [ - { - "title": "send_message_to_complainant", - "description": { - "en": "Send a message to the buyer (with or without attachments).", - "pt": "Enviar mensagem para o comprador (com ou sem anexos).", - "es": "Enviar mensaje para el comprador (con o sin anexos)." - } - }, - { - "title": "send_message_to_mediator", - "description": { - "en": "Send a message to the mediator (with or without attachments).", - "pt": "Enviar mensagem para o mediador (com ou sem anexos).", - "es": "Enviar mensaje para el mediador (con o sin anexos)." - } - }, - { - "title": "recontact (no disponible aún)", - "description": { - "en": "Reopen a closed complaint through an interaction, such as a message.", - "pt": "Reabrir uma reclamação já fechada, por meio de uma interação, como uma mensagem.", - "es": "Reabrir un reclamo ya cerrado, por medio de una interacción, como un mensaje." - } - }, - { - "title": "refund", - "description": { - "en": "Refund the buyer's money. Must be performed by the Mercado Pago front end.", - "pt": "Devolver o dinheiro do comprador. Deve ser realizado pelo front do Mercado Pago.", - "es": "Devolver el dinero del comprado. Debe ser realizado por el front de Mercado Pago." - } - }, - { - "title": "open_dispute", - "description": { - "en": "Initiate mediation.", - "pt": "Iniciar uma mediação.", - "es": "Iniciar una mediación." - } - }, - { - "title": "send_potential_shipping", - "description": { - "en": "Send a promise of shipment, indicating a date.", - "pt": "Enviar uma promessa de postagem, indicando uma data.", - "es": "Enviar una promesa de post, indicando una fecha." - } - }, - { - "title": "add_shipping_evidence", - "description": { - "en": "Publish evidence that the product has been shipped.", - "pt": "Publicar uma evidência de que o produto foi enviado.", - "es": "Publicar una evidencia de que el producto fue enviado." - } - }, - { - "title": "send_attachments", - "description": { - "en": "Send message with attached images.", - "pt": "Enviar mensagem com imagens anexadas.", - "es": "Enviar mensaje con imágenes adjuntas." - } - }, - { - "title": "allow_return_label", - "description": { - "en": "Generate a return label.", - "pt": "Gerar etiqueta de devolução.", - "es": "Generar etiqueta de devolución." - } - }, - { - "title": "send_tracking_number", - "description": { - "en": "Send the shipping tracking number.", - "pt": "Enviar o número de rastreamento de envio (tracking number).", - "es": "Enviar el número de rastreo de envío (tracking number)." - } - } - ] - }, - "due_date": { - "type": "string", - "example": "2020-11-16T22:36:59.000-04:00", - "description": { - "en": "Deadline to perform the action.", - "pt": "Prazo limite para realizar a ação.", - "es": "Tiempo límite para realizar la acción." - } - }, - "mandatory": { - "type": "boolean", - "example": true, - "description": { - "en": "This field being 'true' indicates that the action is mandatory and must be performed within the specified time.", - "pt": "Este campo como 'true' indica que a ação é obrigatória e deve ser realizada dentro do tempo informado.", - "es": "Este campo en 'true' indica que la acción es obligatoria y debe ser realizada dentro del tiempo informado." - } - } - } - } - } - } - } - }, - "resolution": { - "type": "object", - "description": { - "en": "Provides information about claim resolution.", - "pt": "Exibe informações sobre a resolução da reclamação.", - "es": "Presenta información sobre la resolución del reclamo." - }, - "properties": { - "reason": { - "type": "string", - "example": "already_shipped", - "description": { - "en": "Reason for resolution/closure.", - "pt": "Motivo de resolução/encerramento.", - "es": "Motivo de resolucion/cierre." - } - }, - "date_created": { - "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", - "description": { - "en": "Date of resolution/closure of the claim.", - "pt": "Data de resolução/encerramento da reclamação.", - "es": "Fecha de la resolucion/cierre del reclamo." - } - }, - "decision": { - "type": "array", - "items": { - "type": "string", - "example": "complainant", - "description": { - "en": "Person who defined the resolution of the claim.", - "pt": "Pessoa que definiu a resolução da reclamação.", - "es": "Persona que definió la resolución del reclamo." - } - } - }, - "closed_by": { - "type": "string", - "example": "mediator", - "description": { - "en": "Person who closed the claim.", - "pt": "Pessoa que encerrou a reclamação.", - "es": "Persona que cerró el reclamo." - } - } - } - }, - "coverages": { - "type": "array", - "description": { - "en": "Represents the coverages applied to users in the claim.", - "pt": "Representa as coberturas aplicadas aos usuários na reclamação.", - "es": "Representa las coberturas aplicadas a usuarios en el reclamo." - }, - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "bpp", - "description": { - "en": "Type of coverage applied to users (e.g., 'bpp' - Buyer Protection Program).", - "pt": "Tipo de cobertura aplicada aos usuários (ex: 'bpp' - Buyer Protection Program).", - "es": "Tipo de cobertura aplicada a usuarios (ej: 'bpp' - Buyer Protection Program)." - } - }, - "benefited": { - "type": "string", - "example": "complainant", - "description": { - "en": "It will indicate who will benefit from resolving the claim.", - "pt": "Indicará quem for beneficiado pela resolução da reclamação.", - "es": "Indicará quién se beneficiará de resolver el reclamo." - } - }, - "amount": { - "type": "number", - "example": 194.99, - "description": { - "en": "Total amount of the applied coverage.", - "pt": "Valor total da cobertura aplicada.", - "es": "Monto total de la cobertura aplicada" - } - }, - "resource": { - "type": "string", - "example": "shipment", - "description": { - "en": "Identificador del recurso sobre el que se crea el reclamo, such as a payment, order, shipment or purchase.", - "pt": "Identificador do recurso sobre o qual se cria a reclação, como um pagamento, pedido, envio ou compra.", - "es": "Identificador del recurso sobre el que se crea el reclamo, como un pago, pedido, envío o compra." - }, - "enum": [ - { - "title": "payment", - "description": { - "en": "Related to claims involving payment transactions.", - "pt": "Relacionado a reclamações envolvendo transações de pagamento.", - "es": "Relacionado con reclamos que involucran transacciones de pago." - } - }, - { - "title": "order", - "description": { - "en": "Pertains to claims arising from order processing issues.", - "pt": "Refere-se a reclamações decorrentes de problemas no processamento de pedidos.", - "es": "Se refiere a reclamos surgidos de problemas en el procesamiento de pedidos." - } - }, - { - "title": "shipment", - "description": { - "en": "Concerns claims related to shipping or delivery matters.", - "pt": "Refere-se a reclamações relacionadas a questões de envio ou entrega.", - "es": "Concierna a reclamos relacionados con asuntos de envío o entrega." - } - }, - { - "title": "purchase", - "description": { - "en": "Involves claims associated with the purchase process.", - "pt": "Envolve reclamações associadas ao processo de compra.", - "es": "Involucra reclamos asociados con el proceso de compra." - } - } - ] - }, - "resource_id": { - "type": "number", - "example": 7138572864, - "description": { - "en": "ID of the resource on which the claim is created and depends on the 'resource' parameter.", - "pt": "ID do recurso sobre o qual a reclamação é criada e depende do parâmetro 'resource'.", - "es": "ID del recurso sobre el que se crea el reclamo y depende del parámetro 'resource'." - } - }, - "date_created": { - "type": "string", - "example": "2018-03-08T10:35:30.000-0400", - "description": { - "en": "Date the claim was created.", - "pt": "Data em que a reclamação foi criada.", - "es": "Fecha en la que se creó el reclamo." - } - }, - "costs": { - "type": "array", - "description": { - "en": "Represents the breakdown of costs related to the coverage.", - "pt": "Representa a divisão dos custos relacionados à cobertura.", - "es": "Representa la división de los costos relacionados a la cobertura." - }, - "items": { - "type": "object", - "properties": { - "role": { - "type": "string", - "example": "respondent", - "description": { - "en": "The player in the claim responsible for the cost.", - "pt": "O 'player' da reclamação responsável pelo custo.", - "es": "El 'player' del reclamo a cargo del costo." - } - }, - "amount": { - "type": "number", - "example": 194.99, - "description": { - "en": "Amount of the cost borne by the player in the 'role' parameter.", - "pt": "Valor do custo sob responsabilidade do participante no parâmetro 'role'.", - "es": "Monto del costo a cargo del player del parámetro 'role'." - } - }, - "date_created": { - "type": "string", - "example": "2018-03-08T10:35:30.000-0400", - "description": { - "en": "Date of cost creation.", - "pt": "Data de criação do custo.", - "es": "Fecha de creación del costo." - } - } - } - } - } - } - } - }, - "labels": { - "type": "array", - "description": { - "en": "Presents information about the labels associated with the claim, indicating, for example, whether the complaint affects the seller's reputation or not.", - "pt": "Apresenta informações sobre as estiquetas associadas à reclamação, indicando, por exemplo, se a reclamação afeta ou não a reputação do vendedor.", - "es": "Presenta información sobre las etiquetas asociadas al reclamo, indicando, por ejemplo, si la reclamación afecta o no la reputación del vendedor." - }, - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "reputation", - "description": { - "en": "Name of the label associated with the claim.", - "pt": "Nome da etiqueta associada à reclamação.", - "es": "Nombre de la etiqueta asociada al reclamo." - } - }, - "value": { - "type": "string", - "example": "avoid", - "description": { - "en": "Value of the label.", - "pt": "Valor da etiqueta.", - "es": "Valor de la etiqueta." - } - }, - "admin_id": { - "type": "string", - "example": null, - "description": { - "en": "ID of the user managing the claim and who associated the label.", - "pt": "ID da pessoa usuária que está administrando a reclamação e associou a etiqueta.", - "es": "ID de la persona usuaria que está gestionando el reclamo y ha asociado la etiqueta." - } - }, - "date_created": { - "type": "string", - "example": "2018-03-08T09:56:00.078-0400", - "description": { - "en": "Date on which the label was associated with the claim.", - "pt": "Data em que a etiqueta foi associada à reclamação.", - "es": "Fecha en que la etiqueta fue asociada al reclamo." - } - } - } - } - }, - "site_id": { - "type": "string", - "example": "MLA", - "description": { - "en": "ID of the site where the claim occurs.", - "pt": "ID do site em que ocorre a reclamação.", - "es": "ID del sitio donde se desarrolla el reclamo." - }, - "enum": [ - { - "title": "MCO", - "description": { - "en": "Mercado Libre Colombia", - "pt": "Mercado Livre Colômbia", - "es": "Mercado Libre Colombia" - } - }, - { - "title": "MLA", - "description": { - "en": "Mercado Livre Argentina", - "pt": "Mercado Libre Argentina", - "es": "Mercado Libre Argentina" - } - }, - { - "title": "MLB", - "description": { - "en": "Mercado Libre Brasil", - "pt": "Mercado Livre Brasil", - "es": "Mercado Libre Brasil" - } - }, - { - "title": "MLC", - "description": { - "en": "Mercado Libre Chile", - "pt": "Mercado Livre Chile", - "es": "Mercado Libre Chile" - } - }, - { - "title": "MLM", - "description": { - "en": "Mercado Libre México", - "pt": "Mercado Livre México", - "es": "Mercado Libre México" - } - }, - { - "title": "MLU", - "description": { - "en": "Mercado Libre Uruguay", - "pt": "Mercado Livre Uruguai", - "es": "Mercado Libre Uruguay" - } - }, - { - "title": "MPE", - "description": { - "en": "Mercado Libre Perú", - "pt": "Mercado Livre Perú", - "es": "Mercado Libre Perú" - } - } - ] - }, - "date_created": { - "type": "string", - "example": "2020-09-30T09:48:06.000-04:00", - "description": { - "en": "Date the claim was created.", - "pt": "Data em que a reclamação foi criada.", - "es": "Fecha en la que se creó el reclamo." - } - }, - "last_updated": { - "type": "string", - "example": "2020-10-02T01:12:31.000-04:00", - "description": { - "en": "Date of the last update to the claim.", - "pt": "Data da última atualização da reclamação.", - "es": "Fecha de última actualización reclamo." - } - } - } - } - } - } - } - }, - "title": { - "en": "Get claim notifications", - "pt": "Obter notificações da reclamação", - "es": "Obtener notificaciones del reclamo" - } - } - } - } -} \ No newline at end of file From 678a28f1657acb36d1089786118a0665d83f2986 Mon Sep 17 00:00:00 2001 From: hgaldino Date: Tue, 30 Jul 2024 14:04:50 -0300 Subject: [PATCH 11/20] shopify --- reference/api-json/pos copy.json | 1780 ++++++++++++++++++++++++++++++ 1 file changed, 1780 insertions(+) create mode 100644 reference/api-json/pos copy.json diff --git a/reference/api-json/pos copy.json b/reference/api-json/pos copy.json new file mode 100644 index 0000000000..64ade8c662 --- /dev/null +++ b/reference/api-json/pos copy.json @@ -0,0 +1,1780 @@ +{ + "url": "https://api.mercadopago.com", + "paths": { + "/pos": { + "post": { + "tags": [ + "qr-code", + "mp-point" + ], + "description": { + "en": "Generate a Point of Sale in a store. Each POS will have a unique QR Code linked to it", + "pt": "Gerar um ponto de venda em uma loja. Cada caixa registradora terá um código QR exclusivo vinculado a ela", + "es": "Genera un punto de venta en una sucursal. Cada caja tendrá vinculado un código QR unívoco" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": { + "en": "Name of the POS.", + "pt": "Nome do ponto de venda.", + "es": "Nombre del punto de venta." + }, + "example": "First POS" + }, + "fixed_amount": { + "type": "boolean", + "description": { + "en": "Define if the customer can insert the amount to be paid.", + "pt": "Determine se o cliente pode inserir o valor a ser pago.", + "es": "Determina si el cliente puede insertar el monto a pagar." + }, + "example": false + }, + "store_id": { + "type": "string", + "description": { + "en": "Store identifier to which the point of sale belongs.", + "pt": "Identificador da loja à qual o ponto de venda pertence.", + "es": "Identificador de la sucursal a la que pertenece el punto de venta." + }, + "example": 1234567 + }, + "external_store_id": { + "type": "string", + "description": { + "en": "External_id of the store to which the pos belongs defined by integrator system.", + "pt": "External_id of the store to which the pos belongs defined by integrator system.", + "es": "External_id of the store to which the pos belongs defined by integrator system." + }, + "example": "SUC001" + }, + "external_id": { + "type": "string", + "description": { + "en": "Unique identifier of the pos defined by integrator system.", + "pt": "Identificador único da caixa definido pelo sistema integrador.", + "es": "Identificador único de la caja definido por el integrador." + }, + "example": "SUC001POS001" + }, + "category": { + "$ref": "#/components/schemas/category" + }, + "url": { + "type": "string", + "description": { + "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", + "pt": "URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.", + "es": "URL para obtener la orden del sistema integrador. Es opcional y se utiliza solo en el modelo de integración desatendido." + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": { + "es": "Success", + "pt": "Success", + "en": "Success" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number", + "example": 2711382, + "description": { + "es": "id", + "pt": "id", + "en": "id" + } + }, + "qr": { + "type": "object", + "properties": { + "image": { + "type": "string", + "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", + "description": { + "es": "image", + "pt": "image", + "en": "image" + } + }, + "template_document": { + "type": "string", + "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.pdf", + "description": { + "es": "template_document", + "pt": "template_document", + "en": "template_document" + } + }, + "template_image": { + "type": "string", + "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", + "description": { + "es": "template_image", + "pt": "template_image", + "en": "template_image" + } + } + }, + "description": { + "es": "qr", + "pt": "qr", + "en": "qr" + } + }, + "status": { + "type": "string", + "example": "active", + "description": { + "es": "status", + "pt": "status", + "en": "status" + } + }, + "date_created": { + "type": "string", + "example": "2019-08-22T14:11:12.000Z", + "description": { + "es": "date_created", + "pt": "date_created", + "en": "date_created" + } + }, + "date_last_updated": { + "type": "string", + "example": "2019-08-22T14:11:12.000Z", + "description": { + "es": "date_last_updated", + "pt": "date_last_updated", + "en": "date_last_updated" + } + }, + "uuid": { + "type": "string", + "example": "0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1", + "description": { + "es": "uuid", + "pt": "uuid", + "en": "uuid" + } + }, + "user_id": { + "type": "number", + "example": 446566691, + "description": { + "es": "user_id", + "pt": "user_id", + "en": "user_id" + } + }, + "name": { + "type": "string", + "example": "First POS", + "description": { + "es": "name", + "pt": "name", + "en": "name" + } + }, + "fixed_amount": { + "type": "boolean", + "example": false, + "description": { + "es": "fixed_amount", + "pt": "fixed_amount", + "en": "fixed_amount" + } + }, + "category": { + "$ref": "#/components/schemas/category" + }, + "store_id": { + "type": "string", + "example": 1234567, + "description": { + "es": "store_id", + "pt": "store_id", + "en": "store_id" + } + }, + "external_store_id": { + "type": "string", + "example": "SUC001", + "description": { + "es": "external_store_id", + "pt": "external_store_id", + "en": "external_store_id" + } + }, + "url": { + "type": "string", + "description": { + "es": "url", + "pt": "url", + "en": "url" + } + }, + "external_id": { + "type": "string", + "example": "SUC001POS001", + "description": { + "es": "external_id", + "pt": "external_id", + "en": "external_id" + } + } + } + } + } + } + }, + "400": { + "description": { + "en": "Error", + "pt": "Erro", + "es": "Error" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errorKey": { + "type": "string", + "enum": [ + { + "title": "MISSING_BODY", + "description": { + "en": "HTTP body is required to create pos.", + "es": "HTTP body is required to create pos.", + "pt": "HTTP body is required to create pos." + } + }, + { + "title": "UNKNOWN_FIELD_EXCEPTION", + "description": { + "en": "The indicated field is not allowed for this operation or is unknown.", + "es": "The indicated field is not allowed for this operation or is unknown.", + "pt": "The indicated field is not allowed for this operation or is unknown." + } + }, + { + "title": "INVALID_NAME", + "description": { + "en": "NAME must be string.", + "es": "NAME must be string.", + "pt": "NAME must be string." + } + }, + { + "title": "NAME_TOO_LONG", + "description": { + "en": "The NAME must be less than 45 characters.", + "es": "The NAME must be less than 45 characters.", + "pt": "The NAME must be less than 45 characters." + } + }, + { + "title": "INVALID_FIXED_AMOUNT", + "description": { + "en": "FIXED_AMOUNT must be boolean.", + "es": "FIXED_AMOUNT must be boolean.", + "pt": "FIXED_AMOUNT must be boolean." + } + }, + { + "title": "INVALID_CATEGORY", + "description": { + "en": "CATEGORY must be numeric.", + "es": "CATEGORY must be numeric.", + "pt": "CATEGORY must be numeric." + } + }, + { + "title": "UNKNOWN_MCC", + "description": { + "en": "The CATEGORY must be valid for the user's site.", + "es": "The CATEGORY must be valid for the user's site.", + "pt": "The CATEGORY must be valid for the user's site." + } + }, + { + "title": "INVALID_STORE_ID", + "description": { + "en": "STORE_ID must be numeric.", + "es": "STORE_ID must be numeric.", + "pt": "STORE_ID must be numeric." + } + }, + { + "title": "INVALID_EXTERNAL_STORE_ID", + "description": { + "en": "EXTERNAL_STORE_ID muste be string.", + "es": "EXTERNAL_STORE_ID muste be string.", + "pt": "EXTERNAL_STORE_ID muste be string." + } + }, + { + "title": "EXTERNAL_STORE_ID_NOT_MATCH", + "description": { + "en": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID.", + "es": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID.", + "pt": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID." + } + }, + { + "title": "INEXISTENT_EXTERNAL_STORE_ID", + "description": { + "en": "The EXTERNAL_STORE_ID does not refer to any existing store.", + "es": "The EXTERNAL_STORE_ID does not refer to any existing store.", + "pt": "The EXTERNAL_STORE_ID does not refer to any existing store." + } + }, + { + "title": "INVALID_EXTERNAL_ID", + "description": { + "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", + "es": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", + "pt": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters." + } + }, + { + "title": "EXTERNAL_ID_TOO_LONG", + "description": { + "en": "The EXTERNAL_ID must be less than 40 characters.", + "es": "The EXTERNAL_ID must be less than 40 characters.", + "pt": "The EXTERNAL_ID must be less than 40 characters." + } + }, + { + "title": "INVALID_URL", + "description": { + "en": "The URL must be string and muste have the format of a valid url", + "es": "The URL must be string and muste have the format of a valid url", + "pt": "The URL must be string and muste have the format of a valid url" + } + }, + { + "title": "URL_TOO_LONG", + "description": { + "en": "The URL must be less than 300 characters.", + "es": "The URL must be less than 300 characters.", + "pt": "The URL must be less than 300 characters." + } + }, + { + "title": "FIXED_AMOUNT_FALSE", + "description": { + "en": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case.", + "es": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case.", + "pt": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case." + } + } + ] + } + } + } + } + } + }, + "403": { + "description": { + "en": "Error", + "pt": "Erro", + "es": "Error" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errorKey": { + "type": "string", + "enum": [ + { + "title": "1", + "description": { + "en": "If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor.", + "es": "If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor.", + "pt": "If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor." + } + } + ] + } + } + } + } + } + }, + "404": { + "description": { + "en": "Error", + "pt": "Erro", + "es": "Error" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errorKey": { + "type": "string", + "enum": [ + { + "title": "1", + "description": { + "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", + "es": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", + "pt": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user." + } + } + ] + } + } + } + } + } + }, + "409": { + "description": { + "en": "Error", + "pt": "Erro", + "es": "Error" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errorKey": { + "type": "string", + "enum": [ + { + "title": "1", + "description": { + "en": "A pos with the same EXTERNAL_ID already exists.", + "es": "A pos with the same EXTERNAL_ID already exists.", + "pt": "A pos with the same EXTERNAL_ID already exists." + } + } + ] + } + } + } + } + } + } + }, + "title": { + "en": "Create POS", + "pt": "Criar caixa", + "es": "Crear caja" + } + }, + "get": { + "tags": [ + "qr-code", + "mp-point" + ], + "description": { + "en": "Get the information about all of your stores", + "pt": "Encontre todas as informações dos pontos de venda através de filtros específicos", + "es": "Encuentra toda la información de los puntos de venta a través de filtros específicos" + }, + "parameters": [ + { + "name": "external_id", + "in": "query", + "description": { + "es": "External ID", + "pt": "External ID", + "en": "External ID" + }, + "required": false, + "schema": { + "type": "string", + "example": "SUC001POS001" + } + }, + { + "name": "external_store_id", + "in": "query", + "description": { + "es": "External Store ID", + "pt": "External Store ID", + "en": "External Store ID" + }, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "store_id", + "in": "query", + "description": { + "es": "Store ID", + "pt": "Store ID", + "en": "Store ID" + }, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "category", + "in": "query", + "description": { + "es": "Category", + "pt": "Category", + "en": "Category" + }, + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": { + "es": "Success", + "pt": "Success", + "en": "Success" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "paging": { + "type": "object", + "properties": { + "total": { + "type": "number", + "example": 1, + "description": { + "es": "total", + "pt": "total", + "en": "total" + } + }, + "offset": { + "type": "number", + "example": 0, + "description": { + "es": "offset", + "pt": "offset", + "en": "offset" + } + }, + "limit": { + "type": "number", + "example": 0, + "description": { + "es": "limit", + "pt": "limit", + "en": "limit" + } + } + }, + "description": { + "es": "paging", + "pt": "paging", + "en": "paging" + } + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "user_id": { + "type": "number", + "example": 446566691, + "description": { + "es": "user_id", + "pt": "user_id", + "en": "user_id" + } + }, + "name": { + "type": "string", + "example": "Caja Principal", + "description": { + "es": "name", + "pt": "name", + "en": "name" + } + }, + "fixed_amount": { + "type": "boolean", + "description": { + "es": "fixed_amount", + "pt": "fixed_amount", + "en": "fixed_amount" + } + }, + "category": { + "$ref": "#/components/schemas/category" + }, + "store_id": { + "type": "string", + "example": 1234567, + "description": { + "es": "store_id", + "pt": "store_id", + "en": "store_id" + } + }, + "external_id": { + "type": "string", + "example": "SUC001POS001", + "description": { + "es": "external_id", + "pt": "external_id", + "en": "external_id" + } + }, + "id": { + "type": "number", + "example": 1988157, + "description": { + "es": "id", + "pt": "id", + "en": "id" + } + }, + "qr": { + "type": "object", + "properties": { + "image": { + "type": "string", + "example": "https://www.mercadopago.com/instore/merchant/qr/1988157/1f1da6401a4645e99fa21d3f4ffe0e702c4eab2209784fce9d45c83fa93bd5a7.png", + "description": { + "es": "image", + "pt": "image", + "en": "image" + } + }, + "template_document": { + "type": "string", + "example": "https://www.mercadopago.com/instore/merchant/qr/1988157/template_1f1da6401a4645e99fa21d3f4ffe0e702c4eab2209784fce9d45c83fa93bd5a7.pdf", + "description": { + "es": "template_document", + "pt": "template_document", + "en": "template_document" + } + }, + "template_image": { + "type": "string", + "example": "https://www.mercadopago.com/instore/merchant/qr/1988157/template_1f1da6401a4645e99fa21d3f4ffe0e702c4eab2209784fce9d45c83fa93bd5a7.png", + "description": { + "es": "template_image", + "pt": "template_image", + "en": "template_image" + } + } + }, + "description": { + "es": "qr", + "pt": "qr", + "en": "qr" + } + }, + "date_created": { + "type": "string", + "example": "2019-06-24T13:31:56.000Z", + "description": { + "es": "date_created", + "pt": "date_created", + "en": "date_created" + } + }, + "date_last_updated": { + "type": "string", + "example": "2019-08-07T21:07:26.000Z", + "description": { + "es": "date_last_updated", + "pt": "date_last_updated", + "en": "date_last_updated" + } + }, + "external_store_id": { + "type": "string", + "example": "SUC001", + "description": { + "es": "external_store_id", + "pt": "external_store_id", + "en": "external_store_id" + } + } + } + }, + "description": { + "es": "results", + "pt": "results", + "en": "results" + } + } + } + } + } + } + }, + "400": { + "description": { + "en": "Error", + "pt": "Erro", + "es": "Error" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errorKey": { + "type": "string", + "enum": [ + { + "title": "INVALID_CATEGORY", + "description": { + "en": "The CATEGORY must be numeric.", + "es": "The CATEGORY must be numeric.", + "pt": "The CATEGORY must be numeric." + } + }, + { + "title": "INVALID_STORE_ID", + "description": { + "en": "The STORE_ID must be numeric.", + "es": "The STORE_ID must be numeric.", + "pt": "The STORE_ID must be numeric." + } + }, + { + "title": "INVALID_EXTERNAL_STORE_ID", + "description": { + "en": "The EXTERNAL_STORE_ID must be string.", + "es": "The EXTERNAL_STORE_ID must be string.", + "pt": "The EXTERNAL_STORE_ID must be string." + } + }, + { + "title": "INEXISTENT_EXTERNAL_STORE_ID", + "description": { + "en": "The EXTERNAL STORE_ID does not refer to an existing Store.", + "es": "The EXTERNAL STORE_ID does not refer to an existing Store.", + "pt": "The EXTERNAL STORE_ID does not refer to an existing Store." + } + }, + { + "title": "INVALID_EXTERNAL_ID", + "description": { + "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", + "es": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", + "pt": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters." + } + }, + { + "title": "EXTERNAL_ID_TOO_LONG", + "description": { + "en": "The EXTERNAL_ID must be less than 40 characters.", + "es": "The EXTERNAL_ID must be less than 40 characters.", + "pt": "The EXTERNAL_ID must be less than 40 characters." + } + }, + { + "title": "INVALID_LIMIT", + "description": { + "en": "The LIMIT must be numeric.", + "es": "The LIMIT must be numeric.", + "pt": "The LIMIT must be numeric." + } + }, + { + "title": "INVALID_OFFSET", + "description": { + "en": "The OFFSET must be numeric.", + "es": "The OFFSET must be numeric.", + "pt": "The OFFSET must be numeric." + } + } + ] + } + } + } + } + } + } + }, + "title": { + "en": "Search POS", + "pt": "Buscar em caixas", + "es": "Buscar en cajas" + } + } + }, + "/pos/{id}": { + "get": { + "tags": [ + "qr-code", + "mp-point" + ], + "description": { + "en": "Check all the information of a Point of Sale with the ID of the POS you want", + "pt": "Veja toda a informação de um ponto de venda a partir do ID da caixa que você deseja", + "es": "Consulta toda la información de un punto de venta con el ID de la caja que quieras" + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": { + "en": "POS Id", + "pt": "POS Id", + "es": "POS Id" + }, + "required": true, + "schema": { + "type": "string", + "example": 1988157 + } + } + ], + "responses": { + "200": { + "description": { + "es": "Success", + "pt": "Success", + "en": "Success" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": 1988157, + "description": { + "en": "POS identifier, numerical and self-generated.", + "pt": "Identificador exclusivo da caixa, numérico e gerado automaticamente", + "es": "Identificador único de la caja, numérico y autogenerado" + } + }, + "qr": { + "type": "object", + "properties": { + "image": { + "type": "string", + "example": "https://www.mercadopago.com/instore/merchant/qr/2852128/c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68.png" + }, + "template_document": { + "type": "string", + "example": "https://www.mercadopago.com/instore/merchant/qr/2852128/template_c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68.pdf" + }, + "template_image": { + "type": "string", + "example": "https://www.mercadopago.com/instore/merchant/qr/2852128/template_c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68.png" + } + } + }, + "status": { + "type": "string", + "example": "active" + }, + "date_created": { + "type": "string", + "example": "2019-09-03T13:13:54.000-04:00" + }, + "date_last_updated": { + "type": "string", + "example": "2020-09-30T08:38:58.000-04:00" + }, + "uuid": { + "type": "string", + "example": "c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68" + }, + "compatible_id": { + "type": "string", + "example": "4be87a269a7b863fd043658d2a0d7b3fa2f32334138ff651e2408d3f8191d6c9f67a4dc297e9efc70d1adfbb31f7c21c29c9059ac905a359e39114c9871afef9" + }, + "user_id": { + "type": "number", + "example": 329653108 + }, + "name": { + "type": "string", + "example": "POS001" + }, + "fixed_amount": { + "type": "boolean", + "example": false + }, + "store_id": { + "type": "string", + "example": 56807753 + }, + "external_store_id": { + "type": "string", + "example": "SUC01" + }, + "external_id": { + "type": "string", + "example": "SUC001POS002" + }, + "site": { + "type": "string", + "example": "MLB" + }, + "qr_code": { + "type": "string", + "example": "00020101021226940014BR.GOV.BCB.PIX2572pix-qr-h.mercadopago.com/instore/h/p/v2/c955a5618d874e998c8399e3515fed3a43520016com.mercadolibre0128https://mpago.la/pos/28521285204000053039865802BR5924VICTOR CORREA DE ALMEIDA6008CAMPINAS62070503***6304367C" + } + } + } + } + } + }, + "400": { + "description": { + "en": "Error", + "pt": "Erro", + "es": "Error" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errorKey": { + "type": "string", + "enum": [ + { + "title": "INVALID_POS_ID", + "description": { + "en": "The ID of the pos is invalid, it must be numeric.", + "es": "The ID of the pos is invalid, it must be numeric.", + "pt": "The ID of the pos is invalid, it must be numeric." + } + }, + { + "title": "INVALID_EXTERNAL_ID", + "description": { + "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", + "es": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", + "pt": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters." + } + }, + { + "title": "EXTERNAL_ID_TOO_LONG", + "description": { + "en": "The EXTERNAL_ID must be less than 40 characters.", + "es": "The EXTERNAL_ID must be less than 40 characters.", + "pt": "The EXTERNAL_ID must be less than 40 characters." + } + } + ] + } + } + } + } + } + }, + "404": { + "description": { + "en": "Error", + "pt": "Erro", + "es": "Error" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errorKey": { + "type": "string", + "enum": [ + { + "title": "1", + "description": { + "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", + "es": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", + "pt": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user." + } + } + ] + } + } + } + } + } + } + }, + "title": { + "en": "Get POS", + "pt": "Obter caixa", + "es": "Obtener caja" + } + }, + "put": { + "tags": [ + "qr-code", + "mp-point" + ], + "description": { + "en": "Renew the data of a Point of Sale. Indicate the ID of the POS and send the parameters with the information you want to update", + "pt": "Atualizar os dados de um ponto de venda. Indicar a identificação da caixa registradora e enviar os parâmetros com as informações que você deseja atualizar", + "es": "Renueva los datos de un punto de venta. Indica el ID de la caja y envía los parámetros con la información que quieras actualizar" + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": { + "en": "POS Id", + "pt": "POS Id", + "es": "POS Id" + }, + "required": true, + "schema": { + "type": "string", + "example": 1988157 + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": { + "en": "Name of the POS.", + "pt": "Nome da caixa", + "es": "Nombre de la caja" + }, + "example": "First POS" + }, + "fixed_amount": { + "type": "boolean", + "description": { + "en": "Define if the customer can insert the amount to be paid.", + "pt": "Determine se o cliente pode inserir o valor a ser pago.", + "es": "Determina si el cliente puede insertar el monto a pagar." + }, + "example": false + }, + "category": { + "$ref": "#/components/schemas/category" + }, + "store_id": { + "type": "string", + "description": { + "en": "Store identifier to which the point of sale belongs.", + "pt": "Identificador da loja à qual o caixa pertence", + "es": "Identificador de la sucursal a la que pertenece el Punto de Venta" + }, + "example": 1234567 + }, + "external_store_id": { + "type": "string", + "description": { + "es": "External_id of the store to which the pos belongs defined by integrator system.", + "pt": "External_id of the store to which the pos belongs defined by integrator system.", + "en": "External_id of the store to which the pos belongs defined by integrator system." + } + }, + "url": { + "type": "string", + "description": { + "es": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", + "pt": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", + "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model." + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": { + "es": "success", + "pt": "success", + "en": "success" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number", + "example": 2711382, + "description": { + "es": "id", + "pt": "id", + "en": "id" + } + }, + "qr": { + "type": "object", + "properties": { + "image": { + "type": "string", + "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", + "description": { + "es": "image", + "pt": "image", + "en": "image" + } + }, + "template_document": { + "type": "string", + "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.pdf", + "description": { + "es": "template_document", + "pt": "template_document", + "en": "template_document" + } + }, + "template_image": { + "type": "string", + "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", + "description": { + "es": "template_image", + "pt": "template_image", + "en": "template_image" + } + } + }, + "description": { + "es": "qr", + "pt": "qr", + "en": "qr" + } + }, + "status": { + "type": "string", + "example": "active", + "description": { + "es": "status", + "pt": "status", + "en": "status" + } + }, + "date_created": { + "type": "string", + "example": "2019-08-22T14:11:12.000Z", + "description": { + "es": "date_created", + "pt": "date_created", + "en": "date_created" + } + }, + "date_last_updated": { + "type": "string", + "example": "2019-08-22T14:11:12.000Z", + "description": { + "es": "date_last_updated", + "pt": "date_last_updated", + "en": "date_last_updated" + } + }, + "uuid": { + "type": "string", + "example": "0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1", + "description": { + "es": "uuid", + "pt": "uuid", + "en": "uuid" + } + }, + "user_id": { + "type": "number", + "example": 446566691, + "description": { + "es": "user_id", + "pt": "user_id", + "en": "user_id" + } + }, + "name": { + "type": "string", + "example": "First POS", + "description": { + "es": "name", + "pt": "name", + "en": "name" + } + }, + "fixed_amount": { + "type": "boolean", + "example": false, + "description": { + "es": "fixed_amount", + "pt": "fixed_amount", + "en": "fixed_amount" + } + }, + "category": { + "$ref": "#/components/schemas/category" + }, + "store_id": { + "type": "string", + "example": 1234567, + "description": { + "es": "store_id", + "pt": "store_id", + "en": "store_id" + } + }, + "external_store_id": { + "type": "string", + "example": "SUC001", + "description": { + "es": "external_store_id", + "pt": "external_store_id", + "en": "external_store_id" + } + }, + "url": { + "type": "string", + "description": { + "es": "url", + "pt": "url", + "en": "url" + } + }, + "external_id": { + "type": "string", + "example": "SUC001POS002", + "description": { + "es": "external_id", + "pt": "external_id", + "en": "external_id" + } + }, + "site": { + "type": "string", + "example": "MLB" + }, + "qr_code": { + "type": "string", + "example": "00020101021226940014BR.GOV.BCB.PIX2572pix-qr-h.mercadopago.com/instore/h/p/v2/db12b6e2ec4844839825c6dce7cd2f2243530016com.mercadolibre0129https://mpago.la/pos/212798995204000053039865802BR5924VICTOR CORREA DE ALMEIDA6008CAMPINAS62070503***63040B44" + } + } + } + } + } + }, + "400": { + "description": { + "en": "Error", + "pt": "Erro", + "es": "Error" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errorKey": { + "type": "string", + "enum": [ + { + "title": "MISSING_BODY", + "description": { + "en": "HTTP body is required to modify pos.", + "es": "El cuerpo del HTTP es requerido para modificar el punto de venta.", + "pt": "O corpo do HTTP é necessário para modificar o ponto de venda." + } + }, + { + "title": "UNKNOWN_FIELD_EXCEPTION", + "description": { + "en": "The indicated field is not allowed for this operation or is unknown.", + "es": "El campo indicado no está permitido para esta operación o es desconocido.", + "pt": "O campo indicado não é permitido para esta operação ou é desconhecido." + } + }, + { + "title": "INVALID_POS_ID", + "description": { + "en": "The ID of the pos is invalid, it must be numeric.", + "es": "El ID del punto de venta es inválida, debe ser numérica.", + "pt": "O ID do ponto de venda é inválida, deve ser numérica." + } + }, + { + "title": "INVALID_NAME", + "description": { + "en": "NAME must be string.", + "es": "NOMBRE debe ser string.", + "pt": "NAME deve ser string." + } + }, + { + "title": "NAME_TOO_LONG", + "description": { + "en": "The NAME must be less than 45 characters.", + "es": "NAME debe ser menor de 45 caracteres.", + "pt": "NAME deve ter menos de 45 caracteres." + } + }, + { + "title": "INVALID_FIXED_AMOUNT", + "description": { + "en": "FIXED_AMOUNT must be boolean.", + "es": "FIXED_AMOUNT debe ser boolean.", + "pt": "FIXED_AMOUNT deve ser boolean." + } + }, + { + "title": "INVALID_CATEGORY", + "description": { + "en": "CATEGORY must be numeric.", + "es": "CATEGORY debe ser numérico.", + "pt": "CATEGORY deve ser numérico." + } + }, + { + "title": "POS_UNKNOWN_MCC", + "description": { + "en": "CATEGORY must be valid for the user's site.", + "es": "CATEGORY debe ser válida para el sitio del usuario.", + "pt": "CATEGORY deve ser válida para o site do usuário." + } + }, + { + "title": "POS_INVALID_STORE_ID", + "description": { + "en": "STORE_ID must be numeric.", + "es": "STORE_ID debe ser numérico.", + "pt": "STORE_ID deve ser numérico." + } + }, + { + "title": "INVALID_EXTERNAL_STORE_ID", + "description": { + "en": "EXTERNAL_STORE_ID must be string.", + "es": "EXTERNAL_STORE_ID debe ser string.", + "pt": "EXTERNAL_STORE_ID deve ser string." + } + }, + { + "title": "EXTERNAL_STORE_ID_NOT_MATCH", + "description": { + "en": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID.", + "es": "El EXTERNAL_STORE_ID no hace referencia al STORE_ID indicado.", + "pt": "O EXTERNAL_STORE_ID não se refere ao STORE_ID indicado." + } + }, + { + "title": "INEXISTENT_EXTERNAL_STORE_ID", + "description": { + "en": "The EXTERNAL STORE_ID does not refer to an existing Store.", + "es": "El EXTERNAL_STORE_ID no hace referencia a una tienda existente.", + "pt": "O EXTERNAL_STORE_ID não se refere a uma loja existente." + } + }, + { + "title": "INVALID_EXTERNAL_ID", + "description": { + "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces, hyphens or special characters.", + "es": "El campo EXTERNAL_ID debe ser alfanumérico, solo letras y números. Sin espacios, guiones o caracteres especiales.", + "pt": "O campo EXTERNAL_ID deve ser alfanumérico, apenas letras e números. Sem espaços, hífens ou caracteres especiais." + } + }, + { + "title": "EXTERNAL_ID_TOO_LONG", + "description": { + "en": "The EXTERNAL_ID must be less than 40 characters.", + "es": "El EXTERNAL_ID debe ser menor de 40 caracteres.", + "pt": "O EXTERNAL_ID deve ter menos de 40 caracteres." + } + }, + { + "title": "INVALID_URL", + "description": { + "en": "The URL must be string and muste have the format of a valid url", + "es": "La URL debe ser una cadena y debe tener el formato de una URL válida.", + "pt": "A URL deve ser uma string e deve ter o formato de uma URL válida." + } + }, + { + "title": "URL_TOO_LONG", + "description": { + "en": "The URL must be less than 300 characters.", + "es": "La URL debe ser menor de 300 caracteres.", + "pt": "A URL deve ter menos de 300 caracteres." + } + }, + { + "title": "FIXED_AMOUNT_FALSE", + "description": { + "en": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case.", + "es": "Si se indica el campo URL, el campo FIXED_AMOUNT debe ser verdadero. No soportamos la modalidad de monto abierto en este caso.", + "pt": "Se o campo URL estiver indicado, o campo FIXED_AMOUNT deve ser verdadeiro. Não suportamos a modalidade de valor aberto nesse caso." + } + } + ] + } + } + } + } + } + }, + "403": { + "description": { + "en": "Error", + "pt": "Erro", + "es": "Error" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errorKey": { + "type": "string", + "enum": [ + { + "title": "1", + "description": { + "en": "If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor.", + "es": "Si está utilizando el campo URL, el host debe estar habilitado por Mercado Pago. Si no lo está, recibirá este error. Por favor, comuníquese con su asesor técnico asignado.", + "pt": "Se você estiver usando o campo URL, o host deve ser habilitado pelo Mercado Pago. Se não for, você receberá este erro. Por favor, entre em contato com seu assessor técnico designado." + } + } + ] + } + } + } + } + } + }, + "404": { + "description": { + "en": "Error", + "pt": "Erro", + "es": "Error" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errorKey": { + "type": "string", + "enum": [ + { + "title": "1", + "description": { + "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and to the user.", + "es": "Si el punto de venta no existe para un ID o EXTERNAL_ID indicado y para el usuario.", + "pt": "Se o ponto de venda não existir para um ID ou EXTERNAL_ID indicado e para o usuário." + } + } + ] + } + } + } + } + } + }, + "409": { + "description": { + "en": "Error", + "pt": "Erro", + "es": "Error" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errorKey": { + "type": "string", + "enum": [ + { + "title": "1", + "description": { + "en": "A pont of sale with the same EXTERNAL_ID already exists.", + "es": "Ya existe un punto de venta con el mismo EXTERNAL_ID.", + "pt": "Já existe um ponto de venda com o mesmo EXTERNAL_ID." + } + } + ] + } + } + } + } + } + } + }, + "title": { + "en": "Update POS", + "pt": "Atualizar caixa", + "es": "Actualizar caja" + } + }, + "delete": { + "tags": [ + "qr-code", + "mp-point" + ], + "description": { + "en": "Delete a point of sale whenever you need it with the ID of the POS", + "pt": "Exclua um ponto de venda sempre que for necessário com o ID da caixa", + "es": "Elimina un punto de venta siempre que lo necesites con el ID de la caja" + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": { + "en": "POS Id", + "pt": "POS Id", + "es": "POS Id" + }, + "required": true, + "schema": { + "type": "string", + "example": "12123adfasdf123u4u" + } + } + ], + "responses": { + "400": { + "description": { + "en": "Error", + "pt": "Erro", + "es": "Error" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errorKey": { + "type": "string", + "enum": [ + { + "title": "INVALID_POS_ID", + "description": { + "en": "The ID of the pos is invalid, it must be numeric.", + "es": "El ID del punto de venta es inválida, debe ser numérica.", + "pt": "O ID do ponto de venda é inválida, deve ser numérica." + } + } + ] + } + } + } + } + } + }, + "404": { + "description": { + "en": "Error", + "pt": "Erro", + "es": "Error" + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errorKey": { + "type": "string", + "enum": [ + { + "title": "1", + "description": { + "en": "If there is no pos for the indicated ID and user.", + "es": "If there is no pos for the indicated ID and user.", + "pt": "If there is no pos for the indicated ID and user." + } + } + ] + } + } + } + } + } + } + }, + "title": { + "en": "Delete POS", + "pt": "Excluir caixa", + "es": "Eliminar caja" + } + } + } + }, + "components": { + "schemas": { + "category": { + "type": "number", + "example": 621102, + "description": { + "en": "MCC code that indicates the category of the point of sale. If not specified, it remains as a generic category.", + "pt": "Código MCC que indica a categoria do ponto de venda. Se não especificado, ele permanece como uma categoria genérica.", + "es": "Código MCC que indica el rubro del punto de venta. Si no se especifica, queda como categoría genérica." + }, + "enum": [ + { + "title": "Gastronomy", + "description": { + "en": "Gastronomy", + "es": "Gastronomía", + "pt": "Gastronomia" + } + }, + { + "title": "621102", + "description": { + "en": "Argentina", + "es": "Argentina", + "pt": "Argentina" + } + }, + { + "title": "5611203", + "description": { + "en": "Brazil", + "es": "Brasil", + "pt": "Brasil" + } + }, + { + "title": "5812", + "description": { + "en": "Mexico", + "es": "México", + "pt": "México" + } + }, + { + "title": "5611", + "description": { + "en": "Colombia", + "es": "Colombia", + "pt": "Colômbia" + } + }, + { + "title": "5520", + "description": { + "en": "Peru", + "es": "Perú", + "pt": "Peru" + } + }, + { + "title": "56101", + "description": { + "en": "Uruguay", + "es": "Uruguay", + "pt": "Uruguai" + } + }, + { + "title": "561000", + "description": { + "en": "Chile", + "es": "Chile", + "pt": "Chile" + } + }, + { + "title": "Gas station", + "description": { + "en": "Gas station", + "es": "Estación de servicio", + "pt": "posto de gasolina" + } + }, + { + "title": "473000", + "description": { + "en": "Argentina", + "es": "Argentina", + "pt": "Argentina" + } + }, + { + "title": "4731300", + "description": { + "en": "Brazil", + "es": "Brazil", + "pt": "Brazil" + } + }, + { + "title": "468419", + "description": { + "en": "Mexico", + "es": "Mexico", + "pt": "Mexico" + } + }, + { + "title": "4731", + "description": { + "en": "Colombia", + "es": "Colombia", + "pt": "Colombia" + } + }, + { + "title": "5050", + "description": { + "en": "Peru", + "es": "Peru", + "pt": "Peru" + } + }, + { + "title": "47300", + "description": { + "en": "Uruguay", + "es": "Uruguay", + "pt": "Uruguay" + } + }, + { + "title": "473001", + "description": { + "en": "Chile", + "es": "Chile", + "pt": "Chile" + } + } + ] + } + } + } +} \ No newline at end of file From 6aeae7c6c40d1a499547d2ff3e97130c8fc32e8c Mon Sep 17 00:00:00 2001 From: hgaldino Date: Wed, 31 Jul 2024 15:25:00 -0300 Subject: [PATCH 12/20] final1 --- reference/api-json/pos copy.json | 54 ++++++++++++++++---------------- reference/api-json/pos.json | 54 ++++++++++++++++---------------- 2 files changed, 54 insertions(+), 54 deletions(-) diff --git a/reference/api-json/pos copy.json b/reference/api-json/pos copy.json index 64ade8c662..192fc55c25 100644 --- a/reference/api-json/pos copy.json +++ b/reference/api-json/pos copy.json @@ -8,7 +8,7 @@ "mp-point" ], "description": { - "en": "Generate a Point of Sale in a store. Each POS will have a unique QR Code linked to it", + "en": "Generate a point of sale in a store. Each POS will have a unique QR Code linked to it", "pt": "Gerar um ponto de venda em uma loja. Cada caixa registradora terá um código QR exclusivo vinculado a ela", "es": "Genera un punto de venta en una sucursal. Cada caja tendrá vinculado un código QR unívoco" }, @@ -21,7 +21,7 @@ "name": { "type": "string", "description": { - "en": "Name of the POS.", + "en": "Name of the point of sale.", "pt": "Nome do ponto de venda.", "es": "Nombre del punto de venta." }, @@ -481,7 +481,7 @@ } }, "title": { - "en": "Create POS", + "en": "Create point of sale", "pt": "Criar caixa", "es": "Crear caja" } @@ -847,9 +847,9 @@ "name": "id", "in": "path", "description": { - "en": "POS Id", - "pt": "POS Id", - "es": "POS Id" + "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", + "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", + "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." }, "required": true, "schema": { @@ -1040,18 +1040,18 @@ "mp-point" ], "description": { - "en": "Renew the data of a Point of Sale. Indicate the ID of the POS and send the parameters with the information you want to update", - "pt": "Atualizar os dados de um ponto de venda. Indicar a identificação da caixa registradora e enviar os parâmetros com as informações que você deseja atualizar", - "es": "Renueva los datos de un punto de venta. Indica el ID de la caja y envía los parámetros con la información que quieras actualizar" + "en": "This endpoint allows you to update the data of a point of sale. To use it, you need to provide the identification of the point of sale and send the parameters with the information to be updated.", + "pt": "Este endpoint permite atualizar os dados de um ponto de venda (caixa). Para utilizá-lo, é necessário fornecer a identificação do ponto de venda e enviar os parâmetros com as informações a serem atualizadas.", + "es": "Este endpoint permite actualizar los datos de un punto de venta (caja). Para utilizarlo, es necesario proporcionar la identificación del punto de venta y enviar los parámetros con la información que se debe actualizar." }, "parameters": [ { "name": "id", "in": "path", "description": { - "en": "POS Id", - "pt": "POS Id", - "es": "POS Id" + "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including updating the point of sale data.", + "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo a atualização de dados do ponto de venda.", + "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la actualización de los datos del punto de venta." }, "required": true, "schema": { @@ -1069,9 +1069,9 @@ "name": { "type": "string", "description": { - "en": "Name of the POS.", - "pt": "Nome da caixa", - "es": "Nombre de la caja" + "en": "Name of the point of sale.", + "pt": "Nome do caixa.", + "es": "Nombre de la caja." }, "example": "First POS" }, @@ -1091,8 +1091,8 @@ "type": "string", "description": { "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o caixa pertence", - "es": "Identificador de la sucursal a la que pertenece el Punto de Venta" + "pt": "Identificador da loja à qual o ponto de venda pertence.", + "es": "Identificador de la sucursal a la que pertenece el punto de venta." }, "example": 1234567 }, @@ -1555,9 +1555,9 @@ "name": "id", "in": "path", "description": { - "en": "POS Id", - "pt": "POS Id", - "es": "POS Id" + "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including deleting a point of sale.", + "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", + "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la eliminación de un punto de venta." }, "required": true, "schema": { @@ -1729,16 +1729,16 @@ "title": "4731300", "description": { "en": "Brazil", - "es": "Brazil", - "pt": "Brazil" + "es": "Brasil", + "pt": "Brasil" } }, { "title": "468419", "description": { "en": "Mexico", - "es": "Mexico", - "pt": "Mexico" + "es": "México", + "pt": "México" } }, { @@ -1746,14 +1746,14 @@ "description": { "en": "Colombia", "es": "Colombia", - "pt": "Colombia" + "pt": "Colômbia" } }, { "title": "5050", "description": { "en": "Peru", - "es": "Peru", + "es": "Perú", "pt": "Peru" } }, @@ -1762,7 +1762,7 @@ "description": { "en": "Uruguay", "es": "Uruguay", - "pt": "Uruguay" + "pt": "Uruguai" } }, { diff --git a/reference/api-json/pos.json b/reference/api-json/pos.json index 64ade8c662..192fc55c25 100644 --- a/reference/api-json/pos.json +++ b/reference/api-json/pos.json @@ -8,7 +8,7 @@ "mp-point" ], "description": { - "en": "Generate a Point of Sale in a store. Each POS will have a unique QR Code linked to it", + "en": "Generate a point of sale in a store. Each POS will have a unique QR Code linked to it", "pt": "Gerar um ponto de venda em uma loja. Cada caixa registradora terá um código QR exclusivo vinculado a ela", "es": "Genera un punto de venta en una sucursal. Cada caja tendrá vinculado un código QR unívoco" }, @@ -21,7 +21,7 @@ "name": { "type": "string", "description": { - "en": "Name of the POS.", + "en": "Name of the point of sale.", "pt": "Nome do ponto de venda.", "es": "Nombre del punto de venta." }, @@ -481,7 +481,7 @@ } }, "title": { - "en": "Create POS", + "en": "Create point of sale", "pt": "Criar caixa", "es": "Crear caja" } @@ -847,9 +847,9 @@ "name": "id", "in": "path", "description": { - "en": "POS Id", - "pt": "POS Id", - "es": "POS Id" + "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", + "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", + "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." }, "required": true, "schema": { @@ -1040,18 +1040,18 @@ "mp-point" ], "description": { - "en": "Renew the data of a Point of Sale. Indicate the ID of the POS and send the parameters with the information you want to update", - "pt": "Atualizar os dados de um ponto de venda. Indicar a identificação da caixa registradora e enviar os parâmetros com as informações que você deseja atualizar", - "es": "Renueva los datos de un punto de venta. Indica el ID de la caja y envía los parámetros con la información que quieras actualizar" + "en": "This endpoint allows you to update the data of a point of sale. To use it, you need to provide the identification of the point of sale and send the parameters with the information to be updated.", + "pt": "Este endpoint permite atualizar os dados de um ponto de venda (caixa). Para utilizá-lo, é necessário fornecer a identificação do ponto de venda e enviar os parâmetros com as informações a serem atualizadas.", + "es": "Este endpoint permite actualizar los datos de un punto de venta (caja). Para utilizarlo, es necesario proporcionar la identificación del punto de venta y enviar los parámetros con la información que se debe actualizar." }, "parameters": [ { "name": "id", "in": "path", "description": { - "en": "POS Id", - "pt": "POS Id", - "es": "POS Id" + "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including updating the point of sale data.", + "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo a atualização de dados do ponto de venda.", + "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la actualización de los datos del punto de venta." }, "required": true, "schema": { @@ -1069,9 +1069,9 @@ "name": { "type": "string", "description": { - "en": "Name of the POS.", - "pt": "Nome da caixa", - "es": "Nombre de la caja" + "en": "Name of the point of sale.", + "pt": "Nome do caixa.", + "es": "Nombre de la caja." }, "example": "First POS" }, @@ -1091,8 +1091,8 @@ "type": "string", "description": { "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o caixa pertence", - "es": "Identificador de la sucursal a la que pertenece el Punto de Venta" + "pt": "Identificador da loja à qual o ponto de venda pertence.", + "es": "Identificador de la sucursal a la que pertenece el punto de venta." }, "example": 1234567 }, @@ -1555,9 +1555,9 @@ "name": "id", "in": "path", "description": { - "en": "POS Id", - "pt": "POS Id", - "es": "POS Id" + "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including deleting a point of sale.", + "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", + "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la eliminación de un punto de venta." }, "required": true, "schema": { @@ -1729,16 +1729,16 @@ "title": "4731300", "description": { "en": "Brazil", - "es": "Brazil", - "pt": "Brazil" + "es": "Brasil", + "pt": "Brasil" } }, { "title": "468419", "description": { "en": "Mexico", - "es": "Mexico", - "pt": "Mexico" + "es": "México", + "pt": "México" } }, { @@ -1746,14 +1746,14 @@ "description": { "en": "Colombia", "es": "Colombia", - "pt": "Colombia" + "pt": "Colômbia" } }, { "title": "5050", "description": { "en": "Peru", - "es": "Peru", + "es": "Perú", "pt": "Peru" } }, @@ -1762,7 +1762,7 @@ "description": { "en": "Uruguay", "es": "Uruguay", - "pt": "Uruguay" + "pt": "Uruguai" } }, { From fccb4044e48b2075829f4e47e08e27eefcfe8fbe Mon Sep 17 00:00:00 2001 From: hgaldino Date: Wed, 31 Jul 2024 15:31:30 -0300 Subject: [PATCH 13/20] final2 --- reference/api-json/claims.json | 112 ++++++++++++++++++++++++++++----- 1 file changed, 98 insertions(+), 14 deletions(-) diff --git a/reference/api-json/claims.json b/reference/api-json/claims.json index 618b87b1eb..8d42b816ae 100644 --- a/reference/api-json/claims.json +++ b/reference/api-json/claims.json @@ -4,7 +4,13 @@ "/post-purchase/v1/claims/{claim_id}": { "get": { "tags": [ - "checkout-pro" + "checkout-pro", + "checkout-api", + "checkout-bricks", + "subscriptions", + "mp-point", + "qr-code", + "wallet-connect" ], "description": { "en": "This endpoint allows you to obtain, through a valid token, details of claims such as, for example, information about the users involved and the order that generated the claim", @@ -647,7 +653,13 @@ "/post-purchase/v1/claims/search": { "get": { "tags": [ - "checkout-pro" + "checkout-pro", + "checkout-api", + "checkout-bricks", + "subscriptions", + "mp-point", + "qr-code", + "wallet-connect" ], "description": { "en": "This endpoint allows searching, through a valid token, which claims belong to a certain user", @@ -1563,7 +1575,13 @@ "/post-purchase/v1/claims/{claim_id}/messages": { "get": { "tags": [ - "checkout-pro" + "checkout-pro", + "checkout-api", + "checkout-bricks", + "subscriptions", + "mp-point", + "qr-code", + "wallet-connect" ], "description": { "en": "This endpoint allows searching, through a valid token, messages associated with a claim", @@ -1898,7 +1916,13 @@ "/post-purchase/v1/claims/{claim_id}/attachments": { "post": { "tags": [ - "checkout-pro" + "checkout-pro", + "checkout-api", + "checkout-bricks", + "subscriptions", + "mp-point", + "qr-code", + "wallet-connect" ], "description": { "en": "This endpoint allows, through a valid token, attaching image files to the messages that will be associated with the complaint", @@ -1989,7 +2013,13 @@ "/post-purchase/v1/claims/{claim_id}/actions/send-message": { "post": { "tags": [ - "checkout-pro" + "checkout-pro", + "subscriptions", + "checkout-api", + "checkout-bricks", + "wallet-connect", + "mp-point", + "qr-code" ], "description": { "en": "This endpoint allows, through a valid token, sending and associating messages with attached image files to the claim", @@ -2084,7 +2114,13 @@ "/post-purchase/v1/claims/{claim_id}/attachments/{fileName}/download": { "get": { "tags": [ - "checkout-pro" + "checkout-pro", + "checkout-api", + "checkout-bricks", + "subscriptions", + "mp-point", + "qr-code", + "wallet-connect" ], "description": { "en": "This endpoint allows, through a valid token, downloading image files attached to the messages associated with the claim", @@ -2140,7 +2176,13 @@ "/post-purchase/v1/claims/{claim_id}/attachments/{fileName}": { "get": { "tags": [ - "checkout-pro" + "checkout-pro", + "checkout-api", + "checkout-bricks", + "subscriptions", + "mp-point", + "qr-code", + "wallet-connect" ], "description": { "en": "This endpoint allows searching, through a valid token, for image files attached to the message associated with the complaint", @@ -2250,7 +2292,13 @@ "/post-purchase/v1/claims/{claim_id}/actions/open-dispute": { "post": { "tags": [ - "checkout-pro" + "checkout-pro", + "subscriptions", + "checkout-api", + "checkout-bricks", + "wallet-connect", + "mp-point", + "qr-code" ], "description": { "en": "This endpoint allows searching, through a valid token, requesting mediation in the claim opened by the user", @@ -2893,7 +2941,13 @@ "/post-purchase/v1/claims/{claim_id}/expected-resolutions": { "get": { "tags": [ - "checkout-pro" + "checkout-pro", + "subscriptions", + "checkout-api", + "checkout-bricks", + "wallet-connect", + "mp-point", + "qr-code" ], "description": { "en": "This endpoint allows, through a valid token, viewing the expected resolutions by the user in their claim", @@ -3061,7 +3115,13 @@ "/post-purchase/v1/claims/{claim_id}/evidences": { "get": { "tags": [ - "checkout-pro" + "checkout-pro", + "checkout-api", + "checkout-bricks", + "subscriptions", + "mp-point", + "qr-code", + "wallet-connect" ], "description": { "en": "This endpoint allows, through a valid token, obtaining evidence of the the claim, such as order shipping information and attached image files associated with the claim", @@ -3290,7 +3350,13 @@ "/post-purchase/v1/claims/{claim_id}/actions/evidences": { "post": { "tags": [ - "checkout-pro" + "checkout-pro", + "checkout-api", + "checkout-bricks", + "subscriptions", + "mp-point", + "qr-code", + "wallet-connect" ], "description": { "en": "This endpoint allows you to upload, through a valid token, evidence of sending the order. For a delivery by mail the fields 'shipping_company_name' and 'date_shipped' are required, while for a delivery to order the required fields are 'shipping_company_name', 'destination_agency', 'date_shipped' and 'receiver_name'. For delivery by email, the 'receiver_email' and 'date_shipped' fields are mandatory", @@ -3647,7 +3713,13 @@ "/post-purchase/v1/claims/{claim_id}/status_history": { "get": { "tags": [ - "checkout-pro" + "checkout-pro", + "checkout-api", + "checkout-bricks", + "subscriptions", + "mp-point", + "qr-code", + "wallet-connect" ], "description": { "en": "This endpoint allows you to view, through a valid token, the history of states and scenarios that the complaint has gone through. It will also be possible to consult the history of actions taken by the people responsible for the complaint", @@ -3815,7 +3887,13 @@ "/post-purchase/v1/claims/reasons/{reason_id}": { "get": { "tags": [ - "checkout-pro" + "checkout-pro", + "checkout-api", + "checkout-bricks", + "subscriptions", + "mp-point", + "qr-code", + "wallet-connect" ], "description": { "en": "This endpoint allows you to view, through a valid token, the 'reason' why the claim was created, so that based on its classification, certain behaviors are allowed", @@ -4213,7 +4291,13 @@ "/claim_resource": { "get": { "tags": [ - "checkout-pro" + "checkout-pro", + "checkout-api", + "checkout-bricks", + "subscriptions", + "mp-point", + "qr-code", + "wallet-connect" ], "description": { "en": "This endpoint allows, through a valid token, to obtain notifications of the complaint by making a 'get' request to the complaints resource using the 'resource' field of the 'data' parameter from the Webhook notifications received from the topic. For more information about Webhook notifications, visit: https://www.mercadopago.com/developers/en/docs/your-integrations/notifications/webhooks", From 8c283e3de07c430fc4b44e247caa1d380449d8e3 Mon Sep 17 00:00:00 2001 From: hgaldino Date: Wed, 31 Jul 2024 16:53:33 -0300 Subject: [PATCH 14/20] sim --- .../security/{pci-v2.en 2.md => pci-v2.en.md} | 0 .../security/{pci-v2.es 2.md => pci-v2.es.md} | 0 .../security/{pci-v2.pt 2.md => pci-v2.pt.md} | 0 guides/sdks-v2/official/server-side.en.md | 5 ++--- guides/sdks-v2/official/server-side.es.md | 7 ++----- guides/sdks-v2/official/server-side.pt.md | 7 ++----- guides/shopify/integration-configuration-cho-api.es.md | 2 +- 7 files changed, 7 insertions(+), 14 deletions(-) rename guides/additional-content/security/{pci-v2.en 2.md => pci-v2.en.md} (100%) rename guides/additional-content/security/{pci-v2.es 2.md => pci-v2.es.md} (100%) rename guides/additional-content/security/{pci-v2.pt 2.md => pci-v2.pt.md} (100%) diff --git a/guides/additional-content/security/pci-v2.en 2.md b/guides/additional-content/security/pci-v2.en.md similarity index 100% rename from guides/additional-content/security/pci-v2.en 2.md rename to guides/additional-content/security/pci-v2.en.md diff --git a/guides/additional-content/security/pci-v2.es 2.md b/guides/additional-content/security/pci-v2.es.md similarity index 100% rename from guides/additional-content/security/pci-v2.es 2.md rename to guides/additional-content/security/pci-v2.es.md diff --git a/guides/additional-content/security/pci-v2.pt 2.md b/guides/additional-content/security/pci-v2.pt.md similarity index 100% rename from guides/additional-content/security/pci-v2.pt 2.md rename to guides/additional-content/security/pci-v2.pt.md diff --git a/guides/sdks-v2/official/server-side.en.md b/guides/sdks-v2/official/server-side.en.md index 001ceed8b3..15948bc913 100644 --- a/guides/sdks-v2/official/server-side.en.md +++ b/guides/sdks-v2/official/server-side.en.md @@ -33,11 +33,10 @@ Mercado Pago's SDKs are available in several programming languages. For more det | Java 2.1.21 | Java 1.8 or higher | [Maven](https://search.maven.org/artifact/com.mercadopago/sdk-java) | [GitHub](https://github.com/mercadopago/sdk-java) | | NodeJS 2.0.0 | Node.js 12 or higher | [NPM](https://www.npmjs.com/package/mercadopago) | [GitHub](https://github.com/mercadopago/sdk-nodejs) | | Ruby 2.2.0 | Ruby 2.3+ | [Gem](https://rubygems.org/gems/mercadopago-sdk) | [GitHub](https://github.com/mercadopago/sdk-ruby) | -| .NET 2.3.3 | .NET Standard 2.0+
.NET Core 2.0+
.NET Framework 4.6.1+ | [NuGet](https://www.nuget.org/packages/mercadopago-sdk) | [GitHub](https://github.com/mercadopago/sdk-dotnet) | +| .NET 2.4 | .NET Standard 2.1+
.NET Core 2.0+
.NET Framework 6.0+ | [NuGet](https://www.nuget.org/packages/mercadopago-sdk) | [GitHub](https://github.com/mercadopago/sdk-dotnet) | | Python 2.2.1 | Python 3+ | [PyPI](https://pypi.org/project/mercadopago/) | [GitHub](https://github.com/mercadopago/sdk-python) | | Go 1.0.0 | Go 1.18+ | [Go](https://pkg.go.dev/github.com/mercadopago/sdk-go) | [GitHub](https://github.com/mercadopago/sdk-go) | - --- mini_landing_separator --- >>>> API Reference <<<< @@ -48,4 +47,4 @@ After installing one of our SDKs, you can use our API Reference to generate code 2. In the selector, within the code block, select the programming language of your choice. 3. Enter the necessary parameters and view the updated code snippet. -Done! The generated code snippets can be directly copied to your application and customized as needed. +Done! The generated code snippets can be directly copied to your application and customized as needed. \ No newline at end of file diff --git a/guides/sdks-v2/official/server-side.es.md b/guides/sdks-v2/official/server-side.es.md index 04f39008eb..dc54421046 100644 --- a/guides/sdks-v2/official/server-side.es.md +++ b/guides/sdks-v2/official/server-side.es.md @@ -27,18 +27,16 @@ bullet_section_with_media: Los SDKs de Mercado Pago están disponibles en distintos lenguajes de programación. Puedes ver más detalles sobre su instalación, requisitos previos y primeros pasos en la tabla a continuación. - | SDK | Versiones compatibles | Descarga | Documentación | |:-------------:|:--------------------------------------------------------:|:---------:|:------------:| | PHP 3.0.0 | PHP 8.2 o superior | [Packagist](https://packagist.org/packages/mercadopago/dx-php)| [GitHub](https://github.com/mercadopago/sdk-php) | | Java 2.1.21 | Java 1.8 o superior | [Maven](https://search.maven.org/artifact/com.mercadopago/sdk-java) | [GitHub](https://github.com/mercadopago/sdk-java) | | NodeJS 2.0.0 | Node.js 12 o superior | [NPM](https://www.npmjs.com/package/mercadopago) | [GitHub](https://github.com/mercadopago/sdk-nodejs) | | Ruby 2.2.0 | Ruby 2.3+ | [Gem](https://rubygems.org/gems/mercadopago-sdk) | [GitHub](https://github.com/mercadopago/sdk-ruby) | -| .NET 2.3.3 | .NET Standard 2.0+
.NET Core 2.0+
.NET Framework 4.6.1+ | [NuGet](https://www.nuget.org/packages/mercadopago-sdk) | [GitHub](https://github.com/mercadopago/sdk-dotnet) | +| .NET 2.4 | .NET Standard 2.1+
.NET Core 2.0+
.NET Framework 6.0+ | [NuGet](https://www.nuget.org/packages/mercadopago-sdk) | [GitHub](https://github.com/mercadopago/sdk-dotnet) | | Python 2.2.1 | Python 3+ | [PyPI](https://pypi.org/project/mercadopago/) | [GitHub](https://github.com/mercadopago/sdk-python) | | Go 1.0.0 | Go 1.18+ | [Go](https://pkg.go.dev/github.com/mercadopago/sdk-go) | [GitHub](https://github.com/mercadopago/sdk-go) | - --- mini_landing_separator --- >>>> Referencia de API <<<< @@ -49,5 +47,4 @@ Luego de instalar uno de nuestros SDKs, puedes utilizar nuestra Referencia de AP 2. En el menú desplegable ubicado en el borde superior del bloque de código, selecciona el lenguaje de programación de tu preferencia. 3. Inserta los parámetros necesarios siguiendo las descripciones, y visualiza el bloque de código actualizado. -¡Hecho! Los bloques de código generados pueden ser copiados directamente en tu aplicación, y personalizados como creas necesario. - +¡Hecho! Los bloques de código generados pueden ser copiados directamente en tu aplicación, y personalizados como creas necesario. \ No newline at end of file diff --git a/guides/sdks-v2/official/server-side.pt.md b/guides/sdks-v2/official/server-side.pt.md index 6c9c14792a..e739e89993 100644 --- a/guides/sdks-v2/official/server-side.pt.md +++ b/guides/sdks-v2/official/server-side.pt.md @@ -28,21 +28,18 @@ bullet_section_with_media: Os SDKs do Mercado Pago estão disponíveis em diversas linguagens de programação. Para mais detalhes sobre instalação, requisitos e primeiros passos, veja a tabela abaixo: - | SDK | Versões compatíveis | Download | Documentação | |:-------------:|:--------------------------------------------------------:|:---------:|:------------:| | PHP 3.0.0 | PHP 8.2 ou superior | [Packagist](https://packagist.org/packages/mercadopago/dx-php)| [GitHub](https://github.com/mercadopago/sdk-php) | | Java 2.1.21 | Java 1.8 ou superior | [Maven](https://search.maven.org/artifact/com.mercadopago/sdk-java) | [GitHub](https://github.com/mercadopago/sdk-java) | | NodeJS 2.0.0 | Node.js 12 ou superior | [NPM](https://www.npmjs.com/package/mercadopago) | [GitHub](https://github.com/mercadopago/sdk-nodejs) | | Ruby 2.2.0 | Ruby 2.3+ | [Gem](https://rubygems.org/gems/mercadopago-sdk) | [GitHub](https://github.com/mercadopago/sdk-ruby) | -| .NET 2.3.3 | .NET Standard 2.0+
.NET Core 2.0+
.NET Framework 4.6.1+ | [NuGet](https://www.nuget.org/packages/mercadopago-sdk) | [GitHub](https://github.com/mercadopago/sdk-dotnet) | +| .NET 2.4 | .NET Standard 2.1+
.NET Core 2.0+
.NET Framework 6.0+ | [NuGet](https://www.nuget.org/packages/mercadopago-sdk) | [GitHub](https://github.com/mercadopago/sdk-dotnet) | | Python 2.2.1 | Python 3+ | [PyPI](https://pypi.org/project/mercadopago/) | [GitHub](https://github.com/mercadopago/sdk-python) | | Go 1.0.0 | Go 1.18+ | [Go](https://pkg.go.dev/github.com/mercadopago/sdk-go) | [GitHub](https://github.com/mercadopago/sdk-go) | - --- mini_landing_separator --- - >>>> Referência de API <<<< Depois de instalar um de nossos SDKs, você pode utilizar nossa API Reference para gerar trechos de código na linguagem de programação de sua escolha. Para explorar como integrar utilizando nossas APIs, siga as etapas abaixo. @@ -51,4 +48,4 @@ Depois de instalar um de nossos SDKs, você pode utilizar nossa API Reference pa 2. No seletor, dentro do bloco de código, selecione a linguagem de programação de sua preferência. 3. Insira os parâmetros necessários e visualize o trecho de código atualizado. -Feito! Os trechos de código gerados podem ser copiados diretamente para o seu aplicativo e personalizados conforme necessário. +Feito! Os trechos de código gerados podem ser copiados diretamente para o seu aplicativo e personalizados conforme necessário. \ No newline at end of file diff --git a/guides/shopify/integration-configuration-cho-api.es.md b/guides/shopify/integration-configuration-cho-api.es.md index db9a6ef628..c0899e94d3 100644 --- a/guides/shopify/integration-configuration-cho-api.es.md +++ b/guides/shopify/integration-configuration-cho-api.es.md @@ -162,7 +162,7 @@ Para instalar el checkout **Mercado Pago Tarjetas** en una tienda Shopify, ofrec ## Configura meses sin intereses -Después de instalar y activar la aplicación **Mercado Pago Cartões**, configura la opción de ofrecer a tus clientes pagos en meses sin intereses con cualquier tarjeta de crédito. Para ello, sigue los pasos a continuación. +Después de instalar y activar la aplicación **Mercado Pago Tarjetas**, configura la opción de ofrecer a tus clientes pagos en meses sin intereses con cualquier tarjeta de crédito. Para ello, sigue los pasos a continuación. 1. Inicia sesión en tu [cuenta de Mercado Pago](https://www.mercadopago[FAKER][URL][DOMAIN]/home). 2. Ve a la sección **Tu negocio > Costos** y selecciona la opción **Checkout**. From de17d9b1ab9d081fb3fad53e63116b39796215ed Mon Sep 17 00:00:00 2001 From: Pilar Canosa Date: Wed, 31 Jul 2024 17:18:40 -0300 Subject: [PATCH 15/20] fixes money out --- guides/money-out/prerequisites.en.md | 8 +++++++- guides/money-out/prerequisites.es.md | 8 +++++++- guides/money-out/prerequisites.pt.md | 8 +++++++- 3 files changed, 21 insertions(+), 3 deletions(-) diff --git a/guides/money-out/prerequisites.en.md b/guides/money-out/prerequisites.en.md index a0843a1a2d..d0a5b9b2bc 100644 --- a/guides/money-out/prerequisites.en.md +++ b/guides/money-out/prerequisites.en.md @@ -1,6 +1,12 @@ # Prerequisites -To integrate the Money Out functionality, you must be authorized by our comercial area. If you have been authorized already, you must also meet the requirements shown below. +> WARNING +> +> Important +> +> To integrate this functionality, you must be authorized by our comercial area. + +Once authorized by our commercial area, you can begin your integration with Money Out if you meet the requirements shown below. | Requirement | Description | |---|---| diff --git a/guides/money-out/prerequisites.es.md b/guides/money-out/prerequisites.es.md index ca292d78dd..6b81dff290 100644 --- a/guides/money-out/prerequisites.es.md +++ b/guides/money-out/prerequisites.es.md @@ -1,6 +1,12 @@ # Requisitos previos -Para integrar la funcionalidad Money Out, primero debes haber sido autorizado por nuestra área comercial. Si ya fuiste autorizado a utilizarla, debes cumplir con los requisitos previos que se muestran a continuación: +> WARNING +> +> Importante +> +> Para integrar esta funcionalidad, primero debes haber sido autorizado por nuestra área comercial. + +Una vez recibida la autorización de nuestra área comercial, puedes comenzar tu integración con Money Out si cumples con los requisitos previos que se muestran a continuación: | Requisito | Descripción | |---|---| diff --git a/guides/money-out/prerequisites.pt.md b/guides/money-out/prerequisites.pt.md index 3fd2124b2e..e95d217419 100644 --- a/guides/money-out/prerequisites.pt.md +++ b/guides/money-out/prerequisites.pt.md @@ -1,6 +1,12 @@ # Pré-requisitos -Para integrar a funcionalidade Money Out, é necessária a autorização da nossa área comercial. Caso esta autorização já tenha sido concedida, é preciso cumprir com os requisitos listados abaixo. +> WARNING +> +> Importante +> +> Para integrar a funcionalidade Money Out, é necessária a autorização da nossa área comercial. + +Após receber autorização de nossa área comercial, você poderá iniciar sua integração com o Money Out caso atenda aos pré-requisitos listados abaixo. | Requisito | Descrição | |---|---| From f8272efaa60a537cd8ba3fbdc6b0efe71c8ab630 Mon Sep 17 00:00:00 2001 From: hgaldino Date: Thu, 1 Aug 2024 14:23:50 -0300 Subject: [PATCH 16/20] sim --- .../{getting-started-v2.en.md => getting-started.en.md} | 0 .../{getting-started-v2.es.md => getting-started.es.md} | 0 .../{getting-started-v2.pt.md => getting-started.pt.md} | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename guides/additional-content/getting-started/{getting-started-v2.en.md => getting-started.en.md} (100%) rename guides/additional-content/getting-started/{getting-started-v2.es.md => getting-started.es.md} (100%) rename guides/additional-content/getting-started/{getting-started-v2.pt.md => getting-started.pt.md} (100%) diff --git a/guides/additional-content/getting-started/getting-started-v2.en.md b/guides/additional-content/getting-started/getting-started.en.md similarity index 100% rename from guides/additional-content/getting-started/getting-started-v2.en.md rename to guides/additional-content/getting-started/getting-started.en.md diff --git a/guides/additional-content/getting-started/getting-started-v2.es.md b/guides/additional-content/getting-started/getting-started.es.md similarity index 100% rename from guides/additional-content/getting-started/getting-started-v2.es.md rename to guides/additional-content/getting-started/getting-started.es.md diff --git a/guides/additional-content/getting-started/getting-started-v2.pt.md b/guides/additional-content/getting-started/getting-started.pt.md similarity index 100% rename from guides/additional-content/getting-started/getting-started-v2.pt.md rename to guides/additional-content/getting-started/getting-started.pt.md From 331cc82be51b871cb91160582eee2e51ea37897b Mon Sep 17 00:00:00 2001 From: hgaldino Date: Thu, 1 Aug 2024 16:47:28 -0300 Subject: [PATCH 17/20] sim --- guides/additional-content/security/oauth/creation.en.md | 2 +- guides/additional-content/security/oauth/creation.es.md | 2 +- guides/additional-content/security/oauth/creation.pt.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/guides/additional-content/security/oauth/creation.en.md b/guides/additional-content/security/oauth/creation.en.md index d1008c5e82..f4702626e5 100644 --- a/guides/additional-content/security/oauth/creation.en.md +++ b/guides/additional-content/security/oauth/creation.en.md @@ -62,7 +62,7 @@ Access Token is the code used in different requests of public origin to access a > > It is recommended to carry out this procedure all at once together with the user, since the code received by the "Redirect URL" after authorization is valid for 10 minutes and the Access Token received through the endpoint is valid for 180 days (6 months). -1. Edit your application so that it contains your Redirect URL. See [Edit Application](/developers/en/guides/additional-content/your-integrations/application-details). +1. Edit your application so that it contains your Redirect URL. See [Edit application](/developers/en/docs/your-integrations/application-details). 2. Send the **authentication URL** to the seller whose account you want to link to yours with the following fields: ```Authentication_URL diff --git a/guides/additional-content/security/oauth/creation.es.md b/guides/additional-content/security/oauth/creation.es.md index ef203acb18..a7db41de2a 100644 --- a/guides/additional-content/security/oauth/creation.es.md +++ b/guides/additional-content/security/oauth/creation.es.md @@ -63,7 +63,7 @@ Sigue los pasos a continuación para obtenerlo. > > Se recomienda realizar este procedimiento de una única vez junto con el usuario, ya que el código recibido por la "URL de redireccionamiento" después de la autorización tiene una validez de 10 minutos y el Access Token recibido a través del endpoint tiene una validez de 180 días (6 meses). -1. Edita tu aplicación para que contenga tu URLs de redireccionamiento. Consulta [Editar aplicación](/developers/es/guides/additional-content/your-integrations/application-details). +1. Edita tu aplicación para que contenga tu URLs de redireccionamiento. Consulta [Editar aplicación](/developers/es/docs/your-integrations/application-details). 2. Envía la **URL de autenticación** con los siguientes campos al vendedor con cuya cuenta deseas vincular la tuya: ```Authentication_URL diff --git a/guides/additional-content/security/oauth/creation.pt.md b/guides/additional-content/security/oauth/creation.pt.md index 32720f63cc..ef88632012 100644 --- a/guides/additional-content/security/oauth/creation.pt.md +++ b/guides/additional-content/security/oauth/creation.pt.md @@ -62,7 +62,7 @@ O Access Token é o código utilizado em diferentes _requests_ públicos para ac > > É recomendado realizar este procedimento por completo de uma única vez em conjunto com o usuário, visto que o código recebido pela "URL de redirecionamento" após a autorização tem validade de 10 minutos e o Access Token recebido através do endpoint tem validade de 180 dias (6 meses). -1. Edite sua aplicação para conter suas URLs de redirecionamento. Veja [Editar aplicação](/developers/pt/guides/additional-content/your-integrations/application-details). +1. Edite sua aplicação para conter suas URLs de redirecionamento. Veja [Editar aplicação](/developers/pt/docs/your-integrations/application-details). 2. Envie a **URL de autenticação** para o vendedor cuja conta você deseja vincular à sua com os seguintes campos: ```Authentication_URL From d2847342769d537621379735a9dc465c8b75409e Mon Sep 17 00:00:00 2001 From: hgaldino Date: Thu, 1 Aug 2024 18:07:02 -0300 Subject: [PATCH 18/20] finalfinal --- reference/api-json/pos copy.json | 290 ++++++++++---------- reference/api-json/pos.json | 449 +++++++++++++++++-------------- 2 files changed, 400 insertions(+), 339 deletions(-) diff --git a/reference/api-json/pos copy.json b/reference/api-json/pos copy.json index 192fc55c25..4f13533c90 100644 --- a/reference/api-json/pos copy.json +++ b/reference/api-json/pos copy.json @@ -48,9 +48,9 @@ "external_store_id": { "type": "string", "description": { - "en": "External_id of the store to which the pos belongs defined by integrator system.", - "pt": "External_id of the store to which the pos belongs defined by integrator system.", - "es": "External_id of the store to which the pos belongs defined by integrator system." + "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", + "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", + "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." }, "example": "SUC001" }, @@ -82,9 +82,9 @@ "responses": { "200": { "description": { - "es": "Success", - "pt": "Success", - "en": "Success" + "en": "Success", + "pt": "Sucesso", + "es": "Éxito" }, "content": { "application/json": { @@ -95,9 +95,9 @@ "type": "number", "example": 2711382, "description": { - "es": "id", - "pt": "id", - "en": "id" + "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", + "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", + "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." } }, "qr": { @@ -207,35 +207,35 @@ "type": "string", "example": 1234567, "description": { - "es": "store_id", - "pt": "store_id", - "en": "store_id" + "en": "Store identifier to which the point of sale belongs.", + "pt": "Identificador da loja à qual o ponto de venda pertence.", + "es": "Identificador de la sucursal a la que pertenece el punto de venta." } }, "external_store_id": { "type": "string", "example": "SUC001", "description": { - "es": "external_store_id", - "pt": "external_store_id", - "en": "external_store_id" + "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", + "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", + "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." } }, "url": { "type": "string", "description": { - "es": "url", - "pt": "url", - "en": "url" + "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", + "pt": "URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.", + "es": "URL para obtener la orden del sistema integrador. Es opcional y se utiliza solo en el modelo de integración desatendido." } }, "external_id": { "type": "string", "example": "SUC001POS001", "description": { - "es": "external_id", - "pt": "external_id", - "en": "external_id" + "en": "Unique identifier of the pos defined by integrator system.", + "pt": "Identificador único da caixa definido pelo sistema integrador.", + "es": "Identificador único de la caja definido por el integrador." } } } @@ -260,129 +260,137 @@ { "title": "MISSING_BODY", "description": { - "en": "HTTP body is required to create pos.", - "es": "HTTP body is required to create pos.", - "pt": "HTTP body is required to create pos." + "en": "HTTP body is required to modify pos.", + "es": "El cuerpo del HTTP es requerido para modificar el punto de venta.", + "pt": "O corpo do HTTP é necessário para modificar o ponto de venda." } }, { "title": "UNKNOWN_FIELD_EXCEPTION", "description": { "en": "The indicated field is not allowed for this operation or is unknown.", - "es": "The indicated field is not allowed for this operation or is unknown.", - "pt": "The indicated field is not allowed for this operation or is unknown." + "es": "El campo indicado no está permitido para esta operación o es desconocido.", + "pt": "O campo indicado não é permitido para esta operação ou é desconhecido." + } + }, + { + "title": "INVALID_POS_ID", + "description": { + "en": "The ID of the pos is invalid, it must be numeric.", + "es": "El ID del punto de venta es inválida, debe ser numérica.", + "pt": "O ID do ponto de venda é inválida, deve ser numérica." } }, { "title": "INVALID_NAME", "description": { "en": "NAME must be string.", - "es": "NAME must be string.", - "pt": "NAME must be string." + "es": "NOMBRE debe ser string.", + "pt": "NAME deve ser string." } }, { "title": "NAME_TOO_LONG", "description": { "en": "The NAME must be less than 45 characters.", - "es": "The NAME must be less than 45 characters.", - "pt": "The NAME must be less than 45 characters." + "es": "NAME debe ser menor de 45 caracteres.", + "pt": "NAME deve ter menos de 45 caracteres." } }, { "title": "INVALID_FIXED_AMOUNT", "description": { "en": "FIXED_AMOUNT must be boolean.", - "es": "FIXED_AMOUNT must be boolean.", - "pt": "FIXED_AMOUNT must be boolean." + "es": "FIXED_AMOUNT debe ser boolean.", + "pt": "FIXED_AMOUNT deve ser boolean." } }, { "title": "INVALID_CATEGORY", "description": { "en": "CATEGORY must be numeric.", - "es": "CATEGORY must be numeric.", - "pt": "CATEGORY must be numeric." + "es": "CATEGORY debe ser numérico.", + "pt": "CATEGORY deve ser numérico." } }, { - "title": "UNKNOWN_MCC", + "title": "POS_UNKNOWN_MCC", "description": { - "en": "The CATEGORY must be valid for the user's site.", - "es": "The CATEGORY must be valid for the user's site.", - "pt": "The CATEGORY must be valid for the user's site." + "en": "CATEGORY must be valid for the user's site.", + "es": "CATEGORY debe ser válida para el sitio del usuario.", + "pt": "CATEGORY deve ser válida para o site do usuário." } }, { - "title": "INVALID_STORE_ID", + "title": "POS_INVALID_STORE_ID", "description": { "en": "STORE_ID must be numeric.", - "es": "STORE_ID must be numeric.", - "pt": "STORE_ID must be numeric." + "es": "STORE_ID debe ser numérico.", + "pt": "STORE_ID deve ser numérico." } }, { "title": "INVALID_EXTERNAL_STORE_ID", "description": { - "en": "EXTERNAL_STORE_ID muste be string.", - "es": "EXTERNAL_STORE_ID muste be string.", - "pt": "EXTERNAL_STORE_ID muste be string." + "en": "EXTERNAL_STORE_ID must be string.", + "es": "EXTERNAL_STORE_ID debe ser string.", + "pt": "EXTERNAL_STORE_ID deve ser string." } }, { "title": "EXTERNAL_STORE_ID_NOT_MATCH", "description": { "en": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID.", - "es": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID.", - "pt": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID." + "es": "El EXTERNAL_STORE_ID no hace referencia al STORE_ID indicado.", + "pt": "O EXTERNAL_STORE_ID não se refere ao STORE_ID indicado." } }, { "title": "INEXISTENT_EXTERNAL_STORE_ID", "description": { - "en": "The EXTERNAL_STORE_ID does not refer to any existing store.", - "es": "The EXTERNAL_STORE_ID does not refer to any existing store.", - "pt": "The EXTERNAL_STORE_ID does not refer to any existing store." + "en": "The EXTERNAL STORE_ID does not refer to an existing Store.", + "es": "El EXTERNAL_STORE_ID no hace referencia a una tienda existente.", + "pt": "O EXTERNAL_STORE_ID não se refere a uma loja existente." } }, { "title": "INVALID_EXTERNAL_ID", "description": { - "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "es": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "pt": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters." + "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces, hyphens or special characters.", + "es": "El campo EXTERNAL_ID debe ser alfanumérico, solo letras y números. Sin espacios, guiones o caracteres especiales.", + "pt": "O campo EXTERNAL_ID deve ser alfanumérico, apenas letras e números. Sem espaços, hífens ou caracteres especiais." } }, { "title": "EXTERNAL_ID_TOO_LONG", "description": { "en": "The EXTERNAL_ID must be less than 40 characters.", - "es": "The EXTERNAL_ID must be less than 40 characters.", - "pt": "The EXTERNAL_ID must be less than 40 characters." + "es": "El EXTERNAL_ID debe ser menor de 40 caracteres.", + "pt": "O EXTERNAL_ID deve ter menos de 40 caracteres." } }, { "title": "INVALID_URL", "description": { "en": "The URL must be string and muste have the format of a valid url", - "es": "The URL must be string and muste have the format of a valid url", - "pt": "The URL must be string and muste have the format of a valid url" + "es": "La URL debe ser una cadena y debe tener el formato de una URL válida.", + "pt": "A URL deve ser uma string e deve ter o formato de uma URL válida." } }, { "title": "URL_TOO_LONG", "description": { "en": "The URL must be less than 300 characters.", - "es": "The URL must be less than 300 characters.", - "pt": "The URL must be less than 300 characters." + "es": "La URL debe ser menor de 300 caracteres.", + "pt": "A URL deve ter menos de 300 caracteres." } }, { "title": "FIXED_AMOUNT_FALSE", "description": { "en": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case.", - "es": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case.", - "pt": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case." + "es": "Si se indica el campo URL, el campo FIXED_AMOUNT debe ser verdadero. No soportamos la modalidad de monto abierto en este caso.", + "pt": "Se o campo URL estiver indicado, o campo FIXED_AMOUNT deve ser verdadeiro. Não suportamos a modalidade de valor aberto nesse caso." } } ] @@ -439,8 +447,8 @@ "title": "1", "description": { "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", - "es": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", - "pt": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user." + "pt": "Se o ponto de venda não existir para o ID ou EXTERNAL_ID indicado e para o usuário.", + "es": "Si el punto de venta no existe para el ID o EXTERNAL_ID indicado y para el usuario." } } ] @@ -501,9 +509,9 @@ "name": "external_id", "in": "query", "description": { - "es": "External ID", - "pt": "External ID", - "en": "External ID" + "en": "Unique identifier of the pos defined by integrator system.", + "pt": "Identificador único da caixa definido pelo sistema integrador.", + "es": "Identificador único de la caja definido por el integrador." }, "required": false, "schema": { @@ -515,9 +523,9 @@ "name": "external_store_id", "in": "query", "description": { - "es": "External Store ID", - "pt": "External Store ID", - "en": "External Store ID" + "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", + "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", + "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." }, "required": false, "schema": { @@ -528,9 +536,9 @@ "name": "store_id", "in": "query", "description": { - "es": "Store ID", - "pt": "Store ID", - "en": "Store ID" + "en": "Store identifier to which the point of sale belongs.", + "pt": "Identificador da loja à qual o ponto de venda pertence.", + "es": "Identificador de la sucursal a la que pertenece el punto de venta." }, "required": false, "schema": { @@ -554,9 +562,9 @@ "responses": { "200": { "description": { - "es": "Success", - "pt": "Success", - "en": "Success" + "en": "Success", + "pt": "Sucesso", + "es": "Éxito" }, "content": { "application/json": { @@ -638,27 +646,27 @@ "type": "string", "example": 1234567, "description": { - "es": "store_id", - "pt": "store_id", - "en": "store_id" + "en": "Store identifier to which the point of sale belongs.", + "pt": "Identificador da loja à qual o ponto de venda pertence.", + "es": "Identificador de la sucursal a la que pertenece el punto de venta." } }, "external_id": { "type": "string", "example": "SUC001POS001", "description": { - "es": "external_id", - "pt": "external_id", - "en": "external_id" + "en": "Unique identifier of the pos defined by integrator system.", + "pt": "Identificador único da caixa definido pelo sistema integrador.", + "es": "Identificador único de la caja definido por el integrador." } }, "id": { "type": "number", "example": 1988157, "description": { - "es": "id", - "pt": "id", - "en": "id" + "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", + "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", + "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." } }, "qr": { @@ -720,9 +728,9 @@ "type": "string", "example": "SUC001", "description": { - "es": "external_store_id", - "pt": "external_store_id", - "en": "external_store_id" + "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", + "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", + "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." } } } @@ -838,9 +846,9 @@ "mp-point" ], "description": { - "en": "Check all the information of a Point of Sale with the ID of the POS you want", - "pt": "Veja toda a informação de um ponto de venda a partir do ID da caixa que você deseja", - "es": "Consulta toda la información de un punto de venta con el ID de la caja que quieras" + "en": "This endpoint allows you to find all the information about the points of sale created using specific filters.", + "pt": "Este endpoint permite encontrar todas as informações das caixas (ponto de venda) criadas utilizando filtros específicos.", + "es": "Este endpoint permite encontrar toda la información de las cajas (puntos de venta) creadas utilizando filtros específicos." }, "parameters": [ { @@ -861,9 +869,9 @@ "responses": { "200": { "description": { - "es": "Success", - "pt": "Success", - "en": "Success" + "en": "Success", + "pt": "Sucesso", + "es": "Éxito" }, "content": { "application/json": { @@ -874,9 +882,9 @@ "type": "string", "example": 1988157, "description": { - "en": "POS identifier, numerical and self-generated.", - "pt": "Identificador exclusivo da caixa, numérico e gerado automaticamente", - "es": "Identificador único de la caja, numérico y autogenerado" + "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", + "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", + "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." } }, "qr": { @@ -971,24 +979,24 @@ "title": "INVALID_POS_ID", "description": { "en": "The ID of the pos is invalid, it must be numeric.", - "es": "The ID of the pos is invalid, it must be numeric.", - "pt": "The ID of the pos is invalid, it must be numeric." + "es": "El ID del punto de venta es inválida, debe ser numérica.", + "pt": "O ID do ponto de venda é inválida, deve ser numérica." } }, { "title": "INVALID_EXTERNAL_ID", "description": { - "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "es": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "pt": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters." + "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces, hyphens or special characters.", + "es": "El campo EXTERNAL_ID debe ser alfanumérico, solo letras y números. Sin espacios, guiones o caracteres especiales.", + "pt": "O campo EXTERNAL_ID deve ser alfanumérico, apenas letras e números. Sem espaços, hífens ou caracteres especiais." } }, { "title": "EXTERNAL_ID_TOO_LONG", "description": { "en": "The EXTERNAL_ID must be less than 40 characters.", - "es": "The EXTERNAL_ID must be less than 40 characters.", - "pt": "The EXTERNAL_ID must be less than 40 characters." + "es": "El EXTERNAL_ID debe ser menor de 40 caracteres.", + "pt": "O EXTERNAL_ID deve ter menos de 40 caracteres." } } ] @@ -1016,8 +1024,8 @@ "title": "1", "description": { "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", - "es": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", - "pt": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user." + "pt": "Se o ponto de venda não existir para o ID ou EXTERNAL_ID indicado e para o usuário.", + "es": "Si el punto de venta no existe para el ID o EXTERNAL_ID indicado y para el usuario." } } ] @@ -1041,8 +1049,8 @@ ], "description": { "en": "This endpoint allows you to update the data of a point of sale. To use it, you need to provide the identification of the point of sale and send the parameters with the information to be updated.", - "pt": "Este endpoint permite atualizar os dados de um ponto de venda (caixa). Para utilizá-lo, é necessário fornecer a identificação do ponto de venda e enviar os parâmetros com as informações a serem atualizadas.", - "es": "Este endpoint permite actualizar los datos de un punto de venta (caja). Para utilizarlo, es necesario proporcionar la identificación del punto de venta y enviar los parámetros con la información que se debe actualizar." + "pt": "Este endpoint permite atualizar os dados de uma caixa (ponto de venda). Para utilizá-lo, é necessário fornecer a identificação do ponto de venda e enviar os parâmetros com as informações a serem atualizadas.", + "es": "Este endpoint permite actualizar los datos de una caja (punto de venta). Para utilizarlo, es necesario proporcionar la identificación del punto de venta y enviar los parámetros con la información que se debe actualizar." }, "parameters": [ { @@ -1070,8 +1078,8 @@ "type": "string", "description": { "en": "Name of the point of sale.", - "pt": "Nome do caixa.", - "es": "Nombre de la caja." + "pt": "Nome da caixa (ponto de venda).", + "es": "Nombre de la caja (punto de venta)." }, "example": "First POS" }, @@ -1099,17 +1107,17 @@ "external_store_id": { "type": "string", "description": { - "es": "External_id of the store to which the pos belongs defined by integrator system.", - "pt": "External_id of the store to which the pos belongs defined by integrator system.", - "en": "External_id of the store to which the pos belongs defined by integrator system." + "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", + "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", + "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." } }, "url": { "type": "string", "description": { - "es": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", - "pt": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", - "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model." + "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", + "pt": "URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.", + "es": "URL para obtener la orden del sistema integrador. Es opcional y se utiliza solo en el modelo de integración desatendido." } } } @@ -1120,9 +1128,9 @@ "responses": { "200": { "description": { - "es": "success", - "pt": "success", - "en": "success" + "en": "Success", + "pt": "Sucesso", + "es": "Éxito" }, "content": { "application/json": { @@ -1133,9 +1141,9 @@ "type": "number", "example": 2711382, "description": { - "es": "id", - "pt": "id", - "en": "id" + "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", + "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", + "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." } }, "qr": { @@ -1245,35 +1253,35 @@ "type": "string", "example": 1234567, "description": { - "es": "store_id", - "pt": "store_id", - "en": "store_id" + "en": "Store identifier to which the point of sale belongs.", + "pt": "Identificador da loja à qual o ponto de venda pertence.", + "es": "Identificador de la sucursal a la que pertenece el punto de venta." } }, "external_store_id": { "type": "string", "example": "SUC001", "description": { - "es": "external_store_id", - "pt": "external_store_id", - "en": "external_store_id" + "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", + "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", + "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." } }, "url": { "type": "string", "description": { - "es": "url", - "pt": "url", - "en": "url" + "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", + "pt": "URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.", + "es": "URL para obtener la orden del sistema integrador. Es opcional y se utiliza solo en el modelo de integración desatendido." } }, "external_id": { "type": "string", "example": "SUC001POS002", "description": { - "es": "external_id", - "pt": "external_id", - "en": "external_id" + "en": "Unique identifier of the pos defined by integrator system.", + "pt": "Identificador único da caixa definido pelo sistema integrador.", + "es": "Identificador único de la caja definido por el integrador." } }, "site": { @@ -1492,7 +1500,7 @@ { "title": "1", "description": { - "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and to the user.", + "en": "If the point of sale does not exist for an indicated ID or EXTERNAL_ID and to the user.", "es": "Si el punto de venta no existe para un ID o EXTERNAL_ID indicado y para el usuario.", "pt": "Se o ponto de venda não existir para um ID ou EXTERNAL_ID indicado e para o usuário." } @@ -1535,7 +1543,7 @@ } }, "title": { - "en": "Update POS", + "en": "Update point of sale", "pt": "Atualizar caixa", "es": "Actualizar caja" } @@ -1546,9 +1554,9 @@ "mp-point" ], "description": { - "en": "Delete a point of sale whenever you need it with the ID of the POS", - "pt": "Exclua um ponto de venda sempre que for necessário com o ID da caixa", - "es": "Elimina un punto de venta siempre que lo necesites con el ID de la caja" + "en": "This endpoint allows the deletion of a specific point of sale, identified by its ID.", + "pt": "Este endpoint permite a exclusão de uma caixa (ponto de venda) específica, identificada pelo seu ID.", + "es": "Este endpoint permite la eliminación de una caja (punto de venta) específica, identificada por su ID." }, "parameters": [ { @@ -1586,7 +1594,7 @@ "description": { "en": "The ID of the pos is invalid, it must be numeric.", "es": "El ID del punto de venta es inválida, debe ser numérica.", - "pt": "O ID do ponto de venda é inválida, deve ser numérica." + "pt": "O ID do ponto de venda é inválido, deve ser numérica." } } ] @@ -1614,8 +1622,8 @@ "title": "1", "description": { "en": "If there is no pos for the indicated ID and user.", - "es": "If there is no pos for the indicated ID and user.", - "pt": "If there is no pos for the indicated ID and user." + "es": "Si no hay punto de venta para el ID y el usuario indicados.", + "pt": "Se não houver ponto de venda para o ID e o usuário indicados." } } ] @@ -1627,7 +1635,7 @@ } }, "title": { - "en": "Delete POS", + "en": "Delete point of sale", "pt": "Excluir caixa", "es": "Eliminar caja" } diff --git a/reference/api-json/pos.json b/reference/api-json/pos.json index 192fc55c25..07bf5b5d18 100644 --- a/reference/api-json/pos.json +++ b/reference/api-json/pos.json @@ -48,9 +48,9 @@ "external_store_id": { "type": "string", "description": { - "en": "External_id of the store to which the pos belongs defined by integrator system.", - "pt": "External_id of the store to which the pos belongs defined by integrator system.", - "es": "External_id of the store to which the pos belongs defined by integrator system." + "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", + "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", + "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." }, "example": "SUC001" }, @@ -82,9 +82,9 @@ "responses": { "200": { "description": { - "es": "Success", - "pt": "Success", - "en": "Success" + "en": "Success", + "pt": "Sucesso", + "es": "Éxito" }, "content": { "application/json": { @@ -95,9 +95,9 @@ "type": "number", "example": 2711382, "description": { - "es": "id", - "pt": "id", - "en": "id" + "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", + "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", + "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." } }, "qr": { @@ -150,54 +150,54 @@ "type": "string", "example": "2019-08-22T14:11:12.000Z", "description": { - "es": "date_created", - "pt": "date_created", - "en": "date_created" + "en": "Point of sale creation date. This field displays the date and time in ISO 8601 format, such as 2024-08-08T19:29:45.019Z.", + "pt": "Data de criação da caixa. Este campo exibe a data e hora no formato ISO 8601, como 2024-08-08T19:29:45.019Z.", + "es": "Fecha de creación de la caja. Este campo muestra la fecha y hora en el formato ISO 8601, como 2024-08-08T19:29:45.019Z." } }, "date_last_updated": { "type": "string", - "example": "2019-08-22T14:11:12.000Z", + "example": "2019-08-25T15:16:12.000Z", "description": { - "es": "date_last_updated", - "pt": "date_last_updated", - "en": "date_last_updated" + "en": "Date of last modification of the cash register data. This field displays the date and time in ISO 8601 format, such as 2024-08-08T19:29:45.019Z.", + "pt": "Data de ultima alteração nos dados da caixa. Este campo exibe a data e hora no formato ISO 8601, como 2024-08-08T19:29:45.019Z.", + "es": "Fecha de última modificación en los datos de la caja. Este campo muestra la fecha y hora en el formato ISO 8601, como 2024-08-08T19:29:45.019Z." } }, "uuid": { "type": "string", "example": "0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1", "description": { - "es": "uuid", - "pt": "uuid", - "en": "uuid" + "en": "The UUID (Universally Unique Identifier) is a 128-bit number used to identify information. In this case, it is the identification number of the QR Code in question.", + "pt": "O UUID (Identificador Único Universal) é um número de 128 bits usado para identificar informações. Neste caso, trata-se do número de identificação do Código QR em questão.", + "es": "El UUID (Identificador Único Universal) es un número de 128 bits utilizado para identificar información. En este caso, se trata del número de identificación del Código QR en cuestión." } }, "user_id": { "type": "number", "example": 446566691, "description": { - "es": "user_id", - "pt": "user_id", - "en": "user_id" + "en": "The user_id corresponds to the collector_id. It refers to the user_id of the Mercado Pago account that receives the money from sales, that is, the account responsible for collecting the funds.", + "pt": "O user_id corresponde ao collector_id. Trata-se do user_id da conta do Mercado Pago que recebe o dinheiro das vendas, ou seja, a conta responsável pela arrecadação dos valores.", + "es": "El user_id corresponde al collector_id. Se trata del user_id de la cuenta de Mercado Pago que recibe el dinero de las ventas, es decir, la cuenta encargada de recaudar los fondos." } }, "name": { "type": "string", "example": "First POS", "description": { - "es": "name", - "pt": "name", - "en": "name" + "en": "Name of the point of sale.", + "pt": "Nome do ponto de venda.", + "es": "Nombre del punto de venta." } }, "fixed_amount": { "type": "boolean", "example": false, "description": { - "es": "fixed_amount", - "pt": "fixed_amount", - "en": "fixed_amount" + "en": "Define if the customer can insert the amount to be paid.", + "pt": "Determine se o cliente pode inserir o valor a ser pago.", + "es": "Determina si el cliente puede insertar el monto a pagar." } }, "category": { @@ -207,35 +207,35 @@ "type": "string", "example": 1234567, "description": { - "es": "store_id", - "pt": "store_id", - "en": "store_id" + "en": "Store identifier to which the point of sale belongs.", + "pt": "Identificador da loja à qual o ponto de venda pertence.", + "es": "Identificador de la sucursal a la que pertenece el punto de venta." } }, "external_store_id": { "type": "string", "example": "SUC001", "description": { - "es": "external_store_id", - "pt": "external_store_id", - "en": "external_store_id" + "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", + "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", + "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." } }, "url": { "type": "string", "description": { - "es": "url", - "pt": "url", - "en": "url" + "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", + "pt": "URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.", + "es": "URL para obtener la orden del sistema integrador. Es opcional y se utiliza solo en el modelo de integración desatendido." } }, "external_id": { "type": "string", "example": "SUC001POS001", "description": { - "es": "external_id", - "pt": "external_id", - "en": "external_id" + "en": "Unique identifier of the pos defined by integrator system.", + "pt": "Identificador único da caixa definido pelo sistema integrador.", + "es": "Identificador único de la caja definido por el integrador." } } } @@ -260,129 +260,137 @@ { "title": "MISSING_BODY", "description": { - "en": "HTTP body is required to create pos.", - "es": "HTTP body is required to create pos.", - "pt": "HTTP body is required to create pos." + "en": "HTTP body is required to modify pos.", + "es": "El cuerpo del HTTP es requerido para modificar el punto de venta.", + "pt": "O corpo do HTTP é necessário para modificar o ponto de venda." } }, { "title": "UNKNOWN_FIELD_EXCEPTION", "description": { "en": "The indicated field is not allowed for this operation or is unknown.", - "es": "The indicated field is not allowed for this operation or is unknown.", - "pt": "The indicated field is not allowed for this operation or is unknown." + "es": "El campo indicado no está permitido para esta operación o es desconocido.", + "pt": "O campo indicado não é permitido para esta operação ou é desconhecido." + } + }, + { + "title": "INVALID_POS_ID", + "description": { + "en": "The ID of the pos is invalid, it must be numeric.", + "es": "El ID del punto de venta es inválida, debe ser numérica.", + "pt": "O ID do ponto de venda é inválida, deve ser numérica." } }, { "title": "INVALID_NAME", "description": { "en": "NAME must be string.", - "es": "NAME must be string.", - "pt": "NAME must be string." + "es": "NOMBRE debe ser string.", + "pt": "NAME deve ser string." } }, { "title": "NAME_TOO_LONG", "description": { "en": "The NAME must be less than 45 characters.", - "es": "The NAME must be less than 45 characters.", - "pt": "The NAME must be less than 45 characters." + "es": "NAME debe ser menor de 45 caracteres.", + "pt": "NAME deve ter menos de 45 caracteres." } }, { "title": "INVALID_FIXED_AMOUNT", "description": { "en": "FIXED_AMOUNT must be boolean.", - "es": "FIXED_AMOUNT must be boolean.", - "pt": "FIXED_AMOUNT must be boolean." + "es": "FIXED_AMOUNT debe ser boolean.", + "pt": "FIXED_AMOUNT deve ser boolean." } }, { "title": "INVALID_CATEGORY", "description": { "en": "CATEGORY must be numeric.", - "es": "CATEGORY must be numeric.", - "pt": "CATEGORY must be numeric." + "es": "CATEGORY debe ser numérico.", + "pt": "CATEGORY deve ser numérico." } }, { - "title": "UNKNOWN_MCC", + "title": "POS_UNKNOWN_MCC", "description": { - "en": "The CATEGORY must be valid for the user's site.", - "es": "The CATEGORY must be valid for the user's site.", - "pt": "The CATEGORY must be valid for the user's site." + "en": "CATEGORY must be valid for the user's site.", + "es": "CATEGORY debe ser válida para el sitio del usuario.", + "pt": "CATEGORY deve ser válida para o site do usuário." } }, { - "title": "INVALID_STORE_ID", + "title": "POS_INVALID_STORE_ID", "description": { "en": "STORE_ID must be numeric.", - "es": "STORE_ID must be numeric.", - "pt": "STORE_ID must be numeric." + "es": "STORE_ID debe ser numérico.", + "pt": "STORE_ID deve ser numérico." } }, { "title": "INVALID_EXTERNAL_STORE_ID", "description": { - "en": "EXTERNAL_STORE_ID muste be string.", - "es": "EXTERNAL_STORE_ID muste be string.", - "pt": "EXTERNAL_STORE_ID muste be string." + "en": "EXTERNAL_STORE_ID must be string.", + "es": "EXTERNAL_STORE_ID debe ser string.", + "pt": "EXTERNAL_STORE_ID deve ser string." } }, { "title": "EXTERNAL_STORE_ID_NOT_MATCH", "description": { "en": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID.", - "es": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID.", - "pt": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID." + "es": "El EXTERNAL_STORE_ID no hace referencia al STORE_ID indicado.", + "pt": "O EXTERNAL_STORE_ID não se refere ao STORE_ID indicado." } }, { "title": "INEXISTENT_EXTERNAL_STORE_ID", "description": { - "en": "The EXTERNAL_STORE_ID does not refer to any existing store.", - "es": "The EXTERNAL_STORE_ID does not refer to any existing store.", - "pt": "The EXTERNAL_STORE_ID does not refer to any existing store." + "en": "The EXTERNAL STORE_ID does not refer to an existing Store.", + "es": "El EXTERNAL_STORE_ID no hace referencia a una tienda existente.", + "pt": "O EXTERNAL_STORE_ID não se refere a uma loja existente." } }, { "title": "INVALID_EXTERNAL_ID", "description": { - "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "es": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "pt": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters." + "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces, hyphens or special characters.", + "es": "El campo EXTERNAL_ID debe ser alfanumérico, solo letras y números. Sin espacios, guiones o caracteres especiales.", + "pt": "O campo EXTERNAL_ID deve ser alfanumérico, apenas letras e números. Sem espaços, hífens ou caracteres especiais." } }, { "title": "EXTERNAL_ID_TOO_LONG", "description": { "en": "The EXTERNAL_ID must be less than 40 characters.", - "es": "The EXTERNAL_ID must be less than 40 characters.", - "pt": "The EXTERNAL_ID must be less than 40 characters." + "es": "El EXTERNAL_ID debe ser menor de 40 caracteres.", + "pt": "O EXTERNAL_ID deve ter menos de 40 caracteres." } }, { "title": "INVALID_URL", "description": { "en": "The URL must be string and muste have the format of a valid url", - "es": "The URL must be string and muste have the format of a valid url", - "pt": "The URL must be string and muste have the format of a valid url" + "es": "La URL debe ser una cadena y debe tener el formato de una URL válida.", + "pt": "A URL deve ser uma string e deve ter o formato de uma URL válida." } }, { "title": "URL_TOO_LONG", "description": { "en": "The URL must be less than 300 characters.", - "es": "The URL must be less than 300 characters.", - "pt": "The URL must be less than 300 characters." + "es": "La URL debe ser menor de 300 caracteres.", + "pt": "A URL deve ter menos de 300 caracteres." } }, { "title": "FIXED_AMOUNT_FALSE", "description": { "en": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case.", - "es": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case.", - "pt": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case." + "es": "Si se indica el campo URL, el campo FIXED_AMOUNT debe ser verdadero. No soportamos la modalidad de monto abierto en este caso.", + "pt": "Se o campo URL estiver indicado, o campo FIXED_AMOUNT deve ser verdadeiro. Não suportamos a modalidade de valor aberto nesse caso." } } ] @@ -439,8 +447,8 @@ "title": "1", "description": { "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", - "es": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", - "pt": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user." + "pt": "Se o ponto de venda não existir para o ID ou EXTERNAL_ID indicado e para o usuário.", + "es": "Si el punto de venta no existe para el ID o EXTERNAL_ID indicado y para el usuario." } } ] @@ -501,9 +509,9 @@ "name": "external_id", "in": "query", "description": { - "es": "External ID", - "pt": "External ID", - "en": "External ID" + "en": "Unique identifier of the pos defined by integrator system.", + "pt": "Identificador único da caixa definido pelo sistema integrador.", + "es": "Identificador único de la caja definido por el integrador." }, "required": false, "schema": { @@ -515,9 +523,9 @@ "name": "external_store_id", "in": "query", "description": { - "es": "External Store ID", - "pt": "External Store ID", - "en": "External Store ID" + "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", + "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", + "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." }, "required": false, "schema": { @@ -528,9 +536,9 @@ "name": "store_id", "in": "query", "description": { - "es": "Store ID", - "pt": "Store ID", - "en": "Store ID" + "en": "Store identifier to which the point of sale belongs.", + "pt": "Identificador da loja à qual o ponto de venda pertence.", + "es": "Identificador de la sucursal a la que pertenece el punto de venta." }, "required": false, "schema": { @@ -554,9 +562,9 @@ "responses": { "200": { "description": { - "es": "Success", - "pt": "Success", - "en": "Success" + "en": "Success", + "pt": "Sucesso", + "es": "Éxito" }, "content": { "application/json": { @@ -609,9 +617,9 @@ "type": "number", "example": 446566691, "description": { - "es": "user_id", - "pt": "user_id", - "en": "user_id" + "en": "The user_id corresponds to the collector_id. It refers to the user_id of the Mercado Pago account that receives the money from sales, that is, the account responsible for collecting the funds.", + "pt": "O user_id corresponde ao collector_id. Trata-se do user_id da conta do Mercado Pago que recebe o dinheiro das vendas, ou seja, a conta responsável pela arrecadação dos valores.", + "es": "El user_id corresponde al collector_id. Se trata del user_id de la cuenta de Mercado Pago que recibe el dinero de las ventas, es decir, la cuenta encargada de recaudar los fondos." } }, "name": { @@ -638,27 +646,27 @@ "type": "string", "example": 1234567, "description": { - "es": "store_id", - "pt": "store_id", - "en": "store_id" + "en": "Store identifier to which the point of sale belongs.", + "pt": "Identificador da loja à qual o ponto de venda pertence.", + "es": "Identificador de la sucursal a la que pertenece el punto de venta." } }, "external_id": { "type": "string", "example": "SUC001POS001", "description": { - "es": "external_id", - "pt": "external_id", - "en": "external_id" + "en": "Unique identifier of the pos defined by integrator system.", + "pt": "Identificador único da caixa definido pelo sistema integrador.", + "es": "Identificador único de la caja definido por el integrador." } }, "id": { "type": "number", "example": 1988157, "description": { - "es": "id", - "pt": "id", - "en": "id" + "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", + "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", + "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." } }, "qr": { @@ -702,27 +710,27 @@ "type": "string", "example": "2019-06-24T13:31:56.000Z", "description": { - "es": "date_created", - "pt": "date_created", - "en": "date_created" + "en": "Point of sale creation date. This field displays the date and time in ISO 8601 format, such as 2024-08-08T19:29:45.019Z.", + "pt": "Data de criação da caixa. Este campo exibe a data e hora no formato ISO 8601, como 2024-08-08T19:29:45.019Z.", + "es": "Fecha de creación de la caja. Este campo muestra la fecha y hora en el formato ISO 8601, como 2024-08-08T19:29:45.019Z." } }, "date_last_updated": { "type": "string", - "example": "2019-08-07T21:07:26.000Z", + "example": "2019-08-25T15:16:12.000Z", "description": { - "es": "date_last_updated", - "pt": "date_last_updated", - "en": "date_last_updated" + "en": "Date of last modification of the cash register data. This field displays the date and time in ISO 8601 format, such as 2024-08-08T19:29:45.019Z.", + "pt": "Data de ultima alteração nos dados da caixa. Este campo exibe a data e hora no formato ISO 8601, como 2024-08-08T19:29:45.019Z.", + "es": "Fecha de última modificación en los datos de la caja. Este campo muestra la fecha y hora en el formato ISO 8601, como 2024-08-08T19:29:45.019Z." } }, "external_store_id": { "type": "string", "example": "SUC001", "description": { - "es": "external_store_id", - "pt": "external_store_id", - "en": "external_store_id" + "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", + "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", + "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." } } } @@ -838,9 +846,9 @@ "mp-point" ], "description": { - "en": "Check all the information of a Point of Sale with the ID of the POS you want", - "pt": "Veja toda a informação de um ponto de venda a partir do ID da caixa que você deseja", - "es": "Consulta toda la información de un punto de venta con el ID de la caja que quieras" + "en": "This endpoint allows you to find all the information about the points of sale created using specific filters.", + "pt": "Este endpoint permite encontrar todas as informações das caixas (ponto de venda) criadas utilizando filtros específicos.", + "es": "Este endpoint permite encontrar toda la información de las cajas (puntos de venta) creadas utilizando filtros específicos." }, "parameters": [ { @@ -861,9 +869,9 @@ "responses": { "200": { "description": { - "es": "Success", - "pt": "Success", - "en": "Success" + "en": "Success", + "pt": "Sucesso", + "es": "Éxito" }, "content": { "application/json": { @@ -874,9 +882,9 @@ "type": "string", "example": 1988157, "description": { - "en": "POS identifier, numerical and self-generated.", - "pt": "Identificador exclusivo da caixa, numérico e gerado automaticamente", - "es": "Identificador único de la caja, numérico y autogenerado" + "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", + "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", + "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." } }, "qr": { @@ -902,15 +910,30 @@ }, "date_created": { "type": "string", - "example": "2019-09-03T13:13:54.000-04:00" + "example": "2019-09-03T13:13:54.000-04:00", + "description": { + "en": "Point of sale creation date. This field displays the date and time in ISO 8601 format, such as 2024-08-08T19:29:45.019Z.", + "pt": "Data de criação da caixa. Este campo exibe a data e hora no formato ISO 8601, como 2024-08-08T19:29:45.019Z.", + "es": "Fecha de creación de la caja. Este campo muestra la fecha y hora en el formato ISO 8601, como 2024-08-08T19:29:45.019Z." + } }, "date_last_updated": { "type": "string", - "example": "2020-09-30T08:38:58.000-04:00" + "example": "2019-10-25T15:16:12.000Z", + "description": { + "en": "Date of last modification of the cash register data. This field displays the date and time in ISO 8601 format, such as 2024-08-08T19:29:45.019Z.", + "pt": "Data de ultima alteração nos dados da caixa. Este campo exibe a data e hora no formato ISO 8601, como 2024-08-08T19:29:45.019Z.", + "es": "Fecha de última modificación en los datos de la caja. Este campo muestra la fecha y hora en el formato ISO 8601, como 2024-08-08T19:29:45.019Z." + } }, "uuid": { "type": "string", - "example": "c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68" + "example": "c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68", + "description": { + "en": "The UUID (Universally Unique Identifier) is a 128-bit number used to identify information. In this case, it is the identification number of the QR Code in question.", + "pt": "O UUID (Identificador Único Universal) é um número de 128 bits usado para identificar informações. Neste caso, trata-se do número de identificação do Código QR em questão.", + "es": "El UUID (Identificador Único Universal) es un número de 128 bits utilizado para identificar información. En este caso, se trata del número de identificación del Código QR en cuestión." + } }, "compatible_id": { "type": "string", @@ -918,27 +941,57 @@ }, "user_id": { "type": "number", - "example": 329653108 + "example": 329653108, + "description": { + "en": "The user_id corresponds to the collector_id. It refers to the user_id of the Mercado Pago account that receives the money from sales, that is, the account responsible for collecting the funds.", + "pt": "O user_id corresponde ao collector_id. Trata-se do user_id da conta do Mercado Pago que recebe o dinheiro das vendas, ou seja, a conta responsável pela arrecadação dos valores.", + "es": "El user_id corresponde al collector_id. Se trata del user_id de la cuenta de Mercado Pago que recibe el dinero de las ventas, es decir, la cuenta encargada de recaudar los fondos." + } }, "name": { "type": "string", - "example": "POS001" + "example": "POS001", + "description": { + "en": "Name of the point of sale.", + "pt": "Nome do ponto de venda.", + "es": "Nombre del punto de venta." + } }, "fixed_amount": { "type": "boolean", - "example": false + "example": false, + "description": { + "en": "Define if the customer can insert the amount to be paid.", + "pt": "Determine se o cliente pode inserir o valor a ser pago.", + "es": "Determina si el cliente puede insertar el monto a pagar." + } }, "store_id": { "type": "string", - "example": 56807753 + "example": 56807753, + "description": { + "en": "Store identifier to which the point of sale belongs.", + "pt": "Identificador da loja à qual o ponto de venda pertence.", + "es": "Identificador de la sucursal a la que pertenece el punto de venta." + } }, "external_store_id": { "type": "string", - "example": "SUC01" + "example": "SUC01", + "description": { + "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", + "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", + "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." + } }, "external_id": { "type": "string", - "example": "SUC001POS002" + "example": "SUC001POS002", + "description": { + "en": "Unique identifier of the pos defined by integrator system.", + "pt": "Identificador único da caixa definido pelo sistema integrador.", + "es": "Identificador único de la caja definido por el integrador." + } }, "site": { "type": "string", @@ -971,24 +1024,24 @@ "title": "INVALID_POS_ID", "description": { "en": "The ID of the pos is invalid, it must be numeric.", - "es": "The ID of the pos is invalid, it must be numeric.", - "pt": "The ID of the pos is invalid, it must be numeric." + "es": "El ID del punto de venta es inválida, debe ser numérica.", + "pt": "O ID do ponto de venda é inválida, deve ser numérica." } }, { "title": "INVALID_EXTERNAL_ID", "description": { - "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "es": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "pt": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters." + "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces, hyphens or special characters.", + "es": "El campo EXTERNAL_ID debe ser alfanumérico, solo letras y números. Sin espacios, guiones o caracteres especiales.", + "pt": "O campo EXTERNAL_ID deve ser alfanumérico, apenas letras e números. Sem espaços, hífens ou caracteres especiais." } }, { "title": "EXTERNAL_ID_TOO_LONG", "description": { "en": "The EXTERNAL_ID must be less than 40 characters.", - "es": "The EXTERNAL_ID must be less than 40 characters.", - "pt": "The EXTERNAL_ID must be less than 40 characters." + "es": "El EXTERNAL_ID debe ser menor de 40 caracteres.", + "pt": "O EXTERNAL_ID deve ter menos de 40 caracteres." } } ] @@ -1016,8 +1069,8 @@ "title": "1", "description": { "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", - "es": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", - "pt": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user." + "pt": "Se o ponto de venda não existir para o ID ou EXTERNAL_ID indicado e para o usuário.", + "es": "Si el punto de venta no existe para el ID o EXTERNAL_ID indicado y para el usuario." } } ] @@ -1041,8 +1094,8 @@ ], "description": { "en": "This endpoint allows you to update the data of a point of sale. To use it, you need to provide the identification of the point of sale and send the parameters with the information to be updated.", - "pt": "Este endpoint permite atualizar os dados de um ponto de venda (caixa). Para utilizá-lo, é necessário fornecer a identificação do ponto de venda e enviar os parâmetros com as informações a serem atualizadas.", - "es": "Este endpoint permite actualizar los datos de un punto de venta (caja). Para utilizarlo, es necesario proporcionar la identificación del punto de venta y enviar los parámetros con la información que se debe actualizar." + "pt": "Este endpoint permite atualizar os dados de uma caixa (ponto de venda). Para utilizá-lo, é necessário fornecer a identificação do ponto de venda e enviar os parâmetros com as informações a serem atualizadas.", + "es": "Este endpoint permite actualizar los datos de una caja (punto de venta). Para utilizarlo, es necesario proporcionar la identificación del punto de venta y enviar los parámetros con la información que se debe actualizar." }, "parameters": [ { @@ -1070,8 +1123,8 @@ "type": "string", "description": { "en": "Name of the point of sale.", - "pt": "Nome do caixa.", - "es": "Nombre de la caja." + "pt": "Nome da caixa (ponto de venda).", + "es": "Nombre de la caja (punto de venta)." }, "example": "First POS" }, @@ -1099,17 +1152,17 @@ "external_store_id": { "type": "string", "description": { - "es": "External_id of the store to which the pos belongs defined by integrator system.", - "pt": "External_id of the store to which the pos belongs defined by integrator system.", - "en": "External_id of the store to which the pos belongs defined by integrator system." + "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", + "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", + "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." } }, "url": { "type": "string", "description": { - "es": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", - "pt": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", - "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model." + "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", + "pt": "URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.", + "es": "URL para obtener la orden del sistema integrador. Es opcional y se utiliza solo en el modelo de integración desatendido." } } } @@ -1120,9 +1173,9 @@ "responses": { "200": { "description": { - "es": "success", - "pt": "success", - "en": "success" + "en": "Success", + "pt": "Sucesso", + "es": "Éxito" }, "content": { "application/json": { @@ -1133,9 +1186,9 @@ "type": "number", "example": 2711382, "description": { - "es": "id", - "pt": "id", - "en": "id" + "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", + "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", + "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." } }, "qr": { @@ -1188,54 +1241,54 @@ "type": "string", "example": "2019-08-22T14:11:12.000Z", "description": { - "es": "date_created", - "pt": "date_created", - "en": "date_created" + "en": "Point of sale creation date. This field displays the date and time in ISO 8601 format, such as 2024-08-08T19:29:45.019Z.", + "pt": "Data de criação da caixa. Este campo exibe a data e hora no formato ISO 8601, como 2024-08-08T19:29:45.019Z.", + "es": "Fecha de creación de la caja. Este campo muestra la fecha y hora en el formato ISO 8601, como 2024-08-08T19:29:45.019Z." } }, "date_last_updated": { "type": "string", - "example": "2019-08-22T14:11:12.000Z", + "example": "2019-08-25T15:16:12.000Z", "description": { - "es": "date_last_updated", - "pt": "date_last_updated", - "en": "date_last_updated" + "en": "Date of last modification of the cash register data. This field displays the date and time in ISO 8601 format, such as 2024-08-08T19:29:45.019Z.", + "pt": "Data de ultima alteração nos dados da caixa. Este campo exibe a data e hora no formato ISO 8601, como 2024-08-08T19:29:45.019Z.", + "es": "Fecha de última modificación en los datos de la caja. Este campo muestra la fecha y hora en el formato ISO 8601, como 2024-08-08T19:29:45.019Z." } }, "uuid": { "type": "string", "example": "0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1", "description": { - "es": "uuid", - "pt": "uuid", - "en": "uuid" + "en": "The UUID (Universally Unique Identifier) is a 128-bit number used to identify information. In this case, it is the identification number of the QR Code in question.", + "pt": "O UUID (Identificador Único Universal) é um número de 128 bits usado para identificar informações. Neste caso, trata-se do número de identificação do Código QR em questão.", + "es": "El UUID (Identificador Único Universal) es un número de 128 bits utilizado para identificar información. En este caso, se trata del número de identificación del Código QR en cuestión." } }, "user_id": { "type": "number", "example": 446566691, "description": { - "es": "user_id", - "pt": "user_id", - "en": "user_id" + "en": "The user_id corresponds to the collector_id. It refers to the user_id of the Mercado Pago account that receives the money from sales, that is, the account responsible for collecting the funds.", + "pt": "O user_id corresponde ao collector_id. Trata-se do user_id da conta do Mercado Pago que recebe o dinheiro das vendas, ou seja, a conta responsável pela arrecadação dos valores.", + "es": "El user_id corresponde al collector_id. Se trata del user_id de la cuenta de Mercado Pago que recibe el dinero de las ventas, es decir, la cuenta encargada de recaudar los fondos." } }, "name": { "type": "string", "example": "First POS", "description": { - "es": "name", - "pt": "name", - "en": "name" + "en": "Name of the point of sale.", + "pt": "Nome do ponto de venda.", + "es": "Nombre del punto de venta." } }, "fixed_amount": { "type": "boolean", "example": false, "description": { - "es": "fixed_amount", - "pt": "fixed_amount", - "en": "fixed_amount" + "en": "Define if the customer can insert the amount to be paid.", + "pt": "Determine se o cliente pode inserir o valor a ser pago.", + "es": "Determina si el cliente puede insertar el monto a pagar." } }, "category": { @@ -1245,35 +1298,35 @@ "type": "string", "example": 1234567, "description": { - "es": "store_id", - "pt": "store_id", - "en": "store_id" + "en": "Store identifier to which the point of sale belongs.", + "pt": "Identificador da loja à qual o ponto de venda pertence.", + "es": "Identificador de la sucursal a la que pertenece el punto de venta." } }, "external_store_id": { "type": "string", "example": "SUC001", "description": { - "es": "external_store_id", - "pt": "external_store_id", - "en": "external_store_id" + "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", + "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", + "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." } }, "url": { "type": "string", "description": { - "es": "url", - "pt": "url", - "en": "url" + "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", + "pt": "URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.", + "es": "URL para obtener la orden del sistema integrador. Es opcional y se utiliza solo en el modelo de integración desatendido." } }, "external_id": { "type": "string", "example": "SUC001POS002", "description": { - "es": "external_id", - "pt": "external_id", - "en": "external_id" + "en": "Unique identifier of the pos defined by integrator system.", + "pt": "Identificador único da caixa definido pelo sistema integrador.", + "es": "Identificador único de la caja definido por el integrador." } }, "site": { @@ -1492,7 +1545,7 @@ { "title": "1", "description": { - "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and to the user.", + "en": "If the point of sale does not exist for an indicated ID or EXTERNAL_ID and to the user.", "es": "Si el punto de venta no existe para un ID o EXTERNAL_ID indicado y para el usuario.", "pt": "Se o ponto de venda não existir para um ID ou EXTERNAL_ID indicado e para o usuário." } @@ -1535,7 +1588,7 @@ } }, "title": { - "en": "Update POS", + "en": "Update point of sale", "pt": "Atualizar caixa", "es": "Actualizar caja" } @@ -1546,9 +1599,9 @@ "mp-point" ], "description": { - "en": "Delete a point of sale whenever you need it with the ID of the POS", - "pt": "Exclua um ponto de venda sempre que for necessário com o ID da caixa", - "es": "Elimina un punto de venta siempre que lo necesites con el ID de la caja" + "en": "This endpoint allows the deletion of a specific point of sale, identified by its ID.", + "pt": "Este endpoint permite a exclusão de uma caixa (ponto de venda) específica, identificada pelo seu ID.", + "es": "Este endpoint permite la eliminación de una caja (punto de venta) específica, identificada por su ID." }, "parameters": [ { @@ -1586,7 +1639,7 @@ "description": { "en": "The ID of the pos is invalid, it must be numeric.", "es": "El ID del punto de venta es inválida, debe ser numérica.", - "pt": "O ID do ponto de venda é inválida, deve ser numérica." + "pt": "O ID do ponto de venda é inválido, deve ser numérica." } } ] @@ -1614,8 +1667,8 @@ "title": "1", "description": { "en": "If there is no pos for the indicated ID and user.", - "es": "If there is no pos for the indicated ID and user.", - "pt": "If there is no pos for the indicated ID and user." + "es": "Si no hay punto de venta para el ID y el usuario indicados.", + "pt": "Se não houver ponto de venda para o ID e o usuário indicados." } } ] @@ -1627,7 +1680,7 @@ } }, "title": { - "en": "Delete POS", + "en": "Delete point of sale", "pt": "Excluir caixa", "es": "Eliminar caja" } From fb64025453d552e72bcd38161a1a838390872dfc Mon Sep 17 00:00:00 2001 From: hgaldino Date: Fri, 2 Aug 2024 15:35:08 -0300 Subject: [PATCH 19/20] finalfinalfinal --- reference/api-json/pos.json | 297 ++++++++++++++++++++---------------- 1 file changed, 166 insertions(+), 131 deletions(-) diff --git a/reference/api-json/pos.json b/reference/api-json/pos.json index 07bf5b5d18..306144a873 100644 --- a/reference/api-json/pos.json +++ b/reference/api-json/pos.json @@ -8,9 +8,9 @@ "mp-point" ], "description": { - "en": "Generate a point of sale in a store. Each POS will have a unique QR Code linked to it", - "pt": "Gerar um ponto de venda em uma loja. Cada caixa registradora terá um código QR exclusivo vinculado a ela", - "es": "Genera un punto de venta en una sucursal. Cada caja tendrá vinculado un código QR unívoco" + "en": "This endpoint allows for the creation of a point of sale in a store to receive payments for products or services. Each point of sale will have a unique QR code linked to it", + "pt": "Este endpoint possibilita a criação de uma caixa (ponto de venda) em uma loja para o recebimento das vendas de produtos ou serviços. Cada caixa terá um código QR exclusivo vinculado a ela", + "es": "Este endpoint permite la creación de una caja (punto de venta) en una tienda para recibir las ventas de productos o servicios. Cada caja tendrá un código QR exclusivo vinculado a ella" }, "requestBody": { "content": { @@ -57,7 +57,7 @@ "external_id": { "type": "string", "description": { - "en": "Unique identifier of the pos defined by integrator system.", + "en": "Unique identifier of the point of sale defined by integrator system.", "pt": "Identificador único da caixa definido pelo sistema integrador.", "es": "Identificador único de la caja definido por el integrador." }, @@ -107,43 +107,43 @@ "type": "string", "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", "description": { - "es": "image", - "pt": "image", - "en": "image" + "en": "URL of the image of the QR code to be used for receiving payments.", + "pt": "URL da imagem do código QR a ser utilizado para receber pagamentos.", + "es": "URL de la imagen del código QR que se utilizará para recibir pagos." } }, "template_document": { "type": "string", "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.pdf", "description": { - "es": "template_document", - "pt": "template_document", - "en": "template_document" + "en": "URL of the file (in PDF format) of the template containing the QR code to be used for receiving payments.", + "pt": "URL do arquivo (em formato PDF) do template com o código QR a ser utilizado para receber pagamentos.", + "es": "URL del archivo (en formato PDF) de la plantilla con el código QR que se utilizará para recibir pagos." } }, "template_image": { "type": "string", "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", - "description": { - "es": "template_image", - "pt": "template_image", - "en": "template_image" + "description": { + "en": "URL of the file (in image format) of the template containing the QR code to be used for receiving payments.", + "pt": "URL do arquivo (em formato de imagem) do template com o código QR a ser utilizado para receber pagamentos.", + "es": "URL del archivo (en formato de imagen) de la plantilla con el código QR que se utilizará para recibir pagos." } } }, "description": { - "es": "qr", - "pt": "qr", - "en": "qr" + "en": "QR code automatically created to receive payments from the point of sale.", + "pt": "Código QR criado automaticamente para receber os pagamentos do ponto de venda.", + "es": "Código QR creado automáticamente para recibir los pagos del punto de venta." } }, "status": { "type": "string", "example": "active", "description": { - "es": "status", - "pt": "status", - "en": "status" + "en": "Status of the point of sale creation.", + "pt": "Status de criação do ponto de venda.", + "es": "Status de creación del punto de venta." } }, "date_created": { @@ -233,7 +233,7 @@ "type": "string", "example": "SUC001POS001", "description": { - "en": "Unique identifier of the pos defined by integrator system.", + "en": "Unique identifier of the point of sale defined by integrator system.", "pt": "Identificador único da caixa definido pelo sistema integrador.", "es": "Identificador único de la caja definido por el integrador." } @@ -260,7 +260,7 @@ { "title": "MISSING_BODY", "description": { - "en": "HTTP body is required to modify pos.", + "en": "HTTP body is required to modify point of sale.", "es": "El cuerpo del HTTP es requerido para modificar el punto de venta.", "pt": "O corpo do HTTP é necessário para modificar o ponto de venda." } @@ -276,7 +276,7 @@ { "title": "INVALID_POS_ID", "description": { - "en": "The ID of the pos is invalid, it must be numeric.", + "en": "The ID of the point of sale is invalid, it must be numeric.", "es": "El ID del punto de venta es inválida, debe ser numérica.", "pt": "O ID do ponto de venda é inválida, deve ser numérica." } @@ -446,7 +446,7 @@ { "title": "1", "description": { - "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", + "en": "If the point of sale does not exist for an indicated ID or EXTERNAL_ID and user.", "pt": "Se o ponto de venda não existir para o ID ou EXTERNAL_ID indicado e para o usuário.", "es": "Si el punto de venta no existe para el ID o EXTERNAL_ID indicado y para el usuario." } @@ -475,9 +475,9 @@ { "title": "1", "description": { - "en": "A pos with the same EXTERNAL_ID already exists.", - "es": "A pos with the same EXTERNAL_ID already exists.", - "pt": "A pos with the same EXTERNAL_ID already exists." + "en": "A point of sale with the same EXTERNAL_ID already exists.", + "pt": "Já existe um ponto de venda com o mesmo EXTERNAL_ID.", + "es": "Ya existe un punto de venta con el mismo EXTERNAL_ID." } } ] @@ -500,16 +500,16 @@ "mp-point" ], "description": { - "en": "Get the information about all of your stores", - "pt": "Encontre todas as informações dos pontos de venda através de filtros específicos", - "es": "Encuentra toda la información de los puntos de venta a través de filtros específicos" + "en": "This endpoint allows you to find all the information about the point of sale created using specific filters", + "pt": "Este endpoint permite encontrar todas as informações das caixas (pontos de venda) criadas utilizando filtros específicos", + "es": "Este endpoint permite encontrar toda la información de las cajas (puntos de venta) creadas utilizando filtros específicos" }, "parameters": [ { "name": "external_id", "in": "query", "description": { - "en": "Unique identifier of the pos defined by integrator system.", + "en": "Unique identifier of the point of sale defined by integrator system.", "pt": "Identificador único da caixa definido pelo sistema integrador.", "es": "Identificador único de la caja definido por el integrador." }, @@ -549,9 +549,9 @@ "name": "category", "in": "query", "description": { - "es": "Category", - "pt": "Category", - "en": "Category" + "en": "MCC code that indicates the category of the point of sale. If not specified, it remains as a generic category.", + "pt": "Código MCC que indica a categoria do ponto de venda. Se não especificado, ele permanece como uma categoria genérica.", + "es": "Código MCC que indica el rubro del punto de venta. Si no se especifica, queda como categoría genérica." }, "required": false, "schema": { @@ -578,34 +578,34 @@ "type": "number", "example": 1, "description": { - "es": "total", - "pt": "total", - "en": "total" + "en": "Number of point of sales found in the search.", + "pt": "Quantidade de pontos de venda encontrados na busca.", + "es": "Cantidad de puntos de venta encontrados en la búsqueda." } }, "offset": { "type": "number", "example": 0, "description": { - "es": "offset", - "pt": "offset", - "en": "offset" + "en": "Offset over the total set of data gathered by the search.", + "pt": "Deslocamento sobre o conjunto total de dados levantados pela busca.", + "es": "Desplazamiento sobre el conjunto total de datos levantados por la búsqueda." } }, "limit": { "type": "number", "example": 0, "description": { - "es": "limit", - "pt": "limit", - "en": "limit" + "en": "Limit of point of sales returned in the search.", + "pt": "Quantidade limite de pontos de venda que serão retornadas na busca.", + "es": "Cantidad límite de puntos de venta que se devolverán en la búsqueda." } } }, "description": { - "es": "paging", - "pt": "paging", - "en": "paging" + "en": "Information for pagination of search results.", + "pt": "Informações para paginação dos resultados da pesquisa.", + "es": "Información para paginación de resultados de búsqueda." } }, "results": { @@ -626,17 +626,17 @@ "type": "string", "example": "Caja Principal", "description": { - "es": "name", - "pt": "name", - "en": "name" + "en": "Name of the point of sale.", + "pt": "Nome do ponto de venda.", + "es": "Nombre del punto de venta." } }, "fixed_amount": { "type": "boolean", "description": { - "es": "fixed_amount", - "pt": "fixed_amount", - "en": "fixed_amount" + "en": "Define if the customer can insert the amount to be paid.", + "pt": "Determine se o cliente pode inserir o valor a ser pago.", + "es": "Determina si el cliente puede insertar el monto a pagar." } }, "category": { @@ -655,7 +655,7 @@ "type": "string", "example": "SUC001POS001", "description": { - "en": "Unique identifier of the pos defined by integrator system.", + "en": "Unique identifier of the point of sale defined by integrator system.", "pt": "Identificador único da caixa definido pelo sistema integrador.", "es": "Identificador único de la caja definido por el integrador." } @@ -676,34 +676,34 @@ "type": "string", "example": "https://www.mercadopago.com/instore/merchant/qr/1988157/1f1da6401a4645e99fa21d3f4ffe0e702c4eab2209784fce9d45c83fa93bd5a7.png", "description": { - "es": "image", - "pt": "image", - "en": "image" + "en": "URL of the image of the QR code to be used for receiving payments.", + "pt": "URL da imagem do código QR a ser utilizado para receber pagamentos.", + "es": "URL de la imagen del código QR que se utilizará para recibir pagos." } }, "template_document": { "type": "string", "example": "https://www.mercadopago.com/instore/merchant/qr/1988157/template_1f1da6401a4645e99fa21d3f4ffe0e702c4eab2209784fce9d45c83fa93bd5a7.pdf", "description": { - "es": "template_document", - "pt": "template_document", - "en": "template_document" + "en": "URL of the file (in PDF format) of the template containing the QR code to be used for receiving payments.", + "pt": "URL do arquivo (em formato PDF) do template com o código QR a ser utilizado para receber pagamentos.", + "es": "URL del archivo (en formato PDF) de la plantilla con el código QR que se utilizará para recibir pagos." } }, "template_image": { "type": "string", "example": "https://www.mercadopago.com/instore/merchant/qr/1988157/template_1f1da6401a4645e99fa21d3f4ffe0e702c4eab2209784fce9d45c83fa93bd5a7.png", "description": { - "es": "template_image", - "pt": "template_image", - "en": "template_image" + "en": "URL of the file (in image format) of the template containing the QR code to be used for receiving payments.", + "pt": "URL do arquivo (em formato de imagem) do template com o código QR a ser utilizado para receber pagamentos.", + "es": "URL del archivo (en formato de imagen) de la plantilla con el código QR que se utilizará para recibir pagos." } } }, "description": { - "es": "qr", - "pt": "qr", - "en": "qr" + "en": "QR code automatically created to receive payments from the point of sale.", + "pt": "Código QR criado automaticamente para receber os pagamentos do ponto de venda.", + "es": "Código QR creado automáticamente para recibir los pagos del punto de venta." } }, "date_created": { @@ -736,9 +736,9 @@ } }, "description": { - "es": "results", - "pt": "results", - "en": "results" + "en": "Results found based on the filters used for the search.", + "pt": "Resultados encontrados a partir dos filtros utilizados para busca.", + "es": "Resultados encontrados a partir de los filtros utilizados para la búsqueda." } } } @@ -763,65 +763,65 @@ { "title": "INVALID_CATEGORY", "description": { - "en": "The CATEGORY must be numeric.", - "es": "The CATEGORY must be numeric.", - "pt": "The CATEGORY must be numeric." + "en": "CATEGORY must be numeric.", + "es": "CATEGORY debe ser numérico.", + "pt": "CATEGORY deve ser numérico." } }, { "title": "INVALID_STORE_ID", "description": { - "en": "The STORE_ID must be numeric.", - "es": "The STORE_ID must be numeric.", - "pt": "The STORE_ID must be numeric." + "en": "STORE_ID must be numeric.", + "es": "STORE_ID debe ser numérico.", + "pt": "STORE_ID deve ser numérico." } }, { "title": "INVALID_EXTERNAL_STORE_ID", "description": { - "en": "The EXTERNAL_STORE_ID must be string.", - "es": "The EXTERNAL_STORE_ID must be string.", - "pt": "The EXTERNAL_STORE_ID must be string." + "en": "EXTERNAL_STORE_ID must be string.", + "es": "EXTERNAL_STORE_ID debe ser string.", + "pt": "EXTERNAL_STORE_ID deve ser string." } }, { "title": "INEXISTENT_EXTERNAL_STORE_ID", "description": { "en": "The EXTERNAL STORE_ID does not refer to an existing Store.", - "es": "The EXTERNAL STORE_ID does not refer to an existing Store.", - "pt": "The EXTERNAL STORE_ID does not refer to an existing Store." + "es": "El EXTERNAL_STORE_ID no hace referencia a una tienda existente.", + "pt": "O EXTERNAL_STORE_ID não se refere a uma loja existente." } }, { "title": "INVALID_EXTERNAL_ID", "description": { - "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "es": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "pt": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters." + "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces, hyphens or special characters.", + "es": "El campo EXTERNAL_ID debe ser alfanumérico, solo letras y números. Sin espacios, guiones o caracteres especiales.", + "pt": "O campo EXTERNAL_ID deve ser alfanumérico, apenas letras e números. Sem espaços, hífens ou caracteres especiais." } }, { "title": "EXTERNAL_ID_TOO_LONG", "description": { "en": "The EXTERNAL_ID must be less than 40 characters.", - "es": "The EXTERNAL_ID must be less than 40 characters.", - "pt": "The EXTERNAL_ID must be less than 40 characters." + "es": "El EXTERNAL_ID debe ser menor de 40 caracteres.", + "pt": "O EXTERNAL_ID deve ter menos de 40 caracteres." } }, { "title": "INVALID_LIMIT", "description": { - "en": "The LIMIT must be numeric.", - "es": "The LIMIT must be numeric.", - "pt": "The LIMIT must be numeric." + "en": "LIMIT must be numeric.", + "es": "LIMIT debe ser numérico.", + "pt": "LIMIT deve ser numérico." } }, { "title": "INVALID_OFFSET", "description": { - "en": "The OFFSET must be numeric.", - "es": "The OFFSET must be numeric.", - "pt": "The OFFSET must be numeric." + "en": "OFFSET must be numeric.", + "es": "OFFSET debe ser numérico.", + "pt": "OFFSET deve ser numérico." } } ] @@ -833,7 +833,7 @@ } }, "title": { - "en": "Search POS", + "en": "Search point of sale", "pt": "Buscar em caixas", "es": "Buscar en cajas" } @@ -846,9 +846,9 @@ "mp-point" ], "description": { - "en": "This endpoint allows you to find all the information about the points of sale created using specific filters.", - "pt": "Este endpoint permite encontrar todas as informações das caixas (ponto de venda) criadas utilizando filtros específicos.", - "es": "Este endpoint permite encontrar toda la información de las cajas (puntos de venta) creadas utilizando filtros específicos." + "en": "This endpoint allows you to find all the information about the points of sale created using specific filters", + "pt": "Este endpoint permite encontrar todas as informações das caixas (ponto de venda) criadas utilizando filtros específicos", + "es": "Este endpoint permite encontrar toda la información de las cajas (puntos de venta) creadas utilizando filtros específicos" }, "parameters": [ { @@ -889,24 +889,49 @@ }, "qr": { "type": "object", + "description": { + "en": "QR code automatically created to receive payments from the point of sale.", + "pt": "Código QR criado automaticamente para receber os pagamentos do ponto de venda.", + "es": "Código QR creado automáticamente para recibir los pagos del punto de venta." + }, "properties": { "image": { "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2852128/c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68.png" + "example": "https://www.mercadopago.com/instore/merchant/qr/2852128/c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68.png", + "description": { + "en": "URL of the image of the QR code to be used for receiving payments.", + "pt": "URL da imagem do código QR a ser utilizado para receber pagamentos.", + "es": "URL de la imagen del código QR que se utilizará para recibir pagos." + } }, "template_document": { "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2852128/template_c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68.pdf" + "example": "https://www.mercadopago.com/instore/merchant/qr/2852128/template_c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68.pdf", + "description": { + "en": "URL of the file (in PDF format) of the template containing the QR code to be used for receiving payments.", + "pt": "URL do arquivo (em formato PDF) do template com o código QR a ser utilizado para receber pagamentos.", + "es": "URL del archivo (en formato PDF) de la plantilla con el código QR que se utilizará para recibir pagos." + } }, "template_image": { "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2852128/template_c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68.png" + "example": "https://www.mercadopago.com/instore/merchant/qr/2852128/template_c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68.png", + "description": { + "en": "URL of the file (in image format) of the template containing the QR code to be used for receiving payments.", + "pt": "URL do arquivo (em formato de imagem) do template com o código QR a ser utilizado para receber pagamentos.", + "es": "URL del archivo (en formato de imagen) de la plantilla con el código QR que se utilizará para recibir pagos." + } } } }, "status": { "type": "string", - "example": "active" + "example": "active", + "description": { + "en": "Status of the search.", + "pt": "Status da busca.", + "es": "Estado de la búsqueda." + } }, "date_created": { "type": "string", @@ -988,7 +1013,7 @@ "type": "string", "example": "SUC001POS002", "description": { - "en": "Unique identifier of the pos defined by integrator system.", + "en": "Unique identifier of the point of sale defined by integrator system.", "pt": "Identificador único da caixa definido pelo sistema integrador.", "es": "Identificador único de la caja definido por el integrador." } @@ -1023,7 +1048,7 @@ { "title": "INVALID_POS_ID", "description": { - "en": "The ID of the pos is invalid, it must be numeric.", + "en": "The ID of the poin of sale is invalid, it must be numeric.", "es": "El ID del punto de venta es inválida, debe ser numérica.", "pt": "O ID do ponto de venda é inválida, deve ser numérica." } @@ -1068,7 +1093,7 @@ { "title": "1", "description": { - "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", + "en": "If the point of sale does not exist for an indicated ID or EXTERNAL_ID and user.", "pt": "Se o ponto de venda não existir para o ID ou EXTERNAL_ID indicado e para o usuário.", "es": "Si el punto de venta no existe para el ID o EXTERNAL_ID indicado y para el usuario." } @@ -1082,7 +1107,7 @@ } }, "title": { - "en": "Get POS", + "en": "Get point of sale", "pt": "Obter caixa", "es": "Obtener caja" } @@ -1093,9 +1118,9 @@ "mp-point" ], "description": { - "en": "This endpoint allows you to update the data of a point of sale. To use it, you need to provide the identification of the point of sale and send the parameters with the information to be updated.", - "pt": "Este endpoint permite atualizar os dados de uma caixa (ponto de venda). Para utilizá-lo, é necessário fornecer a identificação do ponto de venda e enviar os parâmetros com as informações a serem atualizadas.", - "es": "Este endpoint permite actualizar los datos de una caja (punto de venta). Para utilizarlo, es necesario proporcionar la identificación del punto de venta y enviar los parámetros con la información que se debe actualizar." + "en": "This endpoint allows you to update the data of a point of sale. To use it, you need to provide the identification of the point of sale and send the parameters with the information to be updated", + "pt": "Este endpoint permite atualizar os dados de uma caixa (ponto de venda). Para utilizá-lo, é necessário fornecer a identificação do ponto de venda e enviar os parâmetros com as informações a serem atualizadas", + "es": "Este endpoint permite actualizar los datos de una caja (punto de venta). Para utilizarlo, es necesario proporcionar la identificación del punto de venta y enviar los parámetros con la información que se debe actualizar" }, "parameters": [ { @@ -1149,8 +1174,18 @@ }, "example": 1234567 }, + "external_id": { + "type": "string", + "example": "SUC001POS001", + "description": { + "en": "Unique identifier of the point of sale defined by integrator system.", + "pt": "Identificador único da caixa definido pelo sistema integrador.", + "es": "Identificador único de la caja definido por el integrador." + } + }, "external_store_id": { "type": "string", + "example": "SUC001", "description": { "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", @@ -1198,43 +1233,43 @@ "type": "string", "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", "description": { - "es": "image", - "pt": "image", - "en": "image" + "en": "URL of the image of the QR code to be used for receiving payments.", + "pt": "URL da imagem do código QR a ser utilizado para receber pagamentos.", + "es": "URL de la imagen del código QR que se utilizará para recibir pagos." } }, "template_document": { "type": "string", "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.pdf", "description": { - "es": "template_document", - "pt": "template_document", - "en": "template_document" + "en": "URL of the file (in PDF format) of the template containing the QR code to be used for receiving payments.", + "pt": "URL do arquivo (em formato PDF) do template com o código QR a ser utilizado para receber pagamentos.", + "es": "URL del archivo (en formato PDF) de la plantilla con el código QR que se utilizará para recibir pagos." } }, "template_image": { "type": "string", "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", "description": { - "es": "template_image", - "pt": "template_image", - "en": "template_image" + "en": "URL of the file (in image format) of the template containing the QR code to be used for receiving payments.", + "pt": "URL do arquivo (em formato de imagem) do template com o código QR a ser utilizado para receber pagamentos.", + "es": "URL del archivo (en formato de imagen) de la plantilla con el código QR que se utilizará para recibir pagos." } } }, "description": { - "es": "qr", - "pt": "qr", - "en": "qr" + "en": "QR code automatically created to receive payments from the point of sale.", + "pt": "Código QR criado automaticamente para receber os pagamentos do ponto de venda.", + "es": "Código QR creado automáticamente para recibir los pagos del punto de venta." } }, "status": { "type": "string", "example": "active", "description": { - "es": "status", - "pt": "status", - "en": "status" + "en": "Status of the point of sale data update.", + "pt": "Status da atualização dos dados do ponto de venda.", + "es": "Estado de la actualización de los datos del punto de venta." } }, "date_created": { @@ -1324,7 +1359,7 @@ "type": "string", "example": "SUC001POS002", "description": { - "en": "Unique identifier of the pos defined by integrator system.", + "en": "Unique identifier of the point of sale defined by integrator system.", "pt": "Identificador único da caixa definido pelo sistema integrador.", "es": "Identificador único de la caja definido por el integrador." } @@ -1359,7 +1394,7 @@ { "title": "MISSING_BODY", "description": { - "en": "HTTP body is required to modify pos.", + "en": "HTTP body is required to modify point of sale.", "es": "El cuerpo del HTTP es requerido para modificar el punto de venta.", "pt": "O corpo do HTTP é necessário para modificar o ponto de venda." } @@ -1375,7 +1410,7 @@ { "title": "INVALID_POS_ID", "description": { - "en": "The ID of the pos is invalid, it must be numeric.", + "en": "The ID of the point of sale is invalid, it must be numeric.", "es": "El ID del punto de venta es inválida, debe ser numérica.", "pt": "O ID do ponto de venda é inválida, deve ser numérica." } @@ -1599,9 +1634,9 @@ "mp-point" ], "description": { - "en": "This endpoint allows the deletion of a specific point of sale, identified by its ID.", - "pt": "Este endpoint permite a exclusão de uma caixa (ponto de venda) específica, identificada pelo seu ID.", - "es": "Este endpoint permite la eliminación de una caja (punto de venta) específica, identificada por su ID." + "en": "This endpoint allows the deletion of a specific point of sale, identified by its ID", + "pt": "Este endpoint permite a exclusão de uma caixa (ponto de venda) específica, identificada pelo seu ID", + "es": "Este endpoint permite la eliminación de una caja (punto de venta) específica, identificada por su ID" }, "parameters": [ { @@ -1637,7 +1672,7 @@ { "title": "INVALID_POS_ID", "description": { - "en": "The ID of the pos is invalid, it must be numeric.", + "en": "The ID of the point of sale is invalid, it must be numeric.", "es": "El ID del punto de venta es inválida, debe ser numérica.", "pt": "O ID do ponto de venda é inválido, deve ser numérica." } @@ -1666,7 +1701,7 @@ { "title": "1", "description": { - "en": "If there is no pos for the indicated ID and user.", + "en": "If there is no point of sale for the indicated ID and user.", "es": "Si no hay punto de venta para el ID y el usuario indicados.", "pt": "Se não houver ponto de venda para o ID e o usuário indicados." } @@ -1693,9 +1728,9 @@ "type": "number", "example": 621102, "description": { - "en": "MCC code that indicates the category of the point of sale. If not specified, it remains as a generic category.", - "pt": "Código MCC que indica a categoria do ponto de venda. Se não especificado, ele permanece como uma categoria genérica.", - "es": "Código MCC que indica el rubro del punto de venta. Si no se especifica, queda como categoría genérica." + "en": "MCC code that indicates the category of the point of sale. If not specified, it remains as a generic category", + "pt": "Código MCC que indica a categoria do ponto de venda. Se não especificado, ele permanece como uma categoria genérica", + "es": "Código MCC que indica el rubro del punto de venta. Si no se especifica, queda como categoría genérica" }, "enum": [ { From bcb204b0ada557aca4479bafe22ec6d618de283c Mon Sep 17 00:00:00 2001 From: hgaldino Date: Fri, 2 Aug 2024 16:15:29 -0300 Subject: [PATCH 20/20] final --- reference/api-json/pos copy.json | 1788 ------------------------------ 1 file changed, 1788 deletions(-) delete mode 100644 reference/api-json/pos copy.json diff --git a/reference/api-json/pos copy.json b/reference/api-json/pos copy.json deleted file mode 100644 index 4f13533c90..0000000000 --- a/reference/api-json/pos copy.json +++ /dev/null @@ -1,1788 +0,0 @@ -{ - "url": "https://api.mercadopago.com", - "paths": { - "/pos": { - "post": { - "tags": [ - "qr-code", - "mp-point" - ], - "description": { - "en": "Generate a point of sale in a store. Each POS will have a unique QR Code linked to it", - "pt": "Gerar um ponto de venda em uma loja. Cada caixa registradora terá um código QR exclusivo vinculado a ela", - "es": "Genera un punto de venta en una sucursal. Cada caja tendrá vinculado un código QR unívoco" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": { - "en": "Name of the point of sale.", - "pt": "Nome do ponto de venda.", - "es": "Nombre del punto de venta." - }, - "example": "First POS" - }, - "fixed_amount": { - "type": "boolean", - "description": { - "en": "Define if the customer can insert the amount to be paid.", - "pt": "Determine se o cliente pode inserir o valor a ser pago.", - "es": "Determina si el cliente puede insertar el monto a pagar." - }, - "example": false - }, - "store_id": { - "type": "string", - "description": { - "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o ponto de venda pertence.", - "es": "Identificador de la sucursal a la que pertenece el punto de venta." - }, - "example": 1234567 - }, - "external_store_id": { - "type": "string", - "description": { - "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", - "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", - "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." - }, - "example": "SUC001" - }, - "external_id": { - "type": "string", - "description": { - "en": "Unique identifier of the pos defined by integrator system.", - "pt": "Identificador único da caixa definido pelo sistema integrador.", - "es": "Identificador único de la caja definido por el integrador." - }, - "example": "SUC001POS001" - }, - "category": { - "$ref": "#/components/schemas/category" - }, - "url": { - "type": "string", - "description": { - "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", - "pt": "URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.", - "es": "URL para obtener la orden del sistema integrador. Es opcional y se utiliza solo en el modelo de integración desatendido." - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": { - "en": "Success", - "pt": "Sucesso", - "es": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number", - "example": 2711382, - "description": { - "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", - "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", - "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." - } - }, - "qr": { - "type": "object", - "properties": { - "image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", - "description": { - "es": "image", - "pt": "image", - "en": "image" - } - }, - "template_document": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.pdf", - "description": { - "es": "template_document", - "pt": "template_document", - "en": "template_document" - } - }, - "template_image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", - "description": { - "es": "template_image", - "pt": "template_image", - "en": "template_image" - } - } - }, - "description": { - "es": "qr", - "pt": "qr", - "en": "qr" - } - }, - "status": { - "type": "string", - "example": "active", - "description": { - "es": "status", - "pt": "status", - "en": "status" - } - }, - "date_created": { - "type": "string", - "example": "2019-08-22T14:11:12.000Z", - "description": { - "es": "date_created", - "pt": "date_created", - "en": "date_created" - } - }, - "date_last_updated": { - "type": "string", - "example": "2019-08-22T14:11:12.000Z", - "description": { - "es": "date_last_updated", - "pt": "date_last_updated", - "en": "date_last_updated" - } - }, - "uuid": { - "type": "string", - "example": "0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1", - "description": { - "es": "uuid", - "pt": "uuid", - "en": "uuid" - } - }, - "user_id": { - "type": "number", - "example": 446566691, - "description": { - "es": "user_id", - "pt": "user_id", - "en": "user_id" - } - }, - "name": { - "type": "string", - "example": "First POS", - "description": { - "es": "name", - "pt": "name", - "en": "name" - } - }, - "fixed_amount": { - "type": "boolean", - "example": false, - "description": { - "es": "fixed_amount", - "pt": "fixed_amount", - "en": "fixed_amount" - } - }, - "category": { - "$ref": "#/components/schemas/category" - }, - "store_id": { - "type": "string", - "example": 1234567, - "description": { - "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o ponto de venda pertence.", - "es": "Identificador de la sucursal a la que pertenece el punto de venta." - } - }, - "external_store_id": { - "type": "string", - "example": "SUC001", - "description": { - "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", - "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", - "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." - } - }, - "url": { - "type": "string", - "description": { - "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", - "pt": "URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.", - "es": "URL para obtener la orden del sistema integrador. Es opcional y se utiliza solo en el modelo de integración desatendido." - } - }, - "external_id": { - "type": "string", - "example": "SUC001POS001", - "description": { - "en": "Unique identifier of the pos defined by integrator system.", - "pt": "Identificador único da caixa definido pelo sistema integrador.", - "es": "Identificador único de la caja definido por el integrador." - } - } - } - } - } - } - }, - "400": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "MISSING_BODY", - "description": { - "en": "HTTP body is required to modify pos.", - "es": "El cuerpo del HTTP es requerido para modificar el punto de venta.", - "pt": "O corpo do HTTP é necessário para modificar o ponto de venda." - } - }, - { - "title": "UNKNOWN_FIELD_EXCEPTION", - "description": { - "en": "The indicated field is not allowed for this operation or is unknown.", - "es": "El campo indicado no está permitido para esta operación o es desconocido.", - "pt": "O campo indicado não é permitido para esta operação ou é desconhecido." - } - }, - { - "title": "INVALID_POS_ID", - "description": { - "en": "The ID of the pos is invalid, it must be numeric.", - "es": "El ID del punto de venta es inválida, debe ser numérica.", - "pt": "O ID do ponto de venda é inválida, deve ser numérica." - } - }, - { - "title": "INVALID_NAME", - "description": { - "en": "NAME must be string.", - "es": "NOMBRE debe ser string.", - "pt": "NAME deve ser string." - } - }, - { - "title": "NAME_TOO_LONG", - "description": { - "en": "The NAME must be less than 45 characters.", - "es": "NAME debe ser menor de 45 caracteres.", - "pt": "NAME deve ter menos de 45 caracteres." - } - }, - { - "title": "INVALID_FIXED_AMOUNT", - "description": { - "en": "FIXED_AMOUNT must be boolean.", - "es": "FIXED_AMOUNT debe ser boolean.", - "pt": "FIXED_AMOUNT deve ser boolean." - } - }, - { - "title": "INVALID_CATEGORY", - "description": { - "en": "CATEGORY must be numeric.", - "es": "CATEGORY debe ser numérico.", - "pt": "CATEGORY deve ser numérico." - } - }, - { - "title": "POS_UNKNOWN_MCC", - "description": { - "en": "CATEGORY must be valid for the user's site.", - "es": "CATEGORY debe ser válida para el sitio del usuario.", - "pt": "CATEGORY deve ser válida para o site do usuário." - } - }, - { - "title": "POS_INVALID_STORE_ID", - "description": { - "en": "STORE_ID must be numeric.", - "es": "STORE_ID debe ser numérico.", - "pt": "STORE_ID deve ser numérico." - } - }, - { - "title": "INVALID_EXTERNAL_STORE_ID", - "description": { - "en": "EXTERNAL_STORE_ID must be string.", - "es": "EXTERNAL_STORE_ID debe ser string.", - "pt": "EXTERNAL_STORE_ID deve ser string." - } - }, - { - "title": "EXTERNAL_STORE_ID_NOT_MATCH", - "description": { - "en": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID.", - "es": "El EXTERNAL_STORE_ID no hace referencia al STORE_ID indicado.", - "pt": "O EXTERNAL_STORE_ID não se refere ao STORE_ID indicado." - } - }, - { - "title": "INEXISTENT_EXTERNAL_STORE_ID", - "description": { - "en": "The EXTERNAL STORE_ID does not refer to an existing Store.", - "es": "El EXTERNAL_STORE_ID no hace referencia a una tienda existente.", - "pt": "O EXTERNAL_STORE_ID não se refere a uma loja existente." - } - }, - { - "title": "INVALID_EXTERNAL_ID", - "description": { - "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces, hyphens or special characters.", - "es": "El campo EXTERNAL_ID debe ser alfanumérico, solo letras y números. Sin espacios, guiones o caracteres especiales.", - "pt": "O campo EXTERNAL_ID deve ser alfanumérico, apenas letras e números. Sem espaços, hífens ou caracteres especiais." - } - }, - { - "title": "EXTERNAL_ID_TOO_LONG", - "description": { - "en": "The EXTERNAL_ID must be less than 40 characters.", - "es": "El EXTERNAL_ID debe ser menor de 40 caracteres.", - "pt": "O EXTERNAL_ID deve ter menos de 40 caracteres." - } - }, - { - "title": "INVALID_URL", - "description": { - "en": "The URL must be string and muste have the format of a valid url", - "es": "La URL debe ser una cadena y debe tener el formato de una URL válida.", - "pt": "A URL deve ser uma string e deve ter o formato de uma URL válida." - } - }, - { - "title": "URL_TOO_LONG", - "description": { - "en": "The URL must be less than 300 characters.", - "es": "La URL debe ser menor de 300 caracteres.", - "pt": "A URL deve ter menos de 300 caracteres." - } - }, - { - "title": "FIXED_AMOUNT_FALSE", - "description": { - "en": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case.", - "es": "Si se indica el campo URL, el campo FIXED_AMOUNT debe ser verdadero. No soportamos la modalidad de monto abierto en este caso.", - "pt": "Se o campo URL estiver indicado, o campo FIXED_AMOUNT deve ser verdadeiro. Não suportamos a modalidade de valor aberto nesse caso." - } - } - ] - } - } - } - } - } - }, - "403": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor.", - "es": "If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor.", - "pt": "If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor." - } - } - ] - } - } - } - } - } - }, - "404": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", - "pt": "Se o ponto de venda não existir para o ID ou EXTERNAL_ID indicado e para o usuário.", - "es": "Si el punto de venta no existe para el ID o EXTERNAL_ID indicado y para el usuario." - } - } - ] - } - } - } - } - } - }, - "409": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "A pos with the same EXTERNAL_ID already exists.", - "es": "A pos with the same EXTERNAL_ID already exists.", - "pt": "A pos with the same EXTERNAL_ID already exists." - } - } - ] - } - } - } - } - } - } - }, - "title": { - "en": "Create point of sale", - "pt": "Criar caixa", - "es": "Crear caja" - } - }, - "get": { - "tags": [ - "qr-code", - "mp-point" - ], - "description": { - "en": "Get the information about all of your stores", - "pt": "Encontre todas as informações dos pontos de venda através de filtros específicos", - "es": "Encuentra toda la información de los puntos de venta a través de filtros específicos" - }, - "parameters": [ - { - "name": "external_id", - "in": "query", - "description": { - "en": "Unique identifier of the pos defined by integrator system.", - "pt": "Identificador único da caixa definido pelo sistema integrador.", - "es": "Identificador único de la caja definido por el integrador." - }, - "required": false, - "schema": { - "type": "string", - "example": "SUC001POS001" - } - }, - { - "name": "external_store_id", - "in": "query", - "description": { - "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", - "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", - "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." - }, - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "store_id", - "in": "query", - "description": { - "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o ponto de venda pertence.", - "es": "Identificador de la sucursal a la que pertenece el punto de venta." - }, - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "category", - "in": "query", - "description": { - "es": "Category", - "pt": "Category", - "en": "Category" - }, - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": { - "en": "Success", - "pt": "Sucesso", - "es": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "paging": { - "type": "object", - "properties": { - "total": { - "type": "number", - "example": 1, - "description": { - "es": "total", - "pt": "total", - "en": "total" - } - }, - "offset": { - "type": "number", - "example": 0, - "description": { - "es": "offset", - "pt": "offset", - "en": "offset" - } - }, - "limit": { - "type": "number", - "example": 0, - "description": { - "es": "limit", - "pt": "limit", - "en": "limit" - } - } - }, - "description": { - "es": "paging", - "pt": "paging", - "en": "paging" - } - }, - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "user_id": { - "type": "number", - "example": 446566691, - "description": { - "es": "user_id", - "pt": "user_id", - "en": "user_id" - } - }, - "name": { - "type": "string", - "example": "Caja Principal", - "description": { - "es": "name", - "pt": "name", - "en": "name" - } - }, - "fixed_amount": { - "type": "boolean", - "description": { - "es": "fixed_amount", - "pt": "fixed_amount", - "en": "fixed_amount" - } - }, - "category": { - "$ref": "#/components/schemas/category" - }, - "store_id": { - "type": "string", - "example": 1234567, - "description": { - "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o ponto de venda pertence.", - "es": "Identificador de la sucursal a la que pertenece el punto de venta." - } - }, - "external_id": { - "type": "string", - "example": "SUC001POS001", - "description": { - "en": "Unique identifier of the pos defined by integrator system.", - "pt": "Identificador único da caixa definido pelo sistema integrador.", - "es": "Identificador único de la caja definido por el integrador." - } - }, - "id": { - "type": "number", - "example": 1988157, - "description": { - "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", - "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", - "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." - } - }, - "qr": { - "type": "object", - "properties": { - "image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/1988157/1f1da6401a4645e99fa21d3f4ffe0e702c4eab2209784fce9d45c83fa93bd5a7.png", - "description": { - "es": "image", - "pt": "image", - "en": "image" - } - }, - "template_document": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/1988157/template_1f1da6401a4645e99fa21d3f4ffe0e702c4eab2209784fce9d45c83fa93bd5a7.pdf", - "description": { - "es": "template_document", - "pt": "template_document", - "en": "template_document" - } - }, - "template_image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/1988157/template_1f1da6401a4645e99fa21d3f4ffe0e702c4eab2209784fce9d45c83fa93bd5a7.png", - "description": { - "es": "template_image", - "pt": "template_image", - "en": "template_image" - } - } - }, - "description": { - "es": "qr", - "pt": "qr", - "en": "qr" - } - }, - "date_created": { - "type": "string", - "example": "2019-06-24T13:31:56.000Z", - "description": { - "es": "date_created", - "pt": "date_created", - "en": "date_created" - } - }, - "date_last_updated": { - "type": "string", - "example": "2019-08-07T21:07:26.000Z", - "description": { - "es": "date_last_updated", - "pt": "date_last_updated", - "en": "date_last_updated" - } - }, - "external_store_id": { - "type": "string", - "example": "SUC001", - "description": { - "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", - "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", - "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." - } - } - } - }, - "description": { - "es": "results", - "pt": "results", - "en": "results" - } - } - } - } - } - } - }, - "400": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "INVALID_CATEGORY", - "description": { - "en": "The CATEGORY must be numeric.", - "es": "The CATEGORY must be numeric.", - "pt": "The CATEGORY must be numeric." - } - }, - { - "title": "INVALID_STORE_ID", - "description": { - "en": "The STORE_ID must be numeric.", - "es": "The STORE_ID must be numeric.", - "pt": "The STORE_ID must be numeric." - } - }, - { - "title": "INVALID_EXTERNAL_STORE_ID", - "description": { - "en": "The EXTERNAL_STORE_ID must be string.", - "es": "The EXTERNAL_STORE_ID must be string.", - "pt": "The EXTERNAL_STORE_ID must be string." - } - }, - { - "title": "INEXISTENT_EXTERNAL_STORE_ID", - "description": { - "en": "The EXTERNAL STORE_ID does not refer to an existing Store.", - "es": "The EXTERNAL STORE_ID does not refer to an existing Store.", - "pt": "The EXTERNAL STORE_ID does not refer to an existing Store." - } - }, - { - "title": "INVALID_EXTERNAL_ID", - "description": { - "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "es": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.", - "pt": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters." - } - }, - { - "title": "EXTERNAL_ID_TOO_LONG", - "description": { - "en": "The EXTERNAL_ID must be less than 40 characters.", - "es": "The EXTERNAL_ID must be less than 40 characters.", - "pt": "The EXTERNAL_ID must be less than 40 characters." - } - }, - { - "title": "INVALID_LIMIT", - "description": { - "en": "The LIMIT must be numeric.", - "es": "The LIMIT must be numeric.", - "pt": "The LIMIT must be numeric." - } - }, - { - "title": "INVALID_OFFSET", - "description": { - "en": "The OFFSET must be numeric.", - "es": "The OFFSET must be numeric.", - "pt": "The OFFSET must be numeric." - } - } - ] - } - } - } - } - } - } - }, - "title": { - "en": "Search POS", - "pt": "Buscar em caixas", - "es": "Buscar en cajas" - } - } - }, - "/pos/{id}": { - "get": { - "tags": [ - "qr-code", - "mp-point" - ], - "description": { - "en": "This endpoint allows you to find all the information about the points of sale created using specific filters.", - "pt": "Este endpoint permite encontrar todas as informações das caixas (ponto de venda) criadas utilizando filtros específicos.", - "es": "Este endpoint permite encontrar toda la información de las cajas (puntos de venta) creadas utilizando filtros específicos." - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": { - "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", - "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", - "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." - }, - "required": true, - "schema": { - "type": "string", - "example": 1988157 - } - } - ], - "responses": { - "200": { - "description": { - "en": "Success", - "pt": "Sucesso", - "es": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": 1988157, - "description": { - "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", - "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", - "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." - } - }, - "qr": { - "type": "object", - "properties": { - "image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2852128/c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68.png" - }, - "template_document": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2852128/template_c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68.pdf" - }, - "template_image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2852128/template_c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68.png" - } - } - }, - "status": { - "type": "string", - "example": "active" - }, - "date_created": { - "type": "string", - "example": "2019-09-03T13:13:54.000-04:00" - }, - "date_last_updated": { - "type": "string", - "example": "2020-09-30T08:38:58.000-04:00" - }, - "uuid": { - "type": "string", - "example": "c955a5618d874e998c8399e3515fed3a00b8cc0ca401448ca56e2f2e18f4ba68" - }, - "compatible_id": { - "type": "string", - "example": "4be87a269a7b863fd043658d2a0d7b3fa2f32334138ff651e2408d3f8191d6c9f67a4dc297e9efc70d1adfbb31f7c21c29c9059ac905a359e39114c9871afef9" - }, - "user_id": { - "type": "number", - "example": 329653108 - }, - "name": { - "type": "string", - "example": "POS001" - }, - "fixed_amount": { - "type": "boolean", - "example": false - }, - "store_id": { - "type": "string", - "example": 56807753 - }, - "external_store_id": { - "type": "string", - "example": "SUC01" - }, - "external_id": { - "type": "string", - "example": "SUC001POS002" - }, - "site": { - "type": "string", - "example": "MLB" - }, - "qr_code": { - "type": "string", - "example": "00020101021226940014BR.GOV.BCB.PIX2572pix-qr-h.mercadopago.com/instore/h/p/v2/c955a5618d874e998c8399e3515fed3a43520016com.mercadolibre0128https://mpago.la/pos/28521285204000053039865802BR5924VICTOR CORREA DE ALMEIDA6008CAMPINAS62070503***6304367C" - } - } - } - } - } - }, - "400": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "INVALID_POS_ID", - "description": { - "en": "The ID of the pos is invalid, it must be numeric.", - "es": "El ID del punto de venta es inválida, debe ser numérica.", - "pt": "O ID do ponto de venda é inválida, deve ser numérica." - } - }, - { - "title": "INVALID_EXTERNAL_ID", - "description": { - "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces, hyphens or special characters.", - "es": "El campo EXTERNAL_ID debe ser alfanumérico, solo letras y números. Sin espacios, guiones o caracteres especiales.", - "pt": "O campo EXTERNAL_ID deve ser alfanumérico, apenas letras e números. Sem espaços, hífens ou caracteres especiais." - } - }, - { - "title": "EXTERNAL_ID_TOO_LONG", - "description": { - "en": "The EXTERNAL_ID must be less than 40 characters.", - "es": "El EXTERNAL_ID debe ser menor de 40 caracteres.", - "pt": "O EXTERNAL_ID deve ter menos de 40 caracteres." - } - } - ] - } - } - } - } - } - }, - "404": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "If the POS does not exist for an indicated ID or EXTERNAL_ID and user.", - "pt": "Se o ponto de venda não existir para o ID ou EXTERNAL_ID indicado e para o usuário.", - "es": "Si el punto de venta no existe para el ID o EXTERNAL_ID indicado y para el usuario." - } - } - ] - } - } - } - } - } - } - }, - "title": { - "en": "Get POS", - "pt": "Obter caixa", - "es": "Obtener caja" - } - }, - "put": { - "tags": [ - "qr-code", - "mp-point" - ], - "description": { - "en": "This endpoint allows you to update the data of a point of sale. To use it, you need to provide the identification of the point of sale and send the parameters with the information to be updated.", - "pt": "Este endpoint permite atualizar os dados de uma caixa (ponto de venda). Para utilizá-lo, é necessário fornecer a identificação do ponto de venda e enviar os parâmetros com as informações a serem atualizadas.", - "es": "Este endpoint permite actualizar los datos de una caja (punto de venta). Para utilizarlo, es necesario proporcionar la identificación del punto de venta y enviar los parámetros con la información que se debe actualizar." - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": { - "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including updating the point of sale data.", - "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo a atualização de dados do ponto de venda.", - "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la actualización de los datos del punto de venta." - }, - "required": true, - "schema": { - "type": "string", - "example": 1988157 - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": { - "en": "Name of the point of sale.", - "pt": "Nome da caixa (ponto de venda).", - "es": "Nombre de la caja (punto de venta)." - }, - "example": "First POS" - }, - "fixed_amount": { - "type": "boolean", - "description": { - "en": "Define if the customer can insert the amount to be paid.", - "pt": "Determine se o cliente pode inserir o valor a ser pago.", - "es": "Determina si el cliente puede insertar el monto a pagar." - }, - "example": false - }, - "category": { - "$ref": "#/components/schemas/category" - }, - "store_id": { - "type": "string", - "description": { - "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o ponto de venda pertence.", - "es": "Identificador de la sucursal a la que pertenece el punto de venta." - }, - "example": 1234567 - }, - "external_store_id": { - "type": "string", - "description": { - "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", - "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", - "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." - } - }, - "url": { - "type": "string", - "description": { - "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", - "pt": "URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.", - "es": "URL para obtener la orden del sistema integrador. Es opcional y se utiliza solo en el modelo de integración desatendido." - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": { - "en": "Success", - "pt": "Sucesso", - "es": "Éxito" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number", - "example": 2711382, - "description": { - "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including retrieving the point of sale data.", - "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", - "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la consulta de los datos del punto de venta." - } - }, - "qr": { - "type": "object", - "properties": { - "image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", - "description": { - "es": "image", - "pt": "image", - "en": "image" - } - }, - "template_document": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.pdf", - "description": { - "es": "template_document", - "pt": "template_document", - "en": "template_document" - } - }, - "template_image": { - "type": "string", - "example": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png", - "description": { - "es": "template_image", - "pt": "template_image", - "en": "template_image" - } - } - }, - "description": { - "es": "qr", - "pt": "qr", - "en": "qr" - } - }, - "status": { - "type": "string", - "example": "active", - "description": { - "es": "status", - "pt": "status", - "en": "status" - } - }, - "date_created": { - "type": "string", - "example": "2019-08-22T14:11:12.000Z", - "description": { - "es": "date_created", - "pt": "date_created", - "en": "date_created" - } - }, - "date_last_updated": { - "type": "string", - "example": "2019-08-22T14:11:12.000Z", - "description": { - "es": "date_last_updated", - "pt": "date_last_updated", - "en": "date_last_updated" - } - }, - "uuid": { - "type": "string", - "example": "0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1", - "description": { - "es": "uuid", - "pt": "uuid", - "en": "uuid" - } - }, - "user_id": { - "type": "number", - "example": 446566691, - "description": { - "es": "user_id", - "pt": "user_id", - "en": "user_id" - } - }, - "name": { - "type": "string", - "example": "First POS", - "description": { - "es": "name", - "pt": "name", - "en": "name" - } - }, - "fixed_amount": { - "type": "boolean", - "example": false, - "description": { - "es": "fixed_amount", - "pt": "fixed_amount", - "en": "fixed_amount" - } - }, - "category": { - "$ref": "#/components/schemas/category" - }, - "store_id": { - "type": "string", - "example": 1234567, - "description": { - "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o ponto de venda pertence.", - "es": "Identificador de la sucursal a la que pertenece el punto de venta." - } - }, - "external_store_id": { - "type": "string", - "example": "SUC001", - "description": { - "en": "The unique store identifier, set by the integrated system and can contain up to 60 characters.", - "pt": "Identificador único da loja, definido pelo sistema integrador e pode conter até 60 caracteres.", - "es": "El identificador único de la tienda, establecido por el sistema integrador y puede contener hasta 60 caracteres." - } - }, - "url": { - "type": "string", - "description": { - "en": "URL to get the order of the integrator system. It is optional and is used only in the unattended integration model.", - "pt": "URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.", - "es": "URL para obtener la orden del sistema integrador. Es opcional y se utiliza solo en el modelo de integración desatendido." - } - }, - "external_id": { - "type": "string", - "example": "SUC001POS002", - "description": { - "en": "Unique identifier of the pos defined by integrator system.", - "pt": "Identificador único da caixa definido pelo sistema integrador.", - "es": "Identificador único de la caja definido por el integrador." - } - }, - "site": { - "type": "string", - "example": "MLB" - }, - "qr_code": { - "type": "string", - "example": "00020101021226940014BR.GOV.BCB.PIX2572pix-qr-h.mercadopago.com/instore/h/p/v2/db12b6e2ec4844839825c6dce7cd2f2243530016com.mercadolibre0129https://mpago.la/pos/212798995204000053039865802BR5924VICTOR CORREA DE ALMEIDA6008CAMPINAS62070503***63040B44" - } - } - } - } - } - }, - "400": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "MISSING_BODY", - "description": { - "en": "HTTP body is required to modify pos.", - "es": "El cuerpo del HTTP es requerido para modificar el punto de venta.", - "pt": "O corpo do HTTP é necessário para modificar o ponto de venda." - } - }, - { - "title": "UNKNOWN_FIELD_EXCEPTION", - "description": { - "en": "The indicated field is not allowed for this operation or is unknown.", - "es": "El campo indicado no está permitido para esta operación o es desconocido.", - "pt": "O campo indicado não é permitido para esta operação ou é desconhecido." - } - }, - { - "title": "INVALID_POS_ID", - "description": { - "en": "The ID of the pos is invalid, it must be numeric.", - "es": "El ID del punto de venta es inválida, debe ser numérica.", - "pt": "O ID do ponto de venda é inválida, deve ser numérica." - } - }, - { - "title": "INVALID_NAME", - "description": { - "en": "NAME must be string.", - "es": "NOMBRE debe ser string.", - "pt": "NAME deve ser string." - } - }, - { - "title": "NAME_TOO_LONG", - "description": { - "en": "The NAME must be less than 45 characters.", - "es": "NAME debe ser menor de 45 caracteres.", - "pt": "NAME deve ter menos de 45 caracteres." - } - }, - { - "title": "INVALID_FIXED_AMOUNT", - "description": { - "en": "FIXED_AMOUNT must be boolean.", - "es": "FIXED_AMOUNT debe ser boolean.", - "pt": "FIXED_AMOUNT deve ser boolean." - } - }, - { - "title": "INVALID_CATEGORY", - "description": { - "en": "CATEGORY must be numeric.", - "es": "CATEGORY debe ser numérico.", - "pt": "CATEGORY deve ser numérico." - } - }, - { - "title": "POS_UNKNOWN_MCC", - "description": { - "en": "CATEGORY must be valid for the user's site.", - "es": "CATEGORY debe ser válida para el sitio del usuario.", - "pt": "CATEGORY deve ser válida para o site do usuário." - } - }, - { - "title": "POS_INVALID_STORE_ID", - "description": { - "en": "STORE_ID must be numeric.", - "es": "STORE_ID debe ser numérico.", - "pt": "STORE_ID deve ser numérico." - } - }, - { - "title": "INVALID_EXTERNAL_STORE_ID", - "description": { - "en": "EXTERNAL_STORE_ID must be string.", - "es": "EXTERNAL_STORE_ID debe ser string.", - "pt": "EXTERNAL_STORE_ID deve ser string." - } - }, - { - "title": "EXTERNAL_STORE_ID_NOT_MATCH", - "description": { - "en": "The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID.", - "es": "El EXTERNAL_STORE_ID no hace referencia al STORE_ID indicado.", - "pt": "O EXTERNAL_STORE_ID não se refere ao STORE_ID indicado." - } - }, - { - "title": "INEXISTENT_EXTERNAL_STORE_ID", - "description": { - "en": "The EXTERNAL STORE_ID does not refer to an existing Store.", - "es": "El EXTERNAL_STORE_ID no hace referencia a una tienda existente.", - "pt": "O EXTERNAL_STORE_ID não se refere a uma loja existente." - } - }, - { - "title": "INVALID_EXTERNAL_ID", - "description": { - "en": "The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces, hyphens or special characters.", - "es": "El campo EXTERNAL_ID debe ser alfanumérico, solo letras y números. Sin espacios, guiones o caracteres especiales.", - "pt": "O campo EXTERNAL_ID deve ser alfanumérico, apenas letras e números. Sem espaços, hífens ou caracteres especiais." - } - }, - { - "title": "EXTERNAL_ID_TOO_LONG", - "description": { - "en": "The EXTERNAL_ID must be less than 40 characters.", - "es": "El EXTERNAL_ID debe ser menor de 40 caracteres.", - "pt": "O EXTERNAL_ID deve ter menos de 40 caracteres." - } - }, - { - "title": "INVALID_URL", - "description": { - "en": "The URL must be string and muste have the format of a valid url", - "es": "La URL debe ser una cadena y debe tener el formato de una URL válida.", - "pt": "A URL deve ser uma string e deve ter o formato de uma URL válida." - } - }, - { - "title": "URL_TOO_LONG", - "description": { - "en": "The URL must be less than 300 characters.", - "es": "La URL debe ser menor de 300 caracteres.", - "pt": "A URL deve ter menos de 300 caracteres." - } - }, - { - "title": "FIXED_AMOUNT_FALSE", - "description": { - "en": "If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case.", - "es": "Si se indica el campo URL, el campo FIXED_AMOUNT debe ser verdadero. No soportamos la modalidad de monto abierto en este caso.", - "pt": "Se o campo URL estiver indicado, o campo FIXED_AMOUNT deve ser verdadeiro. Não suportamos a modalidade de valor aberto nesse caso." - } - } - ] - } - } - } - } - } - }, - "403": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor.", - "es": "Si está utilizando el campo URL, el host debe estar habilitado por Mercado Pago. Si no lo está, recibirá este error. Por favor, comuníquese con su asesor técnico asignado.", - "pt": "Se você estiver usando o campo URL, o host deve ser habilitado pelo Mercado Pago. Se não for, você receberá este erro. Por favor, entre em contato com seu assessor técnico designado." - } - } - ] - } - } - } - } - } - }, - "404": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "If the point of sale does not exist for an indicated ID or EXTERNAL_ID and to the user.", - "es": "Si el punto de venta no existe para un ID o EXTERNAL_ID indicado y para el usuario.", - "pt": "Se o ponto de venda não existir para um ID ou EXTERNAL_ID indicado e para o usuário." - } - } - ] - } - } - } - } - } - }, - "409": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "A pont of sale with the same EXTERNAL_ID already exists.", - "es": "Ya existe un punto de venta con el mismo EXTERNAL_ID.", - "pt": "Já existe um ponto de venda com o mesmo EXTERNAL_ID." - } - } - ] - } - } - } - } - } - } - }, - "title": { - "en": "Update point of sale", - "pt": "Atualizar caixa", - "es": "Actualizar caja" - } - }, - "delete": { - "tags": [ - "qr-code", - "mp-point" - ], - "description": { - "en": "This endpoint allows the deletion of a specific point of sale, identified by its ID.", - "pt": "Este endpoint permite a exclusão de uma caixa (ponto de venda) específica, identificada pelo seu ID.", - "es": "Este endpoint permite la eliminación de una caja (punto de venta) específica, identificada por su ID." - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": { - "en": "Creation ID of the point of sale. When you register a point of sale, you will receive a corresponding ID. This ID can be used for various operations, including deleting a point of sale.", - "pt": "ID de criação do ponto de venda. Ao registrar um ponto de venda, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluindo consultar os dados do ponto de venda.", - "es": "ID de creación del punto de venta. Al registrar un punto de venta, recibirás un ID correspondiente. Este ID puede ser utilizado para varias operaciones, incluida la eliminación de un punto de venta." - }, - "required": true, - "schema": { - "type": "string", - "example": "12123adfasdf123u4u" - } - } - ], - "responses": { - "400": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "INVALID_POS_ID", - "description": { - "en": "The ID of the pos is invalid, it must be numeric.", - "es": "El ID del punto de venta es inválida, debe ser numérica.", - "pt": "O ID do ponto de venda é inválido, deve ser numérica." - } - } - ] - } - } - } - } - } - }, - "404": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "If there is no pos for the indicated ID and user.", - "es": "Si no hay punto de venta para el ID y el usuario indicados.", - "pt": "Se não houver ponto de venda para o ID e o usuário indicados." - } - } - ] - } - } - } - } - } - } - }, - "title": { - "en": "Delete point of sale", - "pt": "Excluir caixa", - "es": "Eliminar caja" - } - } - } - }, - "components": { - "schemas": { - "category": { - "type": "number", - "example": 621102, - "description": { - "en": "MCC code that indicates the category of the point of sale. If not specified, it remains as a generic category.", - "pt": "Código MCC que indica a categoria do ponto de venda. Se não especificado, ele permanece como uma categoria genérica.", - "es": "Código MCC que indica el rubro del punto de venta. Si no se especifica, queda como categoría genérica." - }, - "enum": [ - { - "title": "Gastronomy", - "description": { - "en": "Gastronomy", - "es": "Gastronomía", - "pt": "Gastronomia" - } - }, - { - "title": "621102", - "description": { - "en": "Argentina", - "es": "Argentina", - "pt": "Argentina" - } - }, - { - "title": "5611203", - "description": { - "en": "Brazil", - "es": "Brasil", - "pt": "Brasil" - } - }, - { - "title": "5812", - "description": { - "en": "Mexico", - "es": "México", - "pt": "México" - } - }, - { - "title": "5611", - "description": { - "en": "Colombia", - "es": "Colombia", - "pt": "Colômbia" - } - }, - { - "title": "5520", - "description": { - "en": "Peru", - "es": "Perú", - "pt": "Peru" - } - }, - { - "title": "56101", - "description": { - "en": "Uruguay", - "es": "Uruguay", - "pt": "Uruguai" - } - }, - { - "title": "561000", - "description": { - "en": "Chile", - "es": "Chile", - "pt": "Chile" - } - }, - { - "title": "Gas station", - "description": { - "en": "Gas station", - "es": "Estación de servicio", - "pt": "posto de gasolina" - } - }, - { - "title": "473000", - "description": { - "en": "Argentina", - "es": "Argentina", - "pt": "Argentina" - } - }, - { - "title": "4731300", - "description": { - "en": "Brazil", - "es": "Brasil", - "pt": "Brasil" - } - }, - { - "title": "468419", - "description": { - "en": "Mexico", - "es": "México", - "pt": "México" - } - }, - { - "title": "4731", - "description": { - "en": "Colombia", - "es": "Colombia", - "pt": "Colômbia" - } - }, - { - "title": "5050", - "description": { - "en": "Peru", - "es": "Perú", - "pt": "Peru" - } - }, - { - "title": "47300", - "description": { - "en": "Uruguay", - "es": "Uruguay", - "pt": "Uruguai" - } - }, - { - "title": "473001", - "description": { - "en": "Chile", - "es": "Chile", - "pt": "Chile" - } - } - ] - } - } - } -} \ No newline at end of file