2021.11.12時点の情報です。

お世話になります。
Shopify専門エンジニアのRyotaです。

Shopify CLIでテーマ開発する際に、カスタマイズ画面から変更した内容が消えてしてしまうという内容のご質問をいただいたので、解決方法を記載します。

さっそく結論

結論として、テーマのカスタマイズ画面を直接変更しているのが問題です。

$ shopify theme serve

カスタマイズを行う際は、上記コマンドで生成されるカスタマイズ画面のリンクからカスタマイズを行ってください。

$ shopify theme pull -n

ローカル環境で変更した内容をpushする前に、先ほどのカスタマイズ画面の設定内容をpullします。

上記コマンドで、pullするテーマの選択肢が出てきますので、Development(先ほど生成されたカスタマイズ画面)を選択してください。
この時に、実際のテーマを選択すると、内容が上書きされてしまいますので、注意してください。

最後に

$ shopify theme push -n

これで、コードの修正と、カスタマイズ画面の変更内容が両方反映されます。

以上です。
Shopify CLIについては、私もまだ慣れていないので、間違いやご不明な点などございましたら、気軽にご連絡ください。