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

Get a paginated list of supplier scraping requests for a specific supplier

Path parameters

  • supplier string(uuid) Required

    The supplier ID

Query parameters

  • page integer

    Page number

    Minimum value is 1. Default value is 1.

  • per_page integer

    Number of items per page

    Minimum value is 1, maximum value is 100. Default value is 15.

  • status string

    Filter by request status

    Values are pending, approved, completed, or rejected.

Responses

  • 200 application/json

    Supplier scraping requests retrieved successfully

    Hide response attributes Show response attributes object
    • links object
      Hide links attributes Show links attributes object
      • first string
      • last string
      • prev string | null
      • next string | null
    • meta object
      Hide meta attributes Show meta attributes object
      • current_page integer
      • from integer | null
      • last_page integer
      • path string
      • per_page integer
      • to integer | null
      • total integer
    • data array[object]
      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
GET /2024-09/suppliers/{supplier}/scraping-requests 
curl \
 --request GET 'https://app.merchanthq.com/api/2024-09/suppliers/{supplier}/scraping-requests' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "links": {
    "first": "https://app.merchanthq.com/api/2024-09/merchants?page=1",
    "last": "https://app.merchanthq.com/api/2024-09/merchants?page=10",
    "prev": "https://app.merchanthq.com/api/2024-09/merchants?page=1",
    "next": "https://app.merchanthq.com/api/2024-09/merchants?page=3"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "path": "https://app.merchanthq.com/api/2024-09/merchants",
    "per_page": 10,
    "to": 10,
    "total": 20
  },
  "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"
    }
  ]
}