API - Sistema de Gestão Online

Documentação V2

Veja no GitHub

Bem-Vindo a nossa Documentação


Esta documentação mostrará como usar os vários recursos provenientes da API do Sistema Gestão Online, quais são os requisitos para usar esses recursos e alguns exemplos nas linguagens de programação mais usadas.

Na seção de introdução, apresentamos como obter a chave de acesso necessária para fazer as requisições, bem como usá-la.

Nas seções a seguir, mostramos os recursos disponíveis em nossa API, demonstrando como você pode testá-los usando o Postman e como implementar as solicitações em determinadas linguagens de programação.

Utilize o nosso email de contato para solicitar o envio da nossa collection do Postmam, para facilitar seu fluxo de desenvolvimento.

Nosso endpoint para todas as requisições:

https://api01.erpgestao.com.br/sistema/rest

Versão atual: v0.2.2

Início

Introdução

Nossas API utilizam o protocolo REST para receber as requisições, utilizando o modelo HTTP cujo método disponível é apenas o POST. Para solicitações que desejam receber dados do sistema, nossa API usa o formato JSON para recuperar os dados.

Autenticação

Para acessar os recursos da API, o usuário deve ter uma Chave. Essa chave pode ser adquirida facilmente entrando em contato com nossa equipe. Para isso, mande um email para [email protected] com o assunto "Integração API" e no corpo do email seu login de usuário na plataforma. Para dúvidas utilizar o mesmo email [email protected]

Estoque

Consultar Estoque

Este método é utilizado para obter o estoque atual de determinado produto ou variação, através do seu SKU.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
ProdutoReferencia Character(12) Código SKU ou Referência do Produto 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg93=gb",
"ProdutoReferencia": "123"
}





Então faça a requisição abaixo:

POST

/api_sgo/wsconsultaestoque 

Resposta:
{
"EstoqueAtual": "123"
}




ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo o erro ocorrido. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}



Consultar Estoque Geral (Data)

Este método é utilizado para obter o estoque atual de diversos produtos, por uma determinada Data.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
FilterCategoria Integer Id da Categoria
FilterEAN Character(13) Código EAN do produto
FilterSKU Character(20) Código SKU do produto
FilterMarca Integer Id da Marca
ProdutoTipo Integer Tipo Produto, opções: 1-Produto, 2-Serviço, 3-Matéria Prima, 4-Produto em Processo, 5-Embalagem
Data Date Data que deseja o estoque do produto
NumPag Integer Número de paginação 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"FilterCategoria": 0,
"FilterEAN": "1254021859741",
"FilterSKU": "",
"FilterMarca": 0,
"ProdutoTipo": 1,
"Data": "2021-07-30",
"NumPag": 1
}





Então faça a requisição abaixo:

POST

/api_sgo/wsconsultaprodutosdata 

				Resposta:
[
  {
"ProdutoCodigo": 427,
"ProdutoTipo": 1,
"ProdutoCodigoEAN": "000000",
"TGruposProdutosCodigo": 23,
"ProdutoDescricao": "Bolsa de Bebê Lisa",
"ProdutoUND": "UNID",
"NCM": "42022220",
"ProdutoValorCompra": 0.01,
"ProdutoPerLucro": 0,
"ProdutoValorVenda": 90.48,
"ProdutoPesoLiq": 333,
"ProdutoPesoBruto": 333,
"ProdutoAtivo": "S",
"ProdutoObs": "AZUL/PINK",
"ProdutoOcultarPDV": "",
"ProdutoEstoque": 39,
"ProdutoReferencia": "ABC15002-AZ-PK",
"ProdutoDescricaoCompleta": "Bolsa para bebê com alça",
"ProdutoComprimento": 37,
"ProdutoLargura": 16,
"TMarcasCodigo": 0,
"ProdutoURLVideo": "https://www.youtube.com/watch?",
"ProdutoRetiraLocal": "Nao",
"ProdutoNovoUsado": "new",
"ProdutoValorVendaECommerce": 0,
"ProdutoDescricaoGarantia": "",
"ProdutoFreteGratis": "1",
"ProdutoTagTitle": "",
"ProdutoMetaTagDescription": "",
"ProdutoMetaTagKeywords": "",
"ProdutoFornecedor": 0,
"ProdutoIdEcommerce": "",
"ProdutoImagem": [
{
"ProdutoImagemItem": 1,
"ProdutoImagem": "C:\\inetpub\\57ec28.jpg",
"ProdutoImagem_GXI": "http://www.softupsistemas.com.br"
},{
"ProdutoImagemItem": 2,
"ProdutoImagem": "C:\\inetpub\\86857ec28.jpg",
"ProdutoImagem_GXI": "http://www.softupsistemas.com.br"
}
],
"Variacoes": [
{
"ProdutoVariacao": 8,
"ProdutoVariacaoEstoque": 0,
"ProdutoVariacaoSKU": "ABC15002-AZ-PK-M"
},{
"ProdutoVariacao": 9,
"ProdutoVariacaoEstoque": 0,
"ProdutoVariacaoSKU": "ABC15002-AZ-PK-P"
}
],
"Atributos": [
{
"AtributoDescricao": "Alças",
"AtributoConteudo": "3"
},{
"AtributoDescricao": "Material",
"AtributoConteudo": "Couro"
}
   ]
  }
]




ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo o erro ocorrido. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}



Consultar Estoque (Data)

Este método é utilizado para obter o estoque atual de determinado produto ou variação, através do seu SKU em uma determinada Data.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
ProdutoReferencia Character(12) Código SKU ou Referência do Produto
Data Date Data que deseja o estoque do produto 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg93=gb",
"ProdutoReferencia": "123",
"Data": "2021/05/06 00:00:00"
}





Então faça a requisição abaixo:

POST

/api_sgo/wsconsultaestoquedata 

Resposta:
{
"EstoqueAtual": "123"
}




ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo o erro ocorrido. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}



Consultar Movimento Estoque (Kardex)

Este método é utilizado para obter a movimentação de estoque (kardex) do produto.

HEADER:

Content-Type: application/json

BODY:

>
Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
Seq_Apos Integer Valor inicial do intervalo do código sequencial do lançamento
Seq_Ate Integer Valor final do intervalo do código sequencial do lançamento
DtMov_Apos DateTime Data inicial do intervalo da data de vencimento
DtMov_Ate DateTime Data final do intervalo da data de vencimento
TipoMov Character(1) Define o tipo de movimentação do estoque "E" entrada ou "S" saída
ProdCod_Apos Integer Valor inicial do intervalo do código do produto
ProdCod_Ate Integer Valor final do intervalo do código do produto
NumPag Integer Numero da paginação 

{
"Chave": "98QSlqIS1mMJimRzzorTiQ==",
"Seq_Apos": 0,
"Seq_Ate"0,
"DtMov_Apos": "2023/06/06",
"DtMov_Ates": "2023/06/06",
"TipoMov": "",
"ProdCod_Apos": 0,
"ProdCod_Ate": 0,
"NumPag": 1
}





Então faça a requisição abaixo:

POST

/api_sgo/WSConsultaMovEstoque 

				Resposta:
[
  {
"TMovEstoqueId": 150602,
"ProdutoCodigo": 1,
"ProdutoDescricao": "Abdominal Articulado STRONG",
"ProdutoVariacao": 0,
"ProdutoVariacaoDescricao": "",
"TMovEstoqueData": "2023-06-06",
"TMovEstoqueHora": "07:13:26",
"TMovEstoqueTipoMov": "S"",
"TMovEstoqueQtd": 0.0000,
"TMovEstoqueDesc": "AJUSTE ESTOQUE",
"TMovEstoquePdv": 0,
"TMovEstoqueCodigo_OS": 0,
"TMovEstoqueDNT_NFSe": 0,
"TMovEstoqueAjusteEstoqueID": 1827,
"TMovEstoqueNfeNfCod": 0,
"TMovEstoqueNfeNotSer": " "
}
]




ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo o erro ocorrido. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Pessoas

Consultar Pessoas

Este método permite consultar as informações de uma determinada pessoa, através de seu CPF ou CNPJ.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
OrderReg Character(18) Tipos de Ordenação (opções abaixo)
FilterCPF Character(11) CPF, apenas números
FilterCNPJ Character(14) CNPJ, apenas números
NumPag Integer Número de paginação
TipoPessoa Character(1) Informar C para listar somente Clientes, F para listar somente Fornecedores, V para listar somente Vendedores, T para listar somente Transportadoras
PessoaCodigo Integer Código (Id) Pessoa
DataUltAltInicial Character(10) Data da última alteração do registro de pessoas inicial
DataUltAltFinal Character(10) Data da última alteração do registro de pessoas final 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg93=gb",
"OrderReg": "PessoaCodigo",
"FilterCPF": "12312312312",
"FilterCNPJ": "",
"NumPag": 1,
"TipoPessoa": "",
"PessoaCodigo": 0,
"DataUltAltInicial": "2023-10-13",
"DataUltAltFinal": "2023-10-13"
}


OrderReg opções:


Então faça a requisição abaixo:

POST

/api_sgo/wsconsultapessoas



PessoaCodigo: Id da pessoa no sistema
PessoaTipo: Tipo de pessoa (física ou jurídica)
PessoaCNPJ: CNPJ, apenas números
PessoaIE: Inscrição Estadual
PessoaCPF: CPF, apenas números
PessoaRG: Registro Geral da pessoa
PessoaRazaoSocial: Razão Social da pessoa
PessoaNomeFantasia: Nome fantasia da pessoa
PessoaCEP: Código Postal
PessoaLogradouro: Nome da Rua
PessoaNumero: Número do endereço
PessoaComplemento: Complemento do endereço
PessoaBairro: Bairro
PessoaNomeMunicipio: Cidade
EstadoUF: Estado
PessoaCodigoMunicipio: Código Município
PessoaCodigoPais: Código País
PessoaNomePais: Nome do País
PessoaDDDFone: Telefone
PessoaCelular: Celular
PessoaSUFRAMA: Código SUFRAMA
PessoasSite: Site
PessoaEmail: Email
PessoaCliente: Cadastrado como Cliente
PessoaFornecedor: Cadastrado como fornecedor
PessoaVendedor: Cadastrado como vendedor
PessoaTransportador: Cadastrado como Transportador
PessoaOBS: Observações
PessoaCEPEntrega: Código Postal para entrega
PessoaLogradouroEntrega: Rua para entrega
PessoaNumeroEntrega: Número para entrega
PessoaComplementoEntrega: Complemento para entrega
PessoaBairroEntrega: Bairro para entrega
PessoaNomeMunicipioEntrega: Cidade para entrega
PessoaEstadoUFEntrega: Estado para entrega
PessoaCEPCobranca: Código Postal para cobrança
PessoaLogradouroCobranca: Rua para cobrança
PessoaNumeroCobranca: Número para cobrança
PessoaComplementoCobranca: Complemento para cobrança
PessoaBairroCobranca: Bairro para cobrança
PessoaNomeMunicipioCobranca: Cidade para cobrança
PessoaEstadoUFCobranca: Estado para cobrança
PessoaVendedorComissao: Comissão de vendas
PessoaAtivo: Se a pessoa está ativa no sistema (S ou N)
PessoaLimiteCredito: Valor do limite de crédito indicado no cadastro
PessoaDataUltAlt: Data da ultima alteração ocorrida no cadastro 


				Resposta:
[
  {
"PessoaCodigo":1640,
"PessoaTipo":"Física ",
"PessoaCNPJ":" ",
"PessoaIE":" ",
"PessoaCPF":"12312312312",
"PessoaRG":" ",
"PessoaRazaoSocial":"Fulano de tal",
"PessoaNomeFantasia":"Fulano de tal",
"PessoaCEP":12345678,
"PessoaLogradouro":"Rua dos Jardins",
"PessoaNumero":"400 ",
"PessoaComplemento":"casa",
"PessoaBairro":"Nova Morada",
"PessoaNomeMunicipio":"São Paulo",
"EstadoUF":"SP",
"PessoaCodigoMunicipio":3516200,
"PessoaCodigoPais":1058,
"PessoaNomePais":"BRASIL",
"PessoaDDDFone":11990000000,
"PessoaCelular":11990000000,
"PessoaSUFRAMA":" ",
"PessoasSite":"",
"PessoaEmail":"[email protected]",
"PessoaCliente":"S",
"PessoaFornecedor":"N",
"PessoaVendedor":"N",
"PessoaTransportador":"N",
"PessoaOBS":"",
"PessoaCEPEntrega":0,
"PessoaLogradouroEntrega":"",
"PessoaNumeroEntrega":"",
"PessoaComplementoEntrega":"",
"PessoaBairroEntrega":"",
"PessoaNomeMunicipioEntrega":"",
"PessoaEstadoUFEntrega":"",
"PessoaCEPCobranca":0,
"PessoaLogradouroCobranca":"",
"PessoaNumeroCobranca":"",
"PessoaComplementoCobranca":"",
"PessoaBairroCobranca":"",
"PessoaNomeMunicipioCobranca":"",
"PessoaEstadoUFCobranca":"",
"PessoaVendedorComissao":0,
"PessoaAtivo":"S",
"PessoaLimiteCredito":0,00,
"PessoaDataUltAlt":"21/11/2023"
  }
]{}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Criar Pessoas

Este método permite cadastrar determinada pessoa, com todas as suas informações.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Pessoas_SDT Object JSON com as informações da pessoa


Pessoas_SDT:

Chave: Chave de acesso obtida pelo cliente
Pessoa: Objeto com dados da pessoa

Pessoa:

PessoaTipo: Física ou Jurídica
PessoaCNPJ: CNPJ em caso de Pessoa Jurídica
PessoaIE: Inscrição Estadual
PessoaRG: Registro Geral da Pessoa
PessoaRazaoSocial: Razão Social da Pessoa
PessoaNomeFantasia: Nome Fantasia da Pessoa
PessoaCPF: CPF em caso de Pessoa Física
PessoaCelular: Celular da Pessoa
PessoaCEP: Código Postal da Pessoa
PessoaLogradouro: Logradouro referente ao endereço da Pessoa
PessoaNumero: Número referente ao endereço da Pessoa
PessoaComplemento: Complemento referente ao endereço da Pessoa
PessoaBairro: Bairro referente ao endereço da Pessoa
PessoaNomeMunicipio: Cidade referente ao endereço da Pessoa
EstadoUF: UF do Estado referente ao endereço da Pessoa
PessoaNomePais: País referente ao endereço da Pessoa
PessoaDDDFone: Telefone de contato da Pessoa
PessoasSite: Endereço eletrônico do site da Pessoa
PessoaEmail: Email da Pessoa
PessoaCliente: Flag para marcar se a pessoa é um CLIENTE
PessoaOBS: Campo para observações da Pessoa
PessoaTransportador: Flag para marcar se a pessoa é uma TRANSPORTADORA
PessoaVendedor: Flag para marcar se a pessoa é um VENDEDOR
PessoaFornecedor: Flag para marcar se a pessoa é um FORNECEDOR
PessoaCodigoPais: Código do pais, para Brasil informar "1058"
PessoaDataNasc: Data de nascimento do cliente, informar no padrão ano/mês/dia "1979/12/21" 

				{
"Pessoas_SDT":{
"Chave":"asdaafa85a1asf1a8s9f1as9",
"Pessoa":{
"PessoaTipo":"Física",
"PessoaCNPJ":"",
"PessoaIE":"",
"PessoaRG":" ",
"PessoaRazaoSocial":"Fulano de tal",
"PessoaNomeFantasia":"Fulano de tal",
"PessoaCPF":"12312312312",
"PessoaCelular":11990000000,
"PessoaCEP":12345678,
"PessoaLogradouro":"Rua dos Jardins",
"PessoaNumero":"400 ",
"PessoaComplemento":"casa",
"PessoaBairro":"Nova Morada",
"PessoaNomeMunicipio":"São Paulo",
"EstadoUF":"SP",
"PessoaNomePais":"BRASIL",
"PessoaDDDFone":11990000000,
"PessoasSite":"",
"PessoaEmail":"[email protected]",
"PessoaCliente":"S",
"PessoaOBS":"",
"PessoaTransportador":"N",
"PessoaVendedor":"N",
"PessoaFornecedor":"N",
"PessoaCodigoPais":"1058",
"PessoaDataNasc":"1979/12/21"
  }
}}


Então faça a requisição abaixo:

POST

/api_sgo/wscriapessoa 

				Resposta:
{
   "Response":{
      "success":true,
      "message":"47"//<- Id da Pessoa no sistema
  }
}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Atualiza Pessoas

Este método permite atualizar as informações de determinada pessoa.

Esse método utiliza os campos PessoaCPF ou PessoaCNPJ para buscar na base de dados e efetuar a mdificação dos outros campos.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Pessoas_SDT Object JSON com as informações da pessoa


Pessoas_SDT:

Chave: Chave de acesso obtida pelo cliente
Pessoa: Objeto com dados da pessoa

Pessoa:

PessoaTipo: Física ou Jurídica
PessoaCNPJ: CNPJ em caso de Pessoa Jurídica
PessoaIE: Inscrição Estadual
PessoaRG: Registro Geral da Pessoa
PessoaRazaoSocial: Razão Social da Pessoa
PessoaNomeFantasia: Nome Fantasia da Pessoa
PessoaCPF: CPF em caso de Pessoa Física
PessoaCelular: Celular da Pessoa
PessoaCEP: Código Postal da Pessoa
PessoaLogradouro: Logradouro referente ao endereço da Pessoa
PessoaNumero: Número referente ao endereço da Pessoa
PessoaComplemento: Complemento referente ao endereço da Pessoa
PessoaBairro: Bairro referente ao endereço da Pessoa
PessoaNomeMunicipio: Cidade referente ao endereço da Pessoa
EstadoUF: UF do Estado referente ao endereço da Pessoa
PessoaNomePais: País referente ao endereço da Pessoa
PessoaDDDFone: Telefone de contato da Pessoa
PessoasSite: Endereço eletrônico do site da Pessoa
PessoaEmail: Email da Pessoa
PessoaCliente: Flag para marcar se a pessoa é um CLIENTE
PessoaOBS: Campo para observações da Pessoa
PessoaTransportador: Flag para marcar se a pessoa é uma TRANSPORTADORA
PessoaVendedor: Flag para marcar se a pessoa é um VENDEDOR
PessoaFornecedor: Flag para marcar se a pessoa é um FORNECEDOR 


				{
"Pessoas_SDT":{
"Chave":"asdaafa85a1asf1a8s9f1as9",
"Pessoa":{
"PessoaTipo":"Física",
"PessoaCNPJ":"",
"PessoaIE":"",
"PessoaRG":" ",
"PessoaRazaoSocial":"Fulano de tal",
"PessoaNomeFantasia":"Fulano de tal",
"PessoaCPF":"12312312312",
"PessoaCelular":11990000000,
"PessoaCEP":12345678,
"PessoaLogradouro":"Rua dos Jardins",
"PessoaNumero":"400 ",
"PessoaComplemento":"casa",
"PessoaBairro":"Nova Morada",
"PessoaNomeMunicipio":"São Paulo",
"EstadoUF":"SP",
"PessoaNomePais":"BRASIL",
"PessoaDDDFone":11990000000,
"PessoasSite":"",
"PessoaEmail":"[email protected]",
"PessoaCliente":"S",
"PessoaOBS":"",
"PessoaTransportador":"N",
"PessoaVendedor":"N",
"PessoaFornecedor":"N"
  }
}}


Então faça a requisição abaixo:

POST

/api_sgo/wsatualizapessoa 

				Resposta:
{
   "Response":{
      "success":true,
      "message":"47"//<- Id da Pessoa no sistema
  }
}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Produtos

Consultar Categorias

Este método permite consultar todas as Categorias cadastradas na conta do cliente.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
OrderReg Character(50) Ordenação dos registros
DataAlteracaoApos Date Filtro inicial de data de alteração da categoria
DataAlteracaoAte Date Filtro final de data de alteração da categoria
NumPag Integer Número de paginação 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"OrderReg": "DataUltAlt",
"DataAlteracaoApos": "2020-10-04",
"DataAlteracaoAte": "2020-10-05",
"NumPag": 1
}


Então faça a requisição abaixo:

POST

/api_sgo/wsconsultacategorias



TGruposProdutosCodigo: Id da Categoria
TGruposProdutosDescricao: Nome da Categoria
TGruposProdutosCodigoPai: ID da Categoria Pai
TGruposProdutosImagem: Imagem da Categoria
TGruposProdutosImagem_GXI: Ícone da Categoria 


				Resposta:
[
  {
"TGruposProdutosCodigo":8,
"TGruposProdutosDescricao":"Categoria Principal ",
"TGruposProdutosCodigoPai":0,
"TGruposProdutosImagem":" ",
"TGruposProdutosImagem_GXI":" "
  }
]{}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Cria Categorias

Este método permite criar categorias de produtos, com todas as suas informações.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
itemGrupos Object JSON com as informações da categoria


itemGrupos:

Chave: Chave de acesso obtida pelo cliente
Grupo: Objeto com dados da categoria

Grupo:

TGruposProdutosDescricao: Descrição da Categoria
TGruposProdutosCodigoPai: Código da Categoria Pai


 

				{
"itemGrupos":{
"Chave":"asdaafa85a1asf1a8s9f1as9",
"Grupo":[{
"TGruposProdutosDescricao":"Categoria teste",
"TGruposProdutosCodigoPai":2
  }]
}}


Então faça a requisição abaixo:

POST

/api_sgo/wscriacategoria 

				Resposta:
{
   "SDTCriaGruposResponse":[{
      "GrupoCodigo":15,
      "TGruposProdutosDescricao":"Categoria teste",
      "TGruposProdutosCodigoPai":2
  }]
}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Atualiza Categorias

Este método permite atualizar categorias de produtos, com todas as suas informações.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
itemGrupoAtualiza Object JSON com as informações da categoria


itemGrupoAtualiza:

Chave: Chave de acesso obtida pelo cliente
Grupos: Objeto com dados da categoria

Grupos:

GrupoCodigo: Código da Categoria
TGruposProdutosDescricao: Descrição da Categoria
TGruposProdutosCodigoPai: Código da Categoria Pai


 

				{
"itemGrupoAtualiza":{
"Chave":"asdaafa85a1asf1a8s9f1as9",
"Grupos":[{
"TGruposProdutosDescricao":"Categoria teste",
"TGruposProdutosCodigoPai":2
  }]
}}


Então faça a requisição abaixo:

POST

/api_sgo/wsatualizacategorias 

				Resposta:
{
   "SDTCriaGruposResponse":[{
      "GrupoCodigo":15,
      "TGruposProdutosDescricao":"Categoria teste",
      "TGruposProdutosCodigoPai":2
  }]
}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Deleta Categorias

Este método permite deletar categorias de produtos, com todas as suas informações.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
itemGrupoDeleta Object JSON com as informações da categoria


itemGrupoDeleta:

Chave: Chave de acesso obtida pelo cliente
Grupos: Objeto com dados da categoria

Grupos:

