Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bukimedia/prestasharp
CSharp .Net client library for the PrestaShop API via web service
https://github.com/bukimedia/prestasharp
c-sharp csharp dot-net dotnet prestashop prestashop-api prestashop-webservice
Last synced: about 15 hours ago
JSON representation
CSharp .Net client library for the PrestaShop API via web service
- Host: GitHub
- URL: https://github.com/bukimedia/prestasharp
- Owner: Bukimedia
- License: gpl-3.0
- Created: 2013-07-02T09:48:04.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-02-22T15:55:31.000Z (7 months ago)
- Last Synced: 2024-09-26T11:41:38.646Z (about 15 hours ago)
- Topics: c-sharp, csharp, dot-net, dotnet, prestashop, prestashop-api, prestashop-webservice
- Language: C#
- Homepage:
- Size: 632 KB
- Stars: 155
- Watchers: 43
- Forks: 151
- Open Issues: 95
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PrestaSharp
[](https://travis-ci.org/Bukimedia/PrestaSharp)
[](https://lgtm.com/projects/g/Bukimedia/PrestaSharp/alerts/)
[](https://lgtm.com/projects/g/Bukimedia/PrestaSharp/context:csharp)
### CSharp .Net client library for the PrestaShop API via web service
## Introduction
A simple .Net REST client written in C# for the Prestashop API.
PrestaSharp uses the RestSharp library to consume the Prestashop services.
# Installation
[](http://www.nuget.org/packages/PrestaSharp)
PrestaSharp is [available on NuGet](https://www.nuget.org/packages/PrestaSharp/). Use the package manager
console to install it:
```powershell
Install-Package PrestaSharp
```
## Basic usage
1) Initiate a client instance:
```csharp
string baseUrl = "http://www.myweb.com/api";
string account = "ASDLKJOIQWEPROQWUPRPOQPPRQOW";
string password = "";
ManufacturerFactory manufacturerFactory = new ManufacturerFactory(baseUrl, account, password);
```
2) Perform CRUD actions through the client:
```csharp
Bukimedia.PrestaSharp.Entities.manufacturer manufacturer = manufacturerFactory.Get(6);
manufacturer.name = "Iron Maiden";
manufacturer.active = 1;
manufacturerFactory.Add(manufacturer);
manufacturerFactory.Update(manufacturer);
manufacturerFactory.Delete(manufacturer);
```
3) Add an image:
```csharp
Bukimedia.PrestaSharp.Entities.product myProduct = new Bukimedia.PrestaSharp.Entities.product();
ProductFactory productFactory = new ProductFactory(baseUrl, account, password);
myProduct = productFactory.Add(myProduct);
ImageFactory imageFactory = new ImageFactory(baseUrl, account, password);
imageFactory.AddProductImage((long)myProduct.id, "C:\\MyImage.jpg");
```
4) Set quantity of products:
The quantity of a product may not be updated directly in the 'product' entity. You need to update 'stock_available' entity.
```csharp
StockAvailableFactory stockAvailableFactory = new StockAvailableFactory(baseUrl, account, password);
long stockAvailableId = myProduct.associations.stock_availables[0].id;
Bukimedia.PrestaSharp.Entities.stock_available myStockAvailable = stockAvailableFactory.Get(stockAvailableId);
myStockAvailable.quantity = 99; // Number of available products
myStockAvailable.out_of_stock = 1; // Must enable orders
stockAvailableFactory.Update(myStockAvailable);
```
## Advanced usage
1) Get all. This sample retrieves the list of manufacturers:
```csharp
List manufacturers = ManufacturerFactory.GetAll();
```
2) Get ids. This sample retrieves the list of the manufacturer ids:
```csharp
List ids = ManufacturerFactory.GetIds();
```
3) Get by filter. This sample retrieves the list of manufacturers which name is "Metallica":
```csharp
Dictionary dtn = new Dictionary();
dtn.Add("name", "Metallica");
List manufacturers = ManufacturerFactory.GetByFilter(dtn, null, null);
```
4) Get by filter with wildcards. This sample retrieves the manufacturers which name starts with "Metall":
```csharp
Dictionary dtn = new Dictionary();
dtn.Add("name", "[Metall]%");
List manufacturers = ManufacturerFactory.GetByFilter(dtn, null, null);
```
5) Get ids by filter. This sample retrieves the list of the manufacturers ids which name is "Metallica":
```csharp
Dictionary dtn = new Dictionary();
dtn.Add("name", "Metallica");
List ids = ManufacturerFactory.GetIdsByFilter(dtn, null, null);
```
6) Get ids by filter with wildcards. This sample retrieves the list of the manufacturers ids which name starts with "Metall":
```csharp
Dictionary dtn = new Dictionary();
dtn.Add("name", "[Metall]%");
List ids = ManufacturerFactory.GetIdsByFilter(dtn, null, null);
```
7) Get by complex filter. This sample retrieves the top five manufacturers in ascendent sorting which name starts with "Metall":
```csharp
Dictionary dtn = new Dictionary();
dtn.Add("name", "[Metall]%");
List manufacturers = ManufacturerFactory.GetByFilter(dtn, "name_ASC", "5");
```
8) Get by filter for pagination. This sample retrieves the top five manufacturers from tenth position in ascendent sorting which name starts with "Metall":
```csharp
Dictionary dtn = new Dictionary();
dtn.Add("name", "[Metall]%");
List manufacturers = ManufacturerFactory.GetByFilter(dtn, "name_ASC", "9,5");
```
9) Get ids by filter. This sample retrieves the list of the manufacturers ids which name is "Metallica", "Nirvana" or "Pantera":
```csharp
Dictionary dtn = new Dictionary();
dtn.Add("name", "[Metallica|Nirvana|Pantera]");
List ids = ManufacturerFactory.GetIdsByFilter(dtn, null, null);
```
10) Get by filter by range date. This sample retrieves the orders in a date range:
```csharp
DateTime startDate = new DateTime (2016, 1, 1);
DateTime endDate = new DateTime (2016, 1, 31);
Dictionary filter = new Dictionary();
string dFrom = string.Format("{0:yyyy-MM-dd HH:mm:ss}", startDate);
string dTo = string.Format("{0:yyyy-MM-dd HH:mm:ss}", endDate);
filter.Add("date_add", "[" + dFrom + "," + dTo + "]");
List prestaSharpOrderIds = this.OrderFactory.GetIdsByFilter(filter, "id_DESC", null);
```
## Supported resources
- Address
- Carriers
- Carts
- Categories
- Combinations
- Currencies
- Customers
- Customer Messages
- Customer Threads
- Guests
- Groups
- Images
- Languages
- Manufacturers
- Messages
- Orders
- Order Carriers
- Order Cart Rules
- Order Histories
- Order Invoices
- Order States
- Products
- Product Features
- Product Feature Values
- Product Options
- Product Option Values
- Product Suppliers
- Shops
- Specific Prices
- Specific Price Rules
- States
- Stock Availables
- Tags
- Tax
- Tax Rule
- Tax Rule Groups
- Warehouse
- Zones
## Supported actions
- Create
- Read
- Update
- Delete
## Roadmap
- Add other resources
## Debugging
Enabling debugging in PrestaShop would make PrestaSharp exceptions more verbose, to enable that, edit ```/config/defines.inc.php``` file in your PrestaShop website and edit this code block:
```php
define('_PS_MODE_DEV_', false);
```
to:
```php
define('_PS_MODE_DEV_', true);
```
More information in the development section of [PrestaShop's documentation](http://doc.prestashop.com/display/PS15/Setting+up+your+local+development+environment).
## License
PrestaSharp is GNU General Public License (GPL)
This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantabilty or fitness for a particular purpose. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see .
Bukimedia reserves the right to mention of companies or individuals who use this software.
Copyright (C) 2019 Bukimedia
- Bukimedia: https://bukimedia.com/
- Twitter: http://twitter.com/bukimedia
- GitHub: https://github.com/bukimedia
- PrestaSharp on Bukimedia: https://bukimedia.com/prestasharp/