{
  "openapi": "3.0.1",
  "info": {
    "title": "1688 Supplier Scraper: Factory Profiles & Products",
    "description": "Scrape 1688.com suppliers by shop link, shop ID or company name: company registration, founding year, shop ratings, factory card, shop metrics and hot offers. Optionally collect each supplier's products with tiered prices, MOQ, stock and sales. No contacts, no login.",
    "version": "0.1",
    "x-build-id": "Khbvcx0aS3ScjfzGN"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/theshark~1688-supplier-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-theshark-1688-supplier-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/theshark~1688-supplier-scraper/runs": {
      "post": {
        "operationId": "runs-sync-theshark-1688-supplier-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/theshark~1688-supplier-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-theshark-1688-supplier-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": {
          "suppliers": {
            "title": "Supplier shop links, shop IDs or company names",
            "type": "array",
            "description": "Get a profile row for each supplier (rowType \"supplier\"): company name, registration, shop header and ratings, factory card, shop metrics and the IDs of the shop's hot offers. Accepted: a shop link (https://shop....1688.com/ or https://<name>.1688.com/, any page of the shop), m.1688.com/winport/b2b-....html, winport.m.1688.com/...?memberId=b2b-..., a shop ID (b2b-...) or the exact company name. A product link is not a supplier and is skipped. One supplier profile found is billed as one supplier event; not found suppliers and errors are free. No contacts (phones, emails, WeChat, QQ, names) are collected.",
            "items": {
              "type": "string"
            }
          },
          "maxProductsPerSupplier": {
            "title": "Max products per supplier",
            "minimum": 0,
            "maximum": 1000,
            "type": "integer",
            "description": "How many products to scrape for each supplier. 0 (default) means only the supplier profile. Products come from a search by the exact company name, the factory card list (factories only) and the shop's hot and new offers. This is not the full catalog: 1688 closes it, and about 180-260 products per seller can be found. Each product is scraped as a normal product (full card, billed as a product) and carries the supplier in source. With 'Open product pages' off, products found by the company-name search come as cheaper search cards, but products without a search card (factory card list, hot and new offers) are still scraped from their product page and billed as a product.",
            "default": 0
          },
          "scrapeProductPages": {
            "title": "Open product pages",
            "type": "boolean",
            "description": "On (default): every supplier product is scraped from its own page, with the full set of fields. Off: products found by the company-name search are taken straight from the search results, which is much faster and cheaper (billed as the cheaper product-card event); such rows have the search-card fields (title, price tiers, image, seller, sales, trade scores). Products without a search card (factory card list, hot and new offers) are still scraped from their product page and billed as a product. Reviews, supplier intelligence and same items need product pages, so they are off in this mode.",
            "default": true
          },
          "includeSkuDetails": {
            "title": "Include SKU details",
            "type": "boolean",
            "description": "Add the full variant matrix: each variant with its options, price, stock and sales.",
            "default": false
          },
          "includeDescriptionHtml": {
            "title": "Include description HTML",
            "type": "boolean",
            "description": "Add the full product description as HTML. Description text and images are always included.",
            "default": false
          },
          "includeReviews": {
            "title": "Reviews per product",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "How many latest reviews to attach to each product (0 to 100). 1688 shows anonymous visitors only part of a product's reviews, so some products get fewer. Buyer names, avatars and profiles are never collected. Charged per review delivered.",
            "default": 0
          },
          "includeSupplierIntelligence": {
            "title": "Include supplier intelligence",
            "type": "boolean",
            "description": "Add a supplierIntelligence block to supplier rows and product rows: certificates (including CE/FCC/RoHS), customization (services with prices, printing price list, lead times by quantity), dropshipping metrics and the ranking on 1688. A supplier row takes them from the shop's hot offer; a product row also gets the factory card. Charged as an extra event per row only when at least part of this data is found. Always included for free: company registration, shop header and ratings, the factory card of supplier rows and shop metrics.",
            "default": false
          },
          "includeSameItems": {
            "title": "Include same items from other sellers",
            "type": "boolean",
            "description": "Add a sameItems list to each product: up to 8 offers of the same item from other sellers (title, price, sales text, image and link; no seller details). Billed as a same-items event only when the list is not empty. Needs product pages, so it is off when scrapeProductPages is false.",
            "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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}