REST API for Oracle Commerce Cloud December 2017

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

application/json

Query Parameters

includeBase: Type: boolean

Set to true to get base type details.
itemTypeIds: Type: string

Required: true

Comma separated list of item types to be returned
parent: Type: string

Parent Type of current requested item type. It takes product as default parent for custom types.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : listItemTypes_response

Properties

items: Type: array items

Additional Properties Allowed:

Array containing the properties of the item type ids in the request

Nested Schema : items

Type: array

Array containing the properties of the item type ids in the request

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

base: Type: array base

Additional Properties Allowed:

Base type Details
count: Type: integer

The count of items.
displayName: Type: string

The display name of the item type
id: Type: string

The ID of the item type.
specifications: Type: array specifications

Additional Properties Allowed:

List of properties for user-defined item type.
variants: Type: array variants

Additional Properties Allowed:

Variants of the product

Nested Schema : base

Type: array

Base type Details

Items

Type: object items

Additional Properties Allowed:

Nested Schema : specifications

Type: array

List of properties for user-defined item type.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : variants

Type: array

Variants of the product

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

default: Type: string

Default specification of product type.
hidden: Type: boolean

Whether item is hidden.
id: Type: string

ID of specification.
itemType: Type: string

Item type for user-defined product.
label: Type: string

Label for new item type.
length: Type: integer

The length property of the variant
listingVariant: Type: boolean

Whether listing should be done based on this variant.
localizable: Type: boolean

Whether Localizable or not.
order: Type: integer

Order count of item type.
required: Type: boolean

Whether it is required or not.
type: Type: string

Data type of variant.
uiEditorType: Type: string

The UIEditorType property of the variant
variantBasedDisplay: Type: boolean

Whether this variant based display should be allowed
writable: Type: string

Whether writable or not.

Nested Schema : items

Type: object

Properties

default: Type: string

Default specification of product type.
hidden: Type: boolean

Whether item is hidden.
id: Type: string

ID of specification.
itemType: Type: string

Item type for user-defined product.
label: Type: string

Label for new item type.
length: Type: integer

The length property of the variant
listingVariant: Type: boolean

Whether listing should be done based on this variant.
localizable: Type: boolean

Whether Localizable or not.
order: Type: integer

Order count of item type.
required: Type: boolean

Whether it is required or not.
type: Type: string

Data type of variant.
uiEditorType: Type: string

The UIEditorType property of the variant
variantBasedDisplay: Type: boolean

Whether this variant based display should be allowed
writable: Type: string

Whether writable or not.

Nested Schema : items

Type: object

Properties

default: Type: string

Default specification of product type.
hidden: Type: boolean

Whether item is hidden.
id: Type: string

ID of specification.
itemType: Type: string

Item type for user-defined product.
label: Type: string

Label for new item type.
length: Type: integer

The length property of the variant
listingVariant: Type: boolean

Whether listing should be done based on this variant.
localizable: Type: boolean

Whether Localizable or not.
order: Type: integer

Order count of item type.
required: Type: boolean

Whether it is required or not.
type: Type: string

Data type of variant.
uiEditorType: Type: string

The UIEditorType property of the variant
variantBasedDisplay: Type: boolean

Whether this variant based display should be allowed
writable: Type: string

Whether writable or not.

Example application/json


[
    {
        "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,
                "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,
                "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,
                "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,
                "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,
                "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,
                "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,
                "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,
                "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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

[
  {
    "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,
        "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,
        "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,
        "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,
        "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,
        "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,
        "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,
        "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,
        "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
      }
    ]
  }
]