getItemType

get

/ccagent/v1/itemTypes/{id}

Get Item Type. Get item type and base type info.

Request

Supported Media Types
Path Parameters
Query 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 : propertiesOrder
Type: array
List of properties in ascending order
Show Source
Nested Schema : specifications
Type: array
List of specifications for user-defined item type.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : editableAttributes
Type: array
List of editable properties
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"
            ]
        }
    ],
    "displayName":"Tables",
    "count":10,
    "id":"Tables",
    "specifications":[
        {
            "itemType":"Tables",
            "hidden":false,
            "length":1000,
            "variantBasedDisplay":false,
            "label":"Wood Species",
            "type":"shortText",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "internalOnly":false,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"woodSpecies",
            "order":null
        },
        {
            "itemType":"Tables",
            "hidden":false,
            "length":10,
            "variantBasedDisplay":false,
            "label":"Seating Capacity",
            "type":"number",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "internalOnly":false,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"seatingCapacity",
            "order":null
        },
        {
            "itemType":"Tables",
            "hidden":false,
            "length":19,
            "variantBasedDisplay":false,
            "label":"Handmade",
            "type":"checkbox",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "internalOnly":false,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"handmade",
            "order":null
        },
        {
            "itemType":"Tables",
            "hidden":false,
            "length":1000,
            "variantBasedDisplay":false,
            "label":"Shape",
            "type":"shortText",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "internalOnly":false,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"shape",
            "order":null
        }
    ],
    "base":[
        {
            "itemType":"product",
            "hidden":false,
            "length":254,
            "variantBasedDisplay":false,
            "label":"Name",
            "type":"shortText",
            "required":true,
            "writable":true,
            "uiEditorType":null,
            "internalOnly":false,
            "default":null,
            "listingVariant":false,
            "localizable":true,
            "id":"displayName",
            "order":"0"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":165,
            "variantBasedDisplay":false,
            "label":"Product ID",
            "type":"shortText",
            "required":true,
            "writable":false,
            "uiEditorType":null,
            "internalOnly":false,
            "default":"",
            "listingVariant":false,
            "localizable":false,
            "id":"id",
            "order":"10"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":254,
            "variantBasedDisplay":false,
            "label":"Description",
            "type":"shortText",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "internalOnly":false,
            "default":null,
            "listingVariant":false,
            "localizable":true,
            "id":"description",
            "order":"10"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":254,
            "variantBasedDisplay":false,
            "label":"Brand",
            "type":"shortText",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "internalOnly":false,
            "default":null,
            "listingVariant":false,
            "localizable":true,
            "id":"brand",
            "order":"15"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":0,
            "variantBasedDisplay":false,
            "label":"List Price",
            "type":"currencyMap",
            "required":false,
            "writable":true,
            "default":{
            },
            "listingVariant":false,
            "localizable":false,
            "id":"listPrices",
            "order":"19"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":0,
            "variantBasedDisplay":false,
            "label":"Sale Price",
            "type":"currencyMap",
            "required":false,
            "writable":true,
            "default":{
            },
            "listingVariant":false,
            "localizable":false,
            "id":"salePrices",
            "order":"20"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":0,
            "variantBasedDisplay":false,
            "label":"Shipping Surcharge",
            "type":"currencyMap",
            "required":false,
            "writable":true,
            "default":{
            },
            "listingVariant":false,
            "localizable":false,
            "id":"shippingSurcharges",
            "order":"20"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":22,
            "variantBasedDisplay":false,
            "label":"List Price",
            "type":"currency",
            "required":true,
            "writable":true,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"listPrice",
            "order":"20"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":22,
            "variantBasedDisplay":false,
            "label":"Sale Price",
            "type":"currency",
            "required":false,
            "writable":true,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"salePrice",
            "order":"20"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":22,
            "variantBasedDisplay":false,
            "label":"Shipping Surcharge",
            "type":"currency",
            "required":false,
            "writable":true,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"shippingSurcharge",
            "order":"21"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":254,
            "variantBasedDisplay":false,
            "label":"Product Tax Code",
            "type":"shortText",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "internalOnly":false,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"taxCode",
            "order":"25"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":4000000,
            "variantBasedDisplay":false,
            "label":"Long Description",
            "type":"richText",
            "required":false,
            "writable":true,
            "default":null,
            "listingVariant":false,
            "localizable":true,
            "id":"longDescription",
            "order":"30"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":1,
            "variantBasedDisplay":false,
            "label":"Active",
            "type":"checkbox",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "internalOnly":false,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"active",
            "order":"50"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":7,
            "variantBasedDisplay":false,
            "label":"Arrival Date",
            "type":"date",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "internalOnly":false,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"arrivalDate",
            "order":"60"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":12,
            "variantBasedDisplay":false,
            "label":"Height",
            "type":"number",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "internalOnly":false,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"height",
            "order":"70"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":12,
            "variantBasedDisplay":false,
            "label":"Length",
            "type":"number",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "internalOnly":false,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"length",
            "order":"80"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":12,
            "variantBasedDisplay":false,
            "label":"Width",
            "type":"number",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "internalOnly":false,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"width",
            "order":"90"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":12,
            "variantBasedDisplay":false,
            "label":"Weight",
            "type":"number",
            "required":false,
            "writable":true,
            "uiEditorType":null,
            "internalOnly":false,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"weight",
            "order":"100"
        },
        {
            "itemType":"product",
            "hidden":false,
            "length":10,
            "variantBasedDisplay":false,
            "label":"Order Limit",
            "type":"digit",
            "required":false,
            "writable":true,
            "default":null,
            "listingVariant":false,
            "localizable":false,
            "id":"orderLimit",
            "order":"110"
        }
    ]
}

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