{
"openapi": "3.0.1",
"info": {
"title": "ShopBack Scraper & Affiliate Network Detector",
"description": "Detect a brand's active affiliate network via ShopBack click-out, and/or scrape ShopBack merchant page details (cashback rates, terms, vouchers). Mode-selectable per run.",
"version": "0.1",
"x-build-id": "KXNQvSpfC7xpeJLnT"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/automation_craft~affiliate-network-detector/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-automation_craft-affiliate-network-detector",
"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/automation_craft~affiliate-network-detector/runs": {
"post": {
"operationId": "runs-sync-automation_craft-affiliate-network-detector",
"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/automation_craft~affiliate-network-detector/run-sync": {
"post": {
"operationId": "run-sync-automation_craft-affiliate-network-detector",
"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": [
"targets"
],
"properties": {
"mode": {
"title": "What to extract",
"enum": [
"affiliate",
"details",
"both"
],
"type": "string",
"description": "affiliate = detect the active affiliate network via click-out; details = scrape the ShopBack merchant page; both = do both in one page load.",
"default": "affiliate"
},
"targets": {
"title": "Targets",
"type": "array",
"description": "Each target's 'input' is EITHER a company domain (e.g. 2xu.com) OR a ShopBack URL (e.g. shopback.com.au/2xu). Auto-detected and normalized. 'brand' is optional but improves domain->ShopBack resolution. 'rowNumber' is carried through untouched for sheet mapping.",
"items": {
"type": "object",
"properties": {
"input": {
"title": "Input",
"type": "string",
"description": "Company domain or ShopBack URL."
},
"brand": {
"title": "Brand",
"type": "string",
"description": "Optional. Improves slug construction / search matching."
},
"rowNumber": {
"title": "Row number",
"type": "integer",
"description": "Optional pass-through for sheet mapping."
}
},
"required": [
"input"
]
}
},
"region": {
"title": "ShopBack region",
"enum": [
"au",
"sg",
"my",
"global"
],
"type": "string",
"description": "Which ShopBack storefront to use when resolving domains.",
"default": "au"
},
"maxConcurrency": {
"title": "Max concurrency",
"minimum": 1,
"maximum": 50,
"type": "integer",
"description": "Maximum parallel targets.",
"default": 5
},
"shopbackSessionCookie": {
"title": "ShopBack session cookie (affiliate / both modes)",
"type": "string",
"description": "Needed only for affiliate / both modes — ShopBack shows the click-out that reveals the affiliate network only when logged in. details mode needs no cookie. To get it (2 minutes, once): 1. Log in to shopback.com.au in Chrome. 2. Install the free Cookie-Editor extension. 3. On the ShopBack tab, open Cookie-Editor → Export → JSON (copies to clipboard). 4. Paste the JSON here. It must include the sbrefresh cookie (it will, if you're logged in). Stored encrypted, never logged. The session self-refreshes as long as you run the Actor regularly (e.g. a weekly schedule); if it ever dies, results say auth_expired — just re-paste."
},
"forceBrowser": {
"title": "Force browser path",
"type": "boolean",
"description": "Skip the HTTP fast path and always use the Playwright browser path. (Reserved: the HTTP fast path is enabled post-recon once a replayable click-out / JSON detail endpoint is confirmed.)",
"default": false
}
}
},
"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
}
}
}
}
}
}
}
}
}
}