---
canonical_url: "https://docs.composio.dev/toolkits/merchantpro"
markdown_url: "https://docs.composio.dev/toolkits/merchantpro.md"
product: "platform"
version: null
last_updated: null
---

# MerchantPro

MerchantPro is an eCommerce platform for managing storefront catalogs, customers, orders, inventory, content, and related commerce operations.

- **Category:** ecommerce
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `MERCHANTPRO`
- **Version:** 00000000_00

## Tools

### Get Inventory Unit

**Slug:** `MERCHANTPRO_GET_INVENTORY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inventory_unit_id` | integer | Yes | Basic product or variant ID whose inventory and prices to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product

**Slug:** `MERCHANTPRO_GET_PRODUCT`

Return details for one MerchantPro product, including variant IDs when the product has variants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | integer | Yes | Numeric product ID returned by List Products. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Shop Taxonomy

**Slug:** `MERCHANTPRO_GET_SHOP_TAXONOMY`

Return 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taxonomy_type` | string ("currency" | "language" | "payment_method" | "warehouse") | Yes | Shop taxonomy to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Catalog Partners

**Slug:** `MERCHANTPRO_LIST_CATALOG_PARTNERS`

List brands or suppliers used by the product catalog; choose one resource type per call.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Categories

**Slug:** `MERCHANTPRO_LIST_CATEGORIES`

Find 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customers

**Slug:** `MERCHANTPRO_LIST_CUSTOMERS`

Find 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Subscriptions

**Slug:** `MERCHANTPRO_LIST_CUSTOMER_SUBSCRIPTIONS`

List recurring product subscriptions by customer, status, recurrence, type, or renewal date. The connected MerchantPro API user must have the customers_read permission.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Locations

**Slug:** `MERCHANTPRO_LIST_LOCATIONS`

List countries, states, or cities for address and customer workflows; state and city searches require a parent country ID.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Orders

**Slug:** `MERCHANTPRO_LIST_ORDERS`

Find 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Products

**Slug:** `MERCHANTPRO_LIST_PRODUCTS`

Find products and variants in the shop catalog using common identity, category, brand, stock, visibility, and status filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sku` | string | No | Filter by an exact product or variant SKU. |
| `sort` | 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") | No | Product sort order; omit to use the MerchantPro default. |
| `limit` | integer | No | Maximum products to return in this page (1-100). |
| `search` | string | No | Search across MerchantPro's relevant product fields. |
| `status` | string ("active" | "inactive") | No | Filter by product status. |
| `brand_id` | integer | No | Filter by brand ID. |
| `product_id` | integer | No | Return the product with this numeric ID. |
| `variant_id` | integer | No | Return the product containing this numeric variant ID. |
| `visibility` | string ("visible" | "discontinued" | "hidden" | "bundle_only") | No | Filter by catalog visibility. |
| `category_id` | integer | No | Filter by category ID. |
| `next_cursor` | string | No | Cursor returned by a previous call; omit for the first page. |
| `listing_status` | string ("listed" | "delisted" | "discontinued") | No | Filter by catalog listing status. |
| `stock_availability` | string ("in_stock" | "has_stock" | "real_stock" | "low_stock" | "out_of_stock") | No | Filter products by stock availability. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |