GET /api/v3/inventory-items/constants/inventory-item-classes

Summary

GET /inventory-items/constants/inventory-item-classes

Description

Returns a list of inventory item classes

Tags: inventory-items

Parameters

Header Parameters

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

Responses

Response: 200

Description: Sample Response

Content Type: application/json

Schema

Type: object

Properties:

• success (boolean)
• inventory_item_classes (array)

• Array items: object Type: object

  Properties:

  • class (string)
  • class_description (string)
  • group_class (string)
  • group_class_description (string)
  • can_be_a_creative (boolean)
  • has_inventory (boolean)
  • can_have_assigned_drive_template (boolean)
  • can_be_created_by_data_sources (boolean)

Example Response

{
    "success": true,
    "inventory_item_classes": [
        {
            "class": "App\\LuCore\\InventoryItems\\AutomotiveInventoryItemClass",
            "class_description": "Automotive",
            "group_class": "App\\LuCore\\InventoryItems\\AutoAgMotorsportsItemClassGroup",
            "group_class_description": "Auto, Ag and Motorsports",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\AgInventoryItemClass",
            "class_description": "Ag",
            "group_class": "App\\LuCore\\InventoryItems\\AutoAgMotorsportsItemClassGroup",
            "group_class_description": "Auto, Ag and Motorsports",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\GenericInventoryItemClass",
            "class_description": "Generic",
            "group_class": "App\\LuCore\\InventoryItems\\SystemItemClassGroup",
            "group_class_description": "System",
            "can_be_a_creative": false,
            "has_inventory": true,
            "can_have_assigned_drive_template": false,
            "can_be_created_by_data_sources": false
        },
        {
            "class": "App\\LuCore\\InventoryItems\\RealEstateInventoryItemClass",
            "class_description": "Real Estate",
            "group_class": "App\\LuCore\\InventoryItems\\PropertyItemClassGroup",
            "group_class_description": "Property",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\NoInventoryInventoryItemClass",
            "class_description": "No Inventory",
            "group_class": "App\\LuCore\\InventoryItems\\SystemItemClassGroup",
            "group_class_description": "System",
            "can_be_a_creative": false,
            "has_inventory": false,
            "can_have_assigned_drive_template": false,
            "can_be_created_by_data_sources": false
        },
        {
            "class": "App\\LuCore\\InventoryItems\\KeyValueDataInventoryItemClass",
            "class_description": "Key / Value Data",
            "group_class": "App\\LuCore\\InventoryItems\\SystemItemClassGroup",
            "group_class_description": "System",
            "can_be_a_creative": false,
            "has_inventory": false,
            "can_have_assigned_drive_template": false,
            "can_be_created_by_data_sources": false
        },
        {
            "class": "App\\LuCore\\InventoryItems\\CreativeInventoryItemClass",
            "class_description": "Creative",
            "group_class": "App\\LuCore\\InventoryItems\\CreativesItemClassGroup",
            "group_class_description": "Creatives",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": false,
            "can_be_created_by_data_sources": false
        },
        {
            "class": "App\\LuCore\\InventoryItems\\PhotoStreamInventoryItemClass",
            "class_description": "Post",
            "group_class": "App\\LuCore\\InventoryItems\\CreativesItemClassGroup",
            "group_class_description": "Creatives",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": false
        },
        {
            "class": "App\\LuCore\\InventoryItems\\InventoryExportInventoryItemClass",
            "class_description": "Child Campaign",
            "group_class": "App\\LuCore\\InventoryItems\\CreativeGroupItemClassGroup",
            "group_class_description": "Group of Creatives",
            "can_be_a_creative": false,
            "has_inventory": true,
            "can_have_assigned_drive_template": false,
            "can_be_created_by_data_sources": false
        },
        {
            "class": "App\\LuCore\\InventoryItems\\RealEstateAgentInventoryItemClass",
            "class_description": "Real Estate Agent",
            "group_class": "App\\LuCore\\InventoryItems\\PeopleItemClassGroup",
            "group_class_description": "People",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\ArticleInventoryItemClass",
            "class_description": "Article",
            "group_class": "App\\LuCore\\InventoryItems\\ArticlesAndContentItemClassGroup",
            "group_class_description": "Articles and Content",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\ReviewInventoryItemClass",
            "class_description": "Review",
            "group_class": "App\\LuCore\\InventoryItems\\ArticlesAndContentItemClassGroup",
            "group_class_description": "Articles and Content",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\SocialPostInventoryItemClass",
            "class_description": "Social Post",
            "group_class": "App\\LuCore\\InventoryItems\\ArticlesAndContentItemClassGroup",
            "group_class_description": "Articles and Content",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\DefaultCreativeInventoryItemClass",
            "class_description": "Default Creative",
            "group_class": "App\\LuCore\\InventoryItems\\CreativesItemClassGroup",
            "group_class_description": "Creatives",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": false,
            "can_be_created_by_data_sources": false
        },
        {
            "class": "App\\LuCore\\InventoryItems\\ProductInventoryItemClass",
            "class_description": "Product",
            "group_class": "App\\LuCore\\InventoryItems\\ProductsItemClassGroup",
            "group_class_description": "Products",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\RecreationalInventoryItemClass",
            "class_description": "Recreational",
            "group_class": "App\\LuCore\\InventoryItems\\AutoAgMotorsportsItemClassGroup",
            "group_class_description": "Auto, Ag and Motorsports",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\JobPostInventoryItemClass",
            "class_description": "Job Posting",
            "group_class": "App\\LuCore\\InventoryItems\\ArticlesAndContentItemClassGroup",
            "group_class_description": "Articles and Content",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        }
    ]
}

Example Implementations

Bash (cURL)

curl --request GET \
    --get "https://api.lucit.app/api/v3/inventory-items/constants/inventory-item-classes" \
    --header "Authorization: Bearer {AuthToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "AppIdV3: LCUID-LAP-********-****-****-****-************"

JavaScript (Fetch API)

const url = new URL(
    "https://api.lucit.app/api/v3/inventory-items/constants/inventory-item-classes"
);

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

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

PHP (Guzzle)

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.lucit.app/api/v3/inventory-items/constants/inventory-item-classes',
    [
        'headers' => [
            'Authorization' => 'Bearer {AuthToken}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'AppIdV3' => 'LCUID-LAP-********-****-****-****-************',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Python (Requests)

import requests
import json

url = 'https://api.lucit.app/api/v3/inventory-items/constants/inventory-item-classes'
headers = {
  'Authorization': 'Bearer {AuthToken}',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'AppIdV3': 'LCUID-LAP-********-****-****-****-************'
}

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

Example Responses

200 Response

{
    "success": true,
    "inventory_item_classes": [
        {
            "class": "App\\LuCore\\InventoryItems\\AutomotiveInventoryItemClass",
            "class_description": "Automotive",
            "group_class": "App\\LuCore\\InventoryItems\\AutoAgMotorsportsItemClassGroup",
            "group_class_description": "Auto, Ag and Motorsports",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\AgInventoryItemClass",
            "class_description": "Ag",
            "group_class": "App\\LuCore\\InventoryItems\\AutoAgMotorsportsItemClassGroup",
            "group_class_description": "Auto, Ag and Motorsports",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\GenericInventoryItemClass",
            "class_description": "Generic",
            "group_class": "App\\LuCore\\InventoryItems\\SystemItemClassGroup",
            "group_class_description": "System",
            "can_be_a_creative": false,
            "has_inventory": true,
            "can_have_assigned_drive_template": false,
            "can_be_created_by_data_sources": false
        },
        {
            "class": "App\\LuCore\\InventoryItems\\RealEstateInventoryItemClass",
            "class_description": "Real Estate",
            "group_class": "App\\LuCore\\InventoryItems\\PropertyItemClassGroup",
            "group_class_description": "Property",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\NoInventoryInventoryItemClass",
            "class_description": "No Inventory",
            "group_class": "App\\LuCore\\InventoryItems\\SystemItemClassGroup",
            "group_class_description": "System",
            "can_be_a_creative": false,
            "has_inventory": false,
            "can_have_assigned_drive_template": false,
            "can_be_created_by_data_sources": false
        },
        {
            "class": "App\\LuCore\\InventoryItems\\KeyValueDataInventoryItemClass",
            "class_description": "Key / Value Data",
            "group_class": "App\\LuCore\\InventoryItems\\SystemItemClassGroup",
            "group_class_description": "System",
            "can_be_a_creative": false,
            "has_inventory": false,
            "can_have_assigned_drive_template": false,
            "can_be_created_by_data_sources": false
        },
        {
            "class": "App\\LuCore\\InventoryItems\\CreativeInventoryItemClass",
            "class_description": "Creative",
            "group_class": "App\\LuCore\\InventoryItems\\CreativesItemClassGroup",
            "group_class_description": "Creatives",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": false,
            "can_be_created_by_data_sources": false
        },
        {
            "class": "App\\LuCore\\InventoryItems\\PhotoStreamInventoryItemClass",
            "class_description": "Post",
            "group_class": "App\\LuCore\\InventoryItems\\CreativesItemClassGroup",
            "group_class_description": "Creatives",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": false
        },
        {
            "class": "App\\LuCore\\InventoryItems\\InventoryExportInventoryItemClass",
            "class_description": "Child Campaign",
            "group_class": "App\\LuCore\\InventoryItems\\CreativeGroupItemClassGroup",
            "group_class_description": "Group of Creatives",
            "can_be_a_creative": false,
            "has_inventory": true,
            "can_have_assigned_drive_template": false,
            "can_be_created_by_data_sources": false
        },
        {
            "class": "App\\LuCore\\InventoryItems\\RealEstateAgentInventoryItemClass",
            "class_description": "Real Estate Agent",
            "group_class": "App\\LuCore\\InventoryItems\\PeopleItemClassGroup",
            "group_class_description": "People",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\ArticleInventoryItemClass",
            "class_description": "Article",
            "group_class": "App\\LuCore\\InventoryItems\\ArticlesAndContentItemClassGroup",
            "group_class_description": "Articles and Content",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\ReviewInventoryItemClass",
            "class_description": "Review",
            "group_class": "App\\LuCore\\InventoryItems\\ArticlesAndContentItemClassGroup",
            "group_class_description": "Articles and Content",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\SocialPostInventoryItemClass",
            "class_description": "Social Post",
            "group_class": "App\\LuCore\\InventoryItems\\ArticlesAndContentItemClassGroup",
            "group_class_description": "Articles and Content",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\DefaultCreativeInventoryItemClass",
            "class_description": "Default Creative",
            "group_class": "App\\LuCore\\InventoryItems\\CreativesItemClassGroup",
            "group_class_description": "Creatives",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": false,
            "can_be_created_by_data_sources": false
        },
        {
            "class": "App\\LuCore\\InventoryItems\\ProductInventoryItemClass",
            "class_description": "Product",
            "group_class": "App\\LuCore\\InventoryItems\\ProductsItemClassGroup",
            "group_class_description": "Products",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\RecreationalInventoryItemClass",
            "class_description": "Recreational",
            "group_class": "App\\LuCore\\InventoryItems\\AutoAgMotorsportsItemClassGroup",
            "group_class_description": "Auto, Ag and Motorsports",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        },
        {
            "class": "App\\LuCore\\InventoryItems\\JobPostInventoryItemClass",
            "class_description": "Job Posting",
            "group_class": "App\\LuCore\\InventoryItems\\ArticlesAndContentItemClassGroup",
            "group_class_description": "Articles and Content",
            "can_be_a_creative": true,
            "has_inventory": true,
            "can_have_assigned_drive_template": true,
            "can_be_created_by_data_sources": true
        }
    ]
}

---

← Back to inventory-items index | Back to main index