# eyond_core_api > API Client Latest version **1.0.1** (published 2019-08-11) · Unlicense license · 0 weekly downloads ## Install ```sh npm install eyond_core_api pnpm add eyond_core_api yarn add eyond_core_api bun add eyond_core_api ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.1 | | Published | 2019-08-11 | | First published | 2019-08-11 | | Weekly downloads | 0 | | License | Unlicense | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Unpacked size | 348.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Maintainers | eyond.eu | ## Links - npm: https://www.npmjs.com/package/eyond_core_api - npm.io page: https://npm.io/package/eyond_core_api ## Dependencies (1) - [superagent](https://npm.io/package/superagent.md) 3.7.0 ## Recent versions - 1.0.1 (latest) — 2019-08-11 - 1.0.0 — 2019-08-11 ## README # eyond_core_api EyondCoreApi - JavaScript client for eyond_core_api Eyond Core API is an extensive ASP.NET Core Web API for managing operations between Eyond ERP frontend, Eyond Core Database and thrid party connectors (Shopify, Avocadostore, sevDesk). This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - API version: v1 - Package version: v1 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit [https://eyond.eu/#contact](https://eyond.eu/#contact) ## Installation ### For [Node.js](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell npm install eyond_core_api --save ``` ##### Local development To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run: ```shell npm install ``` Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: ```shell npm link ``` Finally, switch to the directory you want to use your eyond_core_api from, and run: ```shell npm link /path/to/ ``` You should now be able to `require('eyond_core_api')` in javascript files from the directory you ran the last command above from. #### git # If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/eyond_core_api then install it via: ```shell npm install YOUR_USERNAME/eyond_core_api --save ``` ### For browser The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following the above steps with Node.js and installing browserify with `npm install -g browserify`, perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually use this library): ```shell browserify main.js > bundle.js ``` Then include *bundle.js* in the HTML pages. ### Webpack Configuration Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config: ```javascript module: { rules: [ { parser: { amd: false } } ] } ``` ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript var EyondCoreApi = require('eyond_core_api'); var defaultClient = EyondCoreApi.ApiClient.instance; // Configure API key authorization: Bearer var Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = "YOUR API KEY" // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix['Authorization'] = "Token" var api = new EyondCoreApi.ClientsApi() var clientId = 789; // {Number} var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.deleteClient(clientId, callback); ``` ## Documentation for API Endpoints All URIs are relative to *https://eyondcoreapi.azurewebsites.net* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *EyondCoreApi.ClientsApi* | [**deleteClient**](docs/ClientsApi.md#deleteClient) | **DELETE** /api/Clients/delete/{clientId} | *EyondCoreApi.ClientsApi* | [**getClient**](docs/ClientsApi.md#getClient) | **GET** /api/Clients/{clientId} | *EyondCoreApi.ClientsApi* | [**getClients**](docs/ClientsApi.md#getClients) | **GET** /api/Clients/all | *EyondCoreApi.ClientsApi* | [**login**](docs/ClientsApi.md#login) | **POST** /api/Clients/login | *EyondCoreApi.ClientsApi* | [**postClient**](docs/ClientsApi.md#postClient) | **POST** /api/Clients/add | *EyondCoreApi.OrderFulfillmentLineItemsApi* | [**deleteOrderFulfillment**](docs/OrderFulfillmentLineItemsApi.md#deleteOrderFulfillment) | **DELETE** /api/OrderFulfillmentLineItems/delete/client/{clientId}/order/{orderId}/fulfillment/{fulId}/item/{itemId} | *EyondCoreApi.OrderFulfillmentLineItemsApi* | [**getOrderFulfillmentItem**](docs/OrderFulfillmentLineItemsApi.md#getOrderFulfillmentItem) | **GET** /api/OrderFulfillmentLineItems/client/{clientId}/order/{orderId}/fulfillment/{fulId}/item/{itemId} | *EyondCoreApi.OrderFulfillmentLineItemsApi* | [**getOrderFulfillmentItems**](docs/OrderFulfillmentLineItemsApi.md#getOrderFulfillmentItems) | **GET** /api/OrderFulfillmentLineItems/{clientId} | *EyondCoreApi.OrderFulfillmentLineItemsApi* | [**getOrderFulfillmentItems_0**](docs/OrderFulfillmentLineItemsApi.md#getOrderFulfillmentItems_0) | **GET** /api/OrderFulfillmentLineItems/client/{clientId}/order/{orderId} | *EyondCoreApi.OrderFulfillmentLineItemsApi* | [**getOrderFulfillmentItems_1**](docs/OrderFulfillmentLineItemsApi.md#getOrderFulfillmentItems_1) | **GET** /api/OrderFulfillmentLineItems/client/{clientId}/order/{orderId}/fulfillment/{fulId} | *EyondCoreApi.OrderFulfillmentLineItemsApi* | [**postOrderFulfillment**](docs/OrderFulfillmentLineItemsApi.md#postOrderFulfillment) | **POST** /api/OrderFulfillmentLineItems/add | *EyondCoreApi.OrderFulfillmentLineItemsApi* | [**putOrderFulfillment**](docs/OrderFulfillmentLineItemsApi.md#putOrderFulfillment) | **PUT** /api/OrderFulfillmentLineItems/modify/client/{clientId}/order/{orderId}/fulfillment/{fulId}/item/{itemId} | *EyondCoreApi.OrderFulfillmentsApi* | [**deleteOrderFulfillment**](docs/OrderFulfillmentsApi.md#deleteOrderFulfillment) | **DELETE** /api/OrderFulfillments/delete/client/{clientId}/order/{orderId}/fulfillment/{fulId} | *EyondCoreApi.OrderFulfillmentsApi* | [**getOrderFulfillment**](docs/OrderFulfillmentsApi.md#getOrderFulfillment) | **GET** /api/OrderFulfillments/client/{clientId}/order/{orderId}/fulfillment/{fulId} | *EyondCoreApi.OrderFulfillmentsApi* | [**getOrderFulfillments**](docs/OrderFulfillmentsApi.md#getOrderFulfillments) | **GET** /api/OrderFulfillments/{clientId} | *EyondCoreApi.OrderFulfillmentsApi* | [**getOrderFulfillments_0**](docs/OrderFulfillmentsApi.md#getOrderFulfillments_0) | **GET** /api/OrderFulfillments/client/{clientId}/order/{orderId} | *EyondCoreApi.OrderFulfillmentsApi* | [**postOrderFulfillment**](docs/OrderFulfillmentsApi.md#postOrderFulfillment) | **POST** /api/OrderFulfillments/add | *EyondCoreApi.OrderFulfillmentsApi* | [**putOrderFulfillment**](docs/OrderFulfillmentsApi.md#putOrderFulfillment) | **PUT** /api/OrderFulfillments/modify/client/{clientId}/order/{orderId}/fulfillment/{fulId} | *EyondCoreApi.OrdersApi* | [**getOrder**](docs/OrdersApi.md#getOrder) | **GET** /api/Orders/client/{clientId}/order/{ordrId} | *EyondCoreApi.OrdersApi* | [**getOrders**](docs/OrdersApi.md#getOrders) | **GET** /api/Orders/{clientId} | *EyondCoreApi.ProductVariantsApi* | [**deleteProductVariant**](docs/ProductVariantsApi.md#deleteProductVariant) | **DELETE** /api/ProductVariants/delete/client/{clientId}/product/{prodId}/variant/{varId} | *EyondCoreApi.ProductVariantsApi* | [**getProductVariant**](docs/ProductVariantsApi.md#getProductVariant) | **GET** /api/ProductVariants/client/{clientId}/product/{prodId}/variant/{varId} | *EyondCoreApi.ProductVariantsApi* | [**getProductVariants**](docs/ProductVariantsApi.md#getProductVariants) | **GET** /api/ProductVariants/{clientId} | *EyondCoreApi.ProductVariantsApi* | [**getProductVariants_0**](docs/ProductVariantsApi.md#getProductVariants_0) | **GET** /api/ProductVariants/client/{clientId}/product/{prodId} | *EyondCoreApi.ProductVariantsApi* | [**postProductVariant**](docs/ProductVariantsApi.md#postProductVariant) | **POST** /api/ProductVariants/add | *EyondCoreApi.ProductVariantsApi* | [**putProductVariant**](docs/ProductVariantsApi.md#putProductVariant) | **PUT** /api/ProductVariants/modify/client/{clientId}/product/{prodId}/variant/{varId} | *EyondCoreApi.ProductsApi* | [**deleteProduct**](docs/ProductsApi.md#deleteProduct) | **DELETE** /api/Products/delete/client/{clientId}/prod/{prodId} | *EyondCoreApi.ProductsApi* | [**getProduct**](docs/ProductsApi.md#getProduct) | **GET** /api/Products/client/{clientId}/prod/{prodId} | *EyondCoreApi.ProductsApi* | [**getProducts**](docs/ProductsApi.md#getProducts) | **GET** /api/Products/{clientId} | *EyondCoreApi.ProductsApi* | [**postProduct**](docs/ProductsApi.md#postProduct) | **POST** /api/Products/add | *EyondCoreApi.ProductsApi* | [**putProduct**](docs/ProductsApi.md#putProduct) | **PUT** /api/Products/modify/client/{clientId}/prod/{prodId} | *EyondCoreApi.PurchaseOrderLineItemsApi* | [**deletePurchaseOrderLineItem**](docs/PurchaseOrderLineItemsApi.md#deletePurchaseOrderLineItem) | **DELETE** /api/PurchaseOrderLineItems/delete/client/{clientId}/order/{orderId}/lineItem/{itemId} | *EyondCoreApi.PurchaseOrderLineItemsApi* | [**getFPurchaseOrderLineItem**](docs/PurchaseOrderLineItemsApi.md#getFPurchaseOrderLineItem) | **GET** /api/PurchaseOrderLineItems/client/{clientId}/order/{orderId}/lineItem/{itemId} | *EyondCoreApi.PurchaseOrderLineItemsApi* | [**getPurchaseOrderLineItem**](docs/PurchaseOrderLineItemsApi.md#getPurchaseOrderLineItem) | **GET** /api/PurchaseOrderLineItems/{clientId} | *EyondCoreApi.PurchaseOrderLineItemsApi* | [**getPurchaseOrderLineItem_0**](docs/PurchaseOrderLineItemsApi.md#getPurchaseOrderLineItem_0) | **GET** /api/PurchaseOrderLineItems/client/{clientId}/order/{orderId} | *EyondCoreApi.PurchaseOrderLineItemsApi* | [**postPurchaseOrderLineItem**](docs/PurchaseOrderLineItemsApi.md#postPurchaseOrderLineItem) | **POST** /api/PurchaseOrderLineItems/add | *EyondCoreApi.PurchaseOrderLineItemsApi* | [**putFPurchaseOrderLineItem**](docs/PurchaseOrderLineItemsApi.md#putFPurchaseOrderLineItem) | **PUT** /api/PurchaseOrderLineItems/modify/client/{clientId}/order/{orderId}/lineItem/{itemId} | *EyondCoreApi.PurchaseOrdersApi* | [**deletePurchaseOrder**](docs/PurchaseOrdersApi.md#deletePurchaseOrder) | **DELETE** /api/PurchaseOrders/delete/client/{clientId}/purchaseOrder/{orderId} | *EyondCoreApi.PurchaseOrdersApi* | [**getPurchaseOrder**](docs/PurchaseOrdersApi.md#getPurchaseOrder) | **GET** /api/PurchaseOrders/{clientId} | *EyondCoreApi.PurchaseOrdersApi* | [**getPurchaseOrder_0**](docs/PurchaseOrdersApi.md#getPurchaseOrder_0) | **GET** /api/PurchaseOrders/client/{clientId}/purchaseOrder/{orderId} | *EyondCoreApi.PurchaseOrdersApi* | [**posFPurchaseOrder**](docs/PurchaseOrdersApi.md#posFPurchaseOrder) | **POST** /api/PurchaseOrders/add | *EyondCoreApi.PurchaseOrdersApi* | [**putPurchaseOrder**](docs/PurchaseOrdersApi.md#putPurchaseOrder) | **PUT** /api/PurchaseOrders/modify/client/{clientId}/purchaseOrder/{orderId} | *EyondCoreApi.StocksApi* | [**deleteStock**](docs/StocksApi.md#deleteStock) | **DELETE** /api/Stocks/delete/client/{clientId}/warehouse/{warhId}/productVariant/{prodVarId} | *EyondCoreApi.StocksApi* | [**getStock**](docs/StocksApi.md#getStock) | **GET** /api/Stocks/{clientId} | *EyondCoreApi.StocksApi* | [**getStock_0**](docs/StocksApi.md#getStock_0) | **GET** /api/Stocks/client/{clientId}/warehouse/{warhId} | *EyondCoreApi.StocksApi* | [**getStock_1**](docs/StocksApi.md#getStock_1) | **GET** /api/Stocks/client/{id}/warehouse/{warhId}/productVariant/{prodVarId} | *EyondCoreApi.StocksApi* | [**postStock**](docs/StocksApi.md#postStock) | **POST** /api/Stocks/add | *EyondCoreApi.StocksApi* | [**putStock**](docs/StocksApi.md#putStock) | **PUT** /api/Stocks/modify/client/{clientId}/warehouse/{warhId}/productVariant/{prodVarId} | *EyondCoreApi.StocksApi* | [**shift**](docs/StocksApi.md#shift) | **PUT** /api/Stocks/shift/client/{clientId}/sourceWarehouse/{sourceWarhId}/destWarehouse/{destWarhId}/quantity/{quantity} | *EyondCoreApi.WarehousesApi* | [**deleteWarehouse**](docs/WarehousesApi.md#deleteWarehouse) | **DELETE** /api/Warehouses/delete/client/{clientId}/warehouse/{warhId} | *EyondCoreApi.WarehousesApi* | [**getWarehouse**](docs/WarehousesApi.md#getWarehouse) | **GET** /api/Warehouses/{clientId} | *EyondCoreApi.WarehousesApi* | [**getWarehouse_0**](docs/WarehousesApi.md#getWarehouse_0) | **GET** /api/Warehouses/client/{clientId}/warehouse/{warhId} | *EyondCoreApi.WarehousesApi* | [**postWarehouse**](docs/WarehousesApi.md#postWarehouse) | **POST** /api/Warehouses/add | *EyondCoreApi.WarehousesApi* | [**putWarehouse**](docs/WarehousesApi.md#putWarehouse) | **PUT** /api/Warehouses/modify/client/{clientId}/warehouse/{warhId} | ## Documentation for Models - [EyondCoreApi.EyondClient](docs/EyondClient.md) - [EyondCoreApi.OrderFulfillment](docs/OrderFulfillment.md) - [EyondCoreApi.OrderFulfillmentLine](docs/OrderFulfillmentLine.md) - [EyondCoreApi.Product](docs/Product.md) - [EyondCoreApi.ProductVariant](docs/ProductVariant.md) - [EyondCoreApi.PurchaseOrder](docs/PurchaseOrder.md) - [EyondCoreApi.PurchaseOrderLineItem](docs/PurchaseOrderLineItem.md) - [EyondCoreApi.Stock](docs/Stock.md) - [EyondCoreApi.Warehouse](docs/Warehouse.md) ## Documentation for Authorization ### Bearer - **Type**: API key - **API key parameter name**: Authorization - **Location**: HTTP header --- _Source: https://npm.io/package/eyond_core_api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._