Á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/vendaMensagens
    • V3: /api/pdvsyncclient/v3/vendaMensagens
  • Método: GETPUT
  • Autenticação: Bearer token
  • Permissão: Client

...

Expandir
titleDefinição dos campos de requisição

Campo

Tipo

Descrição

Observações

idMensagemStringIdentificador da venda no POSH

Obrigatório

observacaoStringObservação enviada pela retaguarda

Opcional

statusIntStatus da venda (Definições abaixo)

Opcional

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

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
Expandir
titleBody de retorno

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

Expandir
title400 - Bad Request

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
Expandir
titleBody de retorno

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