SalesChannelProductImage

Retrieve a product image

get

Retrieves a specific product image associated with a sales channel.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Product image

application/json

Represents an image associated with a product, used for display in sales channels or internal listings.

pkintegerRead-onlyOptional

Unique identifier for the product image.

productintegerOptional

ID of the associated product.

sourcestring · enum · nullableOptional

The source of the image (e.g., 'unified').

Possible values:

modified_datestring · date-timeOptional

The date and time when the image was last modified.

created_datestring · date-timeRead-onlyOptional

The date and time when the image was created.

heightinteger · nullableOptional

Height of the image in pixels.

widthinteger · nullableOptional

Width of the image in pixels.

hashstring · nullableOptional

A hash of the image content used for deduplication or versioning.

statusstring · enumOptional

Status of the image (e.g., active). Read-only.

Possible values:

is_activebooleanOptional

Indicates whether the image is currently active and should be used.

orderintegerOptional

Display order for the image among other images of the same product.

object_idintegerOptional

ID of the target object this configuration applies to.

content_typestringOptional

The model name of the target object's content type.

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/product_images/{id}/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_images/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "product": 1,
  "source": "unified",
  "modified_date": "2026-03-06T21:01:00.678Z",
  "created_date": "2026-03-06T21:01:00.678Z",
  "height": 1,
  "width": 1,
  "hash": "text",
  "status": "active",
  "is_active": true,
  "order": 1,
  "object_id": 1,
  "content_type": "text"
}

Retrieve a product image with details

get

Get details of a specific product image associated with a sales channel.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Product image with details

application/json

Represents an image associated with a product, used for display in sales channels or internal listings.

pkintegerRead-onlyOptional

Unique identifier for the product image.

productintegerOptional

ID of the associated product.

sourcestring · enum · nullableOptional

The source of the image (e.g., 'unified').

Possible values:

modified_datestring · date-timeOptional

The date and time when the image was last modified.

created_datestring · date-timeRead-onlyOptional

The date and time when the image was created.

heightinteger · nullableOptional

Height of the image in pixels.

widthinteger · nullableOptional

Width of the image in pixels.

hashstring · nullableOptional

A hash of the image content used for deduplication or versioning.

statusstring · enumOptional

Status of the image (e.g., active). Read-only.

Possible values:

is_activebooleanOptional

Indicates whether the image is currently active and should be used.

orderintegerOptional

Display order for the image among other images of the same product.

object_idintegerOptional

ID of the target object this configuration applies to.

content_typestringOptional

The model name of the target object's content type.

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/product_images/{id}/detailed/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_images/{id}/detailed/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "product": 1,
  "source": "unified",
  "modified_date": "2026-03-06T21:01:00.678Z",
  "created_date": "2026-03-06T21:01:00.678Z",
  "height": 1,
  "width": 1,
  "hash": "text",
  "status": "active",
  "is_active": true,
  "order": 1,
  "object_id": 1,
  "content_type": "text"
}

List product images

get

Retrieve a list of product images associated with a specific sales channel.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

productinteger · int64Optional

Filter by Product ID.

Example: 123

product__pk__ininteger[]Optional

Filter by multiple primary keys (comma-separated).

id__ininteger[]Optional

Filters by multiple ids (comma-separated list of integers)

is_seller_productbooleanOptional

Filter by seller product status (True or False).

product_typearray · enumOptional

Filter by product type.

Possible values:

Responses

200

List of product images

application/json

countintegerOptional

Total number of items

nextstring · nullableOptional

URL for next page

previousstring · nullableOptional

URL for previous page

get

/api/v1/channel/{channel_id}/product_images/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_images/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

List of product images

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 1,
      "product": 1,
      "source": "unified",
      "modified_date": "2026-03-06T21:01:00.678Z",
      "created_date": "2026-03-06T21:01:00.678Z",
      "height": 1,
      "width": 1,
      "hash": "text",
      "status": "active",
      "is_active": true,
      "order": 1,
      "object_id": 1,
      "content_type": "text"
    }
  ]
}

List product images with details

get

Retrieve a detailed list of product images associated with a specific sales channel.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

Responses

200

List of product images

application/json

countintegerOptional

Total number of items

nextstring · nullableOptional

URL for next page

previousstring · nullableOptional

URL for previous page

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/product_images/detailed/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_images/detailed/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 1,
      "product": 1,
      "source": "unified",
      "modified_date": "2026-03-06T21:01:00.678Z",
      "created_date": "2026-03-06T21:01:00.678Z",
      "height": 1,
      "width": 1,
      "hash": "text",
      "status": "active",
      "is_active": true,
      "order": 1,
      "object_id": 1,
      "content_type": "text"
    }
  ]
}

