Manual Técnico Integração Plansyst WebService - 07112022

Plansyst P12
1. Manual Técnico - Integração Plansyst via WebService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.1 Integração - Cancela Pedido . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.2 Integração - Consulta de Cliente . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.3 Integração - Consulta de Produto(s) Específico(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.4 Integração - Consulta de Produto(s) Específico(s) Com Foto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.5 Integração - Consulta de Produtos por Data/Hora de alteração de Preço/Estoque . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.6 Integração - Consulta de Produtos por Data de Cadastro/Alteração . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.7 Integração - Consulta de Tipos de Pagamento . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
1.8 Integração - Consulta de XML da NFE de Venda . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
1.9 Integração - Geração de Pedido de Venda . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Manual Técnico - Integração Plansyst via WebService
Objetivo
Disponibilização de dados específicos do sistema Plansyst para integração com E-Commerces.
Pré-Requisitos
Adquirir junto a Plansyst o token conforme o tipo de integração para utilização dos WebServices.
Ambiente pré-instalado com IIS > 7.0 ( Somente caso o WebService seja instalado em um servidor do Cliente )
Especificações
Web Services disponíveis para integração :
1. Consulta de Cliente
2. Consulta de Produtos
a. Consulta de Produto(s) específico(s)
b. Consulta de Produtos por Data/Hora de alteração de Preço/Estoque
c. Consulta de Produtos por Data de Cadastro/Alteração.
3. Consulta de Tipos de Pagamento
4. Geração de Pedido de Venda
5. Consulta de XML da NFE de Venda
Regras e Definição
Em todos os WebServices disponíveis, deverá ser utilizado a formatação JSON (JavaScript Object Notation).
Deverá ser utilizado somente os métodos POST e GET, conforme cada WebService disponível.
Todos os elementos utilizados no Body da requisição deverão estar entre aspas, por exemplo, "Codigo", "CodCliente".
Todas as atribuições de valores para campos do Body devem utilizar o caractere : (por exemplo, "Codigo" : 1.9)
Caso haja necessidade de informar no Body objetos que possuam objetos filhos (por exemplo, campo "CNPJ" do objeto ClienteInfo), o objeto
principal (pai) deverá ser informado seguindo a formatação de exemplo a seguir :
'ClienteInfo':
{
"CNPJ":"999.999.999-99"
}
No caso de uma chamada simples, o Body da chamada seguiria a formatação conforme exemplo abaixo:
{
"Codigo": 66695.5
}
Importante
Todos as chamadas dos WebServices, devem obrigatoriamente informar no header da requisição as seguintes informações:
Authorization : Será composto por uma chave pública enviada pela Plansyst mais o símbolo @ e um hash MD5
gerado a partir de uma chave privada também disponibilizada pela Plansyst mais o body da requisição.
Exemplo
Chave pública - 89284699231717553692431954424984121268964762974254892665160
Body da requisição - {"ListaProd": "1.9", "CodCliente": "1234.5"}
Chave privada - 1111111111111111111111111111111111111111111
Calcular Hash MD5 da junção de Chave Privada + Body - 11111111111111111111111111111111111111
11111{"ListaProd": "1.9", "CodCliente": "1234.5"}
Hash Calculado - FFEDA47353B98342AB35F40CAC8B2249
Authorization - 89284699231717553692431954424984121268964762974254892665160@FFEDA47353B9
8342AB35F40CAC8B2249
Content-Type : com o formato application/json
A falta de uma destas informações no header da requisição fará com que a mesma seja rejeitada.
Para testes com a geração do Hash MD5 utilizando ferramentas de RestAPI atentar-se ao conteúdo do Body pois não podem conter
espaços nem quebra de linha para cálculo correto do hash. Em muitos casos o body é formatado em padrão JSON com espaçamentos
que para o cálculo não podem existir.
Plansyst Consultoria e Informática LTDA - EPP

Av. Andrade Neves, 295 sala 172 CEP:13013-160 - Campinas - SP Fone/Fax: (019) 3027-6900/3731-6900 3
E-Mail: plansyst@plansyst.com.br
Interfaces
Título method Caminho
Integração - Geração de Pedido de Venda POST http://[URL]/api/v2/GeraVenda
Integração - Consulta de Produto(s) Específico(s) Com Foto PUT http://[URL]/api/v2/ProdutoFoto
Integração - Consulta de Produto(s) Específico(s) PUT http://[URL]/api/v2/Produto
Integração - Consulta de XML da NFE de Venda PUT http://[URL]/api/v2/RetornaXML
Integração - Consulta de Tipos de Pagamento PUT http://[URL]/api/v2/TipoPagamento
Integração - Consulta de Cliente POST/PUT http://[URL]/api/v2/Cliente
Integração - Consulta de Produtos por Data/Hora de alteração de Preço/Estoque PUT http://[URL]/api/v2/ListaProdutosMovHora
Integração - Consulta de Produtos por Data de Cadastro/Alteração PUT http://[URL]/api/v2/ProdutosDtCad
Integração - Cancela Pedido POST http://[URL]/api/v2/CancelaVenda

Integração - Cancela Pedido
method POST
Caminho http://[URL]/api/v2/CancelaVenda
Cancela Pedido
Método disponível : POST

No body da chamada, deverão ser informados os dados da venda, seguindo a obrigatoriedade dos objetos abaixo:
Empresa
Informar o CNPJ da empresa onde foi gerado o pedido de venda, utilizando o objeto "EmpresaInfo" e "CNPJ". Exemplo : "Empr
esaInfo": {"CNPJ": "11.222.333/4444-55"}
ClienteInfo
Informar o CPF/CNPJ e Codigo do cliente e seu código já previamente cadastrado na Plansyst.
NumeroPedido- Informar o numero do pedido gerado anteriormente.
O WebService de "Cancela Pedido " deverá ser acessado através do caminho http://WCFDoCliente/api/v2/CancelaVenda
Caso o pedido seja cancelado será retornado : "Documento Cancelado"
caso não seja possível cancelar irá retornar o erro
Falha Cancelamento(1)
Pedido já cancelado
Nota impressa
Abaixo um exemplo
Requisição de XML de Venda
{
"EmpresaInfo":{
"CNPJ": "11.222.333/4444-55"
},
"ClienteInfo": {
"CNPJ": "11.222.333/4444-55",
"Codigo": 123686.5
},
"NumeroPedido":"V0570005"
}

Integração - Consulta de Cliente
method POST/PUT
Caminho http://[URL]/api/v2/Cliente
Consulta de Cliente
Métodos disponíveis : POST e PUT

PUT - Utilizado para consultar por CPF/CNPJ um cliente já cadastrado no Plansyst.
Utilizar o elemento CPF_CNPJ para consultar um CPF/CNPJ de cliente.
O elemento CPF_CNPJ é obrigatório neste método.
Poderá ser retornado uma lista de clientes caso existam registros de clientes com mesmo CNPJ.
Exemplo de uma consulta de cliente
{"CPF_CNPJ": "123.456.789-00"}
POST - Utilizado para enviar informação de um novo cliente para cadastro no Plansyst.
Detalhamento dos campos obrigatórios para cadastramento de cliente:
Campo Tamanho Observação
EmpresaInfo Objeto Informar CNPJ da Empresa com máscara
CPF_CNPJ 20 Informar CPF ou CNPJ com máscara
IE_RG 20 Informar RG ou IE com máscara
Pessoa 1 F (Física) ou J (Jurídica)
Nome 60
Estado 2 Informar UF (SP, MG, MA, etc)
Cidade 50
Bairro 60
Endereco 50
CEP 10 Informar o CEP com máscara
Número 10 Número do Endereço do Cliente
Email 100 E-mail do Cliente para envio do XML

Exemplo de uma requisição para criação de um novo cliente
{
"EmpresaInfo": {
"CNPJ": "11.111.111/0001-01"
},
"CPF_CNPJ": "162.209.988-55",
"IE_RG": "12.135.678-9",
"Pessoa": "F",
"Nome": "NOME DO CLIENTE",
"Estado": "SP",
"Cidade": "CAMPINAS",
"Bairro": "CENTRO",
"Endereco": "RUA DO TESTE",
"CEP": "10000-000",
"Numero": "500",
"Email": "emaildocliente@xxx.com"
}
Exemplo do retorno de uma requisição ao WebService de cliente, contendo os dados retornados

Retorno de Requisição Retorno de Requisição
CPF/CNPJ informado existe CPF/CNPJ Informado não cadastrado
{ {
"Codigo" : 123456.3 , "Codigo" : 0.0 ,
"CPF_CNPJ" : "123.456.789-00" , "CPF_CNPJ" : null ,
"Status" : "Cliente não cadastrado."
"Status" : "Sucesso" }
}
O WebService de "Dados de Clientes" deverá ser acessado através do caminho http://WCFDoCliente/api/v2/Cliente

Integração - Consulta de Produto(s) Específico(s)
method PUT
Caminho http://[URL]/api/v2/Produto
Consulta de Produto(s) Específico(s)
Método disponível : PUT

Elementos de consulta (informar somente 1 filtro por requisição)
"Codigo" - Código interno do produto
"ListaProd" - Lista de códigos internos de produtos, para em uma única consulta ter o retorno de diversos produtos. Os códigos devem
ser separador por ; (ponto e vírgula)
Elemento "CodCliente" deverá conter o código do cliente para que o preço calculado do produto possa considerar possíveis regras específicas
por cliente.
Objeto "EmpresaInfo" deverá conter o elemento CNPJ da empresa utilizado na consulta de Preço/Estoque.
O WebService de Produtos deverá ser acessado através do caminho :
http://WCFDoCliente/api/v2/Produto
Abaixo exemplos de consultas utilizando o WebService:
Requisição por Código Requisição de Lista de Produtos
{
"ListaProd": "1.9;2.7",
{ "CodCliente": "1234.5",
"Codigo": "1.9", "EmpresaInfo": {
"CodCliente": "1234.5", "CNPJ": "11.111.111/0001-01"
"EmpresaInfo": { }
"CNPJ": "11.111.111/0001-01" }
}
}
Retorno Retorno
Requisição por Número de Fabricante Requisição por Lista de Produtos
[
{
"Codigo" : 1.9 ,
"NumeroFabrica" : "R9999" ,
"Estoque" : 999 .0 ,
"Preco" : 100.88,

[
{ "ModeloAno": [
"Codigo" : 1.9 , {
"NumeroFabrica" : "R9999" , "CodMod": "513038-7",
"Estoque" : 999.0 , "Modelo": "P-124 CB 360 6X4 NZ 2P (DIESEL)",
"Preco" : 100.88, "Marca": "SCANIA CAMINHOES",
"ModeloAno": [ "AnoIni": "1997",
{ "AnoFim": "2006"
"CodMod": "513038-7", },
"Modelo": "P-124 CB 360 6X4 NZ 2P (DIESEL)", {
"Marca": "SCANIA CAMINHOES", "CodMod": "513094-8",
"AnoIni": "1997", "Modelo": "P-124 CB 360 8X4 NZ 2P (DIESEL)",
"AnoFim": "2006" "Marca": "SCANIA CAMINHOES",
}, "AnoIni": "1999",
{ "AnoFim": "2006"
"CodMod": "513094-8", },
}, "AnoIni": "2001",
{ "AnoFim": "2006"
"CodMod": "513095-6", },
}, "AnoIni": "2002",
{ "AnoFim": "2006"
"CodMod": "513126-0", }
"Modelo": "P-124 CB 400 8X4 NZ 2P (DIESEL)", ],
"Marca": "SCANIA CAMINHOES", "CodBarras": "7899159724171",
"AnoIni": "2002", "Dimensoes": [
"AnoFim": "2006" {
} "Id": 1,
], "Dimensao": "Largura",
"CodBarras": "7899159724171", "Valor": 133.0
"Dimensoes": [ },
{ {
"Id": 1, "Id": 2,
"Dimensao": "Largura", "Dimensao": "Comprimento",
"Valor": 133.0 "Valor": 50.0
}, },
{ {
"Id": 2, "Id": 3,
"Dimensao": "Comprimento", "Dimensao": "Altura",
"Valor": 50.0 "Valor": 222.0
}, }
{ ],
"Id": 3, "Titulo": "TITULO ECOMMERCE TESTE",
"Dimensao": "Altura", "Descricao":
"Valor": 222.0
} "DESCRICAO TESTE\r\n\r\nENTER\r\n\r\nDADOS DO
], ANUNCIO ESPAÇAMENTOS \r\n\r\",
"Titulo": "TITULO ECOMMERCE TESTE",
"Descricao":
"Categoria": "CAMBIO | CAIXA DE CAMBIO | ANEIS"
"DESCRICAO TESTE\r\n\r\nENTER\r\n\r\nDADOS DO
ANUNCIO ESPAÇAMENTOS \r\n\r\",
"Categoria": "CAMBIO | CAIXA DE CAMBIO | ANEIS"

}
]

},
{
"Codigo" : 2.7 ,
"Estoque" : 55.0 ,
"Preco" : 31.48,
"ModeloAno": [],
"CodBarras" : null,
"Dimensoes": [],
"Titulo": null,
"Descricao": null,
"Categoria": ""
}
]

