Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Retrieve a special image

Returns a single special image by its identifier.

get
/special_image/{id}/
Authorizations
AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Path parameters
idintegerRequired

The unique identifier of the special image.

Responses
200

The requested special image.

application/json

A special image record — marks one of a product's images with a specific role.

pkintegerRead-onlyRequired

Unique identifier of the special image.

productintegerRequired

Identifier of the product the image belongs to.

product_imageintegerRequired

Identifier of the underlying product image that is being flagged.

image_typestring · enumRequired

The role a special image plays for its product. Each type is unique per product.

  • base — the product's primary/base image
  • swatch — a color or material swatch image
  • listing — the image used in product listings
  • picto — a pictogram / icon image
Possible values:
get/special_image/{id}/
GET /api/v1/remote/1/special_image/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "pk": 12,
  "product": 340,
  "product_image": 981,
  "image_type": "base"
}

Last updated

Was this helpful?