Shopify
Create products, manage orders, and update inventory in your Shopify store.
On this page
- Connect
- Call it from a workflow
- Actions (27)
- create_order
- create_product
- update_order
- adjust_inventory_level
- cancel_order
- close_order
- create_collect
- create_customer
- create_draft_order
- create_fulfillment_event
- create_transaction
- custom_api_call
- get_asset
- get_customer
- get_customer_orders
- get_customers
- get_fulfillment
- get_fulfillments
- get_locations
- get_product
- get_product_variant
- get_products
- get_transaction
- get_transactions
- update_customer
- update_product
- upload_product_image
- Details
Connect
Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.
- In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
- For every project in a workspace: Workspace settings, Integrations.
- Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.
Call it from a workflow
Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.
// .workflow.js (native ctx)
export async function run(ctx) {
const res = await ctx.integrations.invoke("shopify", "create_order", {});
if (!res.success) throw new Error(res.error);
ctx.log.info("Shopify answered", { output: res.output });
}// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";
export default defineWorkflow({
id: "shopify-create-order",
name: "Shopify: Create Order",
description: "Calls Shopify when a row is created.",
trigger: { type: "entity_event", entity: "tickets", event: "created" },
async run(ctx, event) {
const res = await ctx.integrations.call("shopify", {
"action": "create_order"
}) as { success: boolean; error?: string };
if (!res.success) throw new Error(res.error);
},
});curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/shopify/create_order" \
-H "Authorization: Bearer $APP_KEY" \
-H "content-type: application/json" \
-d '{"props":{}}'Actions
create_orderin catalog
Create Order. Create a new order.
| Input | Type | Description |
|---|---|---|
productIdoptional | number | The ID of the product to create the order with. |
variantIdoptional | number | The ID of the variant to create the order with. |
titleoptional | text | Title |
quantityoptional | number | Quantity |
priceoptional | text | Price |
customerIdoptional | text | The ID of the customer to use. |
emailoptional | text | |
sendReceiptoptional | boolean | Send Receipt |
sendFulfillmentReceiptoptional | boolean | Send Fulfillment Receipt |
tagsoptional | text | A string of comma-separated tags for filtering and search |
create_productin catalog
Create Product. Create a new product.
| Input | Type | Description |
|---|---|---|
titlerequired | text | Title |
bodyHtmloptional | long text | Product description (supports HTML) |
productTypeoptional | text | A categorization for the product used for filtering and searching products |
productImageoptional | file | The public URL or the base64 image to use |
statusrequired | one of "active" | "draft" | "archived" | Status |
vendoroptional | text | Vendor |
tagsoptional | text | A string of comma-separated tags for filtering and search |
update_orderin catalog
Update Order. Update an existing order.
| Input | Type | Description |
|---|---|---|
idrequired | text | The ID of the order. |
emailoptional | text | |
phoneNumberoptional | text | Phone Number |
tagsoptional | text | A string of comma-separated tags for filtering and search |
noteoptional | text | Note |
adjust_inventory_level
Adjust Inventory Level. Adjust inventory level of an item at a location.
| Input | Type | Description |
|---|---|---|
idrequired | number | The ID of the inventory item. |
locationIdrequired | number | The ID of the location. |
adjustmentrequired | number | Positive values increase inventory, negative values decrease it. |
cancel_order
Cancel Order. Cancel an order.
| Input | Type | Description |
|---|---|---|
orderIdrequired | number | The ID of the order. |
close_order
Close Order. Close an order.
| Input | Type | Description |
|---|---|---|
orderIdrequired | number | The ID of the order. |
create_collect
Create Collect. Add a product to a collection.
| Input | Type | Description |
|---|---|---|
idrequired | number | The ID of the product. |
collectionIdrequired | number | The ID of the collection. |
create_customer
Create Customer. Create a new customer.
| Input | Type | Description |
|---|---|---|
emailoptional | text | |
verifiedEmailoptional | boolean | Whether the customer has verified their email. |
sendEmailInviteoptional | boolean | Send Email Invite |
firstNameoptional | text | First Name |
lastNameoptional | text | Last Name |
phoneNumberoptional | text | Phone Number |
tagsoptional | text | A string of comma-separated tags for filtering and search |
acceptsMarketingoptional | boolean | Accepts Marketing ? |
create_draft_order
Create Draft Order. Create a new draft order.
| Input | Type | Description |
|---|---|---|
productIdoptional | number | The ID of the product to create the order with. |
variantIdoptional | number | The ID of the variant to create the order with. |
titleoptional | text | Title |
quantityoptional | number | Quantity |
priceoptional | text | Price |
customerIdoptional | text | The ID of the customer to use. |
create_fulfillment_event
Create Fulfillment Event. Create a new fulfillment event.
| Input | Type | Description |
|---|---|---|
orderIdrequired | number | The ID of the order. |
fulfillmentIdrequired | number | The ID of the fulfillment. |
statusrequired | id (picked from your account) | Status |
messageoptional | text | Message |
create_transaction
Create Transaction. Create a new transaction.
| Input | Type | Description |
|---|---|---|
orderIdrequired | number | The ID of the order to create a transaction for. |
kindrequired | id (picked from your account) | Type |
currencyoptional | text | Currency |
amountoptional | text | Amount |
authorizationoptional | text | Authorization Key |
parentIdoptional | number | The ID of an associated transaction. |
sourceoptional | text | An optional origin of the transaction. Set to external to import a cash transaction for the associated order. |
testoptional | boolean | Whether the transaction is a test transaction. |
custom_api_call
Custom API Call. Make a custom API call to a specific endpoint
| Input | Type | Description |
|---|---|---|
urlrequired | object (depends on other props) | url |
methodrequired | one of "GET" | "POST" | "PATCH" | "PUT" | "DELETE" | "HEAD" | Method |
headersrequired | object | Authorization headers are injected automatically from your connection. |
queryParamsrequired | object | Query Parameters |
body_typeoptional | one of "none" | "json" | "form_data" | "raw" | Body Type |
bodyoptional | object (depends on other props) | Body |
response_is_binaryoptional | boolean | Enable for files like PDFs, images, etc. |
failsafeoptional | boolean | No Error on Failure |
timeoutoptional | number | Timeout (in seconds) |
followRedirectsoptional | boolean | Follow redirects |
get_asset
Get Asset. Get a theme's asset.
| Input | Type | Description |
|---|---|---|
keyrequired | text | Asset Key |
themeIdrequired | text | The ID of the theme. |
get_customer
Get Customer. Get an existing customer's information.
| Input | Type | Description |
|---|---|---|
customerIdrequired | text | Customer ID |
get_customer_orders
Get Customer Orders. Get an existing customer's orders.
| Input | Type | Description |
|---|---|---|
customerIdrequired | text | Customer ID |
get_customers
Get Customers. Get an existing customers.
No input.
get_fulfillment
Get Fulfillment. Get a fulfillment.
| Input | Type | Description |
|---|---|---|
orderIdrequired | number | The ID of the order. |
fulfillmentIdrequired | number | The ID of the fulfillment. |
get_fulfillments
Get Fulfillments. Get an order's fulfillments.
| Input | Type | Description |
|---|---|---|
orderIdrequired | number | The ID of the order. |
get_locations
Get Locations. Get locations.
No input.
get_product
Get Product. Get existing product.
| Input | Type | Description |
|---|---|---|
idrequired | text | The ID of the product. |
get_product_variant
Get Product Variant. Get a product variant.
| Input | Type | Description |
|---|---|---|
idrequired | text | The ID of the product variant. |
get_products
Get Products. Get existing products by title.
| Input | Type | Description |
|---|---|---|
titleoptional | text | Title |
get_transaction
Get Transaction. Get an existing transaction's information.
| Input | Type | Description |
|---|---|---|
orderIdrequired | number | The ID of the order. |
transactionIdrequired | number | The ID of the transaction |
get_transactions
Get Order Transactions. Get an order's transactions.
| Input | Type | Description |
|---|---|---|
orderIdrequired | number | The ID of the order. |
update_customer
Update Customer. Update an existing customer.
| Input | Type | Description |
|---|---|---|
customerIdrequired | text | Customer ID |
emailoptional | text | |
verifiedEmailoptional | boolean | Whether the customer has verified their email. |
sendEmailInviteoptional | boolean | Send Email Invite |
firstNameoptional | text | First Name |
lastNameoptional | text | Last Name |
phoneNumberoptional | text | Phone Number |
tagsoptional | text | A string of comma-separated tags for filtering and search |
acceptsMarketingoptional | boolean | Accepts Marketing ? |
update_product
Update Product. Update an existing product.
| Input | Type | Description |
|---|---|---|
idrequired | text | The ID of the product. |
titleoptional | text | Title |
bodyHtmloptional | long text | Product description (supports HTML) |
productTypeoptional | text | A categorization for the product used for filtering and searching products |
productImageoptional | file | The public URL or the base64 image to use |
statusrequired | one of "active" | "draft" | "archived" | Status |
vendoroptional | text | Vendor |
tagsoptional | text | A string of comma-separated tags for filtering and search |
upload_product_image
Upload Product Image. Upload a new product image.
| Input | Type | Description |
|---|---|---|
idrequired | text | The ID of the product. |
imagerequired | file | The public URL or the base64 image to use |
positionoptional | number | 1 makes it the main image. |
Details
- Id
shopify- Category
- E-commerce
- Tags
- store, products, orders, inventory, shop
- Package
@activepieces/piece-shopify@0.2.4- Tier
- Built in