Integração - Consulta de Produto(s) Específico(s) Com Foto
method PUT
Caminho http://[URL]/api/v2/ProdutoFoto
Consulta de Produto(s) Específico(s)

Elementos de consulta (informar somente 1 filtro por requisição)
"Codigo" - Código interno do produto
"ListaProd" - Lista de códigos internos de produtos, para em uma única consulta ter o retorno de diversos produtos. Os códigos devem
ser separador por ; (ponto e vírgula)
por cliente.
http://WCFDoCliente/api/v2/ProdutoFoto
Requisição por Código Requisição de Lista de Produtos
{
"ListaProd": "1.9;2.7",
{ "CodCliente": "1234.5",
"Codigo": "1.9", "EmpresaInfo": {
"CodCliente": "1234.5", "CNPJ": "11.111.111/0001-01"
"EmpresaInfo": { }
"CNPJ": "11.111.111/0001-01" }
}
}
Retorno Retorno
Requisição por Número de Fabricante Requisição por Lista de Produtos

[ [
{ {
"Fotos": [}, "Fotos": [},
"Codigo": 1.9, "Codigo": 1.9,
"NumeroFabrica": "CH27X27-1", "NumeroFabrica": "CH27X27-1",
"Estoque": 0.0, "Estoque": 0.0,
"Preco": 0.0, "Preco": 0.0,
"ModeloAno": null, "ModeloAno": null,
"CodBarras": null, "CodBarras": null,
"Dimensoes": null, "Dimensoes": null,
"Titulo": null, "Titulo": null,
"Descricao": null, "Descricao": null,
"Categoria": null "Categoria": null
} },
] {
"Fotos": [},
"Codigo":2.7 ,
"Estoque": 0.0,
"Preco": 0.0,
"ModeloAno": null,
"CodBarras": null,
"Dimensoes": null,
"Titulo": null,
"Descricao": null,
"Categoria": null
}
]

