Skip to main content
PUT
/
api
/
v1
/
merchants
/
{merchant_id}
/
collections
/
{collection_id}
/
products
/
{main_product_id}
/
images
Update Collection Product Images Endpoint
curl --request PUT \
  --url https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id}/products/{main_product_id}/images \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "main_image_url": "<string>",
  "hover_image_url": "<string>",
  "video": {}
}
'
import requests

url = "https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id}/products/{main_product_id}/images"

payload = {
"main_image_url": "<string>",
"hover_image_url": "<string>",
"video": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({main_image_url: '<string>', hover_image_url: '<string>', video: {}})
};

fetch('https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id}/products/{main_product_id}/images', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id}/products/{main_product_id}/images",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'main_image_url' => '<string>',
'hover_image_url' => '<string>',
'video' => [

]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id}/products/{main_product_id}/images"

payload := strings.NewReader("{\n \"main_image_url\": \"<string>\",\n \"hover_image_url\": \"<string>\",\n \"video\": {}\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id}/products/{main_product_id}/images")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"main_image_url\": \"<string>\",\n \"hover_image_url\": \"<string>\",\n \"video\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id}/products/{main_product_id}/images")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"main_image_url\": \"<string>\",\n \"hover_image_url\": \"<string>\",\n \"video\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "main_product_id": "<string>",
  "collection_id": "<string>",
  "product_ids": [
    "<string>"
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

merchant_id
string
required
collection_id
string<uuid>
required
main_product_id
string
required

Body

application/json
main_image_url
string | null
hover_image_url
string | null
video
Video · object | null

Response

Successful Response

main_product_id
string
required
collection_id
string
required
product_ids
string[]
required