Páginas filhas
  • DR VA Integração API Produto - Requisições de Produto

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.




...

Obter saldo de produto por empresa

  • Requsição que retorna saldo de um ou mais produtos por empresa.
  • Link para documentação técnica: obter saldo produto por empresa
Totvs custom tabs box
tabsClassificação de Produto, Preço do Produto, Saldo de Produtos por Grupo, Saldo de Produto por Lote, Saldo de Produto por Empresa
idsclassificacaoproduto,precoproduto,saldogrupo,saldoloteproduto,saldoproduto
Totvs custom tabs box items
defaultyes
referenciaclassificacaoproduto

01. INTRODUÇÃO

Obter classificação de produto 

  • Requisição que retorna a classificação de um produto.
Totvs custom tabs box items
defaultno
referenciaconsultarclassificacoesdeproduto
Bloco de código
titleURL
https://www30.bhan.com.br:9443/api/v1/produto/classificacaoproduto
Bloco de código
titleMÉTODO
POST
Bloco de código
titleCABEÇALHO
Token: "XXXXXXXXXXXXXX"
Bloco de código
titleEXEMPLO REQUISIÇÃO
collapsetrue
{
    "cdProduto": 999999999,
    "cdBarra": "XXXXXXXXXXXXX"
}
Bloco de código
titleEXEMPLO RESPOSTA
collapsetrue
[
    {
        "cdProduto": 10,						//Código do produto
        "cdBarra": "5809600000107",				//Código de barras do produto
        "dsProduto": "BASICA AMARELO DV",		//Descrição do produto
        "cdTpClassificacao": 22,				//Código do tipo de classificação
        "dsTpClassificacao": "MARCA",			//Descrição do tipo de classificação
        "cdClassificacao": "3",					//Código da classificação
        "dsClassificacao": "CLAS 3",			//Descrição classificação
        "cdGrupo": "2",							//Código do grupo
        "dsGrupo": "BASICA",					//Descrição do grupo
        "cdNivel": "300 2",						//Código do nível
        "dsNivel": "BASICA",					//Descrição do nível
        "cdCor": "1",							//Código da cor
        "dsCor": "UN",							//Descrição da cor
        "cdTamanho": 1,							//Código do tamanho
        "dsTamanho": "34",						//Descrição do tamanho
        "cdEspecie": "SVC"						//Código da espécie
    }
]
Totvs custom tabs box items
defaultno
referenciaprecoproduto

01. INTRODUÇÃO

Requisição que tem a finalidade de retornar os preços de um ou mais produtos, incluindo os valores promocionais.

Observação: Se a grade possuir um produto padrão configurado, todos os produtos receberão o mesmo valor do produto padrão.

02. UTILIZAÇÃO


Totvs custom tabs box
tabsEnvio, Retorno, Exemplo de Implementação
idsenvio,retorno,cod
Totvs custom tabs box items
defaultyes
referenciaenvio
Totvs custom tabs box
tabsURL, Body, Exemplo de Requisição, Detalhamento dos Campos
idsurlE,corpoE,exE,campE
Totvs custom tabs box items
defaultyes
referenciaurlE

Button
Cor#61affe
TextoPOST
Link.
 https://www30.bhan.com.br:9443/api/v1/produto/precoproduto

Totvs custom tabs box items
defaultno
referenciacorpoE
Bloco de código
languagexml
themeRDark
firstline1
titleBody
linenumberstrue
{
    "produtos": [
        {
            "cdProduto": "XXXXXXXXXXXXXXXXXXXX"
        }
    ],
    "cdPreco": 9999,
    "inPromocao": 9,
    "empresas": [
        {
            "cdEmpresa": 9999,
            "nrCNPJEmpresa": "XXXXXXXXXXXXXX"
        }
    ]
}
Totvs custom tabs box items
defaultno
referenciaexE

URL

Button
Cor#61affe
TextoPOST
Link.
 https://www30.bhan.com.br:9443/api/v1/produto/precoproduto


HEADER

AuthorizationBearer {{token}}


BODY


Bloco de código
languagexml
themeRDark
firstline1
titleBody
linenumberstrue
{
    "produtos": [
        {
            "cdProduto": "100"
        }
    ],
    "cdPreco": 1,
    "inPromocao": 1,
    "empresas": [
        {
            "cdEmpresa": 1
        }
    ]
}
Totvs custom tabs box items
defaultno
referenciacampE

Image AddedImage Added