Integração - Consulta de Produtos por Data/Hora de
alteração de Preço/Estoque
method PUT
Caminho http://[URL]/api/v2/ListaProdutosMovHora
Consulta de Produtos por Data/Hora de alteração de Preço/Estoque

Elementos de consulta
"DtUltMovEstPco " - Data/Hora para consulta de peças com alteração de estoque disponível/preço. Utilizar formato "AAAA-MM-
DDTHH:MM:SS", por exemplo "2020-10-14T16:00:00"
por cliente.
http://WCFDoCliente/api/v2/ ListaProdutosMovHora
Requisição por Código
{
"CodCliente": "1234.5",
"EmpresaInfo": {
"CNPJ": "11.111.111/0001-01"
},
"DtUltMovEstPco": "2020-10-14T16:00:00"
}
Na requisição acima, será consultado todas as peças que possuem data/hora de alteração de estoque/preço maior ou igual a 14/10/2020 16:00:
00. Significa que todas as peças que após esta data/hora mencionada, tiveram alguma movimentação ou alteração de preço serão retornadas
nesta API.
Retorno

[
{
"Codigo" : 1.9 ,
"NumeroFabrica" : "AAAAAA" ,
"Estoque" : 100.0 ,
"Preco" : 0.0 ,
"ModeloAno" : [],
"CodBarras" : null
},
{
"Codigo" : 2.7 ,
"NumeroFabrica" : "BBBBBB" ,
"Estoque" : 106.0 ,
"Preco" : 10.7 ,
"ModeloAno" : [],
"CodBarras" : null
},
{
"Codigo" : 3.5 ,
"NumeroFabrica" : "CCCCCC" ,
"Estoque" : 0.0 ,
"Preco" : 139.21 ,
"ModeloAno" : [],
"CodBarras" : null
}
]

