Skip to content
For LLMsView as Markdown·

Shopify

Manage products, orders, and customers in your Shopify store.

DetailValue
CategoryE-commerce
Base URLhttps://{shop}.myshopify.com/admin/api/2024-01
AuthenticationAPI Key
Endpoints7
Connector keyshopify

Using Shopify in a workflow

  1. Go to Connections and click New Connection.
  2. Pick Shopify from the marketplace.
  3. Enter your credentials (see Authentication above for what's expected).
  4. In a workflow, drop an API Call node and select this connection.
  5. Pick the operation you need from the Operation dropdown — the full list is below.

Available endpoints

EndpointSummary
GET /products.jsonList products
POST /products.jsonCreate a product
GET /products/{product_id}.jsonGet a product
GET /orders.jsonList orders
GET /orders/{order_id}.jsonGet an order
GET /customers.jsonList customers
POST /customers.jsonCreate a customer

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET /products.json

List products

DetailValue
Operation IDecommerce.listProducts
MethodGET
Path/products.json

Parameters

NameLocationTypeRequired
limitqueryintegerNo
collection_idquerystringNo

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Shopify connection from the Connection dropdown.
  3. In the Operation dropdown, select ecommerce.listProducts.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Shopify API reference.

POST /products.json

Create a product

DetailValue
Operation IDecommerce.createProduct
MethodPOST
Path/products.json

Parameters

No parameters.

Request Body

FieldType
productobject

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Shopify connection from the Connection dropdown.
  3. In the Operation dropdown, select ecommerce.createProduct.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Shopify API reference.

GET /products/{product_id}.json

Get a product

DetailValue
Operation IDecommerce.getProduct
MethodGET
Path/products/{product_id}.json

Parameters

NameLocationTypeRequired
product_idpathstringYes

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Shopify connection from the Connection dropdown.
  3. In the Operation dropdown, select ecommerce.getProduct.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Shopify API reference.

GET /orders.json

List orders

DetailValue
Operation IDecommerce.listOrders
MethodGET
Path/orders.json

Parameters

NameLocationTypeRequired
statusquerystringNo
limitqueryintegerNo

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Shopify connection from the Connection dropdown.
  3. In the Operation dropdown, select ecommerce.listOrders.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Shopify API reference.

GET /orders/{order_id}.json

Get an order

DetailValue
Operation IDecommerce.getOrder
MethodGET
Path/orders/{order_id}.json

Parameters

NameLocationTypeRequired
order_idpathstringYes

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Shopify connection from the Connection dropdown.
  3. In the Operation dropdown, select ecommerce.getOrder.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Shopify API reference.

GET /customers.json

List customers

DetailValue
Operation IDecommerce.listCustomers
MethodGET
Path/customers.json

Parameters

NameLocationTypeRequired
limitqueryintegerNo

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Shopify connection from the Connection dropdown.
  3. In the Operation dropdown, select ecommerce.listCustomers.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Shopify API reference.

POST /customers.json

Create a customer

DetailValue
Operation IDecommerce.createCustomer
MethodPOST
Path/customers.json

Parameters

No parameters.

Request Body

FieldType
customerobject

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Shopify connection from the Connection dropdown.
  3. In the Operation dropdown, select ecommerce.createCustomer.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Shopify API reference.