API atual/Referência completa/Catálogo mestre e visibilidade

Modo catálogo

Liga ou desliga o modo catálogo do seller (sem carrinho) e define o link "Comprar agora" de cada produto.

O modo catálogo é para o seller que mostra produtos na loja, mas fecha a venda fora da plataforma (showroom, atacado, venda por representante). Com ele ligado, todos os produtos do seller perdem o botão "Adicionar ao carrinho" na vitrine. Cada produto pode ter um link externo "Comprar agora". O módulo catalog-store precisa estar ligado na loja.

Ler o modo catálogo

GET/api/v1/vendor/catalog-storeSeller

Ver se o modo catálogo está ligado

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário do painel do seller (lojista), obtido no login (veja Tokens).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/catalog-store" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Estado

json

{
  "vendor_id": "7c1f0b52-3a64-4d1e-9a40-5f0c2b6a91d3",
  "catalog_mode": true
}

Campos da resposta

vendor_iduuid

Seu seller.

catalog_modeboolean

true se o modo catálogo está ligado.

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` / `{"error":"invalid or expired token"}`
403	O token não é de um usuário seller (por exemplo, é de um administrador da loja).	`{"error":"insufficient permissions"}`
403	O cadastro do seller ainda está em análise (só a tela de cadastro funciona até a aprovação).	`{"error":"vendor_pending_review","message":"..."}`
403	O módulo `catalog-store` está desligado nesta loja.	`{"error":"module_disabled","module":"catalog-store"}`
403	O usuário da equipe do seller não tem nenhum dos privilégios exigidos: `vendor_settings`, `vendor_view_settings`, `vendor_manage_delivery_areas`, `vendor_manage_whatsapp`, `vendor_manage_documents`, `vendor_manage_kyc`, `vendor_view_plan`, `vendor_manage_application`, `vendor_manage_vacation`.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings","vendor_view_settings","vendor_manage_delivery_areas","vendor_manage_whatsapp","vendor_manage_documents","vendor_manage_kyc","vendor_view_plan","vendor_manage_application","vendor_manage_vacation"]}`
404	O usuário não está ligado a nenhum seller.	`{"error":"VENDOR_NOT_FOUND"}`

Ligar ou desligar

PUT/api/v1/vendor/catalog-storeSeller

Ligar ou desligar o modo catálogo

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário do painel do seller (lojista), obtido no login (veja Tokens).

Content-Typestringobrigatório

application/json.

Corpo da requisição

catalog_modebooleanobrigatório

true liga, false desliga. Omitido, vale false (desliga).

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/vendor/catalog-store" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "catalog_mode": true
}'

Resposta

200Estado gravado

json

{
  "vendor_id": "7c1f0b52-3a64-4d1e-9a40-5f0c2b6a91d3",
  "catalog_mode": true
}

Campos da resposta

vendor_iduuid

Seu seller.

catalog_modeboolean

O valor gravado.

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` / `{"error":"invalid or expired token"}`
403	O token não é de um usuário seller (por exemplo, é de um administrador da loja).	`{"error":"insufficient permissions"}`
403	O cadastro do seller ainda está em análise (só a tela de cadastro funciona até a aprovação).	`{"error":"vendor_pending_review","message":"..."}`
403	O usuário da equipe do seller não tem nenhum dos privilégios exigidos: `vendor_settings`, `vendor_view_settings`, `vendor_manage_delivery_areas`, `vendor_manage_whatsapp`, `vendor_manage_documents`, `vendor_manage_kyc`, `vendor_view_plan`, `vendor_manage_application`, `vendor_manage_vacation`.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings","vendor_view_settings","vendor_manage_delivery_areas","vendor_manage_whatsapp","vendor_manage_documents","vendor_manage_kyc","vendor_view_plan","vendor_manage_application","vendor_manage_vacation"]}`
400	Corpo que não é JSON.	`{"error":"INVALID_BODY","detail":"..."}`
403	O módulo `catalog-store` está desligado. Vem como `module_disabled` (rota) ou como `CATALOG_STORE_MODULE_DISABLED` (gravação).	`{"error":"module_disabled","module":"catalog-store"}` / `{"error":"CATALOG_STORE_MODULE_DISABLED","detail":"..."}`
404	O usuário não está ligado a nenhum seller.	`{"error":"VENDOR_NOT_FOUND"}`

Link Comprar agora

