MerchantHQ API
PUT /2024-09/supplier-items/{supplier_item}
Default

Update the specified supplier item's information

Path parameters

  • supplier_item string(uuid) Required

    The UUID of the supplier item

application/json

Body Required

  • description string | null

    Description of the supplier item

  • 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)

Responses

  • 204

    Empty response with no content

  • 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
PUT /2024-09/supplier-items/{supplier_item} 
curl \
 --request PUT 'https://app.merchanthq.com/api/2024-09/supplier-items/1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"description":"Blue widget with advanced features","product_id":"3e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4","costs":[{"minimum_order_quantity":1,"cost":{"value":42.0,"currency":"string"}}]}'
Request examples 
{
  "description": "Blue widget with advanced features",
  "product_id": "3e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
  "costs": [
    {
      "minimum_order_quantity": 1,
      "cost": {
        "value": 42.0,
        "currency": "string"
      }
    }
  ]
}
Response examples (401) 
{
  "message": "Unauthorized"
}
Response examples (403) 
{
  "message": "This action is unauthorized."
}
Response examples (404) 
{
  "message": "Not found"
}