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

# Pricemend

Pricemend provides retailer return-policy data, country consumer-rights coverage, policy search, and return-deadline calculations.

- **Category:** commerce
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 9
- **Triggers:** 0
- **Slug:** `PRICEMEND`
- **Version:** 00000000_00

## Tools

### Calculate Policy Deadline

**Slug:** `PRICEMEND_CALCULATE_POLICY_DEADLINE`

Calculate the deadline and applicable remedy for a purchase under a retailer policy, including whether the deadline has expired.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `member` | boolean | No | Whether to apply an eligible member-specific policy window. |
| `channel` | string | No | Purchase channel used when applying the policy; online is the documented default. |
| `retailer_id` | string | Yes | Pricemend retailer identifier returned by SEARCH_RETAILERS, such as office_depot. |
| `purchase_date` | string | Yes | Purchase date in YYYY-MM-DD form. |

#### 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 |

### Download Policy Dataset

**Slug:** `PRICEMEND_DOWNLOAD_POLICY_DATASET`

Download Pricemend's complete policy corpus as a bounded JSON file for bulk ingestion, optionally restricted to a country. This is not an interactive policy lookup; use focused policy read actions for individual retailers and decisions. The connected account requires a separate Pricemend dataset licence beyond ordinary Policy API access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | No | Country code used to restrict the separately licensed dataset; omit for the complete licensed corpus. This filter does not grant dataset access, and Pricemend publishes no fixed enum or format constraint. |

#### 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 Policy Coverage

**Slug:** `PRICEMEND_GET_COVERAGE`

Show Pricemend corpus coverage, supported countries, price-checkable stores, review date, and confidence definitions.

#### 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 Retailer Policy

**Slug:** `PRICEMEND_GET_RETAILER_POLICY`

Get one retailer's policy, optionally selecting a product category, including all category windows, or returning the draft UCP representation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category` | string | No | Product category whose specific policy window to select; omit for the retailer's default policy. |
| `retailer_id` | string | Yes | Pricemend retailer identifier returned by SEARCH_RETAILERS or LIST_RETAILERS. |
| `response_format` | string ("standard" | "ucp") | No | Response representation: standard returns the full Pricemend policy; ucp returns the draft dev.ucp.shopping.policy.return representation with Pricemend provenance. |
| `include_categories` | boolean | No | Whether to include the retailer's complete category-window table. |

#### 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 API Usage

**Slug:** `PRICEMEND_GET_USAGE`

Return plan, activity status, expiry, and daily and monthly call usage for the connected Pricemend licence key.

#### 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 Covered Countries

**Slug:** `PRICEMEND_LIST_COUNTRIES`

List countries covered by Pricemend with locale, currency, store count, statutory consumer rights, sources, and review date.

#### 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 Price Adjustment Policies

**Slug:** `PRICEMEND_LIST_PRICE_ADJUSTMENT_POLICIES`

List retailer price-adjustment outcomes, including stores that refund a post-purchase price difference and stores where the remedy is returning and rebuying, optionally narrowed by country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | No | Country code used to narrow results; omit for all covered countries. Pricemend publishes no fixed enum or format constraint. |

#### 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 Retailer Policies

**Slug:** `PRICEMEND_LIST_RETAILERS`

List retailer policies, optionally filtering by country, remedy, confidence, or live-price availability; returns the complete matching set in one response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `remedy` | string | No | Policy remedy to match; documented examples include adjust and return. |
| `country` | string | No | Two-letter country code to filter retailers, such as US or GB; omit to include all covered countries. |
| `confidence` | string | No | Provenance confidence to match; documented values include confirmed, declared, archived, no_window_published, statutory, sourced, unsourced, and unchecked. |
| `price_checkable` | boolean | No | Set true for stores with live price checking or false for stores without it; omit for either. |

#### 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 |

### Search Retailers

**Slug:** `PRICEMEND_SEARCH_RETAILERS`

Resolve a human-entered retailer name to Pricemend retailer identifiers, optionally narrowed to a country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Retailer name or search text to resolve, such as Office Depot. |
| `country` | string | No | Two-letter country code used to narrow matches; omit to search all covered countries. |

#### 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 |
