Skip to main content
GET
/
{alias}
/
public
/
catalog
/
collections
?id[]=
{collectionId}
{
  "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,
  "restriced": true,
  "url": "<string>",
  "stopwatch": "<string>",
  "stopwatch_expires_in": "<string>",
  "start_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "end_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "products": [
    {
      "data": {
        "id": "<any>",
        "sku_id": "<any>",
        "gift_value": "<any>",
        "simple": "<any>",
        "has_variations": "<any>",
        "is_digital": "<any>",
        "warranty": "<any>",
        "custom_shipping": "<any>",
        "shipping_price": "<any>",
        "name": "<any>",
        "slug": "<any>",
        "sku": "<any>",
        "blocked_sale": "<any>",
        "rating": "<any>",
        "total_approved_reviews": "<any>",
        "url": "<any>",
        "url_path": "<any>",
        "use_different_images": "<any>",
        "brand": "<any>",
        "images": "<any>",
        "prices": "<any>",
        "flags": "<any>",
        "variations": "<any>",
        "skus": "<any>",
        "extras": "<any>",
        "texts": "<any>",
        "seo": "<any>",
        "categories": "<any>",
        "breadcrumbs": "<any>"
      }
    }
  ],
  "banners": [
    {
      "data": [
        {
          "id": 119474,
          "product_id": null,
          "type": "image",
          "active": true,
          "home": true,
          "name": "Top-banner",
          "slug": "top-banner",
          "image_url": "//images.yampi.me/assets/stores/mytems/uploads/banners/62c6fbff0fddc.jpg",
          "mobile_image_url": null,
          "link": null,
          "expired": false,
          "stopwatch": null,
          "stopwatch_expires_in": null,
          "start_at": {
            "date": "2025-01-21 10:35:41.000000",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "end_at": {
            "date": "3024-01-21 10:35:41.000000",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "first_banner": {
            "id": 119474,
            "link": null,
            "image": "//images.yampi.me/assets/stores/mytems/uploads/banners/62c6fbff0fddc.jpg",
            "mobile_image": null,
            "stopwatch": null
          },
          "dimensions": {
            "desktop": {
              "width": "1186.00",
              "height": "441.00"
            },
            "mobile": {
              "width": "0.00",
              "height": "0.00"
            }
          },
          "product": {
            "data": [
              {
                "data": {
                  "id": "<any>",
                  "sku_id": "<any>",
                  "gift_value": "<any>",
                  "simple": "<any>",
                  "has_variations": "<any>",
                  "is_digital": "<any>",
                  "warranty": "<any>",
                  "custom_shipping": "<any>",
                  "shipping_price": "<any>",
                  "name": "<any>",
                  "slug": "<any>",
                  "sku": "<any>",
                  "blocked_sale": "<any>",
                  "rating": "<any>",
                  "total_approved_reviews": "<any>",
                  "url": "<any>",
                  "url_path": "<any>",
                  "use_different_images": "<any>",
                  "brand": "<any>",
                  "images": "<any>",
                  "prices": "<any>",
                  "flags": "<any>",
                  "variations": "<any>",
                  "skus": "<any>",
                  "extras": "<any>",
                  "texts": "<any>",
                  "seo": "<any>",
                  "categories": "<any>",
                  "breadcrumbs": "<any>"
                }
              }
            ]
          }
        }
      ]
    }
  ]
}

Authorizations

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

Path Parameters

alias
string
required

Alias da loja

Query Parameters

id[]
string
required

ID da coleção - exemplo: /{alias}/public/catalog/collections?id[]=5287&id[]=7821

Response

Retorna as Informações públicas de uma Coleção

Representa uma coleção do catálogo Representa uma coleção a qual um produto pertence

id
integer
parent_id
integer
active
boolean
show_banners
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.

restriced
boolean
url
string<uri>
stopwatch
string
stopwatch_expires_in
string
start_at
object
end_at
object
created_at
object
updated_at
object
products
object[]
banners
object[]
I