openapi: 3.0.0
info:
title: VTex Anti-fraud Provider Account Conversation API
description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)"
version: '1.0'
servers:
- url: https://{providerApiEndpoint}
description: Anti-fraud provider endpoint URL.
variables:
providerApiEndpoint:
description: Anti-fraud provider endpoint URL.
default: '{providerApiEndpoint}'
tags:
- name: Conversation
paths:
/api/oms/pvt/orders/{orderId}/conversation-message:
get:
tags:
- Conversation
summary: VTex Retrieve order conversation
description: List all order conversations of an order by its order ID.
operationId: GetConversation
parameters:
- name: Accept
in: header
description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
required: true
style: simple
schema:
type: string
default: application/json
- name: Content-Type
in: header
description: Type of the content being sent.
required: true
style: simple
schema:
type: string
default: application/json
- name: orderId
in: path
description: Order ID is a unique code that identifies an order.
required: true
example: 1172452900788-01
style: simple
schema:
type: string
example: 1172452900788-01
responses:
'200':
description: OK
headers:
Cache-Control:
content:
text/plain:
schema:
type: string
example: no-cache
Connection:
content:
text/plain:
schema:
type: string
example: close
Content-Encoding:
content:
text/plain:
schema:
type: string
example: gzip
Date:
content:
text/plain:
schema:
type: string
example: Mon, 13 Feb 2017 15:25:24 GMT
Expires:
content:
text/plain:
schema:
type: string
example: '-1'
Pragma:
content:
text/plain:
schema:
type: string
example: no-cache
Server:
content:
text/plain:
schema:
type: string
example: nginx
Vary:
content:
text/plain:
schema:
type: string
example: Accept-Encoding
X-CDNIgnore:
content:
text/plain:
schema:
type: string
example: '1'
X-Powered-by-VTEX-Janus-Edge:
content:
text/plain:
schema:
type: string
example: v1.35.3
X-Track:
content:
text/plain:
schema:
type: string
example: stable
X-VTEX-Janus-Router-Backend-App:
content:
text/plain:
schema:
type: string
example: omsapi-v1.5.135
content:
application/json; charset=utf-8:
schema:
type: array
items:
$ref: '#/components/schemas/GetConversation'
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: ' recorrenciaqa
Seu pagamento foi aprovado.
Referente ao Pedido #1305371685465-01
Olá, jose. Estamos providenciando a emissão da Nota Fiscal do seu pedido e o envio do seu produto.
Pagamento
Visa final 1111 R$ 3,99 à vista
Atenciosamente, Equipe recorrenciaqa
'
hasAttachment: false
attachmentNames:
- attachments439505
date: '2023-01-23T09:23:31.0000000+00:00'
deprecated: false
components:
schemas:
From:
title: From
description: Conversation sender.
required:
- conversationRelatedTo
- conversationSubject
- emailAlias
- aliasMaskType
- email
- name
- role
type: object
properties:
conversationRelatedTo:
type: string
description: Related order ID.
example: 1305371685465-01
conversationSubject:
type: string
description: Conversation subject.
example: oms
emailAlias:
type: string
description: Sender transactional tracker email.
example: 64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br
aliasMaskType:
type: integer
description: Conversation tracker mask type.
example: 0
email:
type: string
description: Sender's email.
example: noreply@store.com.br
name:
type: string
description: Sender's name.
example: no reply
role:
type: string
nullable: true
description: If it is a client or null, for transactional emails.
example: 'null'
example:
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:
title: To
description: Conversation receiver.
required:
- conversationRelatedTo
- conversationSubject
- emailAlias
- aliasMaskType
- email
- name
- role
type: object
properties:
conversationRelatedTo:
type: string
description: Related order ID.
example: 1305371685465-01
conversationSubject:
type: string
description: Conversation subject.
example: oms
emailAlias:
type: string
description: Sender transactional tracker email.
example: 64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br
aliasMaskType:
type: integer
description: Conversation tracker mask type.
example: 0
email:
type: string
description: Receiver's email.
example: customer.name@email.com
name:
type: string
description: Receiver's name.
example: Mary John
role:
type: string
description: If it is a customer or null, for transactional emails.
example: Customer
example:
conversationRelatedTo: 1305371685465-01
conversationSubject: oms
emailAlias: 64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br
aliasMaskType: 0
email: customer.name@email.com
name: Mary John
role: Customer
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: ' recorrenciaqa
Seu pagamento foi aprovado.
Referente ao Pedido #1305371685465-01
Olá, jose. Estamos providenciando a emissão da Nota Fiscal do seu pedido e o envio do seu produto.
Pagamento
Visa final 1111 R$ 3,99 à vista
Atenciosamente, Equipe recorrenciaqa
'
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: ' recorrenciaqa
Seu pagamento foi aprovado.
Referente ao Pedido #1305371685465-01
Olá, jose. Estamos providenciando a emissão da Nota Fiscal do seu pedido e o envio do seu produto.