PrestaShop

PrestaShop

PrestaShop is an open-source e-commerce platform. The webservice exposes the same data the back-office reads and writes: products, categories, manufacturers, suppliers, customers, addresses, orders, stock, pricing, taxes, shipping and CMS pages.

Resource Map

• Catalogue master data — products, combinations (variants), stock_availables, specific_prices.
• Taxonomy — categories, manufacturers, suppliers, product_features, product_options, tags.
• Sales — orders (with inline order_rows line items), order_histories (status changes), order_invoices, order_payments, order_carriers, order_slip (refunds), order_states.
• People — customers, addresses, customer_threads + customer_messages (support tickets), groups, carts, guests.
• Storefront — cms_pages, contacts, messages, languages, currencies, image_types.
• Geography — countries, states, zones; deliveries / price_ranges / weight_ranges drive shipping cost.
• Tax — taxes, tax_rules, tax_rule_groups (assigned to products via id_tax_rules_group).
• Multi-shop — shops, shop_groups, shop_urls; shop-scoped resources accept id_shop.
• Discounts — cart_rules (coupons), specific_price_rules (bulk price overrides), specific_prices (per-row overrides).

Operating Order

1. Use get_<resource>(schema='blank') to inspect the write shape before any upsert.
2. Use get_languages and get_shops to resolve language / shop ids; pass them as language / id_shop on translatable / shop-scoped resources.
3. To change order status, append a row to order_histories via change_order_status — never PUT orders.current_state directly (state-change emails and inventory hooks only fire through that path).
4. To update inventory, find the stock_availables row via get_stock_levels(filter={"id_product": ...}) and call upsert_stock_level. The row already exists — PrestaShop creates one per (id_product, id_product_attribute, id_shop) when products are created.
5. To stop a coupon early, delete_cart_rule. To stop a promotion early, delete_specific_price. To soft-disable, upsert with active=0 instead.

Filter Mini-Language

PrestaShop's filter syntax (passed verbatim through the filter map):

• Literal: filter[id_customer]=42 — exact match.
• Wildcard LIKE: filter[reference]=%FU_% — non-translatable columns only.
• OR: filter[id]=[1|2|3].
• Range: filter[id]=[1,100].
• Date range: filter[date_upd]=[2026-01-01 00:00:00,2026-12-31 23:59:59] — must also pass date_filter=true, otherwise the filter is silently ignored.

Filtering on translatable fields (e.g. products.name, categories.name) is not supported. Filter on reference, id_category_default, id_manufacturer, or date_upd instead.

Sorting

Sort syntax is <field>_ASC or <field>_DESC, e.g. sort=id_DESC, sort=date_add_DESC. Date-column sorts (date_add, date_upd) require date_filter=true to be passed alongside the sort — without it the request times out on large tables. To get the most recent order or product reliably, prefer sort=id_DESC (id is monotonic in PrestaShop) unless you specifically need date-based ordering.

Counts and Pagination

The PrestaShop webservice does not return a total-count header anywhere — no Total-Count, X-Total-Count, Content-Range, no next_cursor, no has_more. Page-size full means "the page was full", not "there are exactly N total". Never claim "500+ orders" from a single full page.

To get an exact total, call get_<resource> with count_only=true (returns {'resource': '<plural>', 'count': N} without shipping ids). Alternatively use display='id' with a very large limit when you need the id list itself.

To page through full records, set display='full' (default), pick a chunk size (e.g. limit=200), and increment offset until the response is shorter than limit.

Currency

Prices and totals (price, total_paid, total_paid_tax_incl, etc.) are in the store's default currency, not USD or EUR. Resolve the symbol/ISO code with get_currencies (iso_code, sign, conversion_rate) before reporting any monetary value to a user. A bare number without a currency label is misleading — many PrestaShop stores run in non-USD currencies (e.g. UYU, MXN, BRL, INR).

Status and Category Labels

Foreign-key id fields like current_state (orders), id_order_state (order_histories), id_category_default (products), id_manufacturer, id_supplier, id_carrier, id_country, id_state, and id_lang are opaque integers. The label is in a sibling resource — get_order_states for current_state, get_categories for id_category_default, get_manufacturers, get_suppliers, get_carriers, get_countries, get_states, get_languages. Resolve the label via the matching get_* tool before reporting it. Never invent labels for status or category integers — the same id maps to different labels across stores (state 4 may be "Shipped" on one install and "En tránsito" on another).

Multi-Shop

API keys are scoped per shop. Calling a shop the key is not entitled to returns a code-132 error. Inspect entitlements with get_shops and pass id_shop on shop-scoped reads when the install has more than one shop.

Translations

Single-language stores return translatable fields as bare strings. Multi-language stores return them as [{id: <lang_id>, value: "..."}]. Pass language=<lang_id> on reads to collapse to a single language. On writes, pass the same [{id, value}] shape — the tool serializes it correctly into PrestaShop's XML body.