Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Para acessar os dados a requisição é a seguinte

  • Endpoint:
    • V2: /api/pdvsyncclient/v2/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


title da title
Deck of Cards
ida
Card
labelV3.1(V2)
Expandir

Exemplo de body

de requisição:

Column
width50%

[
    {
        "idMensagem": "string",
        "observacao": "string",
        "status": 0
    }
]

Expandir


Tipos de staus:

CódigoStatusDescrição
0ProcessarPendente consumo pela retaguarda
1ProcessadaConsumido pela retaguarda
2ErroConsumido com erro pela retaguarda
3ReprocessarPara reprocessar
4


IntegradoComSucesso

Integrado com sucesso pela retaguarda
Column
width50%

Definição dos campos de requisição

Campo

Tipo

Descrição

Observações

idMensagemStringIdentificador da Trocano POSH

Obrigatório

observacaoStringObservação enviada pela retaguarda

Opcional

statusIntStatus da venda (Definições abaixo)

Opcional



Expandirdeck
titleStatus
CódigoStatusDescrição
0ProcessarPendente consumo pela retaguarda
1ProcessadaConsumido pela retaguarda
2ErroConsumido com erro pela retaguarda
3ReprocessarPara reprocessar
4IntegradoComSucessoIntegrado com sucesso pela retaguarda
idDefinição dos campos de retorno
Card
label200 ok
Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok
Column
width50%

{
    "success": true,
    "message": "",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Column
width50%

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos
Expandircard
titlelabel400 - Bad RequestBad Request
Column
width50%

{
    "success": false,
    "message": "",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Column
width50%

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos