VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Kits, mix e compartilhamento

Quatro ferramentas que ajudam a vender mais de um produto por vez ou por indicação, e quando cada uma faz sentido.

Esta seção reúne quatro ferramentas de venda que não são cadastro de produto: o mix de produtos (um pacote com preço fechado que o cliente monta), as listas sugeridas (kits prontos com quantidades prescritas), o modo catálogo (seller que só exibe produtos, sem carrinho) e o compartilhamento (links de indicação que rendem pontos).

Pontos-chave
  • Mix, listas sugeridas e modo catálogo dependem de módulos que a loja liga (mix-products, suggested-lists, catalog-store). Desligado, a resposta é 403 module_disabled.
  • Todos os valores em dinheiro são inteiros em centavos (kit_price: 8990 é R$ 89,90).
  • Um mix é montado pelo cliente (escolhe entre componentes); uma lista sugerida é um kit fixo, com quantidades prescritas.
  • A lista sugerida guarda o kit_price, mas a plataforma não cria sozinha a promoção que o aplica no carrinho (veja a página dela).
  • O compartilhamento tem só duas rotas de leitura e uma de configuração, e todas exigem manage_settings.

Como escolher

Quero...Use
Vender um pacote em que o cliente escolhe trocas ("monte seu kit com 3 itens") e o total é fechadoMix de produtos
Mostrar kits prontos, cada um com produtos e quantidades fixas, na vitrineListas sugeridas
Deixar um seller só mostrar o catálogo, sem compra diretaModo catálogo
Recompensar clientes que indicam produtos por linkCompartilhamento

Conceitos-chave

Status em letra

Mix e listas sugeridas guardam o status em uma letra: A ativo, D desativado, H oculto (no mix). Nas listas sugeridas a API aceita também a palavra (active, disabled) na entrada e devolve a letra.

Visibilidade do mix

Um mix tem uma de três visibilidades na vitrine: public (qualquer cliente vê), customer-list (só quem foi atribuído, por cliente ou por grupo de usuários) e private (só o cliente atribuído diretamente, nunca por grupo). private é o padrão quando você não informa.

Dono do registro

Um mix pode pertencer a um seller (vendor_id) ou à loja (sem vendor_id). O administrador lê e altera os de todos.

Endpoints

Método e caminhoPara que serveAutenticaçãoPágina
GET /api/v1/admin/mix-productsLista mixesadministradorMix de produtos
POST /api/v1/admin/mix-productsCria mixadministradorMix de produtos
GET /api/v1/admin/mix-products/{id}Lê um mixadministradorMix de produtos
PUT /api/v1/admin/mix-products/{id}Altera mixadministradorMix de produtos
DELETE /api/v1/admin/mix-products/{id}Apaga mixadministradorMix de produtos
GET /api/v1/admin/suggested-listsLista kitsadministradorListas sugeridas
POST /api/v1/admin/suggested-listsCria kitadministradorListas sugeridas
GET /api/v1/admin/suggested-lists/{id}Lê um kitadministradorListas sugeridas
PUT /api/v1/admin/suggested-lists/{id}Altera kitadministradorListas sugeridas
DELETE /api/v1/admin/suggested-lists/{id}Apaga kitadministradorListas sugeridas
GET /api/v1/admin/catalog-storeLista sellers e o modo catálogoadministradorModo catálogo
PUT /api/v1/admin/catalog-store/vendors/{vendorId}Liga ou desliga o modo catálogoadministradorModo catálogo
GET /api/v1/admin/sharing/settingsLê a recompensaadministradorCompartilhamento
PUT /api/v1/admin/sharing/settingsAltera a recompensaadministradorCompartilhamento
GET /api/v1/admin/sharing/reportRelatório de indicaçõesadministradorCompartilhamento

Erros comuns

  • Criar um mix sem componentes. 400 invalid_input: ao menos um componente é obrigatório.
  • min_components maior que max_components. 400.
  • Mandar a lista de components em um PUT de mix achando que acrescenta. Ela substitui todos os componentes.
  • Esperar que o kit_price desconte sozinho no carrinho. A lista só guarda e exibe o preço.
  • Alterar o modo catálogo com o módulo desligado. 403 CATALOG_STORE_MODULE_DISABLED.
  • Mandar um id que não é UUID para o mix. Dá 500, não 400.

Próximos passos

Mix de produtos
Pacote com preço fechado e trocas.
Listas sugeridas
Kits prontos para a vitrine.
Compartilhamento
Pontos por indicação.
Anterior
Conjuntos de dados
Próxima
Mix de produtos
Nesta página
  • Como escolher
  • Conceitos-chave
  • Status em letra
  • Visibilidade do mix
  • Dono do registro
  • Endpoints
  • Erros comuns
  • Próximos passos