# Macys Reviews Scraper (`pintostudio/macys-reviews-scraper`) Actor

This API retrieves data from macys product Reviews

- **URL**: https://apify.com/pintostudio/macys-reviews-scraper.md
- **Developed by:** [Pinto Studio](https://apify.com/pintostudio) (community)
- **Categories:** E-commerce
- **Stats:** 3 total users, 1 monthly users, 90.4% runs succeeded, 2 bookmarks
- **User rating**: No ratings yet

## Pricing

from $5.00 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Macy's Reviews Scraper

Extract customer reviews and review metadata for a Macy's product using its product ID. The Actor returns Macy's native review payload, including pagination information and review fields such as rating, title, text, recommendation status, author, submission date, feedback counts, locale, and photo flags.

### What this Actor does

- Fetches reviews for one Macy's product per run.
- Supports a region and currency so the request matches the intended Macy's market context.
- Lets you control how many reviews Macy's returns in the response.
- Can request reviews with photos via `withImage`.
- Writes one structured item to the default dataset and also stores the same payload in the `OUTPUT` key-value-store record.

### Quick start

1. Open the Actor in Apify Console.
2. Enter the Macy's `productId` (the numeric ID in a Macy's product URL).
3. Optionally set the currency, region, result limit, and photo filter.
4. Click **Start**.
5. When the run succeeds, open **Output** to inspect or export the JSON.

Example input:

```json
{
  "productId": "27024288",
  "currencyCode": "USD",
  "regionCode": "US",
  "limit": "50",
  "withImage": "false"
}
```

### Input

| Field | Type | Required | Default | Description |
|---|---|---:|---|---|
| `productId` | string | Yes | Example: `27024288` | Macy's product ID. Use the numeric identifier from the product page URL. |
| `currencyCode` | string | No | `USD` | Currency code sent to Macy's, normally an ISO 4217 code such as `USD`. |
| `regionCode` | string | No | `US` | Region code sent to Macy's, normally a two-letter country/region code such as `US`. |
| `limit` | string | No | `50` | Maximum number of reviews requested in the returned page. |
| `withImage` | string | No | `false` | Set to the string `true` to request the photo-review view; otherwise use `false`. |

All input values are currently strings. For API calls, do not send `limit` or `withImage` as JSON numbers/booleans.

### Output

Each run pushes one item to the default dataset. The item preserves Macy's response structure rather than flattening every review into a separate dataset row.

The tested example returned this shape:

```json
[
  {
    "productReviews": [
      {
        "productId": 27024288,
        "reviewFamilyProducts": [27024288],
        "paginatedReviews": {
          "total": 96,
          "limit": 50,
          "offset": 0,
          "reviews": [
            {
              "reviewId": 305891389,
              "productId": 27024288,
              "authorId": "...",
              "userNickname": "Sandra",
              "ratingsOnly": false,
              "rating": 1,
              "ratingRange": 5,
              "recommended": false,
              "title": "...",
              "reviewText": "...",
              "totalFeedbackCount": 1,
              "totalPositiveFeedbackCount": 1,
              "totalNegativeFeedbackCount": 0,
              "featured": false,
              "contentLocale": "en_US",
              "hasPhotos": false,
              "topContributor": false,
              "anonymous": false,
              "syndicated": false,
              "submissionTime": "Aug 19, 2026",
              "incentivizedReview": false
            }
          ]
        }
      }
    ]
  }
]
```

Macy's may add, remove, or vary fields between products and reviews. Integrations should tolerate optional fields and use `paginatedReviews.reviews` as the review list.

### Run with the Apify API

Replace `APIFY_TOKEN` with your token:

```bash
curl -X POST \
  'https://api.apify.com/v2/acts/pintostudio~macys-reviews-scraper/run-sync-get-dataset-items?token=APIFY_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "productId": "27024288",
    "currencyCode": "USD",
    "regionCode": "US",
    "limit": "50",
    "withImage": "false"
  }'
```

For asynchronous workflows, start the Actor with the standard Apify run endpoint, wait for the run to finish, then read items from the run's default dataset.

### Guidance for AI agents

Treat the Actor as a single-product review lookup tool.

1. Extract a numeric Macy's product ID from the user's product URL or ask for it if missing.
2. Send input values as strings.
3. Use `US` and `USD` unless the user specifies another market.
4. Read reviews from `productReviews[].paginatedReviews.reviews`.
5. Read the available review count from `productReviews[].paginatedReviews.total`.
6. Do not assume every review contains text, photos, recommendation status, or author data.
7. If the required volume is greater than the returned review list, report the returned count honestly; this Actor currently exposes a limit but no offset input.
8. Preserve attribution and comply with applicable laws, Macy's terms, and privacy requirements when storing or publishing review content.

### Storage

- **Dataset:** one item containing the complete Macy's review response.
- **Key-value store:** record named `OUTPUT`, shaped as `{ "productReview": <response> }`.

### Troubleshooting

- **No reviews:** verify the product ID and confirm that the product has reviews on Macy's.
- **Unexpected market data:** check `regionCode` and `currencyCode`.
- **Fewer reviews than expected:** compare the returned array length with `paginatedReviews.total`; the Actor requests only one page.
- **Run fails:** retry once. Macy's upstream response and network availability can change; persistent failures should be reported with the run ID and log excerpt.

### Notes and limitations

- One product is processed per run.
- The Actor returns one page of reviews and does not currently expose an offset/page input.
- Output follows Macy's upstream schema and can change without notice.
- This Actor is an independent tool and is not affiliated with or endorsed by Macy's.

### Support

When reporting a problem, include the Apify run ID, product ID, region code, and a short description of the expected versus actual result. Do not post API tokens or other secrets.

# Actor input Schema

## `productId` (type: `string`):

The Product ID

## `currencyCode` (type: `string`):

The currency code

## `regionCode` (type: `string`):

The region code

## `limit` (type: `string`):

The limit parameter

## `withImage` (type: `string`):

Include images

## Actor input object example

```json
{
  "productId": "27024288",
  "currencyCode": "USD",
  "regionCode": "US",
  "limit": "50",
  "withImage": "false"
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "productId": "27024288"
};

// Run the Actor and wait for it to finish
const run = await client.actor("pintostudio/macys-reviews-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "productId": "27024288" }

# Run the Actor and wait for it to finish
run = client.actor("pintostudio/macys-reviews-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "productId": "27024288"
}' |
apify call pintostudio/macys-reviews-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,pintostudio/macys-reviews-scraper"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/tu80qJ70tdeLFyZaq/builds/wbFtxlWjHK20Ri59j/openapi.json