NomeTipoDescriçãoExemploVA
cdProdutostringCódigo do produto *"cdProduto": "100"Referência 1
cdPrecointCódigo do Preço"cdPreco": 1Referência 2
inPromocaointValor de Promoção **"inPromocao": 1--
cdEmpresaintCódigo da Empresa ***"cdEmpresa": 1Referência 3
nrCNPJEmpresastringCNPJ da Empresa ***"nrCNPJEmpresa": "12345678901234"--



*Neste campo podemos informar o código sku do produto ou o código de barras do produto.

**Neste campo podemos informar 1 (um) para retornar os valores promocionais ou 0 (zero) para NÃO retornar os valores promocionais.

***Neste campo quando Código da Empresa for informado, não existe a necessidade de informar o CNPJ. Porém, caso o Código não for informado, o documento se torna obrigatório!

Informações

Todos os campos são obrigatórios. Caso possua a opção de informar  código e/ou documento, pelo menos um dos campos deve ser informado!

Totvs custom tabs box items
defaultno
referenciaretorno
Totvs custom tabs box
tabsSucesso, Erro
idssucesso,erro
Totvs custom tabs box items
defaultyes
referenciasucesso
Bloco de código
languagexml
themeRDark
firstline1
titleStatus 200 OK
linenumberstrue
{
    "precos": [
        {
            "cdSKU": 9999999,
            "cdProduto": "XXXXXXXXXX",
            "dsProduto": "XXXXXXXXXX",
            "cdReferencia": "XXXXXXXXXX",
            "cdCor": "XXXXXXXXX",
            "dsTamanho": "XXXXXXXXXX",
            "cdEmpresa": 999999999,
            "nrCNPJEmpresa": "XXXXXXXXXXX",
            "vlPreco": 999999999.99,
            "vlPrecoPromocao": 999999999.99
        }
    ]
}
Totvs custom tabs box items
defaultno
referenciaerro
Bloco de código
languagexml
themeRDark
firstline1
titleStatus 400 Bad Request
linenumberstrue
{
    "dsErro": "Mensagem informativa do erro"
}
Totvs custom tabs box items
defaultno
referenciacod
Totvs custom tabs box
tabsConsulta Preço Produto, Token, Preço Produto
idsapi,token,prproduto
Totvs custom tabs box items
defaultyes
referenciaapi
Totvs custom tabs box
tabsMain, DtoBuilder, DtoEnvioProdutoBuilder, DtoEnvioEmpresaBuilder
idsmain,dtoB,dtoProduto,dtoEmpresa
Totvs custom tabs box items
defaultyes
referenciamain
Bloco de código
languagec#
themeRDark
firstline1
titleMain
linenumberstrue
public class ApiPrecoProduto
    {
        static void Main(string[] args)
        {
            var token = Token.ObterToken();
            var dto = PopularDto();
            RequisicaoPrecoProduto.PrecoProdutoConsulta(token, dto);
        }

        private static PrecoProdutoDTO.Envio PopularDto()
        {
            var dto = new DtoBuilder()
                .ComProdutos(ObterProduto())
                .ComCodigoPreco(1)
                .ComIncluiPromocao(1)
                .ComEmpresas(ObterEmpresa())                
                .Build();
            return dto;
        }

        private static List<Empresa> ObterEmpresa()
        {
            var empresas = new List<Empresa>();

            empresas.Add(
                new DtoEnvioEmpresaBuilder()
                .ComCodigoEmpresa(1)
                .ComNumeroCNPJEmpresa("12345678901234")
                .Build()
                );
            return empresas;
        }

        private static List<Produto> ObterProduto()
        {
            var produtos = new List<Produto>();

            produtos.Add(
                new DtoEnvioProdutoBuilder()
                .ComCodigoProduto("100")
                .Build()
                );
            return produtos;
        }
    }
Totvs custom tabs box items
defaultno
referenciadtoB
Bloco de código
languagec#
themeRDark
firstline1
linenumberstrue
public class DtoBuilder
    {
        private readonly PrecoProdutoDTO.Envio _dto;

        public DtoBuilder()
        {
            _dto = new PrecoProdutoDTO.Envio();
        }

        public DtoBuilder ComProdutos(Produto _produto)
        {
            _dto.Produtos.Add(_produto);
            return this;
        }

        public DtoBuilder ComProdutos(List<Produto> _produtos)
        {
            _dto.Produtos = _produtos;
            return this;
        }

        public DtoBuilder ComCodigoPreco(int codigoPreco)
        {
            _dto.CodigoPreco = codigoPreco;
            return this;
        }

        public DtoBuilder ComIncluiPromocao(int incluiPromocao)
        {
            _dto.IncluiPromocao = incluiPromocao;
            return this;
        }

        public DtoBuilder ComEmpresas(Empresa _empresa)
        {
            _dto.Empresas.Add(_empresa);
            return this;
        }

        public DtoBuilder ComEmpresas(List<Empresa> _empresas)
        {
            _dto.Empresas = _empresas;
            return this;
        }

        public PrecoProdutoDTO.Envio Build() => _dto;
    }    
