{
  "openapi": "3.0.1",
  "info": {
    "title": "SHEIN Product Scraper | Prices SKUs Global",
    "description": "Scrape SHEIN regional storefronts — keyword search, category PLP & PDP across US, UK, EU, Asia & more. Extract goods_id, local+USD prices, SKUs, colors, images, ratings. Export Excel/CSV/JSON for fashion market research & price monitoring.",
    "version": "0.1",
    "x-build-id": "HPTKaB68t9MiKklWr"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/lentic_clockss~shein-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-lentic_clockss-shein-scraper",
        "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/lentic_clockss~shein-scraper/runs": {
      "post": {
        "operationId": "runs-sync-lentic_clockss-shein-scraper",
        "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/lentic_clockss~shein-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-lentic_clockss-shein-scraper",
        "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",
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "keywordSearch",
              "categorySearch",
              "productDetail",
              "categories"
            ],
            "type": "string",
            "description": "keywordSearch / categorySearch / productDetail / categories.",
            "default": "keywordSearch"
          },
          "region": {
            "title": "Region subdomain",
            "type": "string",
            "description": "SHEIN host prefix: us, ph, uk, de, fr, mx, br, au, … (maps to https://{region}.shein.com).",
            "default": "us"
          },
          "browseCountry": {
            "title": "Browse country (alias)",
            "type": "string",
            "description": "Optional ISO-2 alias (US→us, GB→uk, PH→ph)."
          },
          "currency": {
            "title": "Currency hint",
            "type": "string",
            "description": "Optional currency override (e.g. USD, PHP, EUR)."
          },
          "query": {
            "title": "Search query",
            "type": "string",
            "description": "Keyword for keywordSearch. Console Test prefills a short US query so Start works without extra fields.",
            "default": "dress"
          },
          "keyword": {
            "title": "Keyword (alias)",
            "type": "string",
            "description": "Alias of query."
          },
          "keywords": {
            "title": "Keywords (batch)",
            "type": "array",
            "description": "Optional list of keywords; worker runs each until maxResults.",
            "items": {
              "type": "string"
            }
          },
          "categorySlug": {
            "title": "Category slug",
            "type": "string",
            "description": "URL slug before -c-{id}, e.g. Women-Tops. Prefer with catId or use bucket."
          },
          "catId": {
            "title": "Category ID",
            "type": "string",
            "description": "Numeric cat id (e.g. 2223 for Women-Tops). Sample IDs may drift by region."
          },
          "categoryUrl": {
            "title": "Category URL",
            "type": "string",
            "description": "Full or path category / RecommendSelection / sale / new URL."
          },
          "bucket": {
            "title": "Vertical bucket",
            "type": "string",
            "description": "Shortcut vertical: women, men, kids, shoes, beauty, sale, new, just-for-you, …"
          },
          "productUrl": {
            "title": "Product URL",
            "type": "string",
            "description": "PDP URL containing -p-{goods_id}.html."
          },
          "goodsId": {
            "title": "Goods ID",
            "type": "string",
            "description": "Numeric SHEIN goods_id."
          },
          "sort": {
            "title": "Sort",
            "enum": [
              "",
              "recommend",
              "sales",
              "price_asc",
              "price_desc",
              "newest"
            ],
            "type": "string",
            "description": "Listing sort: recommend, sales, price_asc, price_desc, newest (mapped to SHEIN query)."
          },
          "minPrice": {
            "title": "Min price",
            "minimum": 0,
            "type": "number",
            "description": "Local-currency min price filter for listings."
          },
          "maxPrice": {
            "title": "Max price",
            "minimum": 0,
            "type": "number",
            "description": "Local-currency max price filter for listings."
          },
          "color": {
            "title": "Color filter",
            "type": "string",
            "description": "Optional color refine token (site-specific)."
          },
          "size": {
            "title": "Size filter",
            "type": "string",
            "description": "Optional size refine token."
          },
          "refine": {
            "title": "Raw refine",
            "type": "string",
            "description": "Pass-through refine/attr query fragment when known."
          },
          "forceSuggest": {
            "title": "Force suggest",
            "type": "boolean",
            "description": "Force SHEIN suggest/search variant when enabled.",
            "default": false
          },
          "page": {
            "title": "Start page",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Listing start page (page>1 may hit risk/challenge).",
            "default": 1
          },
          "maxPages": {
            "title": "Max pages",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Max listing pages to fetch.",
            "default": 1
          },
          "maxResults": {
            "title": "Max results",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Cap on dataset rows. Free plan capped at 200. Store Test default is 1.",
            "default": 1
          },
          "enrichDetails": {
            "title": "Enrich with PDP",
            "type": "boolean",
            "description": "For list modes, fetch PDP gbRawData for enrichLimit items. Default ON: enrich is what carries full product detail + lead fields.",
            "default": true
          },
          "enrichLimit": {
            "title": "Enrich limit",
            "minimum": 0,
            "maximum": 50,
            "type": "integer",
            "description": "Max listing rows to enrich with PDP (SKU/images/USD/reviews).",
            "default": 3
          },
          "includeReviews": {
            "title": "Include reviews",
            "type": "boolean",
            "description": "When enriching or on PDP, attach soft review snippets from modules if present.",
            "default": false
          },
          "expandColors": {
            "title": "Expand colors",
            "type": "boolean",
            "description": "Follow color variants into additional PDP fetches (costly).",
            "default": false
          },
          "pageRetry": {
            "title": "Page retry",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Retries per listing page on challenge/empty.",
            "default": 1
          },
          "workerBaseUrl": {
            "title": "Worker base URL override",
            "type": "string",
            "description": "Optional HTTPS Cloud Run origin (allowlisted). Prefer Actor env WORKER_BASE_URL."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}