API atual/Referência completa/Kits, mestres e caixas

Modo catálogo

Diz se um produto, ou todos os produtos de um seller, são vendidos em modo catálogo (sem carrinho), com o link externo de compra quando existe.

Alguns sellers (lojistas) usam a loja como vitrine de catálogo: não vendem pelo carrinho, e o cliente pede orçamento ou compra em um link externo. Isso é o modo catálogo (catalog_mode), uma opção do seller que vale para todos os produtos dele. As duas rotas desta página servem para a interface decidir qual botão mostrar: "Adicionar ao carrinho", "Comprar agora" (link externo) ou "Solicitar orçamento".

As rotas são públicas e sempre existem, mesmo em lojas que nunca ligaram o modo catálogo (nelas, a resposta é simplesmente "não está em modo catálogo").

GET/api/v1/storefront/catalog-store/products/{id}Pública

Modo catálogo de um produto

Use na página do produto, onde há um único produto em mãos.

Parâmetros de caminho

iduuidobrigatório

Id do produto.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/catalog-store/products/5e833a7f-1a77-402c-835a-32594350d7a7"

Resposta

200Produto de um seller em modo catálogo

json

{
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "catalog_mode": true,
  "buy_now_url": "https://exemplo.com.br/comprar/cafeteira"
}

200Produto comum

json

{
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "catalog_mode": false,
  "buy_now_url": ""
}

Campos da resposta

vendor_iduuid

Seller dono do produto. Vazio ("") quando o produto é da própria loja.

catalog_modeboolean

true quando o seller está em modo catálogo: o produto não deve ter botão de carrinho.

buy_now_urlstring

Link externo de compra cadastrado no produto, ou vazio. É devolvido mesmo quando catalog_mode é false; só use-o se catalog_mode for true. Sem link, mostre "Solicitar orçamento".

Erros

Status	Quando	Corpo
404	Produto inexistente ou apagado.	`{"error":"PRODUCT_NOT_FOUND"}`
500	`id` que não é UUID, ou falha interna.	`{"error":"CATALOG_STORE_LOOKUP_FAILED","detail":"..."}`

GET/api/v1/storefront/catalog-store/vendorsPública

Sellers em modo catálogo

Devolve os ids de todos os sellers em modo catálogo, de uma vez. Use nas listagens (categoria, busca, página do seller): em vez de uma chamada por cartão de produto, busque este conjunto uma vez e esconda o botão de carrinho dos cartões cujo vendor_id esteja nele.

Exemplo de requisição (sellers)

bash

curl "$BASE_URL/api/v1/storefront/catalog-store/vendors"

Resposta (sellers)

200Sellers em modo catálogo

json

{ "vendor_ids": ["94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36"] }

Campos da resposta

vendor_idsarray

Ids (UUID) dos sellers em modo catálogo. Lista vazia, nunca erro, quando nenhum seller usa o modo ou a loja não o ativou.

Erros (sellers)

Status	Quando	Corpo
500	Falha interna.	`{"error":"CATALOG_VENDORS_LIST_FAILED","detail":"..."}`

Veja também

Modo catálogo

Diz se um produto, ou todos os produtos de um seller, são vendidos em modo catálogo (sem carrinho), com o link externo de compra quando existe.

As rotas são públicas e sempre existem, mesmo em lojas que nunca ligaram o modo catálogo (nelas, a resposta é simplesmente "não está em modo catálogo").

GET/api/v1/storefront/catalog-store/products/{id}Pública

Modo catálogo de um produto

Use na página do produto, onde há um único produto em mãos.

Parâmetros de caminho

iduuidobrigatório

Id do produto.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/catalog-store/products/5e833a7f-1a77-402c-835a-32594350d7a7"

Resposta

200Produto de um seller em modo catálogo

json

{
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "catalog_mode": true,
  "buy_now_url": "https://exemplo.com.br/comprar/cafeteira"
}

200Produto comum

json

{
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "catalog_mode": false,
  "buy_now_url": ""
}

Campos da resposta

vendor_iduuid

Seller dono do produto. Vazio ("") quando o produto é da própria loja.

catalog_modeboolean

true quando o seller está em modo catálogo: o produto não deve ter botão de carrinho.

buy_now_urlstring

Link externo de compra cadastrado no produto, ou vazio. É devolvido mesmo quando catalog_mode é false; só use-o se catalog_mode for true. Sem link, mostre "Solicitar orçamento".

Erros

Status	Quando	Corpo
404	Produto inexistente ou apagado.	`{"error":"PRODUCT_NOT_FOUND"}`
500	`id` que não é UUID, ou falha interna.	`{"error":"CATALOG_STORE_LOOKUP_FAILED","detail":"..."}`

GET/api/v1/storefront/catalog-store/vendorsPública

Sellers em modo catálogo

Exemplo de requisição (sellers)

bash

curl "$BASE_URL/api/v1/storefront/catalog-store/vendors"

Resposta (sellers)

200Sellers em modo catálogo

json

{ "vendor_ids": ["94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36"] }

Campos da resposta

vendor_idsarray

Ids (UUID) dos sellers em modo catálogo. Lista vazia, nunca erro, quando nenhum seller usa o modo ou a loja não o ativou.

Erros (sellers)

Status	Quando	Corpo
500	Falha interna.	`{"error":"CATALOG_VENDORS_LIST_FAILED","detail":"..."}`