TOTVS Varejo PDV Omni

Árvore de páginas

Versões comparadas

Versão antiga 7

changes.mady.by.user Ianara Santos Rocha

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

Retorno

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_retaguardaidRetaguardaSimTexto100Identificador 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
Identificador do cliente na retaguardaEste cliente deve estar cadastrado no PDV para que o grupo seja baixado.
Identificação no retaguardaid_retaguarda_grupo idRetaguardaGrupoNãoTexto100Identificador do grupo na retaguarda

Este método é responsável pela criação de um novo grupo

  • Endpoint: /api/retaguarda/v3/dadosdinamicos/down/21/{versão}
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda
    • Microserviço: PDVSync.Core.Cliente

    Requisição

    Card
    labelComo integrar

    Este endpoint recebe uma lista de grupos permitindo vários em uma mesma requisição

    Aviso

    Para que a baixa do grupo criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 21 = grupo

    É necessário que o inquilino tenha o parametro 21 - grupo cadastrado no controle.

    Todo grupo deve estar vinculado a um cliente cadastrado no PDV para que seja baixado, clique aqui para acessar a documentação do envio de cliente.

    Deck of Cards
    idversoes2
    Card
    labelV3.1
    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
    idRetaguardaClientestringIdentificador do cliente na retaguardaSimEste cliente deve estar cadastrado no PDV para que o grupo seja baixado.
    idRetaguardaLojastringIdentificador da loja na retaguardaNãoTamanho máximo: 100 caracteres
    loteOrigemstringIdentificador do loteSim
    situacaoIntSituação do grupoSim0 - Inativo , 1 - ativo
    Deck of Cards
    idretornos
    Card
    label200 - 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 índice do grupo enviado que está com erro.

    messageString

    Descrição do erro

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

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