API atual/Referência completa/Catálogo: kits, mix e compartilhamento

Modo catálogo

Lista os sellers com a situação do modo catálogo e liga ou desliga o modo para um seller, trocando "comprar" por "pedir orçamento".

No modo catálogo, os produtos de um seller (lojista) são exibidos, mas não vendidos direto pelo carrinho. Na página do produto, no lugar de "Adicionar ao carrinho", a vitrine mostra "Pedir orçamento" ou, se o produto tem um link externo (buy_now_url), "Comprar agora" apontando para o site do seller. É o modelo de vitrine de fabricante ou distribuidor que fecha o pedido fora da plataforma.

O administrador vê todos os sellers e liga ou desliga o modo de qualquer um. O próprio seller também pode fazê-lo pelo painel dele, e define o link de compra de cada produto pela API de seller. As duas rotas exigem o módulo catalog-store ligado.

Listar sellers e o modo

GET/api/v1/admin/catalog-storeAdmin

Listar sellers com a situação do modo catálogo

Devolve todos os sellers não apagados, em ordem alfabética pelo nome da empresa, sem paginação.

Parâmetros de consulta

only_enabledbooleanpadrão: false

Com true, devolve só os sellers que já estão em modo catálogo. Qualquer outro valor é ignorado.

bash

curl "$BASE_URL/api/v1/admin/catalog-store?only_enabled=true" \
  -H "Authorization: Bearer $TOKEN"

200Sellers

json

{
  "vendors": [
    {
      "id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "company_name": "Distribuidora Exemplo",
      "slug": "distribuidora-exemplo",
      "status": "A",
      "catalog_mode": true
    }
  ],
  "total": 1
}

Campos da resposta

vendorsarray

Sellers.

vendors[].iduuid

Id do seller.

vendors[].company_namestring

Razão ou nome fantasia.

vendors[].slugstring

Nome curto do seller na URL. Vazio quando não há.

vendors[].statusstring

Letra de status do seller (A ativo).

vendors[].catalog_modeboolean

Se o seller está em modo catálogo.

totalinteger

Quantidade de sellers no vetor.

Ligar ou desligar para um seller

PUT/api/v1/admin/catalog-store/vendors/{vendorId}Admin

Ligar ou desligar o modo catálogo de um seller

Define o modo catálogo do seller. A vitrine passa a mostrar (ou deixa de mostrar) o botão de orçamento nos produtos dele na próxima consulta.

Parâmetros de caminho

vendorIduuidobrigatório

Id do seller.

Corpo da requisição

catalog_modebooleanobrigatório

true liga, false desliga. Se omitido, vale false e desliga o modo.

bash

curl -X PUT "$BASE_URL/api/v1/admin/catalog-store/vendors/94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"catalog_mode": true}'

200Modo atualizado

json

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

Erros

Os códigos de erro desta área são palavras em maiúsculas.

Status	Quando	Corpo de exemplo
400	Corpo do `PUT` que não é JSON.	`{"error":"INVALID_BODY","detail":"..."}`
401	Sem token ou token expirado.	`{"error":"invalid or expired token"}`
403	Módulo desligado (porta de entrada).	`{"error":"module_disabled","module":"catalog-store"}`
403	Módulo desligado (checagem interna do `PUT`).	`{"error":"CATALOG_STORE_MODULE_DISABLED","detail":"..."}`
500	Seller que não existe ou foi apagado, ou `{vendorId}` que não é UUID.	`{"error":"CATALOG_MODE_UPDATE_FAILED","detail":"vendor 0000... not found"}`

Veja também

Modo catálogo

Lista os sellers com a situação do modo catálogo e liga ou desliga o modo para um seller, trocando "comprar" por "pedir orçamento".

Listar sellers e o modo

GET/api/v1/admin/catalog-storeAdmin

Listar sellers com a situação do modo catálogo

Devolve todos os sellers não apagados, em ordem alfabética pelo nome da empresa, sem paginação.

Parâmetros de consulta

only_enabledbooleanpadrão: false

Com true, devolve só os sellers que já estão em modo catálogo. Qualquer outro valor é ignorado.

bash

curl "$BASE_URL/api/v1/admin/catalog-store?only_enabled=true" \
  -H "Authorization: Bearer $TOKEN"

200Sellers

json

{
  "vendors": [
    {
      "id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "company_name": "Distribuidora Exemplo",
      "slug": "distribuidora-exemplo",
      "status": "A",
      "catalog_mode": true
    }
  ],
  "total": 1
}

Campos da resposta

vendorsarray

Sellers.

vendors[].iduuid

Id do seller.

vendors[].company_namestring

Razão ou nome fantasia.

vendors[].slugstring

Nome curto do seller na URL. Vazio quando não há.

vendors[].statusstring

Letra de status do seller (A ativo).

vendors[].catalog_modeboolean

Se o seller está em modo catálogo.

totalinteger

Quantidade de sellers no vetor.

Ligar ou desligar para um seller

PUT/api/v1/admin/catalog-store/vendors/{vendorId}Admin

Ligar ou desligar o modo catálogo de um seller

Define o modo catálogo do seller. A vitrine passa a mostrar (ou deixa de mostrar) o botão de orçamento nos produtos dele na próxima consulta.

Parâmetros de caminho

vendorIduuidobrigatório

Id do seller.

Corpo da requisição

catalog_modebooleanobrigatório

true liga, false desliga. Se omitido, vale false e desliga o modo.

bash

curl -X PUT "$BASE_URL/api/v1/admin/catalog-store/vendors/94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"catalog_mode": true}'

200Modo atualizado

json

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

Erros

Os códigos de erro desta área são palavras em maiúsculas.

Status	Quando	Corpo de exemplo
400	Corpo do `PUT` que não é JSON.	`{"error":"INVALID_BODY","detail":"..."}`
401	Sem token ou token expirado.	`{"error":"invalid or expired token"}`
403	Módulo desligado (porta de entrada).	`{"error":"module_disabled","module":"catalog-store"}`
403	Módulo desligado (checagem interna do `PUT`).	`{"error":"CATALOG_STORE_MODULE_DISABLED","detail":"..."}`
500	Seller que não existe ou foi apagado, ou `{vendorId}` que não é UUID.	`{"error":"CATALOG_MODE_UPDATE_FAILED","detail":"vendor 0000... not found"}`