idosell

library0.4.38jsnpmunverified

A TypeScript-first wrapper for the Idosell 3 REST API (e-commerce platform), providing chainable methods, intuitive property-to-endpoint mapping, and helper functions for request formatting. Current stable version is 0.4.38, with active development. Key differentiators: translates awkward gateway names to readable REST verbs, supports method chaining for parameters, and includes built-in pagination helpers. Requires Shop URL, API key, and optional API version (default v7). Ideal for Node.js environments interacting with Idosell stores.

ecommerce

npm install idosell

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · IDOSELL

idosell

ecommercejavascriptv0.4.38

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default (idosell)

✓ import idosell from 'idosell';

✗ import { idosell } from 'idosell';

Package exports a default function, not a named export.

IdosellRequest (initiated instance)

✓ const idosellRequest = idosell('SHOP_URL', 'API_KEY', 'v7');

✗ const idosellRequest = new idosell('SHOP_URL', 'API_KEY');

idosell() is a factory function, not a constructor.

IdosellConfig (optional types)

✓ import type { IdosellConfig } from 'idosell';

✗ import { IdosellConfig } from 'idosell';

TypeScript users can import types, but they are not runtime exports.

Shows how to initialize the client, fetch paginated categories, and create a discount rebate code using method chaining.

import idosell from 'idosell'; const shopUrl = process.env.SHOP_URL ?? 'https://yourdomain.com'; const apiKey = process.env.API_KEY ?? ''; const apiVersion = 'v7'; // optional, default v7 const idosellRequest = idosell(shopUrl, apiKey, apiVersion); // Fetch product categories with pagination const categories = await idosellRequest.getProductsCategories .ids([123, 456]) .languages(['pol', 'eng']) .result_page(1) .result_limit(10) .exec(); console.log('Categories:', categories); // Create a discount rebate code (POST) const rebate = await idosellRequest.postDiscountsRebatesCode .campaign_id(123) .code_number('REBATECODE') .exec(); console.log('Rebate created:', rebate);

Debug

Known issues

breakingPackage version <1.0, may have breaking changes in minor/patch releases.

fix

Pin to exact version in package.json (e.g., "idosell": "0.4.38") and test upgrades.

affects: <1.0.0

gotchaExec() returns a Promise; must be awaited or handled with .then().

fix

Use await or .then() when calling .exec().

affects: >=0.0.0

deprecatedThe default API version may change in future releases; always specify explicitly.

fix

Pass the desired API version as third argument to idosell() (e.g., 'v7').

affects: >=0.0.0

gotchaParameter names like 'result_page' are snake_case, not camelCase.

fix

Use snake_case as shown in examples (e.g., result_page, result_limit).

affects: >=0.0.0

gotchaSome endpoints map to non-obvious properties (e.g., getProducts => /products/products).

fix

Refer to the converter tool or documentation for property-to-endpoint mapping.

affects: >=0.0.0

breakingVersion 0.x may have renamed methods between releases; not guaranteed API stable.

fix

Check changelog before upgrading; lock version in package.json.

affects: >=0.0.0 <1.0.0

Errors

Common errors & fixes

Cannot find module 'idosell' or its corresponding type declarations.

Package is not installed or not recognized by TypeScript compiler.

fix

Install via npm: npm install idosell. Ensure tsconfig.json includes 'node_modules' in 'paths' or 'types'.

TypeError: idosell is not a function

Using named import instead of default import.

fix

Use default import: import idosell from 'idosell';

Property 'getProductCategories' does not exist on type '...'

Typo in method name (missing 's' after 'product').

fix

Correct method name: getProductsCategories (plural 'Products').

Cannot read properties of undefined (reading 'exec')

idosell() returned undefined due to missing or invalid arguments.

fix

Ensure SHOP_URL, API_KEY, and API_VERSION are provided and valid.

Upgrade

Version history

0.4.38latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

35 hits · last 30 days

node

Resources

githubhttps://github.com/ltung7/idosell ↗

packageidosell ↗

homepagehttps://idosell-converter.vercel.app ↗