Help CenterGitHub
PrestaShop
Integration Guide

PrestaShop + AtoShip

Connect your PrestaShop store using the built-in WebService API — no plugin or extension required. Generate an API key in your admin panel, paste it into AtoShip, and orders start flowing immediately.

How it works

PrestaShop includes a built-in REST WebService API. AtoShip connects to it using a WebService key you create in your admin panel. No extra modules to install — everything works out of the box.

1

Customer places an order

New orders appear in your PrestaShop back office

2

Orders sync to AtoShip

Auto-imported with customer info, line items, and addresses

3

Buy label, tracking goes back

Tracking number written to the PrestaShop order

Setup (no plugin required)

Step 1 — Enable the WebService API

PrestaShop's WebService is disabled by default. Turn it on first:

  1. Go to Advanced Parameters → WebService
  2. Set Enable PrestaShop WebService to Yes
  3. Click Save

If you don't see the WebService menu, check that your PrestaShop installation is accessible over HTTPS. The WebService API is only fully functional over a secure connection.

Step 2 — Create a WebService key

Still in Advanced Parameters → WebService:

  1. Click Add new webservice key
  2. Click Generate to create a random API key
  3. Under Permissions, enable the following resources with at least GETaccess: orders, customers, addresses, products, order_details
  4. Also enable PUT access for orders and order_histories (needed for tracking writeback)
  5. Set Status to Enabled
  6. Click Save
  7. Copy the generated API key — you'll need it in the next step

Step 3 — Connect from AtoShip

In your AtoShip dashboard:

  1. Go to Channels → Add Channel → PrestaShop
  2. Enter your store URL (e.g. https://your-store.com)
  3. Paste the WebService API key from Step 2
  4. Click Connect Store

AtoShip will validate the credentials using GET /api/ and detect your store name automatically. Orders will begin syncing on the next scheduled cron cycle.

WebService permissions reference

Here's exactly what permissions AtoShip needs and why:

ResourceGETPUTWhy
orders
GET
PUT
Read orders, update tracking info
order_details
GET
Read line items and quantities
order_histories
GET
PUT
Update order status on shipment/delivery
customers
GET
Read customer name and email
addresses
GET
Read shipping and billing addresses
products
GET
Sync product catalog

You can grant more permissions — AtoShip will only use the ones listed above.

What gets synced

PrestaShop → AtoShip

  • Order number, date, total
  • Shipping & billing addresses
  • Line items with product name, quantity
  • Customer name & email
  • Order status
  • Product catalog

AtoShip → PrestaShop

  • Tracking number & carrier name
  • Order status update (Shipped / Delivered)
  • Order history comment with carrier details

Troubleshooting

Connection fails with "Invalid API key"

Verify the WebService is Enabled and the key status is Enabled in Advanced Parameters → WebService. Also confirm the key has at least GET access toorders.

WebService menu not visible in admin

Go to Advanced Parameters → Performance and check if caching is causing menu issues. Also, the WebService menu requires admin-level permissions — check your admin role.

Orders not syncing

AtoShip syncs on a scheduled cron cycle. Use Sync Now on the Channels page to trigger an immediate sync. If that fails, check the store URL — it must include the protocol (https://) and match the URL where PrestaShop is installed exactly.

Tracking not updating on PrestaShop orders

Make sure the WebService key has PUT access to orders and order_histories. You can also use the Resend Tracking button on the AtoShip order detail page to manually push tracking.

Requirements

  • PrestaShop 1.7.x or 8.x
  • WebService API enabled (Advanced Parameters → WebService)
  • Store accessible via public HTTPS URL
  • Admin account to create WebService keys
No Plugin Required
PrestaShop has a built-in WebService API. Just create an API key and connect — nothing to install.
At a glance
AuthWebService API key
CarriersUSPS, UPS, FedEx, DHL
Plugin required
None
PrestaShop version1.7+ / 8.x
Sync intervalEvery 30 min
Features
Order sync (auto + manual)
Product catalog sync
Tracking writeback
Order status updates
Customer name & address
No extension to install
Ready to connect?
Create a WebService key, then connect from your dashboard.
atoship © 2026