Totvs custom tabs box items
defaultno
referenciadtoProduto
Bloco de código
languagec#
themeRDark
firstline1
linenumberstrue
    public class DtoEnvioProdutoBuilder
    {
        private readonly Produto _produto;

        public DtoEnvioProdutoBuilder()
        {
            _produto = new Produto();
        }

        public DtoEnvioProdutoBuilder ComCodigoProduto(string codigoProduto)
        {
            _produto.CodigoProduto = codigoProduto;
            return this;
        }

        public Produto Build() => _produto;
    }
Totvs custom tabs box items
defaultno
referenciadtoEmpresa
Bloco de código
languagec#
themeRDark
firstline1
linenumberstrue
 public class DtoEnvioEmpresaBuilder
    {
        private readonly Empresa _empresa;

        public DtoEnvioEmpresaBuilder()
        {
            _empresa = new Empresa();
        }

        public DtoEnvioEmpresaBuilder ComCodigoEmpresa(int codigoEmpresa)
        {
            _empresa.CodigoEmpresa = codigoEmpresa;
            return this;
        }

        public DtoEnvioEmpresaBuilder ComNumeroCNPJEmpresa(string numeroCNPJEmpresa)
        {
            _empresa.NumeroCNPJEmpresa = numeroCNPJEmpresa;
            return this;
        }

        public Empresa Build() => _empresa;
    }    
Totvs custom tabs box items
defaultno
referenciatoken
Totvs custom tabs box
tabsObter Token, LoginDTO
idsobterToken,login
Totvs custom tabs box items
defaultyes
referenciaobterToken
Bloco de código
languagec#
themeRDark
firstline1
titleToken
linenumberstrue
public class Token
    {
        private const string _applicationJson = "application/json";
        private const string _baseUri = @"http://www30.bhan.com.br:9443/api/v1/";
        private const string _usuario = "usuario";
        private const string _senha = "senha";


        public static string ObterToken()
        {
            LoginDTO.EnvioToken login = new LoginDTO.EnvioToken(_usuario, _senha);

            var cliente = PopularCliente();


            var uri = @"autorizacao/token";
            var conteudo = new StringContent(_applicationJson);
            var response = cliente.PostAsync(uri, conteudo).Result;

            if (!response.IsSuccessStatusCode)
                throw new Exception();

            var retorno = JsonConvert.DeserializeObject<LoginDTO.RetornoToken>(response.Content.ReadAsStringAsync().Result);
            return retorno.Token.Replace("Bearer", "").Trim();

        }


        private static HttpClient PopularCliente()
        {
            HttpClient cliente = new HttpClient();
            cliente.BaseAddress = new Uri($"{_baseUri}");
            cliente.DefaultRequestHeaders.Accept.Clear();
            cliente.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(_applicationJson));
            cliente.DefaultRequestHeaders.Add("usuario", _usuario);
            cliente.DefaultRequestHeaders.Add("senha", _senha);
            cliente.Timeout = TimeSpan.FromDays(1);

            return cliente;
        }
    }
Totvs custom tabs box items
defaultno
referencialogin
Bloco de código
languagec#
themeRDark
firstline1
titleLogin
linenumberstrue
public class LoginDTO
    {
        public class EnvioToken
        {
            [JsonProperty("usuario")]
            public string Usuario { get; set; }

            [JsonProperty("senha")]
            public string Senha { get; set; }

            public EnvioToken(string usuario, string senha)
            {
                Usuario = usuario;
                Senha = senha;
            }
        }

        public class RetornoToken
        {
            [JsonProperty("cdToken")]
            public string Token { get; set; }

            [JsonProperty("dtExpiracao")]
            public string DataExpiracao { get; set; }

            public RetornoToken(string token, string dataExpitacao)
            {
                Token = token;
                DataExpiracao = dataExpitacao;
            }
        }
    }
