With Zapier you can set up triggers and actions that allow you easily to create automation for your online store. Here’s the API documentation, with all API keys and the related field values.
Triggers (Webhooks)
New Order
Trigger that fires when a new order has been created
Output
- order_number – Order Number
- fullname – Fullname
- telephone_number – Phone
- email – Email
- address – Shipping Address
- city – Shipping City
- civic_number – Civic Number
- zipcode – Zipcode
- province – Province
- fiscal_code – Fiscal Code
- price_total – Total price with shipment included
- discount – Discount
- paid – Payment Status
- created_at – Created at
- products[]name – Product Name
- total_price – Total Price
- delivery_option__name – Delivery Option
- applied_cost – Shipping Cost
New Customer
Trigger that fires when a new customer has been created
Output
- id – Customer ID
- fullname – Fullname
- phone – Phone
- email – Email
- marketing_consent – Marketing Consent
- marketing_consent_date – Marketing Consent Date
- orders – Orders
New Product
Trigger that fires when a new product has been created
Output
- id – Product ID
- name – Product name
- key – Product URL
- description – Product Description
- shop_id – Shop ID
- shop_key – Shop Key
- category__id – Category ID
- category__title – Category Title
- category__color – Category Color
- quantity – Product Quantity
- price – Product Price
- discounted_price – Product Discounted Price
- discounted_price_enabled – Discounted Price Status
- order – Storefront Order
- is_published – Product Status
- is_price_variable – Variable Price
- weights – Product Variant Sizes
- colors – Product Variant Colors
- featured – Featured Product Status
- sku – Product SKU
New Out of Stock Product
Trigger that fires when there’s a new product that is out of stock
Output
- id – Product ID
- name – Product name
- key – Product URL
- description – Product Description
- shop_id – Shop ID
- shop_key – Shop Key
- quantity – Product Quantity
- price – Product Price
- discounted_price – Product Discounted Price
- discounted_price_enabled – Discounted Price Status
- order – Storefront Order
- is_published – Product Status
- is_price_variable – Variable Price
- weights – Product Variant Sizes
- colors – Product Variant Colors
- featured – Featured Product Status
- sku – Product SKU
Actions (API)
Create Coupon Code
Action for creating coupon codes
Input
- name – Name of coupon
- condition_type – Condition type (exceeding_order or whole_order)
- description – Coupon description
- discount_type – Discount Type (percentage or fixed)
- address – Shipping Address
- discount – The amount of discount
- available_from – Date which the coupon is avalable from
- available_to – Date which the coupon is avalable to
- order_exceeds – The limit which the discount will work from
- active – Identifies whether the coupon is active or not
Output
- id – Coupon ID
- name – Coupon Name
- description – Coupon description
- status – Coupon status
- active – Activation status
- used_times – Used times
- discount – Discount
- available_from – Available from
- available_to – Available to
Create product
Action for creating product
Input
- name – Product name
- description_plain – Product description
- quantity – Product quantity
- price – Product price
- discounted_price – Product discounted price
- sku – Product SKU
Output
- id – Product ID
- name – Product name
- key – Product URL
- description – Product Description
- quantity – Product Quantity
- price – Product Price
- discounted_price – Product Discounted Price
- sku – Product SKU
Update product
Action for updating product
Input
- id – Product SKU or ID
- name – Product name
- description_plain – Product description
- quantity – Product quantity
- price – Product price
- discounted_price – Product discounted price
- sku – Product SKU
Output
- id – Product ID
- name – Product name
- key – Product URL
- description – Product Description
- quantity – Product Quantity
- price – Product Price
- discounted_price – Product Discounted Price
- sku – Product SKU
Create product variation
Action for creating a product variant
Input
- id – Product ID
- size – Variant size
- color – Variant color
- quantity – Variant quantity
- price – Variant price
- discounted_price – Variant discounted price
- sku – Variant SKU
- active – Variant Status
Output
- id – Product ID
- name – Product name
- key – Product URL
- description – Product Description
- quantity – Product Quantity
- price – Product Price
- discounted_price – Product Discounted Price
- sku – Product SKU
Update product variation
Action for updating a product variant
Input
- id – Product ID
- size – Variant size
- color – Variant color
- quantity – Variant quantity
- price – Variant price
- discounted_price – Variant discounted price
- sku – Variant SKU
- active – Variant Status
Output
- id – Product ID
- name – Product name
- key – Product URL
- description – Product Description
- quantity – Product Quantity
- price – Product Price
- discounted_price – Product Discounted Price
- sku – Product SKU
Update order
Action for updating order
Input
- id – Order ID
- status – Order status
- payment_status – Payment status
- fiscal_code – Fiscal code
Output
- id – Order ID
- status – Order status
- fiscal_code – Order fiscal code
- payment_status – Order payment status
Find customer
Action for finding customer
Input
- fullname – Customer Name
- email – Customer email
Output
- fullname – Fullname
- country_code – Country
- email – Email
- telephone_number – Phone number
- marketing_consent – Marketing Consent
- marketing_consent_date – Marketing Consent Date