@kasual-business/prestashop-api

v1.5.7

Published

5 months ago

Prestashop node API

Downloads

131

0High
0Medium
0Low

nico.kasual

yourikopecky

prestashop node api typescript

prestashop-api

Simplified and typed calls to Prestashop webservices.

Access all endpoints offered by Prestashop webservices as well as custom routes added by addons.

Installation

npm install @kasual-business/prestashop-api

Usage/Examples

Initialize the connection

You only need to initialize the api url and api key once.

import { init } from "@kasual-business/prestashop-api";

// Init the api url and api key
init("https://my-prestashop.com", "my-api-key");

Use

import prestashopAPI, { products } from "@kasual-business/prestashop-api";

await prestashopAPI.products.list();
// or
await products.list();

List

// List all products
await products.list();

// Precise custom type
interface CustomProduct extends Product {
  custom_key_from_addon: string;
}

await products.list<CustomProduct>();

Filter on name with exact match

// List all products having 1 as id_supplier
await products.list({
  filters: [{ key: "id_supplier", value: 1 }],
});

Filter on name with containing operator

// List all products containing "orange" in name
await products.list({
  filters: [{ key: "name", value: "orange", operator: "contains" }],
});

Sort

// List all products and sort on id DESC
await products.list({
  sort: ["id_DESC"],
});

Display

// List all products and display only id and name
await products.list({
  display: ["id", "name"],
});

Pagination

// List all products and use skip and limit to paginate
await products.list({
  skip: 0,
  limit: 10,
});

Find

It works like list except it only returns the first item of the list. This can be useful when searching by EAN13, for example. It avoids having to manipulate the returned array in order to obtain the first element.

// Returns the first product
await products.find();

// Returns the first product having his ean13 equals to 123
await products.find({
  filters: [{ key: "ean13", value: "123" }],
});

Create

// Create a product
await products.create({
  name: "name",
  // ...rest of the mandatory values
});

// Create a product with multiple languages
await products.create({
  name: [
    { id: 1, value: "My Name 1" },
    { id: 2, value: "My Name 2" },
  ],
  // ...rest of the mandatory values
});

Update

// Update product with id 1
await products.update(1, {
  name: "new name",
});

// Update the name of product with id 1 with multiple languages
await products.update(1, {
  name: [
    { id: 1, value: "My Name 1" },
    { id: 2, value: "My Name 2" },
  ],
});

// Update the name and the reference
await products.update(1, {
  name: [
    { id: 1, value: "My Name 1" },
    { id: 2, value: "My Name 2" },
  ],
  reference: "my-ref",
});

Delete

// Delete product with id 1
await products.delete(1);

Custom calls

If you have an addon that add additional routes to prestashop's webservices, you can call them like this:

// list
await custom<{ items: Item[] }>("my-custom-route").list();

// get
await custom<{ item: Item }>("my-custom-route").get(1);

// create
await custom<{ item: Item }>("my-custom-route").create<{ name: string }>({ name: "My name" });

// update
await custom<{ item: Item }>("my-custom-route").update<{ name: string }>(1, { name: "My new name" });

// delete
await custom<{ item: Item }>("my-custom-route").delete(1);

// list with custom query params
const searchParams = new URLSearchParams();

searchParams.append('myCustomId', '1');

await custom<{ items: Item[] }>('my-custom-route').list({
  customSearchParams: searchParams,
});

// send body as json instead of xml
await custom<{ item: Item }>("my-custom-route").create<{ name: string }>({ name: "My name" }, { json: true });
await custom<{ item: Item }>("my-custom-route").update<{ name: string }>(1, { name: "My new name" }, { json: true });

API Reference

ListParams

| Name | Value | Description | | :-------- | :------------------------------------------------------------ | :--------------------------------------- | | display | 'full' or string[] | Display specific keys | | filters | {key: string; value: string OR number, operator?: Operator}[] | Filter on one or many params | | limit | number | Limit the number of items | | skip | number | Skip to the index (should specify limit) | | sort | (${string}_ASC OR ${string}_DESC)[] | Sort ASC or DESC on one several keys |

Note: In order to do an OR operator while filtering on a key, just append the same key multiple times.

import { products } from "@kasual-business/prestashop-api";

const listProducts = async () => {
  const response = await products.list({
    filters: [
      { key: "id", value: 1 },
      { key: "id", value: 2 },
    ],
  });
};

GetParams

PostParams

PutParams

CustomParams

CustomGetParams

Operator

Operator can be 'start', 'end', 'contains' and 'strict'.

References

addresses

attachments

carriers

cartRules

carts

combinations

configurations

contacts

contentManagementSystem

countries

currencies

customerMessages

customerThreads

customers

customizations

deliveries

employees

groups

guests

imageTypes

images

languages

manufacturers

messages

orderCarriers

orderCartRules

orderDetails

orderHistories

orderInvoices

orderPayments

orderSlip

orderStates

orders

priceRanges

productCustomizationFields

productFeatureValues

productFeatures

productOptionValues

productOptions

productSuppliers

products

search

shopGroups

shopUrls

shops

specificPriceRules

specificPrices

states

stockAvailables

stockMovementReasons

stockMovements

stocks

stores

suppliers

supplyOrderDetails

supplyOrderHistories

supplyOrderReceiptHistories

supplyOrderStates

supplyOrders

taxRuleGroups

taxRules

taxes

translatedConfigurations

warehouseProductLocations

warehouses

weightRanges

zones

custom

Tests

npm run test