Integrations

PrestaShop

20 actions for PrestaShop.

Create Cart Rule in PrestaShop#

Creates a discount voucher in a PrestaShop store.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopCreateCartRule

Inputs#

FieldTypeRequiredDefaultWhat it does
NameTextYes(empty)Voucher name shown to the customer.
CodeTextYes(empty)Code the customer enters at checkout.
Percent OffNumberNo0Percentage off the order, for example 10.
Amount OffNumberNo0Fixed amount off the order, in the shop’s default currency.
Free ShippingYes/NoNoOffWhether the voucher gives free shipping.
Valid FromTextNo(empty)Start of validity, YYYY-MM-DD HH:MM:SS (default: now).
Valid ToTextNo(empty)End of validity, YYYY-MM-DD HH:MM:SS (default: 30 days from now).
QuantityNumberNo1How many times the voucher can be used in total (default: 1).
Quantity per CustomerNumberNo1How many times one customer can use it (default: 1).

Outputs#

OutputType
SuccessYes/No
Cart RuleObject

Use as an agent tool#

Tool name: prestashop_create_cart_rule

Create a PrestaShop discount voucher that customers redeem with a code at checkout. Give a percentage off, an amount off or free shipping.

Get Carriers from PrestaShop#

Gets the shipping carriers of a PrestaShop store.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopGetCarriers

Outputs#

OutputType
CarriersList
CountNumber

Use as an agent tool#

Tool name: prestashop_get_carriers

List the shipping carriers of a PrestaShop store with their delivery time, whether they are free and whether they are active. Use it to answer which shipping options the store offers.

Get Cart Rules from PrestaShop#

Gets the cart rules (discount vouchers) of a PrestaShop store, newest first.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopGetCartRules

Inputs#

FieldTypeRequiredDefaultWhat it does
LimitNumberNo20Number of cart rules to return (default: 20).
OffsetNumberNo0Number of cart rules to skip (default: 0).

Outputs#

OutputType
Cart RulesList
CountNumber

Use as an agent tool#

Tool name: prestashop_get_cart_rules

List a PrestaShop store’s cart rules, its discount vouchers, with code, discount, validity dates and remaining quantity. Voucher codes are the merchant’s; do not read them out to a customer unless the merchant asked for it.

Get Categories from PrestaShop#

Gets the product categories of a PrestaShop store, with an optional name search.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopGetCategories

Inputs#

FieldTypeRequiredDefaultWhat it does
Name ContainsTextNo(empty)Only return categories whose name contains this text.
LimitNumberNo50Number of categories to return (default: 50).
OffsetNumberNo0Number of categories to skip (default: 0).

Outputs#

OutputType
CategoriesList
CountNumber

Use as an agent tool#

Tool name: prestashop_get_categories

List the product categories of a PrestaShop store with their parent category and whether they are active. Pass a name to search.

Get Customer Orders from PrestaShop#

Gets the orders of one PrestaShop customer, newest first.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopGetCustomerOrders

Inputs#

FieldTypeRequiredDefaultWhat it does
Customer IDNumberYes0PrestaShop’s internal ID of the customer.
LimitNumberNo20Number of orders to return (default: 20).
OffsetNumberNo0Number of orders to skip (default: 0).

Outputs#

OutputType
OrdersList
CountNumber

Use as an agent tool#

Tool name: prestashop_get_customer_orders

List the orders of one PrestaShop customer by customer ID, newest first. This is the merchant’s own data and must not be used to answer a customer asking about their order: use prestashop_get_order or prestashop_get_order_tracking for that, which check the customer’s email.

Get Customers from PrestaShop#

Searches the customers of a PrestaShop store by email or last name.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopGetCustomers

Inputs#

FieldTypeRequiredDefaultWhat it does
EmailTextNo(empty)Only return the customer with this exact email.
Last Name ContainsTextNo(empty)Only return customers whose last name contains this text.
LimitNumberNo20Number of customers to return (default: 20).
OffsetNumberNo0Number of customers to skip (default: 0).

Outputs#

OutputType
CustomersList
CountNumber

Use as an agent tool#

Tool name: prestashop_get_customers

Search a PrestaShop store’s customers by exact email or by part of the last name. This is the merchant’s own data and must not be used to answer a customer asking about their order: use prestashop_get_order or prestashop_get_order_tracking for that, which check the customer’s email.

Get Manufacturers from PrestaShop#

Gets the manufacturers (brands) of a PrestaShop store, with an optional name search.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopGetManufacturers

Inputs#

FieldTypeRequiredDefaultWhat it does
Name ContainsTextNo(empty)Only return manufacturers whose name contains this text.
LimitNumberNo50Number of manufacturers to return (default: 50).
OffsetNumberNo0Number of manufacturers to skip (default: 0).

Outputs#

OutputType
ManufacturersList
CountNumber

Use as an agent tool#

Tool name: prestashop_get_manufacturers

List the manufacturers (brands) a PrestaShop store sells. Pass a name to search.

Get Order from PrestaShop#

Gets a single order from a PrestaShop store by order reference, returning it only when it belongs to the given customer email.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopGetOrder

Inputs#

FieldTypeRequiredDefaultWhat it does
Customer EmailTextYes(empty)Email address the order was placed under. Ask the customer for it; the order is only returned when it belongs to this email.
Order ReferenceTextYes(empty)Customer-facing order reference as it appears on the confirmation email or invoice (e.g. “XKBKNABJK”).

Outputs#

OutputType
FoundYes/No
ReferenceText
Customer EmailText
Order IdNumber
Order DataObject

Use as an agent tool#

Tool name: prestashop_get_order

Get the status and details of one PrestaShop order. Requires BOTH the customer’s email address and the order reference; ask the customer for whichever one is missing instead of guessing. Returns the order only when that reference belongs to that email.

Get Order by ID from PrestaShop#

Gets one order from a PrestaShop store by its internal ID, with its product rows.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopGetOrderById

Inputs#

FieldTypeRequiredDefaultWhat it does
Order IDNumberYes0PrestaShop’s internal ID of the order.

Outputs#

OutputType
FoundYes/No
OrderObject

Use as an agent tool#

Tool name: prestashop_get_order_by_id

Get one PrestaShop order by its internal ID, with totals, payment method, state and the ordered products. This is the merchant’s own data and must not be used to answer a customer asking about their order: use prestashop_get_order or prestashop_get_order_tracking for that, which check the customer’s email.

Get Order States from PrestaShop#

Gets the order states a PrestaShop store uses, such as Shipped or Delivered.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopGetOrderStates

Outputs#

OutputType
Order StatesList
CountNumber

Use as an agent tool#

Tool name: prestashop_get_order_states

List the order states of a PrestaShop store (for example Payment accepted, Shipped, Delivered) with their IDs. Use it to read an order’s current_state or to pick a state for prestashop_update_order_status.

Get Order Tracking from PrestaShop#

Gets the shipping and status history of a PrestaShop order, only when it belongs to the given customer email.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopGetOrderTracking

Inputs#

FieldTypeRequiredDefaultWhat it does
Customer EmailTextYes(empty)Email address the order was placed under. Ask the customer for it; the tracking is only returned when the order belongs to this email.
Order ReferenceTextYes(empty)Customer-facing order reference as it appears on the confirmation email or invoice (e.g. “XKBKNABJK”).

Outputs#

OutputType
FoundYes/No
ReferenceText
Customer EmailText
TrackingObject

Use as an agent tool#

Tool name: prestashop_get_order_tracking

Answer where a customer’s PrestaShop order is: current status, carrier, tracking number and link, and the status history. Requires BOTH the customer’s email address and the order reference; ask the customer for whichever one is missing instead of guessing. Returns nothing unless that reference belongs to that email.

Get Orders from PrestaShop#

Gets orders from a PrestaShop store, newest first, with pagination.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopGetOrders

Inputs#

FieldTypeRequiredDefaultWhat it does
Order StateTextNo(empty)PrestaShop order state ID to restrict the list to.
Date FromTextNo(empty)Only return orders placed on or after this date (YYYY-MM-DD).
Date ToTextNo(empty)Only return orders placed on or before this date (YYYY-MM-DD).
LimitNumberNo20Number of orders to return (default: 20).
OffsetNumberNo0Number of orders to skip (default: 0).

Outputs#

OutputType
OrdersList
CountNumber

Use as an agent tool#

Tool name: prestashop_get_orders

List a PrestaShop store’s recent orders, newest first. This returns the merchant’s own orders and must not be used to answer a customer asking about their order: use prestashop_get_order for that, which checks the order belongs to the customer’s email.

Get Product from PrestaShop#

Gets one product from a PrestaShop store by its ID, with description, price and images.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopGetProduct

Inputs#