GrupoCodigo: Código da Categoria
TGruposProdutosDescricao: Descrição da Categoria
TGruposProdutosCodigoPai: Código da Categoria Pai


 

				{
"itemGrupoDeleta":{
"Chave":"asdaafa85a1asf1a8s9f1as9",
"Grupos":[{
"TGruposProdutosDescricao":"Categoria teste",
"TGruposProdutosCodigoPai":2
  }]
}}


Então faça a requisição abaixo:

POST

/api_sgo/wsdeletacategorias 

				Resposta:
{
   "SDTCriaGruposResponse":[{
      "GrupoCodigo":15,
      "TGruposProdutosDescricao":"Categoria teste",
      "TGruposProdutosCodigoPai":2
  }]
}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Consultar Marcas

Este método permite consultar todas as Marcas cadastradas na conta do cliente.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
NumPag Integer Número de paginação 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"NumPag": 1
}


Então faça a requisição abaixo:

POST

/api_sgo/wsconsultamarcas



TMarcasCodigo: Id da Marca
TMarcasDescricao: Nome da Marca 


				Resposta:
[
  {
"TMarcasCodigo": 1,
"TMarcasDescricao": "GESTÃO ONLINE"
  }
]{}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Consultar Produtos

Este método permite consultar as informações de determinado produto, através do código EAN ou SKU, permitindo filtrar por Categoria ou Marca.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
OrderReg Character(18) Tipos de Ordenação (opções abaixo)
FilterCategoria Integer Id da Categoria
FilterEAN Character(13) Código EAN do produto
FilterSKU Character(20) Código SKU do produto
FilterMarca Integer Id da Marca
DataAlteracaoApos DateTime Data inicial do intervalo da data de alteração do produto
DataAlteracaoAte DateTime Data final do intervalo da data de alteração do produto
ProdutoTipo Integer Tipo Produto, opções: 1-Produto, 2-Serviço, 3-Matéria Prima, 4-Produto em Processo, 5-Embalagem
NumPag Integer Número de paginação 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"OrderReg": "ProdutoCodigo",
"FilterCategoria": 0,
"FilterEAN": "1254021859741",
"FilterSKU": "",
"FilterMarca": 0,
"DataAlteracaoApos": "2019/01/01 00:00:00",
"DataAlteracaoAte": "2025/12/31 23:59:59",
"ProdutoTipo": 1,
"NumPag": 1
}


OrderReg opções:


Então faça a requisição abaixo:

POST

/api_sgo/wsconsultaprodutos



ProdutoCodigo: Id do produto
ProdutoTipo: Tipo do produto
ProdutoCodigoEAN: EAN do produto
TGruposProdutosCodigo: Id da Categoria
ProdutoDescricao: Nome do produto
ProdutoUND: Unidade do produto
NCM: NCM do produto
ProdutoValorCompra: Valor de compra do produto
ProdutoPerLucro: Porcentagem de lucro sobre o produto
ProdutoValorVenda: Valor de venda do produto
ProdutoPesoLiq: Peso líquido do produto
ProdutoPesoBruto: Peso bruto do produto
ProdutoAtivo: Status de ativo do produto
ProdutoObs: Observações do produto
ProdutoOcultarPDV: Valor 1 caso este produto deve aparecer no PDV
ProdutoEstoque: Quantidade em estoque do produto
ProdutoReferencia: SKU do produto
ProdutoMLTitAnuncio: Titulo do anuncio ML
ProdutoDescricaoCompleta: Descrição completa do produto
ProdutoComprimento: Comprimento do produto
ProdutoLargura: Largura do produto
ProdutoAltura: Altura do produto
TMarcasCodigo: Id da Marca
ProdutoURLVideo: URL do vídeo do produto
ProdutoRetiraLocal: Retirada no local
ProdutoNovoUsado: Estado do produto (Novo ou Usado)
ProdutoValorVendaECommerce: Valor de venda em Ecommerce
ProdutoDescricaoGarantia: Descrição da garantia
ProdutoFreteGratis: Frete Grátis (0 - não 1 - sim)
ProdutoTagTitle: meta tag título do produto
ProdutoMetaTagDescription: meta tag descrição
ProdutoMetaTagKeywords: meta tag palavras-chave
ProdutoFornecedor: Id do Fornecedor
ProdutoIdEcommerce: Id externo do produto
ProdutoImagemItem: Id da imagem
ProdutoImagem: URL da imagem do produto
ProdutoImagem_GXI: URL do objeto da imagem
ProdutoVariacao: Id da Variação
ProdutoVariacaoEstoque: Quantidade em estoque da variação
ProdutoVariacaoSKU: SKU da variação
ProdutoVariacaoImg1: URL da imagem da variação do produto
ProdutoVariacaoImg1_GXI: URL do objeto da variação da imagem
ProdutoVariacaoImg2: URL da imagem da variação do produto
ProdutoVariacaoImg2_GXI: URL do objeto da variação da imagem
ProdutoVariacaoImg3: URL da imagem da variação do produto
ProdutoVariacaoImg3_GXI: URL do objeto da variação da imagem
ProdutoVariacaoImg4: URL da imagem da variação do produto
ProdutoVariacaoImg4_GXI: URL do objeto da variação da imagem
ProdutoVariacaoImg5: URL da imagem da variação do produto
ProdutoVariacaoImg5_GXI: URL do objeto da variação da imagem
AtributoDescricao: Descrição do Atributo
AtributoConteudo: Conteúdo do Atributo 


				Resposta:
[
  {
"ProdutoCodigo": 427,
"ProdutoTipo": 1,
"ProdutoCodigoEAN": "000000",
"TGruposProdutosCodigo": 23,
"ProdutoDescricao": "Bolsa de Bebê Lisa",
"ProdutoUND": "UNID",
"NCM": "42022220",
"ProdutoValorCompra": 0.01,
"ProdutoPerLucro": 0,
"ProdutoValorVenda": 90.48,
"ProdutoPesoLiq": 333,
"ProdutoPesoBruto": 333,
"ProdutoAtivo": "S",
"ProdutoObs": "AZUL/PINK",
"ProdutoOcultarPDV": "",
"ProdutoEstoque": 39,
"ProdutoReferencia": "ABC15002-AZ-PK",
"ProdutoMLTitAnuncio":"Sapato Masculino Anti Stress",
"ProdutoDescricaoCompleta": "Bolsa para bebê com alça",
"ProdutoComprimento": 37,
"ProdutoLargura": 16,
"TMarcasCodigo": 0,
"ProdutoURLVideo": "https://www.youtube.com/watch?",
"ProdutoRetiraLocal": "Nao",
"ProdutoNovoUsado": "new",
"ProdutoValorVendaECommerce": 0,
"ProdutoDescricaoGarantia": "",
"ProdutoFreteGratis": "1",
"ProdutoTagTitle": "",
"ProdutoMetaTagDescription": "",
"ProdutoMetaTagKeywords": "",
"ProdutoFornecedor": 0,
"ProdutoIdEcommerce": "",
"ProdutoImagem": [
{
"ProdutoImagemItem": 1,
"ProdutoImagem": "C:\\inetpub\\57ec28.jpg",
"ProdutoImagem_GXI": "http://www.softupsistemas.com.br"
},{
"ProdutoImagemItem": 2,
"ProdutoImagem": "C:\\inetpub\\86857ec28.jpg",
"ProdutoImagem_GXI": "http://www.softupsistemas.com.br"
}
],
"Variacoes": [
{
"ProdutoVariacao": 8,
"ProdutoVariacaoEstoque": 0,
"ProdutoVariacaoSKU": "ABC15002-AZ-PK-M"
"ProdutoVariacaoImg1":"C:\\inetpub\\57ec28.jpg",
"ProdutoVariacaoImg1_GXI":"http://www.softupsistemas.com",
"ProdutoVariacaoImg2":"C:\\inetpub\\57ec28.jpg",
"ProdutoVariacaoImg2_GXI":"http://www.softupsistemas.com",
"ProdutoVariacaoImg3":"C:\\inetpub\\57ec28.jpg",
"ProdutoVariacaoImg3_GXI":"http://www.softupsistemas.com",
"ProdutoVariacaoImg4":"C:\\inetpub\\57ec28.jpg",
"ProdutoVariacaoImg4_GXI":"http://www.softupsistemas.com",
"ProdutoVariacaoImg5":"C:\\inetpub\\57ec28.jpg",
"ProdutoVariacaoImg5_GXI":"http://www.softupsistemas.com",
},{
"ProdutoVariacao": 9,
"ProdutoVariacaoEstoque": 0,
"ProdutoVariacaoSKU": "ABC15002-AZ-PK-P"
"ProdutoVariacaoImg1":"C:\\inetpub\\57ec28.jpg",
"ProdutoVariacaoImg1_GXI":"http://www.softupsistemas.com",
"ProdutoVariacaoImg2":"C:\\inetpub\\57ec28.jpg",
"ProdutoVariacaoImg2_GXI":"http://www.softupsistemas.com",
"ProdutoVariacaoImg3":"C:\\inetpub\\57ec28.jpg",
"ProdutoVariacaoImg3_GXI":"http://www.softupsistemas.com",
"ProdutoVariacaoImg4":"C:\\inetpub\\57ec28.jpg",
"ProdutoVariacaoImg4_GXI":"http://www.softupsistemas.com",
"ProdutoVariacaoImg5":"C:\\inetpub\\57ec28.jpg",
"ProdutoVariacaoImg5_GXI":"http://www.softupsistemas.com",
}
],
"Atributos": [
{
"AtributoDescricao": "Alças",
"AtributoConteudo": "3"
},{
"AtributoDescricao": "Material",
"AtributoConteudo": "Couro"
}
   ]
  }
]

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Consultar Variações

Este método permite consultar todas as Variações de um determinado produto.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
ProdutoReferencia Character(20) SKU do produto 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg3=gb",
"ProdutoReferencia": "ABC15002-AZ-PK"
}


Então faça a requisição abaixo:

POST

/api_sgo/wsconsultavariacoes



ProdutoVariacaoEstoque: Quantidade em estoque da variação
ProdutoVariacaoDescricao: Nome da Variação
ProdutoVariacaoNome: Identificação da variação
ProdutoVariacaoSKU: SKU da Variação
ProdutoVariacao: Id da Variação 


				Resposta:
[
  {
"ProdutoVariacaoEstoque": 8,
"ProdutoVariacaoDescricao": "P":,
"ProdutoVariacaoNome": "",
"ProdutoVariacaoSKU": "ABC15002-AZ-PK-P",
"ProdutoVariacao": 9
  }
]{}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Consultar Unidades

Este método permite consultar todas as Unidades cadastradas no sistema.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
NumPag Integer Número de paginação 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg3=gb",
"NumPag": 1
}


Então faça a requisição abaixo:

POST

/api_sgo/wsconsultaunidades



TUnidade: Sigla Unidade de Medida
TUnidadeDescricao: Descrição da Unidade 


				Resposta:
[
  {
"TUnidade": "M2",
"TUnidadeDescricao": "METRO QUADRADO":
  }
]

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Cria Produtos

Este método permite criar um Produto com todas as suas informações básicas.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
ItemProdutos Object Estrutura de dados com as informações do produto


ItemProdutos:

Chave: Chave de acesso obtida pelo cliente
Produto: Coleção de objetos com dados do produto

Produto:

