Ecommerce¶
Documento de Integração FoccoERP - E-commerce - Relação de Webservices¶
1. Introdução¶
Esse documento identifica os webservices que são utilizados para a integração entre as aplicações de e-commerce e Focco. Estão definidos aqui os endereços dos webservices, bem como seus parâmetros de entrada e saída.
No endereço dos webservices abaixo descritos, há o trecho “<endereçoERP>” nos mesmos que deve ser alterado conforme o cliente em questão. Esse endereço será o link de acesso à aplicação web da Focco.
Todos as requisições aos webservices devem ter, em seu cabeçalho a chave “Content-Type” como “application/json”.
Segue, abaixo, a relação de webservices.
2. Requisitar Acesso¶
Endereço:¶
URL: <endereçoERP>/api/authentication/requestaccess
Esse webservice irá realizar a requisição de autenticação com o sistema.
Entrada:¶
| Parâmetros | Descrição |
|---|---|
| ClientID | Deve ser passado fixo como “ECOMMERCE”, que define o tipo de autenticação para essa aplicação em específico. |
| User | Deve ser um usuário de conexão ao FoccoERP, cadastrado pelo próprio cliente para o e-commerce. |
| Password | Deve ser a senha de conexão do usuário ao FoccoERP, cadastrado pelo próprio cliente para o e-commerce. |
| KillOthersSessions | Define se irá encerrar as sessões abertas do usuário informado ao realizar a autenticação. Como a aplicação de eCommerce permite várias conexões simultâneas, deve ser passado como “false”. |
Exemplo:
{
ClientID: "ECOMMERCE",
User: "<usuário>",
Password: "<senha>",
KillOtherSessions: false
}
Saída:¶
O json de retorno da requisição de autenticação irá retornar um token que deverá ser utilizado no cabeçalho das outras chamadas de webservices, na chave “Authorization”, com a seguinte informação:
“Bearer <token>”
Exemplo:
{
"$id": "32282",
"ErrorReason": 0,
"CustomErrorMessage": null,
"Token": "CfDJ8N9H4sMCRcZJj7vaStaDeKjUduS6BEpAXl6KimLfnZWDfD2GunFWISyFgqQasaSD77Q9jcqhAM3tOhSwiRj0vTr8UEhKjo1_E6DPa1nBqrD6AggY6fpdaTXIhRhFYp1ETjwst86Vddu3f3tqXSn0RlbwzlPHu2HHa0DbxSBShPvLXVCWokJCQOgl_op66idLBgUbrjQq0cSCZox79g2PxyydUF0Uj4JdpgTq36WLwxeAdUTansW4q_G8XuTpaSxCjKTLXJFdSwso3hw_yOb8osHHnI0-yyvOIDaeM1-PRvvv_2iPAClUp8Eg4WV7JrPkKIcWGoaojpC1gE9qDoA043fYt_TRtDuZJ8-z38XgGuY7K4OLjb-_kgoYvONped6jtelsF7dW3I-XwZpR9Ds_QvnHUOoCc4JE-MmG8n1PPlGzJklcsJU5xwqXb1lcQOAbzMxjp-lkP-vZxsRouQvt9emSTCaaq1zIaZHCe6P_CLRH0kGDKX5I4FIuXIiUchNqSnzyVJ7NRCgkQiFrEGg9rpH2c00if6pfRsU2exAVAwCdrE9zK_QioTokOuLN8ON4bINVxCRsGH177yHaV_uOJJ-TYykZTCR8ssZpl0uIHGZZaxPnXA4GZZ_Ymj2F3AGgWBQBeFq-lJvL17H_p29kP-Tzw84Y4l8-3Jepu0mSrXul4t8cnOInol3VWQhk4c0bzurbgRpljYQuB5Sn0VinMLKbv602t6v59VPlu0OBpcAD",
"IsSuccessful": true
}
3. Buscar Condições de Pagamento:¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.GetCondicoesPagamentoCommand
Esse webservice irá buscar todas as condições de pagamento do sistema que estão marcadas para envio ao eCommerce.
| Parâmetros |
|---|
| Esse webservice não requer parâmetros de entrada. |
Saída:¶
| Dados | Descrição |
|---|---|
| ID | ID interno da condição de pagamento no ERP. |
| Codigo | Código da condição de pagamento que foi cadastrada no ERP. |
| Descricao | Descrição da condição de pagamento que foi cadastrada no ERP. |
Exemplo:
{
"$id": "2",
"$values": [
{
"$id": "3",
"ID": 595,
"Codigo": 3,
"Descricao": "PARCELAMENTO LIVRE"
},
{
"$id": "4",
"ID": 727,
"Codigo": 99,
"Descricao": "TESTE FGK"
}
]
}
4. Buscar Itens:¶
Endereço:¶
URL:
Esse webservice busca todos os itens do sistema que estão marcados para envio ao eCommerce, retornando-os conforme a quantidade solicitada na requisição.
| Parâmetros | Descrição |
|---|---|
| skip | Identifica a quantidade de registros que serão ignorados na busca dos itens. Os registros sempre retornarão ordenados, portanto ao informar esse parâmetro maior que zero, indica-se que a quantidade informada de registros não precisa ou não deve ser retornada. |
| take | Identifica a quantidade de registros que devem ser retornados na busca. Esse parâmetro é limitado em um máximo de 1000 registros. |
Exemplo:
{
skip: 0,
take: 2
}
Saída:¶
| Dados | Descrição |
|---|---|
| TotalRowCount | Indica a quantidade de registros que há para consulta. Ou seja, a quantidade de itens que estão marcados para envio ao eCommerce. |
| ID: | ID interno do item no ERP. |
| Codigo | Código do item que foi cadastrada no ERP. |
| Descricao | Descrição resumida do item que foi cadastrada no ERP. |
| DescTecnica | Descrição técnica do item que foi cadastrada no ERP. |
| DescComplementar | Descrição complementar do item cadastrada no ERP. |
| Observação | Observação da capa do cadastro do item no ERP. |
| Configurado | Indica se o item é configurado ou não. Ou seja, se tem ou não máscaras. |
| DadosEmpresa | Agrupado de informações do item separados por empresa. |
| Empresa | Código da empresa ao qual o agrupado de informações do cadastro se refere. |
| DescComercial | Descrição do item na pasta comercial cadastrada no ERP. |
| CodFornecedor | Código do fornecedor preferencial do item. Retorna nulo caso não encontre um fornecedor preferencial. |
| Fornecedor | Descrição do fornecedor preferencial do item. Retorna nulo caso não encontre um fornecedor preferencial. |
| UnidadeMedida | Unidade de medida do item, será retornada a unidade de medida da pasta comercial, caso não houver, será retornada da pasta estoque. |
| Classificação | Descrição do grupo de classificação do item. |
| DescGrupo | Descrição do grupo de inventário ao qual o item pertence. |
| MultiploVenda | Multiplo de venda da pasta comercial do item no ERP. |
| CodBarra | Código de barra preferencial cadastrado para o item. |
Exemplo:
{
"$id": "29279",
"TotalRowCount": 3,
"Rows": {
"$id": "29280",
"$values": [
{
"$id": "29281",
"ID": 30990,
"Codigo": "8801",
"Descricao": "GAVETA (CAIXA)",
"DescTecnica": "GAVETA (CAIXA)",
"DescComplementar": null,
"Observacao": null,
"Configurado": "Não",
"DadosEmpresa": {
"$id": "29282",
"$values": [
{
"$id": "29283",
"Empresa": 10,
"DescComercial": null,
"CodFornecedor": 2,
"Fornecedor": "BIGFER IND COM DE FERR LTDA",
"UnidadeMedida": "UNIDADE",
"Classificacao": "ACESSÓRIOS",
"DescGrupo": "EM ELABORACAO",
"MultiploVenda": null,
"CodBarra": "7890000724142"
},
{
"$id": "29284",
"Empresa": 100,
"DescComercial": null,
"CodFornecedor": null,
"Fornecedor": null,
"UnidadeMedida": "UNIDADE",
"Classificacao": "ACESSÓRIOS",
"DescGrupo": "EM ELABORACAO",
"MultiploVenda": null,
"CodBarra": null
}
]
}
},
{
"$id": "29285",
"ID": 31915,
"Codigo": "ITEM_LOTE_FILHO1",
"Descricao": "ITEM LOTE FILHO 1",
"DescTecnica": "ITEM LOTE FILHO 1",
"DescComplementar": null,
"Observacao": null,
"DadosEmpresa": {
"$id": "29286",
"$values": [
{
"$id": "29287",
"Empresa": 10,
"DescComercial": null,
"CodFornecedor": null,
"Fornecedor": null,
"UnidadeMedida": "UNIDADE",
"Classificacao": "TOMADAS",
"DescGrupo": "MERCADORIA REVENDA",
"MultiploVenda": null,
"CodBarra": null
}
]
}
}
]
}
}
5. Buscar Clientes:¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.GetClientesCommand
Busca todos os clientes da base que tem, no mínimo, um estabelecimento marcado para utilização no eCommerce.
| Parâmetros |
|---|
| Esse webservice não requer parâmetros de entrada. |
Saída:¶
| Dados | Descrição |
|---|---|
| ID | ID interno do cliente no ERP. |
| Codigo | Código do cliente cadastrado no ERP. |
| Descricao | Descrição do cliente cadastrado no ERP. |
| CpfCnpjs | CNPJ ou CPF do cliente cadastrado no ERP. |
| Cpf | CPF. |
| Cnpj | CNPJ. |
Exemplo:
{
"$id": "52739",
"$values": [
{
"$id": "52740",
"ID": 5211,
"Codigo": 2,
"Descricao": "EMPRESA BRASILEIRA S/A",
"CpfCnpjs": {
"$id": "52741",
"$values": [
{
"$id": "52742",
"Cpf": 0,
"Cnpj": 99556753000145
}
]
}
}
]
}
6. Buscar Representantes:¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.GetRepresentantesCommand
Busca uma lista de todos os representantes ativos do sistema.
| Parâmetros |
|---|
| Esse webservice não requer parâmetros de entrada. |
Saída:¶
| Dados | Descrição |
|---|---|
| ID | ID interno do representante no ERP. |
| Codigo | Código do representante cadastrado no ERP. |
| Descricao | Descrição do representante cadastrado no ERP. |
| E-mail do representante cadastrado no ERP. |
Exemplo:
{
"$id": "1",
"$values": [
{
"$id": "2",
"ID": 561,
"Codigo": 41,
"Descricao": "SUDESTE REPRESENTAÇÕES",
"Email": null
},
{
"$id": "3",
"ID": 562,
"Codigo": 42,
"Descricao": "NORTE REPRESENTAÇÕES",
"Email": null
},
{
"$id": "4",
"ID": 721,
"Codigo": 7,
"Descricao": "REPRESENTANTE ECOMMERCE",
"Email": "teste.ecommerce@focco.com.br"
}
]
}
7. Buscar Clientes de um Representante:¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.GetClientesRepresentanteCommand
Busca todos os clientes vinculados ao representante desejado.
| Parâmetros | Descrição |
|---|---|
| codigoRepresentante | Código do representante do qual se deseja buscar os clientes vinculados. |
Exemplo:
{
codigoRepresentante: 44
}
Saída:¶
| Dados | Descrição |
|---|---|
| ID | ID interno do cliente no ERP. |
| Codigo | Código do cliente cadastrado no ERP. |
| Descricao | Descrição do cliente cadastro no ERP. |
Exemplo:
{
"$id": "296",
"$values": [
{
"$id": "297",
"ID": 5211,
"Codigo": 2,
"Descricao": "BIGFER IND COM DE FERR LTDA"
},
{
"$id": "298",
"ID": 5408,
"Codigo": 201,
"Descricao": "OXALIS"
},
{
"$id": "299",
"ID": 5457,
"Codigo": 65,
"Descricao": "TESTE NFCE"
}
]
}
8. Buscar Saldo de Estoque de Item:¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.GetEstoqueItemCommand
Busca o saldo de estoque do item/configuração informado em seu almoxarifado padrão. É retornado o estoque do item em todas as empresas às quais o mesmo está vinculado.
| Parâmetros | Descrição |
|---|---|
| codigoItem | Código do item cujo saldo em estoque se deseja consultar. |
| mascaraId | ID da máscara do item cujo saldo em estoque se deseja consultar. Caso o item seja configurado e a máscara não seja informada, a rotina busca o saldo consolidado de todas as máscaras. |
Exemplo:
{
codigoItem: 'EN7000',
mascaraId: null
}
Saída:¶
| Dados | Descrição |
|---|---|
| CodigoEmpresa | Código da Empresa no ERP. |
| Uf | Unidade Federativa na qual encontra-se a empresa. |
| Saldo | Saldo em estoque do item/configuração informados. |
Exemplo:
{
"$id": "41",
"Value": {
"$id": "42",
"$type": "Focco.Framework.DataAccess.BaseDatabase+<Query>d__39`1[[Focco.ERP.Core.Commands.Comercial.Ecommerce.WebServices.GetEstoqueItemCommand+Result, Focco.ERP.Core]], Focco.Framework.DataAccess",
"$values": [
{
"$id": "43",
"CodigoEmpresa": 10,
"Uf": "RS",
"Saldo": -2
},
{
"$id": "44",
"CodigoEmpresa": 100,
"Uf": "RS",
"Saldo": 0
}
]
},
"InnerSingleStatuses": [],
"Succeeded": true,
"AnySucceeded": false,
"Failed": false,
"AllFailed": false,
"BaseErrorMessage": null,
"ErrorMessage": "",
"Exception": null
}
9. Buscar Itens Comercializáveis ao Cliente:¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.GetItensClienteCommand
Esse webservice busca todos os itens que estão disponíveis para venda à um cliente. Ou seja, todos os itens que estão marcados para e-Commerce. Caso o cliente em específico possua inclusões cadastradas, o serviço irá retornar apenas os itens incluídos a ele, caso contrário, irá retornar todos do sistema marcados para e-Commerce. Caso o item seja configurado, o webservice irá retornar um registro do item para cada máscara. A quantidade de registros retornado é controlada a partir do valor informado na solicitação na requisição.
| Parâmetros | Descrição |
|---|---|
| codigoCliente | Código do cliente ao qual se deseja buscar os itens comercializáveis. |
| cnpjCpf | CNPJ ou CPF do cliente ao qual se deseja buscar os itens comercializáveis. |
| skip | Identifica a quantidade de registros que serão ignorados na busca dos itens. Os registros sempre retornarão ordenados, portanto ao informar esse parâmetro maior que zero, indica-se que a quantidade informada de registros não precisa ou não deve ser retornada. |
| take | Identifica a quantidade de registros que devem ser retornados na busca. Esse parâmetro é limitado em um máximo de 1000 registros. |
Exemplo:
{
codigoCliente: 4,
cnpjCpf: “56643018000913”,
skip: 0,
take: 1000
}
Saída:¶
| Dados | Descrição |
|---|---|
| TotalRowCount | Indica a quantidade de registros que há para consulta. Ou seja, a quantidade de itens que estão marcados para envio ao eCommerce. |
| ID | ID interno do item no ERP. |
| Codigo | Código do item que foi cadastrada no ERP. |
| Descricao | Descrição resumida do item que foi cadastrada no ERP. |
| DescTecnica | Descrição técnica do item que foi cadastrada no ERP. |
| DescComercial | Descrição do item na pasta comercial cadastrada no ERP. |
| DescComplementar | Descrição complementar do item cadastrada no ERP. |
| Observação | Observação da capa do cadastro do item no ERP. |
| CodFornecedor | Código do fornecedor preferencial do Item. Retorna nulo caso não encontre um fornecedor preferencial. |
| Fornecedor | Descrição do fornecedor preferencial do item. Retorna nulo caso não encontre um fornecedor preferencial. |
| UnidadeMedida | Unidade de medida do item, será retornada a unidade de medida da pasta comercial, caso não houver, será retornada da pasta estoque. |
| MascaraID | ID da máscara do item no ERP. |
| Mascara | Descrição da máscara do item no ERP. |
| IpiPerc | Percentual de IPI do item no ERP. |
| PesoBruto | Peso bruto do item. |
| Classificação | Descrição do grupo de classificação do item. |
| DescGrupo | Descrição do grupo de inventário ao qual o item pertence. |
| MultiploVenda | Multiplo de venda da pasta comercial do item no ERP. |
| CodBarra | Código de barra preferencial cadastrado para o item. |
| Configurado | Indica se o item é configurado ou não. Ou seja, se tem ou não máscaras. |
Exemplo:
{
"$id": "6",
"Value": {
"$id": "7",
"TotalRowCount": 2,
"Rows": {
"$id": "8",
"$values": [
{
"$id": "9",
"ID": 30808,
"Codigo": "REV1003",
"Descricao": "TOMADA P/ ENGATE PRETA",
"DescTecnica": "TOMADA P/ ENGATE PRETA",
"DescComercial": null,
"DescComplementar": null,
"Observacao": "teste",
"CodFornecedor": 9,
"Fornecedor": "ELETROPECAS COM ELETRONICA LTDA",
"UnidadeMedida": "UNIDADE",
"MascaraID": 0,
"Mascara": null,
"IpiPerc": null,
"PesoBruto": 0,
"Classificacao": "TOMADAS",
"DescGrupo": "MATERIAL COMERCIALIZACAO",
"MultiploVenda": null,
"CodBarra": null,
"Configurado": "Não"
},
{
"$id": "10",
"ID": 33234,
"Codigo": "MARK",
"Descricao": "MARK",
"DescTecnica": "MARK",
"DescComercial": "TESTE DESCRIÇÃO ",
"DescComplementar": "UTILIZADO PARA INETEGRA",
"Observacao": "Item cadastrado apenas para a empresa 10"
"Fornecedor": null,
"UnidadeMedida": "UNIDADE",
"MascaraID": 0,
"Mascara": null,
"IpiPerc": null,
"PesoBruto": 0,
"Classificacao": "ITEM GENERICO",
"DescGrupo": "GENERICO",
"MultiploVenda": null,
"CodBarra": null,
"Configurado": "Não"
}
]
}
},
"InnerSingleStatuses": [],
"Succeeded": true,
"AnySucceeded": false,
"Failed": false,
"AllFailed": false,
"BaseErrorMessage": null,
"ErrorMessage": "",
"Exception": null
}
10. Criar Item em Orçamento:¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.CriaItemOrcamentoCommand
Esse webservice irá criar um item em um orçamento, a fim de realizar os cálculos necessários sobre o mesmo, para retornar ao e-commerce. Conforme os parâmetros de entrada da requisição, é identificado se a capa do orçamento deve ser criada ou se o item está sendo adicionado a um orçamento já existente.
| Parâmetros | Descrição |
|---|---|
| orcamentoID | Utilizado quando já existe um orçamento em uso. Caso esteja informado, o sistema irá adicionar o item informado ao orçamento. |
| cnpjCpf | CNPJ ou CPF do cliente que está logado no sistema. Passar nulo quando o parâmetro orcamentoID for preenchido. |
| codigoCliente | Código do cliente que está logado no sistema. Passar nulo quando o parâmetro orcamentoID for preenchido. |
| codigoCondPagamento | Código da condição de pagamento utilizada no carrinho. Passar nulo quando o parâmetro orcamentoID for preenchido. |
| codigoRepresentante | Código do representante que está efetuando o pedido em nome do cliente. Passar nulo quando o parâmetro orcamentoID for preenchido. |
| codigoItem | Código do item que deve ser adicionado ao orçamento. |
| mascaraId | ID da máscara do item que está sendo adicionado ao orçamento. |
| quantidade | Quantidade do item. |
| tipoDctAcr | Tipo de Informação de Desconto/Acréscimo. (D – Desconto, A – Acréscimo) |
| tipoVlrDctAcr | Tipo de valor. (P - percentual, Q - quilo, U – unidade, V - valor) |
| vlrDctAcr | Valor de desconto ou acréscimo a ser aplicado, conforme parâmetros anteriores. |
| ordemCompra | Ordem de compra do cliente. |
| precoUnitario | Preço unitário do item. |
| codigoEmpresa | Código da empresa para geração do orçamento. |
| valorLiquido | Indica um valor líquido fixo para o item. Ao informar esse campo, o valor líquido do item não será alterado mesmo que o orçamento seja recalculado. |
| recalculaOrcamento | Indica se o orçamento deve ser recalculado após a inclusão do novo item. O valor padrão é "true". |
Exemplo:
{
orcamentoId: null,
cnpjCpf: 56643018000913,
codigoCliente: 4,
codigoCondPagamento: 1,
codigoRepresentante: null,
codigoItem: "KIT9999",
mascaraId: null,
quantidade: 3,
tipoDctAcr: "D",
tipoVlrDctAcr: "P",
vlrDctAcr: 2,
ordemCompra: "326",
precoUnitario: 15.50,
codigoEmpresa: 1
}
Saída:¶
| Dados | Descrição |
|---|---|
| IdOrcamento | ID do orçamento criado pelo no ERP. |
| CodigoEmpresa | Código da empresa na qual se encontra o orçamento. |
| Uf | Unidade Federativa da empresa na qual se encontra o orçamento. |
| IdItem | ID da linha do item criado no orçamento do ERP. |
| ValorLiquido | Valor líquido do item calculado no orçamento. |
| ValorIpi | Valor de IPI do item calculado no orçamento. |
| ValorSubIcms | Valor de Substituição de ICMS do item calculado no orçamento. |
Exemplo:
{
"$id": "4",
"Value": {
"$id": "5",
"$type": "Focco.Framework.DataAccess.BaseDatabase+<Query>d__39`1[[Focco.ERP.Core.Commands.Comercial.Ecommerce.WebServices.GetEstoqueItemCommand+Result, Focco.ERP.Core]], Focco.Framework.DataAccess",
"$values": [
{
"$id": "6",
"IdOrcamento": 50900,
"CodigoEmpresa": 10,
"Uf": "RS",
"IdItem": 623358,
"ValorLiquido": 6.06,
"ValorIpi": 0,
"ValorSubIcms": 0
}
]
},
"InnerSingleStatuses": [],
"Succeeded": true,
"AnySucceeded": false,
"Failed": false,
"AllFailed": false,
"BaseErrorMessage": null,
"ErrorMessage": "",
"Exception": null
}
11. Atualizar Item de Orçamento¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.AtualizaItemOrcamentoCommand
Esse webservice irá atualizar um item em um orçamento, a fim de efetuar os cálculos necessários sobre o mesmo quando for alterada a sua quantidade, para retornar ao e-commerce.
| Parâmetros | Descrição |
|---|---|
| itemId | ID da linha do item do orçamento que se deseja atualizar. |
| quantidade | Nova quantidade para o item do orçamento. |
| recalculaOrcamento | Indica se o orçamento deve ser recalculado após a atualização do item. O valor padrão é "true". |
Exemplo:
{
itemId: 623298,
quantidade: 15
}
Saída:¶
| Dados | Descrição |
|---|---|
| IdOrcamento | ID do orçamento alterado. |
| IdItem | ID da linha do item do orçamento alterada. |
| ValorLiquido | Valor líquido atualizado do item calculado no orçamento. |
| ValorIpi | Valor de IPI atualizado do item calculado no orçamento. |
| ValorSubIcms | Valor de Substituição de ICMS atualizado do item calculado no orçamento. |
Exemplo:
{
"$id": "5",
"Value": {
"$id": "6",
"$type": "Focco.Framework.DataAccess.BaseDatabase+<Query>d__39`1[[Focco.ERP.Core.Commands.Comercial.Ecommerce.WebServices.GetEstoqueItemCommand+Result, Focco.ERP.Core]], Focco.Framework.DataAccess",
"$values": [
{
"$id": "7",
"IdOrcamento": 50840,
"IdItem": 623298,
"ValorLiquido": 178.2,
"ValorIpi": 8.91,
"ValorSubIcms": 0
}
]
},
"InnerSingleStatuses": [],
"Succeeded": true,
"AnySucceeded": false,
"Failed": false,
"AllFailed": false,
"BaseErrorMessage": null,
"ErrorMessage": "",
"Exception": null
}
12. Apagar Item de Orçamento¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.ApagaItemOrcamentoCommand
Esse webservice irá apagar um item em um orçamento. Caso exista apenas um item no orçamento, irá apagar o orçamento inteiro.
| Parâmetros | Descrição |
|---|---|
| itemId | ID da linha do item do orçamento que se deseja excluir. |
| recalculaOrcamento | Indica se o orçamento deve ser recalculado após a exclusão do item. O valor padrão é "true". |
Exemplo:
{
itemId: 623250
}
Saída:¶
| Dados |
|---|
| Retorna o sucesso ou falha da execução da requisição. |
Exemplo:
{
"$id": "13",
"InnerSingleStatuses": [],
"Succeeded": true,
"AnySucceeded": false,
"Failed": false,
"AllFailed": false,
"BaseErrorMessage": null,
"ErrorMessage": "",
"Exception": null
}
13. Atualizar Condição de Pagamento de Orçamento¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.AtualizaCondPagamentoCommand
Esse webservice permite alterar a condição de pagamento de um orçamento e o recalcula, devolvendo seus respectivos valores atualizados.
| Parâmetros | Descrição |
|---|---|
| codigoCondPagamento | Código da nova condição de pagamento para o orçamento. |
| orcamentoId | ID do orçamento. |
Exemplo:
{
codigoCondPagamento: 2,
orcamentoId: 50880
}
Saída:¶
| Dados | Descrição |
|---|---|
| IdOrcamento | Id do orçamento alterado. |
| ValorLiquido | Valor líquido total do orçamento. |
| ValorIpi | Valor de IPI total do orçamento. |
| ValorSubIcms | Valor de Substituição de ICMS total do orçamento. |
| IdItem | ID da linha do item no orçamento. |
| ValorLiquido | Valor líquido do item. |
| ValorIpi | Valor de IPI do item. |
| ValorSubIcms | Valor de Substituição de ICMS do item. |
Exemplo:
{
"$id": "10",
"Value": {
"$id": "11",
"IdOrcamento": 0,
"ValorLiquido": 6.06,
"ValorIpi": 0,
"ValorSubIcms": 0,
"Itens": {
"$id": "12",
"$values": [
{
"$id": "13",
"IdItem": 623338,
"ValorLiquido": 6.06,
"ValorIpi": 0,
"ValorSubIcms": 0
}
]
}
},
"InnerSingleStatuses": [],
"Succeeded": true,
"AnySucceeded": false,
"Failed": false,
"AllFailed": false,
"BaseErrorMessage": null,
"ErrorMessage": "",
"Exception": null
}
14. Apagar Orçamento¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.ApagaOrcamentoCommand
Esse webservice irá apagar um orçamento completo do ERP.
| Parâmetros | Descrição |
|---|---|
| orcamentoId | ID do orçamento. |
Exemplo:
{
orcamentoId: 50869
}
Saída:¶
| Dados |
|---|
| Retorna o sucesso ou falha da execução da requisição. |
Exemplo:
{
"$id": "4",
"InnerSingleStatuses": [],
"Succeeded": true,
"AnySucceeded": false,
"Failed": false,
"AllFailed": false,
"BaseErrorMessage": null,
"ErrorMessage": "",
"Exception": null
}
15. Buscar Orçamento Completo¶
Endereço:¶
URL:
Esse webservice retorna o orçamento completo, com seus valores de capa, itens e respectivos valores.
| Parâmetros | Descrição |
|---|---|
| orcamentoId | ID do orçamento. |
| recalculaOrcamento | Indica se o orçamento deve ser recalculado antes de ser retornado. O valor padrão é "false". |
Exemplo:
{
orcamentoId: 50871,
}
Saída:¶
| Dados | Descrição |
|---|---|
| IdOrcamento | Id do orçamento consultado. |
| CodigoEmpresa | Código da empresa na qual se encontra o orçamento. |
| Uf | Unidade Federativa da empresa na qual se encontra o orçamento. |
| ValorLiquido | Valor líquido total do orçamento. |
| ValorIpi | Valor de IPI total do orçamento. |
| ValorSubIcms | Valor de Substituição de ICMS total do orçamento. |
| IdItem | ID da linha do item no orçamento. |
| CodigoItem | Código do item da linha do orçamento. |
| MascaraId | ID da máscara do item na linha do orçamento. Esse campo não é retornado se o valor for nulo. |
| Quantidade | Quantidade do item na linha do orçamento. |
| ValorLiquido | Valor líquido do item. |
| ValorIpi | Valor de IPI do item. |
| ValorSubIcms | Valor de Substituição de ICMS do item. |
Exemplo:
{
"$id": "11",
"Value": {
"$id": "12",
"IdOrcamento": 50871,
"CodigoEmpresa": 10,
"Uf": "RS",
"ValorLiquido": 41.7,
"ValorIpi": 1.78,
"ValorSubIcms": 0,
"Itens": {
"$id": "13",
"$values": [
{
"$id": "14",
"IdItem": 623323,
"CodigoItem": "KIT9999",
"Quantidade": 2,
"ValorLiquido": 35.64,
"ValorIpi": 1.782,
"ValorSubIcms": 0
},
{
"$id": "15",
"IdItem": 623324,
"CodigoItem": "EN7000",
"MascaraId": 270,
"Quantidade": 45,
"ValorLiquido": 6.06,
"ValorIpi": 0,
"ValorSubIcms": 0
}
]
}
},
"InnerSingleStatuses": [],
"Succeeded": true,
"AnySucceeded": false,
"Failed": false,
"AllFailed": false,
"BaseErrorMessage": null,
"ErrorMessage": "",
"Exception": null
}
16. Criar Pedido de Venda¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.CriaPedidoCommand
Cria um pedido de venda no sistema a partir do orçamento informado. O orçamento utilizado, caso o processo seja bem-sucedido, será apagado do ERP.
| Parâmetros | Descrição |
|---|---|
| orcamentoId | ID do orçamento que se deseja transformar em pedido de venda. |
Exemplo:
{
orcamentoId: 50826
}
Saída:¶
| Dados | Descrição |
|---|---|
| IdPedido | ID do pedido de venda criado no ERP. |
| NumeroPedido | Número do pedido de venda criado no ERP. |
| ValorLiquido | Valor líquido total do pedido. |
| ValorIpi | Valor de IPI total do pedido. |
| ValorSubIcms | Valor de Substituição de ICMS total do pedido. |
| IdItem | ID da linha do item no pedido. |
| ValorLiquido | Valor líquido do item. |
| ValorIpi | Valor de IPI do item. |
| ValorSubIcms | Valor de Substituição de ICMS do item. |
Exemplo:
{
"$id": "307",
"Value": {
"$id": "308",
"IdPedido": 50873,
"NumeroPedido": 379
"ValorLiquido": 41.7,
"ValorIpi": 1.78,
"ValorSubIcms": 0,
"Itens": {
"$id": "309",
"$values": [
{
"$id": "310",
"IdItem": 623325,
"ValorLiquido": 35.64,
"ValorIpi": 1.782,
"ValorSubIcms": 0
},
{
"$id": "311",
"IdItem": 623326,
"ValorLiquido": 6.06,
"ValorIpi": 0,
"ValorSubIcms": 0
}
]
}
},
"InnerSingleStatuses": [],
"Succeeded": true,
"AnySucceeded": false,
"Failed": false,
"AllFailed": false,
"BaseErrorMessage": null,
"ErrorMessage": "",
"Exception": null
}
17. Buscar Status de Pedido de Venda¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.GetStatusPedidoCommand
Busca o status atual do Pedido de Venda, a afim de acompanhar o seu andamento, podendo ser um dos seguintes:
-
Cancelado
-
Faturado
-
Em separação
-
Em processamento
| Parâmetros | Descrição |
|---|---|
| pdvId | ID do pedido de venda cujo status se deseja consultar. |
Exemplo:
{
pdvId: 50480
}
Saída:¶
| Dados | Descrição |
|---|---|
| NumeroPedido | Número do pedido de venda no ERP. |
| PosicaoPedido | Posição atual do pedido de venda. |
| Status | Retorna o status atual do pedido de venda. |
Exemplo:
{
"$id": "314",
"NumeroPedido": "379",
"PosicaoPedido": "PE",
"Status": "Faturado",
"InnerSingleStatuses": [],
"Succeeded": true,
"AnySucceeded": false,
"Failed": false,
"AllFailed": false,
"BaseErrorMessage": null,
"ErrorMessage": "",
"Exception": null
}
18. Buscar Cliente Específico¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.GetClienteCommand
Esse webservice tem o propósito de retornar os dados completos por cliente, será necessário informar o CNPJ ou CPF do estabelecimento marcado como e-Commerce e o código do cliente para que busque as informações corretamente.
| Parâmetros | Descrição |
|---|---|
| codigoCliente | Código do cliente ao qual se deseja buscar os dados. |
| cnpjCpf | CNPJ ou CPF do cliente ao qual se deseja buscar os dados. |
Exemplo:
{
codigoCliente: 12,
cnpjCpf: “91514836000160”
}
Saída:¶
| Dados | Descrição |
|---|---|
| ID | ID interno do Cliente no ERP. |
| Codigo | Código do cliente cadastrado no ERP. |
| RazaoSocial | Razão social do estabelecimento cadastrada no ERP. |
| NomeFantasia | Nome fantasia do estabelecimento cadastrada no ERP. |
| Cnpj | CNPJ do estabelecimento, caso houver. |
| Cpf | CPF do cliente, caso houver. |
| Contato | Contato de ranking mais baixo do cadastro do cliente no ERP. |
| DataNasc | Data de nascimento do contato, caso houver. |
| E-Mail do cliente/estabelecimento de ranking mais baixo. | |
| Cep | CEP do endereço do estabelecimento informado. |
| Endereco | Endereço do cliente/estabelecimento. |
| NumEndereco | Número do endereço do cliente/estabelecimento. |
| Bairro | Bairro do cliente/estabelecimento. |
| Complemento | Complemento do endereço cadastrado. |
| Cidade | Cidade do cliente/estabelecimento. |
| UF | UF do cliente/estabelecimento. |
| Pais | País do cliente/estabelecimento. |
| TabelaPreco | Tabela de Preco do cliente/estabelecimento. |
| Codigo | Código da tabela de preço. |
| Descricao | Descrição da tabela de preço. |
| NumTelefones | Números de telefones cadastrados para o cliente no ERP. |
| DDD | DDD do telefone. |
| Telefone | Número do telefone. |
| TipoTelefone | Tipo do telefone. |
| CondicaoPagamento | Condição de pagamento do cliente/estabelecimento. |
| Codigo | Código da condição de pagamento. |
| Descricao | Descrição da condição de pagamento. |
Exemplo:
{
"$id": "19",
"Value": {
"$id": "20",
"ID": 5209,
"Codigo": 12,
"RazaoSocial": "TECNOVIDRO INDUSTRIA DE VIDROS LTDA",
"NomeFantasia": "TECNOVIDRO INDUSTRIA DE VIDROS LTDA - FANTASIA",
"Cnpj": 91514836000160,
"Cpf": null,
"InscEstadual": "0450022188",
"Contato": "TESTE ECOMMERCE",
"DataNasc": "25/09/1990",
"Email": "teste.ecommerce@focco.com.br",
"Cep": 95180000,
"Endereco": "RODOVIA RS 122",
"NumEndereco": "5",
"Bairro": "CENTRO",
"Complemento": null,
"Cidade": "FARROUPILHA",
"UF": "RS",
"Pais": "BRASIL",
"TabelaPreco": {
"$id": "13",
"Codigo": 100,
"Descricao": "TABELA INDUSTRIA MOVELEIRA S/ICMS"
},
"NumTelefones": {
"$id": "21",
"$values": [
{
"$id": "22",
"DDD": "054",
"Telefone": "1561561",
"TipoTelefone": "Comercial"
},
{
"$id": "23",
"DDD": "054",
"Telefone": "1568181",
"TipoTelefone": "Fax"
},
{
"$id": "24",
"DDD": "054",
"Telefone": "181231458",
"TipoTelefone": "Conexão"
}
]
},
"CondicaoPagamento": {
"$id": "52767",
"Codigo": 90,
"Descricao": "A VISTA"
},
},
"InnerSingleStatuses": [],
"Succeeded": true,
"AnySucceeded": false,
"Failed": false,
"AllFailed": false,
"BaseErrorMessage": null,
"ErrorMessage": "",
"Exception": null
}
19. Buscar Itens Alternativos¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.GetItensAlternativosCommand
Busca os itens alternativos de um item ou de todos os itens que tenham alternativos na empresa informada.
| Parâmetros | Descrição |
|---|---|
| empresaId | ID da empresa. |
| codigoItem | Código do item a ser consultado. Passar nulo para retornar todos os itens e seus alternativos na empresa em questão. |
Exemplo:
{
empresaId: 1,
codigoItem: "10034"
}
Saída:¶
| Dados | Descrição |
|---|---|
| ID | ID do item comercial. |
| ItemEmpresaID | ID do item empresa. |
| CodigoItem | Código do item. |
| DescricaoItem | Descrição do item. |
| ID | ID do item comercial, referente ao item alternativo. |
| ItemEmpresaID | ID do item empresa, referente ao item alternativo. |
| CodigoItem | Código do item, referente ao item alternativo. |
| DescricaoItem | Descrição do item, referente ao item alternativo. |
Exemplo:
{
"$id": "885",
"Value": {
"$id": "886",
"$values": [
{
"$id": "887",
"ID": 30787,
"ItemEmpresaID": 31491,
"CodigoItem": "MAQ9015",
"DescricaoItem": "MAQUINA BIB SELECAO - 220 VOLTS",
"Rows": {
"$id": "888",
"$values": [
{
"$id": "889",
"ID": 30681,
"ItemEmpresaID": 31385,
"CodigoItem": "MAQ9014",
"DescricaoItem": "MAQUINA BIB SELECAO PEQUENA - 220 VOLTS"
},
{
"$id": "894",
"ID": 30788,
"ItemEmpresaID": 31492,
"CodigoItem": "MAQ9016",
"DescricaoItem": "MAQUINA BIB SELECAO - 110 VOLTS"
}
]
}
}
]
},
"InnerSingleStatuses": [],
"Succeeded": true,
"AnySucceeded": false,
"Failed": false,
"AllFailed": false,
"BaseErrorMessage": null,
"ErrorMessage": "",
"Exception": null
}
20. Buscar Último Preço Praticado¶
Endereço:¶
URL: <endereçoERP>/api/Commands/Comercial.Ecommerce.WebServices.GetUltimoPrecoPraticadoCommand
Busca o último preço praticado para o item, vendido a um determinado cliente.
| Parâmetros | Descrição |
|---|---|
| empresaId | ID da empresa. |
| codigoCliente | Código do cliente a ser consultado. |
| codigoItem | Código do item a ser consultado. |
| mascaraId | ID da máscara do item, caso seja configurado. |
Exemplo:
{
"empresaId": 1,
"codigoCliente": "51",
"codigoItem": "EN7000",
"mascaraId": null
}
Saída:¶
| Dados | Descrição |
|---|---|
| ValorLiquido | Valor liquido do item correspondendo ao último preço praticado. |
Exemplo:
{
"$id": "1",
"Value": {
"$id": "2",
"ValorLiquido": 4.55
},
"InnerSingleStatuses": [],
"Succeeded": true,
"AnySucceeded": false,
"Failed": false,
"AllFailed": false,
"BaseErrorMessage": null,
"ErrorMessage": "",
"Exception": null
}