Documentação oficial da API Orima. Todos os exemplos apresentados utilizam dados genéricos.
A API da Orima permite a integração direta com os sistemas internos, disponibilizando acesso a informação de produtos, stocks e funcionalidades de envio de encomendas. Esta API foi concebida para ser utilizada por aplicações externas, como plataformas de e-commerce, sistemas de gestão ou integrações personalizadas.
Todos os endpoints apresentados nesta documentação seguem uma estrutura consistente e requerem autenticação através de credenciais válidas. Por razões de segurança, recomenda-se a utilização de credenciais dedicadas exclusivamente à API, evitando o uso da conta principal.
A comunicação com a API é realizada através de pedidos HTTP, sendo possível obter os dados em diferentes formatos, nomeadamente:
O formato de resposta é definido diretamente no endpoint através dos parâmetros fornecidos em cada pedido.
Ao longo desta documentação, a sequência orima:// representa o endereço base da API: https://www.orima.pt/api/
Cada endpoint inclui a descrição do seu funcionamento, parâmetros necessários e exemplos de resposta, permitindo uma integração rápida e direta.
Descrição: Verifica o estado da API, com autenticação obrigatória.
Endpoint:
orima://v2/status/id/{id_orima}/token/{token}/mode/{mode}
Parâmetros:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id_orima | integer | Sim | ID do cliente |
| token | string | Sim | Token de acesso à API |
| mode | string | Não | Formato da resposta: boolean, xml ou json |
Notas:
$url = "https://www.orima.pt/api/v2/status/id/123/token/API_KEY/mode/json";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/v2/status/id/123/token/API_KEY/mode/xml";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/v2/status/id/123/token/API_KEY";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/v2/status/id/123/token/API_KEY/mode/json"
response = requests.get(url)
print(response.json())
import requests
url = "https://www.orima.pt/api/v2/status/id/123/token/API_KEY/mode/xml"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/v2/status/id/123/token/API_KEY"
response = requests.get(url)
print(response.text)
{
"ok": true,
"timestamp": "20260418153000",
"api_info": {
"version": "2.0",
"developer": "viktr software"
},
"api": {
"status": {
"boolean": "true",
"text": "activo",
"integer": "1"
}
}
}
<response>
<ok>true</ok>
<timestamp>20260418153000</timestamp>
<api_info>
<version>2.0</version>
<developer>viktr software</developer>
</api_info>
<api>
<status>
<boolean>true</boolean>
<text>activo</text>
<integer>1</integer>
</status>
</api>
</response>
1
Descrição: Devolve a estrutura completa de famílias (gamma → family → category).
Endpoint:
orima://v2/list/families/id/{id_orima}/token/{token}/filetype/{filetype}
Parâmetros:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id_orima | integer | Sim | ID do cliente |
| token | string | Sim | Token de acesso à API |
| mode | string | Não | Formato da resposta: boolean, xml ou json |
Notas:
$url = "https://www.orima.pt/api/v2/list/families/id/123/token/API_KEY/filetype/json";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/v2/list/families/id/123/token/API_KEY/filetype/xml";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/v2/list/families/id/123/token/API_KEY/filetype/csv";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/v2/list/families/id/123/token/API_KEY/filetype/json"
response = requests.get(url)
print(response.json())
import requests
url = "https://www.orima.pt/api/v2/list/families/id/123/token/API_KEY/filetype/xml"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/v2/list/families/id/123/token/API_KEY/filetype/csv"
response = requests.get(url)
print(response.text)
{
"ok": true,
"timestamp": "20260418153000",
"api_info": {
"version": "2.0",
"developer": "viktr software"
},
"families": [
{
"family": {
"id": 1,
"gamma": "Cozinha",
"family": "Forno",
"category": "Encastre"
}
}
]
}
<response>
<ok>true</ok>
<timestamp>20260418153000</timestamp>
<api_info>
<version>2.0</version>
<developer>viktr software</developer>
</api_info>
<families>
<family>
<id>1</id>
<gamma>Cozinha</gamma>
<family>Forno</family>
<category>Encastre</category>
</family>
</families>
</response>
id;gamma;family;category
1;Cozinha;Forno;Encastre
Descrição: Devolve a lista de todas as marcas disponíveis.
Endpoint:
orima://v2/list/brands/id/{id_orima}/token/{token}/filetype/{filetype}
Parâmetros:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id_orima | integer | Sim | ID do cliente |
| token | string | Sim | Token de acesso à API |
| mode | string | Não | Formato da resposta: boolean, xml ou json |
Notas:
$url = "https://www.orima.pt/api/v2/list/brands/id/123/token/API_KEY/filetype/json";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/v2/list/brands/id/123/token/API_KEY/filetype/xml";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/v2/list/brands/id/123/token/API_KEY/filetype/csv";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/v2/list/brands/id/123/token/API_KEY/filetype/json"
response = requests.get(url)
print(response.json())
import requests
url = "https://www.orima.pt/api/v2/list/brands/id/123/token/API_KEY/filetype/xml"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/v2/list/brands/id/123/token/API_KEY/filetype/csv"
response = requests.get(url)
print(response.text)
{
"ok": true,
"timestamp": "20260418153000",
"api_info": {
"version": "2.0",
"developer": "viktr software"
},
"brands": [
{
"brand": {
"id": 1,
"brand": "Orima"
}
}
]
}
<response>
<ok>true</ok>
<timestamp>20260418153000</timestamp>
<api_info>
<version>2.0</version>
<developer>viktr software</developer>
</api_info>
<brands>
<brand_info>
<id>1</id>
<brand>Orima</brand>
</brand_info>
</brands>
</response>
id;brand
1;Orima
Descrição: Devolve a lista de produtos de uma marca específica, incluindo preços e dados completos.
Endpoint:
orima://v2/brand/id/{id_orima}/token/{token}/brand/{brand}/filetype/{filetype}
Parâmetros:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id_orima | integer | Sim | ID do cliente |
| token | string | Sim | Token de acesso |
| brand | integer | Sim | ID da marca |
| filetype | string | Sim | Formato da resposta: json, xml ou csv |
Notas:
$url = "https://www.orima.pt/api/v2/brand/id/123/token/API_KEY/brand/5/filetype/json";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/v2/brand/id/123/token/API_KEY/brand/5/filetype/xml";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/v2/brand/id/123/token/API_KEY/brand/5/filetype/csv";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/v2/brand/id/123/token/API_KEY/brand/5/filetype/json"
response = requests.get(url)
print(response.json())
import requests
url = "https://www.orima.pt/api/v2/brand/id/123/token/API_KEY/brand/5/filetype/xml"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/v2/brand/id/123/token/API_KEY/brand/5/filetype/csv"
response = requests.get(url)
print(response.text)
{
"ok": true,
"timestamp": "20260418153000",
"api_info": {
"version": "2.0",
"developer": "viktr software"
},
"products": [
{
"product": {
"gamma": "Cozinha",
"family": "Forno",
"category": "Encastre",
"brand": "Orima",
"reference": "REF123",
"ean13": "5601234567890",
"stock_status": "2",
"description": "Forno elétrico",
"details": "Detalhes do produto",
"wholesale_price": "199,99",
"image": "https://...",
"energy_class_png": "https://...",
"energy_class_string": "A+",
"dimensions": "60x60x55",
"weight": "30",
"volume": "0.20",
"specs": "..."
}
}
]
}
<response>
<ok>true</ok>
<timestamp>20260418153000</timestamp>
<api_info>
<version>2.0</version>
<developer>viktr software</developer>
</api_info>
<products>
<product>
<ean13>5601234567890</ean13>
<gamma><![CDATA[Cozinha]]></gamma>
<family><![CDATA[Forno]]></family>
<brand><![CDATA[Orima]]></brand>
<category><![CDATA[Encastre]]></category>
<reference>REF123</reference>
<stock>2</stock>
<description><![CDATA[Forno elétrico]]></description>
<details><![CDATA[Detalhes do produto]]></details>
<price>199,99</price>
<image>https://...</image>
<energy_class_png>https://...</energy_class_png>
<energy_class_string>A+</energy_class_string>
<dimensions>60x60x55</dimensions>
<weight>30</weight>
<volume>0.20</volume>
<specs>...</specs>
</product>
</products>
</response>
gamma;family;category;brand;reference;ean13;stock;description;details;wholesale_price;image;energy_class_png;energy_class_string;dimensions;weight;volume;specs
Cozinha;Forno;Encastre;Orima;REF123;5601234567890;2;Forno elétrico;Detalhes do produto;199,99;https://...;https://...;A+;60x60x55;30;0.20;...
Descrição: Devolve a lista de produtos associados a uma família específica (gamma + family + category).
Endpoint:
orima://v2/family/id/{id_orima}/token/{token}/family/{family}/filetype/{filetype}
Parâmetros:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id_orima | integer | Sim | ID do cliente |
| token | string | Sim | Token de acesso |
| family | integer | Sim | ID da família (id_gamma) |
| filetype | string | Sim | Formato da resposta: json, xml ou csv |
Notas:
$url = "https://www.orima.pt/api/v2/family/id/123/token/API_KEY/family/10/filetype/json";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/v2/family/id/123/token/API_KEY/family/10/filetype/xml";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/v2/family/id/123/token/API_KEY/family/10/filetype/csv";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/v2/family/id/123/token/API_KEY/family/10/filetype/json"
response = requests.get(url)
print(response.json())
import requests
url = "https://www.orima.pt/api/v2/family/id/123/token/API_KEY/family/10/filetype/xml"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/v2/family/id/123/token/API_KEY/family/10/filetype/csv"
response = requests.get(url)
print(response.text)
{
"ok": true,
"timestamp": "20260418153000",
"api_info": {
"version": "2.0",
"developer": "viktr software"
},
"products": [
{
"product": {
"gamma": "Cozinha",
"family": "Forno",
"category": "Encastre",
"brand": "Orima",
"reference": "REF123",
"ean13": "5601234567890",
"stock_status": "2",
"description": "Forno elétrico",
"details": "Detalhes do produto",
"wholesale_price": "199,99",
"image": "https://...",
"energy_class_png": "https://...",
"energy_class_string": "A+",
"dimensions": "60x60x55",
"weight": "30",
"volume": "0.20",
"specs": "..."
}
}
]
}
<response>
<ok>true</ok>
<timestamp>20260418153000</timestamp>
<api_info>
<version>2.0</version>
<developer>viktr software</developer>
</api_info>
<products>
<product>
<ean13>5601234567890</ean13>
<gamma><![CDATA[Cozinha]]></gamma>
<family><![CDATA[Forno]]></family>
<brand><![CDATA[Orima]]></brand>
<category><![CDATA[Encastre]]></category>
<reference>REF123</reference>
<stock>2</stock>
<description><![CDATA[Forno elétrico]]></description>
<details><![CDATA[Detalhes do produto]]></details>
<price>199,99</price>
<image>https://...</image>
<energy_class_png>https://...</energy_class_png>
<energy_class_string>A+</energy_class_string>
<dimensions>60x60x55</dimensions>
<weight>30</weight>
<volume>0.20</volume>
<specs>...</specs>
</product>
</products>
</response>
gamma;family;category;brand;reference;ean13;stock;description;details;wholesale_price;image;energy_class_png;energy_class_string;dimensions;weight;volume;specs
Cozinha;Forno;Encastre;Orima;REF123;5601234567890;2;Forno elétrico;Detalhes do produto;199,99;https://...;https://...;A+;60x60x55;30;0.20;...
Descrição: Devolve a lista de imagens associadas a um produto com base no EAN.
Endpoint:
orima://v2/images/id/{id_orima}/token/{token}/ean/{ean}/filetype/{filetype}
Parâmetros:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id_orima | integer | Sim | ID do cliente |
| token | string | Sim | Token de acesso |
| ean | string | Sim | EAN do produto |
| filetype | string | Sim | Formato da resposta: json, xml ou csv |
Notas:
$url = "https://www.orima.pt/api/v2/images/id/123/token/API_KEY/ean/5601234567890/filetype/json";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/v2/images/id/123/token/API_KEY/ean/5601234567890/filetype/xml";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/v2/images/id/123/token/API_KEY/ean/5601234567890/filetype/csv";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/v2/images/id/123/token/API_KEY/ean/5601234567890/filetype/json"
response = requests.get(url)
print(response.json())
import requests
url = "https://www.orima.pt/api/v2/images/id/123/token/API_KEY/ean/5601234567890/filetype/xml"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/v2/images/id/123/token/API_KEY/ean/5601234567890/filetype/csv"
response = requests.get(url)
print(response.text)
{
"ok": true,
"timestamp": "20260418153000",
"api_info": {
"version": "2.0",
"developer": "viktr software"
},
"ean": "5601234567890",
"images": [
"https://www.orima.pt/img/prods/5601234567890/1.jpg",
"https://www.orima.pt/img/prods/5601234567890/2.jpg"
]
}
<response>
<ok>true</ok>
<timestamp>20260418153000</timestamp>
<api_info>
<version>2.0</version>
<developer>viktr software</developer>
</api_info>
<images>
<image>https://www.orima.pt/img/prods/5601234567890/1.jpg</image>
<image>https://www.orima.pt/img/prods/5601234567890/2.jpg</image>
</images>
</response>
https://www.orima.pt/img/prods/5601234567890/1.jpg
https://www.orima.pt/img/prods/5601234567890/2.jpg
Descrição: Devolve a lista completa de produtos, com preços atualizados via webservice.
Endpoint:
orima://v2/get/products/id/{id_orima}/token/{token}/filetype/{filetype}
Parâmetros:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id_orima | integer | Sim | ID do cliente |
| token | string | Sim | Token de acesso |
| filetype | string | Sim | Formato da resposta: json, xml ou csv |
$url = "https://www.orima.pt/api/v2/get/products/id/123/token/API_KEY/filetype/json";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/v2/get/products/id/123/token/API_KEY/filetype/xml";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/v2/get/products/id/123/token/API_KEY/filetype/csv";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/v2/get/products/id/123/token/API_KEY/filetype/json"
response = requests.get(url)
print(response.json())
import requests
url = "https://www.orima.pt/api/v2/get/products/id/123/token/API_KEY/filetype/xml"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/v2/get/products/id/123/token/API_KEY/filetype/csv"
response = requests.get(url)
print(response.text)
{
"ok": true,
"timestamp": "20260418153000",
"api_info": {
"version": "2.0",
"developer": "viktr software"
},
"products": [
{
"product": {
"gamma": "Cozinha",
"family": "Forno",
"category": "Encastre",
"brand": "Orima",
"reference": "REF123",
"ean13": "5601234567890",
"stock_status": "2",
"description": "Forno elétrico",
"details": "Detalhes do produto",
"wholesale_price": "199,99",
"image": "https://...",
"energy_class_png": "https://...",
"energy_class_string": "A+",
"dimensions": "60x60x55",
"weight": "30",
"volume": "0.20",
"specs": "..."
}
}
]
}
<response>
<ok>true</ok>
<timestamp>20260418153000</timestamp>
<api_info>
<version>2.0</version>
<developer>viktr software</developer>
</api_info>
<products>
<product>
<ean13>5601234567890</ean13>
<gamma><![CDATA[Cozinha]]></gamma>
<family><![CDATA[Forno]]></family>
<brand><![CDATA[Orima]]></brand>
<category><![CDATA[Encastre]]></category>
<reference>REF123</reference>
<stock>2</stock>
<description><![CDATA[Forno elétrico]]></description>
<details><![CDATA[Detalhes do produto]]></details>
<price>199,99</price>
<image>https://...</image>
<energy_class_png>https://...</energy_class_png>
<energy_class_string>A+</energy_class_string>
<dimensions>60x60x55</dimensions>
<weight>30</weight>
<volume>0.20</volume>
<specs>...</specs>
</product>
</products>
</response>
gamma;family;category;brand;reference;ean13;stock;description;details;wholesale_price;image;energy_class_png;energy_class_string;dimensions;weight;volume;specs
Cozinha;Forno;Encastre;Orima;REF123;5601234567890;2;Forno elétrico;Detalhes do produto;199,99;https://...;https://...;A+;60x60x55;30;0.20;...
Descrição: Devolve a lista de produtos disponíveis em stock (stock > 0), com preços atualizados via webservice.
Endpoint:
orima://v2/get/stock/id/{id_orima}/token/{token}/filetype/{filetype}
Parâmetros:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id_orima | integer | Sim | ID do cliente |
| token | string | Sim | Token de acesso |
| filetype | string | Sim | Formato da resposta: json, xml ou csv |
$url = "https://www.orima.pt/api/v2/get/stock/id/123/token/API_KEY/filetype/json";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/v2/get/stock/id/123/token/API_KEY/filetype/xml";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/v2/get/stock/id/123/token/API_KEY/filetype/csv";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/v2/get/stock/id/123/token/API_KEY/filetype/json"
response = requests.get(url)
print(response.json())
import requests
url = "https://www.orima.pt/api/v2/get/stock/id/123/token/API_KEY/filetype/xml"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/v2/get/stock/id/123/token/API_KEY/filetype/csv"
response = requests.get(url)
print(response.text)
{
"ok": true,
"timestamp": "20260418153000",
"api_info": {
"version": "2.0",
"developer": "viktr software"
},
"products": [
{
"product": {
"gamma": "Cozinha",
"family": "Forno",
"category": "Encastre",
"brand": "Orima",
"reference": "REF123",
"ean13": "5601234567890",
"stock_status": "2",
"description": "Forno elétrico",
"details": "Detalhes do produto",
"wholesale_price": "199,99",
"image": "https://...",
"energy_class_png": "https://...",
"energy_class_string": "A+",
"dimensions": "60x60x55",
"weight": "30",
"volume": "0.20",
"specs": "..."
}
}
]
}
<response>
<ok>true</ok>
<timestamp>20260418153000</timestamp>
<api_info>
<version>2.0</version>
<developer>viktr software</developer>
</api_info>
<products>
<product>
<ean13>5601234567890</ean13>
<gamma><![CDATA[Cozinha]]></gamma>
<family><![CDATA[Forno]]></family>
<brand><![CDATA[Orima]]></brand>
<category><![CDATA[Encastre]]></category>
<reference>REF123</reference>
<stock>2</stock>
<description><![CDATA[Forno elétrico]]></description>
<details><![CDATA[Detalhes do produto]]></details>
<price>199,99</price>
<image>https://...</image>
<energy_class_png>https://...</energy_class_png>
<energy_class_string>A+</energy_class_string>
<dimensions>60x60x55</dimensions>
<weight>30</weight>
<volume>0.20</volume>
<specs>...</specs>
</product>
</products>
</response>
gamma;family;category;brand;reference;ean13;stock;description;details;wholesale_price;image;energy_class_png;energy_class_string;dimensions;weight;volume;specs
Cozinha;Forno;Encastre;Orima;REF123;5601234567890;2;Forno elétrico;Detalhes do produto;199,99;https://...;https://...;A+;60x60x55;30;0.20;...
Descrição: Verifica o estado da API da Orima, indicando se o sistema está disponível.
Endpoint:
orima://status/mode/{mode}
Parâmetros:
Notas:
$url = "https://www.orima.pt/api/status/mode/json";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/status/mode/xml";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/status";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/status/mode/json"
response = requests.get(url)
data = response.json()
print(data)
import requests
url = "https://www.orima.pt/api/status/mode/xml"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/status"
response = requests.get(url)
print(response.text)
{
"api": {
"status": {
"boolean": "true",
"text": "activo",
"integer": "1"
}
}
}
<api>
<status>
<boolean>true</boolean>
<text>activo</text>
<integer>1</integer>
</status>
</api>
1
Descrição: Devolve a lista de todas as famílias (estrutura gamma → family → category).
Endpoint:
orima://list/families/id/{id}/username/{username}/password/{password}/filetype/{filetype}
Parâmetros:
Notas:
$url = "https://www.orima.pt/api/list/families/id/123/username/user/password/pass/filetype/json";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/list/families/id/123/username/user/password/pass/filetype/xml";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/list/families/id/123/username/user/password/pass/filetype/csv";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/list/families/id/123/username/user/password/pass/filetype/json"
response = requests.get(url)
data = response.json()
print(data)
import requests
url = "https://www.orima.pt/api/list/families/id/123/username/user/password/pass/filetype/xml"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/list/families/id/123/username/user/password/pass/filetype/csv"
response = requests.get(url)
print(response.text)
{
"families": [
{
"family": {
"id": 1,
"gamma": "Cozinha",
"family": "Forno",
"category": "Encastre"
}
},
{
"family": {
"id": 2,
"gamma": "Lavagem",
"family": "Máquina de Lavar",
"category": "Roupa"
}
}
]
}
<families>
<family>
<id>1</id>
<gamma>Cozinha</gamma>
<family>Forno</family>
<category>Encastre</category>
</family>
<family>
<id>2</id>
<gamma>Lavagem</gamma>
<family>Máquina de Lavar</family>
<category>Roupa</category>
</family>
</families>
id;gamma;family;category
1;Cozinha;Forno;Encastre
2;Lavagem;Máquina de Lavar;Roupa
Descrição: Devolve a lista de todas as marcas disponíveis.
Endpoint:
orima://list/brands/id/{id}/username/{username}/password/{password}/filetype/{filetype}
Parâmetros:
Notas:
$url = "https://www.orima.pt/api/list/brands/id/123/username/user/password/pass/filetype/json";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/list/brands/id/123/username/user/password/pass/filetype/xml";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/list/brands/id/123/username/user/password/pass/filetype/csv";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/list/brands/id/123/username/user/password/pass/filetype/json"
response = requests.get(url)
data = response.json()
print(data)
import requests
url = "https://www.orima.pt/api/list/brands/id/123/username/user/password/pass/filetype/xml"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/list/brands/id/123/username/user/password/pass/filetype/csv"
response = requests.get(url)
print(response.text)
{
"brands": [
{
"brand": {
"id": 1,
"brand": "Orima"
}
},
{
"brand": {
"id": 2,
"brand": "Outra Marca"
}
}
]
}
<brands>
<brand_info>
<id>1</id>
<brand>Orima</brand>
</brand_info>
<brand_info>
<id>2</id>
<brand>Outra Marca</brand>
</brand_info>
</brands>
id;brand
1;Orima
2;Outra Marca
Descrição: Devolve a lista de produtos associados a uma marca específica.
Endpoint:
orima://brand/id/{id}/username/{username}/password/{password}/filetype/{filetype}/brand/{brand}
Parâmetros:
Notas:
$url = "https://www.orima.pt/api/brand/id/123/username/user/password/pass/filetype/json/brand/5";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/brand/id/123/username/user/password/pass/filetype/xml/brand/5";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/brand/id/123/username/user/password/pass/filetype/csv/brand/5";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/brand/id/123/username/user/password/pass/filetype/json/brand/5"
response = requests.get(url)
data = response.json()
print(data)
import requests
url = "https://www.orima.pt/api/brand/id/123/username/user/password/pass/filetype/xml/brand/5"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/brand/id/123/username/user/password/pass/filetype/csv/brand/5"
response = requests.get(url)
print(response.text)
{
"products": [
{
"product": {
"gamma": "Cozinha",
"family": "Forno",
"category": "Encastre",
"brand": "Orima",
"reference": "REF123",
"ean13": "5601234567890",
"stock_status": "2",
"description": "Forno elétrico",
"details": "Detalhes do produto",
"wholesale_price": "199,99",
"image": "https://...",
"energy_class_png": "https://...",
"energy_class_string": "A+"
}
}
]
<products>
<product>
<ean13>5601234567890</ean13>
<gamma>Cozinha</gamma>
<family>Forno</family>
<category>Encastre</category>
<brand>Orima</brand>
<reference>REF123</reference>
<stock>2</stock>
<description>Forno elétrico</description>
<details>Detalhes do produto</details>
<price>199,99</price>
<image>https://...</image>
<energy_class_png>https://...</energy_class_png>
<energy_class_string>A+</energy_class_string>
</product>
</products>
gamma;family;category;brand;reference;ean13;stock;description;details;wholesale_price;image;energy_class_png;energy_class_string
Cozinha;Forno;Encastre;Orima;REF123;5601234567890;2;Forno elétrico;Detalhes do produto;199,99;https://...;https://...;A+
Descrição: Devolve a lista de produtos associados a uma família específica.
Endpoint:
orima://family/id/{id}/username/{username}/password/{password}/filetype/{filetype}/family/{family}
Parâmetros:
Notas:
$url = "https://www.orima.pt/api/family/id/123/username/user/password/pass/filetype/json/family/10";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/family/id/123/username/user/password/pass/filetype/xml/family/10";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/family/id/123/username/user/password/pass/filetype/csv/family/10";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/family/id/123/username/user/password/pass/filetype/json/family/10"
response = requests.get(url)
data = response.json()
print(data)
import requests
url = "https://www.orima.pt/api/family/id/123/username/user/password/pass/filetype/xml/family/10"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/family/id/123/username/user/password/pass/filetype/csv/family/10"
response = requests.get(url)
print(response.text)
{
"products": [
{
"product": {
"gamma": "Cozinha",
"family": "Forno",
"category": "Encastre",
"brand": "Orima",
"reference": "REF123",
"ean13": "5601234567890",
"stock_status": "2",
"description": "Forno elétrico",
"details": "Detalhes do produto",
"wholesale_price": "199,99",
"image": "https://...",
"energy_class_png": "https://...",
"energy_class_string": "A+"
}
}
]
<products>
<product>
<gamma>Cozinha</gamma>
<family>Forno</family>
<category>Encastre</category>
<brand>Orima</brand>
<reference>REF123</reference>
<ean13>5601234567890</ean13>
<stock>2</stock>
<description>Forno elétrico</description>
<details>Detalhes do produto</details>
<price>199,99</price>
<image>https://...</image>
<energy_class_png>https://...</energy_class_png>
<energy_class_string>A+</energy_class_string>
</product>
</products>
gamma;family;category;brand;reference;ean13;stock;description;details;wholesale_price;image;energy_class_png;energy_class_string
Cozinha;Forno;Encastre;Orima;REF123;5601234567890;2;Forno elétrico;Detalhes do produto;199,99;https://...;https://...;A+
Descrição: Devolve a lista de imagens associadas a um produto, com base no EAN.
Endpoint:
orima://images/id/{id}/username/{username}/password/{password}/filetype/{filetype}/ean/{ean}
Parâmetros:
Notas:
$url = "https://www.orima.pt/api/images/id/123/username/user/password/pass/filetype/json/ean/5601234567890";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/images/id/123/username/user/password/pass/filetype/xml/ean/5601234567890";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/images/id/123/username/user/password/pass/filetype/csv/ean/5601234567890";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/images/id/123/username/user/password/pass/filetype/json/ean/5601234567890"
response = requests.get(url)
data = response.json()
print(data)
import requests
url = "https://www.orima.pt/api/images/id/123/username/user/password/pass/filetype/xml/ean/5601234567890"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/images/id/123/username/user/password/pass/filetype/csv/ean/5601234567890"
response = requests.get(url)
print(response.text)
{
"ean": "5601234567890",
"images": [
"https://www.orima.pt/img/prods/5601234567890/1.jpg",
"https://www.orima.pt/img/prods/5601234567890/2.jpg"
]
}
<images>
<image>https://www.orima.pt/img/prods/5601234567890/1.jpg</image>
<image>https://www.orima.pt/img/prods/5601234567890/2.jpg</image>
</images>
https://www.orima.pt/img/prods/5601234567890/1.jpg
https://www.orima.pt/img/prods/5601234567890/2.jpg
Descrição: Devolve a lista completa de produtos disponíveis, podendo estar limitada às marcas associadas ao utilizador.
Endpoint:
orima://get/products/id/{id}/username/{username}/password/{password}/filetype/{filetype}
Parâmetros:
Notas:
$url = "https://www.orima.pt/api/get/products/id/123/username/user/password/pass/filetype/json";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/get/products/id/123/username/user/password/pass/filetype/xml";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/get/products/id/123/username/user/password/pass/filetype/csv";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/get/products/id/123/username/user/password/pass/filetype/json"
response = requests.get(url)
data = response.json()
print(data)
import requests
url = "https://www.orima.pt/api/get/products/id/123/username/user/password/pass/filetype/xml"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/get/products/id/123/username/user/password/pass/filetype/csv"
response = requests.get(url)
print(response.text)
{
"products": [
{
"product": {
"gamma": "Cozinha",
"family": "Forno",
"category": "Encastre",
"brand": "Orima",
"reference": "REF123",
"ean13": "5601234567890",
"stock_status": "2",
"description": "Forno elétrico",
"details": "Detalhes do produto",
"wholesale_price": "199,99",
"image": "https://...",
"energy_class_png": "https://...",
"energy_class_string": "A+",
"iva": "23",
"dimensions": "60x60x55",
"weight": "30",
"volume": "0.20",
"specs": "Classe energética A+, ventilado"
}
}
]
<products>
<product>
<ean13>5601234567890</ean13>
<gamma>Cozinha</gamma>
<family>Forno</family>
<brand>Orima</brand>
<category>Encastre</category>
<reference>REF123</reference>
<stock>2</stock>
<description>Forno elétrico</description>
<details>Detalhes do produto</details>
<price>199,99</price>
<image>https://...</image>
<energy_class_png>https://...</energy_class_png>
<energy_class_string>A+</energy_class_string>
<iva>23</iva>
<dimensions>60x60x55</dimensions>
<weight>30</weight>
<volume>0.20</volume>
<specs>Classe energética A+, ventilado</specs>
</product>
</products>
gamma;family;category;brand;reference;ean13;stock;description;details;wholesale_price;image;energy_class_png;energy_class_string;iva;dimensions;weight;volume;specs
Cozinha;Forno;Encastre;Orima;REF123;5601234567890;2;Forno elétrico;Detalhes do produto;199,99;https://...;https://...;A+;23;60x60x55;30;0.20;Classe energética A+, ventilado
Descrição: Devolve a lista de produtos disponíveis em stock (stock > 0), incluindo preços e informação detalhada.
Endpoint:
orima://get/stock/id/{id}/username/{username}/password/{password}/filetype/{filetype}
Parâmetros:
Notas:
$url = "https://www.orima.pt/api/get/stock/id/123/username/user/password/pass/filetype/json";
$response = file_get_contents($url);
$data = json_decode($response, true);
print_r($data);
$url = "https://www.orima.pt/api/get/stock/id/123/username/user/password/pass/filetype/xml";
$response = file_get_contents($url);
echo $response;
$url = "https://www.orima.pt/api/get/stock/id/123/username/user/password/pass/filetype/csv";
$response = file_get_contents($url);
echo $response;
import requests
url = "https://www.orima.pt/api/get/stock/id/123/username/user/password/pass/filetype/json"
response = requests.get(url)
data = response.json()
print(data)
import requests
url = "https://www.orima.pt/api/get/stock/id/123/username/user/password/pass/filetype/xml"
response = requests.get(url)
print(response.text)
import requests
url = "https://www.orima.pt/api/get/stock/id/123/username/user/password/pass/filetype/csv"
response = requests.get(url)
print(response.text)
{
"products": [
{
"product": {
"gamma": "Cozinha",
"family": "Forno",
"category": "Encastre",
"brand": "Orima",
"reference": "REF123",
"ean13": "5601234567890",
"stock_status": "2",
"description": "Forno elétrico",
"details": "Detalhes do produto",
"wholesale_price": "199,99",
"image": "https://...",
"energy_class_png": "https://...",
"energy_class_string": "A+",
"iva": "23",
"dimensions": "60x60x55",
"weight": "30",
"volume": "0.20",
"specs": "Classe energética A+, ventilado"
}
}
]
}
<products>
<product>
<ean13>5601234567890</ean13>
<gamma>Cozinha</gamma>
<family>Forno</family>
<brand>Orima</brand>
<category>Encastre</category>
<reference>REF123</reference>
<stock>2</stock>
<description>Forno elétrico</description>
<details>Detalhes do produto</details>
<price>199,99</price>
<image>https://...</image>
<energy_class_png>https://...</energy_class_png>
<energy_class_string>A+</energy_class_string>
<iva>23</iva>
<dimensions>60x60x55</dimensions>
<weight>30</weight>
<volume>0.20</volume>
<specs>Classe energética A+, ventilado</specs>
</product>
</products>
gamma;family;category;brand;reference;ean13;stock;description;details;wholesale_price;image;energy_class_png;energy_class_string;iva;dimensions;weight;volume;specs
Cozinha;Forno;Encastre;Orima;REF123;5601234567890;2;Forno elétrico;Detalhes do produto;199,99;https://...;https://...;A+;23;60x60x55;30;0.20;Classe energética A+, ventilado
Descrição:
Este endpoint permite criar uma encomenda no sistema Orima. Os produtos são validados internamente, os preços são obtidos via webservice e a encomenda é automaticamente registada e enviada.
Na área de configuração da empresa, no site da Orima, utilizadores com acesso à API podem definir endereços de email que não devem receber notificações automáticas relacionadas com encomendas enviadas pela integração.
{
"auth": {
"id_orima": 123,
"token": "API_KEY"
},
"products": [
{ "ean13": "4054925912975", "qty": 2 },
{ "ean13": "4242005165865", "qty": 1 }
],
"destination": {
"deliver_to_us": false,
"name": "João Silva",
"address": "Rua XPTO 123",
"cp": "1000-001",
"location": "Lisboa",
"phone": "912345678"
},
"notes": "Observações opcionais"
}
Explicação:
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| auth | object | Sim | Credenciais de acesso à API (id_orima + token) |
| products | array | Sim | Lista de produtos com EAN13 e quantidade |
| products[].ean13 | string | Sim | EAN13 do produto |
| products[].qty | integer | Sim | Quantidade (> 0) |
| destination | object | Sim | Configuração do destino da encomenda |
| destination.deliver_to_us | boolean | Sim |
true → usa morada do cliente false → requer dados de entrega |
| destination.name | string | Condicional | Nome do destinatário (obrigatório se deliver_to_us = false) |
| destination.address | string | Condicional | Morada (obrigatório se deliver_to_us = false) |
| destination.cp | string | Condicional | Código postal (obrigatório se deliver_to_us = false) |
| destination.location | string | Condicional | Localidade (obrigatório se deliver_to_us = false) |
| destination.phone | string | Condicional | Contacto telefónico (obrigatório se deliver_to_us = false) |
| notes | string | Não | Observações adicionais |
{
"ok": true,
"timestamp": "20260415174512",
"api_info": {
"version": "2.0",
"developer": "viktr software"
},
"id_order": 230154,
"external_order": 528901,
"products": {
"5601234567890": {
"id_orima_product": 105432,
"ean13": "5601234567890",
"pvp": 129.99,
"id_gamma": 3,
"description": "FORNO ELÉTRICO TEKA HBB 605",
"reference": "TK-605"
},
"5609876543210": {
"id_orima_product": 108765,
"ean13": "5609876543210",
"pvp": 79.50,
"id_gamma": 8,
"description": "KIT ACESSÓRIOS MÁQUINA LOUÇA BOSCH",
"reference": "BSH-KIT01"
}
},
"totals": {
"total": 338.48,
"transport": 0,
"total_with_tax": 416.33
},
"company": {
"entity_name": "Tech Solutions, Lda",
"address": "Rua das Tecnologias 45",
"postal": "1000-200",
"location": "Lisboa",
"phone": "217654321",
"nif": "509876543"
},
"emails": {
"gestor": "gestor@orima.pt",
"vendedor": "vendedor@orima.pt",
"cliente": "cliente@techsolutions.pt"
},
"order_update_ok": true,
"soap_sent": true,
"email_sent": true
}
Explicação:
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id_order | integer | Sim | ID interno da encomenda no sistema |
| external_order | integer|null | Não | ID da encomenda no sistema Orima (null se falhar envio SOAP) |
| products_db | object | Sim | Lista de produtos processados, indexados por EAN13, com dados vindos da base de dados |
| totals | object | Sim | Totais calculados da encomenda |
| totals.total | float | Sim | Total dos produtos sem transporte |
| totals.transport | float | Sim | Valor dos portes calculados |
| totals.total_with_tax | float | Sim | Total final com IVA incluído |
| company | object | Sim | Dados da empresa associada à encomenda |
| emails | object | Sim | Lista de emails envolvidos no envio da encomenda |
| order_update_ok | boolean | Sim | Indica se a encomenda foi atualizada com sucesso após envio |
| soap_sent | boolean | Sim | Indica se a encomenda foi enviada para o ERP (Orima) |
| email_sent | boolean | Sim | Indica se o email foi enviado com sucesso |
{
"ok": false,
"timestamp": "20260415162445",
"error_info": {
"internal_code": 3005,
"error_id": "PRODUCTS_ERROR",
"description": "Existem produtos inválidos ou inexistentes"
}
}
$url = "https://www.orima.pt/api/send";
$data = [
"auth" => [
"id_orima" => 123,
"token" => "API_KEY"
],
"products" => [
["ean13" => "4054925912975", "qty" => 2],
["ean13" => "4242005165865", "qty" => 1]
],
"destination" => [
"deliver_to_us" => true
],
"notes" => "Teste API"
];
$options = [
"http" => [
"header" => "Content-Type: application/json",
"method" => "POST",
"content" => json_encode($data)
]
];
$context = stream_context_create($options);
$response = file_get_contents($url, false, $context);
$result = json_decode($response, true);
print_r($result);
import requests
url = "https://www.orima.pt/api/send"
data = {
"auth": {
"id_orima": 123,
"token": "API_KEY"
},
"products": [
{"ean13": "4054925912975", "qty": 2},
{"ean13": "4242005165865", "qty": 1}
],
"destination": {
"deliver_to_us": True
},
"notes": "Teste API"
}
response = requests.post(url, json=data)
print(response.json())
| ID | Código | Descrição |
|---|---|---|
| 1000 | EMPTY_BODY | Pedido sem conteúdo |
| 1001 | MALFORMED_BODY | JSON inválido |
| 1002 | PRODUCTS_ERROR | Erro ao comunicar com a base de dados (produtos) |
| 1003 | AUTH_FAILED | Erro ao comunicar com a base de dados (autenticação) |
| 2000 | INVALID_AUTH | Formato de autenticação inválido |
| 2001 | INVALID_AUTH_ID | ID Orima inválido |
| 2002 | INVALID_AUTH_TOKEN | Token inválido ou vazio |
| 2003 | AUTH_FAILED | ID Orima ou API Key inválidos |
| 2004 | AUTH_FAILED_ACTIVE | Conta inativa |
| 2005 | AUTH_FAILED_API_ACTIVE | Acesso à API não permitido |
| 3000 | PRODUCTS_MALFORMED | Lista de produtos inválida ou vazia |
| 3001 | PRODUCT_MALFORMED | Produto mal definido |
| 3002 | PRODUCT_INVALID_EAN | EAN inválido ou não numérico |
| 3003 | PRODUCT_INVALID_QUANTITY | Quantidade inválida |
| 3004 | PRODUCTS_UNIQUE_EMPTY | Lista de EANs vazia após validação |
| 3005 | PRODUCTS_ERROR | Produtos inválidos ou inexistentes |
| 3006 | PRODUCTS_INVALID | Produtos inválidos após processamento |
| 4000 | DESTINATION_MALFORMED | Destino inválido |
| 4001 | DESTINATION_INDICATOR_MISSING | Campo deliver_to_us em falta |
| 4002 | DESTINATION_FIELD_MISSING | Campos obrigatórios de morada em falta |
| 5000 | ORDER_CREATE_FAILED | Erro ao criar encomenda |
| 5001 | ORDER_ITEMS_FAILED | Erro ao preparar produtos da encomenda |
| 6000 | SOAP_NO_RESPONSE | Sem resposta do webservice |
| 6002 | SOAP_INVALID_XML | Resposta SOAP inválida |
| 6003 | SOAP_PARSE_ERROR | Erro ao interpretar resposta SOAP |
| 6004 | SOAP_ERROR | Erro ao criar encomenda no sistema Orima |