@geedium/linnworks v1.1.0

Linnworks Node.js SDK

The Linnworks Node.js SDK is here to make connecting with the Linnworks platform super easy for Node.js developers.

⚙️ Installiation

yarn add @geedium/linnworks

You can use your preferred package manager yarn is just an example.

🚀 Quick Start

import { Linnworks } from '@geedium/linnworks';

const client = Linnworks({
    applicationId: "<your_application_id>",
    applicationSecret: "<your_application_secret>",
    installiationToken: "<your_installation_token>",
    version: "v1",
});

await client.auth.authorizeByApplication();

const topProducts = await client.dashboards.getPerformanceTableData({
    period: 1,
});

console.log(topProducts);

🪢 Integrations

This package only includes types and utilities for the integrations.
You must deploy your own application server and host it with your chosen service.
You can obtain your application id, secret, and token from the Linnworks Developer Portal.

!Tip You can import the integration and access all its exported types.

import { Linnworks, Channel } from '@geedium/linnworks';

const var: Channel.ExpectedType = Channel.ExpectedType.STRING;

v1

v2