ProdutoTipo: Tipo do produto
ProdutoCodigoEAN: Cód. de Barras do produto
TGruposProdutosCodigo: Id da Categoria do produto
ProdutoDescricao: Nome do produto
ProdutoUND: Unidade do produto
NCM: NCM do produto
ProdutoValorCompra: Valor de Compra do produto
ProdutoPerLucro: Per Lucro do Produto
ProdutoValorVenda: Valor de Venda do produto
ProdutoPesoLiq: Peso Líquido do produto
ProdutoPesoBruto: Peso Bruto do produto
ProdutoAtivo: Flag para produto ativo
ProdutoObs: Observação do produto
ProdutoImagemUltItem: Último Id cadastrado nas imagens do produto
ProdutoOcultarPDV: Flag para ocultar produto no frente de caixa
ProdutoReferencia: Referência/SKU do produto
ProdutoDescricaoCompleta: Descrição completa do produto
ProdutoComprimento: Comprimento do produto (m)
ProdutoLargura: Largura do produto (m)
ProdutoAltura: Altura do produto (m)
TMarcasCodigo: Id da marca do produto
ProdutoURLVideo: Url de vídeo publicado do produto
ProdutoRetiraLocal: Flag para determinar se produto pode ser retirado no local
ProdutoNovoUsado: Flag para marcar condição do produto
ProdutoValorVendaECommerce: Valor de Venda do produto na loja virtual
ProdutoDescricaoGarantia: Descrição da garantia do produto
ProdutoFreteGratis: Flag para marcar se produto pode ser vendido com frete grátis
ProdutoTagTitle: Title Meta Tag do produto
ProdutoMetaTagDescription: Description Meta Tag do produto
ProdutoMetaTagKeywords: Keywords Meta Tag do produto
ProdutoFornecedor: Id do Fornecedor do produto
ProdutoIdEcommerce: Id externo do produto
ProdutoImagemItem: Id da Imagem do produto
ProdutoImagem: URL da Imagem do produto
ProdutoVariacao: Id da Variação
ProdutoVariacaoSKU: SKU da Variação
ProdutoVariacaoInt: Campo livre
ProdutoVariacaoInt2: Campo livre
TDepositoEstoqueDescricao: Descrição da Variação
TDepositoEstoquePadrao: Flag para marcar Variação Padrão
TDepositoEstoqueNome: Nome da Variação
TDepositoEstoqueCor: Cor da Variação
TDepositoEstoqueIntegracaoLojaID: Código da Loja Virtual
TDepositoEstoqueIntegracaoIntID: Id da Loja Virtual
AtributoDescricao: Descrição do Atributo
AtributoConteudo: Conteúdo do Atributo

ProdutoTipo:
1: Produto
2: Serviço

ProdutoAtivo:
S: Ativo
N: Inativo

ProdutoNovoUsado:
new: Novo
used: Usado

ProdutoFreteGratis:
1: Não
2: Sim 

			{
"ItemProdutos": {
"Chave":"asdsa1aas919a1a0scasfa",
"Produto": [{
"ProdutoTipo": 1,
"ProdutoCodigoEAN": "000000",
"TGruposProdutosCodigo": 23,
"ProdutoDescricao": "Bolsa de Bebê Lisa",
"ProdutoUND": "UNID",
"NCM": "42022220",
"ProdutoValorCompra": 0.01,
"ProdutoPerLucro": 0,
"ProdutoValorVenda": 90.48,
"ProdutoPesoLiq": 333,
"ProdutoPesoBruto": 333,
"ProdutoAtivo": "S",
"ProdutoObs": "AZUL/PINK",
"ProdutoImagemUltItem": 1,
"ProdutoOcultarPDV": "",
"ProdutoReferencia": "ABC15002-AZ-PK",
"ProdutoDescricaoCompleta": "Bolsa para bebê com alça",
"ProdutoComprimento": 0.37,
"ProdutoLargura": 0.16,
"ProdutoAltura": 0.4,
"TMarcasCodigo": 0,
"ProdutoURLVideo": "https://www.youtube.com/watch?",
"ProdutoRetiraLocal": "Nao",
"ProdutoNovoUsado": "new",
"ProdutoValorVendaECommerce": 0,
"ProdutoDescricaoGarantia": "",
"ProdutoFreteGratis": "1",
"ProdutoTagTitle": "",
"ProdutoMetaTagDescription": "",
"ProdutoMetaTagKeywords": "",
"ProdutoFornecedor": 0,
"ProdutoIdEcommerce": "",
"ProdutoImagem": [
{
"ProdutoImagemItem": 1,
"ProdutoImagem": "C:\\inetpub\\57ec28.jpg"},
{
"ProdutoImagemItem": 1,
"ProdutoImagem": "C:\\inetpub\\86857ec28.jpg"}
],
"Variacoes": [
{
"ProdutoVariacao": 9,
"ProdutoVariacaoSKU": "ABC15002-AZ-PK-P",
"ProdutoVariacaoInt": "",
"ProdutoVariacaoInt2": "",
"TDepositoEstoqueDescricao": "G",
"TDepositoEstoquePadrao": "N",
"TDepositoEstoqueNome": "TAMANHO",
"TDepositoEstoqueCor": "Preto",
"TDepositoEstoqueIntegracao": [
{
"TDepositoEstoqueIntegracaoLojaID": "5",
"TDepositoEstoqueIntegracaoIntID": "87421036"}
],
}],
"Atributos": [
{
"AtributoDescricao": "Alças",
"AtributoConteudo": "3"},
{
"AtributoDescricao": "Material",
"AtributoConteudo": "Couro"}
   ]
  }
]


Então faça a requisição abaixo:

POST

/api_sgo/wscriaprodutos 



Resposta:
{
"SDTCriaProdutosResponse": [{
   "ProdutoCodigo": 231
  }
]}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Atualiza Produtos

Este método permite atualizar um Produto com todas as suas informações básicas.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
ItemProdutosUPD Object Estrutura de dados com as informações do produto


ItemProdutosUPD:

Chave: Chave de acesso obtida pelo cliente
ProdutoCodigo: Código do produto no sistema
ProdutoTipo: Tipo do produto
ProdutoCodigoEAN: Cód. de Barras do produto
TGruposProdutosCodigo: Id da Categoria do produto
ProdutoDescricao: Nome do produto
ProdutoUND: Unidade do produto
NCM: NCM do produto
ProdutoValorCompra: Valor de Compra do produto
ProdutoPerLucro: Per Lucro do Produto
ProdutoValorVenda: Valor de Venda do produto
ProdutoPesoLiq: Peso Líquido do produto
ProdutoPesoBruto: Peso Bruto do produto
ProdutoAtivo: Flag para produto ativo
ProdutoObs: Observação do produto
ProdutoImagemUltItem: Último Id cadastrado nas imagens do produto
ProdutoOcultarPDV: Flag para ocultar produto no frente de caixa
ProdutoReferencia: Referência/SKU do produto
ProdutoDescricaoCompleta: Descrição completa do produto
ProdutoComprimento: Comprimento do produto (m)
ProdutoLargura: Largura do produto (m)
ProdutoAltura: Altura do produto (m)
TMarcasCodigo: Id da marca do produto
ProdutoURLVideo: Url de vídeo publicado do produto
ProdutoRetiraLocal: Flag para determinar se produto pode ser retirado no local
ProdutoNovoUsado: Flag para marcar condição do produto
ProdutoValorVendaECommerce: Valor de Venda do produto na loja virtual
ProdutoDescricaoGarantia: Descrição da garantia do produto
ProdutoFreteGratis: Flag para marcar se produto pode ser vendido com frete grátis
ProdutoTagTitle: Title Meta Tag do produto
ProdutoMetaTagDescription: Description Meta Tag do produto
ProdutoMetaTagKeywords: Keywords Meta Tag do produto
ProdutoFornecedor: Id do Fornecedor do produto
ProdutoIdEcommerce: Id externo do produto
ProdutoImagemItem: Id da Imagem do produto
ProdutoImagem: URL da Imagem do produto
ProdutoVariacao: Id da Variação
ProdutoVariacaoSKU: SKU da Variação
ProdutoVariacaoInt: Campo livre
ProdutoVariacaoInt2: Campo livre
TDepositoEstoqueDescricao: Descrição da Variação
TDepositoEstoquePadrao: Flag para marcar Variação Padrão
TDepositoEstoqueNome: Nome da Variação
TDepositoEstoqueIntegracaoLojaID: Código da Loja Virtual
TDepositoEstoqueIntegracaoIntID: Id da Loja Virtual
AtributoDescricao: Descrição do Atributo
AtributoConteudo: Conteúdo do Atributo 

			{
"ItemProdutosUPD": {
"Chave":"asdsa1aas919a1a0scasfa",
"ProdutoCodigo": 16,
"ProdutoTipo": 1,
"ProdutoCodigoEAN": "000000",
"TGruposProdutosCodigo": 23,
"ProdutoDescricao": "Bolsa de Bebê Lisa",
"ProdutoUND": "UNID",
"NCM": "42022220",
"ProdutoValorCompra": 0.01,
"ProdutoPerLucro": 0,
"ProdutoValorVenda": 90.48,
"ProdutoPesoLiq": 333,
"ProdutoPesoBruto": 333,
"ProdutoAtivo": "S",
"ProdutoObs": "AZUL/PINK",
"ProdutoImagemUltItem": 1,
"ProdutoOcultarPDV": "",
"ProdutoReferencia": "ABC15002-AZ-PK",
"ProdutoDescricaoCompleta": "Bolsa para bebê com alça",
"ProdutoComprimento": 0.37,
"ProdutoLargura": 0.16,
"ProdutoAltura": 0.4,
"TMarcasCodigo": 0,
"ProdutoURLVideo": "https://www.youtube.com/watch?",
"ProdutoRetiraLocal": "Nao",
"ProdutoNovoUsado": "new",
"ProdutoValorVendaECommerce": 0,
"ProdutoDescricaoGarantia": "",
"ProdutoFreteGratis": "1",
"ProdutoTagTitle": "",
"ProdutoMetaTagDescription": "",
"ProdutoMetaTagKeywords": "",
"ProdutoFornecedor": 0,
"ProdutoIdEcommerce": "",
"ProdutoImagem": [
{
"ProdutoImagemItem": 1,
"ProdutoImagem": "C:\\inetpub\\57ec28.jpg"},
{
"ProdutoImagemItem": 1,
"ProdutoImagem": "C:\\inetpub\\86857ec28.jpg"}
],
"Variacoes": [
{
"ProdutoVariacao": 9,
"ProdutoVariacaoSKU": "ABC15002-AZ-PK-P",
"ProdutoVariacaoInt": "",
"ProdutoVariacaoInt2": "",
"TDepositoEstoqueDescricao": "G",
"TDepositoEstoquePadrao": "N",
"TDepositoEstoqueNome": "TAMANHO",
"TDepositoEstoqueIntegracao": [
{
"TDepositoEstoqueIntegracaoLojaID": "5",
"TDepositoEstoqueIntegracaoIntID": "87421036"}
],
}],
"Atributos": [
{
"AtributoDescricao": "Alças",
"AtributoConteudo": "3"},
{
"AtributoDescricao": "Material",
"AtributoConteudo": "Couro"}
   ]
  }
}


Então faça a requisição abaixo:

POST

/api_sgo/wsatualizaprodutos 



Resposta:
'Produto Atualizado com sucesso!'

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Deleta Produtos

Este método permite deletar produtos, através de um intervalo de códigos.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
ProdutoCodigoIni Integer Produto Código Inicial
ProdutoCodigoFin Integer Produto Código Final 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"ProdutoCodigoIni": 10,
"ProdutoCodigoFin": 20
}


Então faça a requisição abaixo:

POST

/api_sgo/wsdeletaprodutos 

Resposta:
'10 Produtos Deletados!'

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Vendas

Consultar Vendas

Este método permite consultar todos os Pedidos de Venda criados na conta do cliente.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
Codigo_Apos Integer Valor inicial do intervalo do código do pedido de venda
Codigo_Ate Integer Valor final do intervalo do código do pedido de venda
Criada_Apos DateTime Data inicial do intervalo da data de criação do pedido de venda
Criada_Ate DateTime Data final do intervalo da data de criação do pedido de venda
PDVCodIntero Character(15) Código interno do pedido de venda
NumPag Integer Número de paginação 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"Codigo_Apos": 1,
"Codigo_Ate": 50,
"Criada_Apos": "2019/01/01 00:00:00",
"Criada_Ate": "2019/12/31 23:59:59",
"PDVCodInterno": "",
"NumPag": 1
}


