...
Para acessar os dados a requisição é a seguinte
- Endpoint:
- V2: /api/pdvsyncclient/v2
/trocamensagens- /prevendamensagens
- V3: /api/pdvsyncclient/v3/prevendamensagens
- Método: PUT
- Autenticação: Bearer token
- Permissão: Client
O endpoint recebe uma lista de vendas para que seja possivel enviar várias na mesma requisição
| Deck of Cards |
|---|
|
|
| Expandir |
|---|
title | da de requisição: | Column |
|---|
| [
{
"idMensagem": "string",
"observacao": "string",
"status": 0
}
] |
|
|
| Expandir |
|---|
Tipos de staus: | Código | Status | Descrição |
|---|
| 0 | Processar | Pendente consumo pela retaguarda | | 1 | Processada | Consumido pela retaguarda | | 2 | Erro | Consumido com erro pela retaguarda | | 3 | Reprocessar | Para reprocessar | | 4 | | Integrado com sucesso pela retaguarda |
|
|
| title | Definição dos campos de requisição Campo | Tipo | Descrição | Observações |
|---|
| idMensagem | String | Identificador da Trocano POSH | Obrigatório | | observacao | String | Observação enviada pela retaguarda | Opcional | | status | Int | Status da venda (Definições abaixo) | Opcional |
|
|
|
| Expandirdeck |
|---|
|
| Código | Status | Descrição |
|---|
| 0 | Processar | Pendente consumo pela retaguarda |
| 1 | Processada | Consumido pela retaguarda |
| 2 | Erro | Consumido com erro pela retaguarda |
| 3 | Reprocessar | Para reprocessar |
| 4 | IntegradoComSucesso | Integrado com sucesso pela retaguarda |
| id | Definição dos campos de retorno |
|---|
|
|
| Expandir |
|---|
| title | Definição dos campos de retorno |
|---|
|
| Expandir |
|---|
| | Column |
|---|
| {
"success": true,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Campo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
| Expandircard |
|---|
| titlelabel | 400 - Bad RequestBad Request |
|---|
| | Column |
|---|
| {
"success": false,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Campo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
|
