TOTVS Varejo PDV Omni

Árvore de páginas

Versões comparadas

Versão antiga 3

changes.mady.by.user William da Silva Sombra

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user William da Silva Sombra

Gravado em

Chave

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

...

Definições dos campos do body

string
Deck of Cards
iddk1
Card
idcard1
labelDescrição dos campos e regras
InformaçãoCampo Banco PVCampo Json APIObrigatórioTipoTamanhoDescriçãoObservação
Grupo

id_grupo

N/A

Não

Texto

2

Identificação do grupo da retaguarda

Campo descontinuado

SituaçãosituacaosituacaoSimInteiro

Define se o perfil em questão está ativo ou inativo.

  • 0 - Inativo
  • 1 - Ativo


Data cadastrodata_cadastrodataAtualizacaoSimData
Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.Gerado automaticamente pelo Server
Data atualizaçãodata_atualizacaodataCadastroSimData
Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.Gerado automaticamente pelo Server
Identificação no retaguardaid_retaguardaidRetaguardaSimTexto100
Card
labelV3.1
Identificador do grupo na retaguarda
idInquilinoN/AidInquilinoSimTexto
Identificador do inquilino
idProprietarioN/AidProprietarioSimTexto
Identificador do proprietário
Identificação no retaguardaid_retaguarda_lojaidRetaguardaLoja

Não

Texto100Identificador da loja na retaguarda
Identificação no ServerN/AloteOrigemSimTexto
Identificador do lote
Identificação no retaguardaid_clienteidRetaguardaClienteSimTexto

Requisição

Section
Column
width50%

Exemplo de body da requisição

[
    {
        "idInquilino": "string",
        "idProprietario": "string",
        "idRetaguarda": "string",
        "idRetaguardaCliente": "string",
        "idRetaguardaLoja": "string",
        "loteOrigem": "string",
        "situacao": 1
    }
]

Column
width50%

Campo

Tipo

Descrição

Obrigatório

Observações

idInquilino

string

Identificador do inquilinoSimidProprietariostringIdentificador do proprietárioSim
idRetaguardastringIdentificador do grupo na retaguardaSimTamanho máximo: 100 caracteres
idRetaguardaCliente

Identificador do cliente na retaguarda
Sim
Este cliente deve estar cadastrado no PDV para que o grupo seja baixado.
idRetaguardaLojastring
Identificação no retaguardaid_retaguarda_grupo idRetaguardaGrupo
Identificador da loja na retaguarda
Não
Tamanho máximo:
Texto100
caracteres
loteOrigemstring
Identificador do
loteSimsituacaoIntSituação do grupoSim0 - Inativo , 1 - ativo

Retorno

Deck of Cards
idretornos
grupo na retaguarda
Card
labelComo integrar

Para maiores informações de como integrar o Grupo Cliente, clique aqui.

200 - Ok
Column
width50%

Exemplo de body de retorno

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

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

dataObjetoRetorno dos dados caso tenhaerrorsObjeto

Objeto contendo todos os erros encontrados.

messageString

Descrição do erro

numberOfRecordsIntNúmero de arquivos processadossuccessBoolStatus da requisiçãototalTimeIntTempo total Card
label400 - Bad Request
Column
width50%

Exemplo de body de retorno

{
    "data": null,
    "errors": {
        "0": {
            "IdRetaguarda": [
                ""
            ]
        }
    },
    "message": null,
    "numberOfRecords": 9,
    "success": false,
    "totalTime": 4077
}

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

dataObjetoRetorno dos dados caso tenhaerrorsObjeto

Objeto contendo todos os erros encontrados.

Cada propriedade desse objeto é o indice do grupo enviado que está com erro.

messageString

Descrição do erro

numberOfRecordsIntNúmero de arquivos processadossuccessBoolStatus da requisiçãototalTimeIntTempo total