Então faça a requisição abaixo:

POST

/api_sgo/wsconsultavenda



PDVDataHora: Data do pedido de venda
PDVHora: Hora do pedido de Venda
PDVClienteCodigo: Código do Cliente no sistema
PDVVendedorCodigo: Código do Vendedor no sistema
PDVTransportadoraCodigo: Código da Transportadora no sistema
PDVTransportadoraNome: Nome da Transportadora no sistema
PDVStatus: Status do pedido de venda
PDVCodInterno: Código interno do pedido de venda
PDVShipmentId: Rastreio Transp.
PDVFreteModalidade: Frete Modalidade
PDVShipmentServico: Serviço Frete
ProdutoCodigo: Código do produto no sistema
ProdutoDescricao: Descrição do produto
PDVItemQuantidade: Quantidade vendida do produto
PDVItemValorVenda: Valor de venda do produto
PDVItemProdutosVariacao: Código da variação do produto vendido
PDVItemPercentualDesconto: Percentual de desconto aplicado sobre o produto
PDVItemValorDesconto: Valor de desconto aplicado sobre o produto
PDVIemObservacao: Observação do item
ProdutoPesoBruto: Peso bruto do produto (em gramas)
ProdutoComprimento: Comprimento do produto (em centimetros)
ProdutoLargura: Largura do produto (em centimetros)
ProdutoAltura: Altura do produto (em centimetros)
PDVDescontoExtra: Valor de desconto extra aplicado sobre o pedido
PDVDescontoExtraPerc: Percentual de desconto extra aplicado sobre o pedido
PDVAcrescimoExtra: Valor de acréscimo extra aplicado sobre o pedido
PDVAcrescimoExtraPerc: Percentual de acréscimo extra aplicado sobre o pedido
PDVObservacao: Obersavação do pedido
PDVCPagto: Condição de pagamento do pedido
PDVNFEChavex: Chave da NFe
PDVNumeroNFe: Número da NFe
PDVNFeLinkDanfe: Link com a url do danfe da NFe em PDF (esse link é temporário, ficando ativo por 20 dias após a emissão da NFe)
PDVSATChave: Chave do cupom SAT
PDVSATProtocolo: Protocolo do cupom SAT
PDVSATData: Data de emissão do cupom SAT
PDVSATHora: Hora de emissão do cupom SAT
PDVSATXml: XML do cupom SAT
PDVSATCancelamentoChave: Chave de cancelamento do cupom SAT
PDVSATCancelamentoMotivo: Motivo de cancelamento do cupom SAT
PDVSATCancelamentoData: Data de cancelamento do cupom SAT
PDVSATCancelamentoHora: Hora de cancelamento do cupom SAT
PDVSATXmlCancelamento: XML de cancelamento do cupom SAT
PedidoLojaVirtualVarchar: ID do pedido na loja virtual
PDVNumeroNFCe: Número da NFCe
PDVNFCeChave: Chave da NFCe
PDVNFCeProtocolo: Protocolo da NFCe
PDVNFCeRecibo: Recibo da NFCe
PDVDNFCeAutDataHora: Data e Hora de autenticação da NFCe
PDVNFCeProtocoloCancelamento: Protocolo de cancelamento da NFCe
PDVNFCeCancDataHora: Data e Hora de cancelamento da NFCe
PDVNFCeCPFCNPJ: Documento emitido na NFCe
PDVNFCeLinkQrCode: Link do QRCode da NFCe
PDVParcelaVencto: Data de Vencimento da parcela
PDVParcelaValor: Valor da parcela
TipDocCodigo: Código do tipo de documento
TipoDocBxFinanceiroPDV: Realiza baixa financeira pelo tipo de documento
PDVNumAutMeioPagto:
PDVParcelaObs: Observação da parcela 


				Resposta:
[
  {
"PDVDataHora":"2021-05-04",
"PDVHora":"00:00:00",
"PDVClienteCodigo":8,
"PDVVendedorCodigo":2,
"PDVTransportadoraCodigo":5,
"PDVTransportadoraNome":nome,
"PDVStatus":"VENDA",
"PDVCodInterno":"",
"PDVShipmentId":"",
"PDVFreteModalidade":"",
"PDVShipmentServico":"",
"Itens": [
{
"ProdutoCodigo":54,
"ProdutoDescricao":"Sapato Social",
"PDVItemQuantidade":2.000,
"PDVItemValorVenda":23.50,
"PDVItemProdutosVariacao":0,
"PDVItemPercentualDesconto":0.00,
"PDVItemValorDesconto":0.00,
"PDVIemObservacao":"",
"ProdutoPesoBruto":"",
"ProdutoComprimento":"",
"ProdutoLargura":"",
"ProdutoAltura":""
}],
"PDVDescontoExtra":0.00,
"PDVDescontoExtraPerc":0.00,
"PDVAcrescimoExtra":0.00,
"PDVAcrescimoExtraPerc":0.00,
"PDVObservacao":"",
"PDVCPagto":"1x",
"PDVNFEChavex":0,
"PDVNumeroNFe":0,
"PDVNFeLinkDanfe":"",
"PDVSATChave":0,
"PDVSATProtocolo":0,
"PDVSATData":"2019-01-30",
"PDVSATHora":"00:00:00",
"PDVSATXml":"",
"PDVSATCancelamentoChave":0,
"PDVSATCancelamentoMotivo":"",
"PDVSATCancelamentoData":"2019-01-30",
"PDVSATCancelamentoHora":"00:00:00",
"PDVSATXmlCancelamento":"",
"PedidoLojaVirtualVarchar":"",
"PDVNumeroNFCe":0,
"PDVNFCeChave":0,
"PDVNFCeProtocolo":0,
"PDVNFCeRecibo":0,
"PDVDNFCeAutDataHora":"21/05/2019T00:00:00",
"PDVNFCeProtocoloCancelamento":0,
"PDVNFCeCancDataHora":0,
"PDVNFCeCPFCNPJ":"111.111.111-11",
"PDVNFCeLinkQrCode":"",
"Parcelas": [
{
"PDVParcelaVencto":"2021-06-03",
"PDVParcelaValor":0.00,
"TipDocCodigo":0,
"TipoDocBxFinanceiroPDV":"",
"PDVNumAutMeioPagto":"",
"PDVParcelaObs":""
}]
}
]{}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Consultar Vendas (Pessoas)

