Shopify

Shopify connects your flow to your Shopify store. With a single component you can look up products, orders, customers, transactions and shipments; create products, orders and customers; change or delete them; and mark an order as shipped with its tracking number.

You choose what to do with two fields: Operation (the action) and Entity (what it acts on). The component only shows the fields that combination needs.

When to use it

• Prepare a summary of the previous day’s orders every morning.
• Add to the store the products that arrive in a supplier’s catalog.
• Update a customer’s details when they change in another tool.
• Mark an order as shipped and notify the customer with the tracking number.
• Give a customer service agent access to orders so it can tell people where their shipment is.

Configuration

The component needs a Shopify API credential with your store’s address, the Shopify app’s client ID and secret key, and the API version. See Credentials.

Field	What it does
Credential (required)	Your Shopify store’s credential.
Operation	The action: Get, Create, Update or Delete. Default: Get.
Entity	What it acts on: Product, Order, Customer, Transaction (payment transaction) or Fulfillment (shipment). Default: Product.
Entity ID	The item’s identifier in Shopify. It doesn’t appear when creating. Required to update and delete. For Transaction and Fulfillment, it is the order identifier.

What you can do with each entity

Entity	Get	Create	Update	Delete
Product	Yes	Yes	Yes	Yes
Order	Yes	Yes	Yes	Yes
Customer	Yes	Yes	Yes	Yes
Transaction	Yes, those of an order	No	No	No
Fulfillment	Yes, those of an order	Yes: marks the order’s pending items as shipped	No	No

Looking up (Get)

Field	What it does
Entity ID	When filled in, only that item is returned. When empty, a list is returned.
Search	Optional. A text to filter the list: only items containing it are shown.
Limit	Advanced option. The maximum number of items in the list. Default: 10.
Order By	Advanced option. The field the list is sorted by. Put a hyphen in front for reverse order, for example -created_at. Default: created_at (creation date).

Creating or updating a product

Field	What it does
Product Title	The product name. Required when creating.
Include Additional Fields	Advanced option. Turn it on to add more product details.
Additional Fields	Which extra details you want to fill in. Each one shows its own field: Body HTML (description, formatting allowed), Product Type, Vendor, Tags, Image, Price, Handle (the product’s address in the store), Options (such as size or color), Published At, Published Scope and Template Suffix.

With Options you set how many options the product has and, for each one, its name (Option Name) and its values separated by commas (Option Value). Shopify creates one variant per combination. In Product Price you can give one price for all variants or one per variant, separated by commas.

Creating or updating an order

Field	What it does
Customer ID	The order’s customer. Required when creating.
Number of Line Items	How many lines the order has. For each one, Product ID, Variant ID, Quantity and Grams appear. Default: 1.
Include Additional Fields	Advanced option. Turn it on to add more order details.
Select Additional Fields	Which extra details you want to fill in: Billing Address, Discount Codes, Email, Fulfillment Status, Inventory Behavior, Note, Send Fulfillment Receipt and Send Receipt (send confirmations to the customer), Shipping Address, Source Name (order source), Tags and Test (test order).

Creating or updating a customer

First Name, Last Name, Customer Email, Customer Phone, Customer Tags (comma-separated) and Customer Note. When creating, fill in at least one.

Recording a shipment (Create with Fulfillment)

Field	What it does
Entity ID	The identifier of the order being shipped.
Tracking Number	Optional. The shipment’s tracking number.
Tracking Company	Optional. The carrier.
Notify Customer	Sends the customer Shopify’s shipping notification. Off by default.

Output

The Result output returns what Shopify sends back: the items looked up, or the item created or updated with all its details. When deleting, it returns a confirmation message. If the requested item doesn’t exist, it returns nothing.

Connect it to an agent, to Parse Data or to a spreadsheet. The component can also be used as a tool by an agent, which decides what to look up or change based on the conversation.

Example

A shop wants to notify customers when their order ships:

1. The warehouse records each order and its tracking number in a spreadsheet.
2. Add Shopify and choose Create in Operation and Fulfillment in Entity.
3. Connect the order identifier to Entity ID and the number to Tracking Number, enter the carrier in Tracking Company and turn on Notify Customer.
4. Shopify marks the order as shipped and the customer receives the notification with the tracking number.

Good practices

• Try the operations that create, change or delete with a test product or customer before using them with real data.
• Deleting in Shopify cannot be undone from NappAI.

Related components

• Shopify Webhook: starts the flow when something happens in your Shopify store.
• WooCommerce: the same idea for WooCommerce stores.