inventory-items¶

Summary¶

GET accounts/{id}/inventory-items

Description¶

Return a list of inventory items for an account.

Inventory items are the container objects for creatives.

One inventory item represents one "ad" and each ad could have 1 or more creatives attached to it

Tags: accounts

Parameters¶

Header Parameters¶

Name	Type	Required	Example
`Authorization`	`string`	✓ Yes	`Bearer {AuthToken}`
`Content-Type`	`string`	✓ Yes	`application/json`
`Accept`	`string`	✓ Yes	`application/json`
`AppIdV3`	`string`	✓ Yes	`LCUID-LAP-******----**********`

Request Body¶

Content Type: `application/json`¶

Schema¶

Type: object

Properties:

fields (string): A comma separated list of fields to return, otherwise all fields will be returned.
page (integer): The page number to return, if not supplied, page 1 will be returned.
per_page (integer): The number of items to return per page, if not supplied, The default of 100 will be returned.

Responses¶

Response: 200¶

Description: Sample Response

Content Type: `application/json`¶

Schema¶

Type: object

Properties:

success (boolean): Indicates whether the request was successful or not
inventory_items (array): The inventory items for the account. See Inventory Item Response Fields for more information on the inventory item object
Array items: object Type: object

Properties:
- unique_id (string)
- title (string)
- description (string)
- new_used (integer)
- year (string)
- make (string)
- model (string)
- sub_model (string)
- price (integer)
- price_original (string)
- price_modifier (string)
- external_link (string)
- status (integer)
- item_class (string)
- creative_state (integer)
- lcuid (string)
- created_at (string)
- updated_at (string)
- deleted_at (string)
- has_price_override (boolean)
- price_upstream (string)
- creatives (array)
- Array items: object Type: object
  
  Properties:
  - order_number (integer)
  - status (integer)
  - unique_hash (string)
  - lcuid (string)
  - hash_id (string)
  - options (object) Type: object
  Properties:
  - size_in_bytes (string)
  - dimension_height (integer)
  - dimension_width (integer)
  - hash_md5 (string)
  - public_url (string)
  - xr_status (integer)
  - drive_template_id (string)
- image_assets (array)
- Array items: object Type: object
  
  Properties:
  - order_number (integer)
  - status (integer)
  - unique_hash (string)
  - lcuid (string)
  - hash_id (string)
  - options (object) Type: object
  Properties:
  - size_in_bytes (string)
  - dimension_height (integer)
  - dimension_width (integer)
  - hash_md5 (string)
  - public_url (string)
  - xr_status (integer)
  - drive_template_id (string)
- options (object) Type: object
Properties:
- best_creative_image_photo_url (string)
- first_play_at (string)
- primary_image_background_removed_public_url (string)
- primary_image_public_url (string)
- cached_tags (string)
- attributes (array)
- data_source (object) Type: object
Properties:
- lcuid (string)
- name (string)
- campaign_settings (string)
current_page (integer): The current page number
per_page (integer): The number of items per page
total (integer): The total number of items

Example Response¶

{
    "success": true,
    "inventory_items": [
        {
            "unique_id": "Aak4bDZNyB",
            "title": "Some Item 0",
            "description": "Some Description - SlhPFzfs3DRzAQL6Ip5PngzeBcxf3Ro0yPT4T2gQie9lgkwAlw05QbDe7onLmAX06ENnVC0H2wV9SbtAyR89UO4qlktOKLIVOsdrMShJWe4z6N53QBv2zxLR9aDkC0ZgUblk7kSrrH1svNyeUfn8N0",
            "new_used": 0,
            "year": null,
            "make": "Some Make",
            "model": "Some Model",
            "sub_model": "Some Sub Model",
            "price": 1498,
            "price_original": "1498.00",
            "price_modifier": null,
            "external_link": "https://www.example.com/Aak4bDZNyB",
            "status": 1,
            "item_class": "App\\LuCore\\InventoryItems\\RealEstateInventoryItemClass",
            "creative_state": 2,
            "lcuid": "LCUID-LI-4a442f47-d87f-4d9a-9d85-3f84714d2455",
            "created_at": "2026-10-09T15:54:18.000000Z",
            "updated_at": "2026-10-09T15:54:21.000000Z",
            "deleted_at": null,
            "has_price_override": false,
            "price_upstream": null,
            "creatives": [
                {
                    "order_number": 90,
                    "status": 1,
                    "unique_hash": "f3e58cf2677953959f83de7ca98c825f",
                    "lcuid": "LCUID-LP-965f887a-e29d-4a77-a931-acec0717205f",
                    "hash_id": "lch-4N7K",
                    "options": {
                        "size_in_bytes": null,
                        "dimension_height": 180,
                        "dimension_width": 560,
                        "hash_md5": "c82834b7e7c8688e843d37abf3e6ef49",
                        "public_url": "http://localhost:8080/storage/13/40359/img_6ac90e2d2ec9a_9363ba6c73f8b782b4e9.jpg"
                    },
                    "xr_status": 1,
                    "drive_template_id": "LCUID-LDT-0dbc4f89-d8d6-4445-b5e6-904e8aa78231"
                }
            ],
            "image_assets": [
                {
                    "order_number": 100,
                    "status": 1,
                    "unique_hash": "adb1b5617b20736a20cb45dde163dc5a",
                    "lcuid": "LCUID-LP-fd031dd0-689d-49fc-aedc-74c4a4901531",
                    "hash_id": "lch-4N7H",
                    "options": {
                        "size_in_bytes": null,
                        "dimension_height": 251,
                        "dimension_width": 1151,
                        "hash_md5": "8d6b96e4c1a5cd5450f6169fedd6e9c1",
                        "public_url": "http://localhost:8080/storage/13/40359/img_6ac90e2b003d2_c827bdce55186ab06797.png"
                    },
                    "xr_status": 0,
                    "drive_template_id": null
                }
            ],
            "options": {
                "best_creative_image_photo_url": null,
                "first_play_at": null,
                "primary_image_background_removed_public_url": null,
                "primary_image_public_url": "http://localhost:8080/storage/13/40359/img_6ac90e2b003d2_c827bdce55186ab06797.png"
            },
            "cached_tags": null,
            "attributes": [],
            "data_source": {
                "lcuid": "LCUID-LF-0c6e2e75-6011-4162-9bdf-552b65a9c4e8",
                "name": "LC MLS System"
            },
            "campaign_settings": null
        },
        {
            "unique_id": "sULy88pRSd",
            "title": "Some Item 1",
            "description": "Some Description - 5uPoS2CCVdLoEiRUo9apoMGeL3Pf69P53iROKqhheTQnJFDbKlbOLRUeXRxAbkLna9RnZPYyNHRqzG79puBYZ1BuWiAAV4TLUoxeK6XaZOfyB1exfPjz2F8JUox9Mf6m5L4HgrXh3s7XZhAZnMs60p",
            "new_used": 0,
            "year": null,
            "make": "Some Make",
            "model": "Some Model",
            "sub_model": "Some Sub Model",
            "price": 1351,
            "price_original": "1351.00",
            "price_modifier": null,
            "external_link": "https://www.example.com/sULy88pRSd",
            "status": 1,
            "item_class": "App\\LuCore\\InventoryItems\\RealEstateInventoryItemClass",
            "creative_state": 2,
            "lcuid": "LCUID-LI-0e057d71-e7ce-4e8c-bf73-e8da8e979343",
            "created_at": "2026-10-09T15:54:19.000000Z",
            "updated_at": "2026-10-09T15:54:21.000000Z",
            "deleted_at": null,
            "has_price_override": false,
            "price_upstream": null,
            "creatives": [
                {
                    "order_number": 90,
                    "status": 1,
                    "unique_hash": "4f6dfcd8cd4013630bb6c5825f0ae741",
                    "lcuid": "LCUID-LP-6adffa99-cf16-45bc-84d3-80138d0ec0f8",
                    "hash_id": "lch-4N7L",
                    "options": {
                        "size_in_bytes": null,
                        "dimension_height": 180,
                        "dimension_width": 560,
                        "hash_md5": "c82834b7e7c8688e843d37abf3e6ef49",
                        "public_url": "http://localhost:8080/storage/13/40360/img_6ac90e2d6f2c3_afcac64a4056166d29a9.jpg"
                    },
                    "xr_status": 1,
                    "drive_template_id": "LCUID-LDT-0dbc4f89-d8d6-4445-b5e6-904e8aa78231"
                }
            ],
            "image_assets": [
                {
                    "order_number": 100,
                    "status": 1,
                    "unique_hash": "adb1b5617b20736a20cb45dde163dc5a",
                    "lcuid": "LCUID-LP-6cc2e63a-6428-4957-9aa7-a98da9b4ff2e",
                    "hash_id": "lch-4N7I",
                    "options": {
                        "size_in_bytes": null,
                        "dimension_height": 251,
                        "dimension_width": 1151,
                        "hash_md5": "8d6b96e4c1a5cd5450f6169fedd6e9c1",
                        "public_url": "http://localhost:8080/storage/13/40360/img_6ac90e2b85e4d_1de170982bc1e9b02d00.png"
                    },
                    "xr_status": 0,
                    "drive_template_id": null
                }
            ],
            "options": {
                "best_creative_image_photo_url": null,
                "first_play_at": null,
                "primary_image_background_removed_public_url": null,
                "primary_image_public_url": "http://localhost:8080/storage/13/40360/img_6ac90e2b85e4d_1de170982bc1e9b02d00.png"
            },
            "cached_tags": null,
            "attributes": [],
            "data_source": {
                "lcuid": "LCUID-LF-0c6e2e75-6011-4162-9bdf-552b65a9c4e8",
                "name": "LC MLS System"
            },
            "campaign_settings": null
        },
        {
            "unique_id": "6ac90e2c7e39e",
            "title": "Default Creatives",
            "description": "Auto Generated Creatives for this account",
            "new_used": 0,
            "year": null,
            "make": "DefaultCreatives",
            "model": "Base",
            "sub_model": "",
            "price": 0,
            "price_original": "0.00",
            "price_modifier": null,
            "external_link": "",
            "status": 1,
            "item_class": "App\\LuCore\\InventoryItems\\DefaultCreativeInventoryItemClass",
            "creative_state": 1,
            "lcuid": "LCUID-LI-8c40b356-e13b-4257-9281-3960a4f8b3d6",
            "created_at": "2026-10-09T15:54:20.000000Z",
            "updated_at": "2026-10-09T15:54:21.000000Z",
            "deleted_at": null,
            "has_price_override": false,
            "price_upstream": null,
            "creatives": [],
            "image_assets": [
                {
                    "order_number": 100,
                    "status": 1,
                    "unique_hash": "36c2456a644b9e2e5e5c976c0d1a3bf8",
                    "lcuid": "LCUID-LP-5d986ff7-9e2e-457c-8322-c2365f24baeb",
                    "hash_id": "lch-4N7J",
                    "options": {
                        "size_in_bytes": null,
                        "dimension_height": 251,
                        "dimension_width": 1151,
                        "hash_md5": "8d6b96e4c1a5cd5450f6169fedd6e9c1",
                        "public_url": "http://localhost:8080/storage/60/40361/img_6ac90e2cd0365_9770cd0217ff1c84958a.png"
                    },
                    "xr_status": 0,
                    "drive_template_id": null
                }
            ],
            "options": {
                "best_creative_image_photo_url": null,
                "first_play_at": null,
                "primary_image_background_removed_public_url": null,
                "primary_image_public_url": "http://localhost:8080/storage/60/40361/img_6ac90e2cd0365_9770cd0217ff1c84958a.png"
            },
            "cached_tags": null,
            "attributes": [],
            "data_source": null,
            "campaign_settings": null
        }
    ],
    "current_page": 1,
    "per_page": 100,
    "total": 3
}

