curl --request POST \
--url https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Pequena",
"description": "Tamanho pequeno, ideal para 1 pessoa",
"cost_price": 5.5,
"external_code": "OPT-001",
"status": "ACTIVE"
}
'import requests
url = "https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options"
payload = {
"name": "Pequena",
"description": "Tamanho pequeno, ideal para 1 pessoa",
"cost_price": 5.5,
"external_code": "OPT-001",
"status": "ACTIVE"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Pequena',
description: 'Tamanho pequeno, ideal para 1 pessoa',
cost_price: 5.5,
external_code: 'OPT-001',
status: 'ACTIVE'
})
};
fetch('https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Pequena',
'description' => 'Tamanho pequeno, ideal para 1 pessoa',
'cost_price' => 5.5,
'external_code' => 'OPT-001',
'status' => 'ACTIVE'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options"
payload := strings.NewReader("{\n \"name\": \"Pequena\",\n \"description\": \"Tamanho pequeno, ideal para 1 pessoa\",\n \"cost_price\": 5.5,\n \"external_code\": \"OPT-001\",\n \"status\": \"ACTIVE\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Pequena\",\n \"description\": \"Tamanho pequeno, ideal para 1 pessoa\",\n \"cost_price\": 5.5,\n \"external_code\": \"OPT-001\",\n \"status\": \"ACTIVE\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Pequena\",\n \"description\": \"Tamanho pequeno, ideal para 1 pessoa\",\n \"cost_price\": 5.5,\n \"external_code\": \"OPT-001\",\n \"status\": \"ACTIVE\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"description": "<string>",
"external_code": "<string>",
"status": "ACTIVE",
"image": {
"image_url": "<string>",
"thumbnail_url": "<string>"
},
"cost_price": 1,
"active_stock_control": true,
"stock": 123
}{
"code": 4001,
"message": "Requisição inválida.",
"errors": {
"name": [
"não pode ficar em branco",
"é muito curto (mínimo: 1 caractere)"
],
"price": [
"não é um número"
]
}
}{
"code": 4010,
"message": "Token inválido."
}This response has no body data.Criar opção
Cria uma nova opção. O nome deve ser único no estabelecimento.
Após criar a opção, ela pode ser associada a grupos de complementos via os endpoints de grupos.
curl --request POST \
--url https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Pequena",
"description": "Tamanho pequeno, ideal para 1 pessoa",
"cost_price": 5.5,
"external_code": "OPT-001",
"status": "ACTIVE"
}
'import requests
url = "https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options"
payload = {
"name": "Pequena",
"description": "Tamanho pequeno, ideal para 1 pessoa",
"cost_price": 5.5,
"external_code": "OPT-001",
"status": "ACTIVE"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Pequena',
description: 'Tamanho pequeno, ideal para 1 pessoa',
cost_price: 5.5,
external_code: 'OPT-001',
status: 'ACTIVE'
})
};
fetch('https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Pequena',
'description' => 'Tamanho pequeno, ideal para 1 pessoa',
'cost_price' => 5.5,
'external_code' => 'OPT-001',
'status' => 'ACTIVE'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options"
payload := strings.NewReader("{\n \"name\": \"Pequena\",\n \"description\": \"Tamanho pequeno, ideal para 1 pessoa\",\n \"cost_price\": 5.5,\n \"external_code\": \"OPT-001\",\n \"status\": \"ACTIVE\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Pequena\",\n \"description\": \"Tamanho pequeno, ideal para 1 pessoa\",\n \"cost_price\": 5.5,\n \"external_code\": \"OPT-001\",\n \"status\": \"ACTIVE\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://integracao.sandbox.cardapioweb.com/api/partner/v1/catalog/options")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Pequena\",\n \"description\": \"Tamanho pequeno, ideal para 1 pessoa\",\n \"cost_price\": 5.5,\n \"external_code\": \"OPT-001\",\n \"status\": \"ACTIVE\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"description": "<string>",
"external_code": "<string>",
"status": "ACTIVE",
"image": {
"image_url": "<string>",
"thumbnail_url": "<string>"
},
"cost_price": 1,
"active_stock_control": true,
"stock": 123
}{
"code": 4001,
"message": "Requisição inválida.",
"errors": {
"name": [
"não pode ficar em branco",
"é muito curto (mínimo: 1 caractere)"
],
"price": [
"não é um número"
]
}
}{
"code": 4010,
"message": "Token inválido."
}This response has no body data.Autorizações
Access token OAuth 2.0 de app instalado na CW App Store. Escopo: catalog.
Corpo
Nome da opção. Deve ser único no estabelecimento.
1 - 500Descrição da opção.
1000Preço de custo da opção. Deve ser um número positivo com no máximo 2 casas decimais.
x >= 0Código externo da opção.
50Status da opção.
ACTIVE: opção ativa e visível.INACTIVE: opção oculta.MISSING: opção em falta.
ACTIVE, INACTIVE, MISSING Resposta
Opção criada com sucesso.
Opção que pode ser associada a múltiplos grupos de complementos.
Identificador único da opção.
Nome da opção.
Descrição da opção.
Código externo da opção.
Status da opção.
ACTIVE: opção ativa e visível.INACTIVE: opção oculta.MISSING: opção em falta.
ACTIVE, INACTIVE, MISSING Imagem da opção.
Show child attributes
Show child attributes
Preço de custo da opção.
x >= 0Indica se o controle de estoque está ativo.
Quantidade disponível em estoque.
Esta página foi útil?
