Order Custom Code
refersonprado/order-custom-code
Automatically generates a custom identifier code for each order during checkout, displayed on the success page, admin order grid, and order detail. Includes a CLI command to backfill existing orders.
Build Tests
Code Quality
Tested on Magento 2.4.8-p4
Recent Test History
Each release is tested against the latest Magento version at that time.
Top Contributors
View LeaderboardShare This Module's Status
README
Loaded from GitHubCertisign Order Custom Code
Este módulo para Magento 2 gera automaticamente um código identificador personalizado (custom_code) para cada pedido realizado na loja. O código é persistido na base de dados e disponibilizado para visualização no frontend, painel administrativo e via API.
Funcionalidades
- Geração Automática: O código é gerado durante o checkout através do evento
sales_order_place_before. - Lógica de Composição: O identificador segue o padrão
{Prefixo}-{AnoMês}-{IncrementId}-{QuantidadeTotal}. - Configuração Flexível: Ativação e definição de prefixo via Admin.
- Visibilidade:
- Exibição na página de sucesso do checkout.
- Coluna dedicada na grid de pedidos (Sales Grid).
- Bloco informativo no detalhe do pedido no Admin.
- Retroatividade: Comando de console para popular pedidos antigos.
Instalação
Via Composer (Recomendado)
- No terminal, execute:
(Nota: Requer que o repositório esteja configurado no teu composer.json).composer require refersonprado/order-custom-code - Atualize os módulos:
bin/magento setup:upgrade
Via app/code (Manual)
- Cria a estrutura de pastas:
app/code/Certisign/OrderCustomCode. - Copie todos os arquivos do módulo para este diretório.
- Execute os seguintes comandos do Magento:
bin/magento module:enable Certisign_OrderCustomCode bin/magento setup:upgrade bin/magento setup:di:compile bin/magento setup:static-content:deploy
Configuração
- Navegue até Lojas > Configuração > Certisign > Order Custom Code.
- Enable: Ativa a funcionalidade.
- Prefix: Define o prefixo desejado (ex: VAL).
Comandos CLI
Para gerar códigos para pedidos que foram criados antes da instalação do módulo, utilize o comando:
bin/magento certisign:order:populate-custom-code
Informações Adicionais
Caso deseje fazer consultar SQL irei deixar algumas para facilitar o processo, como consulta por custom_code, update em massa para resetar o campo e update em massa para popular campos de pedidos que já foram feitos antes da implementação.
- SELECT para consulta por custom code
SELECT * FROM sales_order WHERE custom_code = 'VALOR-DO-CUSTOM-CODE';
- UPDATE para limpar todos os custom_code
UPDATE sales_order SET custom_code = '' WHERE custom_code IS NOT NULL;
- UPDATE para pedidos que já foram feitos
UPDATE sales_order
SET
custom_code = CONCAT(
'VAL', '-',
DATE_FORMAT(created_at, '%Y%m'), '-',
increment_id, '-',
CAST(total_qty_ordered AS UNSIGNED)
),
updated_at = NOW()
WHERE
custom_code
This content is fetched directly from the module's GitHub repository. We are not the authors of this content and take no responsibility for its accuracy, completeness, or any consequences arising from its use.