Skip to main content
PUT
/
{alias}
/
catalog
/
collections
/
{id}
Atualizar coleção
curl --request PUT \
  --url https://api.dooki.com.br/v2/{alias}/catalog/collections/{id} \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '
{
  "active": true,
  "name": "Collection Test",
  "home": true,
  "start_at": "2025-06-01 00:00:00",
  "end_at": "2025-08-10 00:00:00",
  "show_banners": true,
  "featured": true,
  "visible_products": 4,
  "slug": "collection-test",
  "description": "Test description",
  "seo_title": "Page Title for SEO",
  "seo_description": "Meta Tag Description",
  "seo_keywords": "seo, keywords",
  "stopwatch": "daily",
  "url": "https://www.domain.com/collection/l",
  "products_ids": [
    1,
    2,
    3,
    4
  ],
  "banners_ids": [
    1,
    2,
    3,
    4
  ],
  "restrictions": {
    "include": {
      "brands_ids": [
        1,
        2,
        3,
        4
      ],
      "categories_ids": [
        143
      ]
    },
    "exclude": {
      "categories_ids": [
        141
      ]
    }
  }
}
'
{
  "id": 123,
  "parent_id": 123,
  "active": true,
  "show_banners": true,
  "featured": true,
  "is_promotional": true,
  "name": "<string>",
  "visible_products": 123,
  "home": true,
  "expired": true,
  "slug": "<string>",
  "description": "<string>",
  "seo_title": "<string>",
  "seo_keywords": "<string>",
  "seo_description": "<string>",
  "path": "<string>",
  "expire_in": "<string>",
  "total_products": 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.

Envie somente os campos obrigatórios e os que deseja alterar, para reduzir validações desnecessárias. Caso não envie um campo, o mesmo será mantido com o valor atual.

Authorizations

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

Path Parameters

​
alias
string
required

Alias da loja

​
id
integer
required

ID da coleção

Body

application/json

Dados para atualização da coleção

Representa os dados necessários para criar ou atualizar uma coleção de produtos

​
active
boolean
required
Example:

true

​
name
string
required
Example:

"Collection Test"

​
home
boolean
required
Example:

true

​
start_at
string<date-time>
required

Data e hora de início

Example:

"2025-06-01 00:00:00"

​
end_at
string<date-time>
required

Data e hora de término

Example:

"2025-08-10 00:00:00"

​
show_banners
boolean
Example:

true

​
featured
boolean
Example:

true

​
visible_products
integer
Example:

4

​
slug
string
Example:

"collection-test"

​
description
string
Example:

"Test description"

​
seo_title
string
Example:

"Page Title for SEO"

​
seo_description
string
Example:

"Meta Tag Description"

​
seo_keywords
string
Example:

"seo, keywords"

​
stopwatch
string
Example:

"daily"

​
url
string<uri>
Example:

"https://www.domain.com/collection/l"

​
products_ids
integer[]
Example:
[1, 2, 3, 4]
​
banners_ids
integer[]
Example:
[1, 2, 3, 4]
​
restrictions
object

Response

Coleção atualizada com sucesso

Representa uma coleção a qual um produto pertence

​
id
integer
​
parent_id
integer
​
active
boolean
​
show_banners
boolean
​
featured
boolean
​
is_promotional
boolean
​
name
string
​
visible_products
integer
​
home
boolean
​
expired
boolean
​
slug
string
​
description
string
​
seo_title
string
​
seo_keywords
string
​
seo_description
string
​
path
string

Caminho relativo para o recurso.

​
expire_in
string

Tempo restante até a expiração, descrito em formato textual (ex.: 'dentro de 998 anos').

​
total_products
integer

Número total de produtos relacionados ao recurso.