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 | URL | Done |
---|---|---|
addresses | [] | |
carts | [] | |
cart_rules | [] | |
categories | [] | |
country | [] | |
customers | [] | |
orders | [] | |
products | [] | |
stores | [] | |
taxes | [] | |
tax_rules | [] |
- fetch
- Typescript
Set up the env file:
cp .env.dist .env
open .env
Run some code:
const client = new BaseClient({
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
Install dependencies:
npm install -g pnpm
pnpm install
Build the library:
pnpm build
Test the library:
pnpm test
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.
You can report issues here.