POST /api/retaguarda/inquilinolotesexternos

Este método é responsável pela abertura de lote pela retaguarda

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

O retorno dessa requisição gerará um código chamado loteOrigem, ele é de suma importância, pois, esse código identifica qual o lote que pertence o(s) dado(s) e deverá ser passado no envio dos dados para que a integração funcione corretamente.

Body da requisição

{
"status": 0,
"tipoLote": [
17
],
"idInquilino": "{{IdInquilino}}"
}

Definição dos campos de requisição

Campo	Tipo	Descrição	Observações
idInquilino	string	idInquilino gerado na criação do inquilino	Não Nulo
tipoLote	Lista de string	Lista dos tipos de dados a serem enviados. São aceitos vários tipos. (Tipos na seção Tipos Lote)	Não nulo
status	string	Status do lote, na abertura sempre enviar 0 - Inicio Envio	Não nulo

Tipos Lote

Os tipos de dados passados na requisição são os seguintes:

Cliente = 0
Loja = 1
Motivo = 2
Perfil = 3
Usuario = 4
FcpProduto = 5
Compartilhamento = 6
Imposto = 7
Ncm = 8
PisCofins = 9
TributoNcm = 10
ClassificacaoProduto = 11
Produto = 12
Preco = 13
Estoque = 14
Operadora = 15
DadoComplementarPagto = 16
CondicaoPagto = 17
FormaPagto = 18
CanalVenda = 24
AlteracaoCliente = 40
AlteracaoImposto = 47
AlteracaoNcm = 48
AlteracaoPisCofins = 49
AlteracaoTributoNcm = 50
AlteracaoClassificacaoProduto = 51
AlteracaoProduto = 52
AlteracaoPreco = 53
AlteracaoEstoque = 54
PreVenda = 55
ClienteEndereco = 56

Retorno da requisição

{
"success": true,
"message": "",
"data": {
"loteOrigem": "{LoteOrigem}",
"mensagem": null,
"status": 0,
"tipoLote": [
"17"
],
"idInquilino": "{IdInquilino)",
"dataAtualizacao": "{DataAtualizacao}",
"dataCadastro": "{DataCadastro}",
"id": "{Identificador}",
"_expandables": []
}
}

Definição dos campos de retorno

Campo	Tipo	Descrição
Success	bool	Indica se a criação do lote foi feita com sucesso
Message	string	Caso ocorra erros durante a criação do lote eles serão enviados nesse campo
Data	objeto	Objeto lote criado
Data.LoteOrigem	string	Número de identificação do lote
Data.Mensagem	string
Data.Status	int	Status do lote
Data.TipoLote	List String	Lista de tipos de dados que serão enviados no lote
Data.IdInquilino	string	idInquilino vinculado ao lote
Data.DataAtualização	datetime	Data da ultima atualização do registo
Data.DataCadastro	datetime	Data de criação do lote
Data.Id	string	Identificador do lote no banco

Atalhos

Árvore de páginas