Totvs custom tabs box items
defaultno
referenciaprproduto
Totvs custom tabs box
tabsRequisicaoPrecoProduto, PrecoProdutoDTO, Produto, Empresa
idsrequisicao,dto,produto,empresa
Totvs custom tabs box items
defaultyes
referenciarequisicao
Bloco de código
languagec#
themeRDark
firstline1
linenumberstrue
public class RequisicaoPrecoProduto
    {
        private const string _balseUri = @"http://www30.bhan.com.br:9443/api/v1/";
        private const string _applicationJson = "application/json";

        public static PrecoProdutoDTO.Retorno PrecoProdutoConsulta(string token, PrecoProdutoDTO.Envio dto)
        {
            var uri = @"produto/precoproduto";
            var json = JsonConvert.SerializeObject(dto);
            var cliente = PopularCliente(token);
            var conteudo = new StringContent(json, Encoding.UTF8, _applicationJson);
            var response = cliente.PostAsync(uri, conteudo).Result;

            if (!response.IsSuccessStatusCode)
                throw new Exception();

            return JsonConvert.DeserializeObject<PrecoProdutoDTO.Retorno>(response.Content.ReadAsStringAsync().Result);
        }

        private static HttpClient PopularCliente(string token)
        {
            HttpClient cliente = new HttpClient();
            cliente.BaseAddress = new Uri($"{_balseUri}");
            cliente.DefaultRequestHeaders.Accept.Clear();
            cliente.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(_applicationJson));
            cliente.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);

            return cliente;
        }
    }
Totvs custom tabs box items
defaultno
referenciadto
Bloco de código
languagec#
themeRDark
firstline1
linenumberstrue
public class PrecoProdutoDTO
    {
        public class Envio
        {
            public List<Produto> Produtos { get; set; }
            public List<Empresa> Empresas { get; set; }

            public Envio()
            {
                Produtos = new List<Produto>();
                Empresas = new List<Empresa>();
            }

            [JsonProperty("cdPreco")]
            public int CodigoPreco { get; set; }

            [JsonProperty("inPromocao")]
            public int IncluiPromocao { get; set; }
        }

        public class Retorno
        {
            public List<RetornoPrecoProduto> precos { get; set; }

            public Retorno()
            {
                precos = new List<RetornoPrecoProduto>();
            }
        } 
    }
Totvs custom tabs box items
defaultno
referenciaproduto
Bloco de código
languagec#
themeRDark
firstline1
linenumberstrue
    public class Produto
    {
        [JsonProperty("cdProduto")]
        public string CodigoProduto { get; set; }
    }
Totvs custom tabs box items
defaultno
referenciaempresa
Bloco de código
languagec#
themeRDark
firstline1
linenumberstrue
    public class Empresa
    {
        [JsonProperty("cdEmpresa")]
        public int CodigoEmpresa { get; set; }

        [JsonProperty("nrCNPJEmpresa")]
        public string NumeroCNPJEmpresa { get; set; }
    }
Totvs custom tabs box items
defaultno
referenciasaldogrupo

01. INTRODUÇÃO

Obter saldo dos produtos de um grupo por empresa

...

  • Requisição que retorna saldo de um grupo de produtos por empresa.
Totvs custom tabs box items
defaultno
referenciaconsultarclassificacoesdeproduto
Bloco de código
titleURL
https://www30.

...

Obter preço de produto por empresa

  • Requsição que retorna o preço de um ou mais produtos por empresa.
  • Link para documentação técnica: preço produto por empresa
bhan.com.br:9443/api/v1/produto/saldogrupo
Bloco de código
titleMÉTODO
POST
Bloco de código
titleCABEÇALHO
Token: "XXXXXXXXXXXXXX"
Bloco de código
titleEXEMPLO REQUISIÇÃO
collapsetrue
{
    "cdReferencia": "XXXXXXXXXXXXXXXXXXXX",
    "cdGrupo": "XXXXXXXXXX",
    "cdCor": "XXXXXXXXXX",
    "dsTamanho": "XXXXXXXXXX",
    "cdSaldo": 9999,
    "inEstoque": 9,
    "inPedidoVenda": 9,
    "empresas": [
        {
            "cdEmpresa": 9999,
            "nrCNPJEmpresa": "XXXXXXXXXXXXXX"
        }
    ]
}
Bloco de código
titleEXEMPLO RESPOSTA
collapsetrue
{
   "saldos": [
        {
            "cdSKU": 999999999,									"Código reduzido do produto"
            "cdProduto": "XXXXXXXXXXXXXXXXXXXX",				"Código de barras do produto"
            "cdReferencia": "XXXXXXXXXXXXXXXXXXXX",				"Código da Referência"
            "cdCor": "XXXXXXXXXX",								"Código da Cor"
            "dsTamanho": "XXXXXXXXXX",							"Descrição do Tamanho"
            "cdEmpresa": 9999,									"Código da Empresa"
            "nrCNPJEmpresa": "XXXXXXXXXXXXXX",					"CNPJ da Empresa"
            "qtEstoque":9999999.999,							"Quantidade em estoque"
            "qtPedidoVenda":9999999.999							"Quantidade em Pedido de Venda"
        }
    ]
}  
Totvs custom tabs box items
defaultno
referenciasaldoloteproduto

