PrestaShop

App · 11 actions

Run your PrestaShop store from workflows: get and find orders, move them to a new status and add tracking numbers, find and add customers, and keep stock and prices in step with your other systems. Start a workflow on a new order, a status change or a new customer.

Actions

ActionWhat it does
Add tracking numberPut the shipment's tracking number on an order, for the customer to see in their account.
Create customerAdd a customer account to the shop.
Find customersFind customers by part of their email address or name, newest first.
Find ordersFind orders by status, customer and the days they were placed, newest first, each with its lines and addresses.
Find productsFind products by part of their name or reference, newest first, with their price and stock.
Get customerGet a customer's details and saved addresses, by their ID or email address.
Get orderGet an order with what was ordered, the customer, the delivery and billing addresses, the carrier, tracking number and status.
Get productGet a product's price, stock and combinations (sizes, colours and so on), by its ID or reference.
Update order statusMove an order to a status, such as Shipped or Canceled, as the back office does.
Update product priceSet a product's price before tax.
Update stockSet how many of a product or one of its combinations are in stock, or add to it.

Add tracking number

Put the shipment's tracking number on an order, for the customer to see in their account. It replaces any number already there.

Inputs

OrderordertextRequired
The order's ID, from a trigger or an earlier step, or its reference, such as XKBKNABJK.
Tracking numbertracking_numbertextRequired
The carrier's tracking number, such as AB123456789GB.

Outputs

carriertext
The carrier's name
order_idnumber
The order's ID
order_referencetext
The order's reference
tracking_numbertext
The tracking number now on the order
tracking_urltext
The carrier's tracking page for it, if the carrier has one
Example output
{
  "carrier": "Royal Mail",
  "order_id": 12,
  "order_reference": "XKBKNABJK",
  "tracking_number": "AB123456789GB",
  "tracking_url": "https://www.royalmail.com/track-your-item#/tracking-results/AB123456789GB"
}

Create customer

Add a customer account to the shop. If one already has the email address, it's returned instead, unchanged.

Inputs

EmailemailtextRequired
The customer's email address.
First namefirstnametextRequired
Their first name.
Last namelastnametextRequired
Their last name.
Companycompanytext
Their company.
Birthdaybirthdaydate
Their date of birth.
Newsletternewslettertrue/false
Sign them up for the shop's newsletter.Default: false.
Notenotetext
A private note about them, seen only in the back office.

Outputs

activetrue/false
Whether their account is turned on
birthdaytext
Their birthday (YYYY-MM-DD), if given
companytext
Their company, if any
createdtrue/false
True if the account was made; false if one had the email already
created_attext
When they signed up, in the shop's time zone
emailtext
Their email address
firstnametext
Their first name
guesttrue/false
Whether it's a guest checkout rather than an account
idnumber
The customer's ID, for other PrestaShop steps
lastnametext
Their last name
nametext
Their full name
newslettertrue/false
Whether they get the shop's newsletter
notetext
The shop's private note about them
updated_attext
When their account last changed
Example output
{
  "active": true,
  "birthday": "1990-04-12",
  "company": "",
  "created": true,
  "created_at": "2026-10-01 10:00:00",
  "email": "jane@example.com",
  "firstname": "Jane",
  "guest": false,
  "id": 2,
  "lastname": "Doe",
  "name": "Jane Doe",
  "newsletter": true,
  "note": "",
  "updated_at": "2026-10-01 10:00:00"
}

Find customers

Find customers by part of their email address or name, newest first.

Inputs

Emailemailtext
An email address, or part of one, such as @example.com.
Namenametext
Part of their first or last name.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many were found
customerslist
The customers, newest first
Example output
{
  "count": 1,
  "customers": [
    {
      "active": true,
      "birthday": "1990-04-12",
      "company": "",
      "created_at": "2026-10-01 10:00:00",
      "email": "jane@example.com",
      "firstname": "Jane",
      "guest": false,
      "id": 2,
      "lastname": "Doe",
      "name": "Jane Doe",
      "newsletter": true,
      "note": "",
      "updated_at": "2026-10-01 10:00:00"
    }
  ]
}

