Load files

/files

Loads a list of abandoned checkout campaigns or information on a single campaign.

URL parameters

Parameters that you can append to the URL, for example: ?parameter=value

Title	Type	Description	Required?
page	int	Number of the page to load. Defaults to 1	No
size	int	Number of items per page. Defaults to 20	No

Response attributes

Attributes that you will receive in response from the endpoint in JSON format, for example:
{"id": 1,"title": "Campaign"}

Title	Type	Description	Required?
id	integer	File id	Yes
mime	bool	Whether this campaign is published or not	Yes
is_image	string	Title of the campaign	Yes
image_max_size_available	integer	Maximum available size constant, possible values: 0 - original 1 - tiny 2 - icon 3 - thumbnail 4 - mini 5 - small 6 - medium 7 - large 8 - jumbo 9 - full 10 - master	Yes
name	string	Name of the file	Yes
url	string	Relative path	Yes
size	integer	File size in bytes	Yes
image_width	integer	Image width	Yes
image_height	integer	Image height	Yes
theme_id	integer	ID of theme file was uploaded for	No
type	string	Type of file, possible values: thumbnails, product_images, variant_images, abandoned_email_logo, review_email_logo, review_image, collection_images, checkout_settings_logo, security_badge_images	Yes
full_url	string	Full url to this file	Yes

Sample request

GET https://mystore.commercehq.com/api/v1/files

Sample response

[
  {
    "id": 453,
    "mime": "image\/jpeg",
    "is_image": 1,
    "image_max_size_available": 8,
    "name": "perfectly-timed-cat-photos-funny-cover.jpg",
    "url": "uploads\/1497530431_03c309ebc4af299f4ab3572b2fc1005481571327.jpg",
    "size": 65206,
    "image_width": 750,
    "image_height": 420,
    "theme_id": null,
    "type": "files",
    "full_url": "https:\/\/s3-us-west-2.amazonaws.com\/commercehq-userfiles-dev\/commercehq-test\/uploads\/1497530431_03c309ebc4af299f4ab3572b2fc1005481571327.jpg"
  }
]