Skip to content

ScreenStaring/shopify_id_export

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

Shopify ID Export

Dump Shopify product and variant IDs —along with other identifiers— to a CSV or JSON file.

When data munging in Shopify you'll often need to (cross-)reference product IDs, variant IDs, SKUs, barcodes, etc... Shopify does not make product nor variant ID available via their product export.

Other times one is provided a product spreadsheet with SKUs but the target system relies on product/variant IDs.

This program can help.

Installation

Download the version for your platform on the releases page. Windows, macOS/OS X, and GNU/Linux are supported.

Usage

Credentials

To use the command you'll need access to the Shopify store you want to export from.

If you have access to the store via Shopify Admin, this can be done by generating private app API credentials. Once obtained they can be specified to the shopify_id_export command:

shopify_id_export -k my-app-key -p my-app-password shop

If the store has your app installed, you can use the credentials generated when the shop installed your app:

shopify_id_export -t shop-token shop

In both cases credentials can be set via environment variables. See Options.

Options

shopify_id_export [hjv] [-k key] [-p password] [-r root-property] [-t token] shop

Options
-h --help                display this help message
-j --json                output dump as JSON
-k --key       key       Shopify API key; defaults to the SHOPIFY_API_KEY environment variable
-p --password  password  Shopify API password; defaults to the SHOPIFY_API_PASSWORD environment variable
-r --json-root property  use property as the top-level property for each JSON object
-t --token     token     Shopify API token; defaults to the SHOPIFY_API_TOKEN environment variable
-v --version             display version information

By default data is output to a CSV file.

Valid properties for the --json-root option are: barcode, product_id, product_title, handle, variant_id, sku

Output to CSV

This is the default output format. A file named shop.csv will be created in the current directory. shop will replaced by the shop's name.

Combining CSVs

Once you have a CSV with the missing product info you can combine it with original CSV via the xsv program. (csvkit's csvjoin will work as well).

For example, if the original spreadsheet contains a column called Product SKU it can be combined with Shopify ID Export's spreadsheet via:

xsv join 'Product SKU' original-data.csv SKU shop.csv | xsv select '!SKU' > combined-data.csv

The 2nd command xsv select '!SKU' removes the SKU column as it's now redundant.

For more info and options see xsv join --help.

Output to JSON

To output a JSON file use the -j option:

shopify_id_export -j -t shop-token shop

This will create a file named shop.json in the current directory. shop will be replaced by the shop's name.

If you're cross-referencing IDs it may be useful to set the root property for the JSON object output for each product/variant.

This will output each object with the variant's SKU as the root:

shopify_id_export -j -r sku -t shop-token shop

Valid properties for the -r/--json-root option are: product_id, product_title, barcode, handle, variant_id, sku.

See Also

License

Released under the MIT License: http://www.opensource.org/licenses/MIT


Made by ScreenStaring

About

Export Shopify product and variant IDs —along with other identifiers— to a CSV or JSON file

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages