shopify-request
eCommerce
TypeScript
@particular./shopify-request
🎮 Minimal Shopify API request library for Node
Installation
yarn add @particular./shopify-request # npm install @particular./shopify-request
Quickstart (OAuth)
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: "<strong>It's great!</strong>", 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.
const shopify = new createClient({ store_name: '...', //Shopify Store Name client_key: '...', //Shopify API Key client_pass: '...' //Shopify API Password });
Kitchen sink
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.
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 @ Particular. for any questions.