Este método permite consultar todos os Pedidos de Venda criados na conta do cliente.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
Codigo_Apos Integer Valor inicial do intervalo do código do pedido de venda
Codigo_Ate Integer Valor final do intervalo do código do pedido de venda
Criada_Apos Date Data inicial do intervalo da data de criação do pedido de venda
Criada_Ate Date Data final do intervalo da data de criação do pedido de venda
PDVCodIntero Character(15) Código interno do pedido de venda
PessoaCNPJ Character(14) CNPJ do cliente, somente numeros
PessoaCPF Character(11) CPF do cliente, somente numeros
PDVFreteModalidade Character(200) Modalidade do frete, ex: "Mercado Envios Coleta"
PedidoLojaVirtualVarchar Character(100) Numero do pedido da plataforma"
NumPag Integer Número de paginação
HoraApos Character(8) Horário inicial do intervalo da hora de criação do pedido de venda
HoraAte Character(8) Horário final do intervalo da hora de criação do pedido de venda
ListarVendas Boolean Lista somente pedidos (se true vai listar somente vendas e nfes, não lista cancelados e orçamentos. 
 {
 "Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
 "Codigo_Apos": 1,
 "Codigo_Ate": 50,
 "Criada_Apos": "2022-06-20",
 "Criada_Ate": "2020-06-23",
 "PDVCodInterno": "",
 "PessoaCNPJ": "",
 "PessoaCPF": "",
 "PDVFreteModalidade": "",
 "PedidoLojaVirtualVarchar": "",
 "NumPag": 1,
 "HoraApos": "09:30:00",
 "HoraAte": "12:00:00",
 "ListarVendas": true
 }


Então faça a requisição abaixo:

POST

/api_sgo/WSConsultaVendasPessoas



PDVNumero: Numero do pedido
PDVDataHora: Data do pedido de venda
PDVHora: Hora do pedido de Venda
PDVClienteCodigo: Código do Cliente no sistema
PessoaCNPJ: CNPJ do cliente em caso de pessoa juridica
PessoaCPF: CPF do cliente em caso de pessoa fisica
PDVVendedorCodigo: Código do Vendedor no sistema
PDVTransportadoraCodigo: Código da Transportadora no sistema
PDVTransportadoraNome: Nome da Transportadora no sistema
PDVStatus: Status do pedido de venda
PDVCodInterno: Código interno do pedido de venda
PDVShipmentId: Rastreio Transp.
PDVFreteModalidade: Frete Modalidade
PDVShipmentServico: Serviço Frete
PDVPlataformaMarketplace: Plataforma do Pedido
PedidoLojaVirtual: Numero do pedido da plataforma
ProdutoCodigo: Código do produto no sistema
ProdutoDescricao: Descrição do produto
PDVItemQuantidade: Quantidade vendida do produto
ProdutoReferencia: Sku do produto
ProdutoCodigoEAN: EAN do produto
PDVItemValorVenda: Valor de venda do produto
PDVItemProdutosVariacao: Código da variação do produto vendido
PDVItemPercentualDesconto: Percentual de desconto aplicado sobre o produto
PDVItemValorDesconto: Valor de desconto aplicado sobre o produto
PDVIemObservacao: Observação do item
ProdutoPesoBruto: Peso bruto do produto (em gramas)
ProdutoComprimento: Comprimento do produto (em centimetros)
ProdutoLargura: Largura do produto (em centimetros)
ProdutoAltura: Altura do produto (em centimetros)
PDVDescontoExtra: Valor de desconto extra aplicado sobre o pedido
PDVDescontoExtraPerc: Percentual de desconto extra aplicado sobre o pedido
PDVAcrescimoExtra: Valor de acréscimo extra aplicado sobre o pedido
PDVAcrescimoExtraPerc: Percentual de acréscimo extra aplicado sobre o pedido
PDVObservacao: Obersavação do pedido
PDVCPagto: Condição de pagamento do pedido
PDVNFEChavex: Chave da NFe
PDVNumeroNFe: Número da NFe
PDVNFeLinkDanfe: Link com a url do danfe da NFe em PDF (esse link é temporário, ficando ativo por 20 dias após a emissão da NFe)
PDVSATChave: Chave do cupom SAT
PDVSATProtocolo: Protocolo do cupom SAT
PDVSATData: Data de emissão do cupom SAT
PDVSATHora: Hora de emissão do cupom SAT
PDVSATXml: XML do cupom SAT
PDVSATCancelamentoChave: Chave de cancelamento do cupom SAT
PDVSATCancelamentoMotivo: Motivo de cancelamento do cupom SAT
PDVSATCancelamentoData: Data de cancelamento do cupom SAT
PDVSATCancelamentoHora: Hora de cancelamento do cupom SAT
PDVSATXmlCancelamento: XML de cancelamento do cupom SAT
PDVSATNum: Numero do sat
PedidoLojaVirtualVarchar: ID do pedido na loja virtual
PDVNumeroNFCe: Número da NFCe
PDVNFCeChave: Chave da NFCe
PDVNFCeProtocolo: Protocolo da NFCe
PDVNFCeRecibo: Recibo da NFCe
PDVDNFCeAutDataHora: Data e Hora de autenticação da NFCe
PDVNFCeProtocoloCancelamento: Protocolo de cancelamento da NFCe
PDVNFCeCancDataHora: Data e Hora de cancelamento da NFCe
PDVNFCeCPFCNPJ: Documento emitido na NFCe
PDVNFCeLinkQrCode: Link do QRCode da NFCe
PDVDataCheckOut: Data realizado o checkout no pedido
PDVHoraCheckOut: Hora realizado o checkout no pedido
PDVUsuarioCheckOut: Usuário logado que realizou o checkout no pedido
PDVParcelaVencto: Data de Vencimento da parcela
PDVParcelaValor: Valor da parcela
TipDocCodigo: Código do tipo de documento
TipoDocBxFinanceiroPDV: Realiza baixa financeira pelo tipo de documento
PDVNumAutMeioPagto:
PDVParcelaObs: Observação da parcela 


				 Resposta:
{
 "RetornoListaVendasPessoas": { 
 "error": "", 
 "vendas": [ 
 { 
 "PDVNumero": 1633,
 "PDVDataHora": "2022-06-20",
 "PDVHora": "",
 "PDVClienteCodigo": "1",
 "PessoaCNPJ": "00000000000",
 "PessoaCPF": "",
 "PDVVendedorCodigo": "1001",
 "PDVTransportadoraCodigo": "0",
 "PDVTransportadoraNome": "",
 "PDVStatus": "ORÇAMENTO",
 "PDVCodInterno": "",
 "PDVShipmentId": "",
 "PDVFreteModalidade": "",
 "PDVShipmentServico": "",
 "PDVPlataformaMarketplace": "",
 "PedidoLojaVirtual": "0",
 "Itens": [ 
 { 
 "ProdutoCodigo": "2",
 "ProdutoDescricao": "Bota Social Casual Collection",
 "PDVItemQuantidade": "1.000",
 "ProdutoReferencia": "SKUXXX",
 "ProdutoCodigoEAN": "789654321",
 "PDVItemValorVenda": "57.80",
 "PDVItemProdutosVariacao": 9747,
 "PDVItemPercentualDesconto": 0,
 "PDVItemValorDesconto": "0.00",
 "PDVIemObservacao": "",
 "ProdutoPesoBruto": "0.8000",
 "ProdutoComprimento": "32.000",
 "ProdutoLargura": "18.000",
 "ProdutoAltura": "12.200",
 } 
 ],
 "PDVDescontoExtra": "0.00",
 "PDVDescontoExtraPerc": 0,
 "PDVAcrescimoExtra": "0.00",
 "PDVAcrescimoExtraPerc": 0,
 "PDVObservacao": "",
 "PDVCPagto": "1x",
 "PDVNFEChavex": "",
 "PDVNumeroNFe": "0",
 "PDVNFeLinkDanfe": "",
 "PDVSATChave": "",
 "PDVSATProtocolo": "",
 "PDVSATData": "",
 "PDVSATHora": "",
 "PDVSATXml": "",
 "PDVSATCancelamentoChave": "",
 "PDVSATCancelamentoMotivo": "",
 "PDVSATCancelamentoData": "",
 "PDVSATCancelamentoHora": "",
 "PDVSATXmlCancelamento": "",
 "PDVSATNum": "0",
 "PedidoLojaVirtualVarchar": "",
 "PDVNumeroNFCe": "0",
 "PDVNFCeChave": "",
 "PDVNFCeProtocolo": "0",
 "PDVNFCeRecibo": "0",
 "PDVDNFCeAutDataHora": "",
 "PDVNFCeProtocoloCancelamento": "0",
 "PDVNFCeCancDataHora": "",
 "PDVNFCeCPFCNPJ": "",
 "PDVNFCeLinkQrCode": "",
 "PDVDataCheckOut": "",
 "PDVHoraCheckOut": "",
 "PDVUsuarioCheckOut": "",
 "Parcelas": [ 
 {
 "PDVParcelaVencto": "2022-07-20",
 "PDVParcelaValor": "57.80",
 "TipDocCodigo": 1,
 "TipoDocBxFinanceiroPDV": "S",
 "PDVNumAutMeioPagto": "",
 "PDVParcelaObs": "",
 } 
 ] 
 } 
 ] 
 } 
}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Consultar Vendas (Encomendas)

Este método permite consultar todos os Pedidos de Venda criados na conta do cliente.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
Codigo_Apos Integer Valor inicial do intervalo do código do pedido de venda
Codigo_Ate Integer Valor final do intervalo do código do pedido de venda
Criada_Apos Date Data inicial do intervalo da data de criação do pedido de venda
Criada_Ate Date Data final do intervalo da data de criação do pedido de venda
PDVCodIntero Character(15) Código interno do pedido de venda
PDVFreteModalidade Character(200) Modalidade do frete, ex: "Mercado Envios Coleta"
NumPag Integer Número de paginação 
 {
 "Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
 "Codigo_Apos": 1,
 "Codigo_Ate": 50,
 "Criada_Apos": "2022-06-20",
 "Criada_Ate": "2020-06-23",
 "PDVCodInterno": "",
 "PDVFreteModalidade": "",
 "NumPag": 1
 }


Então faça a requisição abaixo:

POST

/api_sgo/WSConsultaVendaEncomendas



PDVNumero: Numero do pedido
PDVDataHora: Data do pedido de venda
PDVClienteCodigo: Código do Cliente no sistema
PessoaRazaoSocial: Razão Social do Cliente
PessoaNomeFantasia: Nome Fantasia do cliente
PessoaCEP: CEP do cliente
PessoaLogradouro: Nome da rua do cliente
PessoaNumero: Numero do endereço do cliente
PessoaComplemento: Complemento do endereço do cliente
PessoaBairro: Bairro do cliente
PessoaNomeMunicipio: Cidade do cliente
PessoaUFPDV: Estado do cliente
PessoaDDDFone: Telefone do cliente
PessoaCelular: Celular do cliente
PessoaEmail: E-mail do cliente
PDVTransportadoraCodigo: Código da Transportadora no sistema
PDVTransportadoraNome: Nome da Transportadora no sistema
PDVStatus: Status do pedido de venda
PDVCodInterno: Código interno do pedido de venda
PDVNFEChavex: Chave da NFe
PDVNumeroNFe: Número da NFe
PedidoLojaVirtualVarchar: ID do pedido na loja virtual
PDVVrFrete: Valor do frete
PDVFreteModalidade: Frete Modalidade
PDVPesoBruto: Peso bruto do pedido 


				 Resposta:
 { 
 "PDVNumero": 1633,
 "PDVDataHora": "2022-06-20",
 "PDVClienteCodigo": "1",
 "PessoaRazaoSocial": "ASSOC. ASSIST. PRESB. BOM",
 "PessoaNomeFantasia": "CEBS 2",
 "PessoaCEP": 14407218,
 "PessoaLogradouro": "RUA ALCINO TEIXEIRA DA SILVA",
 "PessoaNumero": "1040",
 "PessoaComplemento": "",
 "PessoaBairro": "JD. TROPICAL II",
 "PessoaNomeMunicipio": "FRANCA",
 "PessoaUFPDV": "SP",
 "PessoaDDDFone": 0,
 "PessoaCelular": 34325411,
 "PessoaEmail": "",
 "PDVTransportadoraCodigo": 0,
 "PDVTransportadoraNome": "",
 "PDVStatus": "ORÇAMENTO",
 "PDVCodInterno": "",
 "PDVNFEChavex": "",
 "PDVNumeroNFe": 0,
 "PedidoLojaVirtualVarchar": "",
 "PDVVrFrete": 0,
 "PDVFreteModalidade": "",
 "PDVPesoBruto": 0,
 }

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Consulta Sangria/Suprimentos

Este método permite consultar todas as Sangrias/Suprimentos realizadas na conta do cliente.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
Criada_Apos DateTime Data inicial do intervalo da data de criação do pedido de venda
Criada_Ate DateTime Data final do intervalo da data de criação do pedido de venda
NumPag Integer Número de paginação 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"Criada_Apos": "2019/01/01 00:00:00",
"Criada_Ate": "2019/12/31 23:59:59",
"NumPag": 1
}


Então faça a requisição abaixo:

POST

/api_sgo/wsconsultasangriasuprimento



TCaixaSangSupriSeq: Código Sequencial da Sangria/Suprimento
TCaixaSangSupriData: Data da Sangria/Suprimento
TCaixaSangSupriHora: Hora da Sangria/Suprimento
TCaixaSangSupriCodCaixa: Código do Caixa que realizou a Sangria/Suprimento
TCaixaSangSupriVendCod: Código do Vendedor que realizou a Sangria/Suprimento
TCaixaSangSupriObs: Observações
TCaixaSangSupriValor: Valor da Sangria/Suprimento
TCaixaSangSupriTipo: Tipo da Movimentação (E-Entrada/S-Saída) 


				Resposta:
  {
"TCaixaSangSupriSeq":"2",
"TCaixaSangSupriData":"2019-01-30",
"TCaixaSangSupriHora":"16:45:33",
"TCaixaSangSupriCodCaixa":18,
"TCaixaSangSupriVendCod":172,
"TCaixaSangSupriObs":"tt1",
"TCaixaSangSupriValor":10,
"TCaixaSangSupriTipo":"E"
}
{}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Cria uma Venda

Este método permite criar um Pedido de Venda na conta do cliente.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
ItemVendas Object Estrutura de dados com as informações do pedido de venda


ItemVendas:

Chave: Chave de acesso obtida pelo cliente
Venda: Coleção de objetos com dados do pedido de venda

Venda:

PDVDataHora: Data do pedido de venda
PDVHora: Hora do pedido de Venda
PDVClienteCodigo: Código do Cliente no sistema
PDVVendedorCodigo: Código do Vendedor no sistema
PDVTransportadoraCodigo: Código da Transportadora no sistema
PDVStatus: Status do pedido de venda
PDVCodInterno: Código interno do pedido de venda
ProdutoCodigo: Código do produto no sistema
ProdutoDescricao: Descrição do produto
PDVItemQuantidade: Quantidade vendida do produto
PDVItemValorVenda: Valor de venda do produto
PDVItemProdutosVariacao: Código da variação do produto vendido
PDVItemPercentualDesconto: Percentual de desconto aplicado sobre o produto
PDVItemValorDesconto: Valor de desconto aplicado sobre o produto
PDVIemObservacao: Observação do item
PDVDescontoExtra: Valor de desconto extra aplicado sobre o pedido
PDVDescontoExtraPerc: Percentual de desconto extra aplicado sobre o pedido
PDVAcrescimoExtra: Valor de acréscimo extra aplicado sobre o pedido
PDVAcrescimoExtraPerc: Percentual de acréscimo extra aplicado sobre o pedido
PDVObservacao: Obersavação do pedido
PDVCPagto: Condição de pagamento do pedido
PDVNFEChavex: Chave da NFe
PDVNumeroNFe: Número da NFe
PDVSATChave: Chave do cupom SAT
PDVSATProtocolo: Protocolo do cupom SAT
PDVSATData: Data de emissão do cupom SAT
PDVSATHora: Hora de emissão do cupom SAT
PDVSATXml: XML do cupom SAT
PDVSATCancelamentoChave: Chave de cancelamento do cupom SAT
PDVSATCancelamentoMotivo: Motivo de cancelamento do cupom SAT
PDVSATCancelamentoData: Data de cancelamento do cupom SAT
PDVSATCancelamentoHora: Hora de cancelamento do cupom SAT
PDVSATXmlCancelamento: XML de cancelamento do cupom SAT
PedidoLojaVirtualVarchar: ID do pedido na loja virtual
PDVNumeroNFCe: Número da NFCe
PDVNFCeChave: Chave da NFCe
PDVNFCeProtocolo: Protocolo da NFCe
PDVNFCeRecibo: Recibo da NFCe
PDVDNFCeAutDataHora: Data e Hora de autenticação da NFCe
PDVNFCeProtocoloCancelamento: Protocolo de cancelamento da NFCe
PDVNFCeCancDataHora: Data e Hora de cancelamento da NFCe
PDVNFCeCPFCNPJ: Documento emitido na NFCe
PDVNFCeLinkQrCode: Link do QRCode da NFCe
PDVFrete: Quem paga o frete (Emitente/Destinatário)
PDVVrFrete: Valor do frete
PDVShipmentId: Código de rastreio
PDVFreteModalidade: Serviço de envio (PAC, Normal, etc)
PDVParcelaVencto: Data de Vencimento da parcela
PDVParcelaValor: Valor da parcela
TipDocCodigo: Código do tipo de documento
TipoDocBxFinanceiroPDV: Realiza baixa financeira pelo tipo de documento
PDVNumAutMeioPagto: Número de Autenticação do Meio de Pagamento
PDVParcelaObs: Observação da parcela

