Package Exports

@agnostack/magento2-request

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@agnostack/magento2-request) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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.