{ "openapi": "3.0.1", "info": { "title": "๐Ÿ›’ Product Matcher - Cross-Retailer Matching, No Shared SKU", "description": "๐Ÿ”— Match the SAME physical product across retailers/marketplaces, no shared SKU. โœ… Brand/model/pack/size extraction, unit canonicalisation, blocking. โš ๏ธ Different pack count or size never match, even on near-identical titles.", "version": "1.0", "x-build-id": "8510ttYM6bwgc9KTc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/that_red_bird~product-matcher/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-that_red_bird-product-matcher", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/that_red_bird~product-matcher/runs": { "post": { "operationId": "runs-sync-that_red_bird-product-matcher", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/that_red_bird~product-matcher/run-sync": { "post": { "operationId": "run-sync-that_red_bird-product-matcher", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "sources" ], "properties": { "sources": { "title": "Product lists to match", "type": "array", "description": "Two or more retailer/marketplace product lists. Each entry is { \"name\": \"storeA\", \"records\": [ {...} ] } and/or { \"name\": \"storeB\", \"datasetId\": \"abc123\" } โ€” inline records and a dataset ID may be combined on the same source. Every record is a flat object; useful fields are title (or name), brand, model/mpn/sku, gtin/ean/upc/asin, packCount, size (or capacity/weight/volume), color. Any of these are optional โ€” whatever is missing is parsed out of the title instead.", "default": [ { "name": "storeA", "records": [ { "title": "Sony WH-1000XM4 Wireless Noise Cancelling Headphones, Black - Best Seller!", "brand": "Sony", "gtin": "027242920404" }, { "title": "CeraVe Moisturizing Cream, 16 oz - Free Shipping", "brand": "CeraVe" }, { "title": "Bounty Paper Towels, 2-Ply, 6 Pack" } ] }, { "name": "storeB", "records": [ { "title": "Sony WH-1000XM4 Black Bluetooth Headphones (Free Shipping)", "brand": "Sony", "gtin": "027242920404" }, { "title": "CeraVe Moisturizing Cream 19 oz Jar", "brand": "CeraVe" }, { "title": "Bounty Paper Towels, 2-Ply, 12 Pack - Hot Deal" } ] } ] }, "matchThreshold": { "title": "Match threshold (0-100)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Pairs scoring at or above this are auto-matched. Higher = fewer false matches, more missed pairs. Expressed 0-100; 85 means 0.85. Ignored when GTIN/EAN/UPC/ASIN agree (instant match) or disagree (instant non-match).", "default": 85 }, "reviewThreshold": { "title": "Review threshold (0-100)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Pairs scoring between this and the match threshold are reported for human review instead of being auto-matched. A confidently wrong match is worse than one that needs a human glance.", "default": 65 }, "maxBlockSize": { "title": "Max block size", "minimum": 10, "maximum": 20000, "type": "integer", "description": "Blocks larger than this (e.g. thousands of listings sharing one generic brand) are skipped to avoid an O(nยฒ) blowup. Other blocking keys still get their chance.", "default": 1000 }, "compareWithinSource": { "title": "Also compare listings within the same source", "type": "boolean", "description": "By default only listings from DIFFERENT sources are compared (that is the point of cross-retailer matching). Turn this on to also catch duplicate listings inside one source's own list.", "default": false }, "weights": { "title": "Scoring weight overrides", "type": "object", "description": "Override the default evidence weights, e.g. {\"brand\":3,\"title\":2,\"size\":2,\"pack\":1,\"colour\":1}. Higher weight = that field's agreement counts for more in the blended score. Model/part-number exact match and GTIN agreement are handled separately and are not affected by these weights." }, "outputMode": { "title": "Output mode", "enum": [ "matches", "clusters" ], "type": "string", "description": "matches = one row per matched pair with confidence and evidence ยท clusters = one row per distinct product with every matching listing grouped together (useful with 3+ sources).", "default": "matches" }, "includeReviewPairs": { "title": "Include review-band pairs", "type": "boolean", "description": "Emit pairs that scored between reviewThreshold and matchThreshold, with their evidence, so a human can decide.", "default": true }, "includeUnmatched": { "title": "Include unmatched items", "type": "boolean", "description": "Emit listings from each source that were never matched to anything, so you know what still needs manual mapping.", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }