Retrieve Images

Returns images for the Inventory

Overview

The Retrieve Content Images request is designed to provide partners with access to images associated with the Inventory. This request enables the Agent to retrieve images for either the entire inventory or a specific unit.

Endpoints Available

Method	Endpoint	Description
GET	v2023.07.31/content/images	Returns content images for Inventory
GET	v2023.07.31/content/images/{unitId}	Returns content images for a Unit in Inventory

Path Parameters

Path Parameter	Required / Optional	Description
{unitId}	Required	Unique Identifier for Unit in Inventory

Query String Parameters

Parameter	Required / Optional	Description	Data Type
page	Optional	The page to be shown	int
pageSize	Optional	Limits the number of returned results	int
lastUpdateDate	Optional	Only return objects which have been modified after a certain date	date-time
mcUserId	Optional	Unique Identifier for Supplier	int
mcUserIds	Optional	Unique Identifiers for Suppliers	array
unitId	Optional	Unique Identifier for Unit in Inventory	int
unitIds	Optional	Unique Identifier for Units in Inventory	array
channel	Optional	Leave empty for general, "airbnb" for airbnb, "vrbo" for vrbo and "bdc" for bdc	string

Response Definition

Response Item	Description	Data Type
`"units"`	An array containing information about different Units. Each element in the array represents unique Unit details associated with the Units Images	array

`"units"` Object

Response Item	Description	Data Type
`"unit_id"`	The unique identifier for the Unit	int
`"images"`	An array containing details about images associated with the Unit	array

`"images"` Object

Response Item	Description	Data Type
`"image_id"`	The unique identifier for the image	int
`"sort_order"`	The value representing the order of the image in a sequence or gallery	int
`"resource"`	The URL that points to the location of the image resource	string
`"tag"`	A tag or label associated with the image, providing additional context or description	string

Sample Request

curl --request GET \
     --url 'https://api.ciiruspartners.com/v2023.07.31/content/images?page=1&pageSize=50'

Sample Response

{
    "units": [
        {
            "unit_id": 219266,
            "images": [
                {
                    "image_id": 1413710,
                    "sort_order": 1,
                    "resource": "https://cdn.ciirus.com/properties/42334/219266/images/download(1).jpg",
                    "tag": "download(1)"
                },
              ...
              ]
              ...
            }
    ],
    "next_page_url": "https://api.ciiruspartners.com/v20230731/content/images?page=2&pageSize=50",
    "total_page_count": 2
}

Updated 3 months ago