Para garantir o pleno funcionamento do PDV Omni, é essencial que os dados da loja estejam devidamente cadastrados. A partir dessas informações, o PDV Omni irá imprimir documentos fiscais e não fiscais, preencher as tags de XML das operações de venda e integrar-se ao ERP.

Abaixo listamos as informações essenciais para pleno funcionamento do PDV. 



1. Método para integração

Método é responsável pela criação de loja

Este endpoint recebe uma lista de lojas para que possam ser enviados vários na mesma requisição

Para que a baixa da loja criada ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 1 = loja

2. Exemplo de requisição


[
    {
        "bairro": "string",
        "cep": "string",
        "cidade": "string",
        "cnpj": "string",
        "codigoIdentificacaoLoja": "string",
        "codigoMaster": "string",
        "codigoMunicipioIbge": "string",
        "codigoOrganizacional": "string",
        "codigoUFIBGE": "string",
        "complemento": "string",
        "endereco": "string",
        "estado": "string",
        "idDominioManutencao": "string",
        "idInquilino": "string",
        "idProprietario": "string",
        "idRetaguarda": "string",
        "idRetaguardaRede": "string",
        "inscricaoEstadual": "string",
        "inscricaoMunicipal": "string",
        "loteOrigem": "string",
        "modeloFiscal": 0,
        "nomeFantasia": "string",
        "nomeMaster": "string",
        "numero": "string",
        "numeroLoja": "string",
        "razaoSocial": "string",
        "rede": "string",
        "regimeTributario": 0,
        "siglaUf": "string",
        "situacao": 1,
        "telefone": "string"
    }
]

2. Descrição de campos e regras

InformaçõesCampo banco PDVCampo Json APIObrigatórioTipoTamanhoDescrição
Razão socialrazao_socialrazaoSocialSimTexto50
Nome fantasianome_fantasianomeFantasiaSimTexto50
CNPJcnpjcnpjSimTexto20Enviar o campo sem formatação (sem ".", "/", "(", ")" ou "-")
Inscrição estadualinscricao_estadualinscricaoEstadualSimTexto15Enviar o campo sem formatação (sem ".", "/", "(", ")" ou "-")
Inscrição municipalinscricao_municipalinscricaoMunicipalNãoTexto15Enviar o campo sem formatação (sem ".", "/", "(", ")" ou "-")
EndereçoenderecoenderecoSimTexto200Rua
Número do endereçonumeronumeroSimTexto10
Complemento do endereçocomplementocomplementoNãoTexto100
Bairro do endereçobairrobairroSimTexto150
Cidade do endereçocidadecidadeSimTexto150
Estado do endereçoestadoestadoSimTexto50Exemplo "SÃO PAULO"
UF do endereçosigla_ufsiglaUfSimTexto20Exemplo "SP"
Código IBGE do estadocodigo_ibgeCodigoUFIBGESimTexto50
Código IBGE do municípiocodigo_municipio_ibgeCodigoMunicipioIbgeSimTexto50
CEP do endereçocepcepSimTexto10Enviar o campo sem formatação (sem ".", "/", "(", ")" ou "-")
TelefonetelefonetelefoneNãoTexto20Enviar campo com DDD+Telefone. Enviar o campo sem formatação (sem ".", "/", "(", ")" ou "-")
Código identificação da lojacodigo_identificacao_lojacodigoIdentificacaoLojaSimTexto20
SituaçãosituacaosituacaoSimInteiro
  • 0 - Inativo
  • 1 - Ativo

Deixar sempre como 1.

Data do cadastrodata_cadastroN/ASimData
Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
Data de atualizaçãodata_atualizacaoN/ASimData
Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.
Modelo fiscalmodelo_fiscalmodeloFiscalSimInteiro
  • 0 - Não configurado
  • 1 -SAT
  • 2 - NFCe
  • 3 - MFe
Rede/GruporederedeSimTexto40
  • 0 - Default
  • 1 - Boticário
  • 2 - GrandCru
  • 3 - Totvs
  • 4 - PetCamp
  • 5 - CacauShow
  • 6 - Loreal
  • 7 - Maybelline
  • 8 - UnderArmor
  • 9 - NyxMakeup
  • 10 - Omnistory
  • 11 - TotvsChef
  • 12 - Qdb
  • 13 - Eudora
Regime tributárioregime_tributarioregimeTributarioSimInteiro
  • 0 - Simples nacional
  • 1 - Regime normal
Número identificaçãonumero_lojanumeroLojaSimTexto30Este campo pode ser o mesmo que o codigo_identificacao_loja, ou para alguns casos pode acontecer de ser retirado dígitos a direita (0 a direita)
Código de identificação no retaguardaid_retaguardaidRetaguardaSimTexto100
Código de identificação da rede no retaguardaid_retaguarda_redeidRetaguardaRedeSimTexto100
Código da mastercodigo_mastercodigoMasterSimTexto50
Nome da masternome_masternomeMasterSimTexto50
Id do inquilinoid_inquilinoidInquilinoNãoTexto250
Id de manutenção do domínioid_dominio_manutencaoidDominioManutencaoNãoTexto100
Utiliza PAFutiliza_pafN/ASimInteiro
  • 0 - False
  • 1 - True
Data atualização do PAFdata_atualizacao_pafN/ANãoData

Código da organizaçãocodigo_organizacionalN/ANãoTexto100

Deverá existir apenas 1 registro de loja no banco de dados dos PDV Omni, caso exista mais de um apenas o primeiro registro será considerado.

No momento da instalação do PDV o registro 1 é criado no banco de dados com informações básicas para que a integração consiga preencher o restantes dos campos. Essas informações são: 
Instalação via BUS: CNPJ, codigo_identificação_loja, data_cadastro, data_atualização
Instalação via Meu Suporte: CNPJ, codigo_identificação_loja, data_cadastro, data_atualização (em breve será adicionado o campo id_inquilino nessa instalação)

A configuração do modelo fiscal pode ser informada pela integração e também pode ser realizada diretamente no PDV Omni, através da opção de "Configurações do sistema".

Para mais informações consulte: https://tdn.totvs.com/pages/viewpage.action?pageId=805985408

3. Retorno de sucesso 


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


Definições dos campos do retorno

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

4. Retorno de falha 


{
    "code": "string",
    "message": "string",
    "detailedMessage": "string",
    "helpUrl": "string",
    "details": [
        {
            "guid": "string",
            "code": "string",
            "message": "string",
            "detailedMessage": "string"
        }
    ]
}

Definições dos campos do retorno

Campo

Tipo

Descrição

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro