Jump to

• Request
• Response

Get an image

get

/ccstore/v1/images

Retrieves an image from a given source URL. Optionally, it can resize and convert the image to a different image format, .jpeg, .png, or gif.

To resize an image, both the width and the height parameters must be specified.

The maximum height and width allowed is 5000 pixels.

If either of these parameters, width or height, is excluded from the endpoint call, the source image is returned without transformation.

Note: Resizing and conversion are not supported for source GIF images.

The endpoint responds with a content type of 'application/json' in error conditions or 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: string
  The hex color code used to replace the transparency layer when converting images to JPEG. Default is FFFFFF.
• height: integer
  The maximum height of the resized image. Required along with the 'width' parameter for the image to be resized.
• outputFormat: 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: number
  Quality of the image transformation: 0.0 (worst/fast) - 1.0 (best/slow). Default is 1.0.
• source(required): string
  The source location of the original image.
• width: integer
  The maximum width of the resized image. Required along with the 'height' parameter for the image to be resized.

Back to Top

Response

Supported Media Types

• image/jpeg
• image/png
• image/gif

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : getImages_200_response

Show Source

{
    "properties":{
    }
}

401 Response

Returned when running in preview mode and the user is not authenticated.

Body ()

Root Schema : getImages_401_response

Type: object

Show Source

• errorCode: string
  00001000
• message: string
  The user is not authenticated.
• status: string
  401

{
    "properties":{
        "errorCode":{
            "description":"00001000",
            "type":"string"
        },
        "message":{
            "description":"The user is not authenticated.",
            "type":"string"
        },
        "status":{
            "description":"401",
            "type":"string"
        }
    }
}

404 Response

Source image is not found

Body ()

Root Schema : getImages_404_response

Type: object

Show Source

• message: string
  HTTP 404 Not Found
• status: string
  404

{
    "properties":{
        "message":{
            "description":"HTTP 404 Not Found",
            "type":"string"
        },
        "status":{
            "description":"404",
            "type":"string"
        }
    }
}

429 Response

There is currently not enough processing capacity when trying to resize an image. Try again later or reduce the size of the image

Body ()

Root Schema : getImages_429_response

Type: object

Show Source

• message: string
  Explanation message stating processing capacity exceeded.
• status: string
  The HTTP status code.

{
    "properties":{
        "message":{
            "description":"Explanation message stating processing capacity exceeded.",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code.",
            "type":"string"
        }
    }
}

Default Response

The following internal error codes are thrown by this API when the request fails in Commerce:

Error Code	Description	Possible Fix
26200	Failure resizing image.	See error messages for more information.

The error response:

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top