Criar tag personalizada
curl --request POST \
--url https://apiv3.usecorvex.com.br/api/v1/orders/{orderId}/tags \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Store-Id: <x-store-id>' \
--data '
{
"label": "VIP",
"color": "violet"
}
'const options = {
method: 'POST',
headers: {
'X-Store-Id': '<x-store-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({label: 'VIP', color: 'violet'})
};
fetch('https://apiv3.usecorvex.com.br/api/v1/orders/{orderId}/tags', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://apiv3.usecorvex.com.br/api/v1/orders/{orderId}/tags"
payload = {
"label": "VIP",
"color": "violet"
}
headers = {
"X-Store-Id": "<x-store-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"data": {
"tag": {
"id": "custom.vip",
"category": "custom",
"label": "VIP",
"color": "violet",
"allowConcurrent": true
},
"catalog": [
{
"id": "faturamento.nf_emitida",
"category": "invoicing",
"label": "NF emitida",
"color": null,
"allowConcurrent": false
},
{
"id": "entrega.em_transporte",
"category": "delivery",
"label": "Em transporte",
"color": null,
"allowConcurrent": false
},
{
"id": "custom.vip",
"category": "custom",
"label": "VIP",
"color": "violet",
"allowConcurrent": true
}
]
}
}{
"success": false,
"error": {
"message": "X-Store-Id deve ser um UUID válido",
"code": "VALIDATION_ERROR"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 400
}
}{
"success": false,
"error": {
"message": "Esta rota exige uma API Key. Use Authorization: Bearer cvx_live_...",
"code": "AUTH_API_KEY_REQUIRED"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 401
}
}{
"success": false,
"error": {
"message": "Sua API Key não tem o escopo necessário para esta operação.",
"code": "AUTH_SCOPE_DENIED"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 403
}
}{
"success": false,
"error": {
"message": "Recurso não encontrado",
"code": "RESOURCE_NOT_FOUND"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 404
}
}{
"success": false,
"error": {
"message": "Já existe uma tag com esse nome",
"code": "DUPLICATE_ENTRY"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 409
}
}{
"success": false,
"message": "Muitas requisições. Tente novamente em instantes.",
"error": "RATE_LIMITED",
"retryAfter": 12
}Pedidos
Criar tag personalizada
Cria uma tag da loja (custom.*). Não aplica sozinha no pedido — depois envie o id em tagIds. Cores: rose, orange, amber, lime, green, sky, blue, violet, pink, slate.
POST
/
api
/
v1
/
orders
/
{orderId}
/
tags
Criar tag personalizada
curl --request POST \
--url https://apiv3.usecorvex.com.br/api/v1/orders/{orderId}/tags \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Store-Id: <x-store-id>' \
--data '
{
"label": "VIP",
"color": "violet"
}
'const options = {
method: 'POST',
headers: {
'X-Store-Id': '<x-store-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({label: 'VIP', color: 'violet'})
};
fetch('https://apiv3.usecorvex.com.br/api/v1/orders/{orderId}/tags', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://apiv3.usecorvex.com.br/api/v1/orders/{orderId}/tags"
payload = {
"label": "VIP",
"color": "violet"
}
headers = {
"X-Store-Id": "<x-store-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"data": {
"tag": {
"id": "custom.vip",
"category": "custom",
"label": "VIP",
"color": "violet",
"allowConcurrent": true
},
"catalog": [
{
"id": "faturamento.nf_emitida",
"category": "invoicing",
"label": "NF emitida",
"color": null,
"allowConcurrent": false
},
{
"id": "entrega.em_transporte",
"category": "delivery",
"label": "Em transporte",
"color": null,
"allowConcurrent": false
},
{
"id": "custom.vip",
"category": "custom",
"label": "VIP",
"color": "violet",
"allowConcurrent": true
}
]
}
}{
"success": false,
"error": {
"message": "X-Store-Id deve ser um UUID válido",
"code": "VALIDATION_ERROR"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 400
}
}{
"success": false,
"error": {
"message": "Esta rota exige uma API Key. Use Authorization: Bearer cvx_live_...",
"code": "AUTH_API_KEY_REQUIRED"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 401
}
}{
"success": false,
"error": {
"message": "Sua API Key não tem o escopo necessário para esta operação.",
"code": "AUTH_SCOPE_DENIED"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 403
}
}{
"success": false,
"error": {
"message": "Recurso não encontrado",
"code": "RESOURCE_NOT_FOUND"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 404
}
}{
"success": false,
"error": {
"message": "Já existe uma tag com esse nome",
"code": "DUPLICATE_ENTRY"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 409
}
}{
"success": false,
"message": "Muitas requisições. Tente novamente em instantes.",
"error": "RATE_LIMITED",
"retryAfter": 12
}Authorizations
API Key no formato cvx_live_..., criada no painel Corvex. Não use JWT de sessão nem x-api-key.
Headers
UUID da loja. A chave precisa ter esta loja autorizada.
Path Parameters
Body
application/json
Response
Tag criada.