REST API for Oracle Commerce Cloud December 2017

getItemType

get

/ccadmin/v1/itemTypes/{id}

Get Item Type. Get information about item types by ID. This get endpoint will not support for products. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

ID of item type.

Header Parameters

X-CCAsset-Language: Type: string

The asset language of the request

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getItemType_response

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


{
    "propertiesOrder":[
        "derivedApprovalRequired",
        "name",
        "description",
        "derivedOrderPriceLimit",
        "customerType",
        "derivedCustomerType",
        "type",
        "dunsNumber",
        "organizationLogo",
        "uniqueId",
        "taxReferenceNumber",
        "vatReferenceNumber",
        "active",
        "TestShortItemType2"
    ],
    "displayName":"Organization",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/itemTypes/organization"
        }
    ],
    "id":"organization",
    "specifications":[
        {
            "length":22,
            "label":"Order limit",
            "type":"number",
            "required":false,
            "searchable":false,
            "writable":true,
            "uiEditorType":"number",
            "internalOnly":false,
            "default":null,
            "localizable":false,
            "textSearchable":false,
            "id":"derivedOrderPriceLimit",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "multiSelect":null
        },
        {
            "length":0,
            "label":"Customer type",
            "type":"shortText",
            "required":false,
            "searchable":false,
            "writable":true,
            "uiEditorType":"shortText",
            "internalOnly":false,
            "default":null,
            "localizable":false,
            "textSearchable":false,
            "id":"customerType",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "multiSelect":null
        },
        {
            "length":254,
            "label":"TestShortItemType2",
            "type":"shortText",
            "required":false,
            "searchable":false,
            "writable":true,
            "uiEditorType":"shortText",
            "internalOnly":false,
            "default":null,
            "localizable":false,
            "textSearchable":false,
            "id":"TestShortItemType2",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "multiSelect":false
        },
        {
            "length":254,
            "label":"vatReferenceNumber",
            "type":"shortText",
            "required":false,
            "searchable":false,
            "writable":true,
            "uiEditorType":"shortText",
            "internalOnly":false,
            "default":null,
            "localizable":false,
            "textSearchable":false,
            "id":"vatReferenceNumber",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "multiSelect":null
        },
        {
            "length":0,
            "label":"Type",
            "type":"shortText",
            "required":false,
            "searchable":false,
            "writable":true,
            "uiEditorType":"shortText",
            "internalOnly":false,
            "default":null,
            "localizable":false,
            "textSearchable":false,
            "id":"type",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "multiSelect":null
        },
        {
            "length":254,
            "label":"DUNS number",
            "type":"shortText",
            "required":false,
            "searchable":false,
            "writable":true,
            "uiEditorType":"shortText",
            "internalOnly":false,
            "default":null,
            "localizable":false,
            "textSearchable":false,
            "id":"dunsNumber",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "multiSelect":null
        },
        {
            "length":254,
            "label":"uniqueId",
            "type":"shortText",
            "required":false,
            "searchable":false,
            "writable":true,
            "uiEditorType":"shortText",
            "internalOnly":false,
            "default":null,
            "localizable":false,
            "textSearchable":false,
            "id":"uniqueId",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "multiSelect":null
        },
        {
            "length":1,
            "label":"Approval required",
            "type":"checkbox",
            "required":false,
            "searchable":false,
            "writable":true,
            "uiEditorType":"checkbox",
            "internalOnly":false,
            "default":true,
            "localizable":false,
            "textSearchable":false,
            "id":"derivedApprovalRequired",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "multiSelect":null
        },
        {
            "length":254,
            "label":"Description",
            "type":"shortText",
            "required":false,
            "searchable":false,
            "writable":true,
            "uiEditorType":"shortText",
            "internalOnly":false,
            "default":null,
            "localizable":false,
            "textSearchable":false,
            "id":"description",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "multiSelect":null
        },
        {
            "length":254,
            "label":"Name",
            "type":"shortText",
            "required":true,
            "searchable":false,
            "writable":true,
            "uiEditorType":"shortText",
            "internalOnly":false,
            "default":null,
            "localizable":false,
            "textSearchable":false,
            "id":"name",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "searchable"
            ],
            "multiSelect":null
        },
        {
            "length":1,
            "label":"active",
            "type":"checkbox",
            "required":false,
            "searchable":false,
            "writable":true,
            "uiEditorType":"checkbox",
            "internalOnly":false,
            "default":true,
            "localizable":false,
            "textSearchable":false,
            "id":"active",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "multiSelect":null
        },
        {
            "length":0,
            "label":"Customer type",
            "type":"shortText",
            "required":false,
            "searchable":false,
            "writable":true,
            "uiEditorType":"shortText",
            "internalOnly":false,
            "default":null,
            "localizable":false,
            "textSearchable":false,
            "id":"derivedCustomerType",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "multiSelect":null
        },
        {
            "length":254,
            "label":"taxReferenceNumber",
            "type":"shortText",
            "required":false,
            "searchable":false,
            "writable":true,
            "uiEditorType":"shortText",
            "internalOnly":false,
            "default":null,
            "localizable":false,
            "textSearchable":false,
            "id":"taxReferenceNumber",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "multiSelect":null
        },
        {
            "length":254,
            "label":"organizationLogo",
            "type":"shortText",
            "required":false,
            "searchable":false,
            "writable":true,
            "uiEditorType":"shortText",
            "internalOnly":false,
            "default":null,
            "localizable":false,
            "textSearchable":false,
            "id":"organizationLogo",
            "dimension":false,
            "editableAttributes":[
                "textSearchable",
                "multiSelect",
                "dimension",
                "internalOnly",
                "default",
                "label",
                "required",
                "searchable"
            ],
            "multiSelect":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| |------------------|------------------| |200501|Invalid item type Id|

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:

{
  "propertiesOrder": [
    "derivedApprovalRequired",
    "name",
    "description",
    "derivedOrderPriceLimit",
    "customerType",
    "derivedCustomerType",
    "type",
    "dunsNumber",
    "organizationLogo",
    "uniqueId",
    "taxReferenceNumber",
    "vatReferenceNumber",
    "active",
    "TestShortItemType2"
  ],
  "displayName": "Organization",
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadminui/v1/itemTypes/organization"
  }],
  "id": "organization",
  "specifications": [
    {
      "length": 22,
      "label": "Order limit",
      "type": "number",
      "required": false,
      "searchable": false,
      "writable": true,
      "uiEditorType": "number",
      "internalOnly": false,
      "default": null,
      "localizable": false,
      "textSearchable": false,
      "id": "derivedOrderPriceLimit",
      "dimension": false,
      "editableAttributes": [
        "textSearchable",
        "multiSelect",
        "dimension",
        "internalOnly",
        "default",
        "label",
        "required",
        "searchable"
      ],
      "multiSelect": null
    },
    {
      "length": 0,
      "label": "Customer type",
      "type": "shortText",
      "required": false,
      "searchable": false,
      "writable": true,
      "uiEditorType": "shortText",
      "internalOnly": false,
      "default": null,
      "localizable": false,
      "textSearchable": false,
      "id": "customerType",
      "dimension": false,
      "editableAttributes": [
        "textSearchable",
        "multiSelect",
        "dimension",
        "internalOnly",
        "default",
        "label",
        "required",
        "searchable"
      ],
      "multiSelect": null
    },
    {
      "length": 254,
      "label": "TestShortItemType2",
      "type": "shortText",
      "required": false,
      "searchable": false,
      "writable": true,
      "uiEditorType": "shortText",
      "internalOnly": false,
      "default": null,
      "localizable": false,
      "textSearchable": false,
      "id": "TestShortItemType2",
      "dimension": false,
      "editableAttributes": [
        "textSearchable",
        "multiSelect",
        "dimension",
        "internalOnly",
        "default",
        "label",
        "required",
        "searchable"
      ],
      "multiSelect": false
    },
    {
      "length": 254,
      "label": "vatReferenceNumber",
      "type": "shortText",
      "required": false,
      "searchable": false,
      "writable": true,
      "uiEditorType": "shortText",
      "internalOnly": false,
      "default": null,
      "localizable": false,
      "textSearchable": false,
      "id": "vatReferenceNumber",
      "dimension": false,
      "editableAttributes": [
        "textSearchable",
        "multiSelect",
        "dimension",
        "internalOnly",
        "default",
        "label",
        "required",
        "searchable"
      ],
      "multiSelect": null
    },
    {
      "length": 0,
      "label": "Type",
      "type": "shortText",
      "required": false,
      "searchable": false,
      "writable": true,
      "uiEditorType": "shortText",
      "internalOnly": false,
      "default": null,
      "localizable": false,
      "textSearchable": false,
      "id": "type",
      "dimension": false,
      "editableAttributes": [
        "textSearchable",
        "multiSelect",
        "dimension",
        "internalOnly",
        "default",
        "label",
        "required",
        "searchable"
      ],
      "multiSelect": null
    },
    {
      "length": 254,
      "label": "DUNS number",
      "type": "shortText",
      "required": false,
      "searchable": false,
      "writable": true,
      "uiEditorType": "shortText",
      "internalOnly": false,
      "default": null,
      "localizable": false,
      "textSearchable": false,
      "id": "dunsNumber",
      "dimension": false,
      "editableAttributes": [
        "textSearchable",
        "multiSelect",
        "dimension",
        "internalOnly",
        "default",
        "label",
        "required",
        "searchable"
      ],
      "multiSelect": null
    },
    {
      "length": 254,
      "label": "uniqueId",
      "type": "shortText",
      "required": false,
      "searchable": false,
      "writable": true,
      "uiEditorType": "shortText",
      "internalOnly": false,
      "default": null,
      "localizable": false,
      "textSearchable": false,
      "id": "uniqueId",
      "dimension": false,
      "editableAttributes": [
        "textSearchable",
        "multiSelect",
        "dimension",
        "internalOnly",
        "default",
        "label",
        "required",
        "searchable"
      ],
      "multiSelect": null
    },
    {
      "length": 1,
      "label": "Approval required",
      "type": "checkbox",
      "required": false,
      "searchable": false,
      "writable": true,
      "uiEditorType": "checkbox",
      "internalOnly": false,
      "default": true,
      "localizable": false,
      "textSearchable": false,
      "id": "derivedApprovalRequired",
      "dimension": false,
      "editableAttributes": [
        "textSearchable",
        "multiSelect",
        "dimension",
        "internalOnly",
        "default",
        "label",
        "required",
        "searchable"
      ],
      "multiSelect": null
    },
    {
      "length": 254,
      "label": "Description",
      "type": "shortText",
      "required": false,
      "searchable": false,
      "writable": true,
      "uiEditorType": "shortText",
      "internalOnly": false,
      "default": null,
      "localizable": false,
      "textSearchable": false,
      "id": "description",
      "dimension": false,
      "editableAttributes": [
        "textSearchable",
        "multiSelect",
        "dimension",
        "internalOnly",
        "default",
        "label",
        "required",
        "searchable"
      ],
      "multiSelect": null
    },
    {
      "length": 254,
      "label": "Name",
      "type": "shortText",
      "required": true,
      "searchable": false,
      "writable": true,
      "uiEditorType": "shortText",
      "internalOnly": false,
      "default": null,
      "localizable": false,
      "textSearchable": false,
      "id": "name",
      "dimension": false,
      "editableAttributes": [
        "textSearchable",
        "multiSelect",
        "dimension",
        "internalOnly",
        "default",
        "label",
        "searchable"
      ],
      "multiSelect": null
    },
    {
      "length": 1,
      "label": "active",
      "type": "checkbox",
      "required": false,
      "searchable": false,
      "writable": true,
      "uiEditorType": "checkbox",
      "internalOnly": false,
      "default": true,
      "localizable": false,
      "textSearchable": false,
      "id": "active",
      "dimension": false,
      "editableAttributes": [
        "textSearchable",
        "multiSelect",
        "dimension",
        "internalOnly",
        "default",
        "label",
        "required",
        "searchable"
      ],
      "multiSelect": null
    },
    {
      "length": 0,
      "label": "Customer type",
      "type": "shortText",
      "required": false,
      "searchable": false,
      "writable": true,
      "uiEditorType": "shortText",
      "internalOnly": false,
      "default": null,
      "localizable": false,
      "textSearchable": false,
      "id": "derivedCustomerType",
      "dimension": false,
      "editableAttributes": [
        "textSearchable",
        "multiSelect",
        "dimension",
        "internalOnly",
        "default",
        "label",
        "required",
        "searchable"
      ],
      "multiSelect": null
    },
    {
      "length": 254,
      "label": "taxReferenceNumber",
      "type": "shortText",
      "required": false,
      "searchable": false,
      "writable": true,
      "uiEditorType": "shortText",
      "internalOnly": false,
      "default": null,
      "localizable": false,
      "textSearchable": false,
      "id": "taxReferenceNumber",
      "dimension": false,
      "editableAttributes": [
        "textSearchable",
        "multiSelect",
        "dimension",
        "internalOnly",
        "default",
        "label",
        "required",
        "searchable"
      ],
      "multiSelect": null
    },
    {
      "length": 254,
      "label": "organizationLogo",
      "type": "shortText",
      "required": false,
      "searchable": false,
      "writable": true,
      "uiEditorType": "shortText",
      "internalOnly": false,
      "default": null,
      "localizable": false,
      "textSearchable": false,
      "id": "organizationLogo",
      "dimension": false,
      "editableAttributes": [
        "textSearchable",
        "multiSelect",
        "dimension",
        "internalOnly",
        "default",
        "label",
        "required",
        "searchable"
      ],
      "multiSelect": null
    }
  ]
}