Árvore de páginas

Este 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

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

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

Campo

Tipo

DescriçãoObservações

Obrigatório

Regras do campo


loteOrigem

stringCódigo do loteSim

idInquilino

stringIdentificador do inquilinoSim

idRetaguarda

stringIdentificador da loja na retaguarda

Sim

Tamanho máximo: 100 caracteres


idProprietario

stringIdentificador do proprietário. (Adicionando na criação do compartilhamento)Sim

razaoSocial

stringRazão social da loja

Sim

Tamanho máximo (50)


nomeFantasia

stringNome Fantasia da loja

Sim

Tamanho máximo (50)


cnpj

stringCNPJ da lojaSimTamanho máximo (14)

inscricaoEstadual

stringInscrição estadual da lojaSim

Tamanho máximo (15)

Tamanho mínimo (2)


endereco

stringEndereço da loja

Sim

Tamanho máximo (200)

Tamanho mínimo (2)


numero

stringNúmero do local da lojaNãoTamanho máximo (10)

bairro

stringBairro da loja

Sim

Tamanho máximo (150)

Tamanho mínimo (2)


cidade

sringCidade da loja

Sim

Tamanho máximo (150) 

Tamanho mínimo (2)


estado

stringEstado da loja

Sim

Tamanho máximo (50)


siglaUf

stringSigla do estado da lojaSim

Tamanho máximo (2)

Tamanho mínimo (2)


CodigoUFIBGE

stringCódigo do estadoSimTamanho igual (2)

CodigoMunicipioIbge

stringCódigo do municípioNãoTamanho igual (7)

cep

stringCep da lonaSim Tamanho máximo (8)

complemento

stringComplemente do endereço da loja

Não

Tamanho máximo (100) 

Tamanho mínimo (2)


modeloFiscal

EnumModelo fiscal utilizado (Tipos abaixo)Não

Enviar um dos tipos abaixo.

Caso não tenha definido o valor deste campo, informar "null" ou não enviar esse campo na requisição 

regimeTributario

intRegime tributário utilizado (Tipos abaixo)Sim

rede

stringRede da loja

Sim

Tamanho máximo (40)


numeroLoja

stringNumero da lojaSimTamanho máximo (30)

telefone

stringTelefone da loja

Não



Informar somente os números

inscricaoMunicipal

stringInscrição municipal da lojaNãoTamanho máximo (15)

codigoIdentificacaoLoja

stringCódigo de identificação da loja

Sim

Tamanho máximo (20)


situacao

intSituação da loja (Tipos abaixo)Sim

idRetaguardaRede

stringIdentificador da rede naretaguardaNãoTamanho máximo (100)

codigoMaster

stringCódigo masterNãoTamanho máximo (50)

nomeMaster

stringNome masterNãoTamanho máximo (50)

idDominioManutencao

stringIdentificador dominio manutençãoNão

codigoOrganizacional

stringCodigo OrganizacionalNão

CódigoNome
0SimplesNacional
1RegimeNormal
CódigoNome
0NaoConfigurado
1SAT
2NFCe
3MFE

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

Campo

Tipo

Descrição

SuccessboolIndica se a criação da loja foi feita com sucesso
MessagestringCaso ocorra erros durante a criação da loja eles serão enviados nesse campo
DataobjetoObjeto loja criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos
  • Sem rótulos