Integração - Consulta de Produtos por Data de Cadastro
/Alteração
method PUT
Caminho http://[URL]/api/v2/ProdutosDtCad
Consulta de Produtos por Data de Cadastro/Alteração

Elementos de consulta
"DtCadastro" - Data de cadastro/alteração do produto. Utilizar formato "AAAA-MM-DDTHH:MM:SS", por exemplo "2020-10-14T16:00:
00"
"Pagina" - Utilizado para paginação dos dados. Informar o número da página que deseja resgatar.
"QtdReg" - Quantidade de registros por página.
por cliente.
http://WCFDoCliente/api/v2/ ProdutosDtCad
Requisição por Código
{
"CodCliente": "1234.5",
"EmpresaInfo": {
"CNPJ": "11.111.111/0001-01"
},
"DtCadastro": "2020-01-01T16:00:00",
"Pagina": 1,
"QtdReg": 10
}
Na requisição acima, serão pesquisados todos os produtos com data de cadastramento ou alteração cadastral a partir de 01/01/2020.
Retorno

[
{
"Codigo" : 1.9 ,
"NumeroFabrica" : "AAAAAA" ,
"DataCadastro" : "23/01/2020" ,
"Estoque" : 100.0 ,
"Preco" : 0.0 ,
"ModeloAno" : [],
"CodBarras" : null
},
{
"Codigo" : 2.7 ,
"NumeroFabrica" : "BBBBBB" ,
"DataCadastro" : "03/01/2020" ,
"Estoque" : 106.0 ,
"Preco" : 10.7 ,
"ModeloAno" : [],
"CodBarras" : null
},
{
"Codigo" : 3.5 ,
"NumeroFabrica" : "CCCCCC" ,
"DataCadastro" : "29/01/2020" ,
"Estoque" : 0.0 ,
"Preco" : 139.21 ,
"ModeloAno" : [],
"CodBarras" : null
},
{
"Codigo" : 4.3 ,
"NumeroFabrica" : "DDDDDD" ,
"DataCadastro" : "03/03/2020" ,
"Estoque" : 0.0 ,
"Preco" : 0.0 ,
"ModeloAno" : [],
"CodBarras" : null
},
{
"Codigo" : 5.1 ,
"NumeroFabrica" : "EEEEEE" ,
"DataCadastro" : "26/02/2020" ,
"Estoque" : 5.0 ,
"Preco" : 15.0 ,
"ModeloAno" : [],
"CodBarras" : null
}
]