FieldTypeRequiredDefaultWhat it does
Product IDNumberYes0PrestaShop’s internal ID of the product.

Outputs#

OutputType
FoundYes/No
ProductObject

Use as an agent tool#

Tool name: prestashop_get_product

Get the full details of one PrestaShop product by its ID: name, description, price (tax excluded), reference, category, images and combination IDs.

Get Product Combinations from PrestaShop#

Gets the combinations (variants such as size or colour) of a PrestaShop product.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopGetProductCombinations

Inputs#

FieldTypeRequiredDefaultWhat it does
Product IDNumberYes0PrestaShop’s internal ID of the product.
LimitNumberNo50Number of combinations to return (default: 50).
OffsetNumberNo0Number of combinations to skip (default: 0).

Outputs#

OutputType
CombinationsList
CountNumber

Use as an agent tool#

Tool name: prestashop_get_product_combinations

List the combinations of a PrestaShop product, PrestaShop’s name for variants such as size or colour, with each one’s reference, price impact and option value IDs.

Get Product Stock from PrestaShop#

Gets the available stock of a PrestaShop product, per combination.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopGetProductStock

Inputs#

FieldTypeRequiredDefaultWhat it does
Product IDNumberYes0PrestaShop’s internal ID of the product.

Outputs#

OutputType
StockList
CountNumber

Use as an agent tool#

Tool name: prestashop_get_product_stock

Get how many units of a PrestaShop product are in stock. Returns one row per combination; the row with id_product_attribute 0 is the product’s total.

Get Products from PrestaShop#

Gets products from a PrestaShop store with pagination and a name search.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopGetProducts

Inputs#

FieldTypeRequiredDefaultWhat it does
Name ContainsTextNo(empty)Only return products whose name contains this text.
LimitNumberNo20Number of products to return (default: 20).
OffsetNumberNo0Number of products to skip (default: 0).

Outputs#

OutputType
ProductsList
CountNumber

Use as an agent tool#

Tool name: prestashop_get_products

Get products from a PrestaShop store. Pass a name to search the catalogue for products whose name contains it.

Set Order Tracking Number in PrestaShop#

Sets the tracking number on a PrestaShop order’s shipment.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopSetOrderTrackingNumber

Inputs#

FieldTypeRequiredDefaultWhat it does
Order IDNumberYes0PrestaShop’s internal ID of the order.
Tracking NumberTextYes(empty)The carrier’s tracking number for the parcel.

Outputs#

OutputType
SuccessYes/No
Order CarrierObject

Use as an agent tool#

Tool name: prestashop_set_order_tracking_number

Set the parcel tracking number on a PrestaShop order’s shipment, so the customer can follow it.

Update Order Status in PrestaShop#

Moves a PrestaShop order to another order state.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopUpdateOrderStatus

Inputs#

FieldTypeRequiredDefaultWhat it does
Order IDNumberYes0PrestaShop’s internal ID of the order.
Order State IDNumberYes0ID of the order state to move the order to.

Outputs#

OutputType
SuccessYes/No
Order HistoryObject

Use as an agent tool#

Tool name: prestashop_update_order_status

Move a PrestaShop order to another state, for example Shipped or Canceled. Get the state ID from prestashop_get_order_states first.

Update Product Price in PrestaShop#

Sets the base price of a PrestaShop product.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopUpdateProductPrice

Inputs#

FieldTypeRequiredDefaultWhat it does
Product IDNumberYes0PrestaShop’s internal ID of the product.
PriceNumberYes0New base price, tax excluded.

Outputs#

OutputType
SuccessYes/No
ProductObject

Use as an agent tool#

Tool name: prestashop_update_product_price

Set the base price of a PrestaShop product. PrestaShop stores it tax excluded, so pass the price before tax.

Update Stock in PrestaShop#

Sets the available quantity of a PrestaShop product or one of its combinations.

Plans: Trial, Pro, Premium, Enterprise · Type: PrestashopUpdateStock

Inputs#

FieldTypeRequiredDefaultWhat it does
Product IDNumberYes0PrestaShop’s internal ID of the product.
QuantityNumberNo0The new available quantity.
Combination IDNumberNo0Combination to update; 0 for a product without combinations.

Outputs#

OutputType
SuccessYes/No
Stock AvailableObject

Use as an agent tool#

Tool name: prestashop_update_stock

Set how many units of a PrestaShop product, or of one of its combinations, are in stock. The quantity replaces the current one rather than adding to it.