npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@agnostack/magento2-request

v1.1.6

Published

Please contact agnoStack via [email protected] for any questions

Downloads

25

Readme

@agnostack/magento2-request

🎮 Minimal Magento2 API request library for Node

Installation

yarn add @agnostack/magento2-request # npm install @agnostack/magento2-request

Quickstart (OAuth)

const { createClient } = require('@agnostack/magento2-request');
// import { createClient } from '@agnostack/magento2-request'

const magento2 = new createClient({
  store_code: 'default', // Magento2 Store Code (optional)
  store_url: '...', // Magento2 Store Url.
  username: '...', // Magento2 Admin username (for token).
  password: '...' // Magento2 Admin password (for token).
});

// const magento2 = new createClient({
//   store_url: '...', // Magento2 Store Url.
//   access_token: '...' // Magento2 Admin token.
// });

magento2
  .get('products/types')
  .then(console.log)
  .catch(console.error);

magento2
  .post('carts/12345/estimate-shipping-methods', {
    address: {
      country_id: 'US'
    }
  })
  .then(console.log)
  .catch(console.error);

magento2
  .put('/carts/12345', {
    customerId: 3,
    storeId: 1
  })
  .then(console.log)
  .catch(console.error);

// GraphQL
magento2
  .query({
    query: `
      {
        products(
          filter: { sku: { like: "sku-123" } }
        ) {
          items {
            sku
          }
        }
      }
    `
  })
  .then(console.log)
  .catch(console.error);

Kitchen sink

const NodeStorageAdapter = require('@moltin/node-storage-adapter')
const magento2 = new createClient({
  store_url: '...',
  username: '...',
  password: '...',
  access_token: '...',
  store_code: '...',
  storage: new NodeStorageAdapter('./tmp/localStorage')
  version: 'V1',
  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, post, put and delete.

Note: If you add the Content-Type custom header to post, put or delete you will need to encode data yourself.

const magento2 = new createClient({
  store_url: '...',
  username: '...',
  password: '...'
});

const headers = {
  'X-My-Header': 'custom'
};

magento2
  .get('products/types', headers)
  .then(console.log)
  .catch(console.error);

Contact Adam Grohs @ agnoStack for any questions.