listItemTypes

get

/ccagent/v1/itemTypes

List Item Types. Get item type info and base type info of a list of item types.

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listItemTypes_response
Type: object
Show Source
Nested Schema : items
Type: array
array of item types
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : base
Type: array
Base type Details
Show Source
Nested Schema : shopperInputs
Type: array
Shopper Inputs corresponding to the productType
Show Source
Nested Schema : specifications
Type: array
List of properties for user-defined item type.
Show Source
Nested Schema : variants
Type: array
Variants of the product
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: array
List of allowed values in case of Single Selection List type.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
[
    {
        "shopperInputs":[
            {
                "uiEditorType":"shortText",
                "translations":{
                    "1":"shopperInputTranslation:giftMessage_en"
                },
                "name":"Gift Message",
                "label":"Gift Message",
                "id":"giftMessage",
                "promptText":"Enter the gift message",
                "type":"shortText",
                "required":false,
                "enumValues":[
                ]
            },
            {
                "uiEditorType":"richText",
                "translations":{
                    "1":"shopperInputTranslation:giftMessageDetails_en"
                },
                "name":"Gift Message Details",
                "label":"Gift Message Description",
                "id":"giftMessageDetails",
                "promptText":"Enter the gift message details",
                "type":"richText",
                "required":false,
                "enumValues":[
                ]
            },
            {
                "uiEditorType":"number",
                "translations":{
                    "1":"shopperInputTranslation:giftMessageNumber_en"
                },
                "name":"Gift Message Number",
                "label":"Gift Message Number",
                "id":"giftMessageNumber",
                "promptText":"Enter the gift number",
                "type":"number",
                "required":true,
                "enumValues":[
                ]
            },
            {
                "uiEditorType":"checkbox",
                "translations":{
                    "1":"shopperInputTranslation:giftMessageCheckbox_en"
                },
                "name":"Gift Message Checkbox",
                "label":"Gift Message Checkbox",
                "id":"giftMessageCheckbox",
                "promptText":"Select the checkbox",
                "type":"checkbox",
                "required":true,
                "enumValues":[
                ]
            },
            {
                "uiEditorType":"date",
                "translations":{
                    "1":"shopperInputTranslation:giftMessageDate_en"
                },
                "name":"Gift Message Date",
                "label":"Gift Message Date",
                "id":"giftMessageDate",
                "promptText":"Enter the date",
                "type":"date",
                "required":true,
                "enumValues":[
                ]
            },
            {
                "uiEditorType":"singleSelectionList",
                "translations":{
                    "1":"shopperInputTranslation:giftMessageSelection_en"
                },
                "name":"Gift Message Selection",
                "label":"Gift Message Selection",
                "id":"giftMessageSelection",
                "promptText":"Select",
                "type":"enumerated",
                "required":true,
                "enumValues":[
                    "J.Crew",
                    "OshKosh B'Gosh",
                    "Abercrombie & Fitch"
                ]
            }
        ],
        "id":"sku",
        "specifications":[
            {
                "itemType":"sku",
                "hidden":false,
                "length":254,
                "variantBasedDisplay":false,
                "label":"baseLevelSkuProperty",
                "type":"shortText",
                "required":false,
                "writable":true,
                "default":null,
                "listingVariant":false,
                "propertyType":"sku-base",
                "localizable":false,
                "id":"baseLevelSkuProperty",
                "order":null
            }
        ],
        "base":[
            {
                "itemType":"sku",
                "hidden":false,
                "length":254,
                "variantBasedDisplay":false,
                "label":"Name",
                "type":"shortText",
                "required":false,
                "writable":true,
                "uiEditorType":null,
                "internalOnly":false,
                "default":null,
                "listingVariant":false,
                "localizable":true,
                "id":"displayName",
                "order":"-11"
            },
            {
                "itemType":"sku",
                "hidden":false,
                "length":165,
                "variantBasedDisplay":false,
                "label":"Id",
                "type":"shortText",
                "required":false,
                "writable":false,
                "uiEditorType":null,
                "internalOnly":false,
                "default":null,
                "listingVariant":false,
                "localizable":false,
                "id":"id",
                "order":"-4"
            },
            {
                "itemType":"sku",
                "hidden":false,
                "length":1,
                "variantBasedDisplay":false,
                "label":"Active",
                "type":"checkbox",
                "required":false,
                "writable":true,
                "uiEditorType":null,
                "internalOnly":false,
                "default":true,
                "listingVariant":false,
                "localizable":false,
                "id":"active",
                "order":"50"
            }
        ]
    },
    {
        "id":"sku-MensApparel",
        "specifications":[
            {
                "itemType":"sku-MensApparel",
                "hidden":false,
                "length":254,
                "variantBasedDisplay":false,
                "label":"customLevelSkuProperty",
                "type":"shortText",
                "required":false,
                "writable":true,
                "default":null,
                "listingVariant":false,
                "propertyType":"sku-custom",
                "localizable":false,
                "id":"customLevelSkuProperty",
                "order":null
            },
            {
                "itemType":"sku-MensApparel",
                "localizedValues":null,
                "hidden":false,
                "values":[
                    "Beige",
                    "Black",
                    "Blue",
                    "Brown",
                    "Camo",
                    "Dark Worn",
                    "Gray",
                    "Green",
                    "Medium Worn",
                    "Navy",
                    "Orange",
                    "Red",
                    "Tan",
                    "White"
                ],
                "length":19,
                "variantBasedDisplay":false,
                "label":"Color",
                "type":"enumerated",
                "required":false,
                "writable":true,
                "uiEditorType":null,
                "internalOnly":false,
                "default":null,
                "listingVariant":false,
                "propertyType":"variant",
                "localizable":false,
                "id":"color",
                "order":null
            },
            {
                "itemType":"sku-MensApparel",
                "localizedValues":null,
                "hidden":false,
                "values":[
                    "Small",
                    "Medium",
                    "Large",
                    "X-Large"
                ],
                "length":19,
                "variantBasedDisplay":false,
                "label":"Size",
                "type":"enumerated",
                "required":false,
                "writable":true,
                "uiEditorType":null,
                "internalOnly":false,
                "default":null,
                "listingVariant":false,
                "propertyType":"variant",
                "localizable":false,
                "id":"size",
                "order":null
            }
        ],
        "base":[
            {
                "itemType":"sku",
                "hidden":false,
                "length":254,
                "variantBasedDisplay":false,
                "label":"Name",
                "type":"shortText",
                "required":false,
                "writable":true,
                "uiEditorType":null,
                "internalOnly":false,
                "default":null,
                "listingVariant":false,
                "localizable":true,
                "id":"displayName",
                "order":"-11"
            },
            {
                "itemType":"sku",
                "hidden":false,
                "length":165,
                "variantBasedDisplay":false,
                "label":"Id",
                "type":"shortText",
                "required":false,
                "writable":false,
                "uiEditorType":null,
                "internalOnly":false,
                "default":null,
                "listingVariant":false,
                "localizable":false,
                "id":"id",
                "order":"-4"
            },
            {
                "itemType":"sku",
                "hidden":false,
                "length":1,
                "variantBasedDisplay":false,
                "label":"Active",
                "type":"checkbox",
                "required":false,
                "writable":true,
                "uiEditorType":null,
                "internalOnly":false,
                "default":true,
                "listingVariant":false,
                "localizable":false,
                "id":"active",
                "order":"50"
            },
            {
                "itemType":"sku",
                "hidden":false,
                "length":254,
                "variantBasedDisplay":false,
                "label":"baseLevelSkuProperty",
                "type":"shortText",
                "required":false,
                "writable":true,
                "default":null,
                "listingVariant":false,
                "propertyType":"sku-base",
                "localizable":false,
                "id":"baseLevelSkuProperty",
                "order":null
            }
        ]
    }
]

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |20583|Could not find item type| |20688|Parent Id does not match Item Type|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top