Árvore de páginas

Versões comparadas

Chave

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

...

Este método é responsável pela consulta de um compartilhamento

  • Endpoint: /api/pdvsyncclientretaguarda/v2/compartilhamentos/{id}/{lote}/{qtdRegistros}/{idRetaguardaLoja}/{sequencial?}idInquilino}
  • Método: Get
  • Autenticação: Bearer token
  • Permissão: PDVSyncClient Retaguarda

Este endpoint exibe uma lista de compartilhamentos dos filtros realizados no próprio endpoint

...

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

Campo

Tipo

Descrição

Observações

idstringId do Inquilino
lotestringNúmero do loteqtdRegistrosintQuantidade de registros que irá retornar na listaIdRetaguardaLojastringIdentificador da loja na retaguarda
sequencialintSequencial para paginação

Opcional


Expandir
titleRetorno da requisição

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

Expandir
titleDefinição dos campos de retorno

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucessoRetorna os compartilhamento existentes por inquilino
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campobusca de compartilhamentos
DataobjetoObjeto compartilhamento
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos

...