moysklad-ts

This library is in alpha stage and is not ready for production use.

moysklad-ts is a fully-typed API wrapper for Moysklad.

Usage

Installation

npm

npm i moysklad-ts

Other package managers

pnpm

pnpm add moysklad-ts

Yarn

yarn add moysklad-ts

bun

bun add moysklad-ts

Deno

import { Moysklad } from "https://esm.sh/moysklad-ts";

Example

import { Moysklad, MoyskladApiError } from "moysklad-ts";

const moysklad = new Moysklad({
  auth: {
    token: "123"
  }
});

try {
  const { rows: bonusTransactions } = await moysklad.bonusTransaction.list({
    expand: { bonusProgram: true }
  });
} catch (error) {
  if (error instanceof MoyskladApiError) {
    console.error(error.message, error.code, error.moreInfo);
		return;
  }

	console.error(error);
}

Documentation

The documentation is available here.

Документация на русском языке доступна здесь.

Contributing

Please read the contributing guidelines before submitting a pull request.

License

This project is licensed under the GPL-3.0 license.

Roadmap

Core features

• ✅ API Client
• ✅ One-level expand
• ✅ Nested expand
• ✅ Ordering
• ✅ Search
• ✅ Filtering
• ⭕ Named filters
• ⭕ Attributes
• ⭕ Positions
• ⭕ Async tasks

Endpoints

• ⭕ Metadata
• ⭕ Assortment
• ⭕ Bonus transaction
• ⭕ Bonus program
• ⭕ Currency
• ⭕ Webhook
• ⭕ Stock webhook
• ⭕ Processing plan folder
• ⭕ Product folder
• ⭕ Contract
• ⭕ UOM
• ⭕ Task
• ⭕ Sales channel
• ⭕ Cashier
• ⭕ Bundle
• ⭕ Counterparty
• ⭕ Variant
• ⭕ Company settings
• ⭕ User settings
• ⭕ Group
• ⭕ Subscription
• ⭕ Role
• ⭕ Custom entity
• ⭕ Project
• ⭕ Region
• ⭕ Consignment
• ⭕ Discount
• ⭕ Store
• ⭕ Employee
• ⭕ Named filter
• ⭕ Tax rate
• ⭕ Expense item
• ⭕ Country
• ⭕ Processing plan
• ⭕ Processing process
• ⭕ Price type
• ⭕ Product
• ⭕ Retail store
• ⭕ Service
• ⭕ Variant's characheristic
• ⭕ Embedded template
• ⭕ Organization
• ⭕ Processing stage