Skip to main content
MerchantPro logo
  • Category: ecommerce
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: MERCHANTPRO
  • Version: 20261101_00

Tools

Slug: MERCHANTPRO_GET_INVENTORYReturn inventory and price information for one MerchantPro inventory unit. The unit may be a basic product or a variant.

Input Parameters

integer
required
Basic product or variant ID whose inventory and prices to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MERCHANTPRO_GET_PRODUCTReturn details for one MerchantPro product, including variant IDs when the product has variants.

Input Parameters

integer
required
Numeric product ID returned by List Products.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MERCHANTPRO_GET_SHOP_TAXONOMYReturn the shop’s currencies, languages, payment methods, or warehouses for interpreting catalog and order data. Language entries are normalized from locale-keyed objects into the same item list used by the other taxonomies.

Input Parameters

string ("currency" | "language" | "payment_method" | "warehouse")
required
Shop taxonomy to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MERCHANTPRO_LIST_CATALOG_PARTNERSList brands or suppliers used by the product catalog; choose one resource type per call.

Input Parameters

array
Return only these positive brand or supplier IDs.
integer
Maximum partners to return in this page (1-100).
Brand name or supplier lookup text. Uses the selected resource’s supported search filter.
string
Opaque cursor returned by a previous call for the same resource type and filters; omit for the first page.
string ("brand" | "supplier")
Catalog partner type to return. Choose brand or supplier; required on the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MERCHANTPRO_LIST_CATEGORIESFind product categories by ID, name, parent, type, or status for catalog navigation and product filtering. Returns one compact page and a continuation cursor.

Input Parameters

string
Filter categories by name.
integer
Maximum categories to return in this page (1-100).
string ("active" | "inactive")
Filter by category status.
integer
Return categories under this parent category ID; use 0 for roots when supported by the shop.
integer
Filter by category ID.
string
Cursor returned by a previous call; omit for the first page.
string ("static" | "dynamic" | "collection")
Filter by MerchantPro category type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MERCHANTPRO_LIST_CUSTOMERSFind customers by identity, group, status, registration, newsletter, or location filters. Returns a privacy-filtered page without identity numbers, bank data, full addresses, or social-login IDs.

Input Parameters

string ("date_created" | "date_created.desc" | "date_login" | "date_login.desc")
Customer sort order.
string
Filter by customer email address.
integer
Maximum customers to return in this page (1-100).
string ("awaiting" | "active" | "inactive" | "cancelled")
Filter by customer login status.
integer
Filter by customer group ID.
integer
Filter by customer ID.
string
Cursor returned by a previous call; omit for the first page.
boolean
Filter registered or guest customers.
integer
Filter by billing country ID.
boolean
Filter by newsletter subscription state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MERCHANTPRO_LIST_CUSTOMER_SUBSCRIPTIONSList recurring product subscriptions by customer, status, recurrence, type, or renewal date. The connected MerchantPro API user must have the customers_read permission.

Input Parameters

integer
Maximum subscriptions to return in this page (1-100).
string ("active" | "inactive")
Filter by subscription status.
string ("manual" | "auto")
Filter by renewal recurrence mode.
integer
Filter by customer ID.
string
Cursor returned by a previous call; omit for the first page.
string
Return subscriptions renewing exactly on this ISO date.
integer
Filter by subscription ID.
string
Return subscriptions whose next renewal is on or before this ISO date.
integer
Filter by subscription type ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MERCHANTPRO_LIST_LOCATIONSList countries, states, or cities for address and customer workflows; state and city searches require a parent country ID.

Input Parameters

integer
Maximum locations to return in this page (1-100).
integer
Parent state ID when listing cities.
integer
Parent country ID. Required when listing states or cities.
string
Opaque cursor returned by a previous call for the same location type and filters; omit for the first page.
string
Exact ISO alpha-2 code when listing countries.
string ("country" | "state" | "city")
Location level to return. Choose country, state, or city; required on the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MERCHANTPRO_LIST_ORDERSFind shop orders by customer, payment, shipping, product, or modification filters without changing order state. Returns compact summaries and omits addresses, phone numbers, payment details, bank data, notes, and device data.

Input Parameters

string ("date_created" | "date_created.desc" | "date_modified" | "date_modified.desc")
Order sort order.
integer
Maximum orders to return in this page (1-100).
integer
Filter by one order ID.
integer
Return orders containing this product ID.
integer
Filter by customer ID.
string
Cursor returned by a previous call; omit for the first page.
string
Filter by customer email address.
string
Return orders modified after this ISO 8601 date-time.
string ("temporary" | "awaiting" | "partially_paid" | "paid" | "failed" | "cancelled" | "refunded" | "rejected")
Filter by payment status.
string
Return orders modified before this ISO 8601 date-time.
string ("temporary" | "awaiting" | "confirmed" | "in_process" | "shipped" | "delivered" | "returned" | "cancelled")
Filter by shipping status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MERCHANTPRO_LIST_PRODUCTSFind shop catalog products using identity, category, brand, stock, visibility, and status filters, including variant ID and SKU filters. Returns product summaries; variant details may be absent.

Input Parameters

string
Filter by an exact product or variant SKU.
string ("availability" | "limited_stock" | "custom_order" | "date_created" | "date_created.desc" | "date_modified" | "date_modified.desc" | "discount" | "name" | "name.desc" | "newest" | "rank" | "price" | "price.desc" | "recommended" | "total_sales" | "total_sales.desc" | "best_seller" | "sales_30d" | "sales_30d.desc" | "sales_90d" | "sales_90d.desc" | "total_units_sold" | "total_units_sold.desc" | "wishlisted")
Product sort order; omit to use the MerchantPro default.
integer
Maximum products to return in this page (1-100).
string
Search across MerchantPro’s relevant product fields.
string ("active" | "inactive")
Filter by product status.
integer
Filter by brand ID.
integer
Return the product with this numeric ID.
integer
Return the product containing this numeric variant ID.
string ("visible" | "discontinued" | "hidden" | "bundle_only")
Filter by catalog visibility.
integer
Filter by category ID.
string
Cursor returned by a previous call; omit for the first page.
string ("listed" | "delisted" | "discontinued")
Filter by catalog listing status.
string ("in_stock" | "has_stock" | "real_stock" | "low_stock" | "out_of_stock")
Filter products by stock availability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not