Shopify

Learn how to use Shopify with Composio

Overview

SLUG

SHOPIFY

Description

Shopify is an e-commerce platform enabling merchants to create online stores, manage products, and process payments with themes, apps, and integrated marketing tools

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to read_products,write_products,read_orders,write_orders
bearer_token
string
subdomain
stringRequired
subdomain
stringRequired
generic_api_key
stringRequired

Tools

SLUG: SHOPIFY_COUNT_PRODUCT_IMAGES

Retrieves the total count of images for a shopify product, useful for inventory management or display logic; the provided `product id` must exist in the store.

Action Parameters

product_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_CREATE_CUSTOMER

Tool to create a new customer in shopify. use when you need to add a new customer record to the store.

Action Parameters

addresses
array
email
stringRequired
first_name
string
last_name
string
note
string
password
string
password_confirmation
string
phone
string
send_email_invite
boolean
send_email_welcome
booleanDefaults to True
tags
string
verified_email
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_CREATE_CUSTOM_COLLECTION

Creates a new custom collection in a shopify store, requiring a unique title for manually curated product groupings (e.g., 'new arrivals', 'seasonal specials').

Action Parameters

title
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_CREATE_ORDER

Creates a new order in shopify, typically requiring line items; if `customer id` is provided, it must correspond to an existing customer.

Action Parameters

currency
string
customer_id
string
line_items
array
total_tax
number
transactions
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_CREATE_PRODUCT

Creates a new product in a shopify store; a product title is generally required.

Action Parameters

body_html
string
product_type
string
title
string
variants
array
vendor
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_CREATE_PRODUCT_IMAGE

Tool to create a new product image for a given product. use when you need to add an image to a product by providing the image source url or attachment.

Action Parameters

image
objectRequired
product_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_GET_ALL_CUSTOMERS

Retrieves customer records from a shopify store, with options for filtering, selecting specific fields, and paginating through the results.

Action Parameters

created_at_max
string
created_at_min
string
fields
string
ids
array
limit
integerDefaults to 50
since_id
string
updated_at_max
string
updated_at_min
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_GET_CUSTOMER

Retrieves detailed information for a specific customer from a shopify store, provided their valid and existing `customer id`.

Action Parameters

customer_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_GET_SHOP_DETAILS

Retrieves comprehensive administrative information about the authenticated shopify store, as defined by the shopify api.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_ADD_PRODUCT_TO_COLLECTION

Adds a product to an existing *custom collection*, optionally specifying its `position` if the collection is manually sorted.

Action Parameters

collection_id
integerRequired
position
integer
product_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_DELETE_CUSTOM_COLLECTION

Permanently deletes a custom collection from a shopify store using its `collection id`; this action is irreversible and requires a valid, existing `collection id`.

Action Parameters

collection_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_DELETE_PRODUCT

Deletes a specific, existing product from a shopify store using its unique product id; this action is irreversible.

Action Parameters

id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_DELETE_PRODUCT_IMAGE

Deletes a specific image from a product in shopify, requiring the `product id` of an existing product and the `image id` of an image currently associated with that product.

Action Parameters

image_id
stringRequired
product_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_GET_COLLECTION_BY_ID

Retrieves a specific shopify collection by its `collection id`, optionally filtering returned data to specified `fields`.

Action Parameters

collection_id
stringRequired
fields
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_GET_COLLECTS

Retrieves a list of collects from a shopify store, where a collect links a product to a custom collection.

Action Parameters

fields
string
limit
integerDefaults to 50
since_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_GET_COLLECTS_COUNT

Retrieves the total count of collects (product-to-collection associations) in a shopify store.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_GET_CUSTOMER_ORDERS

Retrieves all orders for a specific, existing customer in shopify using their unique customer id.

Action Parameters

customer_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_GET_CUSTOM_COLLECTIONS

Retrieves a list of custom collections from a shopify store, optionally filtered by ids, product id, or handle.

Action Parameters

handle
string
ids
string
limit
integerDefaults to 50
product_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_GET_CUSTOM_COLLECTIONS_COUNT

Retrieves the total number of custom collections in a shopify store.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SHOPIFY_GET_ORDERSBY_ID

Retrieves a specific shopify order by its unique id, which must correspond to an existing order.

Action Parameters

fields
string
order_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired