Integration Document - API SIGE Cloud

1. Introduction

The SIGE Cloud is an ERP for micro and small businesses that focuses on their continuous improvement.
features, always aiming at simplicity and productivity for their clients. Thus, for their clients
An Integration API was developed to integrate their legacy systems with SIGE Cloud.

2. Objective

This document aims to inform SIGE Cloud clients about the relevant technical data for integration.
your client module to the integration API provided by SIGE Cloud.

3.Scope

This document will objectively address the standards used during message exchange between the module.
client and the API, as well as expose the defined entities for this message exchange.

4. Of the Standards

Aiming for simplicity and productivity, the SIGE Cloud Integration API was developed using the concepts
RESTful(http://pt.wikipedia.org/wiki/REST)only using the HTTPS protocol for exchanging
mensagens entre o modulo cliente e API, com as mensagens trocadas obedecendo estrutura a JSON e encoding
UTF-8.
Date type fields must be in UTC format, like the following example:
2013-11-14T00:00:00-02:00

5. Authentication

To ensure the security and privacy of customer data for those who choose to use the SIGE Integration API
Cloud, in addition to providing consumable methods through the HTTPS protocol, defined ways to
authentication for the client, thus maintaining data privacy.
Para que esta autenticação seja possível noHeaderde cada requisição realizada pelo modulo do cliente a API de
Integration must include the following headers:

Authorization-Token: 123456789
[email protected]
App: xyz

It should be noted that the data presented above is fictitious, and the actual data for integration is
provided by the technical team of SIGE Cloud, and they must be requested from them, so that it is possible to
integration. To request this data, an email must be sent [email protected] send email
account administrator in SIGE Cloud regarding the subject 'Request for API SIGE Cloud authentication data.'
This data will be sent within 48 hours of the request.
6. Consumable Methods
Currently, the API provides the following list of methods:

Purpose HTTP Verb URL

Order Search GET http://api.sigecloud.com.br/request/pedidos/pesquisar

Order Registration POST http://api.sigecloud.com.br/request/pedidos/salvar

Movement Registration of POST http://api.sigecloud.com.br/request/produtosestoque/salvar

Stock
Registration/Change of People POST http://api.sigecloud.com.br/request/people/save

People Search GET http://api.sigecloud.com.br/request/people/search

Product Registration/Update POST http://api.sigecloud.com.br/request/produtos/salvar

Product Inquiry GET http://api.sigecloud.com.br/request/produtos/get

Product Research GET http://api.sigecloud.com.br/request/produtos/pesquisar

Product Inquiry GET http://api.sigecloud.com.br/request/products/ecommerce-search

Product Inquiry GET http://api.sigecloud.com.br/request/produtos/pesquisaecommercecoun
t
Product Inquiry GET http://api.sigecloud.com.br/request/produtos/todosecommerce

Product Inquiry GET http://api.sigecloud.com.br/request/produtos/todosecommercecount

Product Inquiry GET http://api.sigecloud.com.br/request/produtos/getbynomewebecommer
this
Consulta de Produtos GET http://api.sigecloud.com.br/request/produtos/getbycodigoecommercec
ount
Product Inquiry GET http://api.sigecloud.com.br/request/produtos/produtosrelacionadoseco
e-commerce
ZIP code search GET http://api.sigecloud.com.br/request/cep/get

Settings Registration GET http://api.sigecloud.com.br/request/configuracoes/get

Freight Calculation POST http://api.sigecloud.com.br/request/freightcalculation/calculate

Brand Inquiry GET http://api.sigecloud.com.br/request/marcas/get

Category Inquiry GET http://api.sigecloud.com.br/request/categoria/get

Banner Inquiry GET http://api.sigecloud.com.br/request/banners/getidsbytipo

Banner Inquiry GET http://api.sigecloud.com.br/request/banners/allbytipo

Banner Inquiry GET http://api.sigecloud.com.br/request/banners/getbyid

Banner Inquiry GET http://api.sigecloud.com.br/request/banners/getimagembyid

Product Image Inquiry GET http://api.sigecloud.com.br/request/produtosfotos/getimagemprincipal

byproduct
 Product Image Inquiry GET http://api.sigecloud.com.br/request/produtosfotos/getimagenslbyprod
uto
Product Image Inquiry GET http://api.sigecloud.com.br/request/produtosfotos/getimagem

7.Description of Consumable Methods

7.1 Order Search - /orders/search

This method is intended solely for querying orders registered in SIGE Cloud, and they must
GET requests should be made through the client module to the Integration API.
To facilitate the query, filtering parameters for the research results have been defined, these are
the available parameters:

Parameter Description
code Order code
origin Origin of the request
status Order status
customer Name/Corporate Name of the client related to the order
pagesize Maximum number of results returned per page
skip Number of result pages to be skipped

These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/pedidos/pesquisar?codigo=0&origem=&status=&categoria=&cliente=&pageSize=10&sk
ip=0

7.2 Order Registration - /orders/Save or /orders/SaveAndInvoice

This method is intended for the registration and alteration of orders in SIGE Cloud, and they must be made
POST requests through the client module to the Integration API.

It is worth noting that the change is made when a request containing is sent to the Integration API.
an order with the code already existing in a registered order in SIGE Cloud, given that the order
existing in SIGE Cloud is overwritten by the new request sent to the Integration API.

For the registration/change of orders, it must be sent by the client's module in the request body to
seguinte entidade no formato json:

Order Entity
Field of the Entity Data Type Description
Code int Order code to be assumed by the system
SaleOrigin string Origin of the sale
Deposit string Name of the deposit from which the products for sale will be
retired
SystemStatus string Standard status of the system for the orders being that
the following options must be respected:
Orçamento, Pedido, Pedido Não Faturado, Pedido
Billed, Order Cancelled
Status string User-defined status
Category string Sales category. It must be pre-established.
registered in the system.
Validity date Expiration date of the Order/Quotation
Company string Name of the company responsible for the sale
Client string Customer name related to sale
ClienteCNPJ string Client CNPJ related to the sale and used as
attribute of linkage with clients and suppliers already
registered in the system
Seller string Seller's name related to the sale
LaunchSellerCommission boolean Indicate the seller's commission related to the items
the order will be recorded in the finance when saving the
order
Chart of Accounts string Sales account plan, which must be
previously registered in the system
FormaPagamento string The chosen payment method must be
previously registered.
NumeroParcelas string Number of Installments in which it will be made the
payment
Carrier string Name of the person responsible for transporting the goods.
ShippingMethod string Product Shipping Format
Shipping Data date Shipping date of the merchandise
Delivery Forecast date Delivery forecast date
PostingDate date Posting date
Sent boolean Find out if the goods have been shipped.
Freight Value double Freight Value
Sender Freight Charge boolean Indicate if the shipping cost is borne by the sender.
TrackingCode string Delivery tracking code
SafeValue double Insurance Value
Description string Description and comments related to the order.
Other Expenses double Other expenses that must be added to the amount
end of the order
CardTransaction string Card Transaction Code (TID)
ValorFinal double Final Order Value
Completed boolean Finalized order cannot be altered.
Launched boolean Order already placed by finance
Municipality string DELIVERY DATA: name of the municipality.
Municipality Code string DELIVERY DATA: municipality code.
Country string DADOS DE ENTREGA: Nome do pais.
ZIP Code string DADOS DE ENTREGA: CEP 99999-999.
UF string DELIVERY DATA: STATE
UFC code string DADOS DE ENTREGA: Código UF
Neighborhood string DADOS DE ENTREGA: Nome do Bairro
Street string DADOS DE ENTREGA: Logradouro
Street Number string DELIVERY DATA: Street Number
LogradouroComplemento string DADOS DE ENTREGA: Complemento
Items OrderProduct[ ] Array of typeProductOrdercontaining the products
of the order

OrderProduct Entity
Entity Field Data Type Descrição
Code string Product Code
Unit string Unit of Measure
Description string Description
Quantity double Quantity
ValorUnitario double Unit Selling Price
ValorFrete double Total Discount
UnitDiscount double Unit Selling Discount
Total Discount double Total Discount
SalesCommission double The percentage of commission that the seller receives on
this item
Weight in KG double Weight in KG
Length double Length
Height double Height
Width double Width
FreeShipping boolean Indicate if the shipping is free
FreightUnitValue double Unit Value of Freight
DeliveryDeadlineShipping int Delivery Time in days

Exemplo das entidades na estrutura json :

{"Codigo":169,
"OrigemVenda":"Venda Direta",
"Deposito":"Tupandi",
"StatusSistema":"Orçamento",
"Status":"",
"Categoria":"",
"Validade":"2013-11-14T00:00:00-02:00",
"Empresa":"Creative Mais",
"Cliente":"Venda do Diego",
"Vendedor":"[email protected]",
"LancarComissaoVendedor":true,
"PlanoDeConta":"",
"FormaPagamento":"",
"NumeroParcelas":0,
"Transportadora":"",
"DataEnvio":"0001-01-01T00:00:00-02:00",
"Enviado":false,
"ValorFrete":0.0,
"FreteContaEmitente":false,
"ValorSeguro":0.0,
"Descricao":"",
"OutrasDespesas":0.0,
"ValorFinal":1532.65,
"Finalizado":false,
"Lancado":false,
"Municipio":"Bom Princípio",
"CodigoMunicipio":"4302352",
"Pais":"Brasil",
"CEP":"95765000",
"UF":"RS",
"UFCodigo":"43",
"Bairro":"",
"Logradouro":"Rua Mambuí",
"LogradouroNumero":"951",
"LogradouroComplemento":"Casa ",
"Items":[
{"Codigo":"41",
"Unidade":"",
"Descricao":"SERVIÇOS GERAIS",
 "Quantidade":1.0,
"ValorUnitario":10.0,
"DescontoUnitario":0.0,
"ValorTotal":10.0},
{"Codigo":"12",
"Unidade":"",
"Descricao":"WEB CAN",
"Quantidade":15.0,
"ValorUnitario":101.51,
"DescontoUnitario":0.0,
"ComissaoVendedor":10.0,
"ValorTotal":1522.65}]}

The Integration API performs several validations on the received data, and if the data sent
if they are not validated, the Integration API will return a message informing of the lack of success in
modification/inclusion operation with the description of the validation error that occurred.

7.3 Stock Movement Registration - /productsstock/save

This method is intended only for the registration of inventory movements in SIGE Cloud.
POST requests must be made through the client module to the Integration API.

For registering inventory movements, it must be sent by the client module without body.
requisição a seguinte entidade no formato json:

Entity StockMovement
Field of the Entity Data Type Description
ProductCode int Product code in the system
DepositoNome string Name of the deposit where the operation is to be carried out
Quantity double Quantity of products to be credited or debited from
stock
EhEntry boolean Indicate whether the operation is an entry or exit from stock

Exemplo da entidade na estrutura json :

{"ProdutoCodigo":"001",
"DepositoNome":"Geral",
"Quantidade":1.0,
"EhEntrada":true}

7.4 Registration/Modification of People - /people/save

This method is intended for the registration and modification of clients/suppliers in SIGE Cloud, and they must
POST requests must be made through the client module to the Integration API.

It is important to note that the change is made when a request containing is sent to the Integration API.
a person with an existing CPF/CNPJ already registered in a person in SIGE Cloud, provided that the person
existing in SIGE Cloud is overwritten by the new person sent to the Integration API.
 For the registration/change of people, it must be sent by the client module in the body of the request to
seguinte entidade no formato json:

Entity Person
Field of the Entity Data Type Description
IndividualPerson boolean Indicate whether the person is an individual or legal entity.

Fictional Name string Name or trade name of the person

CompanyName string The corporate name of the person if they are a legal entity

CNPJ_CPF string Indicate whether the operation is an entry or exit from the stock.

RG string RG, only for individuals

IE string State Registration

Street string Street. Ex.: Av. Brasil

Street Number string Street Number

Complement string Supplement

Neighborhood string Neighborhood

City string Municipality/City

Municipality Code string IBGE Municipality Code

Country string Country

CountryCode string IBGE Country Code

ZIP Code string ZIP Code

UF string UF

StateCode string IBGE UF Code

Telephone string Telephone

Cell phone string Cell phone

Email string Email

Client boolean Indicate if the person is a customer

Technician boolean Indicate if the person is a technician

Seller boolean Indicate if the person is a seller.

Carrier boolean Indicate if the person is a carrier

Supplier boolean Indicate if the person is a supplier

Represented boolean Acts as represented (EXCLUSIVE FOR CASES)
SALES BY REPRESENTATION
Branch string Field of Operation

StandardSeller string Standard Seller - (Responsible for the account)

FatherName string Father's name

Mother's Name string Mother's name

Birthplace string Naturalness

ValorMinimoCompra double Minimum purchase value

DataNascimento date Date of birth

Exemplo da entidade na estrutura json :

{"ID":"526fa0c9e955158bb0325578",
"PessoaFisica":false,
"NomeFantasia":"Eletro Peças Vargas",
"RazaoSocial":"Arinda Borges Vargas Me",
"CNPJ_CPF":"1468601000196",
"RG":"",
"IE":"85766406",
"Logradouro":"RUA BUARQUE DE NAZARETH",
"LogradouroNumero":"434",
"Complemento":"",
"Bairro":"",
"Cidade":"ITAPERUNA",
"CodigoMunicipio":"3302205",
"Pais":"BR",
"CodigoPais":"1058",
"CEP":"28300000",
"UF":"RJ",
"CodigoUF":" ",
"Telefone":"(22) 3824-3827",
"Celular":null,
"Email":"[email protected]",
"Site":" ",
"Cliente":true,
"Tecnico":false,
"Vendedor":false,
"Transportadora":false,
"Fonecedor":false,
"Representada":false,
"Ramo":"Nenhum",
"VendedorPadrao":" ",
"NomePai":" ",
"NomeMae":" ",
"Naturalidade":" ",
"ValorMinimoCompra":0.0,
"DataNascimento":"0001-01-01T00:00:00-02:00" }
7.5 People Search - /people/search

This method is intended solely for querying registered individuals in the SIGE Cloud, and they must
GET requests should be made through the client module to the Integration API.

To facilitate the consultation, filtering parameters for the research results have been defined, which are
the available parameters:

Parameter Description
fantasy name Name/Fantasy name of the person
cpfcnpj CPF/CNPJ of the person
city City
uf UF
client Indicate whether the filtering should consider only clients.
supplier Indicate if the filtering should consider only
suppliers
pagesize Maximum number of results returned per page
skip Number of result pages to be 'skipped'

These parameters should be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/pessoas/pesquisar?nomefantasia=&cpfcnpj=&cidade=&uf=&cliente=false&fornecedor=
false&pageSize=10&skip=0

7.6 Registration/Change of Products - /products/save

Este método destinasse ao cadastro e alteração de produtos no SIGE Cloud sendo que devem ser feitas
POST requests through the client module to the Integration API.

For the registration/update of individuals, it must be sent by the client module in the body of the request.
seguinte entidade no formato json:

Product Entity
Field of the Entity Data Type Description
Category string Indicate the product category. It must be previously
registered
Brand string Product brand. Must be pre-registered.
Supplier string Product supplier

Code string Indicate the product code provided by the customer

Bookshelf string Indicate on which shelf the product is located

NumeroSerie string Indicate the product serial number

Name string Product name

Gender string Product type. E.g., Merchandise for resale. Must

being previously registered
EstoqueUnidade string Indicate the unit of stock for the product. Ex: kg, m²
box, etc. Must be registered in advance
Specification string Provide additional product information

Weight in KG double Product weight, according to its unit.

Cost Price double Cost price of the product

ProfitMoney double Profit in cash over the value of the product

LucroPercentual double Percentage of profit on the product price

Sales Price double Selling price of the product

PrecoMinimoVenda double Minimum selling price of the product

StockRisk double

StandardDeposit double Indicate the standard product deposit

StockBalance double Indicate the product stock balance

NCM string NCM code of the product

Tax Group string Indicate the tax group of the product.

TaxGender string Indicate the product gender. Ex: Merchandise for

Revenda, Produto Acabado, Matéria-prima, etc
Standard CFOP string Indicate the CFOP code of the product

Taxable Unit string Indicate the taxable unit of the product. Ex: UN, Kg, m,...

Origin of Goods int Indicate the origin of the product. Ex: 00–National, 01–
Foreign - Direct import, 03 - Foreign -
Acquired in the Domestic Market
VisibleSite boolean Indicate whether the product should be displayed on the website or not

HighlightSite boolean Indicate whether the product should be Featured on the website or not.

IgnoreStock boolean Ignore the product stock shortage

FreeShipping boolean Indicate whether the shipping for the product is free or not.

Active boolean Indicate whether the product is active or not.

CategoryFilters string Filters by category in e-commerce

PercentualDescontoBoleto double Indicate the percentage of discount on the purchase of products

no invoice
Length double Length measurement of the product

Height double Product height measurement

Width double Product width measurement

Exemplo da entidade na estrutura json :

{"ID":"8276fa0c9e955158ff4425556",
"Categoria":"Camisetas"
"Marca":"Adidas",
"Fornecedor":"RR Confeccao LTDA",
"Codigo ":"146896",
"Pratileira":"9B",
"NumeroSerie":"806",
"Nome":"Camiseta Adidas Fit",
"Genero":"01- Mercadoria para Revenda",
"EstoqueUnidade":"UN",
"Especificacao":"",
"PesoKG":0.1
"PrecoCusto":45.00,
"LucroDinheiro":"9.00,
"LucroPercentual":"0.2",
"PrecoVenda":54.00
"PrecoMinimoVenda":52.00,
"EstoqueRisco":0.0,
"DepositoPadrao":Deposito1,
"EstoqueSaldo":52.0,
"NCM": 6106.10.00
"GrupoTributario":"Comercializacao",
"GeneroFiscal":"",
"CFOPPadrao":"5102",
"UnidadeTributavel":"UN",
"OrigemMercadoria":00 - Nacional,
"VisivelSite":false,
"DestaqueSite":false,
"IgnorarEstoque":true,
"FreteGratis":false,
"Ativo":true,
"FiltrosCategoria":" ",
"PercentualDescontoBoleto":0.05,
"Comprimento":null,
"Altura":null
"Largura":null }

7.7 Product Inquiry - /products/get

This method is exclusively intended for querying SIGE Cloud products, returning an entity.
Product, with GET requests to be made through the client module to the API of
Integration.

To facilitate the search, filtering parameters for the results have been defined as follows
the available parameters:

Parameter Descrição
code Product code
 These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/produtos/get?codigo=seucodigo

7.8 Product Search - /products/search

This method is exclusively intended for researching products registered in SIGE Cloud, returning
a list of Product entity, with GET requests to be made through the client module
for the Integration API.

To facilitate the research, filtering parameters for the results have been defined, which are
the available parameters:

Parameter Description
code Product code
serialNumber Product serial number
name Product name
genre Indicate the gender of the product
category Indicate if the filtering should consider only the category
of the product
brand Indicate if the filtering should consider only the brand of the
product
pagesize Maximum number of results returned per page
skip Number of result pages to be 'skipped'

These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/products/search?code=&serialNumber=&name=&gender=&category=false&brand
a=false&pageSize=10&skip=0

7.9 Product Inquiry - /products/ecommerce_search

This method is exclusively intended for querying products from the E-commerce in SIGE Cloud, returning
a list of Product entity, with GET requests to be made through the client module
for the Integration API.

To facilitate the consultation, filtering parameters for the search results have been defined, namely
the available parameters:

Parameter Description
research Product name to be searched
category Product category in E-commerce
brand Product brand in E-commerce
pagesize Maximum number of results returned per page
skip Number of result pages to be "skipped"

These parameters must be sent in the form of a query string as in the following example:
 http://api.sigecloud.com.br/request/produtos/pesquisaecommerce?pesquisa=&categoria=false&marca=false&pageSize=10
&skip=0

7.10 Product Inquiry - /products/ecommercecountsearch

This method is exclusively intended for consulting products from E-commerce in SIGE Cloud, returning
the calculation of products, noting that GET requests must be made through the client module to the API
of Integration.

To facilitate the query, filtering parameters for the search were defined, namely
the available parameters:

Parameter Description
research Product name to be searched
category Product category in E-commerce
brand Product brand in E-commerce

These parameters must be sent in the form of a query string as in the following example:

https://api.sigecloud.com.br/request/produtos/pesquisaecommercecount?pesquisa=&categoria=false&marca=false

7.11 Product Consultation - /products/ allecommerce

This method is intended exclusively for querying products from E-commerce in SIGE Cloud, returning
a list of Product entity, with GET requests to be made through the client module
for the Integration API.

To facilitate the consultation, filtering parameters for the search results have been defined, which are
the available parameters:

Parameter Description
pagesize Maximum number of results returned per page
skip Number of result pages to be 'skipped'

These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/produtos/todosecommerce?pagesize=10&skip=0

7.12 Product Query - /products/ all e-commerce count

This method is exclusively intended for querying e-commerce products in SIGE Cloud, returning
the calculation of the product lists, which should be made through GET requests using the client module
for the Integration API.

Estes parâmetros devem ser enviados na forma de query string como no seguinte exemplo:

http://api.sigecloud.com.br/request/produtos/todosecommercecount
7.13 Product Consultation - /products/getbynomewebecommrece

This method is exclusively intended for querying E-commerce products in SIGE Cloud, returning
a Product entity, where GET requests must be made through the client module to the
Integration API.

To facilitate the consultation, filtering parameters for the research results have been defined, which are
the available parameters:

Parameter Description
web name Nome Web do produto

These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/produtos/getbynomewebecommerce?nomeweb=seunomeweb

7.14 Product Inquiry - /products/getbycodigoecommrece

This method is intended exclusively for querying E-commerce products in SIGE Cloud, returning
a product entity, with requests being made via GET through the client module to the
Integration API.

To facilitate the inquiry, filtering parameters for the research results have been defined, which are
the available parameters:

Parameter Description
code Product code

These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/produtos/getbynomewebecommerce?codigo=seucodigo

7.15 Product Inquiry - /products/ relatedproducts e-commerce

This method is exclusively intended for querying E-commerce products in SIGE Cloud, returning
a list of Product entity, with GET requests to be made through the client module
for the Integration API.

To facilitate the consultation, filtering parameters for the search results have been defined, namely
the available parameters:

Parameter Description
category Product category in E-commerce
marca Brand of the product in E-commerce
quantity Quantity of product in E-commerce

These parameters must be sent in the form of a query string as in the following example:
 http://api.sigecloud.com.br/request/produtos/produtosrelacionadosecommerce?categoria=suacategoria&&marca=suamarc
a&&quantity=4

7.16 ZIP Code Inquiry - /cep/get

Este método destinasse exclusivamente à consulta de CEP no SIGE Cloud, retornando uma entidade CEP,
as GET requests must be made through the client module to the Integration API.

To facilitate the consultation, filtering parameters for the search results have been defined, namely
the available parameters:

Parameter Description
ZIP Code Postal code number

Entity ZIP Code

Field of the Entity Data Type Description
Postal Code Number string Corresponding ZIP code number
Neighborhood string Neighborhood of the city with the corresponding ZIP code

MunicipalityCode string Municipality code of the corresponding ZIP code

MunicipioNome string Name of the municipality corresponding to the ZIP code

State Name string Name of the State of the corresponding ZIP code
StateUF string State abbreviation of the corresponding postal code

StateCodeUF string State code of the corresponding ZIP code

These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/cep/get?cep=seuCEPaqui

7.17 Configuration Consultation - /settings/get

This method is exclusively intended for consulting the E-Commerce settings in SIGE Cloud.
returning a Configuration entity, and GET requests must be made through the module of
client for the Integration API.

Entity Configuration
Field of the Entity Data Type Description
EcommerceStandardCompany string Define the standard e-commerce company.
EcommerceStandardDeposit string Define the standard deposit of E- products
commerce
EcommerceStandardPriceTable string Define the standard price table of
products in e-commerce
EcommerceInstallmentsCard int Define the number of installments made with
card in product sales on E-commerce
EcommerceIgnoreShippingValueAbove double Ignore the shipping cost when the value exceeds
established value
EcommerceValorMinimo double Minimum sale value of orders within the
 E-commerce

These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/configuracao/get

7.18 Freight Calculation - /freightcalculation/calculate

This method is intended for calculating the freight for product sales in SIGE Cloud, sending an entity.
Order, calculating the shipping cost of the products and returning a list of OrderProduct entities, being
POST requests must be made through the client module to the Integration API.

7.19 Brand Inquiry - /brand/get

This method is intended for querying product brands in SIGE Cloud, returning an array of entities.
ProductBrand, and GET requests should be made through the client module to the API of
Integration.

Entity ProductBrand
Field of the Entity Data Type Description
Name string Define the brand name of the product

These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/marca/get

7.20 Category Query - /category/get

This method is exclusively intended for querying product categories in SIGE Cloud, returning
an array of Category entities, with GET requests to be made through the client module
for the Integration API.

Entity ProductCategory
Field of the Entity Type of Data Description
Hierarchy string Define the hierarchical code of the category
Name string Define the name of the category
Description string

These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/categoria/get
7.21 Banner Consultation - /banners/getidsbytipo

This method is intended exclusively for querying banners from E-commerce in SIGE Cloud, returning
an array of strings containing the IDs of the banners of the given type, where requests must be made
GET through the client module for the Integration API.

To facilitate the consultation, filtering parameters for the results of the research have been defined, namely
the available parameters:

Parameter Description
type Define the exact size of the E-commerce banner

These parameters should be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/banners/getidsbytipo?tipo=seutipo

7.22Consulta de Banners - /banners/allbytipo

This method is exclusively intended for querying E-commerce banners in SIGE Cloud, returning
an array of Banner entities, where GET requests must be made through the client module
for the Integration API.

To facilitate the consultation, filtering parameters for the search results have been defined, namely
the available parameters:

Parameter Description
type Define the exact size of the E-commerce banner

Banner Entity
Field of the Entity Data Type Description
Name string Define the banner name in E-commerce
Type string Define the exact size in pixels of the banner
do E-commerce
Link string Define the destination URL of the banner when clicked
no E-commerce

These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/banners/allbytipo?tipo=seutipo

7.23 Banner Inquiry - /banners/getimagembyid

This method is exclusively intended for querying E-commerce banners in SIGE Cloud, returning
a Banner entity, where GET requests must be made through the client module to the API
of Integration.
 To facilitate the consultation, filtering parameters for the search results have been defined, namely
the available parameters:

Parameter Description
id Define the banner ID of the E-commerce

These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/banners/getimagembyid?id=seuid

7.24 Banner Consultation - /banners/getbyid

This method is exclusively intended for querying E-commerce banners in SIGE Cloud, returning
an array of bytes containing the Banner image, where GET requests must be made through
client module for the Integration API.

To facilitate consultation, filtering parameters for the search results have been defined, being these
the available parameters:

Parameter Description
id Define the banner ID of the E-commerce

These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/banners/getbyid?id=seuid

7.25 Product Photos Query - /produtosfotos/ getmainimagebyproduct

This method is intended exclusively for consulting the main photo of products in SIGE Cloud.
returning a ProductPhoto entity, with GET requests to be made through the module of
client for the Integration API.

To facilitate the consultation, filtering parameters for the search results have been defined, namely
the available parameters:

Parameter Description
codigoProduto Product code in SIGE Cloud

ProductPhoto Entity
Field of the Entity Tipo de Dado Description
Id string Image identity code
Principal boolean Define whether this image is or is not the image.
main product
 These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/produtosfotos/getimagemprincipalbyproduto?codigoproduto=seucodigoproduto

7.26 Product Photos Query - /produtosfotos/getimagensbyproduto

This method is intended exclusively for viewing product photos in SIGE Cloud, returning a
list of entity ProductPhoto, with GET requests to be made through the client module
for the Integration API.

To facilitate the consultation, filtering parameters for the research results have been defined, namely
the available parameters:

Parameter Description
codigoProduto Product code in SIGE Cloud

These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/produtosfotos/getimagensbyproduto?codigoproduto=yourproductcode

7.27 Product Photo Consultation - /produtosfotos/getimagem

This method is intended solely for consulting the product photos in SIGE Cloud, returning a
byte array determines whether the image is a thumbnail or not, and GET requests must be made through the
client module for the Integration API.

To facilitate the consultation, filtering parameters for the search results have been defined, namely these
the available parameters:

Parameter Description
imageId Image ID in E-commerce
thumbnail Determine whether the image is a thumbnail or not

These parameters must be sent in the form of a query string as in the following example:

http://api.sigecloud.com.br/request/produtosfotos/getimagem?imagemId=seuimagemId&&miniatura=true

8. Final Remarks

For doubts or technical questions about the SIGE Cloud Integration API, emails should be sent to
[email protected] com o assunto “Duvida API SIGE Cloud”.