VTEX · Schema

GetConversation

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string Conversation ID.
from object
to array Conversation receiver.
subject string Conversation content subject.
firstWords string First words of Conversation content.
body string Conversation content body.
hasAttachment boolean When set as `true`, it means there are attachments, when set as `false`, there are not.
attachmentNames array List with attachments' names, if there are any.
date string Conversation date.
View JSON Schema on GitHub

JSON Schema

vtex-getconversation-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetConversation",
  "title": "GetConversation",
  "required": [
    "id",
    "from",
    "to",
    "subject",
    "firstWords",
    "body",
    "hasAttachment",
    "attachmentNames",
    "date"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Conversation ID.",
      "example": "2023-01-23t09-23-08_619a80a05aa34efb982b309c7a1910e3"
    },
    "from": {
      "$ref": "#/components/schemas/From"
    },
    "to": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/To"
      },
      "description": "Conversation receiver."
    },
    "subject": {
      "type": "string",
      "description": "Conversation content subject.",
      "example": "Your payment has been aproved."
    },
    "firstWords": {
      "type": "string",
      "description": "First words of Conversation content.",
      "example": "Your payment has been aproved and we are waiting for..."
    },
    "body": {
      "type": "string",
      "description": "Conversation content body.",
      "example": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional //EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\"> <html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:o=\"urn:schemas-microsoft-com:office:office\" xmlns:v=\"urn:schemas-microsoft-com:vml\" style=\"-webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; box-sizing: border-box; width: 100%; height: 100%; margin: 0; padding: 0; background: #f1f1f1 !important;\"> <head> <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"/> <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\"/> <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\"/> <title>recorrenciaqa</title> <!--[if gte mso 9]> <xml> <o:OfficeDocumentSettings> <o:AllowPNG/> <o:PixelsPerInch>96</o:PixelsPerInch> </o:OfficeDocumentSettings> </xml> <![endif]--> <style> a[x-apple-data-detectors] { color: inherit !important; text-decoration: none !important; font-size: inherit !important; font-family: inherit !important; font-weight: inherit !important; line-height: inherit !important; } </style> <style> @media (max-width: 600px) { img { max-width: 100% !important; height: auto !important; } } </style> <style> @media screen and (min-width: 30em) { .ph4-ns { padding-left: 2rem !important; padding-right: 2rem !important; } .mv4-ns { margin-top: 2rem !important; margin-bottom: 2rem !important; } } </style> </head> <body style=\"-webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; box-sizing: border-box; width: 100%; height: 100%; margin: 0; padding: 0; background: #f1f1f1 !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\"> <table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"box-sizing: border-box; margin: 0; padding: 0; background: #f1f1f1; border-collapse: collapse; border-spacing: 0; mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif; width: 100%; height: 100%; line-height: 100% !important;\"> <tr style=\"box-sizing: border-box !important;\"> <td align=\"left\" valign=\"top\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\"> <table class=\"mv4-ns\" width=\"100%\" align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"box-sizing: border-box; max-width: 40rem; width: 100%; background-color: #fff; border-collapse: collapse; border-spacing: 0; mso-table-lspace: 0pt; mso-table-rspace: 0pt !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" bgcolor=\"#fff\"> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; border-bottom-style: solid; border-bottom-width: 1px; border-color: #eee; width: 100%; padding-bottom: 2rem; text-align: center !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"center\"> <div style=\"box-sizing: border-box; width: 8rem; margin-bottom: 1rem; margin-top: 2rem; margin-right: auto; margin-left: auto !important;\"> <a href=\"http://.com.br\" style=\"box-sizing: border-box !important;\"> <img alt=\"\" border=\"0\" width=\"auto\" src=\"http://licensemanager.vtex.com.br/api/site/pub/accounts/9ddcfba5-3855-49ec-b61e-b2847b9314cc/logos/show\" style=\"vertical-align: top; outline: none; text-decoration: none; -ms-interpolation-mode: bicubic; max-width: 100%; border: none; max-height: 80px !important;\"> </img></a> </div> <h1 style=\"margin: 0; font-size: 50px; line-height: 58px; box-sizing: border-box !important;\">Seu pagamento foi aprovado.</h1> <div style=\"box-sizing: border-box; color: #777; margin-top: .5rem !important;\"> Referente ao Pedido <span style=\"font-weight: 700 !important;\">#1305371685465-01</span> </div> </td> </tr> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left; width: 100% !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"left\"> <div style=\"box-sizing: border-box; margin-top: 2rem !important;\"> <p style=\"box-sizing: border-box !important;\">    Ol\u00e1, jose.     Estamos providenciando a emiss\u00e3o da Nota Fiscal do seu pedido e o envio do seu produto.  </p> </div> </td> </tr> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left; width: 100%; padding-bottom: 2rem; padding-top: 1rem !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"left\"> <h3 style=\"font-size: 20px; line-height: 36px; text-transform: uppercase; letter-spacing: 1.2pt; font-weight: 300; margin-top: 16px; box-sizing: border-box; margin: 0 !important;\">Pagamento</h3>    <div style=\"box-sizing: border-box; line-height: 1.5; font-size: 1.25rem !important;\"> Visa  final 1111  <br/>R$ 3,99  \u00e0 vista  </div>     </td> </tr> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left; border-top-style: solid; border-top-width: 1px; border-color: #eee; padding-top: 1rem; padding-bottom: 1rem !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"left\"> <p style=\"box-sizing: border-box !important;\"> Atenciosamente,<br/>Equipe recorrenciaqa </p> </td> </tr> </table> </td> </tr> </table> </body> </html>"
    },
    "hasAttachment": {
      "type": "boolean",
      "description": "When set as `true`, it means there are attachments, when set as `false`, there are not.",
      "example": false
    },
    "attachmentNames": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Name of the attachment.",
        "example": "attachments439505"
      },
      "description": "List with attachments' names, if there are any."
    },
    "date": {
      "type": "string",
      "description": "Conversation date.",
      "example": "2023-01-23T09:23:31.0000000+00:00"
    }
  },
  "example": {
    "id": "2023-01-23t09-23-08_619a80a05aa34efb982b309c7a1910e3",
    "from": {
      "conversationRelatedTo": "1305371685465-01",
      "conversationSubject": "oms",
      "emailAlias": "noreply@vtexcommerce.com.br-9814872b.ct.store.com.br",
      "aliasMaskType": 0,
      "email": "noreply@store.com.br",
      "name": "no reply",
      "role": "null"
    },
    "to": [
      {
        "conversationRelatedTo": "1305371685465-01",
        "conversationSubject": "oms",
        "emailAlias": "64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br",
        "aliasMaskType": 0,
        "email": "customer.name@email.com",
        "name": "Mary John",
        "role": "Customer"
      }
    ],
    "subject": "Your payment has been aproved.",
    "firstWords": "Your payment has been aproved and we are waiting for...",
    "body": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional //EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\"> <html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:o=\"urn:schemas-microsoft-com:office:office\" xmlns:v=\"urn:schemas-microsoft-com:vml\" style=\"-webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; box-sizing: border-box; width: 100%; height: 100%; margin: 0; padding: 0; background: #f1f1f1 !important;\"> <head> <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"/> <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\"/> <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\"/> <title>recorrenciaqa</title> <!--[if gte mso 9]> <xml> <o:OfficeDocumentSettings> <o:AllowPNG/> <o:PixelsPerInch>96</o:PixelsPerInch> </o:OfficeDocumentSettings> </xml> <![endif]--> <style> a[x-apple-data-detectors] { color: inherit !important; text-decoration: none !important; font-size: inherit !important; font-family: inherit !important; font-weight: inherit !important; line-height: inherit !important; } </style> <style> @media (max-width: 600px) { img { max-width: 100% !important; height: auto !important; } } </style> <style> @media screen and (min-width: 30em) { .ph4-ns { padding-left: 2rem !important; padding-right: 2rem !important; } .mv4-ns { margin-top: 2rem !important; margin-bottom: 2rem !important; } } </style> </head> <body style=\"-webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; box-sizing: border-box; width: 100%; height: 100%; margin: 0; padding: 0; background: #f1f1f1 !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\"> <table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"box-sizing: border-box; margin: 0; padding: 0; background: #f1f1f1; border-collapse: collapse; border-spacing: 0; mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif; width: 100%; height: 100%; line-height: 100% !important;\"> <tr style=\"box-sizing: border-box !important;\"> <td align=\"left\" valign=\"top\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\"> <table class=\"mv4-ns\" width=\"100%\" align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"box-sizing: border-box; max-width: 40rem; width: 100%; background-color: #fff; border-collapse: collapse; border-spacing: 0; mso-table-lspace: 0pt; mso-table-rspace: 0pt !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" bgcolor=\"#fff\"> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; border-bottom-style: solid; border-bottom-width: 1px; border-color: #eee; width: 100%; padding-bottom: 2rem; text-align: center !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"center\"> <div style=\"box-sizing: border-box; width: 8rem; margin-bottom: 1rem; margin-top: 2rem; margin-right: auto; margin-left: auto !important;\"> <a href=\"http://.com.br\" style=\"box-sizing: border-box !important;\"> <img alt=\"\" border=\"0\" width=\"auto\" src=\"http://licensemanager.vtex.com.br/api/site/pub/accounts/9ddcfba5-3855-49ec-b61e-b2847b9314cc/logos/show\" style=\"vertical-align: top; outline: none; text-decoration: none; -ms-interpolation-mode: bicubic; max-width: 100%; border: none; max-height: 80px !important;\"> </img></a> </div> <h1 style=\"margin: 0; font-size: 50px; line-height: 58px; box-sizing: border-box !important;\">Seu pagamento foi aprovado.</h1> <div style=\"box-sizing: border-box; color: #777; margin-top: .5rem !important;\"> Referente ao Pedido <span style=\"font-weight: 700 !important;\">#1305371685465-01</span> </div> </td> </tr> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left; width: 100% !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"left\"> <div style=\"box-sizing: border-box; margin-top: 2rem !important;\"> <p style=\"box-sizing: border-box !important;\">    Ol\u00e1, jose.     Estamos providenciando a emiss\u00e3o da Nota Fiscal do seu pedido e o envio do seu produto.  </p> </div> </td> </tr> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left; width: 100%; padding-bottom: 2rem; padding-top: 1rem !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"left\"> <h3 style=\"font-size: 20px; line-height: 36px; text-transform: uppercase; letter-spacing: 1.2pt; font-weight: 300; margin-top: 16px; box-sizing: border-box; margin: 0 !important;\">Pagamento</h3>    <div style=\"box-sizing: border-box; line-height: 1.5; font-size: 1.25rem !important;\"> Visa  final 1111  <br/>R$ 3,99  \u00e0 vista  </div>     </td> </tr> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left; border-top-style: solid; border-top-width: 1px; border-color: #eee; padding-top: 1rem; padding-bottom: 1rem !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"left\"> <p style=\"box-sizing: border-box !important;\"> Atenciosamente,<br/>Equipe recorrenciaqa </p> </td> </tr> </table> </td> </tr> </table> </body> </html>",
    "hasAttachment": false,
    "attachmentNames": [
      "attachments439505"
    ],
    "date": "2023-01-23T09:23:31.0000000+00:00"
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/vtex-getconversation"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.