Integração - Consulta de Tipos de Pagamento
method PUT
Caminho http://[URL]/api/v2/TipoPagamento
Consulta de Tipos de Pagamento

Este WebService não possui elementos de filtros pois retornará todos os tipos de pagamentos liberados para integração com o E-Commerce.
O WebService de "Dados de Tipos de Pagamento" deverá ser acessado através do caminho http://WCFDoCliente/api/v2/TipoPagamento
Abaixo exemplo do retorno de uma requisição ao WebService de tipos de pagamento, contendo os campos retornados :
[
{
"Codigo": 403,
"Descricao": "E-COMMERCE CARTÃO CRÉDITO",
"UtilizaECommerce": 1
},
{
"Codigo": 404,
"Descricao": "E-COMMERCE CARTÃO DEBITO",
},
{
"Codigo": 405,
"Descricao": "E-COMMERCE BOLETO BANCÁRIO",
}
]

Integração - Consulta de XML da NFE de Venda
method PUT
Caminho http://[URL]/api/v2/RetornaXML
Consulta de XML da NFE de Venda

Elementos disponíveis para filtros:
"EmpresaInfo" - Contendo o CNPJ da Empresa (Mesma informação enviada na requisição de uma venda)
"Pedido" - Número do Pedido de Venda (Número do pedido retornado da requisição da venda)
O WebService de "Retorno de XML da NFE" deverá ser acessado através do caminho http://WCFDoCliente/api/v2/RetornaXML
O retorno deste WebService será o conteúdo do XML da NFE referente ao pedido de venda requisitado.
Abaixo um exemplo
Requisição de XML de Venda
{
"EmpresaInfo": {"CNPJ": "11.222.333/4444-55"},
"Pedido": "U1000001"
}