01. INTRODUÇÃO

Obter saldo em lote produto por empresa

  • Requisição que retorna o saldo de lote de um ou mais produtos por empresa
Totvs custom tabs box items
defaultno
referenciaconsultarclassificacoesdeproduto
Bloco de código
titleURL
https://www30.bhan.com.br:9443/api/v1/produto/saldoloteproduto
Bloco de código
titleMÉTODO
POST
Bloco de código
titleCABEÇALHO
Token: "XXXXXXXXXXXXXX"
Bloco de código
titleEXEMPLO REQUISIÇÃO
collapsetrue
{  
   "produtos": [
        {
            "cdProduto": "XXXXXXXXXXXXXXXXXXXX"
        }
    ],
   "cdSaldo": 9999,
   "inEstoque":  9,
   "inPedidoVenda":  9,
   "inTransacao":  9,
   "empresas": [
        {
            "cdEmpresa": 9999,
            "nrCNPJEmpresa": "XXXXXXXXXXXXXX"
        }
    ]
}
Bloco de código
titleEXEMPLO RESPOSTA
collapsetrue
{
   "lotes": [
        {
            "cdSKU": 999999999,												"Código reduzido do produto"
            "cdProduto": "XXXXXXXXXXXXXXXXXXXX",							"Código de barras do produto"
            "cdEmpresa": 9999,												"Código da Empresa"
            "nrCNPJEmpresa": "XXXXXXXXXXXXXX",								"CNPJ da Empresa"
            "nrLote": 999999999,											"Número do Lote"
            "nrItem": 999999999,											"Número do Item do Lote"
            "cdLote": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",				"Código do Lote"
            "qtEstoque":9999999.999,										"Quantidade em estoque"
            "qtPedidoVenda":9999999.999,									"Quantidade em Pedido de Venda"
            "qtTransacao":9999999.999										"Quantidade em Transação"
        }
    ]
} 
Totvs custom tabs box items
defaultno
referenciasaldoproduto

01. INTRODUÇÃO

Obter saldo de

...

produto por empresa

  • Requisição que retorna

...

  • saldo

...

  • de um ou mais produtos por empresa

...

  • .
Totvs custom tabs box items
defaultno
referenciaconsultarclassificacoesdeproduto
Bloco de código
titleURL
https://www30.bhan.com.br:9443/api/v1/produto/saldoproduto
Bloco de código
titleMÉTODO
POST
Bloco de código
titleCABEÇALHO
Token: "XXXXXXXXXXXXXX"
Bloco de código
titleEXEMPLO REQUISIÇÃO
collapsetrue
{
    "produtos": [
        {
            "cdProduto": "XXXXXXXXXXXXXXXXXXXX"
        }
    ],
    "cdSaldo": 9999,                           // informar o código do saldo desejado
    "inEstoque": 9,                            // informar igual a 1 para retornar o saldo em estoque
    "inPedidoVenda": 9,                        // informar igual a 1 para retornar o saldo em pedido de venda
    "empresas": [
        {
            "cdEmpresa": 9999,
            "nrCNPJEmpresa": "XXXXXXXXXXXXXX"
        }
    ]
}
Bloco de código
titleEXEMPLO RESPOSTA
collapsetrue
{
   "saldos": [
        {
        	"cdSKU": 999999999,								"Código reduzido do produto"
            "cdProduto": "XXXXXXXXXXXXXXXXXXXX",			"Código de barras do produto"
            "cdReferencia": "XXXXXXXXXXXXXXXXXXXX",			"Código da Referência"
            "cdCor": "XXXXXXXXXX",							"Código da Cor"
            "dsTamanho": "XXXXXXXXXX",						"Descrição do Tamanho"
            "cdEmpresa": 9999,								"Código da Empresa"
            "nrCNPJEmpresa": "XXXXXXXXXXXXXX",				"CNPJ da Empresa"
            "qtEstoque":9999999.999,						"Quatidade em Estoque"
            "qtPedidoVenda":9999999.999						"Quantidade em Pedido de Venda"
        }
    ]
} 

...