v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB
Catálogo - Coleções

Atualizar coleção

Atualiza os detalhes de uma coleção específica

put/{alias}/catalog/collections/{id}

Path parameters

aliasstring required

Alias da loja

idinteger required

ID da coleção

Request body

activeboolean required
show_bannersboolean
featuredboolean
namestring required
visible_productsinteger
homeboolean required
slugstring
descriptionstring
seo_titlestring
seo_descriptionstring
seo_keywordsstring
start_atstring date-time required

Data e hora de início

end_atstring date-time required

Data e hora de término

stopwatchstring
urlstring uri
products_idsinteger[]
banners_idsinteger[]

Example request

{
  "active": true,
  "show_banners": true,
  "featured": true,
  "name": "Collection Test",
  "visible_products": 4,
  "home": true,
  "slug": "collection-test",
  "description": "Test description",
  "seo_title": "Page Title for SEO",
  "seo_description": "Meta Tag Description",
  "seo_keywords": "seo, keywords",
  "start_at": "2025-06-01 00:00:00",
  "end_at": "2025-08-10 00:00:00",
  "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
      ]
    }
  },
  "create_redirect": {
    "url_from": "/colecao-antiga",
    "url_to": "/colecao-nova"
  }
}

Response

Coleção atualizada com sucesso

idinteger
parent_idinteger
activeboolean
show_bannersboolean
featuredboolean
is_promotionalboolean
namestring
visible_productsinteger
homeboolean
expiredboolean
slugstring
descriptionstring
seo_titlestring
seo_keywordsstring
seo_descriptionstring
pathstring

Caminho relativo para o recurso.

expire_instring

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

total_productsinteger

Número total de produtos relacionados ao recurso.