Instalação, configuração e atributos do produto

Âmbito do documento

Este documento descreve a instalação do módulo Estimated Delivery Date, a configuração no painel de administração do Magento 2 e a gestão dos atributos adicionados ao produto. A descrição dos campos baseia-se na implementação atual do módulo.

Instalação

O pacote destina-se a instalação através do Composer.

Exemplo de instalação a partir de um repositório VCS:

composer config repositories.kowal.estimated.delivery.date vcs https://github.com/kowalco/estimated-delivery-datecomposer require kowal/module-estimated-delivery-datebin/magento module:enable Kowal_EstimatedDeliveryDatebin/magento setup:upgradebin/magento cache:flush

Após o deployment em produção, deve ser executado o processo standard de compilação e deployment de recursos estáticos, de acordo com o projeto Magento:

bin/magento setup:di:compilebin/magento setup:static-content:deploybin/magento cache:flush

Localização da configuração

A configuração do módulo está disponível no painel de administração:

Stores > Configuration > Sales > Estimated Delivery Date

As definições estão disponíveis ao nível default, website e store view, de acordo com o mecanismo de configuração do Magento.

General

Enabled

Ativa ou desativa o módulo para o âmbito de configuração em questão. Quando o campo está desativado, as mensagens no frontend não devem ser apresentadas.

Valor predefinido: Yes.

Calculation Timezone

Fuso horário utilizado para o cálculo das datas e da hora de cut-off. Se o campo ficar vazio, o módulo utiliza o fuso horário da loja configurado no Magento.

Exemplo de valor:

Europe/Warsaw

Utilização: útil quando a loja opera em várias store views ou quando o armazém que trata das expedições trabalha num fuso horário diferente da configuração predefinida da loja.

Fallback Message

Mensagem de fallback utilizada como texto de contingência quando a loja pretende mostrar uma informação geral em vez de uma data concreta.

Valor predefinido:

Confirmaremos o prazo de entrega após a realização da encomenda.

Date Format

Formato de data utilizado na apresentação das mensagens para o cliente. O campo usa o padrão ICU suportado pela formatação de datas do Magento.

Valor predefinido:

EEEE, d MMMM

Exemplo de resultado:

segunda-feira, 18 maio

Date Calculation

Processing Days Min

Número mínimo de dias úteis necessários para preparar a encomenda antes da expedição.

Valor predefinido: 1.

Utilização: determina a data de expedição mais cedo possível.

Processing Days Max

Número máximo de dias úteis necessários para preparar a encomenda.

Valor predefinido: 1.

Utilização: permite criar um intervalo de datas de expedição quando a preparação pode demorar mais do que o tempo mínimo.

Transport Days Min

Número mínimo de dias úteis de transporte desde a expedição até à entrega.

Valor predefinido: 1.

Utilização: determina a data de entrega mais cedo possível após a expedição.

Transport Days Max

Número máximo de dias úteis de transporte.

Valor predefinido: 2.

Utilização: permite mostrar um intervalo de entrega, por exemplo quando a transportadora normalmente entrega em 1-2 dias úteis.

Same-day Shipping Cut-off Time

Hora limite para expedição no próprio dia. O valor deve ser introduzido no formato HH:MM.

Valor predefinido:

14:00

Se a hora atual for posterior ao cut-off, o módulo desloca o início do cálculo para o dia útil seguinte.

Non-working Weekdays

Lista dos dias da semana considerados não úteis. Os valores devem ser introduzidos como números ISO separados por vírgulas:

• 1 - segunda-feira,
• 2 - terça-feira,
• 3 - quarta-feira,
• 4 - quinta-feira,
• 5 - sexta-feira,
• 6 - sábado,
• 7 - domingo.

Valor predefinido:

6,7

Utilização: por defeito, ignora sábados e domingos no cálculo dos dias úteis.

Safety Buffer Days

Buffer adicional de segurança acrescentado ao tempo de transporte.

Valor predefinido: 0.

Utilização: útil em períodos de aumento do número de encomendas, em funcionamento instável das transportadoras ou em produtos que exigem uma promessa de entrega mais prudente.

Display Settings

Show on Product Page

Ativa a apresentação da data prevista na página do produto.

Valor predefinido: Yes.

Show in Cart

Ativa a apresentação da data prevista no carrinho.

Valor predefinido: Yes.

Show in Admin Order

Ativa a secção Estimated Delivery Date na vista da encomenda no painel de administração.

Valor predefinido: Yes.

Show Cut-off Widget on Product Page

Ativa o widget de contagem decrescente até à hora de cut-off na página do produto.

Valor predefinido: Yes.

Show Cut-off Widget in Cart

Ativa o widget cut-off no carrinho.

Valor predefinido: No.

Cut-off Widget Mode

Define a forma de apresentação do widget cut-off.

Valores disponíveis:

• Inline - o widget é apresentado no local onde o bloco está inserido,
• Fixed - o widget fica afixado ao canto selecionado do ecrã,
• Inline + Fixed - o widget funciona simultaneamente como elemento inline e fixed.

Valor predefinido: Inline.

