Table of Contents
| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…).. |
This is the latest version of the Prestashop app. See the documentation to replace your existing modules.
![[Caution]](https://docs.boost.space/wp-content/uploads/2022/11/caution.png) |
Caution |
|---|---|
| Prestashop version 1.7.7.x or above will crash if you use PHP 7.2. This will result in errors in our application. Roll back to PHP 7.1 or 7.0 until the problem is resolved by the Prestashop team. |
The Prestashop modules allow you to monitor, create, update, list, retrieve, and delete the customers, orders, products, manufacturers, addresses, carts, images, and languages from the Prestashop account.
- A Prestashop account – create an account at PrestaShop
Connecting the PrestaShop service to Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes.
To connect your Prestashop account to Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. you need to obtain the Webservice Key from your Prestashop account and insert it in the Create a connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). dialog in the Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes.module.
- Log in to your Prestashop account.
- From the left menu, click on clog symbol > Webservices.
- In the Configuration section, ensure that Webservice is enabled for your account.
- Click Add new webservice key. Click Generate to create a new key, enter the details, and assign permissions. Click Save.
Key
Click Generate to create the key.
Key Description
Enter the details of the key.
Status
Select the status of the key. To make it active, click YES.
Permissions
Select the permissions for the key. - Copy the API Key to your clipboard.
- Go to Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. and open the Prestashop module’s Create a connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). dialog.
- In the ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). name field, enter a name for the connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…)..
- In the Host URL field, enter your Prestashop account’s host URL address.
- In the Webservice Key field, enter the key details copied in step 5, and click Continue.
The connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). has been established.
TriggersEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... when a customer is created or updated.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Watch for |
Select or map the option to watch the customers:
|
Limit |
Set the maximum number of customers Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Retrieves a list of customers and filters by criteria.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Search Criteria |
Select or map the search criteria and their value to filter the customers that match the specified criteria. |
Sort By |
Add the options to sort the customers:
Select or map the field by which you want to sort the customers. For example,
Select or map the order in which you want to sort the customers. For example, |
Fields to be displayed |
Select or map the fields whose details you want to list in the output. |
Limit |
Set the maximum number of customers Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Retrieves a list of customer groups and filters by criteria.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Search Criteria |
Select or map the search criteria and their value to filter the customer groups that match the specified criteria. |
Sort By |
Add the options to sort the customer groups:
Select or map the field by which you want to sort the customers. For example,
Select or map the order in which you want to sort the customer groups. For example, |
Fields to be displayed |
Select or map the fields whose details you want to list in the output. |
Limit |
Set the maximum number of customer groups Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Creates a new customer.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
First Name |
Enter (map) the first name of the customer. |
Last Name |
Enter (map) the last name of the customer. |
| Enter (map) the email address of the customer. | |
Password |
Enter (map) a password for the customer account. Enter a valid password between 5 and 72 characters long. It must match pattern, /^[.a-zA-Z_0-9-!@#$%^&*()]{5,72}$/. |
Group IDs |
Select or map the Group IDs to which you want to add the customer. |
Default Group ID |
Select or map the default Group ID for the customer. For example, visitor. |
Social Title |
Select or map the customer title. For example, Mr. or Mrs. |
Birthday |
Enter (map) the customer’s date of birth. See the list of supported date and time formats. |
Company |
Enter (map) the customer’s company name. |
Website |
Enter (map) the customer’s website URL address. |
Active |
Select the checkbox if the customer status is active. |
Newsletter |
Select the checkbox if the customer has opted for newsletters. |
Opt In |
Select the checkbox whether the customer opted in for marketing communication. |
Is Guest |
Select whether the customer is a guest. |
Language ID |
Select or map the applicable Language ID for the customer. For example, English. |
SIRET |
Enter (map) the SIRET number of the customer location. |
APE |
Enter (map) the customer’s business APE number. |
Outstanding Allow Amount |
Enter (map) the outstanding amount allowed for the user in the store with your store specified currency. |
Show Public Prices |
Select whether you want to show the public prices of the store. |
Max Payment Days |
Enter (map) the maximum payments days allowed. |
Note |
Enter (map) any additional information applicable to the customer. |
Shop ID |
Select or map the customer’s Shop ID. |
Shop Group ID |
Select or map the customer’s Shop Group ID. |
Retrieves the details of a customer by its ID.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Customer ID |
Enter (map) the Customer ID whose details you want to retreive. |
Updates an existing customer by its ID.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Customer ID |
Enter (map) the Customer ID whose details you want to update. |
First Name |
Enter (map) the first name of the customer. |
Last Name |
Enter (map) the last name of the customer. |
| Enter (map) the email address of the customer. | |
Password |
Enter (map) a password for the customer account. Enter a valid password between 5 and 72 characters long. It must match pattern /^[.a-zA-Z_0-9-!@#$%^&*()]{5,72}$/. |
Group IDs |
Select or map the Group IDs to which you want to add the customer. |
Default Group ID |
Select or map the default Group ID for the customer. For example, visitor. |
Social Title |
Select or map the customer title. For example, Mr. or Mrs. |
Birthday |
Enter (map) the customer’s date of birth. See the list of supported date and time formats. |
Company |
Enter (map) the customer’s company name. |
Website |
Enter (map) the customer’s website URL address. |
Active |
Select the checkbox if the customer status is active. |
Newsletter |
Select the checkbox if the customer has opted for newsletters. |
Opt In |
Select the checkbox whether the customer opted in for marketing communication. |
Is Guest |
Select whether the customer is a guest. |
Language ID |
Select or map the applicable Language ID for the customer. For example, English. |
SIRET |
Enter (map) the SIRET number of the customer location. |
APE |
Enter (map) the customer’s business APE number. |
Outstanding Allow Amount |
Enter (map) the outstanding amount allowed for the user in the store with your store specified currency. |
Show Public Prices |
Select whether you want to show the public prices of the store. |
Max Payment Days |
Enter (map) the maximum payments days allowed. |
Note |
Enter (map) any additional information applicable to the customer. |
Shop ID |
Select or map the customer’s Shop ID. |
Shop Group ID |
Select or map the customer’s Shop Group ID. |
TriggersEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... when an order is created or updated.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Watch for |
Select or map the option to watch the orders:
|
Order State |
Select or map the status of the order you want to watch. For example, Shipped. |
Limit |
Set the maximum number of orders Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Retrieves a list of rows of an order by the order ID.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Search Criteria |
Select or map the search criteria and their value to filter the orders that match the specified criteria. |
Sort By |
Add the options to sort the orders:
Select or map the field by which you want to sort the orders. For example,
Select or map the order in which you want to sort the orders. For example, |
Fields to be displayed |
Select or map the fields whose details you want to list in the output. For example, Customer ID. |
Limit |
Set the maximum number of orders Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Retrieves the details of an order by its ID.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Order ID |
Enter (map) the Order ID whose row details you want to list. |
Creates a new order.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. | ||||||||||
Address Delivery ID |
Enter (map) the Address Delivery ID of the order. | ||||||||||
Address Invoice ID |
Enter (map) the Address Invoice ID of the order. | ||||||||||
Cart ID |
Enter (map) the Cart ID of the order. | ||||||||||
Currency ID |
Enter (map) the Currency ID applicable for the order. | ||||||||||
Language ID |
Select or map the Language ID applicable for the order. | ||||||||||
Customer ID |
Enter (map) the Customer ID applicable for the order. | ||||||||||
Carrier ID |
Enter (map) the Carrier ID in which the order will be sent. | ||||||||||
Module |
Enter (map) the module to which the order belongs. For example, Administration. |
||||||||||
Payment |
Enter (map) the payment amount applicable for the order. | ||||||||||
Total Paid |
Enter (map) the total amount paid for the order. | ||||||||||
Total Paid Real |
Enter (map) the total amount paid real. | ||||||||||
Total Products |
Enter (map) the total number of products in the order. | ||||||||||
Total Product Wt. |
Enter (map) the weight of the total products | ||||||||||
Conversion Rate |
Enter (map) the currency conversion rate applicable on the order. | ||||||||||
Current State |
Select or map the order status. For example, shipped. |
||||||||||
Invoice Number |
Enter (map) the order invoice number. | ||||||||||
Invoice Date |
Enter (map) the order invoice date. See the list of supported date and time formats. | ||||||||||
Delivery Number |
Enter (map) the order delivery number. | ||||||||||
Delivery Date |
Enter (map) the expected delivery date of the order. See the list of supported date and time formats. | ||||||||||
Valid |
Enter (map) the date until which the order is valid. See the list of supported date and time formats. | ||||||||||
Date Add |
Enter (map) the date on which the order is added. See the list of supported date and time formats. | ||||||||||
Date Update |
Enter (map) the date on which the order is updated. See the list of supported date and time formats. | ||||||||||
Shipping Number |
Enter (map) the order shipping number. Enter a valid tracking number and it must match the pattern, /^[~:#,%&_=()[].? +-@/a-zA-Z0-9]+$/. |
||||||||||
Shop Group ID |
Select or map the Shop Group ID of the order. | ||||||||||
Shop ID |
Select or map Shop ID applicable to the order. | ||||||||||
Secure Key |
Enter (map) the order secure key. Enter a valid MD5 string: 32 characters, mixing lowercase, uppercase, and numerals. The pattern must match with the /^[a-f0-9A-F]{32}$/. | ||||||||||
Recyclable |
Select whether the items in the order are recyclable. | ||||||||||
Gift |
Select whether the order is a gift. | ||||||||||
Gift Message |
Enter (map) the gift message. | ||||||||||
Mobile Theme |
Select whether the order has a mobile theme. | ||||||||||
Total Discounts |
Enter (map) the total discount applied to the order. | ||||||||||
Total Discounts Tax Inclusive |
Enter (map) the total discount inclusive of the tax. | ||||||||||
Total Discounts Tax Exclusive |
Enter (map) the total discount excluding the tax amount. | ||||||||||
Total Paid Tax Inclusive |
Enter (map) the total amount paid for the order including the tax. | ||||||||||
Total Paid Tax Exclusive |
Enter (map) the total amount paid for the order excluding the tax. | ||||||||||
Total Shipping |
Enter (map) the total shipping charges for the order. | ||||||||||
Total Shipping Tax Inclusive |
Enter (map) the total shipping charges including the tax. | ||||||||||
Total Shipping Tax Exclusive |
Enter (map) the total shipping charges excluding the tax. | ||||||||||
Carrier Tax Rate |
Enter (map) the order carrier tax price. | ||||||||||
Total Wrapping |
Enter (map) the total wrapping charges for the order. | ||||||||||
Total Wrapping Tax Inclusive |
Enter (map) the total wrapping charges for the order including tax. | ||||||||||
Total Wrapping Tax Exclusive |
Enter (map) the total wrapping charges for the order excluding tax. | ||||||||||
Round Mode |
Enter (map) the round mode details of the order. | ||||||||||
Round Type |
Enter (map) the round type. | ||||||||||
Reference |
Enter (map) the order reference number. | ||||||||||
Orde Row |
Add the rows:
|
Retrieves the details of an order by its ID.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Order ID |
Enter (map) the Order ID whose details you want to retreive. |
Updates an existing order by its ID.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. | ||||||||||
Order ID |
Enter (map) the Order ID whose details you want to update. | ||||||||||
Address Delivery ID |
Enter (map) the Address Delivery ID of the order. | ||||||||||
Address Invoice ID |
Enter (map) the Address Invoice ID of the order. | ||||||||||
Cart ID |
Enter (map) the Cart ID of the order. | ||||||||||
Currency ID |
Enter (map) the Currency ID applicable for the order. | ||||||||||
Language ID |
Select or map the Language ID applicable for the order. | ||||||||||
Customer ID |
Enter (map) the Customer ID applicable for the order. | ||||||||||
Carrier ID |
Enter (map) the Carrier ID in which the order will be sent. | ||||||||||
Module |
Enter (map) the module to which the order belongs. For example, Administration. |
||||||||||
Payment |
Enter (map) the payment amount applicable for the order. | ||||||||||
Total Paid |
Enter (map) the total amount paid for the order. | ||||||||||
Total Paid Real |
Enter (map) the total amount paid real. | ||||||||||
Total Products |
Enter (map) the total number of products in the order. | ||||||||||
Total Product Wt. |
Enter (map) the weight of the total products | ||||||||||
Conversion Rate |
Enter (map) the currency conversion rate applicable on the order. | ||||||||||
Current State |
Select or map the order status. For example, shipped. |
||||||||||
Invoice Number |
Enter (map) the order invoice number. | ||||||||||
Invoice Date |
Enter (map) the order invoice date. See the list of supported date and time formats. | ||||||||||
Delivery Number |
Enter (map) the order delivery number. | ||||||||||
Delivery Date |
Enter (map) the expected delivery date of the order. See the list of supported date and time formats. | ||||||||||
Valid |
Enter (map) the date until which the order is valid. See the list of supported date and time formats. | ||||||||||
Date Add |
Enter (map) the date on which the order is added. See the list of supported date and time formats. | ||||||||||
Date Update |
Enter (map) the date on which the order is updated. See the list of supported date and time formats. | ||||||||||
Shipping Number |
Enter (map) the order shipping number. Enter a valid tracking number and it must match the pattern, /^[~:#,%&_=()[].? +-@/a-zA-Z0-9]+$/. |
||||||||||
Shop Group ID |
Select or map the Shop Group ID of the order. | ||||||||||
Shop ID |
Select or map Shop ID applicable to the order. | ||||||||||
Secure Key |
Enter (map) the order secure key. Enter a valid MD5 string: 32 characters, mixing lowercase, uppercase, and numerals. The pattern must match with the /^[a-f0-9A-F]{32}$/. | ||||||||||
Recyclable |
Select whether the items in the order are recyclable. | ||||||||||
Gift |
Select whether the order is a gift. | ||||||||||
Gift Message |
Enter (map) the gift message. | ||||||||||
Mobile Theme |
Select whether the order has a mobile theme. | ||||||||||
Total Discounts |
Enter (map) the total discount applied to the order. | ||||||||||
Total Discounts Tax Inclusive |
Enter (map) the total discount inclusive of the tax. | ||||||||||
Total Discounts Tax Exclusive |
Enter (map) the total discount excluding the tax amount. | ||||||||||
Total Paid Tax Inclusive |
Enter (map) the total amount paid for the order including the tax. | ||||||||||
Total Paid Tax Exclusive |
Enter (map) the total amount paid for the older excluding the tax. | ||||||||||
Total Shipping |
Enter (map) the total shipping charges for the order. | ||||||||||
Total Shipping Tax Inclusive |
Enter (map) the total shipping charges including the tax. | ||||||||||
Total Shipping Tax Exclusive |
Enter (map) the total shipping charges excluding the tax. | ||||||||||
Carrier Tax Rate |
Enter (map) the order carrier tax price. | ||||||||||
Total Wrapping |
Enter (map) the total wrapping charges for the order. | ||||||||||
Total Wrapping Tax Inclusive |
Enter (map) the total wrapping charges for the order including tax. | ||||||||||
Total Wrapping Tax Exclusive |
Enter (map) the total wrapping charges for the order excluding tax. | ||||||||||
Round Mode |
Enter (map) the round mode details of the order. | ||||||||||
Round Type |
Enter (map) the round type. | ||||||||||
Reference |
Enter (map) the order reference number. | ||||||||||
Orde Row |
Add the rows:
|
TriggersEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... when a product is created or updated.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Watch for |
Select or map the option to watch the orders:
|
Limit |
Set the maximum number of products Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Retrieves a list of products and filters by criteria.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Search Criteria |
Select or map the search criteria and their value to filter the products that match the specified criteria. |
Sort By |
Add the options to sort the products:
Select or map the field by which you want to sort the products. For example,
Select or map the order in which you want to sort the products. For example, |
Fields to be displayed |
Select or map the fields whose details you want to list in the output. For example, Default Image ID. |
Limit |
Set the maximum number of products Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Creates a new product.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Price |
Enter (map) the product’s price. |
Name |
Add the product name:
Select or map the Language ID in which you want to mention the product name.
Enter (map) the product name. |
Link Rewrite |
Add the product URL link:
Select or map the Language ID in which you want to mention the product link address.
Enter (map) the product URL link address in the specified language. |
Summary |
Add the product summary:
Select or map the Language ID in which you want to mention the product summary.
Enter (map) the product summary in the specified language. |
Description |
Add the product details:
Select or map the Language ID in which you want to mention the product details.
Enter (map) the product details in the specified language. |
Manufacturer ID |
Select or map the product Manufacturer ID. |
Reference |
Enter (map) the product reference number. Must match pattern /^[^<>;={}]*$/. |
Tax Rules Group ID |
Select or map the Tax Rules Group ID of the product. |
Category Default ID |
Select or map the product category default ID. |
Default Image ID |
Enter (map) the default product Image ID. |
Default Combination ID |
Enter (map) the default Combination ID. |
Minimal Quantity |
Enter (map) the minimum number of products that should be ordered. |
Location |
Enter (map) the product reference details. Must match pattern /^[^<>;={}]*$/. |
Low Stock Threshold |
Enter (map) the product items in stock below which the system would send the low stock alert. |
Low Stock Alert |
Select whether you want to keep an alert when the product stock is low. |
Available Now |
Add the product meta title:
Select or map the Language ID in which you want to mention the product meta title.
Enter (map) the details about the product availability in the specified language. |
Available Later |
Add the product meta title:
Select or map the Language ID in which you want to mention the product meta title.
Enter (map) the details about the product availability in the specified language. |
Available Date |
Enter (map) the date when the product is available for sale. See the list of supported date and time formats. |
Width |
Enter (map) the product width measurement. |
Height |
Enter (map) the product height measurement. |
Depth |
Enter (map) the product depth measurement. |
Weight |
Enter (map) the product weight measurement. |
Additional Delivery Times |
Select or map the product delivery times. For example, default delivery time. |
Additional Shipping Cost |
Enter (map) the product shipping charges. |
Unit Price Ratio |
Enter (map) the product unit price ratio details.z |
Unity |
Enter (map) the product unit details. |
On Sale |
Select whether the product is on sale. |
Wholesale Price |
Enter (map) the product wholesale price. |
Meta Title |
Add the product meta title:
Select or map the Language ID in which you want to mention the product meta title.
Enter (map) the product meta details in the specified language. |
Meta Description |
Add the product meta details:
Select or map the Language ID in which you want to mention the product meta details.
Enter (map) the product meta details in the specified language. |
Meta Keywords |
Add the product meta keywords:
Select or map the Language ID in which you want to mention the product meta keywords.
Enter (map) the product meta keywords in the specified language. |
Redirect Type |
Select or map the option to redirect the users when they look for the product. For example, Permanent redirection to a category. |
Visibility |
Select or map the product visibility. For example, the catalog only. |
Available for Order |
Select whether the product is available for ordering. |
Show Price |
Select whether you want to show the product price. |
Online Only |
Select whether the product is available online only. |
Condition |
Select or map the product’s condition. For example, new, refurbished. |
Show Condition |
Select whether you want to display the product condition. |
ISBN |
Enter (map) the product’s ISBN number. The number must be lower than or equal to 13 characters. |
EAN13 |
Enter (map) the product’s EAN 13 number. The number must be lower than or equal to 13 characters. |
UPC |
Enter (map) the product’s UPC number. The number must be lower than or equal to 12 characters. |
MPN |
Enter (map) the product’s MPN number. The number must be 40 characters long. |
Supplier ID |
Enter (map) the product Supplier ID. |
Supplier Reference |
Enter (map) the product supplier reference number. Enter a valid product reference must match the pattern /^[^<>;={}]*$/. |
Shop Default |
Select or map the Shop Default ID applicable to the product. |
Product Features |
Add the product features:
Select or map the product feature ID.
Select or map the feature value. |
Combination |
Add the product combination ID. |
Category |
Add the product categories. For example, clothes. |
Images |
Add the product Images ID. |
Tags |
Add the applicable tags for the product. For example, cups. |
Updates an existing product by its ID.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Product ID |
Select or map the Product ID whose details you want to update. |
See the Create a Product module for the field descriptions.
Updates an existing product by its ID.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
ID |
Select or map the Product ID whose details you want to retrieve. |
Retrieves the stock quantity of a product by the product ID.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Stock Available ID |
Select or map the Product Stock Available ID whose details you want to retrieve |
Updates stock quantity of a product by the product ID.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Stock Available ID |
Select or map the Product Stock Available ID whose details you want to update. |
Product ID |
Enter (map) a new Product ID. |
Product Attribute ID |
Enter (map) the Product Attribute ID. |
Quantity |
Enter (map) the number of product items. |
Depends On Stock |
Select the quantity depends on the stock. |
Out of Stock |
Select whether the product is out of stock. |
Shop ID |
Select or map the Shop ID applicable for the product. |
Shop Group ID |
Select or map the Shop Group ID applicable for the product. |
Location |
Enter (map) the product location details. |
TriggersEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... when a manufacturer is created or updated.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Watch for |
Select or map the option to watch the manufacturers:
|
Limit |
Set the maximum number of manufacturers Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Retrieves a list of manufacturers and filters by criteria.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Search Criteria |
Select or map the search criteria and their value to filter the manufacturers that match the specified criteria. |
Sort By |
Add the options to sort the manufacturers:
Select or map the field by which you want to sort the manufacturers. For example,
Select or map the order in which you want to sort the manufacturers. For example, |
Fields to be displayed |
Select or map the fields whose details you want to list in the output. For example, Active. |
Limit |
Set the maximum number of manufacturers Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Retrieves the details of a manufacturer by its ID.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Manufacturer ID |
Enter (map) the manufacturer ID whose details you want to retreive. |
Retrieves a list of addresses and filters by criteria.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Search Criteria |
Select or map the search criteria and their value to filter the addresses that match the specified criteria. |
Sort By |
Add the options to sort the addresses:
Select or map the field by which you want to sort the addresses. For example,
Select or map the order in which you want to sort the addresses. For example, |
Fields to be displayed |
Select or map the fields whose details you want to list in the output. For example, Phone. |
Limit |
Set the maximum number of addresses Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default). |
Retrieves the details of an address by its ID.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
ID |
Enter (map) the Address ID whose details you want to retreive. |
TriggersEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... when a cart is created or updated.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Watch for |
Select or map the option to watch the carts:
|
Limit |
Set the maximum number of carts Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Retrieves a list of customer carts and filters by criteria.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Search Criteria |
Select or map the search criteria and their value to filter the carts that match the specified criteria. |
Sort By |
Add the options to sort the carts:FieldSelect or map the field by which you want to sort the carts. For example, Name.OrderSelect or map the order in which you want to sort the carts. For example, Ascending. |
Fields to be displayed |
Select or map the fields whose details you want to list in the output. For example, Active. |
Limit |
Set the maximum number of carts Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default). |
Creates a new cart.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. | ||||||||||
Currency ID |
Enter (map) the Currency ID applicable for the cart. | ||||||||||
Language ID |
Select or map the Language ID applicable for the cart. | ||||||||||
Cart Rows |
Add the rows:
|
||||||||||
Customer ID |
Enter (map) the Customer ID applicable for the cart. | ||||||||||
Address Delivery ID |
Enter (map) the Address Delivery ID of the cart. | ||||||||||
Address Invoice ID |
Enter (map) the Address Invoice ID of the cart. | ||||||||||
Carrier ID |
Enter (map) the applicable Carrier ID for the items in the cart. | ||||||||||
Delivery Option |
Enter (map) the delivery option for the items in the cart. | ||||||||||
Gift |
Select whether the items in the cart are for a gift. | ||||||||||
Gift Message |
Enter (map) the gift message. | ||||||||||
Recyclable |
Select whether the items in the cart are recyclable. | ||||||||||
Mobile Theme |
Select whether the cart has a mobile theme. | ||||||||||
Allow Separated Package |
Select whether the cart allows the separate package. | ||||||||||
Guest ID |
Select or map the Guest ID for the cart. | ||||||||||
Shop ID |
Select or map Shop ID applicable to the cart. | ||||||||||
Shop Group ID |
Select or map the Shop Group ID of the cart. |
Retrieves the details of a customer cart by its ID.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
ID |
Enter (map) the Cart ID whose row details you want to list. |
Updates an existing cart by its ID.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. | ||||||||||
Cart ID |
Select or map the Cart ID whose details you want to update. | ||||||||||
Currency ID |
Enter (map) the Currency ID applicable for the cart. | ||||||||||
Language ID |
Select or map the Language ID applicable for the cart. | ||||||||||
Cart Rows |
Add the rows:
|
||||||||||
Customer ID |
Enter (map) the Customer ID applicable for the cart. | ||||||||||
Address Delivery ID |
Enter (map) the Address Delivery ID of the cart. | ||||||||||
Address Invoice ID |
Enter (map) the Address Invoice ID of the cart. | ||||||||||
Carrier ID |
Enter (map) the applicable Carrier ID for the items in the cart. | ||||||||||
Delivery Option |
Enter (map) the delivery option for the items in the cart. | ||||||||||
Gift |
Select whether the items in the cart are for a gift. | ||||||||||
Gift Message |
Enter (map) the gift message. | ||||||||||
Recyclable |
Select whether the items in the cart are recyclable. | ||||||||||
Mobile Theme |
Select whether the cart has a mobile theme. | ||||||||||
Allow Separated Package |
Select whether the cart allows the separate package. | ||||||||||
Guest ID |
Select or map the Guest ID for the order. | ||||||||||
Shop ID |
Select or map Shop ID applicable to the cart. | ||||||||||
Shop Group ID |
Select or map the Shop Group ID of the cart. |
Retrieves a list of images of a specific entity.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Entity Type |
Select or map the entity type and its related ID whose images you want to list. |
Limit |
Set the maximum number of images Boost.space IntegratorPart of the Boost.space system, where you can create your connections and automate your processes.t should return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Retrieves the details of a specified language by its ID.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
Language ID |
Select or map the Language ID whose details you want to retrieve. |
Performs an arbitrary authorized API call.
ConnectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). |
Establish a connection to your Prestashop account. |
URL |
Enter a relative path URL for the API. For example: /api/addresses
For the list of available endpoints, refer to the Prestashop API Documentation. |
Method |
Select the HTTP method you want to use:
to retrieve information for an entry.
to create a new entry.
to update/replace an existing entry.
to make a partial entry update.
to delete an entry. |
Headers |
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
Query String |
Enter the request query string. |
Body |
Enter the body content for your API call. |
The following API call returns all the carts from your Prestashop account:
URL:
/api/carts
Method:
GET
Matches of the search can be found in the module’s Output under BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. > Body > carts.
In our example, 15 carts were returned:
Removed the following modules:
- Get product images
- Iterate order rows
- Update Order Status
Added the following new modules:
- Create a Cart
- Create a Customer
- Create an Order
- Create a Product
- Get a Cart
- Get a Language
- Get an Order
- Get a Product’s Stock
- List Addresses
- List an Order’s Cart Rules
- List Carts
- List Customer Groups
- List Customers
- List Images
- List Manufacturers
- List Order Rows
- List Orders
- Make an API Call
- Update a Cart
- Update a Customer
- Update an Order
- Update a Product
- Update a Product’s Stock
- Watch Carts TriggerEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the...