{
  "openapi": "3.0.1",
  "info": {
    "title": "SHEIN Scraper - Products, Prices and Categories",
    "description": "Extract SHEIN products and categories from regional storefronts including the US, UK, Germany, France, and the Philippines. Get prices, images, sizes, colors, and available ratings; pay per delivered row plus a start fee.",
    "version": "0.2",
    "x-build-id": "G34bJiT1hOnhTJvZd"
  },
  "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": [
              "auto",
              "keywordSearch",
              "categorySearch",
              "productDetail",
              "categories"
            ],
            "type": "string",
            "description": "Choose keyword search, category listings, product details, or the category tree. Auto selects a mode from the target fields you fill.",
            "default": "auto"
          },
          "query": {
            "title": "Search query",
            "type": "string",
            "description": "Search phrase, such as linen dress. Ignored when keyword or keywords is filled."
          },
          "keywords": {
            "title": "Keywords (batch)",
            "type": "array",
            "description": "Search phrases to collect in one run; each has its own maxResults limit. If keyword is also set, it runs first.",
            "items": {
              "type": "string"
            }
          },
          "keyword": {
            "title": "Keyword (alias)",
            "type": "string",
            "description": "Alternative to query for one search phrase. Takes precedence over query when set."
          },
          "productUrl": {
            "title": "Product URL",
            "pattern": "^(?!.*[\\s\\\\\\x00-\\x1f\\x7f])(?:|(?:[hH][tT][tT][pP][sS]://(?:[A-Za-z0-9-]+\\.)*[sS][hH][eE][iI][nN]\\.[cC][oO][mM](?::(?:[0-9]{1,4}|[0-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?/|(?!//)(?![A-Za-z][A-Za-z0-9+.-]*:))[^?#]*-p-[0-9]+(?:-[^?#]*|\\.html[^?#]*)?(?:[?#].*)?)$",
            "type": "string",
            "description": "SHEIN HTTPS product page containing -p-<number>.html, or a relative product path. Use a current product URL for the chosen region."
          },
          "goodsId": {
            "title": "Goods ID",
            "pattern": "^([0-9]+)?$",
            "type": "string",
            "description": "Numeric SHEIN product identifier, also found after -p- in a product URL."
          },
          "categoryUrl": {
            "title": "Category URL",
            "pattern": "^(?!.*[\\s\\\\\\x00-\\x1f\\x7f])(?:[hH][tT][tT][pP][sS]://(?:[A-Za-z0-9-]+\\.)*[sS][hH][eE][iI][nN]\\.[cC][oO][mM](?::(?:[0-9]{1,4}|[0-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?(?:[/?#].*)?|(?!//)(?![A-Za-z][A-Za-z0-9+.-]*:).*)$",
            "type": "string",
            "description": "SHEIN HTTPS category or promotion URL, or a relative path. Use a current address from the selected storefront."
          },
          "catId": {
            "title": "Category ID",
            "pattern": "^([0-9]+)?$",
            "type": "string",
            "description": "Numeric SHEIN category identifier, such as 2223. Category IDs can differ by region or change over time."
          },
          "categorySlug": {
            "title": "Category slug",
            "type": "string",
            "description": "Category address slug, such as Women-Tops. Pair it with catId or choose a known bucket."
          },
          "bucket": {
            "title": "Vertical bucket",
            "type": "string",
            "description": "Category shortcut such as women, men, kids, shoes, beauty, sale, new, or just-for-you. In categories mode, it narrows the category tree."
          },
          "region": {
            "title": "Region subdomain",
            "pattern": "^([A-Za-z]{2,6})?$",
            "type": "string",
            "description": "SHEIN storefront code, such as us, uk, de, fr, ph, or au. Defaults to the US storefront when omitted."
          },
          "browseCountry": {
            "title": "Browse country (alias)",
            "type": "string",
            "description": "Country alias that overrides region when set. For example, US selects us, GB selects uk, and PH selects ph."
          },
          "currency": {
            "title": "Currency hint",
            "type": "string",
            "description": "Optional currency hint, such as USD, PHP, or EUR. Availability depends on the selected storefront."
          },
          "maxResults": {
            "title": "Max results per input",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Maximum delivered and billed rows per keyword; category, product, and category-tree requests each count as one input. Default 70; larger requests continue in parts of up to 70, within the run cost limit and the Free-plan cap of 200 rows per run.",
            "default": 70
          },
          "sort": {
            "title": "Sort",
            "enum": [
              "",
              "recommend",
              "sales",
              "price_asc",
              "price_desc",
              "newest"
            ],
            "type": "string",
            "description": "Listing order: recommended, sales, ascending price, descending price, or newest. An empty value uses the site order."
          },
          "minPrice": {
            "title": "Min price",
            "minimum": 0,
            "type": "number",
            "description": "Minimum listing price in the selected local currency. Must not exceed maxPrice."
          },
          "maxPrice": {
            "title": "Max price",
            "minimum": 0,
            "type": "number",
            "description": "Maximum listing price in the selected local currency. Must not be below minPrice."
          },
          "color": {
            "title": "Color filter",
            "type": "string",
            "description": "Optional color filter value from the selected SHEIN storefront. Accepted values can vary by category."
          },
          "size": {
            "title": "Size filter",
            "type": "string",
            "description": "Optional size filter value from the selected SHEIN storefront. Accepted values can vary by category."
          },
          "refine": {
            "title": "Additional filters",
            "type": "string",
            "description": "Optional SHEIN filter expression, when known. Leave empty if you do not have a category-specific value."
          },
          "enrichDetails": {
            "title": "Add product details",
            "type": "boolean",
            "description": "Add available product details, such as sizes, images, and USD prices, to listing rows. Enabled by default; enrichment updates existing rows without a separate row charge.",
            "default": true
          },
          "enrichLimit": {
            "title": "Detail enrichment limit",
            "minimum": 0,
            "maximum": 50,
            "type": "integer",
            "description": "Maximum listing rows to enrich, from 0 to 50. Defaults to 3; unavailable details remain missing.",
            "default": 3
          },
          "includeReviews": {
            "title": "Include reviews",
            "type": "boolean",
            "description": "Include available review samples when collecting product details or enriching listings. Off by default; samples stay inside product rows and are not the full review history.",
            "default": false
          },
          "expandColors": {
            "title": "Expand colors",
            "type": "boolean",
            "description": "Add color-product rows from available variants when room remains within maxResults. Off by default; each added row is billed, and its details may be reused from the parent product.",
            "default": false
          },
          "page": {
            "title": "Start page",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Starting listing page, from 1 to 100. Later pages may be unavailable or return fewer products.",
            "default": 1
          },
          "maxPages": {
            "title": "Max pages",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Legacy page-count setting. It is not a reliable stopping limit for Actor runs; use maxResults and Maximum cost per run to bound collection.",
            "default": 1
          },
          "pageRetry": {
            "title": "Page retry",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Page retry setting, from 1 to 5, for unavailable or empty listing pages. A retry does not guarantee additional rows.",
            "default": 1
          },
          "forceSuggest": {
            "title": "Alternate search option",
            "type": "boolean",
            "description": "Request an alternate SHEIN search option on listing pages after the first. Leave off unless needed for your search.",
            "default": false
          },
          "workerBaseUrl": {
            "title": "Developer testing",
            "type": "string",
            "description": "Leave empty. Used only by the developer for testing."
          }
        }
      },
      "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}