Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Módulo Vuex que disponibiliza os dados completos da loja, carregados server-side e injetados em window.merchant. Também expõe o mixin merchant para acesso simplificado nos componentes.

​
Getters

GetterTipoDescrição
merchantObjectDados completos da loja: nome, alias, domínio, checkout, módulos, métodos de pagamento, etc.
defaultCardObject|nullMétodo de pagamento padrão (cartão de crédito configurado como padrão na loja).
creditCardOnlyArrayLista de métodos de pagamento que são cartões de crédito (exclui Pix, boleto, etc.).
storeModulesObjectFlags de módulos ativos na loja (ex: { new_search: true }).

​
Principais propriedades de merchant

PropriedadeTipoDescrição
merchant.nameStringNome da loja.
merchant.aliasStringAlias da loja (usado em URLs da API).
merchant.idNumberID da loja.
merchant.checkoutObjectConfigurações do checkout: URLs, tokens, cartão padrão.
merchant.paymentsArrayMétodos de pagamento ativos na loja.
merchant.logo_urlStringURL do logo da loja.

​
Uso

import { mapGetters } from 'vuex';

export default {
    computed: {
        ...mapGetters('merchant', ['merchant', 'defaultCard']),

        hasPixPayment() {
            return this.merchant.payments.some(p => p.alias === 'pix');
        },
    },
};