Find orders

Find orders by status, customer and the days they were placed, newest first, each with its lines and addresses.

Inputs

Statusstatustext
Only orders with this status.
Customercustomertext
Only this customer's orders: their ID or email address.
Placed fromcreated_fromdate
Only orders placed on or after this day.
Placed untilcreated_todate
Only orders placed on or before this day.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many were found
orderslist
The orders, newest first
Example output
{
  "count": 1,
  "orders": [
    {
      "carrier": "Royal Mail",
      "created_at": "2026-11-05 09:12:44",
      "currency": "GBP",
      "customer_email": "jane@example.com",
      "customer_id": 2,
      "customer_name": "Jane Doe",
      "delivery_address": {
        "address1": "16 Main Street",
        "address2": "Flat 2",
        "alias": "Home",
        "city": "London",
        "company": "",
        "country": "United Kingdom",
        "country_code": "GB",
        "id": 5,
        "name": "Jane Doe",
        "phone": "020 7946 0000",
        "phone_mobile": "",
        "postcode": "SW1A 1AA",
        "text": "Jane Doe, 16 Main Street, Flat 2, SW1A 1AA London, United Kingdom",
        "vat_number": ""
      },
      "gift_message": "",
      "id": 12,
      "invoice_address": {
        "address1": "16 Main Street",
        "address2": "Flat 2",
        "alias": "Home",
        "city": "London",
        "company": "",
        "country": "United Kingdom",
        "country_code": "GB",
        "id": 5,
        "name": "Jane Doe",
        "phone": "020 7946 0000",
        "phone_mobile": "",
        "postcode": "SW1A 1AA",
        "text": "Jane Doe, 16 Main Street, Flat 2, SW1A 1AA London, United Kingdom",
        "vat_number": ""
      },
      "lines": [
        {
          "combination_id": 1,
          "ean13": "",
          "name": "Hummingbird printed t-shirt - Color : White, Size : S",
          "product_id": 1,
          "quantity": 2,
          "reference": "demo_1",
          "total": 47.8,
          "unit_price": 23.9,
          "unit_price_tax_excl": 19.92
        }
      ],
      "paid": true,
      "payment": "Bank transfer",
      "reference": "XKBKNABJK",
      "status": "Payment accepted",
      "status_id": 2,
      "total_discounts": 0.0,
      "total_paid": 55.8,
      "total_paid_tax_excl": 46.5,
      "total_products": 47.8,
      "total_products_tax_excl": 39.83,
      "total_shipping": 8.0,
      "tracking_number": "",
      "tracking_url": "",
      "updated_at": "2026-11-05 09:14:02"
    }
  ]
}

Find products

Find products by part of their name or reference, newest first, with their price and stock.

Inputs

Namenametext
Part of the product's name.
Referencereferencetext
Part of the product's reference (SKU).
Only products on saleactive_onlytrue/false
Leave out products switched off in the shop.Default: false.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many were found
productslist
The products, newest first
Example output
{
  "count": 1,
  "products": [
    {
      "active": true,
      "created_at": "2026-10-01 10:00:00",
      "ean13": "",
      "id": 1,
      "link": "https://shop.example.com/index.php?controller=product&id_product=1",
      "manufacturer": "Studio Design",
      "name": "Hummingbird printed t-shirt",
      "price": 19.92,
      "quantity": 2400,
      "reference": "demo_1",
      "updated_at": "2026-11-05 09:00:00",
      "wholesale_price": 5.49
    }
  ]
}

Get customer

Get a customer's details and saved addresses, by their ID or email address.

Inputs

CustomercustomertextRequired
The customer's ID, or their email address.

Outputs

