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
Path Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getItemType_response
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)
{
    "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
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