PrestaShop Python API Docs | dltHub

PrestaShop is an open-source e-commerce platform that exposes store data (products, categories, customers, orders, addresses, combinations, manufacturers, suppliers, carts, cart_rules, etc.) via a RESTful webservice. The REST API base URL is https://{shop_domain}/api and all requests require the PrestaShop webservice key (API key) provided as HTTP Basic Auth username or ?ws_key=key.

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading PrestaShop data in under 10 minutes.

---

What data can I load from PrestaShop?

Here are some of the endpoints you can load from PrestaShop:

---

How do I authenticate with the PrestaShop API?

Authentication uses the PrestaShop webservice key. The API key is used as HTTP Basic Auth username with an empty password (or as key parameter in the query string). Requests accept and return XML by default; JSON output can be requested with output_format=JSON or by using wrappers that convert XML to JSON.

1. Get your credentials

In PrestaShop admin: Advanced Parameters -> Webservice -> Add new webservice key; enable resources/permissions needed; copy the generated key. Use that key as HTTP Basic Auth username (leave password blank) or pass as ws_key parameter.

2. Add them to .dlt/secrets.toml

Copy
[sources.prestashop_webservice_source]
api_key = "your_prestashop_webservice_key_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the PrestaShop API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python prestashop_webservice_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline prestashop_webservice_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset prestashop_webservice_data
The duckdb destination used duckdb:/prestashop_webservice.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline prestashop_webservice_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads products and orders from the PrestaShop API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def prestashop_webservice_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{shop_domain}/api",
            "auth": {
                "type": "http_basic",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "products", "endpoint": {"path": "api/products", "data_selector": "prestashop.products.product"}},
            {"name": "orders", "endpoint": {"path": "api/orders", "data_selector": "prestashop.orders.order"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="prestashop_webservice_pipeline",
        destination="duckdb",
        dataset_name="prestashop_webservice_data",
    )
    load_info = pipeline.run(prestashop_webservice_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("prestashop_webservice_pipeline").dataset()
sessions_df = data.products.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM prestashop_webservice_data.products LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("prestashop_webservice_pipeline").dataset()
data.products.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load PrestaShop data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

Authentication failures

If you get 401 Unauthorized, verify the webservice key is enabled in Admin > Advanced Parameters > Webservice and that you are using the key as the HTTP Basic Auth username (password empty) or as ws_key. Ensure IP restrictions or permission scopes are not blocking access.

Rate limiting and timeouts

PrestaShop itself does not impose a standardized rate limit, but hosted environments or proxies may. Implement exponential backoff on 429 or network timeouts.

Pagination and large responses

The webservice supports filters and limited result sets via search filters and indexing (e.g., /api/products?display=full&limit=0,50). Responses are XML by default; request JSON with output_format=JSON or convert XML to JSON in your pipeline.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack