MerchantHQ API
POST /2024-09/products/{product}/images
Default

Add a new image to a product

application/json

Body Required

  • url string(uri) Required

    The URL of the image to download and store

Responses

  • 201 application/json

    A successful response returning the created product image

    Hide response attribute Show response attribute object
    • data object

      Representation of a product image

      Additional properties are NOT allowed.

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

        The UUID of the resource.

      • product_id string(uuid)

        The UUID of the product this image belongs to

      • public_url string(uri)

        The publicly accessible URL for the image

      • 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
POST /2024-09/products/{product}/images 
curl \
 --request POST 'https://app.merchanthq.com/api/2024-09/products/{product}/images' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"url":"https://example.com/product-image.jpg"}'
Request examples 
{
  "url": "https://example.com/product-image.jpg"
}
Response examples (201) 
{
  "data": {
    "id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
    "product_id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
    "public_url": "https://cdn.merchanthq.com/products/1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4/image1.jpg",
    "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"
}