@agnostack/magento2-request/README.md

Please contact agnoStack via info@agnostack.com for any questions

# @agnostack/magento2-request

> 🎮 Minimal [Magento2](https://devdocs.magento.com/guides/v2.3/rest/bk-rest.html) API request library for Node

## Installation

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

## Quickstart (OAuth)

```js
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

```js
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.

```js
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](https://www.linkedin.com/in/adamgrohs/) @ [agnoStack](https://agnostack.com/) for any questions._