Skip to content

Latest commit

 

History

History
executable file
·
80 lines (66 loc) · 3.18 KB

Readme.md

File metadata and controls

executable file
·
80 lines (66 loc) · 3.18 KB
Raw

PrestaShop REST API Module

Easily expose REST API endpoints for your Prestashop website. No configuration needed, just install and use it.

Official Supported Version v5

Compatible with PrestaShop 8.x, Annotation-based API routing support, and many admin APIs and full front APIs.

Latest release v5.3.0 (Sep, 2024)

  • Feat
    • Guest checkout functionality
    • (Admin API) added product reference for product combinations
    • (Admin API) setting default category id when creating new product
  • Fix
    • fix for wishlist API
    • fix for product quantity in admin product creation
    • fix for loading classes in dispatcher override

Free Version v2.5

For demo and testing, not recommended for production.

The products that use this REST API

PrestaShop PWAPrestaShop PWA PrestaShop Mobile Application PrestaShop Mobile App

Headless Commerce

This module helps you to build Headless applications based on PrestaShop platform. You can read this article to know about Headless PrestaShop and Headless Commerce, why we need it and why it matters.

Demo Link

https://rest.binshops.com/rest/bootstrap

Your API Endpoint

After installation access your API endpoints at: http://yourdomain.tld/rest.

Why we need this API module? Is not Webservice API enough?

You can get more info about this module: https://www.binshops.com/prestashop-api

Documentation

You can access full documentation for REST endpoints on Postman publisher: https://documenter.getpostman.com/view/1491681/TzkyP1UC

How to write your API?

Annotation-based API routing added in v5.

/**
* @Route("/rest/get-products", name=”products”)
*/
public function getProducts()
{
// ...
}

Required Modules

These native modules, which are already included in PrestaShop out of the box, are required to work with some endpoints.

  • ps_mainmenu (Native Ps Menu module)
  • ps_featuredproducts (Native Ps Featured Products module)
  • ps_facetedsearch (Native Ps Faceted Search module)
  • productcomments (Native Ps Product Comments module)
  • ps_banner (Native Ps Banner module)
  • ps_imageslider (Native Ps Image slider module)
  • ps_wirepayment (Native Ps Bankwire module)
  • ps_checkpayment (Native Ps Pay by Check module)
  • blockwishlist (Native Ps Wishlist module)

If you need custom APIs or you want to have APIs for a third-party module, you can send your request for custom API implementation on Binshops website - Request Form