Stores

List GET

Example with mandatory parameters

<?php
$url     = 'https://www.vendus.pt/ws/v1.1/stores/';
$apiKey  = 'c433ff57a5ba6cdf301a48c97d9432594e35e73ce545945639bc4fb5798f1e8a';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $apiKey);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($curl);
?>

Example with all allowed parameters

<?php
$url     = 'https://www.vendus.pt/ws/v1.1/stores/';
$apiKey  = 'c433ff57a5ba6cdf301a48c97d9432594e35e73ce545945639bc4fb5798f1e8a';
$method  = 'GET';
$params  = array(
    'type' => 'store', 

);
$url .= '?' . http_build_query($params);
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $apiKey);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
$result = curl_exec($curl);
?>

Request

Name	Type	Example	Description
type	string all, store, warehouse	Type

Response

Name	Type	Example	Description
id	int		Store ID
type	string store, warehouse		Type
title	string	Loja da Baixa	Title
tax_id	string `NOR` - Taxa Normal `INT` - Taxa Intermédia `RED` - Taxa Reduzida `ISE` - Isento `OUT` - Outros		Default tax rate
tax_exemption	string `M01` - Artigo 16.º, n.º 6 do CIVA ou similar `M02` - Artigo 6.º do Decreto-Lei n.º 198/90, de 19 de Junho `M03` - Exigibilidade de caixa `M04` - Artigo 13.º do CIVA ou similar `M05` - Artigo 14.º do CIVA ou similar `M06` - Artigo 15.º do CIVA ou similar `M07` - Artigo 9.º do CIVA ou similar `M08` - IVA - autoliquidação `M09` - IVA - não confere direito a dedução `M10` - IVA - Regime de isenção (Artigo 53.º do CIVA) `M11` - Regime particular do tabaco `M12` - Regime da margem de lucro - Agências de viagens `M13` - Regime da margem de lucro - Bens em segunda mão `M14` - Regime da margem de lucro - Objetos de arte `M15` - Regime da margem de lucro - Objetos de coleção e antiguidades `M16` - Artigo 14.º do RITI ou similar `M99` - Não sujeito; não tributado ou similar		Tax exemption reason
tax_exemption_law	string	Some law	Tax exemption applicable law
address	string	Rua Nova de Mil Fontes, 35	Address
postalcode	string	1100-234	Postal Code
city	string	Setúbal	City/Locality
country	string	PT	Country
email	string	loja.baixa@empresa.pt	Email
phone	string	210192029	Phone
status	string on, off		Status
cae	string	76290	CAE
share_stock_store_id	int	Uses Own Stock (0) or Other Store Stock (Store ID)	Stock Configuration
sync_pos	string	YES\|NO - if Store`s POS are linked	POS Sincronization
sync_pos_ping	string	YES\|NO - if Store`s POS are linked with ping socket method	POS Sincronization behavior

Detail GET

Example with mandatory parameters

<?php
$url     = 'https://www.vendus.pt/ws/v1.1/stores/12345/';
$apiKey  = 'c433ff57a5ba6cdf301a48c97d9432594e35e73ce545945639bc4fb5798f1e8a';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $apiKey);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($curl);
?>

Example with all allowed parameters

<?php
$url     = 'https://www.vendus.pt/ws/v1.1/stores/12345/';
$apiKey  = 'c433ff57a5ba6cdf301a48c97d9432594e35e73ce545945639bc4fb5798f1e8a';
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, $apiKey);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($curl);
?>

Request

Response

Name	Type	Example	Description
id	int		Store ID
type	string store, warehouse		Type
title	string	Loja da Baixa	Title
tax_id	string `NOR` - Taxa Normal `INT` - Taxa Intermédia `RED` - Taxa Reduzida `ISE` - Isento `OUT` - Outros		Default tax rate
tax_exemption	string `M01` - Artigo 16.º, n.º 6 do CIVA ou similar `M02` - Artigo 6.º do Decreto-Lei n.º 198/90, de 19 de Junho `M03` - Exigibilidade de caixa `M04` - Artigo 13.º do CIVA ou similar `M05` - Artigo 14.º do CIVA ou similar `M06` - Artigo 15.º do CIVA ou similar `M07` - Artigo 9.º do CIVA ou similar `M08` - IVA - autoliquidação `M09` - IVA - não confere direito a dedução `M10` - IVA - Regime de isenção (Artigo 53.º do CIVA) `M11` - Regime particular do tabaco `M12` - Regime da margem de lucro - Agências de viagens `M13` - Regime da margem de lucro - Bens em segunda mão `M14` - Regime da margem de lucro - Objetos de arte `M15` - Regime da margem de lucro - Objetos de coleção e antiguidades `M16` - Artigo 14.º do RITI ou similar `M99` - Não sujeito; não tributado ou similar		Tax exemption reason
tax_exemption_law	string	Some law	Tax exemption applicable law
address	string	Rua Nova de Mil Fontes, 35	Address
postalcode	string	1100-234	Postal Code
city	string	Setúbal	City/Locality
country	string	PT	Country
email	string	loja.baixa@empresa.pt	Email
phone	string	210192029	Phone
status	string on, off		Status
cae	string	76290	CAE
share_stock_store_id	int	Uses Own Stock (0) or Other Store Stock (Store ID)	Stock Configuration
sync_pos	string	YES\|NO - if Store`s POS are linked	POS Sincronization
sync_pos_ping	string	YES\|NO - if Store`s POS are linked with ping socket method	POS Sincronization behavior

API (v1.1)

List GET

Example with mandatory parameters

Example with all allowed parameters

Request

Response

Detail GET

Example with mandatory parameters

Example with all allowed parameters

Request

Response