{"id":28147803,"url":"https://github.com/uniquelyparticular/shopify-request","last_synced_at":"2025-08-24T19:20:41.412Z","repository":{"id":34732327,"uuid":"183086859","full_name":"uniquelyparticular/shopify-request","owner":"uniquelyparticular","description":"A Particularly minimal Shopify API request library for Node.","archived":false,"fork":false,"pushed_at":"2025-05-14T15:48:07.000Z","size":567,"stargazers_count":8,"open_issues_count":98,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-15T00:22:29.538Z","etag":null,"topics":["api","ecommerce","javascript","node","particular","shopify","typescript"],"latest_commit_sha":null,"homepage":"https://uniquelyparticular.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/uniquelyparticular.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-04-23T19:57:48.000Z","updated_at":"2023-03-17T02:08:13.000Z","dependencies_parsed_at":"2024-06-16T18:17:39.996Z","dependency_job_id":"f06ee46d-3afc-4afb-b6a7-dc4268b85f0a","html_url":"https://github.com/uniquelyparticular/shopify-request","commit_stats":{"total_commits":46,"total_committers":7,"mean_commits":6.571428571428571,"dds":0.5,"last_synced_commit":"295524eeb4e56941354abe7ad540704e84574c6b"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uniquelyparticular%2Fshopify-request","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uniquelyparticular%2Fshopify-request/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uniquelyparticular%2Fshopify-request/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uniquelyparticular%2Fshopify-request/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uniquelyparticular","download_url":"https://codeload.github.com/uniquelyparticular/shopify-request/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254249334,"owners_count":22039050,"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":["api","ecommerce","javascript","node","particular","shopify","typescript"],"created_at":"2025-05-15T00:22:23.854Z","updated_at":"2025-05-15T00:22:34.662Z","avatar_url":"https://github.com/uniquelyparticular.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @particular./shopify-request\n\n[![npm version](https://img.shields.io/npm/v/@particular./shopify-request.svg)](https://www.npmjs.com/package/@particular./shopify-request) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![CircleCI](https://img.shields.io/circleci/project/github/uniquelyparticular/shopify-request.svg?label=circleci)](https://circleci.com/gh/uniquelyparticular/shopify-request)\n![dependency status: david](https://img.shields.io/david/uniquelyparticular/shopify-request.svg)\n\n\u003e 🎮 Minimal [Shopify](https://www.shopify.com) API request library for Node\n\n## Installation\n\n```bash\nyarn add @particular./shopify-request # npm install @particular./shopify-request\n```\n\n## Quickstart (OAuth)\n\n```js\nconst { createClient } = require('@particular./shopify-request');\n// import { createClient } from '@particular./shopify-request'\n\nconst shopify = new createClient({\n  store_name: '...', //Shopify Store Name\n  admin_access_token: '...', //Shopify OAuth token received after registering as Public App and installing to Store\n  storefront_access_token: '...' //Shopify OAuth token received after using admin_access_token to call 'admin/storefront_access_tokens.json'\n});\n\nshopify\n  .delete('admin/products/:product_id.json')\n  .then(console.log)\n  .catch(console.error);\n\nshopify\n  .get('admin/products.json')\n  .then(console.log)\n  .catch(console.error);\n\nshopify\n  .post('admin/products.json', {\n    product: {\n      title: 'My Product',\n      body_html: \"\u003cstrong\u003eIt's great!\u003c/strong\u003e\",\n      variants: [\n        {\n          option1: 'S',\n          price: '10.00',\n          sku: '123'\n        }\n      ]\n    }\n  })\n  .then(console.log)\n  .catch(console.error);\n\nshopify\n  .put('admin/products/:product_id.json', {\n    product: {\n      id: 632910392,\n      tags: 'tag 1, tag 2, tag 3'\n    }\n  })\n  .then(console.log)\n  .catch(console.error);\n```\n\n## Quickstart (Basic Auth)\n\n**_NOTE: This should not be used in production as it passes `client_pass` in base64 encoded clear text using basic auth._**\n\n```js\nconst shopify = new createClient({\n  store_name: '...', //Shopify Store Name\n  client_key: '...', //Shopify API Key\n  client_pass: '...' //Shopify API Password\n});\n```\n\n## Kitchen sink\n\n```js\nconst shopify = new createClient({\n    store_name: '...',\n    admin_access_token: '...',\n    storefront_access_token: '...',\n    application: '...',\n    headers: {\n        // ...\n    }\n})\n\n-OR- //access_token (above) -OR- client_key AND client_pass BUT INSECURE (below)\n\nconst shopify = new createClient({\n    store_name: '...',\n    client_key: '...',\n    client_pass: '...'\n    application: '...',\n    headers: {\n        // ...\n    }\n})\n```\n\n## Custom headers per request\n\nThe API provides you the ability to send various request headers that change the way data is stored or retrieved.\n\nBy default this library will encode all data as JSON, however you can customise this by setting your own `Content-Type` header as an additional argument to `get`, `patch`, `post`, `put` and `delete`.\n\n**Note**: If you add the `Content-Type` custom header to `patch`, `post`, `put` or `delete` you will need to encode `data` yourself.\n\n```js\nconst shopify = new createClient({\n  store_name: '...',\n  admin_access_token: '...',\n  storefront_access_token: '...'\n});\n\nconst headers = {\n  'X-My-Header': 'custom'\n};\n\nshopify\n  .get('admin/products.json', headers)\n  .then(console.log)\n  .catch(console.error);\n```\n\n_Contact [Adam Grohs](https://www.linkedin.com/in/adamgrohs/) @ [Particular.](https://uniquelyparticular.com) for any questions._\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funiquelyparticular%2Fshopify-request","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funiquelyparticular%2Fshopify-request","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funiquelyparticular%2Fshopify-request/lists"}