https://github.com/uniquelyparticular/shopify-request
A Particularly minimal Shopify API request library for Node.
https://github.com/uniquelyparticular/shopify-request
api ecommerce javascript node particular shopify typescript
Last synced: 11 months ago
JSON representation
A Particularly minimal Shopify API request library for Node.
- Host: GitHub
- URL: https://github.com/uniquelyparticular/shopify-request
- Owner: uniquelyparticular
- License: mit
- Created: 2019-04-23T19:57:48.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-05-14T15:48:07.000Z (about 1 year ago)
- Last Synced: 2025-05-15T00:22:29.538Z (about 1 year ago)
- Topics: api, ecommerce, javascript, node, particular, shopify, typescript
- Language: TypeScript
- Homepage: https://uniquelyparticular.com
- Size: 554 KB
- Stars: 8
- Watchers: 3
- Forks: 2
- Open Issues: 98
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @particular./shopify-request
[](https://www.npmjs.com/package/@particular./shopify-request) [](https://github.com/semantic-release/semantic-release) [](https://github.com/prettier/prettier) [](https://circleci.com/gh/uniquelyparticular/shopify-request)
> 🎮 Minimal [Shopify](https://www.shopify.com) API request library for Node
## Installation
```bash
yarn add @particular./shopify-request # npm install @particular./shopify-request
```
## Quickstart (OAuth)
```js
const { createClient } = require('@particular./shopify-request');
// import { createClient } from '@particular./shopify-request'
const shopify = new createClient({
store_name: '...', //Shopify Store Name
admin_access_token: '...', //Shopify OAuth token received after registering as Public App and installing to Store
storefront_access_token: '...' //Shopify OAuth token received after using admin_access_token to call 'admin/storefront_access_tokens.json'
});
shopify
.delete('admin/products/:product_id.json')
.then(console.log)
.catch(console.error);
shopify
.get('admin/products.json')
.then(console.log)
.catch(console.error);
shopify
.post('admin/products.json', {
product: {
title: 'My Product',
body_html: "It's great!",
variants: [
{
option1: 'S',
price: '10.00',
sku: '123'
}
]
}
})
.then(console.log)
.catch(console.error);
shopify
.put('admin/products/:product_id.json', {
product: {
id: 632910392,
tags: 'tag 1, tag 2, tag 3'
}
})
.then(console.log)
.catch(console.error);
```
## Quickstart (Basic Auth)
**_NOTE: This should not be used in production as it passes `client_pass` in base64 encoded clear text using basic auth._**
```js
const shopify = new createClient({
store_name: '...', //Shopify Store Name
client_key: '...', //Shopify API Key
client_pass: '...' //Shopify API Password
});
```
## Kitchen sink
```js
const shopify = new createClient({
store_name: '...',
admin_access_token: '...',
storefront_access_token: '...',
application: '...',
headers: {
// ...
}
})
-OR- //access_token (above) -OR- client_key AND client_pass BUT INSECURE (below)
const shopify = new createClient({
store_name: '...',
client_key: '...',
client_pass: '...'
application: '...',
headers: {
// ...
}
})
```
## Custom headers per request
The API provides you the ability to send various request headers that change the way data is stored or retrieved.
By 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`.
**Note**: If you add the `Content-Type` custom header to `patch`, `post`, `put` or `delete` you will need to encode `data` yourself.
```js
const shopify = new createClient({
store_name: '...',
admin_access_token: '...',
storefront_access_token: '...'
});
const headers = {
'X-My-Header': 'custom'
};
shopify
.get('admin/products.json', headers)
.then(console.log)
.catch(console.error);
```
_Contact [Adam Grohs](https://www.linkedin.com/in/adamgrohs/) @ [Particular.](https://uniquelyparticular.com) for any questions._