comecerodocs
Images

List images

GET
/images

Returns your images, oldest first unless you choose another sort_by. Secret and trusted tokens may call it.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Query Parameters

offset?integer

For offset-based lists, how many items to skip before the page starts. Use next_page_offset or previous_page_offset from the page you have. A value that is not a whole number is a 400.

Range0 <= value
Default0
limit?integer

How many items to return on one page, from 1 to 100. The default is 100. A value outside 1 to 100, or one that is not a whole number, is a 400.

Range1 <= value <= 100
Default100
sort_by?string

The field to sort by. The default is date_created.

Value in"date_created""date_modified""filename"
desc?boolean

Sort in descending order (newest, largest or last first) when true. The default is false. A value other than true or false is a 400.

Defaultfalse
show?string

Comma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

hide?string

Comma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse
q?string

Search text. An exact image id returns that image; otherwise images whose file name contains the text (any case) are returned.

Response Body

A page of images.

application/json
  1. response

A page of images. An offset-based list.

total_items*integer

The number of items that match, across all pages.

total_pages*integer

The number of pages.

current_page*integer

The number of this page.

next_page_url*|

The URL of the next page, or null on the last page.

Formaturi
next_page_offset*|

The offset of the next page, or null on the last page.

previous_page_url*|

The URL of the previous page, or null on the first page.

Formaturi
previous_page_offset*|

The offset of the previous page, or null on the first page.

current_page_url*string

The URL of this page.

Formaturi
data*array<>

The items on this page.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/images'
Example Response
{  "total_items": 1,  "total_pages": 1,  "current_page": 1,  "next_page_url": null,  "next_page_offset": null,  "previous_page_url": null,  "previous_page_offset": null,  "current_page_url": "https://api.comecero.com/api/v1/images?offset=0",  "data": [    {      "object": "image",      "url": "https://api.comecero.com/api/v1/images/0099844605810ImLAMbo73",      "image_id": "0099844605810ImLAMbo73",      "date_created": "2026-11-02T14:36:45Z",      "date_modified": "2026-11-02T14:36:45Z",      "test": true,      "account_id": "AB1234",      "link": "https://cdn.comecero.net/AB1234/0099844605810ImLAMbo73/widget.png",      "link_small": "https://cdn.comecero.net/AB1234/0099844605810ImLAMbo73/sm_widget.png",      "link_medium": "https://cdn.comecero.net/AB1234/0099844605810ImLAMbo73/md_widget.png",      "link_large": "https://cdn.comecero.net/AB1234/0099844605810ImLAMbo73/lg_widget.png",      "link_square": "https://cdn.comecero.net/AB1234/0099844605810ImLAMbo73/sq_widget.png",      "filename": "widget.png"    }  ]}

Overview

Previous Page

Upload an image POST

Uploads an image and makes small, medium, large and square copies of it on the CDN. The body must be `multipart/form-data` with the image in a part named `file`; a JSON body is refused with `400`. There is no way to upload an image from a URL. Use the `image_id` in a product's `image_ids`. Images cannot be changed after upload; upload a new one instead. Secret and trusted tokens may call it.