MerchantHQ API
GET /2024-09/supplier-items
Default

Get the list of supplier items for a merchant.

Query parameters

  • merchant_id string(uuid) Required

    The UUID of the merchant to filter supplier items by

  • supplier_id string(uuid)

    Filter supplier items by supplier

  • q string

    A search query to filter supplier items by SKU or description

  • sku string

    Filter supplier items by exact SKU match

  • page integer

    The page number to retrieve

    Minimum value is 1.

  • per_page integer

    The number of results to return per page

    Minimum value is 1, maximum value is 100.

Responses

  • 200 application/json

    A successful response returning the list of supplier items

    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] Required

      Representation of a supplier item

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

        The UUID of the resource.

      • merchant_id string(uuid)

        The UUID of the merchant that owns this supplier item

      • supplier_id string(uuid)

        The UUID of the supplier for this supplier item

      • sku string | null

        Stock Keeping Unit - unique identifier for the product

        Maximum length is 255.

      • description string | null

        Description of the supplier item

      • identifiers array[object]

        Array of supplier item identifiers

        Representation of a supplier item identifier

        Hide identifiers attributes Show identifiers attributes object
        • id string(uuid)

          The UUID of the resource.

        • supplier_item_id string(uuid)

          The UUID of the supplier item this identifier belongs to

        • type string

          The type of identifier

          Values are UPC, EAN, GTIN, or ISBN.

        • value string

          The identifier value

        • created_at string(date-time)

          The date and time the resource was created.

        • updated_at string(date-time)

          The date and time the resource was last updated.

      • product_id string | null

        The UUID of the associated product

      • costs array[object]

        Cost tiers for different minimum order quantities

        Hide costs attributes Show costs attributes object
        • minimum_order_quantity integer Required

          Minimum order quantity for this cost tier

          Minimum value is 1.

        • cost object Required

          The cost of the item with currency

          Additional properties are NOT allowed.

          Hide cost attributes Show cost attributes object
          • value number Required

            The numeric value of the cost

            Minimum value is 0.

          • currency string Required

            The currency code (e.g., USD, EUR)

      • created_at string(date-time)

        The date and time the resource was created.

      • updated_at string(date-time)

        The date and time the resource was last updated.
  • 401 application/json

    The request requires user authentication or the user is not authorized to access this resource.

    Hide response attribute Show response attribute object
    • message string
  • 403 application/json

    Forbidden - The user does not have permission to access this resource.

    Hide response attribute Show response attribute object
    • message string Required
  • 404 application/json

    The specified resource was not found

    Hide response attribute Show response attribute object
    • message string
GET /2024-09/supplier-items 
curl \
 --request GET 'https://app.merchanthq.com/api/2024-09/supplier-items?merchant_id=1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4' \
 --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",
      "merchant_id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
      "supplier_id": "2e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
      "sku": "PROD-001",
      "description": "Blue widget with advanced features",
      "identifiers": [
        {
          "id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
          "supplier_item_id": "string",
          "type": "UPC",
          "value": "string",
          "created_at": "2025-01-10T10:37:11Z",
          "updated_at": "2025-01-10T10:37:11Z"
        }
      ],
      "product_id": "3e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
      "costs": [
        {
          "minimum_order_quantity": 1,
          "cost": {
            "value": 42.0,
            "currency": "string"
          }
        }
      ],
      "created_at": "2025-01-10T10:37:11Z",
      "updated_at": "2025-01-10T10:37:11Z"
    }
  ]
}
Response examples (401) 
{
  "message": "Unauthorized"
}
Response examples (403) 
{
  "message": "This action is unauthorized."
}
Response examples (404) 
{
  "message": "Not found"
}