josalba/prestashop-webservice-lib

PrestaShop Webservice access library

0.0.7 2024-10-24 20:33 UTC

Requires

• php: >=8.0
• ext-curl: *
• ext-libxml: *
• ext-simplexml: *
• doctrine/annotations: ^2.0
• guzzlehttp/guzzle: ^7.5
• jms/serializer-bundle: ^5.2

Requires (Dev)

• phpunit/phpunit: ^10.0
• roave/security-advisories: dev-latest

OSL-3.0

• PrestaShop SA
• josAlba

README

This library allows you to perform requests to a PrestaShop instance using the Webservice API.

Installation

Install the library using composer:

composer require josalba/prestashop-webservice-lib

Usage

La clase Get se encuentra en el los diferentes paquetes (Combinations, Products, StockAvaliable) y se utiliza para realizar solicitudes GET a la API de PrestaShop. Aquí te mostramos cómo usarla.

Ejemplo con StockAvaliables.

Método get

El método __invoke() se utiliza para obtener todos los elementos disponibles. Evoca internamente un método getRaw() para obtener la respuesta en bruto de la API y la deserializa al objeto.

$get = new Get('url','token');
$display = new DisplayFull();
$filter = new Filter(/* Parámetros del constructor */);

$result = $get($display, $filter);

Parámetros

Este método acepta dos parámetros:

• Display $display: Este parámetro determina la cantidad de detalles que se deben devolver. Si deseas obtener todos los detalles, puedes usar la implementación del DisplayFull.

• Filter $filter (opcional): Este parámetro se utiliza para especificar criterios de filtrado. Si lo dejas vacío, el método devolverá todos los recursos disponibles.

Método put

El método __invoke() se utiliza actualizar el objeto. Evoca internamente un método put() .

$put = new Put('url','token');
$prestashopStockAvailableUpdate = new PrestashopStockAvailableUpdate(new StockAvailable(id: 1, quantity: 10));
$shopParam = new ShopParam(shopId: 1); 

$result = $put($prestashopStockAvailableUpdate, $filter, $shopParam);

Parámetros

Este método acepta dos parámetros:

• PrestashopItemUpdate $item: Necesita un item, el item tiene que tener mínimo id y los campos que se quieren actualizar.
• ShopParam $shopParam: Indica la tienda de prestashop.

License

This library is released under the OSL-3.0 license.