{"id":21951322,"url":"https://github.com/hiswe/gulp-dump-shopify","last_synced_at":"2025-10-16T02:19:27.806Z","repository":{"id":57257413,"uuid":"42770611","full_name":"Hiswe/gulp-dump-shopify","owner":"Hiswe","description":"Dump some datas from a Shopify shop","archived":false,"fork":false,"pushed_at":"2019-02-06T16:12:11.000Z","size":90,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-30T00:42:34.193Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/gulp-dump-shopify","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"wtfpl","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Hiswe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-19T11:38:47.000Z","updated_at":"2019-02-06T16:12:12.000Z","dependencies_parsed_at":"2022-09-13T03:31:59.464Z","dependency_job_id":null,"html_url":"https://github.com/Hiswe/gulp-dump-shopify","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/Hiswe/gulp-dump-shopify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hiswe%2Fgulp-dump-shopify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hiswe%2Fgulp-dump-shopify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hiswe%2Fgulp-dump-shopify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hiswe%2Fgulp-dump-shopify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Hiswe","download_url":"https://codeload.github.com/Hiswe/gulp-dump-shopify/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hiswe%2Fgulp-dump-shopify/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263699782,"owners_count":23497963,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-29T06:13:33.679Z","updated_at":"2025-10-16T02:19:22.750Z","avatar_url":"https://github.com/Hiswe.png","language":"JavaScript","readme":"# Gulp dump shopify\n\nThe purpose of this plugin is to grab some datas from [Shopify API](https://docs.shopify.com/api) and to consolidate them in a single JSON file.\n\nAlso this file will try to match as much as possible [Shopify's Objects](https://docs.shopify.com/themes/liquid-documentation/objects)\n\nThe main use case should be to render a static integration with some datas similar to Shopify's one.\n\n## Install\n\n```\nnpm install gulp-dump-shopify --save-dev\n```\n\n## Use\n\nYou will need some credentials from Shopify (see [creating-a-private-app](https://docs.shopify.com/api/authentication/creating-a-private-app))\n\n```js\nvar gulp        = require('gulp');\nvar dumpShopify = require('gulp-dump-shopify');\n\ngulp.task('dump', function () {\n  return dumpShopify({\n      domain: 'https://your-domain.myshopify.com',\n      apikey: '32characterswithnumbersandletter',\n      password: '32characterswithnumbersandletter',\n    })\n    .pipe(gulp.dest('dump'));\n});\n```\n\n### Additional options\n\n*gulp-dump-shopify* can take a `debug` option. If set to `true`, it will also write all results from api calls, and split the dump file in a general, collections \u0026 products files.\n\n### Handle collections \u0026 products references\n\nTo avoid circular references in JSON, all references of products and collections are only made with *ids*.  \n\nYou should replace them with “real” products/collections in order to be closer of Shopify's Object.\n\n```js\nvar shopify     = require('dump/mockup-shopify.json');\nvar collections = shopify.collections;\nvar products    = shopify.products;\n\n// reference products in collections\nfunction getProduct(productId) {\n  return products[productId];\n}\nfor (let collectionName in collections) {\n  let coll = collections[collectionName];\n  coll.products = coll.products.map(getProduct);\n}\n\n// reference collections in products\nfunction getCollection(collectionId) {\n  return collections[collectionId];\n}\nfor (let productId in products) {\n  let prod = products[productId];\n  prod.collections = prod.collections.map(getCollection);\n}\n\n// feed those datas to some templates\n// …\n\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiswe%2Fgulp-dump-shopify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhiswe%2Fgulp-dump-shopify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhiswe%2Fgulp-dump-shopify/lists"}