Documentação da API aberta do Ideris. Essa documentação terá informações sobre:
\nSegue uma lista com os possívels status de retornos da API:
\nAção POST responsável por trazer o token de autenticação. Para criação do token utilizamos JWT, que define uma maneira compacta e independente de transmitir com segurança informações entre as partes como um objeto JSON. A informação retornada deve ser utilizada no Header das demais chamadas da API.
\nSugerimos que seja criado um usuário específico para integração. Para criar esse novo usuário basta ir no menu Configuração > Usuario (dentro de Acessos) e criar um novo usuário com perfil 'Integração'. Caso não seja possível criar um novo usuário, os usuários com perfil 'Administrador' possuem acesso a página para gerar o login_token. Na nossa página de suporte disponibilizamos um passo a passo de como criar gerar o token para integração.
\nRealizando o login no usuário da integração o login_token poderá ser gerado no Menu Configuração > Integração > Token de autenticação. É necessário cadastrar um responsável técnico, de preferência a pessoa/empresa responsável pelo desenvolvimento da integração. Após cadastrar o responsável técnico será possível gerar o token.
\nO token JWT expira em 24 horas após a criação do mesmo. Se expirado, o HTTPStatus retornado pela API é o 401 - Unauthorized.
\nAo chamar a ação Login, é necessário informar o Content-Type 'application/json' no Header e o login_token em um objeto JSON no Body.
\n","urlObject":{"path":["Login"],"host":["{{Url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3db6589-2654-4fb1-994b-8b485fc2c4be"}],"id":"151ba154-9c6e-4eaf-959c-3f14e5d5d614","description":"Pasta onde fica as ações referentes a autenticação junto ao Ideris. O retorno da autenticação é uma string contendo um token JWT.
\n","event":[{"listen":"prerequest","script":{"id":"64ad6f65-1e71-4d44-87e5-37609adbd2bb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a6d13b25-3bf4-4e08-aca9-b272e3572010","type":"text/javascript","exec":[""]}}],"_postman_id":"151ba154-9c6e-4eaf-959c-3f14e5d5d614"},{"name":"Atualização","item":[{"name":"Busca atualizações da API","id":"b0f62d47-83fe-4220-80ef-8a628d1a9583","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Ação GET responsável por trazer a lista de atualizações realizadas na API pública do Ideris. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 50 vezes por minuto.
\nOs parâmetros de filtro são:
\noffset - Valor inicial da pesquisa, parâmetro para ajudar na paginação
\n\n\n/Atualizacao?offset=
\n
limit - Valor máximo de itens na busca. O valor máximo do limit é 50 (cinquenta)
\n\n\n/Atualizacao?limit=
\n
Obs: Não é necessário informar os parâmetros de filtro, somente os desejados.
\nO retorno será um objeto JSON contendo as principais informações da atualização. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Atualização dessa documentação.
\n","urlObject":{"protocol":"http","path":["Atualizacao"],"host":["api","ideris","com","br"],"query":[{"key":"offset","value":"Pasta onde fica as ações referentes a atualização da API do Ideris. Segue abaixo informações sobre o retorno padrão da ação de Atualização:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [\n {\n \"descricao\": null, //Descrição da atualização : string\n \"descricaoLonga\": null, //Descrição mais detalhada da atualização : string\n \"criticidade\": null, //Nível de impacto da atualização : string\n \"data\": null //Data que a atualização foi publicada\n }\n ]\n}\nAção GET responsável por trazer a lista de status e o módulo no qual esse status é utilizado. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 50 vezes por minuto.
\nOs parâmetros de filtro são:
\noffset - Valor inicial da pesquisa, parâmetro para ajudar na paginação
\n\n\n/Status?offset=
\n
limit - Valor máximo de itens na busca. O valor máximo do limit é 50 (cinquenta)
\n\n\n/Status?limit=
\n
Obs: Não é necessário informar os parâmetros de filtro, somente os desejados.
\nO retorno será um objeto JSON contendo as principais informações do status. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Status dessa documentação.
\n","urlObject":{"protocol":"http","path":["Status"],"host":["api","ideris","com","br"],"query":[{"key":"offset","value":"Pasta onde fica as ações de status junto ao Ideris. Segue abaixo informações sobre o retorno padrão das ações do Status:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [ //Informações da lista de status\n {\n \"id\": null, //ID do status : int\n \"descricao\": null, //Descrição do status : string\n \"modulo\": null //Descrição de onde esse status é utilizado. Ex: Pedido, Nota Fiscal, Anúncio\n }\n ]\n}\nAção GET responsável por trazer a lista de marketplaces integrados ao Ideris. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 50 vezes por minuto.
\nOs parâmetros de filtro são:
\noffset - Valor inicial da pesquisa, parâmetro para ajudar na paginação
\n\n\n/Marketplace?offset=
\n
limit - Valor máximo de itens na busca. O valor máximo do limit é 50 (cinquenta)
\n\n\n/Marketplace?limit=
\n
Obs: Não é necessário informar os parâmetros de filtro, somente os desejados.
\nO retorno será um objeto JSON contendo as principais informações do marketplace. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Marketplace dessa documentação.
\n","urlObject":{"protocol":"http","path":["Marketplace"],"host":["api","ideris","com","br"],"query":[{"key":"offset","value":"Pasta onde fica as ações de marketplace junto ao Ideris. Segue abaixo informações sobre o retorno padrão das ações do Marketplace:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [ //Informações da lista de marketplace\n {\n \"id\": null, //ID do marketplace : int\n \"descricao\": null, //Nome do marketplace : string\n }\n ]\n}\nAção GET responsável por trazer a lista de protocolos pendentes ou buscar o protocolo através do código. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 50 vezes por minuto.
\nSe for busca da lista de protocolos pendentes do início basta não informar nada na URL. Exemplo:
\n\n\n/Protocolo
\n
Para paginação disponibilizamos os parâmetros de filtro offset e limit que devem ser informados na URL. Exemplo:
\n\n\n/Protocolo?offset=15&limit=5
\n
Caso a busca seja de um código específico, basta informar o mesmo na URL. Exemplo:
\n\n\n/Protocolo?codigo=<Código de identificação do protocolo>
\n
O retorno será um objeto JSON contendo as principais informações do protocolo. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Protocolo dessa documentação.
\nSegue abaixo alguns pontos sobre o Protocolo:
\nPasta onde fica as ações de protocolo junto ao Ideris.\nSegue abaixo informações sobre o retorno padrão das ações do Protocolo:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [ //Informações do protocolo\n {\n \"id\": null, //ID do protocolo : int\n \"dataCriacao\": null, //Data de criação do protocolo : DateTime\n \"codigo\": null, //Código GUID do protocolo : string\n \"tipoFeed\": null, //Tipo do protocolo (Ex: Cadastro de produto) : string\n \"status\": null, //Status do protocolo (Ex: Pendente ou Finalizado) : string\n \"mensagem\": null //Mensagem do protocolo. Se status for 'Finalizado' e a mensagem estiver vazia significa que o processo foi concluído com sucesso. Se o status for 'Finalizado' e a mensagem estiver preenchida signigica que houve algum problema durante o processo : string\n }\n ]\n}\nAção GET responsável por trazer a lista de produtos ativos ou buscar o produto através do código SKU. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 50 vezes por minuto.
\nSe for busca da lista de produtos do início basta não informar nada na URL. Exemplo:
\n\n\n/Produto
\n
Para paginação disponibilizamos os parâmetros de filtro offset e limit que devem ser informados na URL. Exemplo:
\n\n\n/Produto?offset=15&limit=5
\n
Caso a busca seja de um código SKU específico, basta informar o mesmo na URL. Exemplo:
\n\n\n/Produto?sku=Codigo_SKU
\n
Para incluir as imagens do produto na pesquisa, basta informar o parâmetro include na URL. Exemplo:
\n\n\n/Produto?include=imagem
\n
O retorno será um objeto JSON contendo as principais informações do produto. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Produto dessa documentação.
\n","urlObject":{"protocol":"http","path":["Produto"],"host":["api","ideris","com","br"],"query":[{"key":"sku","value":"Ação GET responsável por buscar o produto através do ID. Essa ação pode ser chamada no máximo 50 vezes por minuto. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e informar o ID do produto desejado após '/' na URL. Exemplo:
\n\n\n/Produto/1
\n
Para incluir as imagens do produto na pesquisa, basta informar o parâmetro include na URL. Exemplo:
\n\n\n/Produto?include=imagem
\n
O retorno será um objeto JSON contendo as principais informações do produto. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Produto dessa documentação.
\n","urlObject":{"protocol":"http","path":["Produto","Ação responsável por cadastrar o produto. Essa é uma ação POST e para chamá-la é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e um objeto JSON no Body. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nObservação: em 11/02/2022 foi incluído o campo \"dataValidade\" no processo de inserção do produto via API pública Ideris, em produto simples, produto composto e produto com variação, onde se for enviada a data no formato \"0001-01-01\" limpa o campo.
\nA Partir do dia 06-07-2021 incluímos o Produto Composto no Cadastro de Produto do Ideris. Mais informações podem ser vistas no BODY abaixo.
\nSegue abaixo os campos que podem ser informados para cadastro do produto:
\nBODY
\n{\n \"sku\": null, //Código SKU do produto : string, obrigatório\n \"titulo\": null, //Tíulo / Nome do produto : string, obrigatório\n \"descricaoLonga\": null, //Descrição longa do produto : string, obrigatório\n \"categoriaML\": null, //ID da categoria junto ao Mercado Livre (https://api.mercadolibre.com/sites/MLB/categories) : string\n \"categoriaIdIderis\": null, //ID da categoria no Ideris : int, obrigatório\n \"subCategoriaIdIderis\": null, //ID da sub categoria no Ideris : int, obrigatório\n \"marcaIdIderis\": null, //ID da marca no Ideris : int, obrigatório\n \"departamentoIdIderis\": null, //ID do departamento no Ideris : int, obrigatório\n \"ncmId\": null, //ID do NCM no Ideris : int, nullable\n \"produtoOrigemId\": null, //ID da origem do produto no Ideris : int, nullable\n \"modelo\": null, //Modelo do produto : string\n \"garantia\": null, //Garantia do produto : string\n \"videoYoutube\": null, //Link do vídeo do Youtube: string\n \"peso\": null, //Peso do produto (em gramas) : decimal, nullable\n \"comprimento\": null, //Comprimento do produto (em centímetros) : decimal, nullable\n \"largura\": null, //Largura do produto (em centímetros) : decimal, nullable\n \"altura\": null, //Altura do produto (em centímetros) : decimal, nullable\n \"pesoEmbalagem\": null, //Peso do produto embalado (em quilos) : decimal, nullable\n \"comprimentoEmbalagem\": null, //Comprimento do produto embalado (em metros) : decimal, nullable\n \"larguraEmbalagem\": null, //Largura do produto embalado (em metros) : decimal, nullable\n \"alturaEmbalagem\": null, //Altura do produto embalado (em metros) : decimal, nullable\n \"cest\": null, //Código CEST do produto : string\n \"ean\": null, //Código EAN do produto : string\n \"valorCusto\": null, //Valor de custo do produto : decimal, obrigatório\n \"valorVenda\": null, //Valor de venda do produto : decimal, obrigatório\n \"dataValidade\":null, //Data de validade do produdo, onde se for enviado no formato \"0001-01-01\" limpa o campo.\n \"quantidadeEstoquePrincipal\": null, //Quantidade de estoque principal do produto. Somente preencher quando for produto simples. : int, nullable\n \"Variacao\": [ //Nó que agrupa as variações. Somente preencher se for um produto com variação. Caso contrário deixar vazio. O número máximo de variações em um produto é 50 (cinquenta).\n {\n \"skuVariacao\": null, //Código SKU da variação : string, obrigatório\n \"quantidadeVariacao\": null, //Quantidade de estoque da variação : int, obrigatório\n \"nomeAtributo\": null, //Nome do atributo personalizado da variação. O nome do atributo deve ser o mesmo para todas as variações. Ex: Tamanho, Polegada : string, obrigatório\n \"valorAtributo\": null, //Valor do atributo da variação : string, obrigatorio\n \"Imagem\": [ //Nó que agrupa as imagens da variação. É necessário informar pelo menos uma imagem e no máximo cinco imagens por variação. Não é necessário informar os 2 campos, porém se ambos forem informados levaremos em consideração o campo 'urlImagem'\n {\n \"urlImagem\": null, //URL da imagem da variação. Extensões aceitas: PNG, JPG e JPEG : string\n \"imagemBase64\": null //String contendo informações da extensão e Base64 da imagem. A string deve ser no seguinte formato: type:image/;base64: : string\n }\n ]\n }\n ],\n \"Imagem\": [ //Nó que agrupa as imagens do produto. É necessário informar pelo menos uma imagem e no máximo dez imagens. Se houver variação as imagens inseridas aqui serão ignoradas. Não é necessário informar os 2 campos, porém se ambos forem informados levaremos em consideração o campo 'urlImagem'\n {\n \"urlImagem\": null, //URL da imagem da variação. Extensões aceitas: PNG, JPG e JPEG : string\n \"imagemBase64\": null //String contendo informações da extensão e Base64 da imagem. A string deve ser no seguinte formato: type:image/;base64: : string\n }\n ],\n \"ProdutoComposto\": [ //Nó que agrupa os produtos contidos no produto.\n {\n \"skuProdutoFilho\": null, //Código do produto contido no produto principal : string\n \"quantidade\": null //Quantidade do produto contido no produto principal : int \n }\n ]\n}\n\nComo o processo de criação de produto pode levar um certo tempo, o retorno será um objeto JSON contendo um Protocolo. Para acompanhar o processo de criação do produto basta buscar informações sobre o protocolo retornado na ação 'Busca protocolos pendentes ou busca protocolo por código'. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Protocolo dessa documentação.
\nSegue abaixo alguns pontos a se atentar durante o cadastro de Produto:
\nA partir do dia 01/10/2019 disponibilizamos o envio da imagem por Base64. Segue alguns pontos a se atentar sobre o envio de imagens:
\nAção responsável por atualizar o produto. Essa é uma ação PUT e para chamá-la é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e um objeto JSON no Body. Esse objeto deve conter pelo menos um identificador do produto e as informações que deseja alterar. Não é necessário informar campos que não serão atualizados. Essa ação pode ser chamada no máximo 50 vezes por minuto.
\nNo momento disponibilizamos a atualização de alguns dos atributos do produto. Segue abaixo os campos que podem ser informados para atualização do produto:
\nBODY
\n{\n //Campos abaixo são atributos de identificação do produto. Só precisa informar um deles para localizar o produto.\n \"id\": null, //ID do produto : int, nullable\n \"sku\": null, //Código SKU do produto : string\n \"estoquePrincipalId\": null, //ID do estoque do produto : int, nullable\n\n //Os campos abaixo são atributos de atualização do produto. Só informar quando os mesmos serão atualizados.\n \"titulo\": null, //Título do produto : string\n \"valorCusto\": null, //Valor de custo do produto : decimal, nullable\n \"valorVenda\": null, //Valor de venda do produto : decimal, nullable\n \"atualizarValoresProdutoComposto\": null, //Caso verdadeiro, irá atualizar os valores dos produtos compostos que contém o produto simples atualizado : booleano\n \"atualizarValoresMarketplace\": null, //Caso verdadeiro, irá atualizar os valores dos anúncios desse produto : booleano\n \"quantidadeEstoquePrincipal\": null, //Quantidade em estoque do produto. Esse campo só poderá ser atualizado se o produto for do tipo 'Simples', tipoProdutoId 1. Caso contrário esse campo é o somatório do estoque das variações, ao alterar o estoque de uma variação esse campo também será alterado : int, nullable\n\n //A opção de edição dos campos abaixo foram incluidos no dia 21/10/2019. Quando informado 'NULL' ou vazio, o campo será ignorado na edição.\n \"descricaoLonga\": null, //Descrição longa do produto : string\n \"categoriaIdIderis\": null, //ID da categoria no Ideris : int, nullable\n \"subCategoriaIdIderis\": null, //ID da sub categoria no Ideris : int, nullable\n \"marcaIdIderis\": null, //ID da marca no Ideris : int, nullable\n \"departamentoIdIderis\": null, //ID do departamento no Ideris : int, nullable\n \"ncmId\": null, //ID do NCM no Ideris : int, nullable\n \"produtoOrigemId\": null, //ID da origem do produto no Ideris : int, nullable\n \"modelo\": null, //Modelo do produto : string\n \"garantia\": null, //Garantia do produto : string\n \"videoYoutube\": null, //Link do vídeo do Youtube: string\n \"peso\": null, //Peso do produto (em gramas) : decimal, nullable\n \"comprimento\": null, //Comprimento do produto (em centímetros) : decimal, nullable\n \"largura\": null, //Largura do produto (em centímetros) : decimal, nullable\n \"altura\": null, //Altura do produto (em centímetros) : decimal, nullable\n \"pesoEmbalagem\": null, //Peso do produto embalado (em quilos) : decimal, nullable\n \"comprimentoEmbalagem\": null, //Comprimento do produto embalado (em metros) : decimal, nullable\n \"larguraEmbalagem\": null, //Largura do produto embalado (em metros) : decimal, nullable\n \"alturaEmbalagem\": null, //Altura do produto embalado (em metros) : decimal, nullable\n \"cest\": null, //Código CEST do produto : string\n \"ean\": null, //Código EAN do produto : string\n\n \"Variacao\": [ //Nó que agrupa as variações do produto. Quando não há alteração na variação, não é necessário informar esse campo\n {\n //Campos abaixo são atributos de identificação da variação. Só precisa informar um deles para localizar a variação e consequentemente o produto.\n \"variacaoId\": null, //ID da variação : int, nullable\n \"skuVariacao\": null, //Código SKU da variação : string\n\n //Os campos abaixo são atributos de atualização da variação. Só informar quando os mesmos serão atualizados.\n \"quantidadeVariacao\": null //Quantidade em estoque da variação : int, nullable\n }\n ]\n}\nObs: Se for informado id e sku na mesma chamada, a prioridade sempre será do id.
\nO retorno será um objeto JSON contendo as principais informações do produto atualizado. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Produto dessa documentação.
\nA partir do dia 26/06/2020, disponibilizamos mais dois campos:
\nPasta onde fica ações referentes ao produto e estoque. Segue abaixo informações sobre o retorno padrão das ações do Produto:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [ //Informações do Produto\n {\n \"id\": null, //ID do produto : int\n \"sku\": null, //Código SKU do produto : string\n \"titulo\": null, //Título do produto : string\n \"descricaoLonga\": null, //Descrição longa do produto : string\n \"marcaId\": null, //ID da marca do produto : int, nullable\n \"marca\": null, //Descrição da marca : string\n \"departamentoId\": null, //ID do departamento : int, nullable\n \"departamento\": null, //Descrição do departamento : string\n \"categoriaId\": null, //ID da categoria : int, nullable\n \"categoria\": null, //Descrição da categoria : string\n \"subCategoriaId\": null, //ID da sub categoria : int, nullable\n \"subCategoria\": null, //Descrição da sub categoria : string\n \"modelo\": null, //Descrição do modelo : string\n \"garantia\": null, //Descrição da garantia : string\n \"peso\": null, //Peso do produto (em gramas) : decimal, nullable\n \"comprimento\": null, //Comprimento do produto (em centímetros) : decimal, nullable\n \"largura\": null, //Largura do produto (em centímetros) : decimal, nullable\n \"altura\": null, //Altura do produto (em centímetros) : decimal, nullable\n \"pesoEmbalagem\": null, //Peso do produto embalado (em quilos) : decimal, nullable\n \"comprimentoEmbalagem\": null, //Comprimento do produto embalado (em metros) : decimal, nullable\n \"larguraEmbalagem\": null, //Largura do produto embalado (em metros) : decimal, nullable\n \"alturaEmbalagem\": null, //Altura do produto embalado (em metros) : decimal, nullable\n \"ncmId\": null, //ID do NCM : int, nullable\n \"ncm\": null, //Código NCM : string\n \"produtoOrigemId\": null, //ID do produto origem : int, nullable\n \"produtoOrigem\": null, //Descrição do produto origem : string\n \"cest\": null, //Descrição do CEST : string\n \"ean\": null, //Descrição do código EAN : string\n \"tipoProdutoId\": null, //ID do tipo do produto : int, nullable\n \"tipoProduto\": null, //Descrição do tipo do produto : string\n \"caminhoImagem\": null, //Caminho da imagem do produto : string\n \"videoYoutube\": null, //Link do vídeo do Youtube: string\n \"estoquePrincipalId\": null, //ID do estoque do produto : int\n \"quantidadeEstoquePrincipal\": null, //Quantidade total em estoque do produto. Em caso de variações, esse valor é o somatório do estoque das variações : int\n \"quantidadeEstoquePrincipalReserva\": null, //Quantidade em reserva da variação. São unidades que estão aguardando confirmação do pagamento. Para produtos com variação deve-se buscar a quantidade reserva da variação : int, nullable\n \"valorCusto\": null, //Valor de custo do produto : decimal, nullable\n \"valorVenda\": null, //Valor de venda do produto : decimal, nullable\n \"ultimaAlteracaoPreco\": null, //Data da última alteração do valor do produto : Datetime, nullable\n \"Variacao\": [ //Nó que agrupa as variações do produto. Quando não há variação esse nó ficará vazio.\n {\n \"variacaoId\": null, //ID da variação : int\n \"quantidadeVariacao\": null, //Quantidade em estoque da variação : int, nullable\n \"quantidadeVariacaoReserva\": null, //Quantidade em reserva de estoque da variação. São unidades que estão aguardando confirmação do pagamento.\n \"skuVariacao\": null, //Código SKU da variação : string\n \"caminhoImagemVariacao\": null, // Caminho da imagem da variação : string\n \"Combinacao\": [ //Nó que agrupa as combinações da variação. Quando não há combinações esse nó ficará vazio. Ex: Cor, Tamanho\n {\n \"tipoVariacaoId\": null, //ID do tipo de variação : int, nullable\n \"tipoVariacao\": null, //Descrição do tipo de variação : string\n \"descricao\": null, //Descrição um pouco mais detalhada da variação : string\n \"tipoVariacaoValorId\": null, //ID do valor do tipo de variação : int, nullable\n \"tipoVariacaoValor\": null //Descrição do valor do tipo de variação : string\n }\n ]\n }\n ],\n \"ProdutoComposto\": [ //Nó que agrupa os produtos vinculados do produto composto. Quando for produto simples ou produto com variação esse campo ficará vazio\n {\n \"idProdutoVinculado\": null, //ID do produto vinculado ao produto composto : int\n \"skuProdutoVinculado\": null, //Código SKU do produto vinculado ao produto composto : string\n \"quantidadeProdutoVinculado\": null //Quantidade do produto vinculado ao produto composto : int\n }\n ],\n \"Imagens\": [ //Nó que lista as imagens do produto quando for utilizado o parâmetro include=imagem.\n ]\n }\n ]\n}\nAção GET responsável por trazer informações de todos os produtos compostos que contém o SKU de um produto simples informado na chamada da requisição. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e o filtro obrigatório na URL. Essa ação pode ser chamada no máximo 50 vezes por minuto.
\nÉ necessário informar o SKU do produto simples que pertence ao produto composto na URL. Exemplo:
\n\n\n/ProdutoComposto?sku=Codigo_SKU_ProdutoSimples
\n
Para paginação disponibilizamos os parâmetros de filtro offset e limit que devem ser informados na URL. Exemplo:
\n\n\n/ProdutoComposto?sku=Codigo_SKU_ProdutoSimples&offset=15&limit=5
\n
O retorno será um objeto JSON contendo informações simplificadas dos produtos compostos que contém o produto simples informado. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Produto composto dessa documentação.
\n","urlObject":{"protocol":"http","path":["ProdutoComposto"],"host":["api","ideris","com","br"],"query":[{"key":"sku","value":"Pasta onde busca informações do produto composto através do SKU de um produto simples. Segue abaixo informações sobre o retorno padrão das ações do Produto Composto:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [ //Informações do Produto\n {\n \"id\": null, //ID do produto : int\n \"sku\": null, //Código SKU do produto : string\n \"titulo\": null, //Título do produto : string\n \"tipoProdutoId\": null, //ID do tipo do produto : int, nullable\n \"tipoProduto\": null, //Descrição do tipo do produto : string\n \n \"ProdutoComposto\": [ //Nó que agrupa os produtos vinculados do produto composto. Quando for produto simples ou produto com variação esse campo ficará vazio\n {\n \"idProdutoVinculado\": null, //ID do produto vinculado ao produto composto : int\n \"skuProdutoVinculado\": null //Código SKU do produto vinculado ao produto composto : string\n }\n ]\n }\n ]\n}\nAção GET responsável por trazer a lista de categorias ativas ou buscar a categoria através da descrição. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 50 vezes por minuto.
\nSe for busca da lista de produtos do início basta não informar nada na URL. Exemplo:
\n\n\n/Categoria
\n
Para paginação disponibilizamos os parâmetros de filtro offset e limit que devem ser informados na URL. Exemplo:
\n\n\n/Categoria?offset=15&limit=5
\n
Caso a busca seja de uma descrição específica, basta informar o mesmo na URL. Exemplo:
\n\n\n/Categoria?descricao=Descrição_Categoria
\n
O retorno será um objeto JSON contendo as principais informações da categoria. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Categoria dessa documentação.
\n","urlObject":{"protocol":"http","path":["Categoria",""],"host":["api","ideris","com","br"],"query":[{"key":"descricao","value":"Ação GET responsável por buscar a categoria através do ID. Essa ação pode ser chamada no máximo 50 vezes por minuto. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e informar o ID da categoria desejado após '/' na URL. Exemplo:
\n\n\n/Categoria/1
\n
O retorno será um objeto JSON contendo as principais informações da categoria. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Categoria dessa documentação.
\n","urlObject":{"protocol":"http","path":["Categoria","Ação responsável por cadastrar a categoria. Essa é uma ação POST e para chamá-la é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e um objeto JSON no Body. Esse objeto deve conter a descrição da categoria a ser cadastrada. Essa ação pode ser chamada no máximo 50 vezes por minuto.
\nBODY
\n{\n \"descricao\": null //Descrição da categoria que será cadastrada : string\n}\nO retorno será um objeto JSON contendo as principais informações da categoria cadastrada. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Categoria dessa documentação.
\n","urlObject":{"protocol":"http","path":["Categoria"],"host":["api","ideris","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"640d9272-b1bb-408c-bf06-01583f019bb1"}],"id":"cf423cbf-2a5e-4cdd-b068-4ce334581a10","description":"Pasta onde fica as ações de categoria junto ao Ideris. Segue abaixo informações sobre o retorno padrão das ações da Categoria:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [\n {\n \"id\": null, //ID da categoria junto ao Ideris : int\n \"descricao\": null //Descrição da categoria junto ao Ideris : string\n }\n ]\n}\nAção GET responsável por trazer a lista de sub categorias ativas ou buscar a sub categoria através da descrição. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nSe for busca da lista de produtos do início basta não informar nada na URL. Exemplo:
\n\n\n/SubCategoria
\n
Para paginação disponibilizamos os parâmetros de filtro offset e limit que devem ser informados na URL. Exemplo:
\n\n\n/SubCategoria?offset=15&limit=5
\n
Caso a busca seja de uma descrição específica, basta informar o mesmo na URL. Exemplo:
\n\n\n/SubCategoria?descricao=Descrição_SubCategoria
\n
O retorno será um objeto JSON contendo as principais informações da sub categoria. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Sub Categoria dessa documentação.\n
\n","urlObject":{"protocol":"http","path":["SubCategoria",""],"host":["api","ideris","com","br"],"query":[{"key":"descricao","value":"Ação GET responsável por buscar a sub categoria através do ID. Essa ação pode ser chamada no máximo 10 vezes por minuto. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e informar o ID da categoria desejado após '/' na URL. Exemplo:
\n\n\n/SubCategoria/1
\n
O retorno será um objeto JSON contendo as principais informações da sub categoria. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Sub categoria dessa documentação.
\n","urlObject":{"protocol":"http","path":["SubCategoria","Ação responsável por cadastrar a sub categoria. Essa é uma ação POST e para chamá-la é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e um objeto JSON no Body. Esse objeto deve conter a descrição da sub categoria a ser cadastrada. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nBODY
\n{\n \"descricao\": null //Descrição da sub categoria que será cadastrada : string\n}\nO retorno será um objeto JSON contendo as principais informações da sub categoria cadastrada. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Sub categoria dessa documentação.
\n","urlObject":{"protocol":"http","path":["SubCategoria"],"host":["api","ideris","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"752a0db7-54ad-4e32-a16e-3572bde26cf4"}],"id":"57700c1f-fe38-48f8-befb-12655077af43","description":"Pasta onde fica as ações de sub categoria junto ao Ideris. Segue abaixo informações sobre o retorno padrão das ações da Sub Categoria:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [\n {\n \"id\": null, //ID da sub categoria junto ao Ideris : int\n \"descricao\": null //Descrição da sub categoria junto ao Ideris : string\n }\n ]\n}\nAção GET responsável por trazer a lista de marcas ativas ou buscar a marca através da descrição. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nSe for busca da lista de produtos do início basta não informar nada na URL. Exemplo:
\n\n\n/Marca
\n
Para paginação disponibilizamos os parâmetros de filtro offset e limit que devem ser informados na URL. Exemplo:
\n\n\n/Marca?offset=15&limit=5
\n
Caso a busca seja de uma descrição específica, basta informar o mesmo na URL. Exemplo:
\n\n\n/Marca?descricao=Descrição_Marca
\n
O retorno será um objeto JSON contendo as principais informações da marca. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Marca dessa documentação.\n
\n","urlObject":{"protocol":"http","path":["Marca",""],"host":["api","ideris","com","br"],"query":[{"key":"descricao","value":"Ação GET responsável por buscar a marca através do ID. Essa ação pode ser chamada no máximo 10 vezes por minuto. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e informar o ID da marca desejado após '/' na URL. Exemplo:
\n\n\n/SubCategoria/1
\n
O retorno será um objeto JSON contendo as principais informações da marca. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Marca dessa documentação.
\n","urlObject":{"protocol":"http","path":["Marca","Ação responsável por cadastrar a marca. Essa é uma ação POST e para chamá-la é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e um objeto JSON no Body. Esse objeto deve conter a descrição da marca a ser cadastrada. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nBODY
\n{\n \"descricao\": null //Descrição da marca que será cadastrada : string\n}\nO retorno será um objeto JSON contendo as principais informações da marca cadastrada. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Marca dessa documentação.
\n","urlObject":{"protocol":"http","path":["Marca"],"host":["api","ideris","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"fd8a361b-a484-4209-b179-2ba015426837"}],"id":"b938b3b0-3333-40dd-b8da-37a10a022141","description":"Pasta onde fica as ações de marca junto ao Ideris. Segue abaixo informações sobre o retorno padrão das ações da Marca:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [\n {\n \"id\": null, //ID da marca junto ao Ideris : int\n \"descricao\": null //Descrição da marca junto ao Ideris : string\n }\n ]\n}\nAção GET responsável por trazer a lista de departamentos ativos ou buscar o departamento através da descrição. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nSe for busca da lista de departamentos do início basta não informar nada na URL. Exemplo:
\n\n\n/Departamento
\n
Para paginação disponibilizamos os parâmetros de filtro offset e limit que devem ser informados na URL. Exemplo:
\n\n\n/Departamento?offset=15&limit=5
\n
Caso a busca seja de uma descrição específica, basta informar o mesmo na URL. Exemplo:
\n\n\n/Departamento?descricao=Descrição_Departamento
\n
O retorno será um objeto JSON contendo as principais informações do departamento. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Departamento dessa documentação.\n
\n","urlObject":{"protocol":"http","path":["Departamento",""],"host":["api","ideris","com","br"],"query":[{"key":"descricao","value":"Ação GET responsável por buscar o departamento através do ID. Essa ação pode ser chamada no máximo 10 vezes por minuto. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e informar o ID da marca desejado após '/' na URL. Exemplo:
\n\n\n/Departamento/1
\n
O retorno será um objeto JSON contendo as principais informações do departamento. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Departamento dessa documentação.
\n","urlObject":{"protocol":"http","path":["Departamento","Ação responsável por cadastrar o departamento. Essa é uma ação POST e para chamá-la é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e um objeto JSON no Body. Esse objeto deve conter a descrição do departamento a ser cadastrado. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nBODY
\n{\n \"descricao\": null //Descrição do departamento que será cadastrada : string\n}\nO retorno será um objeto JSON contendo as principais informações do departamento cadastrado. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Departamento dessa documentação.
\n","urlObject":{"protocol":"http","path":["Departamento"],"host":["api","ideris","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"198307ca-c9f8-403a-b11a-cb1cd0cb9dc3"}],"id":"b4e7aa4b-339f-44b6-9e7b-a741d10da24a","description":"Pasta onde fica as ações de departamento junto ao Ideris. Segue abaixo informações sobre o retorno padrão das ações do Departamento:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [\n {\n \"id\": null, //ID do departamento junto ao Ideris : int\n \"descricao\": null //Descrição do departamento junto ao Ideris : string\n }\n ]\n}\nAção GET responsável por trazer a lista de origem do produto ativos. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nSe for busca da lista de origem do produto do início basta não informar nada na URL. Exemplo:
\n\n\n/ProdutoOrigem
\n
Para paginação disponibilizamos os parâmetros de filtro offset e limit que devem ser informados na URL. Exemplo:
\n\n\n/ProdutoOrigem?offset=15&limit=5
\n
O retorno será um objeto JSON contendo as principais informações da origem do produto. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Origem dessa documentação.
\n","urlObject":{"protocol":"http","path":["ProdutoOrigem"],"host":["api","ideris","com","br"],"query":[{"key":"offset","value":"Pasta onde fica as ações de origem do produto junto ao Ideris. Segue abaixo informações sobre o retorno padrão das ações de Origem do produto:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [\n {\n \"id\": null, //ID da origem do produto junto ao Ideris : int\n \"descricao\": null, //Descrição da origem do produto junto ao Ideris : string\n \"codigo\": null //Código da origem do produto junto ao Ideris : string\n }\n ]\n}\nAção GET responsável por trazer a lista de ncm ativos. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nSe for busca da lista de ncm do início basta não informar nada na URL. Exemplo:
\n\n\n/Ncm
\n
Para paginação disponibilizamos os parâmetros de filtro offset e limit que devem ser informados na URL. Exemplo:
\n\n\n/Ncm?offset=15&limit=5
\n
\n\n/Ncm?codigo=Código do NCM
\n
O retorno será um objeto JSON contendo as principais informações do ncm. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Ncm dessa documentação.
\n","urlObject":{"protocol":"http","path":["Ncm"],"host":["api","ideris","com","br"],"query":[{"key":"offset","value":"Ação responsável por cadastrar o Ncm. Essa é uma ação POST e para chamá-la é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e um objeto JSON no Body. Esse objeto deve conter o código e a descrição do Ncm a ser cadastrado. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nBODY
\n{\n \"codigo\": null, //Código do ncm que será cadastrado : string, obrigatório\n \"descricao\": null //Descrição do ncm que será cadastrado : string, obrigatório\n}\nO retorno será um objeto JSON contendo as principais informações do ncm cadastrado. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Ncm dessa documentação.
\n","urlObject":{"protocol":"http","path":["Ncm"],"host":["api","ideris","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"5244801e-38ab-4873-966e-a7640d805ee4"}],"id":"769eda80-4561-45b1-8cff-c3170b3bd6ec","description":"Pasta onde fica as ações de ncm junto ao Ideris. Segue abaixo informações sobre o retorno padrão das ações de NCM:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [\n {\n \"id\": null, //ID do NCM junto ao Ideris : int\n \"descricao\": null, //Descrição do NCM junto ao Ideris : string\n \"codigo\": null //Código do NCM junto ao Ideris : string\n }\n ]\n}\nPasta onde fica as ações de produto e estoque junto ao Ideris, e ações necessárias para o cadastro de produto.
\n","event":[{"listen":"prerequest","script":{"id":"2bde372c-553a-495d-9e45-f08a10e1fd62","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4c049e94-1beb-4396-b67b-ab07d771b153","type":"text/javascript","exec":[""]}}],"_postman_id":"0b917457-3189-4b2c-badf-04973b797519"},{"name":"ProdutoV2","item":[{"name":"Geral","item":[{"name":"Busca lista de produtosV2 ou busca produtoV2 por SKU","id":"99eac7b0-2499-4755-b0b7-cfdcd7e7d880","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJDdXN0b21lcklkIjoiMTk5NiIsIlVzZXJJZCI6IjExNDIyIiwiQXV0aGVudGljYXRpb25Ub2tlbklkIjoiMTQzIiwiVXNlcklkQmFuY28iOiI3OCIsIkludGVncmFkb3JJZCI6IjM1MCIsIm5iZiI6MTY0NTYzNDk1OCwiZXhwIjoxNjQ1NzIxMzU4LCJpYXQiOjE2NDU2MzQ5NTgsImlzcyI6Imh0dHBzOi8vYXBpLmlkZXJpcy5jb20uYnIiLCJhdWQiOiJodHRwczovL2FwaS5pZGVyaXMuY29tLmJyIn0.tUwmNeFV5YCDZwQIDq5DfeDiwl1fdbPbpXgahOJ_s8U","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{localhost}}/ProdutoV2?limit=Ação GET responsável por trazer a lista de produtosv2 ativos ou buscar o produtov2 através do código SKU. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nSe for busca da lista de produtos do início basta não informar nada na URL. Exemplo:
\n\n\n/ProdutoV2
\n
Para paginação disponibilizamos os parâmetros de filtro offset e limit que devem ser informados na URL. Exemplo:
\n\n\n/ProdutoV2?offset=15&limit=5
\n
Caso a busca seja de um código SKU específico, basta informar o mesmo na URL. Exemplo:
\n\n\n/ProdutoV2?sku=Codigo_SKU
\n
O retorno será um objeto JSON contendo as principais informações do produtoV2. Mais informações sobre o JSON de retorno poderá ser visto na pasta de ProdutoV2 dessa documentação.
\n","urlObject":{"path":["ProdutoV2"],"host":["{{localhost}}"],"query":[{"disabled":true,"key":"sku","value":"Ação responsável por cadastrar o produtoV2. Essa é uma ação POST e para chamá-la é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e um objeto JSON no Body. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nSegue abaixo os campos que podem ser informados para cadastro do produtoV2:
\nBODY
\n{\n \"sku\": null, //Código SKU do produtoV2 : string\n \"titulo\": null, //Título do produtoV2: string \n \"peso\": null, //Peso do produtoV2 : decimal, nullable\n \"comprimento\": null, //Comprimento do produtoV2 : decimal, nullable\n \"largura\": null, //Largura do produtoV2 : decimal, nullable \n \"altura\": null, //Altura do produtoV2 : decimal, nullable \n \"ncmId\": null, //ID do NCM junto ao Ideris : int, nullable\n \"produtoOrigemId\": null, //ID da origem do produtoV2 junto ao Ideris : int, nullable\n \"cest\": null, //Descrição do CEST do produtoV2 : string\n \"ean\": null, //EAN do produtoV2 : string\n \"upc\": null, //UPC do produtoV2 : string\n \"codigoUniversal\": null, //Código universal do produtoV2 : string\n \"estoqueMinimo\": null, //Estoque mínimo do produtoV2 : int, nullable\n \"estoqueMaximo\": null, //Estoque máximo do produtoV2 : int, nullable\n \"imagemBase64\": null, //Imagem em base64 da thumbnail do produtoV2 : string\n \"quantidadeEstoque\": null, //Quantidade em estoque do produtoV2 : int\n \"valorCusto\": null, //Valor de custo do produtoV2 : decimal, nullable\n \"valorVenda\": null, //Valor de venda do produtoV2 : decimal, nullable\n \"ProdutoComposto\": [ //Nó responsável por informar os produtos compostos (somente para quando o tipoProdutoId for 2)\n {\n \"skuProdutoContido\": null, //SKU do produtoV2 que faz parte do produto composto : string\n \"quantidade\": null //Quantidade do produtov2 vinculado ao produto composto : int \n }\n ]\n}\nComo o processo de criação de produtoV2 pode levar um certo tempo, o retorno será um objeto JSON contendo um Protocolo. Para acompanhar o processo de criação do produto basta buscar informações sobre o protocolo retornado na ação 'Busca protocolos pendentes ou busca protocolo por código'. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Protocolo dessa documentação.
\nSegue abaixo alguns pontos a se atentar durante o cadastro de ProdutoV2:
\nAção responsável por atualizar o produtoV2. Essa é uma ação PUT e para chamá-la é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e um objeto JSON no Body. Esse objeto deve conter pelo menos um identificador do produto e as informações que deseja alterar. Não é necessário informar campos que não serão atualizados. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nNo momento disponibilizamos a atualização de alguns dos atributos do produtoV2. Segue abaixo os campos que podem ser informados para atualização do produto:
\nBODY
\n{\n \"sku\": null, //Código SKU do produtoV2 : string\n \"peso\": null, //Peso do produtoV2 : decimal, nullable\n \"comprimento\": null, //Comprimento do produtoV2 : decimal, nullable\n \"largura\": null, //Largura do produtoV2 : decimal, nullable \n \"altura\": null, //Altura do produtoV2 : decimal, nullable \n \"ncmId\": null, //ID do NCM junto ao Ideris : int, nullable\n \"produtoOrigemId\": null, //ID da origem do produtoV2 junto ao Ideris : int, nullable\n \"cest\": null, //Descrição do CEST do produtoV2 : string\n \"ean\": null, //EAN do produtoV2 : string\n \"upc\": null, //UPC do produtoV2 : string\n \"codigoUniversal\": null, //Código universal do produtoV2 : string\n \"estoqueMinimo\": null, //Estoque mínimo do produtoV2 : int, nullable\n \"estoqueMaximo\": null, //Estoque máximo do produtoV2 : int, nullable\n \"quantidadeEstoque\": null, //Quantidade em estoque do produtoV2 : int\n \"valorCusto\": null, //Valor de custo do produtoV2 : decimal, nullable\n \"valorVenda\": null //Valor de venda do produtoV2 : decimal, nullable, \n \"atualizarValoresProdutoComposto\" : false // Campo responsável por atualizar as informações e valores de custo e de venda do produto composto. Por padrão, seu valor é false : boolean\n}\nO retorno será um objeto JSON contendo as principais informações do produtoV2 atualizado. Mais informações sobre o JSON de retorno poderá ser visto na pasta de ProdutoV2 dessa documentação.
\n","urlObject":{"protocol":"http","path":["ProdutoV2",""],"host":["api","ideris","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"7af0f641-dde7-4385-b1ff-804de4e1c301"},{"name":"Verificar utilização do ProdutoV2","id":"42a03ef5-4b9b-4c26-abdd-8a0c4eba64e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Ação GET responsável por informar se o cliente utiliza produtoV2 ou não. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 10 vezes por minuto. O retorno será um booleano.
\n","urlObject":{"protocol":"http","path":["ChecarProdutoV2"],"host":["api","ideris","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"42a03ef5-4b9b-4c26-abdd-8a0c4eba64e5"}],"id":"bf29c393-90c6-4c2a-8234-68eb2e2f09f4","description":"Segue abaixo informações sobre o retorno padrão das ações do ProdutoV2:
\n{\n \"sku\": null, //Código SKU do produtoV2 : string\n \"titulo\": null, //Título do produtoV2: string \n \"peso\": null, //Peso do produtoV2 : decimal, nullable\n \"comprimento\": null, //Comprimento do produtoV2 : decimal, nullable\n \"largura\": null, //Largura do produtoV2 : decimal, nullable \n \"altura\": null, //Altura do produtoV2 : decimal, nullable \n \"ncmId\": null, //ID do NCM junto ao Ideris : int, nullable\n \"ncm\": null, //Descrição do NCM do produtoV2 : string\n \"produtoOrigemId\": null, //ID da origem do produtoV2 junto ao Ideris : int, nullable\n \"produtoOrigem\": null, //Descrição da origem do produtoV2 : string\n \"cest\": null, //Descrição do CEST do produtoV2 : string\n \"ean\": null, //EAN do produtoV2 : string\n \"upc\": null, //UPC do produtoV2 : string\n \"codigoUniversal\": null, //Código universal do produtoV2 : string\n \"estoqueMinimo\": null, //Estoque mínimo do produtoV2 : int, nullable\n \"estoqueMaximo\": null, //Estoque máximo do produtoV2 : int, nullable\n \"tipoProdutoId\": null, //ID do tipo do produto junto ao Ideris : int\n \"tipoProduto\": null, //Descrição do tipo do produtoV2 (Ex: Simples, Composto) : string\n \"imagemBase64\": null, //Imagem em base64 da thumbnail do produtoV2 : string\n \"quantidadeEstoque\": null, //Quantidade em estoque do produtoV2 : int\n \"quantidadeEstoqueReserva\": null, //Quantidade em reserva de estoque do produtoV2 : int\n \"valorCusto\": null, //Valor de custo do produtoV2 : decimal, nullable\n \"valorVenda\": null, //Valor de venda do produtoV2 : decimal, nullable\n \"ProdutoComposto\": [ //Nó responsável por informar os produtos compostos (somente para quando o tipoProdutoId for 2)\n {\n \"skuProdutoContido\": null, //SKU do produtoV2 que faz parte do produto composto : string\n \"quantidade\": null //Quantidade do produtov2 vinculado ao produto composto : int \n }\n ]\n}\nPasta onde fica as ações de produtoV2 junto ao Ideris. O produtoV2 é uma segunda forma de controle de estoque criado pelo Ideris, no qual consegue processar produtos compostos de uma forma mais rápida. Segue alguns links úteis referentes ao produtoV2.
\n\n","_postman_id":"c5b77784-d06a-46f9-8496-ae8619f9aa13"},{"name":"Pedido","item":[{"name":"Busca lista de pedidos","id":"00a76e3c-f67c-413f-a1d3-1db82e54b895","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Ação GET responsável por trazer a lista de pedidos com informações mais básicas. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 2 vezes por minuto.
\nOs parâmetros de filtro são:
\ndataInicial - Data inicial de aprovação do pedido
\n\n\n/ListaPedido?dataInicial=
\n
dataFinal - Data final de aprovação do pedido
\n\n\n/ListaPedido?dataFinal=
\n
status - Status atual do pedido
\n\n\n/ListaPedido?status=
\n
marketplace - Marketplace no qual o pedido foi realizado
\n\n\n/ListaPedido?marketplace=
\n
codigoCarrinhoCompras - Código do carrinho de compras do pedido (Mercado Livre)
\n\n\n/ListaPedido?codigoCarrinhoCompras=
\n
idAutenticacaoIderis- Código de autenticação da conta no Ideris
\n\n\n/ListaPedido?idAutenticacaoIderis=
\n
dataInicialAtualizacao - Data inicial de atualização do pedido
\n\n\n/ListaPedido?dataInicialAtualizacao=
\n
dataFinalAtualizacao - Data final de atualização do pedido
\n\n\n/ListaPedido?dataFinalAtualizacao=
\n
offset - Valor inicial da pesquisa, parâmetro para ajudar na paginação
\n\n\n/ListaPedido?offset=
\n
limit - Valor máximo de itens na busca. O valor máximo do limit é 50 (cinquenta)
\n\n\n/ListaPedido?limit=
\n
Obs: Não é necessário informar todos os parâmetros, somente os desejados. Abaixo um exemplo da chamada dessa ação com todos os parâmetros:
\n\n\n/ListaPedido?dataInicial=2018-11-03T13:57:22-03:00&dataFinal=2018-11-05T10:46:22-02:00&status=Entregue&marketplace=Pedido Manual&offset=0&limit=10
\n
O retorno será um objeto JSON contendo as informações básicas do pedido. Segue abaixo o retorno padrão dessa ação:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [ //Informações da lista de pedidos\n {\n \"id\": null, //ID do pedido : int\n \"codigo\": null, //Código do pedido : string\n \"marketplace\": null, //Marketplace no qual o pedido foi realizado : string\n \"idAutenticacaoIderis\": null, //Código de autenticação da conta no Ideris : int\n \"idContaMarketplace\": null, //ID da conta no marketplace : string\n \"nomeContaMarketplace\": null, //Bine da conta no marketplace : string\n \"status\": null, //Status atual do pedido : string\n \"data\": null //Data de aprovação do pedido : DateTime, nullable\n \"codigoCarrinhoCompras\": null, //Número do carrinho de compras do pedido (Mercado Livre) : string\n \"imagemPedidoItem\": null, //URL da thumbnail do pedido : string,\n \"intermediadorNome\": null, //Nome de intermediador : string\n \"intermediadorCnpj\": null //CNPJ de intermediador : string\n }\n ]\n}\nAção GET responsável por buscar o pedido através do ID. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e informar o ID do pedido desejado após '/' na URL. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nExemplo:
\n\n\n/Pedido/1
\n
O retorno será um objeto JSON contendo as principais informações do pedido. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Pedido dessa documentação.
\nObservações:
\n1 - em 11/02/2022 foi incluído o campo \"modoEnvio\" no retorno do JSON.
\n2 - em 14/06/2023 foi incluído o campo \"quantidadeTotalItensVerificado\" no retorno do JSON, campo que devolve a informação referente à verificação da quantidade de itens que compõem o pedido, caso ela retorne o valor zero, o marketplace do pedido não está implementado com essa verificação.
\nA partir do dia 06/10/2020 disponibilizamos os campos referentes aos dados financeiros do pedido:
\nAção GET responsável por trazer uma lista de até 20 (vinte) pedidos através do ID, ou 1 (um) pedido através do código. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e o parâmetro de filtro desejado na URL. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nNessa ação é necessário sempre informar um dos parâmetros de filtro. Esses parâmetros são:
\n\n\n/Pedido?ids=1,2,3,4
\n
Se a pesquisa é em mais de um ID, separa-los por vírgula ','. O número máximo de ID's que pode ser informado é 20 (vinte).
\n\n\n/Pedido?codigo=Interno+-+1
\n
Diferente da busca por ID's, o número de códigos que pode ser informado é 1 (um).
\nObs: Se for informado ids e código na mesma chamada, a prioridade sempre será dos ids.
\nO retorno será um objeto JSON contendo as principais informações do pedido. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Pedido dessa documentação.
\nObservações:
\n1 - em 11/02/2022 foi incluído o campo \"modoEnvio\" no retorno do JSON.
\n2 - em 14/06/2023 foi incluído o campo \"quantidadeTotalItensVerificado\" no retorno do JSON, campo que devolve a informação referente à verificação da quantidade de itens que compõem o pedido, caso ela retorne o valor zero, o marketplace do pedido não está implementado com essa verificação.
\nA partir do dia 06/10/2020 disponibilizamos os campos referentes aos dados financeiros do pedido:
\nAção responsável por alterar o status do pedido, cadastrar/alterar o código de rastreio do pedido e informar o mesmo para o Mercado Livre, enviar mensagem automática para o cliente e/ou informar entrega do pedido para o Mercado Livre (somente para entrega em mãos). Essa é uma ação PUT e para chamá-la é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e um objeto JSON no Body. Todas as informações desse objeto JSON devem ser preenchidas. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nSegue abaixo os campos que podem ser informados para atualização do pedido:
\nBODY
\n{\n \"idPedidos\": null, //ID's que serão alterados para um mesmo status ou o mesmo código de rastreio, separados por vírgula. O número máximo de ID's é 50 (cinquenta) : string\n \"idNovoStatus\": null, // ID do novo status para o(s) pedido(s) informado(s). É possível encontrar a lista de status de pedido do Ideris na ação GET 'Busca lista de status' : int\n \"enviaMensagemClienteML\": null, //Caso verdadeiro, irá enviar uma mensagem pré-definida para o cliente (somente Mercado Livre) : booleano\n \"informaEntregaML\": null, //Caso verdadeiro, irá informar para o Mercado Livre que o produto foi entregue em mãos (somente Mercado Livre e entrega em mãos) : booleano\n \"codigoRastreio\": null, //Código do rastreio a ser vinculado ao(s) pedido(s) informado(s) : string, nullable\n \"informaRastreio\": null, //Caso verdadeiro, irá informar o rastreio do envio do produto (ainda não implementado para todos os marketplaces) : booleano\n \"diasEstimativa\": null //Uma estimativa do número de dias necessário para realizar a entrega. Necessário somente para alguns marketplaces : int, nullable \n}\nSe o status atual do pedido seja 'Entregue' (ID 1012), 'Cancelado' (ID 1015) ou 'Pagamento cancelado' (ID 1017) não será possível a alteração do mesmo.
\nO retorno padrão para quando todos os processos dos pedidos foram concluídos corretamente será 200 (Ok), juntamente com o objeto JSON abaixo.\nJá o retorno para quando tiver algum problema ao validar as informações recebidas será o 400 (Bad-request). Ex: Status inválido.
\nCaso houver algum problema durante algum processo do(s) pedido(s) informado(s) na lista de IDs, o retorno será HttpStatusCode 207 (Multi-status) e com o seguinte objeto JSON:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [ //Informações da chamada 'Atualiza status do pedido'\n {\n \"pedidoId\": null, //ID do pedido informado na chamada 'Atualiza status do pedido' : int\n \"mensagemRetorno\": null, //Mensagem mais básica de retorno para quando houver algum problema durante o processo de atualização de status do pedido ou envio de informação para o Mercado Livre\n\n \"httpStatusCodeMarketplace_EnvioRastreio\": null, //Retorno do marketplace para quando o campo 'informaRastreio' for true na chamada da API : HttpStatusCode, nullable\n \"EnvioRastreio_Mensagem\": null, //Mensagem do marketplace para quando o retorno for diferente de OK (200)\n\n \"httpStatusCodeMarketplace_EnvioMensagemML\": null, //Retorno do Mercado Livre para quando o campo 'enviaMensagemClienteML' for true na chamada da API : HttpStatusCode, nullable\n \"EnvioMensagemML_Mensagem\": null, //Mensagem do Mercado Livre para quando o retorno for diferente de OK (200)\n\n \"httpStatusCodeMarketplace_InformaEntregaML\": null, //Retorno do Mercado Livre para quando o campo 'informaEntregaML' for true na chamada da API : HttpStatusCode, nullable\n \"InformaEntregaML_Mensagem\": null //Mensagem do Mercado Livre para quando o retorno for diferente de OK (200)\n }\n ]\n}\nOs campos 'informaRastreio' e 'diasEstimativa' foram inseridos no dia 23/06/2020 para substituir o campo 'informaRastreioML', assim como os campos do objeto de retorno 'httpStatusCodeMarketplace_EnvioRastreio' e 'EnvioRastreio_Mensagem' substituiram 'httpStatusCodeMarketplace_EnvioRastreioML' e 'EnvioRastreioML_Mensagem'. \nOs campos 'informaRastreioML', 'httpStatusCodeMarketplace_EnvioRastreioML' e 'EnvioRastreioML_Mensagem' serão removidos da API no dia 01/08/2020.
\n","urlObject":{"protocol":"http","path":["PedidoStatus"],"host":["api","ideris","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"cadfeaef-7563-453c-9a32-0d2c79755d2c"}],"id":"ee3322be-4397-4f2b-b008-e00938704e89","description":"Pasta onde fica as ações de pedido junto ao Ideris. Segue abaixo informações sobre o retorno padrão das ações do Pedido:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [\n {\n \"id\": null, //ID do pedido junto ao Ideris : int\n \"data\": null, //Data de aprovação do pedido : DateTime, nullable\n \"codigo\": null, //Código do pedido junto ao marketplace: string\n \"valorTotalComFrete\": null, //Valor total do pedido com frete : decimal\n \"valorPago\": null, //Valor pago pelo pedido : decimal\n \"valorTotal\": null, //Valor total do pedido : decimal\n \"tarifaEnvio\": null, //Valor da tarifa de envio do pedido : decimal\n \"tarifaVenda\": null, //Valor da tarifa de venda do pedido : decimal\n \"totalDebitado\": null, //Valor do total debitado do pedido : decimal\n \"custoProduto\": null, //Valor do custo do produto : decimal\n \"valorSobrou\": null, //Valor da sobra resultante do valorTotal - totalDebitado : decimal\n \"totalLiquido\": null, //Valor liquido do pedido : decimal\n \"valorDesconto\": null, //Valor do desconto aplicado no pedido : decimal\n \"freteComprador\": null, //Valor do frete pago pelo comprador : decimal\n \"moeda\": null, //Moeda utilizada no pedido : string\n \"tipoEntrega\": null, //Tipo da entrega desse produto. Ex: Mercado Envios, Mercado Pago, Fulfillment : string\n \"marketplace\": null, //Marketplace no qual o pedido foi realizado : string\n \"idAutenticacaoIderis\": null, //Código de autenticação da conta no Ideris : int\n \"idContaMarketplace\": null, //ID da conta no marketplace : string\n \"nomeContaMarketplace\": null, //Bine da conta no marketplace : string\n \"status\": null, // Status atual do pedido : string\n \"codigoEntrega\": null, //Código da entrega do pedido. Pedidos com o mesmo código de entrega pertencem a um carrinho de compra : string\n \"codigoCarrinhoCompras\": null, //Número do carrinho de compras do pedido (Mercado Livre) : string\n \"metodoRastreio\": null, //Método de rastreio do pedido : string\n \"numeroRastreio\": null, //Número de rastreio do pedido : string\n \"modoEnvio: null, //Informação referente ao nome da transportadora do pedido : string \n \"compradorPrimeiroNome\": null, // Primeiro nome do comprador : string\n \"compradorSobrenome\": null, //Sobrenome do comprador : string\n \"compradorApelido\": null, //Apelido do comprador : string\n \"compradorEmail\": null, //Email do comprador : string\n \"compradorTipoDocumento\": null, //Tipo do documento do comprador : string\n \"compradorDocumento\": null, //Número do documento do comprador : string\n //Obs: As informações de endereço pode ser vazio ou nulo. Quando vazio ou nulo significa que o cliente escolheu 'Retirada em mãos' ao comprar o produto. Nesses casos, o campo tipoEntrega será 'A combinar'.\n \"compradorCodigoAreaTelefone\": null, //Código de área (DDD) do comprador : string\n \"compradorTelefone\": null, //Número de telefone do comprador : string\n \"enderecoEntregaCompleto\": null, //Endereço completo de onde será feito a entrega : string\n \"enderecoEntregaRua\": null, //Rua de onde será feito a entrega : string\n \"enderecoEntregaNumero\": null, //Número de onde será feito a entrega : string\n \"enderecoEntregaCep\": null, //CEP de onde será feito a entrega : string\n \"enderecoEntregaBairro\": null, //Bairro de onde será feito a entrega : string\n \"enderecoEntregaCidade\": null, //Cidade onde será feito a entrega : string\n \"enderecoEntregaEstado\": null, //Estado onde será feito a entrega : string\n \"enderecoEntregaPais\": null, //País onde será feito a entrega : string\n \"enderecoEntregaComentario\": null, //Comentário do endereço onde será feito a entrega : string\n \"enderecoEntrega_NomeResponsavelRecebimento\": null, //Nome do responsável para receber a entrega : string\n \"enderecoEntrega_TelefoneResponsavelRecebimento\": null, //Número de telefone do responsável para receber a entrega : string\n \"intermediadorNome\": null, //Nome de intermediador : string\n \"intermediadorCnpj\": null //CNPJ de intermediador : string\n \"Item\": [ //Nó que agrupa os itens do pedido\n {\n \"tituloProdutoItem\": null, //Título do item do pedido : string\n \"skuProdutoItem\": null, //SKU do item do pedido : string\n \"codigoProduto\": null, //Código do item do pedido no Ideris : string\n \"codigoProdutoItem\": null, //Código do item do pedido no marketplace : string\n \"quantidadeItem\": null, //Quantidade total desse item do pedido : int\n \"precoUnitarioItem\": null, //Valor unitário o item do pedido : decimal\n \"caminhoImagemItem\": null //Caminho da imagem do item do pedido : string\n }\n ],\n \"Pagamento\": [ //Nó que agrupa os pagamentos do pedido\n {\n \"codigoPagamento\": null, //Código do pagamento do pedido : string\n \"dataAprovacaoPagamento\": null, //Data de aprovação do pagamento do pedido : DateTime, nullable\n \"statusPagamento\": null, //Status atual do pagamento do pedido : string\n \"formaPagamento\": null, //Forma de pagamento do pedido : string\n \"numeroParcelasPagamento\": null, //Quantidade de parcelas do pagamento do pedido : int, nullable\n \"taxaMercadoPago\": null, //Campo substituído pelo 'tarifaVenda' no nó principal : decimal, nullable\n \"taxaMercadoLivre\": null //Campo substituído pelo 'tarifaVenda' no nó principal : decimal, nullable\n }\n ],\n \"Comentario\": [ //Nó que agrupa os comentários do pedido\n {\n \"comentario\": null, //Comentário realizado no pedido: string\n \"dataCriacao\": null //Data em que o comentário foi realizado : DateTime, nullable\n }\n ]\n }\n ]\n}\n\nAção GET responsável por trazer informações básicas da nota fiscal salva na base de dados do Ideris. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nOs parâmetros de filtro são:
\nidPedido - ID do pedido referente a nota fiscal
\n\n\n/NotaFiscal?idPedido=
\n
numeroNota - Número da nota fiscal
\n\n\n/NotaFiscal?numeroNota=
\n
serieNota - Série da nota fiscal
\n\n\n/NotaFiscal?serieNota=
\n
Obs: O número e série da nota sempre devem ser enviados na mesma chamada.
\nchaveNota - Chave de acesso da nota fiscal
\n\n\n/NotaFiscal?chaveNota=
\n
offset - Valor inicial da pesquisa, parâmetro para ajudar na paginação
\n\n\n/NotaFiscal?offset=
\n
limit - Valor máximo de itens na busca. O valor máximo do limit é 50 (cinquenta)
\n\n\n/NotaFiscal?limit=
\n
Obs: Não é necessário informar os parâmetros de filtro, somente os desejados.
\nNo dia 02/03/2021 foi incluído o nó histórico responsável por retornar as informações alteradas da nota fiscal.
\nNo dia 14/04/2021 foi incluído o campo tipoNota no nó principal e no nó histórico. Esse campo é responsável para informar o tipo da nota fiscal. Tipos disponíveis: NF-e de venda, NF-e de devolução, NF-e de transferência, NF-e de retorno simbólico, 'NF-e de retirada.
\nO retorno padrão para essa ação é:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [ //Informações básicas da nota fiscal\n {\n \"idPedido\": null, //ID do pedido vinculado a Nota Fiscal : int\n \"processo\": null, //ID do processo a ser realizado na nota fiscal : int\n \"chaveNota\": null, //Chave de acesso da nota fiscal. Campo de 44 caracteres numéricos : string\n \"numeroNota\": null, //Número da nota fiscal : int\n \"serieNota\": null, //Série da nota fiscal : int\n \"dataEmissaoNota\": null, //Data de emissão da nota fiscal : datetime\n \"urlDanfe\": null, //URL da Danfe da nota fiscal : string, nullable\n \"tipoNota\": null, //Tipo da nota fiscal : string\n \"statusNota\": null, //Status da nota fiscal: string\n \"xmlNota\": null, //XML da nota fiscal : string, nullable\n \"historico\": [ //Nó que contém todas as alterações da Nota Fiscal\n {\n \"numeroNota\": null, //Número da nota fiscal do histórico : string\n \"serieNota\": null, //Série da nota fiscal do histórico : string\n \"chaveNota\": null, //Chave de acesso da nota fiscal do histórico : string\n \"urlDanfe\": null, //URL da Danfe fiscal do histórico : string\n \"dataEmissao\": null, //Data de emissão da nota fiscal do histórico : DateTime\n \"statusNota\": null, //Status da nota fiscal do histórico : string\n \"xmlNota\": null, //XML da nota fiscal do histórico : string\n \"dataRegistro\": null //Data da alteração da nota fiscal : DateTime\n }\n ]\n }\n ]\n}\nAção responsável por realizar alguns processos com as informações disponibilizadas da nota fiscal. Esses processos serão melhor explicados no decorrer desse documento. Essa é uma ação POST e para chamá-la é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e um objeto JSON no Body. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nSegue abaixo os campos disponíveis nessa ação:
\n{\n \"idPedido\": null, //ID do pedido vinculado a Nota Fiscal : int\n \"processo\": null, //ID do processo a ser realizado na nota fiscal : int\n \"chaveNota\": null, //Chave de acesso da nota fiscal. Campo de 44 caracteres numéricos : string\n \"numeroNota\": null, //Número da nota fiscal : int\n \"serieNota\": null, //Série da nota fiscal : int\n \"dataEmissaoNota\": null, //Data de emissão da nota fiscal : datetime\n \"urlDanfe\": null, //URL da Danfe da nota fiscal : string, nullable\n \"xmlNota\": null //XML da nota fiscal : string, nullable\n}\n\nO campo 'processo' (Processo a ser realizado na Nota Fiscal) é obrigatório. Favor informar somente o ID do processo desejado.
Obs: Se já existir uma nota fiscal cadastrada no pedido a API irá validar se as informações da nota fiscal enviadas são as mesmas da informações salvas no banco de dados. Caso forem diferentes ou houver algum problema nas informações enviadas irá retornar erro 400 (BadRequest).
Se caso houver algum problema junto ao marketplace, o retorno será o erro 207 (Multi-Status) juntamente com o seguinte objeto:
\n{\n \"statusCodeMarketplace\": null, //StatusCode da chamada junto ao marketplace\n \"mensagemMarketplace\": null //Mensagem de retorno da chamada junto ao marketplace\n}\n\nOs processos disponíveis são:
\n1 e 3 - Enviar XML para o marketplace.
\nCaso o Ideris não possua o registro, a API irá salva o número, série, chave de acesso, data de emissão e URL da Danfe da nota fiscal na base de dados do Ideris, e envia o XML informado no campo 'xmlNota' para o marketplace do pedido informado no campo 'idPedido'. O único campo não obrigatório para o processo 1 é o 'urlDanfe', o preenchimento dos demais campos é obrigatório. (Obs.: Para envio de notas fiscais para Olist, o campo 'xmlNota' deverá ser enviado como uma URL no formato 'http://example.com.br' ou 'https://example.com.br' que contenha a nota fiscal, não mais o XML da nota fiscal em si).
\n2 e 4 - Enviar número, série e chave de acesso da nota fiscal para o marketplace.
\nCaso o Ideris não possua o registro, a API irá salvar o número, série, chave de acesso, data de emissão e URL da Danfe da nota fiscal na base de dados do Ideris, e envia essas informações para o marketplace do pedido informado no campo 'idPedido'. Os campos não obrigatórios para o processo 2 são 'urlDanfe' e 'xmlNota'. O preenchimento dos demais campos é obrigatório.
\nAlguns marketplaces não disponibilizam todas as opções dos processos, por isso mostraremos os processos disponíveis por marketplace.
\nObs: Caso o marketplace ainda não está na tabela acima significa que nenhum processo foi implementado para esse marketplace até o momento.
\n","urlObject":{"protocol":"http","path":["NotaFiscal"],"host":["api","ideris","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"03cdd8a7-a78f-4ea6-b885-240c40210ab5"},{"name":"Busca arquivo compactado de nota fiscal e danfe (somente Mercado Livre)","id":"4cbb2b54-9064-4aca-be69-985f5b8a680a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://api.ideris.com.br/ArquivoNotaFiscalMeLi?idAutenticacaoIderis=Ação GET responsável por retornar um arquivo compactado com as notas e danfes salvar no Mercado Livre dentro de um intervalo de tempo. Para essa requisição, buscamos essas informações diretamente na API do MeLi em tempo real . Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header e, caso deseje, os parâmetros de filtro na URL. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nOs parâmetros de identificação da conta do MeLi são (é preciso informar somente um deles):
\nidAutenticacaoIderis- ID da autenticação no Ideris (obtido na requisição de Conta)
\nidContaMarketplace- ID da conta do marketplace (obtido na requisição de Conta)
\nOs parâmetros de intervalo de tempo são (as datas são obrigatórias):
\ndataInicio- Data inicial do intervalo da busca
\ndataFim- Data final do intervalo da busca
\n{\n\"statusCodeMarketplace\": null, //HttpStatusCode da requisição junto ao Mercado Livre : int\n\"mensagemMarketplace\": null, //Retorno da requisição junto ao Mercado Livre : string\n\"contentType\": null //O tipo de retorno do Mercado Livre : string\n\"xml\": null // [{xml1},{xml2}], lista de xml retorno do Mercado Livre : string\n }
\nPasta onde fica as ações de nota fiscal junto ao Ideris.
\n","event":[{"listen":"prerequest","script":{"id":"be4a8ab8-c5f4-4951-88c3-64cb4d5f46d8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b6c37802-95ce-43d9-b812-4395403a69eb","type":"text/javascript","exec":[""]}}],"_postman_id":"d3cc64e0-2351-4b33-8a82-931afaebec68"},{"name":"Conta","item":[{"name":"Busca informações da conta pelo ID do pedido","id":"95791755-ecba-40e3-add9-0f7cd2203bf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Ação GET responsável por trazer uma lista de até 50 (cinquenta) contas de marketplace. Para chamar essa ação é necessário incluir o Content-Type 'application/json' e o token de autenticação retornado da ação Login no Header, e o parâmetro de filtro desejado na URL. Essa ação pode ser chamada no máximo 10 vezes por minuto.
\nNessa ação é necessário sempre informar o parâmetro de filtro.
\n\n\n/Conta?ids=1,2,3,4
\n
Se a pesquisa é em mais de um ID, separa-los por vírgula ','. O número máximo de ID's que pode ser informado é 50 (cinquenta).
\nO retorno será um objeto JSON contendo as principais informações da conta do marketplace. Mais informações sobre o JSON de retorno poderá ser visto na pasta de Conta dessa documentação.
\n","urlObject":{"protocol":"http","path":["Conta"],"host":["api","ideris","com","br"],"query":[{"key":"ids","value":"Pasta onde fica a ação de busca da conta do marketplace de um pedido junto ao Ideris. Segue abaixo informações sobre o retorno padrão da ação de Conta:
\n{\n \"paging\": { //Nó responsável por auxiliar a paginação\n \"limit\": null, //Limite de registros retornados. O limite máximo é 50 : int\n \"offset\": null, //Registro de início para busca no banco de dados : int\n \"count\": null, //Número de registros retornados : int\n \"total\": null //Número total de registros : int\n },\n \"result\": [\n {\n \"idPedido\": null, //ID do pedido para busca da conta do marketplace : int\n \"marketplaceId\": null, //ID do marketplace onde o pedido foi realizado : int, nullable\n \"marketplace\": null, //Descrição do marketplace onde o pedido foi realizado : string\n \"idAutenticacaoIderis\": null, //Código de autenticação da conta no Ideris : int\n \"idContaMarketplace\": null, //ID da conta do marketplace onde o pedido foi realizado : string\n \"nomeContaMarketplace\": null, //Nome da conta do marketplace onde o pedido foi realizado : string\n \"statusContaMarketplace\": null, //Status atual da conta do marketplace onde o pedido foi realizado : string\n \"mensagemRetorno\": null //Mensagem de retorno caso tiver algum problema ao buscar a conta do marketplace. Ex: Não implementado : string\n }\n ]\n}\n