Referência de variáveis de notificações
As notificações da loja são processadas com o Liquid, a linguagem de programação simples e fácil de usar da Shopify. É a mesma usada no desenvolvimento dos temas disponíveis na Loja de temas.
Para editar as notificações enviadas da loja, é possível fazer personalizações básicas nos modelos disponíveis. Acesse a lista completa na página Notificações no seu admin da Shopify.
Para receber ajuda com mudanças mais avançadas ou realizar alterações nos modelos de notificação personalizados, entre em contato com a Comunidade nos fóruns ou contrate um Parceiro da Shopify para fazer as customizações. Saiba mais sobre como contratar um Parceiro da Shopify.
Nesta página
- Propriedades de pedido
- Propriedades do rascunho de pedido
- Propriedades de cronograma de pagamento
- Propriedades de status de pagamento
- Propriedades do item de linha
- Propriedades de reembolsos
- Propriedades de processamento de pedidos
- Propriedades dos pacotes preparados
- Propriedades de entrega
- Propriedades de desconto
- Propriedades da assinatura
- Propriedades de notificação por e-mail
Propriedades de pedido
Muitas propriedades de um pedido estão disponíveis diretamente usando o Liquid, em modelos e em scripts adicionais.
Propriedade | Descrição |
---|---|
id |
Um ID exclusivo do pedido para uso interno em todo o sistema. Utilize o exemplo a seguir e gere um link para o pedido na seção admin da loja. Por exemplo, no modelo Novo pedido, adicione o seguinte código: <a href="{{ shop.url }}/admin/orders/{{ id }}">Ver pedido</a> |
O e-mail associado ao pedido. | |
name |
Normalmente, trata-se de um antífen (#, que equivale a "nº") seguido por Exemplo: #1004 |
order_name |
O mesmo que o nome. |
order_number |
Número exclusivo do pedido na loja, sem o # ou outro prefixo ou sufixo adicionado ao ID de pedido pelo titular nas preferências. Exemplo: 1004 |
confirmation_number |
Um identificador alfanumérico gerado aleatoriamente que pode ser mostrado ao cliente em vez do nome sequencial do pedido. Não há garantia de que esse valor será exclusivo. Exemplo: XPAV284CT |
created_at |
Data e hora em que o cliente fez o pedido. É possível formatar usando o filtro de data. Exemplo: 2009-05-30T17:43:51+02:00 |
payment_terms |
Os termos de pagamento especificam a data em que um pedido deve ser pago. Saiba como adicionar condições de pagamento às faturas de pedido. Para saber mais, consulte a referência do Liquid para payment_terms. |
destination |
O destino para o qual os itens precisam ser enviados. |
tags |
Retorna uma matriz de todas as tags do pedido em ordem alfabética. Veja mais informações na documentação de referência do Liquid. |
transactions |
Retorna uma matriz de transações do pedido. |
tax_price |
Os tributos combinados de todos os itens no pedido. |
tax_lines |
Tributos discriminados por tipo:
|
tax_line.title |
Nome do tributo. Exemplos: QST ou IVA |
tax_line.price |
Quantidade. |
tax_line.rate |
A taxa. Retornará 0,175 se for 17,5%. |
tax_line.rate_percentage |
A taxa de tributo em forma legível para humanos. Ele retornará 17,5 se a taxa for 0,175. |
customer |
Objeto de cliente que contém os atributos da saída do cliente. |
billing_address |
O endereço de faturamento. |
billing_address.first_name |
Primeiro nome do cliente. |
billing_address.last_name |
Sobrenome do cliente. |
billing_address.company |
Nome da empresa para faturamento. |
billing_address.phone |
Número de telefone do endereço de faturamento. |
shop.name |
Nome da sua loja. |
shop.phone |
Número de telefone da sua loja. |
subtotal_price |
Soma dos preços de item de linha do pedido após a dedução de desconto no produto ou no carrinho. O subtotal não inclui tributos (a menos que incluídos nos preços), custos de frete ou gorjetas. |
discounts |
Uma lista de descontos. |
discounts_amount |
Valor total aplicado por todos os descontos. Exemplo: +US$ 5,00 |
discounts_savings |
Valor economizado devido aos descontos. Exemplo: -US$ 5,00 |
total_price |
Total da encomenda (subtotal + custo de frete - desconto de frete + tributo). |
financial_status |
O status atual do pagamento. Pode ser: nulo, pendente , autorizado , pago , anulado , reembolsado . |
requires_shipping |
(boolean) Retorna "true" se houver pelo menos um item no pedido que requer frete. |
shipping_method.title |
O nome da taxa de frete. Nas notificações para compradores, o nome da taxa de frete é traduzido para o idioma usado pelo cliente no checkout se ele for diferente do padrão da loja. Exemplo: padrão |
shipping_method.price |
O preço do frete, incluindo qualquer desconto de frete existente. Exemplo: |
shipping_price |
O preço de frete. Exemplo: |
shipping_address |
O endereço de entrega. |
shipping_address.first_name |
O primeiro nome do endereço de entrega. |
shipping_address.company |
Nome da empresa do endereço de entrega. |
shipping_address.phone |
Número de telefone do endereço de entrega. |
line_items |
Lista de todos os itens de linha no pedido. |
item_count |
Uma soma de todas as quantidades dos itens. |
fulfillment_status |
O status de processamento do pedido atual. Pode ser: não processado , parcial , processado . |
note |
A observação anexada ao pedido. A observação pode ser obtida do cliente e/ou editada na tela de detalhes do pedido em sua interface administrativa. |
attributes |
Os atributos anexados ao pedido. Exemplo: |
referring_site |
Contém o URL do referenciador que levou o cliente à sua loja. Exemplo: |
landing_site |
Contém o caminho do site que o cliente usou. Esta é a primeira página que o cliente viu quando chegou à loja. Exemplo: |
landing_site_ref |
Olha para o local de pouso e extrai um parâmetro de referência dele. Os parâmetros de referência podem ser: Caso {% if landing_site_ref == 'my-tracking-token' %} Minha ação... {% endif %} |
cancelled |
(boolean) Retorna "true" se o pedido foi cancelado. |
cancelled_at |
A hora em que o pedido foi cancelado. |
cancel_reason |
Motivo selecionado para o cancelamento do pedido. Pode ser: estoque , cliente , recusado , fraude ou outro . |
has_high_risks?(deprecated) |
Retorna "true" se o pedido tiver alto risco |
unique_gateways |
Retorna uma lista de provedores de pagamento exclusivos em um pedido. Por exemplo, se alguém pagou com um Visa, um Mastercard e dinheiro, a lista retornada seria |
location (POS only) |
Exibe a localização física do pedido. Existem várias propriedades de localização disponíveis, listadas aqui. Você pode configurar locais na área Locais do admin. |
order_status_url |
Retorna o link para a página de status do pedido em questão. |
fulfilled_line_items(deprecated) |
Lista de itens de linha que foram atendidos. |
unfulfilled_line_items(deprecated) |
Lista de itens de linha que não foram totalmente processados. |
b2b? |
Retorna "true" se o pedido for B2B. Use a propriedade com variáveis B2B para exibir informações relevantes, como nome, local e endereço da empresa nos e-mails. Por exemplo, é possível adicionar um cabeçalho a um modelo com estas informações:
|
company |
A empresa para quem a venda é feita em um pedido B2B. |
company.name |
Nome da empresa em um pedido B2B. |
company.id |
ID da empresa em um pedido B2B. |
company_location |
Local da empresa em um pedido B2B. A empresa que compra de você pode ter mais de um local. |
company_location.name |
Nome do local da empresa em um pedido B2B. |
company_location.id |
Número do ID para o local da empresa em um pedido B2B. |
company_location.shipping_address |
Endereço de entrega para o local da empresa em um pedido B2B. |
company_location.billing_address |
Endereço de faturamento para o local da empresa em um pedido B2B. |
customer_order_url |
A página de informações sobre um novo pedido para o qual o cliente solicitou uma devolução com uma nova conta. |
Propriedades do rascunho de pedido
Propriedade | Descrição |
---|---|
id |
Um ID exclusivo do rascunho de pedido para uso interno. |
invoice_url |
Um link que o cliente pode seguir para pagar a fatura usando o checkout seguro da Shopify. |
reserve_inventory_until |
A data e a hora até as quais os itens de linha no rascunho são reservados, por exemplo, Use o filtro de datas do Liquid para formatar as datas. |
user |
O último membro da equipe que alterou o rascunho de pedido. |
user.name |
O nome do último membro da equipe que alterou o rascunho de pedido. |
user.email |
O e-mail do último membro da equipe que alterou o rascunho de pedido. |
O e-mail associado ao rascunho de pedido. | |
name |
O número (number ) exclusivo do rascunho de pedido, prefixado por um sinal # (que equivale a "nº"). |
number |
O número exclusivo do rascunho de pedido sem o prefixo ou sufixo do pedido. |
created_at |
A data e hora em que o cliente criou o rascunho de pedido, por exemplo, Use o filtro de datas do Liquid para formatar as datas. |
tags |
Retorna uma matriz de todas as tags do pedido em ordem alfabética. Veja mais informações na documentação de referência do Liquid. |
tax_price |
Os tributos combinados de todos os itens no rascunho de pedido. |
tax_lines |
Tributos discriminados por tipo: {% for tax_line in tax_lines %} {{ tax_line.title }} ({{ tax_line.rate_percentage }}%) : {{ tax_line.price | money_with_currency }} {% endfor %} |
tax_line.title |
Nome do tributo. Exemplos: QST ou IVA |
tax_line.price |
O valor do tributo. |
tax_line.rate |
A taxa de tributo na forma decimal. Por exemplo, uma taxa de tributo de 17,5% retornará 0,175 . |
tax_line.rate_percentage |
A taxa de tributo na forma de porcentagem. Por exemplo, uma taxa de 0,175 retornará 17,5 . |
customer |
Objeto de cliente que contém os atributos da saída do cliente. |
billing_address |
O endereço de faturamento do rascunho de pedido. |
billing_address.first_name |
O primeiro nome do cliente. |
billing_address.last_name |
O sobrenome do cliente. |
billing_address.company |
O nome da empresa no endereço de faturamento. |
billing_address.phone |
O número de celular no endereço de faturamento. |
shop.name |
O nome da sua loja. |
shop.phone |
Número de telefone da sua loja. |
subtotal_price |
Soma dos preços de item de linha do pedido após qualquer desconto de item de linha ou desconto de carrinho ter sido deduzido. O subtotal não inclui tributos (a menos que tributos sejam incluídos nos preços) ou custos de frete. |
discounts |
Uma lista de descontos. |
discounts_amount |
Valor total aplicado por todos os descontos. Exemplo: +US$ 5,00 |
discounts_savings |
Valor economizado devido aos descontos. Exemplo: -US$ 5,00 |
total_price |
O preço total da encomenda (subtotal + custo de frete - desconto de frete + tributo). |
requires_shipping |
Retorna true se pelo menos um item no rascunho de pedido exigir frete. Retorna false se nenhum item no rascunho de pedido exigir frete. |
shipping_method.title |
Nome da taxa de frete. Exemplo: padrão |
shipping_method.price |
O preço da forma de frete. Retorna as mesmas informações em shipping_price . |
shipping_price |
O preço de frete. Use os filtros de dinheiro do Liquid para formatar esse valor. |
shipping_address |
Atenção: Ao contrário de pedidos regulares, o endereço de entrega de um rascunho de pedido pode estar incompleto. |
shipping_address.first_name |
O primeiro nome do endereço de entrega. |
shipping_address.company |
O nome da empresa no endereço de entrega. |
shipping_address.phone |
O número de celular no endereço de entrega. |
line_items |
Uma lista de todos os itens de linha no rascunho de pedido. |
item_count |
Uma soma de todas as quantidades do item no rascunho de pedido. |
note |
A observação anexada ao rascunho de pedido. A observação pode ser obtida do cliente e também editada na tela de detalhes do rascunho de pedido no seu admin da Shopify. |
location |
O local físico do pedido. Existem várias propriedades de local disponíveis. Você pode configurar locais na página Locais de seu admin da Shopify. |
b2b? |
Retorna "true" se o pedido for B2B. Use a propriedade com variáveis B2B para exibir informações relevantes, como nome, local e endereço da empresa nos e-mails. Por exemplo, é possível adicionar um cabeçalho a um modelo com estas informações:
|
company |
A empresa para quem a venda é feita em um pedido B2B. |
company.name |
Nome da empresa em um pedido B2B. |
company.id |
ID da empresa em um pedido B2B. |
company_location |
Local da empresa em um pedido B2B. A empresa que compra de você pode ter mais de um local. |
company_location.name |
Nome do local da empresa em um pedido B2B. |
company_location.id |
Número do ID para o local da empresa em um pedido B2B. |
company_location.shipping_address |
Endereço de entrega para o local da empresa em um pedido B2B. |
company_location.billing_address |
Endereço de faturamento para o local da empresa em um pedido B2B. |
Propriedades de cronograma de pagamento
Propriedade | Descrição |
---|---|
payment_schedule.amount_due |
O valor a ser pago em um cronograma de pagamento. Use o filtro de dinheiro do Liquid para formatar os valores do moedas. |
payment_schedule.due_at |
A data de vencimento do cronograma de pagamento. Use o filtro de datas do Liquid para formatar as datas. |
payment_schedule.due_in_days |
O número de dias até a data de vencimento, caso o cronograma de pagamento ainda não esteja vencido (não pago). |
payment_schedule.due_later? |
Retorna "true" se um cronograma de pagamento não tiver sido pago e a data de vencimento estiver no futuro. |
payment_schedule.number_of_days_overdue? |
O número de dias desde a data de vencimento de um cronograma de pagamento já vencido. |
payment_schedule.overdue? |
Retorna "true" se um cronograma de pagamento não tiver sido pago e a data de vencimento estiver no passado. |
Propriedades de status de pagamento
Propriedade | Descrição |
---|---|
has_pending_payment |
(booleano) Retorna "true" se o pedido tiver uma transação com pagamento pendente. Saiba mais sobre pagamentos pendentes. |
buyer_action_required |
(booleano) Retorna "true" se um pedido tiver uma transação com pagamento pendente e for necessária uma ação do comprador para desbloquear o pagamento. Quando o valor retorna "true" e a forma de pagamento aceita instruções de pagamento, Saiba mais sobre o objeto de transação do Liquid. |
Propriedades do item de linha
Cada line
na lista de line_items
ou subtotal_line_items
tem as seguintes propriedades.
Propriedade | Descrição |
---|---|
line.applied_discounts(POS and draft orders only) |
Lista de descontos aplicados a este item (cada desconto tem as propriedades título , código , quantidade , economia e tipo ). |
line.bundle_components(Draft orders only) |
Lista de itens de linha que são componentes do pacote deste item. Só retornará uma lista se esse item de linha for um produto de pacote. |
line.bundle_parent?(Draft orders only) |
(booleano) Retornará "true" se o item de linha for um produto de pacote. |
line.custom(Draft orders only) |
(boolean) Retorna true se o item for um item de linha personalizado para um rascunho de pedido. |
line.delivery_agreement |
O Contrato de entrega associado ao item de linha. |
line.grams |
Peso de um único item. |
line.image |
Retorna o URL da imagem associada ao item de linha. Também é possível usar o filtro img_url para obter tamanhos de imagem específicos, como {{ line.image | img_url: 'small' }}
|
line.line_price |
O preço multiplicado pela quantidade desse item. |
line.original_line_price |
O preço combinado da quantidade de itens incluídos na linha, antes da aplicação de descontos. |
line.final_line_price |
O preço combinado de todos os produtos no item de linha, incluindo todos os valores de desconto. |
line.price |
O preço de um único item. |
line.product.metafields |
Os metacampos no nível do produto. Use a seguinte sintaxe: line.product.metafields.NAMESPACE.KEY |
line.product.title |
O nome atual do produto. |
line.product.vendor |
Fornecedor do item. |
line.properties |
Retorna uma matriz das informações personalizadas de um item. O cliente especifica as propriedades do item de linha na página do produto antes da inclusão no carrinho. |
line.quantity |
Quantidade para esse item. |
line.current_quantity |
A quantidade atual do item após as remoções. |
line.requires_shipping |
(booleano) Retorna "true" se a variante do item tiver a caixa de seleção Este produto é físico marcada na página do produto. |
line.selling_plan_allocation |
Retorna um objeto selling_plan_allocation , que descreve o impacto de um plano de venda, como assinatura, no item de linha. |
line.taxable |
(booleano) Retorna verdadeiro se a variante do item tiver marcado a caixa de seleção "Cobrar tributos sobre este produto" na página do produto. |
line.title |
O nome do produto no momento da venda, seguido por um traço e o nome da variante. O nome da variante não é incluído quando é "Título padrão". Nas notificações para compradores, os nomes do produto e da variante são traduzidos para o idioma usado pelo cliente no checkout se ele for diferente do padrão da loja. |
line.url |
O URL relativo da variante do item de linha. Ela não inclui o URL de raiz da loja (mystore.myshopify.com ). |
line.variant.barcode |
O código de barras associado à variante do produto. |
line.variant.compare_at_price |
A Comparação de preços relacionada à variante do produto. |
line.variant.image |
A imagem da variante do produto. Só retorna uma imagem se houver uma imagem específica atribuída à variante no item de linha. |
line.variant.metafields |
Os metacampos no nível da variante. Use a seguinte sintaxe: line.variant.metafields.NAMESPACE.KEY |
line.variant.sku |
SKU associada à variante de produto. |
line.variant.title |
Os nomes atuais dos valores da opção da variante, unidos por caracteres Exemplo: pequeno/vermelho |
line.refunded.quantity(within refund notifications) |
A quantidade de um item a ser reembolsado. Utilize esta propriedade para adicionar um identificador aos itens reembolsados em um pedido. Por exemplo: |
Propriedades de reembolsos
Propriedade | Descrição |
---|---|
amount |
A quantia de dinheiro reembolsada. |
refund_line_items |
Uma lista de itens de linha de reembolso a serem ressarcidos. |
Propriedades de refund_line_item
Cada refund_line
na lista de refund_line_items
tem as seguintes propriedades:
Propriedade | Descrição |
---|---|
refund_line.line_item |
O line_item que está sendo reembolsado. Tem acesso a todas as propriedades do line_item. |
refund_line.quantity |
A quantidade do item de linha a ser reembolsado. |
Propriedades de processamento de pedidos
Propriedade | Descrição |
---|---|
service_name |
Nome do serviço personalizado definido na página Configurações > Frete. (Apenas solicitações de processamento de pedidos) |
fulfillment.estimated_delivery_at |
Uma data prevista de entrega com base no número de rastreamento (se disponível) fornecido por uma das seguintes transportadoras: USPS, FedEx, UPS, Canada Post (somente Canadá). Esta propriedade só está disponível quando as taxas calculadas pela transportadora estão em uso. |
fulfillment.fulfillment_line_items |
Uma lista de itens de linha de processamento de pedidos a serem executados. |
fulfillment.item_count |
Uma soma de todas as quantidades dos itens. O número total de itens sendo atendidos. |
fulfillment.requires_shipping |
(boolean) Retorna true se essa solicitação de preenchimento exigir frete. |
fulfillment.tracking_company |
A empresa que faz o rastreamento. |
fulfillment.tracking_numbers |
Uma lista de números de rastreamento. |
fulfillment.tracking_urls |
Uma lista de URLs de rastreamento. |
items_to_fulfill(deprecated) |
Lista de itens de linha que precisam passar pelo serviço de processamento de pedidos personalizado específico. (Apenas solicitações de processamento de pedidos) |
items_to_fulfill_count(deprecated) |
O número total de itens a serem atendidos por essa solicitação. (Apenas solicitações de processamento) |
Propriedades de fulfillment_line_item
Cada fulfillment_line
na lista de fulfillment_line_items
tem as seguintes propriedades.
Propriedade | Descrição |
---|---|
fulfillment_line.line_item |
O line_item sendo processado. Tem acesso a todas as propriedades do line_item. |
fulfillment_line.quantity |
A quantidade do item de linha que está sendo processada. |
Propriedades dos pacotes preparados
Um pacote preparado inclui os itens marcados como prontos para retirada.
Propriedade | Descrição |
---|---|
item_count |
Uma soma de todas as quantidades do item no pacote preparado. |
prepared_package_line_items |
Uma lista de itens de linha do pacote preparado. |
Propriedades de Prepared_package_line_item
Cada prepared_package_line_item
na lista de prepared_package_line_items
tem as seguintes propriedades.
Propriedade | Descrição |
---|---|
line_item |
O line_item associado. Tem acesso a todas as propriedades do line_item. |
quantity |
A quantidade do item de linha marcada como pronta para retirada. |
Propriedades de entrega
Propriedade | Descrição |
---|---|
delivery_agreements |
Lista de todos os Contratos de entrega do pedido. |
delivery_instructions |
Informações de entrega local a serem compartilhadas com o cliente. Os dados são controlados pelo campo Informações de entrega nas configurações de entrega local. |
consolidated_estimated_delivery_time |
Informações sobre datas de entrega de pedidos para compartilhar com o cliente. Essas informações são controladas pela configuração de Tempo de processamento definida na página de Frete e entrega. Vale lembrar que, quando o pedido tem várias formas de entrega, uma lista de formas e datas é exibida. |
has_multiple_delivery_methods |
(booleano) Retorna "true" se o pedido tem várias formas de entrega. |
Propriedades do Contrato de entrega
Propriedade | Descrição |
---|---|
delivery_agreement.delivery_method_type |
O tipo da forma de entrega. |
delivery_agreement.delivery_method_name |
O tipo de forma de entrega traduzido para o idioma em que o comprador fez o checkout, quando o idioma for diferente do idioma-padrão da loja. |
delivery_agreement.line_items |
Lista de todos os Itens de linha associados ao contrato de entrega. |
Propriedades de desconto
Existem dois tipos de propriedades de desconto.
discount_applications
descreve por que e como um item foi descontado.
discount_allocations
descreve o impacto de um desconto específico em um item de linha e a redução no preço. Use essa propriedade no item de linha.
É possível combinar as propriedades para exibir informações de desconto em um item de linha ou no pedido.
Exemplo
Verifica se um desconto foi aplicado ao item de linha. Caso não tenha sido utilizado no nível do pedido (all
), o nome e o valor dele serão exibidos.
O resultado pode ser assim:
Propriedades de discount_allocation
Cada discount_allocation
na lista de discount_allocations
tem as seguintes propriedades.
Propriedade | Descrição |
---|---|
discount_allocation.amount |
O valor economizado pelo cliente em um item de linha. É necessário que seja inserido em uma repetição caso queira permitir vários códigos de desconto. |
discount_allocation.discount_application |
A aplicação de desconto que aloca o valor no item de linha. |
Propriedades de discount_application
Cada discount_application
na lista de discount_applications
tem as seguintes propriedades.
Propriedade | Descrição |
---|---|
discount_application.target_selection |
Descreve como os itens de linha são selecionados no carrinho para a aplicação de desconto. Pode ser:
|
discount_application.target_type |
Tipo de item ao qual um desconto é aplicado (line_item ou shipping_line ). |
discount_application.title |
Nome do desconto exibido ao cliente. Exemplos: Boas-vindas10 ou CBBWQQAKYBYY |
discount_application.total_allocated_amount |
Valor total do desconto aplicado ao preço do pedido. |
discount_application.type |
Tipo de desconto. Pode ser: automático , discount_code , manual ou script . |
discount_application.value |
Valor do desconto. |
discount_application.value_type |
Tipo de valor do desconto. Pode ser: fixed_amount ou percentual . |
Propriedades da assinatura
Informações sobre um contrato de assinatura, o ciclo de faturamento atual e seus itens de linha, forma de entrega e forma de pagamento estão disponíveis para todos os modelos de e-mail para assinatura.
Se quiser editar os modelos para notificação de assinatura, instale o app Shopify Subscriptions. Em seguida, localize o modelo em Configurações > Notificações na seção Assinaturas.
Propriedades do ciclo de faturamento do contrato de assinatura
Para acessar as propriedades do contrato de assinatura e seu ciclo de faturamento, use o objeto subscription_contract_billing_cycle
.
Exemplo
Resultado:
Propriedade
Propriedade | Descrição |
---|---|
status |
O status do contrato.active , paused , cancelled , failed , expired ou stale .
|
delivery_method |
A forma de entrega da assinatura. Se for de um serviço ou produto digital, nilserá retornado. |
billing_frequency |
Frequência de faturamento da assinatura. |
delivery_frequency |
Frequência de entrega da assinatura. |
origin_order |
O pedido original que criou a assinatura originalmente. Caso esse processo não tenha sido feito na Shopify, nil será retornado.
|
customer |
O cliente da assinatura. |
line_items |
Os itens de linha no ciclo de faturamento da assinatura. |
product_names |
Uma lista com os nomes dos produtos incluídos no ciclo de faturamento da assinatura. |
update_payment_method_url |
O URL que o cliente usa para atualizar a forma de pagamento do contrato. |
shipping_address |
O endereço de entrega da assinatura. Se for de um serviço ou produto digital, nil será retornado.
|
billing_address |
O endereço de faturamento da assinatura. |
subtotal_price |
O preço subtotal dos itens de linha da assinatura. |
shipping_price |
O preço de frete da assinatura. |
total_tax |
O tributo total da assinatura. |
total_price |
O preço total da assinatura. |
total_discounts |
O total de descontos da assinatura. |
customer_self_serve_url |
O URL de autoatendimento que o cliente usa para gerenciar assinaturas. |
billing_attempt_expected_date |
A data de faturamento do ciclo de faturamento. |
next_billing_date |
A próxima data de faturamento não ignorada após o ciclo de faturamento. |
last_attempted_billing_date |
A última data de faturamento tentada no ciclo de faturamento. |
days_overdue |
O número de dias que o faturamento está vencido no ciclo de faturamento. |
payment_instrument |
O instrumento de pagamento associado ao contrato de assinatura, usado para cobrar o cliente. |
Propriedades do item de linha do contrato de assinatura
As propriedades de cada item de linha incluídas no ciclo de faturamento. Acesse as propriedades do item de linha do contrato pela propriedade principal subscription_contract_billing_cycle.line_items
.
Exemplo
Propriedade | Descrição |
---|---|
url |
O URL para a página de informações do produto da variante do item de linha. |
requires_shipping |
Se o item de linha requer frete físico. |
unit_price_measurement |
A medida de preço unitário do item de linha. |
selling_plan_allocation |
A alocação do plano de venda para o item de linha. |
Propriedades da forma de entrega do contrato de assinatura
As propriedades da forma de entrega usada no ciclo de faturamento. Acesse-as pela propriedade principal subscription_contract_billing_cycle.delivery_method
.
Exemplo
Propriedade | Descrição |
---|---|
title |
O título da opção de frete associada com a forma de entrega. |
type |
O tipo da forma de entrega.shipping , local ou pick-up .
|
Propriedades do instrumento de pagamento do contrato de assinatura
Informações sobre o instrumento de pagamento do contrato de assinatura, usado para cobrar o cliente. Acesse as propriedades do instrumento de pagamento por meio da propriedade principal subscription_contract_billing_cycle.payment_instrument
.
Exemplo
Propriedade | Descrição |
---|---|
payment_type |
O tipo de forma de pagamento representado pelo instrumento. Use filtros de pagamento para gerar um URL ou SVG da imagem. |
credit_card_brand |
A marca do cartão de crédito. |
credit_card_company |
O nome da empresa de cartão de crédito. |
credit_card_last_four_digits |
Os últimos quatro dígitos do cartão de crédito. |
Propriedades de notificação por e-mail
Propriedade | Descrição |
---|---|
shop.email_logo_url |
A URL do logo especificado na seção Personalizar modelos de e-mail do admin. |
shop.email_logo_width |
A largura do logo (pixels) especificada na seção Personalizar modelos de e-mail do admin. |
shop.email_accent_color |
O código hexadecimal para a cor de destaque especificada na seção Personalizar modelos de e-mail do admin. |