Grava o link externo que o botão "Comprar agora" do produto abre (por exemplo, o WhatsApp do vendedor ou uma página de pedido). Vale só para produto seu. Enviar "" apaga o link.

PUT/api/v1/vendor/catalog-store/products/{id}/buy-nowSeller

Link 'Comprar agora' de um produto

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário do painel do seller (lojista), obtido no login (veja Tokens).

Content-Typestringobrigatório

application/json.

Parâmetros de caminho

iduuidobrigatório

Id do produto.

Corpo da requisição

buy_now_urlstringobrigatório

URL absoluta http:// ou https:// com domínio, ou "" para apagar.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/vendor/catalog-store/products/$PRODUCT_ID/buy-now" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "buy_now_url": "https://wa.me/5511987654321?text=Quero%20a%20cafeteira"
}'

Resposta

200Link gravado

json

{
  "product_id": "0c5a7e14-3b2d-4c19-8f66-7a1d2e3f4b50",
  "buy_now_url": "https://wa.me/5511987654321?text=Quero%20a%20cafeteira"
}

Campos da resposta

product_iduuid

Produto.

buy_now_urlstring

O link gravado (como enviado).

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` / `{"error":"invalid or expired token"}`
403	O token não é de um usuário seller (por exemplo, é de um administrador da loja).	`{"error":"insufficient permissions"}`
403	O cadastro do seller ainda está em análise (só a tela de cadastro funciona até a aprovação).	`{"error":"vendor_pending_review","message":"..."}`
403	O usuário da equipe do seller não tem nenhum dos privilégios exigidos: `vendor_catalog`, `vendor_view_catalog`, `vendor_manage_products`, `vendor_manage_master`, `vendor_manage_mix`, `vendor_manage_quotes`, `vendor_manage_features`, `vendor_import_products`.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog","vendor_view_catalog","vendor_manage_products","vendor_manage_master","vendor_manage_mix","vendor_manage_quotes","vendor_manage_features","vendor_import_products"]}`
400	URL inválida, ou corpo que não é JSON.	`{"error":"invalid_buy_now_url","detail":"invalid buy_now_url: must be empty or http(s) URL"}`
403	O produto é de outro seller, ou o módulo está desligado.	`{"error":"PRODUCT_OWNERSHIP_REQUIRED"}` / `{"error":"module_disabled","module":"catalog-store"}`
404	Produto inexistente ou excluído.	`{"error":"PRODUCT_NOT_FOUND","detail":"..."}`

API atual/Referência completa/Catálogo mestre e visibilidade

Modo catálogo

Liga ou desliga o modo catálogo do seller (sem carrinho) e define o link "Comprar agora" de cada produto.

Ler o modo catálogo

GET/api/v1/vendor/catalog-storeSeller

Ver se o modo catálogo está ligado

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário do painel do seller (lojista), obtido no login (veja Tokens).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/catalog-store" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Estado

json

{
  "vendor_id": "7c1f0b52-3a64-4d1e-9a40-5f0c2b6a91d3",
  "catalog_mode": true
}

Campos da resposta

vendor_iduuid

Seu seller.

catalog_modeboolean

true se o modo catálogo está ligado.

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` / `{"error":"invalid or expired token"}`
403	O token não é de um usuário seller (por exemplo, é de um administrador da loja).	`{"error":"insufficient permissions"}`
403	O cadastro do seller ainda está em análise (só a tela de cadastro funciona até a aprovação).	`{"error":"vendor_pending_review","message":"..."}`
403	O módulo `catalog-store` está desligado nesta loja.	`{"error":"module_disabled","module":"catalog-store"}`
403	O usuário da equipe do seller não tem nenhum dos privilégios exigidos: `vendor_settings`, `vendor_view_settings`, `vendor_manage_delivery_areas`, `vendor_manage_whatsapp`, `vendor_manage_documents`, `vendor_manage_kyc`, `vendor_view_plan`, `vendor_manage_application`, `vendor_manage_vacation`.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings","vendor_view_settings","vendor_manage_delivery_areas","vendor_manage_whatsapp","vendor_manage_documents","vendor_manage_kyc","vendor_view_plan","vendor_manage_application","vendor_manage_vacation"]}`
404	O usuário não está ligado a nenhum seller.	`{"error":"VENDOR_NOT_FOUND"}`

Ligar ou desligar

PUT/api/v1/vendor/catalog-storeSeller

Ligar ou desligar o modo catálogo

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário do painel do seller (lojista), obtido no login (veja Tokens).

