Update a product image

curl --request PATCH \
  --url https://sandboxapi.kelviq.com/api/v1/catalog/products/{product_pk}/image/{pk}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "primary-hero.png",
  "ordering": 1,
  "thumbnail": true,
  "enabled": true
}
'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/catalog/products/{product_pk}/image/{pk}/"

payload = {
    "name": "primary-hero.png",
    "ordering": 1,
    "thumbnail": True,
    "enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'primary-hero.png', ordering: 1, thumbnail: true, enabled: true})
};

fetch('https://sandboxapi.kelviq.com/api/v1/catalog/products/{product_pk}/image/{pk}/', 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://sandboxapi.kelviq.com/api/v1/catalog/products/{product_pk}/image/{pk}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'primary-hero.png',
    'ordering' => 1,
    'thumbnail' => true,
    'enabled' => true
  ]),
  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://sandboxapi.kelviq.com/api/v1/catalog/products/{product_pk}/image/{pk}/"

	payload := strings.NewReader("{\n  \"name\": \"primary-hero.png\",\n  \"ordering\": 1,\n  \"thumbnail\": true,\n  \"enabled\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://sandboxapi.kelviq.com/api/v1/catalog/products/{product_pk}/image/{pk}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"primary-hero.png\",\n  \"ordering\": 1,\n  \"thumbnail\": true,\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/catalog/products/{product_pk}/image/{pk}/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"primary-hero.png\",\n  \"ordering\": 1,\n  \"thumbnail\": true,\n  \"enabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "1f7e1b54-7c6f-4d7e-9a4f-2c9c2d8b9d31",
  "name": "hero-banner.png",
  "image": "media/.../products/<id>/<uuid>/hero-banner.png",
  "ordering": 0,
  "thumbnail": true,
  "enabled": true
}

PATCH

catalog

products

{product_pk}

image

{pk}

Update a product image

curl --request PATCH \
  --url https://sandboxapi.kelviq.com/api/v1/catalog/products/{product_pk}/image/{pk}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "primary-hero.png",
  "ordering": 1,
  "thumbnail": true,
  "enabled": true
}
'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/catalog/products/{product_pk}/image/{pk}/"

payload = {
    "name": "primary-hero.png",
    "ordering": 1,
    "thumbnail": True,
    "enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'primary-hero.png', ordering: 1, thumbnail: true, enabled: true})
};

fetch('https://sandboxapi.kelviq.com/api/v1/catalog/products/{product_pk}/image/{pk}/', 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://sandboxapi.kelviq.com/api/v1/catalog/products/{product_pk}/image/{pk}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'primary-hero.png',
    'ordering' => 1,
    'thumbnail' => true,
    'enabled' => true
  ]),
  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://sandboxapi.kelviq.com/api/v1/catalog/products/{product_pk}/image/{pk}/"

	payload := strings.NewReader("{\n  \"name\": \"primary-hero.png\",\n  \"ordering\": 1,\n  \"thumbnail\": true,\n  \"enabled\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://sandboxapi.kelviq.com/api/v1/catalog/products/{product_pk}/image/{pk}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"primary-hero.png\",\n  \"ordering\": 1,\n  \"thumbnail\": true,\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/catalog/products/{product_pk}/image/{pk}/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"primary-hero.png\",\n  \"ordering\": 1,\n  \"thumbnail\": true,\n  \"enabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "1f7e1b54-7c6f-4d7e-9a4f-2c9c2d8b9d31",
  "name": "hero-banner.png",
  "image": "media/.../products/<id>/<uuid>/hero-banner.png",
  "ordering": 0,
  "thumbnail": true,
  "enabled": true
}

Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.

Authorizations

Authorization

string

header

required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Path Parameters

product_pk

string<uuid>

required

Parent product UUID.

string<uuid>

required

Image UUID.

Body

application/json

Editable fields on a product image. The underlying file cannot be changed; upload a new image instead.

name

string

Display name.

Example:

"primary-hero.png"

ordering

integer

Position in the gallery.

Example:

1

thumbnail

boolean

If true, marks this image as the product thumbnail and unsets the flag on other images.

Example:

true

enabled

boolean

Example:

true

Response

Updated product image.

An image asset attached to a product.

string<uuid>

read-only

Unique identifier for the image.

Example:

"1f7e1b54-7c6f-4d7e-9a4f-2c9c2d8b9d31"

name

string | null

Original filename or display name.

Example:

"hero-banner.png"

image

string

read-only

Storage key / URL for the image asset.

Example:

"media/.../products/<id>/<uuid>/hero-banner.png"

ordering

integer

Position of the image in the gallery.

Example:

0

thumbnail

boolean

If true, this image is used as the product thumbnail.

Example:

true

enabled

boolean

If true, the image is shown publicly.

Example:

true

Get Started

API Documentation

Update a product image

Authorizations

Path Parameters

Body

Response