Sign in

v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB
Catálogo - Produtos

Listar produtos

Retorna uma lista de produtos

get/{alias}/catalog/products

Path parameters

aliasstring required

Alias da loja

Query parameters

includestring[]

Incluir relacionamentos adicionais

[
  "?include=dates,brand"
]
customizationboolean

Indica se o produto contém customizações.

custom_shippingboolean

Indica se o produto utiliza frete customizado.

shopify_idinteger

ID do produto no Shopify.

variations_typeinteger

Indica se o produto possui variantes (ativa=1 ou inativa=0).

activeinteger

Status do produto (ativa=1 ou inativa=0).

brand_idinteger[]

IDs das marcas associadas aos produtos.

category_idinteger[]

IDs das categorias associadas aos produtos.

flag_idinteger[]

IDs dos selos associados aos produtos.

collection_idinteger[]

IDs das coleções associadas aos produtos.

not_collection_idinteger[]

IDs das coleções a serem excluídas da busca.

priorityinteger[]

Filtra produtos pela prioridade definida.

qstring

Termo de busca para pesquisa personalizada.

qualitystring[]

Filtro de qualidade e completude do cadastro do produto.

orderBy'total_in_stock'

Ordenação especial.

{
  "active": 1,
  "brand_id": [
    3,
    5
  ],
  "category_id": [
    8,
    12
  ],
  "flag_id": [
    2,
    4
  ],
  "collection_id": [
    1,
    3
  ],
  "not_collection_id": [
    1,
    3
  ],
  "priority": [
    1
  ],
  "q": "nome-do-produto",
  "quality": [
    "with_images"
  ],
  "orderBy": "total_in_stock"
}

Response

Lista de produtos

Example response

{
  "data": [
    {
      "id": 12345678,
      "merchant_id": 1,
      "active": true,
      "searchable": true,
      "is_digital": true,
      "rating": 4,
      "slug": "nome-do-produto",
      "custom_shipping": true,
      "shipping_price": 39.9,
      "simple": true,
      "has_variations": true,
      "sku": "SKU-TEST-API",
      "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"
      }
    }
  ]
}