Integração - Geração de Pedido de Venda
method POST
Caminho http://[URL]/api/v2/GeraVenda
Geração de Pedido de Venda
Método disponível : POST

No body da chamada, deverão ser informados os dados da venda, seguindo a obrigatoriedade dos objetos abaixo:
Empresa
Informar o CNPJ da empresa onde será gerado o pedido de venda, utilizando o objeto "EmpresaInfo" e "CNPJ". Exemplo : "Em
presaInfo": {"CNPJ": "11.222.333/4444-55"}
ClienteInfo
Informar o CPF/CNPJ e Codigo do cliente e seu código já previamente cadastrado na Plansyst. Se informado um CPF ou
CNPJ não cadastrado, o processo de venda não será concluído. Neste caso será necessário enviar primeiramente o
cadastramento do cliente para posteriormente reenviar o pedido de venda.
Transp
Informar o Codigo da Transportadora já previamente cadastrado na Plansyst. Se informado um código não cadastrado, o
processo de venda não será concluído. Caso não tenha transportadora, não enviar esta TAG.
FormaPagamento
Informar a forma de pagamento utilizada na venda.
O código do tipo de pagamento obrigatoriamente deverá existir no Sistema Plansyst, sendo este carregado para o E-
Commerce pelo WebService de tipos de pagamento.
Se informado um tipo de pagamento inválido o processo de venda não será concluído.
Utilizar a estrutura conforme exemplo abaixo :
'FormaPagamento':
{
"Codigo" : 407
},
Neste elemento o mesmo deve ser informado com valor Inteiro .
NumPedCliente - Campo disponível para informar apenas 1 Número do Pedido do Cliente com até 8 dígitos que será enviado no XML
da venda, no campo XPED, podendo quando necessário vincular um número de pedido interno com o pedido gerado no Plansyst. Este
número de pedido será atribuído a todos os itens enviados na Venda.
Produtos
CodigProduto (Código do produto, por exemplo 1.9) - Utilizar . (ponto) e não , (vírgula)
Quantidade (Quantidade vendida)
PrecoVenda (Preço unitário do item conforme enviado no WebService de Produtos )
VlFinal (preço total do item na venda (PrecoVenda * Quantidade)
Este array conterá as informações dos produtos referente ao pedido de venda realizado.
Se este array não for informado, o pedido não será processado.
É obrigatório que a cada produto informado, inicie o array de Produtos da seguinte forma :
'Produtos':[
{
}]
Dentro de cada array de Produtos, deverá obrigatoriamente conter :
Totais
Informações das totalizações dos itens. Campos disponíveis :
ValorFrete (Valor total do frete na venda) - Informar 0 caso não tenha
ValorProduto (Valor total dos produtos na venda)
DescontoTotal (Valor total dos descontos na venda) - Informar 0 caso não tenha
ValorLiquido (Valor líquido da venda (Valor dos Produtos + ValorFrete - DescontoTotal)
DadosPagamento (Dependendo o formato da integração utilizada, este bloco pode não ser obrigatório)
Informações referentes ao pagamento de cartão, boleto, etc.
NSU
Autorizacao
QtdParcelas

ValorRecebido
DataPagamento (data do lançamento no financeiro realizado do cliente)
Bandeira (MASTERCARD, VISA, ELO, etc)
TipoVenda (CREDITO, DEBITO ou BOLETO),
Banco
ContaCorrente
EnderecoEntrega(Apenas enviar caso os dados de Entrega sejam diferentes do Cadastro do Cliente)
Informações referentes ao dados de Entrega:
Nome
Logradouro
Número
Complemento
UF
Bairro
Cidade
CidadeIBGE (Código IBGE da Cidade)
CEP
CPF/CNPJ
IE
E-mail
Fone
Acesso através do caminho http://WCFDoCliente/api/v2/GeraVenda

Abaixo exemplo da estrutura de uma requisição ao WebService de geração de pedido de venda :
Requisição de Venda

{
"EmpresaInfo": {"CNPJ": "11.222.333/4444-55"},
"ClienteInfo": {
"CNPJ": "123.456.789-00",
"Codigo": "12345.1"
},
"Transp":{"Codigo":"220.8"},
"Produtos": [
{
"CodigProduto": 1.9,
"Quantidade": 1,
"PrecoVenda": 100.00,
"VlFinal": 100.00
},
{
"CodigProduto": 2.7,
"Quantidade": 2,
"PrecoVenda": 100.00,
"VlFinal": 200.00
}
],
"NumPedCliente": "058383XF",
"ValorFrete": 0.00,
"ValorProduto": 300.00,
"DescontoTotal": 0.00,
"ValorLiquido": 300.00,
"FormaPagamento": {
"Codigo": 403
},
"DadosPagamento": {
"NSU": "123456",
"Autorizacao": "987654",
"QtdParcelas": 3,
"ValorRecebido": 300.00,
"DataPagamento": "2020-06-16T15:45:00",
"Bandeira": "MASTERCARD",
"TipoVenda": "CREDITO",
"Banco": "",
"ContaCorrente": ""
}
"EnderecoEntrega": {
"Nome":"TESTE",
"Logradouro":"RUA ENTREGA",
"Numero":"NUM ENTREGA",
"Complemento":"COMP ENTREGA",
"Estado":"SP",
"Bairro":"BAIRRO",
"Cidade":"CAMPINAS",
"CidadeIBGE":3509502,
"CEP":"13013-160" ,
"CPF_CNPJ":"123.123.123-22" ,
"IE":"ISENTO",
"EMail":"teste@teste.com",
"Fone":"(19)3731-6900"
}
}

Status de Retorno com Sucesso
{
"NumeroPedido": "U3010001",
"StatusRetorno": "Pedido U3010001 gerado com sucesso."
}
Status de Retorno com Erro
{
"NumeroPedido": "",
"StatusRetorno": "ERRO: Código de Pagamento informado não cadastrado."
}
Qualquer erro retornado virá com o NumeroPedido em branco e o StatusRetorno iniciado com ERRO:
Sempre que o NumeroPedido estiver preenchido, o pedido foi gerado com sucesso.


Manual Técnico Integração Plansyst WebService - 07112022

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Manual Técnico Integração Plansyst WebService - 07112022

Enviado por

Direitos autorais:

Formatos disponíveis

Plansyst P12

1. Manual Técnico - Integração Plansyst via WebService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Disponibilização de dados específicos do sistema Plansyst para integração com E-Commerces.

Web Services disponíveis para integração :

Plansyst Consultoria e Informática LTDA - EPP

Título method Caminho

Integração - Geração de Pedido de Venda POST http://[URL]/api/v2/GeraVenda

Integração - Consulta de Produto(s) Específico(s) Com Foto PUT http://[URL]/api/v2/ProdutoFoto

Integração - Consulta de Produto(s) Específico(s) PUT http://[URL]/api/v2/Produto

Integração - Consulta de XML da NFE de Venda PUT http://[URL]/api/v2/RetornaXML

Integração - Consulta de Tipos de Pagamento PUT http://[URL]/api/v2/TipoPagamento

Integração - Consulta de Cliente POST/PUT http://[URL]/api/v2/Cliente

Integração - Consulta de Produtos por Data/Hora de alteração de Preço/Estoque PUT http://[URL]/api/v2/ListaProdutosMovHora

Integração - Consulta de Produtos por Data de Cadastro/Alteração PUT http://[URL]/api/v2/ProdutosDtCad

Integração - Cancela Pedido POST http://[URL]/api/v2/CancelaVenda

Plansyst Consultoria e Informática LTDA - EPP

Método disponível : POST

Requisição de XML de Venda

Plansyst Consultoria e Informática LTDA - EPP

Métodos disponíveis : POST e PUT

Campo Tamanho Observação

EmpresaInfo Objeto Informar CNPJ da Empresa com máscara

CPF_CNPJ 20 Informar CPF ou CNPJ com máscara

IE_RG 20 Informar RG ou IE com máscara

Pessoa 1 F (Física) ou J (Jurídica)

Estado 2 Informar UF (SP, MG, MA, etc)

CEP 10 Informar o CEP com máscara

Número 10 Número do Endereço do Cliente

Email 100 E-mail do Cliente para envio do XML

Exemplo do retorno de uma requisição ao WebService de cliente, contendo os dados retornados

Plansyst Consultoria e Informática LTDA - EPP

CPF/CNPJ informado existe CPF/CNPJ Informado não cadastrado

O WebService de "Dados de Clientes" deverá ser acessado através do caminho http://WCFDoCliente/api/v2/Cliente

Plansyst Consultoria e Informática LTDA - EPP

Consulta de Produto(s) Específico(s)

Método disponível : PUT

Abaixo exemplos de consultas utilizando o WebService:

Requisição por Código Requisição de Lista de Produtos

Requisição por Número de Fabricante Requisição por Lista de Produtos

Plansyst Consultoria e Informática LTDA - EPP

"Categoria": "CAMBIO | CAIXA DE CAMBIO | ANEIS"

Plansyst Consultoria e Informática LTDA - EPP

Plansyst Consultoria e Informática LTDA - EPP

Consulta de Produto(s) Específico(s)

Método disponível : PUT

Abaixo exemplos de consultas utilizando o WebService:

Requisição por Código Requisição de Lista de Produtos

Requisição por Número de Fabricante Requisição por Lista de Produtos

Plansyst Consultoria e Informática LTDA - EPP

Plansyst Consultoria e Informática LTDA - EPP

Consulta de Produtos por Data/Hora de alteração de Preço/Estoque

Método disponível : PUT

Abaixo exemplos de consultas utilizando o WebService:

Requisição por Código

Plansyst Consultoria e Informática LTDA - EPP

Plansyst Consultoria e Informática LTDA - EPP

Consulta de Produtos por Data de Cadastro/Alteração

Método disponível : PUT

Abaixo exemplos de consultas utilizando o WebService:

Requisição por Código

Plansyst Consultoria e Informática LTDA - EPP

Plansyst Consultoria e Informática LTDA - EPP

Consulta de Tipos de Pagamento