TOTVS Varejo PDV Omni

Árvore de páginas

Api responsável pela abertura de lote, para abrir um lote é necessário fazer uma requisição POST para inquilinolotesexternos, enviando um tipo ou uma lista de tipos de lote. 

  • Endpoint:
    • /api/retaguarda/inquilinolotesexternos
    • /api/retaguarda/v2/inquilinolotesexternos
    • /api/retaguarda/v3/inquilinolotesexternos
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda
  • Microserviço: PDVSync.Core.Controle

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.


{
    "status": 0,
    "tipoLote": [
        {Codigo do Tipo}
    ],
    "idInquilino": "{{IdInquilino}}"
}

Campo

Tipo

Descrição

Obrigatório

Observações

idInquilino

stringidInquilino gerado na criação do inquilinoXNão Nulo 

tipoLote

Lista de stringLista dos tipos de dados a serem enviados. São aceitos vários tipos. (Tipos  na seção Tipos Lote)XNão nulo

status

stringStatus do lote, na abertura sempre enviar 0 - Inicio EnvioXNão nulo

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
    Grupo = 21
    CanalVenda = 24
    AlteracaoCliente = 40
    AlteracaoImposto = 47
    AlteracaoNcm = 48
    AlteracaoPisCofins = 49
    AlteracaoTributoNcm = 50
    AlteracaoClassificacaoProduto = 51
    AlteracaoProduto = 52
    AlteracaoPreco = 53
    AlteracaoEstoque = 54
    PreVenda = 55
    ClienteEndereco = 56
    RamoAtividade = 58
    Regradescontoacrescimo = 59
    Regiao = 100

Campo

Tipo

Descrição

SuccessboolIndica se a criação do lote foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do lote eles serão enviados nesse campo
DataobjetoObjeto lote criado

Data.LoteOrigem

stringNúmero de identificação do lote

Data.Mensagem

string

Data.Status

intStatus do lote
Data.TipoLoteList StringLista de tipos de dados que serão enviados no lote

Data.IdInquilino

stringidInquilino vinculado ao lote

Data.DataAtualização

datetimeData da ultima atualização do registo

Data.DataCadastro

datetimeData de criação do lote

Data.Id

stringIdentificador do lote no banco

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

Campo

Tipo

Descrição

successboolIndica se a criação do lote foi feita com sucesso
messagestringCaso ocorra erros durante a criação do lote eles serão enviados nesse campo
datastringObjeto lote criado
errorsstringObjeto com Detalhamento do erro
errors.inquilinostringInquilino responsável pela aberturado lote
errors.tipodadostringTipo do lote aberto
errors.lotestringNumero do Lote que apresentou erro
error.errorCodenumberCódigo do erro - 3 para erro na abertura
error.errorDetailstringDescrição detalhada do erro
totalTimenumberTempo de resposta
numberOfRecordsnumberNumero de registros

{
    "success": false,
    "message": "Não é possível solicitar um novo lote. Lote {NumeroDoLote} em andamento",
    "data": null,
    "errors": {
        "inquilino": "{IdInquilino}",
        "tipoDado": "0",
        "lote": "{NumeroDoLote}",
        "errorCode": 3,
        "errorDetail": "Não é possível solicitar um novo lote. Lote {NumeroDoLote} em andamento"
    },
    "totalTime": 0,
    "numberOfRecords": 0
}




  • Sem rótulos