Fixed Widget Position

Define a posição do widget fixed.

Valores disponíveis:

• Bottom Right - canto inferior direito,
• Bottom Left - canto inferior esquerdo,
• Top Right - canto superior direito,
• Top Left - canto superior esquerdo.

Valor predefinido: Bottom Right.

Fixed Widget Devices

Define o tipo de dispositivos em que o widget fixed deve ser visível.

Valores disponíveis:

• Desktop,
• Mobile,
• Desktop + Mobile.

Valor predefinido: Desktop + Mobile.

After Cut-off Behavior

Define o comportamento do widget após a ultrapassagem da hora de cut-off.

Valores disponíveis:

• Hide Widget - o widget será ocultado,
• Show After Cut-off Message - o widget mostrará uma mensagem após o cut-off.

Valor predefinido: Show After Cut-off Message.

Customer Messages

As mensagens suportam variáveis simples no formato {{nazwa_zmiennej}}.

Variáveis disponíveis para mensagens de entrega:

• {{ship_date}},
• {{ship_date_from}},
• {{ship_date_to}},
• {{delivery_date}},
• {{delivery_date_from}},
• {{delivery_date_to}}.

Variáveis disponíveis para mensagens de cut-off:

• {{cutoff_time}},
• {{cutoff_countdown}}.

Delivery Range Message

Modelo de mensagem utilizado quando o cálculo devolve um intervalo de datas de entrega.

Valor predefinido:

Entrega prevista: {{delivery_date_from}} - {{delivery_date_to}}

Single Delivery Date Message

Modelo de mensagem utilizado quando a data de entrega mais cedo e a mais tardia são iguais.

Valor predefinido:

Entrega prevista: {{delivery_date}}

Cut-off Countdown Message

Mensagem apresentada antes de ser ultrapassada a hora de cut-off.

Valor predefinido:

Encomende no prazo de {{cutoff_countdown}} e enviaremos ainda hoje.

After Cut-off Message

Mensagem apresentada após a ultrapassagem da hora de cut-off, se o campo After Cut-off Behavior estiver definido para mostrar a mensagem.

Valor predefinido:

A expedição de hoje já encerrou. Enviaremos no próximo dia útil.

Emails

Send Separate Email After Payment

Ativa um e-mail separado enviado após o pagamento da encomenda.

Valor predefinido: No.

Utilização: permite confirmar ao cliente que o pagamento foi recebido e que a encomenda entrou em processamento.

Payment Confirmation Template

Modelo do e-mail enviado após o pagamento.

Valor predefinido:

estimated_delivery_date_emails_payment_template

Payment Confirmation Sender

Remetente da mensagem após o pagamento. O campo utiliza as identidades de e-mail configuradas no Magento.

Valor predefinido:

sales

Allow Email After Delivery Date Change

Permite enviar ao cliente uma mensagem após a alteração manual do prazo de entrega no painel de administração.

Valor predefinido: Yes.

Delivery Date Change Template

Modelo do e-mail enviado após a alteração do prazo de entrega.

Valor predefinido:

estimated_delivery_date_emails_date_change_template

Delivery Date Change Sender

Remetente da mensagem sobre a alteração do prazo de entrega.

Valor predefinido:

sales

Default Apology Message

Texto de desculpa predefinido utilizado na mensagem sobre a alteração do prazo de entrega.

Valor predefinido:

Pedimos desculpa, o prazo de execução da sua encomenda foi alterado.

Require Delay Reason

Exige a indicação do motivo do atraso na alteração manual do prazo na vista da encomenda.

Valor predefinido: No.

Utilização: impõe uma melhor disciplina operacional e facilita esclarecimentos posteriores sobre alterações de prazo.

Send Automatically After Manual Date Change

Envia automaticamente uma mensagem ao cliente após a alteração manual do prazo de entrega.

Valor predefinido: No.

Se o campo estiver desativado, o administrador pode decidir o envio assinalando a checkbox na vista da encomenda.

Gestão dos atributos do produto

O módulo adiciona ao produto um grupo de atributos Estimated Delivery Date. Os atributos são opcionais e têm âmbito store view. Se não forem preenchidos, o módulo utiliza as regras ou a configuração global.

Os atributos do produto têm prioridade sobre as regras calculadas para o produto. Isto permite substituir rapidamente o prazo para um SKU específico sem alterar as definições globais.

Onde editar os atributos

Os atributos estão disponíveis no painel de administração do Magento:

Catalog > Products > Edit Product > Estimated Delivery Date

Se o grupo não estiver visível num determinado attribute set, deve ser verificada a configuração do conjunto de atributos do produto no Magento.

EDD Processing Days Min

Código do atributo:

edd_processing_days_min

Número mínimo de dias úteis necessários para preparar um produto específico.

Utilização: um produto disponível para entrega imediata pode ter o valor 0, e um produto fornecido pelo fornecedor, por exemplo, 3.

EDD Processing Days Max

Código do atributo:

edd_processing_days_max

Número máximo de dias úteis de preparação de um produto específico.

Utilização: se a preparação for variável, pode definir, por exemplo, mínimo 2 e máximo 5, para que a mensagem mostre um intervalo mais seguro.

