MerchantHQ API
POST /2024-09/suppliers/{supplier}/scraping-requests
Default

Create a new supplier scraping request for a supplier

Path parameters

  • supplier string(uuid) Required

    The supplier ID

application/json

Body Required

  • data_source_description string Required

    Description of how to get the data for this supplier

  • url_for_scraping string(uri) Required

    URL to scrape for sourcing opportunities

  • authentication_method string Required

    Authentication method required for scraping

    Values are none, username_password, api_token, or other.

  • authentication_description string

    Description of how to authenticate

  • username string

    Username for authentication

  • password string

    Password for authentication

  • api_token string

    API token for authentication

Responses

  • 201 application/json

    Supplier scraping request created successfully

    Hide response attribute Show response attribute object
    • data object

      Additional properties are NOT allowed.

      Hide data attributes Show data attributes object
      • id string(uuid) Required

        The UUID of the resource.

      • supplier_id string(uuid) Required

        The UUID of the resource.

      • data_source_description string Required

        User description of how to get the data for this supplier

      • url_for_scraping string(uri) Required

        URL to scrape for sourcing opportunities

      • authentication_method string Required

        Authentication method required for scraping

        Values are none, username_password, api_token, or other.

      • authentication_description string | null

        User description of how to authenticate

      • approved_at string | null

        When the request was approved by an administrator

      • completed_at string | null

        When the scraping configuration was completed

      • rejected_at string | null

        When the request was rejected by an administrator

      • developer_notes string | null

        Developer notes explaining approval/rejection/completion

      • created_at string(date-time) Required

        The date and time the resource was created or updated.

      • updated_at string(date-time) Required

        The date and time the resource was created or updated.
  • 401
  • 403
  • 422
POST /2024-09/suppliers/{supplier}/scraping-requests 
curl \
 --request POST 'https://app.merchanthq.com/api/2024-09/suppliers/{supplier}/scraping-requests' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"data_source_description":"string","url_for_scraping":"https://example.com","authentication_method":"none","authentication_description":"string","username":"string","password":"string","api_token":"string"}'
Request examples 
{
  "data_source_description": "string",
  "url_for_scraping": "https://example.com",
  "authentication_method": "none",
  "authentication_description": "string",
  "username": "string",
  "password": "string",
  "api_token": "string"
}
Response examples (201) 
{
  "data": {
    "id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
    "supplier_id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
    "data_source_description": "string",
    "url_for_scraping": "https://example.com",
    "authentication_method": "none",
    "authentication_description": "string",
    "approved_at": "string",
    "completed_at": "string",
    "rejected_at": "string",
    "developer_notes": "string",
    "created_at": "2025-01-10T10:37:11Z",
    "updated_at": "2025-01-10T10:37:11Z"
  }
}