Comment on page
Produtos e serviços
O atual capítulo tem como objetivo descrever as rotas da API responsáveis pela criação e gestão de produtos e serviços
Os detalhes do pedido POST para a criação de produtos estão descritos de seguida, em formato OpenAPI, e em cURL.
curl -v -X POST -H 'Content-Type: application/vnd.api+json' -H 'Accept: application/json' -H 'Authorization: Bearer <access_token>' -d '<payload JSON>' '<API_URL>/products'
No pedido acima, o <access_token> corresponde ao token de acesso válido devolvido pelo serviço de OAuth, e o <payload JSON> deverá ter o seguinte formato
{
"data": {
"type": "products", // [OBRIGATÓRIO]
"attributes": {
"type": "Product", // [OBRIGATÓRIO]
"item_code": "PTEST", // [OBRIGATÓRIO]
"item_description": "Test product", // [OBRIGATÓRIO]
"sales_price": 100, // [OPCIONAL]
"sales_price_includes_vat": false, // [OPCIONAL] Por omissão, false; true, se o preço de venda do produto incluir IVA
"tax_code": "NOR" // [OPCIONAL] Os tipos de IVA suportados são "NOR" (normal), "INT" (intermédio), "RED" (reduzido), "ISE" (isento)
}
}
}
post
/products
De modo a obter informações sobre um dado produto, poderá realizar o seguinte pedido
get
/products
Neste, pode não indicar nenhum filtro, e obter todos os produtos disponíveis, ou então filtrar por qualquer um dos campos disponíveis, tal como no exemplo dado, e seguindo as convenções JSONAPI
Os detalhes do pedido POST para a criação de serviços estão descritos de seguida, em formato OpenAPI, e em cURL.
curl -v -X POST -H 'Content-Type: application/vnd.api+json' -H 'Accept: application/json' -H 'Authorization: Bearer <access_token>' -d '<payload JSON>' '<API_URL>/services'
No pedido acima, o <access_token> corresponde ao token de acesso válido devolvido pelo serviço de OAuth, e o <payload JSON> deverá ter o seguinte formato
{
"data": {
"type": "services", // [OBRIGATÓRIO]
"attributes": {
"type": "Service", // [OBRIGATÓRIO]
"item_code": "STEST", // [OBRIGATÓRIO]
"item_description": "Test service", // [OBRIGATÓRIO]
"sales_price": 100, // [OPCIONAL]
"sales_price_includes_vat": false, // [OPCIONAL] Por omissão, false; true, se o preço de venda do produto incluir IVA
"tax_code": "NOR" // [OPCIONAL] Os tipos de IVA suportados são "NOR" (normal), "INT" (intermédio), "RED" (reduzido), "ISE" (isento)
}
}
}
post
/services
De modo a obter informações sobre um dado serviço, poderá realizar o seguinte pedido
get
/services
Neste, pode não indicar nenhum filtro, e obter todos os serviços disponíveis, ou então filtrar por qualquer um dos campos disponíveis, tal como no exemplo dado, e seguindo as convenções JSONAPI
Last modified 1yr ago