Images associated with a product.
This is archived documentation. The V2 Catalog API is deprecated. For current API documentation, see the Catalog API.
Gets the images associated with a product. (Default sorting is by image id, from lowest to highest.)
GET /stores/{store_hash}/v2/products/{product_id}/images
There are no filter parameters specific to product images.
Parameters can be added to the URL query string to paginate the collection. The maximum limit is 250. If a limit isn’t provided, up to 50 product_images are returned by default.
Example JSON returned in the response:
Gets a product image.
GET /stores/{store_hash}/v2/products/{product_id}/images/{id}
Example JSON returned in the response:
Gets a count of the number of product images in the store.
GET /stores/{store_hash}/v2/products/images/count
Example JSON returned in the response:
Creates a new product image.
POST /stores/{store_hash}/v2/products/{product_id}/images
The following properties of the product image are read-only. If one or more of these properties are included in the request, it will be rejected.
The following properties of the product image are required. The request won’t be fulfilled unless these properties are valid.
Example JSON returned in the response:
Updates an existing product image.
PUT /stores/{store_hash}/v2/products/{product_id}/images/{id}
The following properties of the product image are read-only. If one or more of these properties are included in the request, it will be rejected.
The following properties of the product image are required. The request won’t be fulfilled unless these properties are valid.
Example JSON returned in the response:
Deletes a product image.
DELETE /stores/{store_hash}/v2/products/{product_id}/images/{id}
Deletes multiple product images.
DELETE /stores/{store_hash}/v2/products/{product_id}/images
Parameters can be added to the URL query string to paginate the collection. The maximum limit is 250. If a limit isn’t provided, up to 50 product_images are returned by default.