activetrue/false
Whether their account is turned on
addresseslist
Their saved addresses
birthdaytext
Their birthday (YYYY-MM-DD), if given
companytext
Their company, if any
created_attext
When they signed up, in the shop's time zone
emailtext
Their email address
firstnametext
Their first name
guesttrue/false
Whether it's a guest checkout rather than an account
idnumber
The customer's ID, for other PrestaShop steps
lastnametext
Their last name
nametext
Their full name
newslettertrue/false
Whether they get the shop's newsletter
notetext
The shop's private note about them
updated_attext
When their account last changed
Example output
{
  "active": true,
  "addresses": [
    {
      "address1": "16 Main Street",
      "address2": "Flat 2",
      "alias": "Home",
      "city": "London",
      "company": "",
      "country": "United Kingdom",
      "country_code": "GB",
      "id": 5,
      "name": "Jane Doe",
      "phone": "020 7946 0000",
      "phone_mobile": "",
      "postcode": "SW1A 1AA",
      "text": "Jane Doe, 16 Main Street, Flat 2, SW1A 1AA London, United Kingdom",
      "vat_number": ""
    }
  ],
  "birthday": "1990-04-12",
  "company": "",
  "created_at": "2026-10-01 10:00:00",
  "email": "jane@example.com",
  "firstname": "Jane",
  "guest": false,
  "id": 2,
  "lastname": "Doe",
  "name": "Jane Doe",
  "newsletter": true,
  "note": "",
  "updated_at": "2026-10-01 10:00:00"
}

Get order

Get an order with what was ordered, the customer, the delivery and billing addresses, the carrier, tracking number and status.

Inputs

OrderordertextRequired
The order's ID, from a trigger or an earlier step, or its reference, such as XKBKNABJK.

Outputs

carriertext
The carrier's name
created_attext
When it was placed, in the shop's time zone
currencytext
The currency's code, such as EUR
customer_emailtext
The customer's email address
customer_idnumber
The customer's ID
customer_nametext
The customer's name
delivery_addressobject
Where it's delivered
gift_messagetext
The gift message, if any
idnumber
The order's ID, for other PrestaShop steps
invoice_addressobject
The billing address
lineslist
What was ordered
paidtrue/false
Whether PrestaShop counts the order as paid
paymenttext
How it was paid for, such as Bank transfer
referencetext
The order's reference, such as XKBKNABJK
statustext
Its status, such as Payment accepted or Shipped
status_idnumber
The status's ID
total_discountsnumber
Discounts, with tax
total_paidnumber
What the customer pays, with tax and shipping
total_paid_tax_exclnumber
What the customer pays, before tax
total_productsnumber
The products' total, with tax
total_products_tax_exclnumber
The products' total, before tax
total_shippingnumber
Shipping, with tax
tracking_numbertext
The shipment's tracking number, if one is set
tracking_urltext
The carrier's tracking page for it, if the carrier has one
updated_attext
When it last changed, in the shop's time zone
Example output
{
  "carrier": "Royal Mail",
  "created_at": "2026-11-05 09:12:44",
  "currency": "GBP",
  "customer_email": "jane@example.com",
  "customer_id": 2,
  "customer_name": "Jane Doe",
  "delivery_address": {
    "address1": "16 Main Street",
    "address2": "Flat 2",
    "alias": "Home",
    "city": "London",
    "company": "",
    "country": "United Kingdom",
    "country_code": "GB",
    "id": 5,
    "name": "Jane Doe",
    "phone": "020 7946 0000",
    "phone_mobile": "",
    "postcode": "SW1A 1AA",
    "text": "Jane Doe, 16 Main Street, Flat 2, SW1A 1AA London, United Kingdom",
    "vat_number": ""
  },
  "gift_message": "",
  "id": 12,
  "invoice_address": {
    "address1": "16 Main Street",
    "address2": "Flat 2",
    "alias": "Home",
    "city": "London",
    "company": "",
    "country": "United Kingdom",
    "country_code": "GB",
    "id": 5,
    "name": "Jane Doe",
    "phone": "020 7946 0000",
    "phone_mobile": "",
    "postcode": "SW1A 1AA",
    "text": "Jane Doe, 16 Main Street, Flat 2, SW1A 1AA London, United Kingdom",
    "vat_number": ""
  },
  "lines": [
    {
      "combination_id": 1,
      "ean13": "",
      "name": "Hummingbird printed t-shirt - Color : White, Size : S",
      "product_id": 1,
      "quantity": 2,
      "reference": "demo_1",
      "total": 47.8,
      "unit_price": 23.9,
      "unit_price_tax_excl": 19.92
    }
  ],
  "paid": true,
  "payment": "Bank transfer",
  "reference": "XKBKNABJK",
  "status": "Payment accepted",
  "status_id": 2,
  "total_discounts": 0.0,
  "total_paid": 55.8,
  "total_paid_tax_excl": 46.5,
  "total_products": 47.8,
  "total_products_tax_excl": 39.83,
  "total_shipping": 8.0,
  "tracking_number": "",
  "tracking_url": "",
  "updated_at": "2026-11-05 09:14:02"
}

Get product

Get a product's price, stock and combinations (sizes, colours and so on), by its ID or reference.

Inputs

ProductproducttextRequired
The product's ID, or its reference (SKU).

Outputs

activetrue/false
Whether it's on sale in the shop
combinationslist
Its combinations (sizes, colours and so on)
created_attext
When it was added, in the shop's time zone
ean13text
Its barcode, if any
idnumber
The product's ID, for other PrestaShop steps
linktext
Its page in the shop
manufacturertext
The brand's name, if any
nametext
Its name
pricenumber
Its price before tax
quantitynumber
How many are in stock, across its combinations
referencetext
Its reference (SKU)
summarytext
Its short description, as plain text
updated_attext
When it last changed
wholesale_pricenumber
What the shop pays for it
Example output
{
  "active": true,
  "combinations": [
    {
      "default": true,
      "ean13": "",
      "id": 1,
      "options": "S, White",
      "price_impact": 0.0,
      "quantity": 300,
      "reference": "demo_1_s_white"
    }
  ],
  "created_at": "2026-10-01 10:00:00",
  "ean13": "",
  "id": 1,
  "link": "https://shop.example.com/index.php?controller=product&id_product=1",
  "manufacturer": "Studio Design",
  "name": "Hummingbird printed t-shirt",
  "price": 19.92,
  "quantity": 2400,
  "reference": "demo_1",
  "summary": "Regular fit, round neckline, short sleeves.",
  "updated_at": "2026-11-05 09:00:00",
  "wholesale_price": 5.49
}

Update order status

Move an order to a status, such as Shipped or Canceled, as the back office does. Nothing changes if it already has that status.

Inputs

OrderordertextRequired
The order's ID, from a trigger or an earlier step, or its reference, such as XKBKNABJK.
StatusstatustextRequired
The status to move it to. Statuses set to email the customer do so.
Email the customeremail_customertrue/false
Send the customer the email PrestaShop has for this status, if it has one.Default: true.

Outputs

carriertext
The carrier's name
changedtrue/false
Whether the status changed: false if it already had it
created_attext
When it was placed, in the shop's time zone
currencytext
The currency's code, such as EUR
customer_emailtext
The customer's email address
customer_idnumber
The customer's ID
customer_nametext
The customer's name
delivery_addressobject
Where it's delivered
emailedtrue/false
Whether PrestaShop emailed the customer about it
gift_messagetext
The gift message, if any
idnumber
The order's ID, for other PrestaShop steps
invoice_addressobject
The billing address
lineslist
What was ordered
paidtrue/false
Whether PrestaShop counts the order as paid
paymenttext
How it was paid for, such as Bank transfer
previous_statustext
The status it had before
referencetext
The order's reference, such as XKBKNABJK
statustext
Its status, such as Payment accepted or Shipped
status_idnumber
The status's ID
total_discountsnumber
Discounts, with tax
total_paidnumber
What the customer pays, with tax and shipping
total_paid_tax_exclnumber
What the customer pays, before tax
total_productsnumber
The products' total, with tax
total_products_tax_exclnumber
The products' total, before tax
total_shippingnumber
Shipping, with tax
tracking_numbertext
The shipment's tracking number, if one is set
tracking_urltext
The carrier's tracking page for it, if the carrier has one
updated_attext
When it last changed, in the shop's time zone
Example output
{
  "carrier": "Royal Mail",
  "changed": true,
  "created_at": "2026-11-05 09:12:44",
  "currency": "GBP",
  "customer_email": "jane@example.com",
  "customer_id": 2,
  "customer_name": "Jane Doe",
  "delivery_address": {
    "address1": "16 Main Street",
    "address2": "Flat 2",
    "alias": "Home",
    "city": "London",
    "company": "",
    "country": "United Kingdom",
    "country_code": "GB",
    "id": 5,
    "name": "Jane Doe",
    "phone": "020 7946 0000",
    "phone_mobile": "",
    "postcode": "SW1A 1AA",
    "text": "Jane Doe, 16 Main Street, Flat 2, SW1A 1AA London, United Kingdom",
    "vat_number": ""
  },
  "emailed": true,
  "gift_message": "",
  "id": 12,
  "invoice_address": {
    "address1": "16 Main Street",
    "address2": "Flat 2",
    "alias": "Home",
    "city": "London",
    "company": "",
    "country": "United Kingdom",
    "country_code": "GB",
    "id": 5,
    "name": "Jane Doe",
    "phone": "020 7946 0000",
    "phone_mobile": "",
    "postcode": "SW1A 1AA",
    "text": "Jane Doe, 16 Main Street, Flat 2, SW1A 1AA London, United Kingdom",
    "vat_number": ""
  },
  "lines": [
    {
      "combination_id": 1,
      "ean13": "",
      "name": "Hummingbird printed t-shirt - Color : White, Size : S",
      "product_id": 1,
      "quantity": 2,
      "reference": "demo_1",
      "total": 47.8,
      "unit_price": 23.9,
      "unit_price_tax_excl": 19.92
    }
  ],
  "paid": true,
  "payment": "Bank transfer",
  "previous_status": "Payment accepted",
  "reference": "XKBKNABJK",
  "status": "Shipped",
  "status_id": 4,
  "total_discounts": 0.0,
  "total_paid": 55.8,
  "total_paid_tax_excl": 46.5,
  "total_products": 47.8,
  "total_products_tax_excl": 39.83,
  "total_shipping": 8.0,
  "tracking_number": "",
  "tracking_url": "",
  "updated_at": "2026-11-05 09:14:02"
}

Update product price

Set a product's price before tax. Its combinations keep their own price changes on top of it.

Inputs

ProductproducttextRequired
The product's ID, or its reference (SKU).
Price before taxpricenumberRequired
The new price, before tax, such as 19.99.At least 0.

Outputs

idnumber
The product's ID
linktext
Its page in the shop
nametext
Its name
previous_pricenumber
Its price before tax, before the change
pricenumber
Its price before tax now
referencetext
Its reference (SKU)
Example output
{
  "id": 1,
  "link": "https://shop.example.com/index.php?controller=product&id_product=1",
  "name": "Hummingbird printed t-shirt",
  "previous_price": 19.92,
  "price": 21.5,
  "reference": "demo_1"
}

Update stock

Set how many of a product or one of its combinations are in stock, or add to it.

Inputs

ProductproducttextRequired
The product's ID or reference (SKU), or a combination's reference.
QuantityquantitynumberRequired
The new stock, or how many to add (below 0 to take away).
Combinationcombinationtext
For a product with combinations: the combination's ID or reference.
Howhowtext
Set the stock to the quantity, or add the quantity to it.One of: set (Set the stock to this), add (Add this to the stock). Default: set.

Outputs

combination_idnumber
The combination's ID; 0 for a product without any
nametext
The product's name
previous_quantitynumber
The stock before
product_idnumber
The product's ID
quantitynumber
The stock now
referencetext
The product's or combination's reference
Example output
{
  "combination_id": 1,
  "name": "Hummingbird printed t-shirt",
  "previous_quantity": 300,
  "product_id": 1,
  "quantity": 120,
  "reference": "demo_1_s_white"
}

On this page