PDVStatus:
VENDA: Cria uma Venda no sistema, como também gera a movimentação financeira e realiza a baixa no estoque
ORÇAMENTO: Cria um orçamento na tela de vendas, sem gerar movimentos financeiros ou de estoque

PDVCPagto:
0x: à vista
Nx: N parcelas

IMPORTANTE!
Nas tags:
"PDVDataHora":"2019/12/05 00:00:00",
"PDVParcelaVencto":""2019/02/01 00:00:00,

==> Fazer o tratamento da hora e enviar (com zeros) 00:00:00 

				{
"ItemVendas": {
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"Venda": [
{
"PDVDataHora":"2019/12/05 00:00:00",
"PDVHora":"00:00:00",
"PDVClienteCodigo":8,
"PDVVendedorCodigo":2,
"PDVTransportadoraCodigo":5,
"PDVStatus":"VENDA",
"PDVCodInterno":"",
"Itens": [
{
"ProdutoCodigo":54,
"ProdutoDescricao":"Sapato Social",
"PDVItemQuantidade":2.000,
"PDVItemValorVenda":23.50,
"PDVItemProdutosVariacao":0,
"PDVItemPercentualDesconto":0.00,
"PDVItemValorDesconto":0.00,
"PDVIemObservacao":""
}]
"PDVDescontoExtra":0.00,
"PDVDescontoExtraPerc":0.00,
"PDVObservacao":"",
"PDVCPagto":"1x",
"PDVNFEChavex":0,
"PDVNumeroNFe":0,
"PDVSATChave":0,
"PDVSATProtocolo":0,
"PDVSATData":"2019-01-30",
"PDVSATHora":"00:00:00",
"PDVSATXml":"",
"PDVSATCancelamentoChave":0,
"PDVSATCancelamentoMotivo":"",
"PDVSATCancelamentoData":"2019-01-30",
"PDVSATCancelamentoHora":"00:00:00",
"PDVSATXmlCancelamento":"",
"PedidoLojaVirtualVarchar":"",
"PDVNumeroNFCe":0,
"PDVNFCeChave":0,
"PDVNFCeProtocolo":0,
"PDVNFCeRecibo":0,
"PDVDNFCeAutDataHora":"21/05/2019T00:00:00",
"PDVNFCeProtocoloCancelamento":0,
"PDVNFCeCancDataHora":0,
"PDVNFCeCPFCNPJ":"111.111.111-11",
"PDVNFCeLinkQrCode":"",
"PDVFrete":"Destinatário",
"PDVVrFrete":0,
"PDVShipmentId":"",
"PDVFreteModalidade":"",
"Parcelas": [
{
"PDVParcelaVencto":""2019/02/01 00:00:00,
"PDVParcelaValor":0.00,
"TipDocCodigo":0,
"TipoDocBxFinanceiroPDV":"",
"PDVNumAutMeioPagto":"",
"PDVParcelaObs":""
}]
}
]}
{}


Então faça a requisição abaixo:

POST

/api_sgo/wscriavenda 



Resposta:
[
  {
   "PDVNumero": 231
  }
]

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Alterar Status de Orçamento para Venda

Este método permite alterar o status do pedido de Orçamento para Venda. Executando assim, todos os processos de movimentação de estoque e financeiro do pedido.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
PDVNumero Integer Número do pedido de venda a ser alterado
PDVStatus Character(50) Enviar preenchido "VENDA" 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"PDVNumero": 123456,
"PDVStatus": "VENDA"
}


Então faça a requisição abaixo:

POST

/api_sgo/wsgeravenda 

				Resposta:
  {
"success":"true",
"message":"Sucesso - status alterado!",
}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Cria Ajuste Estoque

Este método permite criar um Ajuste de Estoque com vários produtos.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
AjusteEstoque Object Estrutura de dados com as informações do ajuste estoque


AjusteEstoque:

Chave: Chave de acesso obtida pelo cliente
Ajuste: Coleção de objetos com dados do ajuste estoque

Produto:

Chave = Chave de API
TAjusteEstoqueData = Data do Ajuste Ex: 10/05/21
PessoaCodigo = Id da pessoa no sistema
PessoaRazaoSocial = Razão social da pessoa
PessoaNomeFantasia = Nome fantasia da pessoa
TAjusteEstoqueObs = Observação do Ajuste
TAjusteEstoqueTipo = Tipo do Ajuste (1 - Ajustes de Estoque, 2 - Pedido de Compra)
ProdutoCodigo = Id do produto no sistema
ProdutoReferencia = SKU do produto
ProdutoVariacao = Id da variação do produto
ProdutoVariacaoSKU = SKU da variação do produto
TAjusteEstoqueItensQtd = Quantidade de itens do ajuste de estoque
TAjusteEstoqueItensQtdEntr = Quantidade entregue (caso seja devolução)
TAjusteEstoqueItensTipo = Tipo de item do ajuste (E - Entrada, S - Saída)
TAjusteEstoqueItensValor = Valor do item do ajuste
TAjusteEstoqueItensObs = Observação do item do ajuste


Obs1: Para a pessoa relacionada ao ajuste, envia-se apenas o código, ou a razão social, ou o nome fantasia, não sendo necessário enviar os três. O sistema irá relacionar por algum desses campos que estiverem preenchidos. Os demais podem ir em branco/zerados.

Obs2: Para os produtos e variações do ajuste, envia-se apenas o código ou o SKU, não sendo necessário enviar os dois. O sistema irá relacionar por algum desses campos que estiverem preenchidos. Os demais podem ir em branco/zerados.

Obs3: Apenas a data e os campos para relacionar o produto são obrigatórios. Mas todos os campos devem estar no payload, mesmo que sejam em branco ou zerados. 


{
    "AjusteEstoque": {
        "Chave": "",
        "Ajuste": [
            {
                "TAjusteEstoqueData": "",
                "PessoaCodigo": "0",
                "PessoaRazaoSocial": "",
                "PessoaNomeFantasia": "",
                "TAjusteEstoqueObs": "",
                "TAjusteEstoqueTipo": "",
                "Item": [
                    {
                        "ProdutoCodigo": 0,
                        "ProdutoReferencia": "",
                        "ProdutoVariacao": 0,
                        "ProdutoVariacaoSKU": "",
                        "TAjusteEstoqueItensQtd": 5,
                        "TAjusteEstoqueItensQtdEntr": 0,                        "TAjusteEstoqueItensTipo": "S",                        "TAjusteEstoqueItensValor": "",                        "TAjusteEstoqueItensObs": ""                    }
                ]
            }
        ]
    }
}


Então faça a requisição abaixo:

POST

/api_sgo/wscriaajusteestoque 



Resposta:
{
    "Retorno": {
        "success": true,
        "error": "",
        "response": [
            "459"
        ]
    }
}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Gerar Ajuste Estoque

Este método permite gerar um Ajuste de Estoque que foi criando anteriormente.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
TAjusteEstoqueId Object Id do Ajuste de Estoque a ser processado


AjusteEstoque:

Chave: Chave de acesso obtida pelo cliente
TAjusteEstoqueId: Id do Ajuste de Estoque a ser processado

Produto:

Chave = Chave de API
TAjusteEstoqueId = Id do Ajuste de Estoque a ser processado 


				{
    "Chave": "",
    "TAjusteEstoqueId": 0
}


Então faça a requisição abaixo:

POST

/api_sgo/wsgeraajusteestoque 



Resposta:
			
			
{
    "Retorno": {
        "Retorno": "Ajuste de estoque processado com sucesso."
}

Resposta quando o Ajuste já foi processado:
			
{
    "Retorno": {
        "Retorno": "Ajuste já processado anteriormente."
}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Financeiro

Consulta Bancos

Este método permite consultar todos os Banos cadastrados.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
NumPag Integer Número de paginação 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"NumPag": 1
}


Então faça a requisição abaixo:

POST

/api_sgo/wsconsultabancos



TBancosCodigo: Código do Banco no Sistema
TBancosBanco: Nome do Banco 


				Resposta:
[
  {
  "TBancosCodigo":1,
  "TBancosBanco":"Banco do Brasil S.A."
  }
]

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Consulta Contas Bancárias

Este método permite consultar todas as Contas Bancárias cadastradas na conta do cliente.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
NumPag Integer Número de paginação 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"NumPag": 1
}


Então faça a requisição abaixo:

POST

/api_sgo/wsconsultacontabancaria



TContaBancariaCodigo: Código da Conta Bancária
TContaBancariaConta: Numero da Conta Bancária
TContaBancariaBanco: Banco a qual a conta pertence
TContaBancariaTipo: Tipo de Conta Bancária
TContaBancariaSaldoAtual: Saldo atual da Conta Bancária
TContaBancariaAg: Código Agência da Conta Bancária
TContaBancariaPix: Código Pix da Conta Bancária
TContaBancariaObs: Observação da Conta Bancária 


				Resposta:
[
  {
  "TContaBancariaCodigo":1,
  "TContaBancariaConta":"CAIXA",
  "TContaBancariaBanco":0,
  "TContaBancariaTipo":3,
  "TContaBancariaSaldoAtual":1590.5000,
  "TContaBancariaAg":"",				
  "TContaBancariaPix":"",
  "TContaBancariaObs":""
 },
 { 
  "TContaBancariaCodigo":2,
  "TContaBancariaConta":"BRADESCO",
  "TContaBancariaBanco":1,
  "TContaBancariaTipo":1,
  "TContaBancariaSaldoAtual":13480.0000,
  "TContaBancariaAg":"0263",				
  "TContaBancariaPix":"",
  "TContaBancariaObs":""
}
]

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Consulta Tipo de Documento

Este método permite consultar todos os Tipos de Documentos criados na conta do cliente.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
NumPag Integer Número de paginação 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"NumPag": 1
}


Então faça a requisição abaixo:

POST

/api_sgo/wsconsultatipodoc



TipDocCodigo: Código do Tipo de Documento
TipDocDescricao: Descrição do Tipo de Documento
TipoDocSAT: Código do Documento para o SAT
TipoDocBandeiraOperadora: Bandeira da Operadora do Cartão
TipoDocBxFinanceiroPDV: Realiza Baixa Financeira (N/S)
TipoDocPercFinanceiro: Percentual para realizar baixa financeria
ContaBancariaPadrao: Indica se esta é a conta bancária padrão (0/1)
TTipoDocumentojurosatraso: Valor do Juros por atraso no Financeiro
TTipoDocumentoDiasTolerancia: Dias de Tolerancia para aplicação dos Juros 


				Resposta:
