Histórico da Página

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.

Índice

1. Método para integração

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

Endpoint: /api/retaguarda/v2/lojas
Método: Post
Autenticação: Bearer token
Permissão: Retaguarda

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

Aviso
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

Bloco de código

language	c#
title	Exemplo de body da requisição
collapse	true

[
    {
        "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"
    }
]

3. Descrição de campos e regras

Card

id	card1
label	Descrição dos campos e regras

Informações	Campo banco PDV	Campo Json API	Obrigatório	Tipo	Tamanho	Descrição
Razão social	razao_social	razaoSocial	Sim	Texto	50
Nome fantasia	nome_fantasia	nomeFantasia	Sim	Texto	50
CNPJ	cnpj	cnpj	Sim	Texto	20	Enviar o campo sem formatação (sem ".", "/", "(", ")" ou "-")
Inscrição estadual	inscricao_estadual	inscricaoEstadual	Sim	Texto	15	Enviar o campo sem formatação (sem ".", "/", "(", ")" ou "-")
Inscrição municipal	inscricao_municipal	inscricaoMunicipal	Não	Texto	15	Enviar o campo sem formatação (sem ".", "/", "(", ")" ou "-")
Endereço	endereco	endereco	Sim	Texto	200	Rua
Número do endereço	numero	numero	Sim	Texto	10
Complemento do endereço	complemento	complemento	Não	Texto	100
Bairro do endereço	bairro	bairro	Sim	Texto	150
Cidade do endereço	cidade	cidade	Sim	Texto	150
Estado do endereço	estado	estado	Sim	Texto	50	Exemplo "SÃO PAULO"
UF do endereço	sigla_uf	siglaUf	Sim	Texto	20	Exemplo "SP"
Código IBGE do estado	codigo_ibge	CodigoUFIBGE	Sim	Texto	50
Código IBGE do município	codigo_municipio_ibge	CodigoMunicipioIbge	Sim	Texto	50
CEP do endereço	cep	cep	Sim	Texto	10	Enviar o campo sem formatação (sem ".", "/", "(", ")" ou "-")
Telefone	telefone	telefone	Não	Texto	20	Enviar campo com DDD+Telefone. Enviar o campo sem formatação (sem ".", "/", "(", ")" ou "-")
Código identificação da loja	codigo_identificacao_loja	codigoIdentificacaoLoja	Sim	Texto	20
Situação	situacao	situacao	Sim	Inteiro		0 - Inativo 1 - Ativo Deixar sempre como 1.
Data do cadastro	data_cadastro	N/A	Sim	Data		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
Data de atualização	data_atualizacao	N/A	Sim	Data		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.
Modelo fiscal	modelo_fiscal	modeloFiscal	Sim	Inteiro		0 - Não configurado 1 -SAT 2 - NFCe 3 - MFe
Rede/Grupo	rede	rede	Sim	Texto	40	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ário	regime_tributario	regimeTributario	Sim	Inteiro		0 - Simples nacional 1 - Regime normal
Número identificação	numero_loja	numeroLoja	Sim	Texto	30	Este 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 retaguarda	id_retaguarda	idRetaguarda	Sim	Texto	100
Código de identificação da rede no retaguarda	id_retaguarda_rede	idRetaguardaRede	Sim	Texto	100
Código da master	codigo_master	codigoMaster	Sim	Texto	50
Nome da master	nome_master	nomeMaster	Sim	Texto	50
Id do inquilino	id_inquilino	idInquilino	Não	Texto	250
Id de manutenção do domínio	id_dominio_manutencao	idDominioManutencao	Não	Texto	100
Utiliza PAF	utiliza_paf	N/A	Sim	Inteiro		0 - False 1 - True
Data atualização do PAF	data_atualizacao_paf	N/A	Não	Data
Código da organização	codigo_organizacional	N/A	Não	Texto	100

Aviso

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)

Informações

title	Modelo Fiscal

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

4. Retorno de sucesso

Bloco de código

language	c#
title	Exemplo de body da retorno - 200 OK
collapse	true

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

Definições dos campos do retorno

Campo	Tipo	Descrição
Success	bool	Indica se a criação do compartilhamento foi feita com sucesso
Message	string	Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
Data	objeto	Objeto compartilhamento criado
Errors	Lista	Listas com os erros encontrados no processo
TotalTime	int	tempo da requisição
NumberOfRecords	int	número de dados inseridos

5. Retorno de falha

Bloco de código

language	c#
title	Exemplo de body da retorno - 400 Bad Request
collapse	true

{
    "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
code	string	Código de erro
message	string	Mensagem do erro
detailedMessage	string	Detalhamento do erro
helpUrl	string	url de ajuda
TotalTime	string	Tempo total de busca
details	lista de objeto	Lista de objeto de erros
details.guid	string	Identificador do erro
details.code	string	Código do erro
details.message	string	Mensagem do erro
details.detailedMessage	string	Detalhamento do erro

Árvore de páginas

Versões comparadas

Versão antiga 6

Nova versão 7

Chave

1. Método para integração

2. Exemplo de requisição

3. Descrição de campos e regras

4. Retorno de sucesso

5. Retorno de falha