Skip to main content
POST
/
{alias}
/
catalog
/
categories
Criar categoria
curl --request POST \
  --url https://api.dooki.com.br/v2/{alias}/catalog/categories \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '
{
  "active": true,
  "name": "Categoria",
  "parent_id": 123,
  "home": true,
  "featured": false,
  "price_factor": 1,
  "slug": "categoria",
  "seo_title": "Título SEO para categoria",
  "seo_keywords": "palavras, chave, SEO",
  "seo_description": "Descrição SEO",
  "external_url": "https://www.link.com",
  "canonical_url": "https://www.link.com",
  "order": 1,
  "sort_by": "relevance",
  "banners_ids": [
    123
  ]
}
'
{
  "id": 123,
  "merchant_id": 123,
  "parent_id": 123,
  "active": true,
  "featured": true,
  "price_factor": 123,
  "total_banners": 0,
  "sort_by": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "url": "<string>",
  "description": "<string>",
  "external_url": "<string>",
  "canonical_url": "<string>",
  "order": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
User-Token
string
header
required
​
User-Secret-Key
string
header
required

Path Parameters

​
alias
string
required

Alias da loja

Body

application/json

Representa uma requisição para criar categorias

​
active
boolean
required
Example:

true

​
name
string
required
Example:

"Categoria"

​
parent_id
integer | null
​
home
boolean | null
​
featured
boolean
Example:

false

​
price_factor
number<float>
Example:

1

​
slug
string
Example:

"categoria"

​
seo_title
string

O valor é sanitizado e normalizado automaticamente.

Example:

"Título SEO para categoria"

​
seo_keywords
string
Example:

"palavras, chave, SEO"

​
seo_description
string

O valor é sanitizado e normalizado automaticamente.

Example:

"Descrição SEO"

​
external_url
string<url>
Example:

"https://www.link.com"

​
canonical_url
string<url>
Example:

"https://www.link.com"

​
order
integer
Example:

1

​
sort_by
string
Example:

"relevance"

​
banners_ids
integer[]

Response

Categoria criada com sucesso

​
id
integer
​
merchant_id
integer
read-only
​
parent_id
integer
​
active
boolean
​
featured
boolean
​
price_factor
number<float>
​
total_banners
integer
Example:

0

​
sort_by
string
​
name
string
​
slug
string
​
url
string<url>
​
description
string
​
external_url
string
​
canonical_url
string
​
order
integer