jokesterfr / ws-client

A webservice client library for PrestaShop written in TypeScript

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

WS-CLIENT

Description

Typescript Webservice Client to use with PrestaShop Core.

TO DO :

  • Typing : 2 types are required
    • Readable
    • Writable

PrestaShop Compatibility :

  • 9
  • 8
  • 1.7

NodeJs compatibility :

  • 18

Endpoint to implement

Endpoint URL Done
product []
order []
customer []
cart []
cart_rule []
category []
store []
tax []
tax_rule []
address []
country []

Stack

Architecture

How to use

const client = new WSClient({
  baseURl: process.env.BASE_URL, // URL of your PrestaShop
  wsKey: process.env.WS_KEY, // Key to connect to your prestashop
});

const response = await client.product.create(productData); 
console.log(response.status);
console.log(response.data.product); // Maybe return type writable ??

// Error case
// Return an Exeption depending on what is the error.
// UnreachableServerException
// WrongPayloadException
// RequestTimeoutException
// InvalidCredentialsException

Contributing

This library is an open source solution. Everyone is welcome and even encouraged to contribute with their own improvements!

Just make sure to follow our contribution guidelines.

Reporting issues

You can report issues here.

About

A webservice client library for PrestaShop written in TypeScript