Example Implementations¶

Bash (cURL)¶

curl --request GET \
    --get "https://api.lucit.app/api/v3/accounts/LCUID-LA-506fc585-77be-11ec-acb9-c2cdb617d190/inventory-items" \
    --header "Authorization: Bearer {AuthToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "AppIdV3: LCUID-LAP-********-****-****-****-************" \
    --data "{
    \"fields\": \"lcuid,title,description,unique_id,price\",
    \"page\": 1,
    \"per_page\": 50
}"

JavaScript (Fetch API)¶

const url = new URL(
    "https://api.lucit.app/api/v3/accounts/LCUID-LA-506fc585-77be-11ec-acb9-c2cdb617d190/inventory-items"
);

const headers = {
    "Authorization": "Bearer {AuthToken}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "AppIdV3": "LCUID-LAP-********-****-****-****-************",
};

let body = {
    "fields": "lcuid,title,description,unique_id,price",
    "page": 1,
    "per_page": 50
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

PHP (Guzzle)¶

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.lucit.app/api/v3/accounts/LCUID-LA-506fc585-77be-11ec-acb9-c2cdb617d190/inventory-items',
    [
        'headers' => [
            'Authorization' => 'Bearer {AuthToken}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'AppIdV3' => 'LCUID-LAP-********-****-****-****-************',
        ],
        'json' => [
            'fields' => 'lcuid,title,description,unique_id,price',
            'page' => 1,
            'per_page' => 50,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Python (Requests)¶

import requests
import json

url = 'https://api.lucit.app/api/v3/accounts/LCUID-LA-506fc585-77be-11ec-acb9-c2cdb617d190/inventory-items'
payload = {
    "fields": "lcuid,title,description,unique_id,price",
    "page": 1,
    "per_page": 50
}
headers = {
  'Authorization': 'Bearer {AuthToken}',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'AppIdV3': 'LCUID-LAP-********-****-****-****-************'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

← Back to accounts index | Back to main index

GET /api/v3/accounts/{lcuid}/inventory-items¶

Summary¶

Description¶

Parameters¶

Header Parameters¶

Request Body¶

Content Type: application/json¶

Schema¶

Responses¶

Response: 200¶

Content Type: application/json¶

Schema¶

Example Response¶

Example Implementations¶

Bash (cURL)¶

JavaScript (Fetch API)¶

PHP (Guzzle)¶

Python (Requests)¶

Content Type: `application/json`¶

Content Type: `application/json`¶