1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Store
  4. Images

getImages

get

/ccstore/v1/images

Get Images. Gets an image and optionally resizes and converts it to a different format. Image resizing and conversion is not available for GIF source images. Endpoint responds with a content type of 'application/json' in error conditions, otherwise one of 'image/jpeg', 'image/png', or 'image/gif' depending on the source image and specified parameters.

Request

Supported Media Types
  • application/json
Query Parameters
alphaChannelColor
Type: string
The hex color code used to replace the transparency layer when converting images to JPEG. Default is FFFFFF.
height
Type: integer
The maximum height of the resized image. Required along with the 'width' parameter for the image to be resized.
outputFormat
Type: string
Output format of the converted image. JPEG is the only supported output format. When specified, the source image is converted to a JPEG except for GIF images which are not converted.
quality
Type: number
Quality of the image transformation: 0.0 (worst/fast) - 1.0 (best/slow). Default is 1.0.
source
Type: string
Required: true
The source location of the original image.
width
Type: integer
The maximum width of the resized image. Required along with the 'height' parameter for the image to be resized.

Response

Supported Media Types
  • image/jpeg
  • image/png
  • image/gif
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getImages_response
Default Response
The error response
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object