← All action domains

Shopify

10 operations. Call each with POST https://app.chirply.io/api/v1/actions/<name> and a bearer token; the response is { "data": { "action", "summary", "result" } }. A read badge means the operation changes nothing; write requires the credential’s write scope.

Connect Shopify

shopify.connectreadadmin only

Get the browser link that starts connecting a Shopify store to this account — the machine-surface equivalent of the Connect Shopify button on Settings → Integrations → Shopify. An account manager must open the link signed in (with this account active in their browser) and approve the app install in Shopify's own consent screen; the store's OAuth grant then lands in whichever account their session has active. This call itself changes nothing, installs nothing, and does not contact Shopify.

Parameters

FieldTypeRequiredDescription
shopstringrequiredThe store's myshopify.com domain, e.g. 'acme' or 'acme.myshopify.com' (a URL is accepted and normalized).

Example

curl -X POST https://app.chirply.io/api/v1/actions/shopify.connect \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "shop": "example"
  }'
Test with your API key

Over MCP the same operation is the tool shopify_connect at https://app.chirply.io/api/mcp, same bearer token, same input.

List abandoned Shopify checkouts

shopify.list_abandoned_checkoutsread

List synchronized Shopify checkouts that were abandoned or later recovered, including customer linkage, cart value, recovery URL, and timestamps. This reads protected customer commerce data and does not send recovery messages.

Parameters

FieldTypeRequiredDescription
limitintegeroptionalMax rows to return (1–100). Default: 25
offsetintegeroptionalRows to skip. Default: 0
store_idstring (uuid)optionalOnly records belonging to this connected Shopify store id.
contact_idstring (uuid)optionalOnly checkouts linked to this contact id.

Example

curl -X POST https://app.chirply.io/api/v1/actions/shopify.list_abandoned_checkouts \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'
Test with your API key

Over MCP the same operation is the tool shopify_list_abandoned_checkouts at https://app.chirply.io/api/mcp, same bearer token, same input.

List Shopify collections

shopify.list_collectionsread

List Shopify collections synchronized into this account for catalog segmentation and automation filtering. This is read-only and does not change collection membership in Shopify.

Parameters

FieldTypeRequiredDescription
limitintegeroptionalMax rows to return (1–100). Default: 25
offsetintegeroptionalRows to skip. Default: 0
store_idstring (uuid)optionalOnly records belonging to this connected Shopify store id.
querystringoptionalMatch collection title or handle.

Example

curl -X POST https://app.chirply.io/api/v1/actions/shopify.list_collections \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'
Test with your API key

Over MCP the same operation is the tool shopify_list_collections at https://app.chirply.io/api/mcp, same bearer token, same input.

List Shopify customers

shopify.list_customersread

List Shopify customer commerce profiles synchronized into this account, including CRM contact linkage, order count, spend, tags, and marketing-consent states. This reads protected customer data but does not contact anyone.

Parameters

FieldTypeRequiredDescription
limitintegeroptionalMax rows to return (1–100). Default: 25
offsetintegeroptionalRows to skip. Default: 0
store_idstring (uuid)optionalOnly records belonging to this connected Shopify store id.
querystringoptionalMatch customer name or email.

Example

curl -X POST https://app.chirply.io/api/v1/actions/shopify.list_customers \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'
Test with your API key

Over MCP the same operation is the tool shopify_list_customers at https://app.chirply.io/api/mcp, same bearer token, same input.

List Shopify orders

shopify.list_ordersread

List orders synchronized from connected Shopify stores, including customer linkage, totals, refunds, payment state, fulfillment state, and attribution fields. This does not modify, fulfill, cancel, or refund any order.

Parameters

FieldTypeRequiredDescription
limitintegeroptionalMax rows to return (1–100). Default: 25
offsetintegeroptionalRows to skip. Default: 0
store_idstring (uuid)optionalOnly records belonging to this connected Shopify store id.
contact_idstring (uuid)optionalOnly orders linked to this contact id.
financial_statusstringoptionalOnly orders with this Shopify financial status.
fulfillment_statusstringoptionalOnly orders with this Shopify fulfillment status.
querystringoptionalMatch order name, order number, or customer email.

Example

curl -X POST https://app.chirply.io/api/v1/actions/shopify.list_orders \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'
Test with your API key

Over MCP the same operation is the tool shopify_list_orders at https://app.chirply.io/api/mcp, same bearer token, same input.

List Shopify privacy requests

shopify.list_privacy_requestsreadadmin only

List mandatory Shopify customer data access and erasure requests with their due dates and completion states. Protected payloads are not returned. This is read-only and restricted to account administrators.

Parameters

FieldTypeRequiredDescription
limitintegeroptionalMax rows to return (1–100). Default: 25
offsetintegeroptionalRows to skip. Default: 0
status"pending" | "completed" | "failed"optionalOnly requests in this processing state.

Example

curl -X POST https://app.chirply.io/api/v1/actions/shopify.list_privacy_requests \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'
Test with your API key

Over MCP the same operation is the tool shopify_list_privacy_requests at https://app.chirply.io/api/mcp, same bearer token, same input.

List Shopify products

shopify.list_productsread

List products synchronized from connected Shopify stores with their status, vendor, type, tags, and storefront URL. This does not change Shopify inventory or product listings.

Parameters

FieldTypeRequiredDescription
limitintegeroptionalMax rows to return (1–100). Default: 25
offsetintegeroptionalRows to skip. Default: 0
store_idstring (uuid)optionalOnly records belonging to this connected Shopify store id.
statusstringoptionalOnly products with this Shopify status, such as ACTIVE, DRAFT, or ARCHIVED.
querystringoptionalMatch product title, vendor, or product type.

Example

curl -X POST https://app.chirply.io/api/v1/actions/shopify.list_products \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'
Test with your API key

Over MCP the same operation is the tool shopify_list_products at https://app.chirply.io/api/mcp, same bearer token, same input.

List Shopify refunds

shopify.list_refundsread

List full and partial Shopify refunds synchronized into this account, including order and contact linkage and refunded value. This is read-only and never issues or changes a refund.

Parameters

FieldTypeRequiredDescription
limitintegeroptionalMax rows to return (1–100). Default: 25
offsetintegeroptionalRows to skip. Default: 0
store_idstring (uuid)optionalOnly records belonging to this connected Shopify store id.
contact_idstring (uuid)optionalOnly refunds linked to this contact id.

Example

curl -X POST https://app.chirply.io/api/v1/actions/shopify.list_refunds \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'
Test with your API key

Over MCP the same operation is the tool shopify_list_refunds at https://app.chirply.io/api/mcp, same bearer token, same input.

List Shopify stores

shopify.list_storesreadadmin only

List Shopify stores connected to this account, including connection, import, and webhook health. This only reads stored connection metadata and does not call Shopify or spend money.

Parameters

FieldTypeRequiredDescription
limitintegeroptionalMax rows to return (1–100). Default: 25
offsetintegeroptionalRows to skip. Default: 0

Example

curl -X POST https://app.chirply.io/api/v1/actions/shopify.list_stores \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'
Test with your API key

Over MCP the same operation is the tool shopify_list_stores at https://app.chirply.io/api/mcp, same bearer token, same input.

Sync Shopify store

shopify.sync_storewriteconfirmadmin only

Fetch the next resumable batch of customers, products, orders, and abandoned checkouts from one connected Shopify store into this account. It reads from Shopify and changes nothing in the store, but IT WRITES TO THIS CRM AND CAN TEXT OR EMAIL REAL SHOPPERS. Every Shopify customer it sees is created as a CRM contact, or, when one already matches by email or phone, that existing contact's name, email, phone and lifecycle are OVERWRITTEN with Shopify's values. Once the first full pass has finished, every subsequent call reconciles recently abandoned checkouts and runs this account's 'Shopify checkout abandoned' automations for each newly abandoned cart — so any cart-recovery workflow sends real SMS/email to real shoppers, billed to its own Twilio/Mailgun account. Check those automations before running this on a store you have not synced before.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

FieldTypeRequiredDescription
store_idstring (uuid)requiredThe connected Shopify store id to synchronize.

Example

curl -X POST https://app.chirply.io/api/v1/actions/shopify.sync_store \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "store_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'
Test with your API key

Over MCP the same operation is the tool shopify_sync_store at https://app.chirply.io/api/mcp, same bearer token, same input.

The machine-readable version of this page is GET https://app.chirply.io/api/v1/actions?domain=shopify — same operations, with full JSON Schemas. Authentication, errors and rate limits are covered in the API documentation home.