List product images to insert

get

Retrieve a list of product images that are pending insertion into the system.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

Responses

200

List of product images to insert

application/json

Represents an image associated with a product, used for display in sales channels or internal listings.

pkintegerRead-onlyOptional

Unique identifier for the product image.

productintegerOptional

ID of the associated product.

sourcestring · enum · nullableOptional

The source of the image (e.g., 'unified').

Possible values:

modified_datestring · date-timeOptional

The date and time when the image was last modified.

created_datestring · date-timeRead-onlyOptional

The date and time when the image was created.

heightinteger · nullableOptional

Height of the image in pixels.

widthinteger · nullableOptional

Width of the image in pixels.

hashstring · nullableOptional

A hash of the image content used for deduplication or versioning.

statusstring · enumOptional

Status of the image (e.g., active). Read-only.

Possible values:

is_activebooleanOptional

Indicates whether the image is currently active and should be used.

orderintegerOptional

Display order for the image among other images of the same product.

object_idintegerOptional

ID of the target object this configuration applies to.

content_typestringOptional

The model name of the target object's content type.

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/product_images/inserts/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_images/inserts/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "pk": 1,
    "product": 1,
    "source": "unified",
    "modified_date": "2026-03-06T21:01:00.678Z",
    "created_date": "2026-03-06T21:01:00.678Z",
    "height": 1,
    "width": 1,
    "hash": "text",
    "status": "active",
    "is_active": true,
    "order": 1,
    "object_id": 1,
    "content_type": "text"
  }
]

List product images to update

get

Retrieve a list of product images that are pending updates in the system.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

Responses

200

List of product images to update

application/json

Represents an image associated with a product, used for display in sales channels or internal listings.

pkintegerRead-onlyOptional

Unique identifier for the product image.

productintegerOptional

ID of the associated product.

sourcestring · enum · nullableOptional

The source of the image (e.g., 'unified').

Possible values:

modified_datestring · date-timeOptional

The date and time when the image was last modified.

created_datestring · date-timeRead-onlyOptional

The date and time when the image was created.

heightinteger · nullableOptional

Height of the image in pixels.

widthinteger · nullableOptional

Width of the image in pixels.

hashstring · nullableOptional

A hash of the image content used for deduplication or versioning.

statusstring · enumOptional

Status of the image (e.g., active). Read-only.

Possible values:

is_activebooleanOptional

Indicates whether the image is currently active and should be used.

orderintegerOptional

Display order for the image among other images of the same product.

object_idintegerOptional

ID of the target object this configuration applies to.

content_typestringOptional

The model name of the target object's content type.

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/product_images/updates/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_images/updates/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "pk": 1,
    "product": 1,
    "source": "unified",
    "modified_date": "2026-03-06T21:01:00.678Z",
    "created_date": "2026-03-06T21:01:00.678Z",
    "height": 1,
    "width": 1,
    "hash": "text",
    "status": "active",
    "is_active": true,
    "order": 1,
    "object_id": 1,
    "content_type": "text"
  }
]

List product images to insert or update

get

Retrieve a list of product images that are pending either insertion or updates in the system.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

Responses

200

List of product images to insert or update

application/json

Represents an image associated with a product, used for display in sales channels or internal listings.

pkintegerRead-onlyOptional

Unique identifier for the product image.

productintegerOptional

ID of the associated product.

sourcestring · enum · nullableOptional

The source of the image (e.g., 'unified').

Possible values:

modified_datestring · date-timeOptional

The date and time when the image was last modified.

created_datestring · date-timeRead-onlyOptional

The date and time when the image was created.

heightinteger · nullableOptional

Height of the image in pixels.

widthinteger · nullableOptional

Width of the image in pixels.

hashstring · nullableOptional

A hash of the image content used for deduplication or versioning.

statusstring · enumOptional

Status of the image (e.g., active). Read-only.

Possible values:

is_activebooleanOptional

Indicates whether the image is currently active and should be used.

orderintegerOptional

Display order for the image among other images of the same product.

object_idintegerOptional

ID of the target object this configuration applies to.

content_typestringOptional

The model name of the target object's content type.

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/product_images/inserts_or_updates/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_images/inserts_or_updates/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "pk": 1,
    "product": 1,
    "source": "unified",
    "modified_date": "2026-03-06T21:01:00.678Z",
    "created_date": "2026-03-06T21:01:00.678Z",
    "height": 1,
    "width": 1,
    "hash": "text",
    "status": "active",
    "is_active": true,
    "order": 1,
    "object_id": 1,
    "content_type": "text"
  }
]