/shopify-tools-cli

CLI to bulk edit Shopify Products / Variants, and Customers. Uses CSV to import and iterate over data.

Primary LanguageTypeScript

SHOPIFY TOOLS

CLI to bulk edit Shopify Products / Variants, and Customers. Uses CSV to import and iterate over data.

index.js <command> <option> <option-value>

Commands:
  index.js updatePrices           Updates product variants price & compare at
                                  price.
  index.js addProductTags         Adds tags to products.
  index.js removeProductTags      Removes tags from products.
  index.js getProductsByTemplate  Gets products by template.
  index.js tagCustomers           Adds tags to customer, if customer does not
                                  exists it will create them.
  index.js updateMetafields       Updates metafields

Options:
      --version   Show version number                                  [boolean]
  -i, --import    The name of the csv to import ex: shopify-import      [string]
  -e, --export    What to name the errors export ex: shopify-errors     [string]
  -t, --tags      The tags to add to the product ex `tag1, tag2, tag3`  [string]
  -p, --template  The product template to search for `template-suffix`  [string]
  -h, --help      Show help                                            [boolean]

Setup

CSV Imports

CSV imports are expected to be in /csv directory

Config

Requires .env (config/shopify) file with the following:

SHOPIFY_API_VERSION="2023-01"
# PRODUCTION
# Retail
RETAIL_API_KEY="store api key"
RETAIL_API_PASSWORD="store api password"
RETAIL_STORE_NAME="store name"
# Wholesale
WHOLESALE_API_KEY="store api key"
WHOLESALE_API_PASSWORD="store api password"
WHOLESALE_STORE_NAME="store name"
# Warehouse
WAREHOUSE_API_KEY="store api key"
WAREHOUSE_API_PASSWORD="store api password"
WAREHOUSE_STORE_NAME="store name"
# Professional
PROFESSIONAL_API_KEY="store api key"
PROFESSIONAL_API_PASSWORD="store api password"
PROFESSIONAL_STORE_NAME="store name"
# STAGING
# Retail
STAGING_RETAIL_API_KEY="store api key"
STAGING_RETAIL_API_PASSWORD="store api password"
STAGING_RETAIL_STORE_NAME="store name"
# Wholesale
STAGING_WHOLESALE_API_KEY="store api key"
STAGING_WHOLESALE_API_PASSWORD="store api password"
STAGING_WHOLESALE_STORE_NAME="store name"

If more stores get added .env file should be updated, as well as the config object.

Build

npm run build

Run

Commands

Update Prices

Updates product variants price & compare at price.

CSV header

SKU NewPrice NewCompareAtPrice 
node lib/index.js updatePrices --store 'STORE_NAME' --import 'CSV_FILE_TO_IMPORT' --export 'CSV_FILE_TO_EXPORT_ERRORS'

ex: node lib/index.js updatePrices --store 'retail' --import 'shopify-import-test' --export 'shopify-errors'

Add Tags

Adds tags to products. Tags can either be passed via an argument or via the csv. Will default to csv then argument.

CSV header: tags are optional, if passed as argument

SKU Tags 
node lib/index.js addProductTags --store 'STORE_NAME' --import 'CSV_FILE_TO_IMPORT' --export 'CSV_FILE_TO_EXPORT_ERRORS' --tags 'tag1, tag2, tag3'

ex: node lib/index.js addProductTags --store 'retail' --import 'shopify-import-test' --export 'shopify-errors' --tags 'tag1, tag2, tag3'

Remove Tags

Remove tags from products. Tags can either be passed via an argument or via the csv. Will default to csv then argument.

CSV header: tags are optional, if passed as argument

SKU Tags
``` node lib/index.js removeProductTags --store 'STORE_NAME' --import 'CSV_FILE_TO_IMPORT' --export 'CSV_FILE_TO_EXPORT_ERRORS' --tags 'tag1, tag2, tag3' ```

ex: node lib/index.js removeProductTags --store 'retail' --import 'shopify-import-test' --export 'shopify-errors' --tags 'tag1, tag2, tag3'

Customer Add Tags

CSV header: tags are optional, if passed as argument

Email FirstName LastName Tags

Add tags to customer, if customer not found it creates the customer and adds the tags. Tags can either be passed via an argument or via the csv. Will default to csv then argument.

node lib/index.js tagCustomers --store 'STORE_NAME' --import 'CSV_FILE_TO_IMPORT' --export 'CSV_FILE_TO_EXPORT_ERRORS' --tags 'tag1, tag2, tag3'

ex: node lib/index.js tagCustomers --store 'retail' --import 'shopify-import-test' --export 'shopify-errors' --tags 'tag1, tag2, tag3'

Get Products By Template

Gets all products by product template.

node lib/index.js getProductsByTemplate --store 'STORE_NAME' --template 'TEMPLATE_SUFFIX'

ex: node lib/index.js getProductsByTemplate --store 'retail' --template 'template-suffix'

Update Metafields

Updates metafields

CSV header

SKU MetafieldNamespace MetafieldKey MetafieldType MetafieldValue

Metafield Types can be found here.

node lib/index.js updateMetafields --store 'STORE_NAME' --import 'CSV_FILE_TO_IMPORT' --export 'CSV_FILE_TO_EXPORT_ERRORS'

ex: node lib/index.js updateMetafields --store 'retail' --import 'shopify-import-test' --export 'shopify-errors'