EDD Transport Days Min

Código do atributo:

edd_transport_days_min

Número mínimo de dias úteis de transporte para um produto específico.

Utilização: para produtos enviados por outra transportadora ou a partir de outro armazém.

EDD Transport Days Max

Código do atributo:

edd_transport_days_max

Número máximo de dias úteis de transporte para um produto específico.

Utilização: para produtos volumosos, paletizados ou que exigem logística especial.

EDD Static Customer Message

Código do atributo:

edd_static_text

Mensagem personalizada para o cliente apresentada em vez da mensagem da configuração global.

Exemplos:

Produto fabricado por encomenda. Confirmaremos o prazo de entrega após a compra.

Entrega prevista: {{delivery_date_from}} - {{delivery_date_to}}

O atributo pode utilizar as mesmas variáveis de data que estão disponíveis nas mensagens globais de entrega.

EDD Confidence

Código do atributo:

edd_confidence

Nível de confiança do prazo guardado com a promessa de entrega.

Valores recomendados:

• guaranteed - prazo garantido,
• likely - prazo provável,
• estimated - prazo aproximado,
• unknown - sem estimativa fiável.

A implementação atual guarda este valor no resultado do cálculo e nos snapshots. Pode ser utilizado por templates, integrações ou personalização adicional das mensagens.

Disable Estimated Delivery Date

Código do atributo:

edd_disable

Desativa a apresentação da entrega prevista para um produto específico na página do produto e também desativa para ele o widget cut-off.

Utilização: produtos indisponíveis, produtos que exigem orçamento individual de entrega, serviços, produtos em pré-venda ou mercadorias para as quais a loja não quer fazer uma promessa de prazo.

Boas práticas de preenchimento dos atributos

Para a maioria dos produtos, os atributos podem ser deixados em branco e utilizar a configuração global. Vale a pena preenchê-los apenas quando um produto específico difere realmente do processo logístico standard.

Exemplo de abordagem:

• produtos disponíveis para entrega imediata: deixar em branco ou definir um tempo de preparação mais curto,
• produtos fornecidos pelo fornecedor: definir um intervalo de preparação mais longo,
• produtos volumosos: definir transporte mais longo,
• produtos personalizados: usar uma mensagem estática personalizada,
• produtos sem prazo fiável: ativar Disable Estimated Delivery Date ou definir uma mensagem explicativa.

Após alterar os atributos do produto, deve refrescar a cache do Magento, caso a loja utilize full page cache ou mecanismos adicionais de cache no tema.

Importação de feriados e dias não úteis

A importação está disponível no painel de administração:

Sales > Estimated Delivery Date > Import Holidays

O ficheiro CSV deve conter as colunas:

code,name,type

Colunas opcionais:

date_from,date_to,month,day,country,region,postcode_pattern,shipping_method,source_code,store_id,scope,is_active

Tipos suportados na coluna type:

• single - data única, requer date_from,
• range - intervalo de datas, requer date_from e date_to,
• recurring - data recorrente, requer month e day.

Descrição de campos de importação selecionados:

• code - código único do feriado ou dia não útil,
• name - nome visível administrativamente,
• type - tipo de registo: dia único, intervalo ou data recorrente,
• date_from - data de início no formato YYYY-MM-DD,
• date_to - data de fim no formato YYYY-MM-DD,
• month - mês para registo recorrente,
• day - dia do mês para registo recorrente,
• country - código do país,
• region - região,
• postcode_pattern - padrão de código postal,
• shipping_method - método de entrega,
• source_code - código da fonte MSI,
• store_id - identificador da store view,
• scope - âmbito de aplicação, por defeito shipping_delivery,
• is_active - estado de atividade do registo.

Exemplo:

code,name,type,date_from,date_to,month,day,country,store_id,is_activechristmas_2026,Christmas Break,range,2026-12-24,2026-12-26,,,,,1new_year,New Year,recurring,,,1,1,,,1

Gestão do prazo na encomenda

A secção Estimated Delivery Date está disponível na vista da encomenda, se o campo Show in Admin Order estiver ativado.

O administrador pode editar:

• data de expedição desde,
• data de expedição até,
• data de entrega desde,
• data de entrega até,
• mensagem para o cliente,
• motivo do atraso.

Se o e-mail após alteração do prazo estiver ativado, o administrador pode assinalar o envio da mensagem com pedido de desculpa e novo prazo. O módulo guarda o histórico de alterações com o prazo anterior e o novo, o motivo e a informação sobre o envio do e-mail.

REST API

O módulo disponibiliza os endpoints:

GET /rest/V1/estimated-delivery/product/:skuGET /rest/V1/estimated-delivery/cart/:cartIdGET /rest/V1/estimated-delivery/guest-cart/:cartIdGET /rest/V1/estimated-delivery/order/:orderId

A API devolve, entre outros, a data de expedição, a data de entrega, a mensagem, o nível de confiança, o código da regra, a data de cálculo e a origem dos dados. Para a encomenda, o módulo devolve o snapshot guardado, se existir.