Content-Typestringobrigatório

application/json.

Corpo da requisição

catalog_modebooleanobrigatório

true liga, false desliga. Omitido, vale false (desliga).

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/vendor/catalog-store" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "catalog_mode": true
}'

Resposta

200Estado gravado

json

{
  "vendor_id": "7c1f0b52-3a64-4d1e-9a40-5f0c2b6a91d3",
  "catalog_mode": true
}

Campos da resposta

vendor_iduuid

Seu seller.

catalog_modeboolean

O valor gravado.

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` / `{"error":"invalid or expired token"}`
403	O token não é de um usuário seller (por exemplo, é de um administrador da loja).	`{"error":"insufficient permissions"}`
403	O cadastro do seller ainda está em análise (só a tela de cadastro funciona até a aprovação).	`{"error":"vendor_pending_review","message":"..."}`
403	O usuário da equipe do seller não tem nenhum dos privilégios exigidos: `vendor_settings`, `vendor_view_settings`, `vendor_manage_delivery_areas`, `vendor_manage_whatsapp`, `vendor_manage_documents`, `vendor_manage_kyc`, `vendor_view_plan`, `vendor_manage_application`, `vendor_manage_vacation`.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings","vendor_view_settings","vendor_manage_delivery_areas","vendor_manage_whatsapp","vendor_manage_documents","vendor_manage_kyc","vendor_view_plan","vendor_manage_application","vendor_manage_vacation"]}`
400	Corpo que não é JSON.	`{"error":"INVALID_BODY","detail":"..."}`
403	O módulo `catalog-store` está desligado. Vem como `module_disabled` (rota) ou como `CATALOG_STORE_MODULE_DISABLED` (gravação).	`{"error":"module_disabled","module":"catalog-store"}` / `{"error":"CATALOG_STORE_MODULE_DISABLED","detail":"..."}`
404	O usuário não está ligado a nenhum seller.	`{"error":"VENDOR_NOT_FOUND"}`

Link Comprar agora

Grava o link externo que o botão "Comprar agora" do produto abre (por exemplo, o WhatsApp do vendedor ou uma página de pedido). Vale só para produto seu. Enviar "" apaga o link.

PUT/api/v1/vendor/catalog-store/products/{id}/buy-nowSeller

Link 'Comprar agora' de um produto

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário do painel do seller (lojista), obtido no login (veja Tokens).

Content-Typestringobrigatório

application/json.

Parâmetros de caminho

iduuidobrigatório

Id do produto.

Corpo da requisição

buy_now_urlstringobrigatório

URL absoluta http:// ou https:// com domínio, ou "" para apagar.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/vendor/catalog-store/products/$PRODUCT_ID/buy-now" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "buy_now_url": "https://wa.me/5511987654321?text=Quero%20a%20cafeteira"
}'

Resposta

200Link gravado

json

{
  "product_id": "0c5a7e14-3b2d-4c19-8f66-7a1d2e3f4b50",
  "buy_now_url": "https://wa.me/5511987654321?text=Quero%20a%20cafeteira"
}

Campos da resposta

product_iduuid

Produto.

buy_now_urlstring

O link gravado (como enviado).

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` / `{"error":"invalid or expired token"}`
403	O token não é de um usuário seller (por exemplo, é de um administrador da loja).	`{"error":"insufficient permissions"}`
403	O cadastro do seller ainda está em análise (só a tela de cadastro funciona até a aprovação).	`{"error":"vendor_pending_review","message":"..."}`
403	O usuário da equipe do seller não tem nenhum dos privilégios exigidos: `vendor_catalog`, `vendor_view_catalog`, `vendor_manage_products`, `vendor_manage_master`, `vendor_manage_mix`, `vendor_manage_quotes`, `vendor_manage_features`, `vendor_import_products`.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog","vendor_view_catalog","vendor_manage_products","vendor_manage_master","vendor_manage_mix","vendor_manage_quotes","vendor_manage_features","vendor_import_products"]}`
400	URL inválida, ou corpo que não é JSON.	`{"error":"invalid_buy_now_url","detail":"invalid buy_now_url: must be empty or http(s) URL"}`
403	O produto é de outro seller, ou o módulo está desligado.	`{"error":"PRODUCT_OWNERSHIP_REQUIRED"}` / `{"error":"module_disabled","module":"catalog-store"}`
404	Produto inexistente ou excluído.	`{"error":"PRODUCT_NOT_FOUND","detail":"..."}`