[
  {
  "TipDocCodigo":"1,
  "TipDocDescricao":"DINHEIRO",
  "TipoDocSAT":"02",
  "TipoDocBandeiraOperadora":"",
  "TipoDocBxFinanceiroPDV":"S",
  "TipoDocPercFinanceiro":0,
  "ContaBancariaPadrao":0,
  "TTipoDocumentojurosatraso":0,
  "TTipoDocumentoDiasTolerancia":0
  }
]
{}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Consulta Categorias Mov.Financeiro

Este método permite consultar todas as Categorias de Movimentações Financeiras realizadas na conta do cliente.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
NumPag Integer Número de paginação 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"NumPag": 1
}


Então faça a requisição abaixo:

POST

/api_sgo/wsconsultacategoriasfinanceiro



TCategoriasCodigo: Código da Categoria
TTipoCategoriaCodigo: Código do Tipo da Categoria
TCategoriasDescricao: Descrição da Categoria

Opções para TTipoCategoriaCodigo:
1 Recebimentos
2 Despesas Fixas
3 Despesas Variáveis
4 Pessoas
5 Impostos
6 Transferência (Origem)
7 Transferência (Destino) 


				Resposta:
[
  {
  "TCategoriasCodigo":2,
  "TTipoCategoriaCodigo":1,
  "TCategoriasDescricao":"Adiantamento"
  }
]
{}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Consulta Centros de Custo

Este método permite consultar todos os Centros de Custo cadastrados na conta do cliente.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
NumPag Integer Número de paginação 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"NumPag": 1
}


Então faça a requisição abaixo:

POST

/api_sgo/wsconsultacentroscusto



TCentrosCustoCodigo: Código do Centro de Custo
TCentrosCustoDescricao: Descrição do Centro de Custo 


				Resposta:
[
  {
  "TCentrosCustoCodigo":2,
  "TCentrosCustoDescricao":"COMPRAS"
  }
]
{}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Consulta Movimento Financeiro

Este método permite consultar todos os registros cadastrados no Movimento Financeiro.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
Seq_Apos Integer Valor inicial do intervalo do código sequencial do lançamento
Seq_Ate Integer Valor final do intervalo do código sequencial do lançamento
Vencto_Apos DateTime Data inicial do intervalo da data de vencimento
Vencto_Ate DateTime Data final do intervalo da data de vencimento
NumDoc Character(15) Número do documento do lançamento do movimento financeiro
NumPag Integer Número de paginação
DtComp_Apos DateTime Data inicial do intervalo da data de competência
DtComp_Ate DateTime Data final do intervalo da data de competência
PessoaCodigo Integer Código (Id) Pessoa 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"Seq_Apos": 1,
"Seq_Ate": 50,
"Vencto_Apos": "2019/01/01 00:00:00",
"Vencto_Ate": "2019/12/31 23:59:59",
"NumDoc": "",
"NumPag": 1,
"DtComp_Apos": "2019/01/01 00:00:00",
"DtComp_Ate": "2019/12/31 23:59:59",
"PessoaCodigo": 0
}


Então faça a requisição abaixo:

POST

/api_sgo/wsconsultafinanceiro



TMovFinanceiroSeq: Código Sequencial do Lançamento
TMovFinanceiroTipoCategoria: Tipo de Categoria
TTipoCategoriaDescricao: Descrição Tipo de Categoria
TCategoriasCodigo: Categoria
TCategoriasDescricao: Descrição da Categoria
TMovFinanceiroDtVencimento: Data de Vencimento
TMovFinanceiroDescricao: Descrição do Lançamento
PessoaCodigo: Código do Cliente no sistema
PessoaRazaoSocial: Razão Social do Cliente
TMovFinanceiroValor: Valor do Lançamento a Receber
TMovFinanceiroValorSaldo: Valor do Lançamento a Receber em Aberto
TMovFinanceiroDtComp: Data de Competência
TMovFinanceiroNDoc: Número do Documento
TContaBancariaCodigo: Código Conta Bancária
TContaBancariaConta: Descrição Conta Bancária
TCentrosCustoCodigo: Código Centro de Custo
TCentrosCustoDescricao: Descrição Centro de Custo
TipDocCodigo: Código Tipo de Documento
TipDocDescricao: Descrição Tipo de Documento
TMovFinanceiroObs: Observação do Lançamento
TMovFinanceiroDtDigitacao: Data de Digitação
PDVNumero: Número da venda relacionada ao lançamento
PDVVendedorNome: Nome do vendedor da venda relacionada ao lançamento
TMovFinanceiroJuros: Valor Juros Recebidos
TMovFinanceiroValorBaixas: Valor de Baixas Recebidas
TMovFinanceiroDebCred: Tipo do Lançamento [D] para débito ou [C] para crédito
Codigo_OS: Número da Ordem Serviço relacionada ao lançamento
Codigo_DNT: Número da NFSe relacionada ao lançamento
TMovFinanceiroPedLojaVirtual: Número do Pedido (Integrado) na venda relacionada ao lançamento
TMovFinanceiroCodCaixa: Número do caixa relacionado ao lançamento


 

				Resposta:
				
[
  {
  "TMovFinanceiroSeq": 1,
  "TMovFinanceiroTipoCategoria": 1,
  "TCategoriasCodigo": 12,
  "TMovFinanceiroDtVencimento": "2018-04-06",
  "TMovFinanceiroDescricao": "Venda Nº 8",
  "PessoaCodigo": 4,
  "PessoaRazaoSocial": "teste",
  "TMovFinanceiroValor": "0.00",
  "TMovFinanceiroValorSaldo": "0.00",
  "TMovFinanceiroDtComp": "2018-03-07",
  "TMovFinanceiroNDoc": "8/1",
  "TContaBancariaCodigo": 1,
  "TCentrosCustoCodigo": 0,
  "TCentrosCustoDescricao": "",
  "TipDocCodigo": 1,
  "TipDocDescricao": "DINHEIRO",
  "TMovFinanceiroObs": "Gerado pela venda nº: 8",
  "TMovFinanceiroDtDigitacao": "2018-03-07",
  "PDVNumero": 8,
  "PDVVendedorNome":"",
  "TMovFinanceiroJuros": 0,
  "TMovFinanceiroValorBaixas": "0.00",
  "TMovFinanceiroDebCred": "C",
  "Codigo_OS": 0,
  "Codigo_DNT": 0,
  "TMovFinanceiroPedLojaVirtual": 0,
  "TMovFinanceiroCodCaixa": 0,
  }
]
{}

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

Consulta Baixas Movimento Financeiro

Este método permite consultar todos os registros de baixas do movimento financeiro.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
Seq_Apos Integer Valor inicial do intervalo do código sequencial do lançamento
Seq_Ate Integer Valor final do intervalo do código sequencial do lançamento
DtBaixa_Apos DateTime Data inicial do intervalo da data da baixa
DtBaixa_Ate DateTime Data final do intervalo da data da baixa
Identificador Varchar(200) Identificação da Baixa do lançamento
TipoDocBx Integer Código do Tipo de Documento
ContaBanc Integer Codigo da Conta Bancária
NumPag Integer Número de paginação 
{
"Chave": "et53r4g934j90tj39gjhy93jy39jg9=gb",
"Seq_Apos": 1,
"Seq_Ate": 50,
"DtBaixa_Apos": "2019/01/01 00:00:00",
"DtBaixa_Ate": "2019/12/31 23:59:59",
"Identificador": "",
"TipoDocBx": 0,
"ContaBanc": 0,
"NumPag": 1
}


Então faça a requisição abaixo:

POST

/api_sgo/WSConsultaFinanceiroBaixas



TMovFinanceiroSeq: Código sequencial do lançamento
TMovFinanceiroSeqItem: Código sequencial do lançamento
TContaBancariaCodigo: Código da conta cancária
TMovFinanceiroBaixasDataBaixa: Data da baixa do lançamento
TMovFinanceiroBaixasIdentificador: Identificação da baixa do lançamento
TMovFinanceiroBaixasValor: Valor da baixa do lançamento
TMovFinanceiroBaixasJuros: Valor do Juros do lançamento
TMovFinanceiroBaixasDesconto: Valor do desconto do lançamento
TMovFinanceiroBaixasAcrescimo: Valor do acréscimo do lançamento
TMovFinanceiroBaixasTipoDocBx: Código do tipo de documento do lançamento
TMovFinanceiroBaixasContaBanc: Código da conta bancária do lançamento
TMovFinanceiroBaixasCodCaixa: Código do caixa do lançamento 


				Resposta:
				
[
  {
  "TMovFinanceiroSeq": 1,
  "TMovFinanceiroSeqItem": 1,
  "TContaBancariaCodigo": 1,
  "TMovFinanceiroBaixasDataBaixa": "2023-06-07",
  "TMovFinanceiroBaixasIdentificador": "Bx.Aut. pela venda",
  "TMovFinanceiroBaixasValor":89.1000,
  "TMovFinanceiroBaixasJuros":0,
  "TMovFinanceiroBaixasDesconto": 0,
  "TMovFinanceiroBaixasAcrescimo": 0,
  "TMovFinanceiroBaixasTipoDocBx":0,
  "TMovFinanceiroBaixasContaBanc": 0,
  "TMovFinanceiroBaixasCodCaixa":0,
  }
]

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}

AUDITORIA/LOG

Consulta Auditoria/Logs

Este método permite consultar todos os registros de Auditoria/Logs.

HEADER:

Content-Type: application/json

BODY:

Parâmetro Tipo Descrição
Chave Character(50) Chave de acesso obtida pelo cliente
Seq_Apos Integer Valor inicial do intervalo do código sequencial do lançamento
Seq_Ate Integer Valor final do intervalo do código sequencial do lançamento
Dt_Apos DateTime Data inicial do intervalo da data da Auditoria/Log
Dt_Ate DateTime Data final do intervalo da data da Auditoria/Log
TableName Character(100) Identificação do nome da tabela
Action Varchar(40) Identificação da ação realizada na Auditoria/Log
NumPag Integer Número de paginação 
{
"Chave": "98QSlqIS1mMJimRzzorTiQ==",
"Seq_Apos": 0,
"Seq_Ate": 0,
"Dt_Apos": "2023/06/01 00:00:00",
"Dt_Ate": "2023/06/01 23:59:59",
"TableName": "TMovFinanceiroBaixas",
"Action": "Alterado",
"NumPag": 1
}


Então faça a requisição abaixo:

POST

/api_sgo/WSConsultaAuditoria



AuditId: Código sequencial do lançamento
AuditDate: Data do lançamento
AuditTableName: Nome da Tabela do lançamento
AuditDescription: Descrição do lançamento
AuditShortDescription: Descrição simplificada do lançamento
SecUserId: Id do Usuario do lançamento
AuditUsuario: Nome do usuario do lançamento
AuditAction: Ação realizada no lançamento 


							Resposta:
							
[
  {
 "AuditId": "335343",
"AuditDate": "2023-06-01T13:04:41",
"AuditTableName": "TMovFinanceiroBaixas",
"AuditDescription": ""Estorno de baixa de título INDIVIDUAL",
"AuditShortDescription": "",
"SecUserId": "0",
"AuditUsuario": "A F DA SILVA",
"AuditAction": "Alterado"
 }
]

ERROR:


Quando ocorre algum problema, a requisição retorna um status code 500 e uma mensagem descrevendo a razão do erro. 

{
"error":{
     "code":"500",
     "message":"Error"
    }
}