Jump to

• Request
• Response

getItemType

get

/ccagent/v1/itemTypes/{id}

Get Item Type. Get item type and base type info. Below are the supported item types:

• commerceItem
• gift-item
• gift-list
• order
• organization
• organizationRequest
• user
• profileRequest
• contactInfo
• category
• appeasement
• appeasementRefund
• externalAppeasementRefund
• creditCardAppeasementRefund
• storeCreditAppeasementRefund
• tokenizedCreditCardAppeasementRefund
• onlinePaymentGroupAppeasementRefund
• physicalGiftCardAppeasementRefund
• customCurrencyAppeasementRefund

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID of the item type.

Query Parameters

• includeBase(optional): boolean
  Set to true to get base type details.
• parent(optional): string
  Parent Type of current requested item type. It takes product as default parent for custom types.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getItemType_response

Type: object

Show Source

• base(optional): array base
  Base type Details
• count(optional): integer
  The count of items.
• displayName(optional): string
  The display name of the item type
• id(optional): string
  The ID of the item type.
• shopperInputs(optional): array shopperInputs
  Shopper Inputs corresponding to the productType
• specifications(optional): array specifications
  List of properties for user-defined item type.
• variants(optional): array variants
  Variants of the product

{
    "properties":{
        "shopperInputs":{
            "description":"Shopper Inputs corresponding to the productType",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "uiEditorType":{
                        "description":"The UIEditorType property of the shopperInput",
                        "type":"string"
                    },
                    "values":{
                        "description":"List of allowed values in case of Single Selection List type.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "name":{
                        "description":"The name of the shopperInput",
                        "type":"string"
                    },
                    "label":{
                        "description":"The display label of the shopperInput",
                        "type":"string"
                    },
                    "id":{
                        "description":"Id corresponding to the shopperInput",
                        "type":"string"
                    },
                    "promptText":{
                        "description":"The descriptive text for the shopperInput",
                        "type":"string"
                    },
                    "type":{
                        "description":"Data type of shopperInput.",
                        "type":"string"
                    },
                    "required":{
                        "description":"Whether it is required or not.",
                        "type":"boolean"
                    }
                }
            }
        },
        "displayName":{
            "description":"The display name of the item type",
            "type":"string"
        },
        "count":{
            "description":"The count of items.",
            "type":"integer"
        },
        "id":{
            "description":"The ID of the item type.",
            "type":"string"
        },
        "variants":{
            "description":"Variants of the product",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "itemType":{
                        "description":"Item type for user-defined product.",
                        "type":"string"
                    },
                    "hidden":{
                        "description":"Whether item is hidden.",
                        "type":"boolean"
                    },
                    "variantBasedDisplay":{
                        "description":"Whether this variant based display should be allowed ",
                        "type":"boolean"
                    },
                    "length":{
                        "description":"The length property of the variant",
                        "type":"integer"
                    },
                    "label":{
                        "description":"Label for new item type.",
                        "type":"string"
                    },
                    "type":{
                        "description":"Data type of variant.",
                        "type":"string"
                    },
                    "required":{
                        "description":"Whether it is required or not.",
                        "type":"boolean"
                    },
                    "writable":{
                        "description":"Whether writable or not.",
                        "type":"string"
                    },
                    "uiEditorType":{
                        "description":"The UIEditorType property of the variant",
                        "type":"string"
                    },
                    "default":{
                        "description":"Default specification of product type.",
                        "type":"string"
                    },
                    "listingVariant":{
                        "description":"Whether listing should be done based on this variant.",
                        "type":"boolean"
                    },
                    "localizable":{
                        "description":"Whether Localizable or not.",
                        "type":"boolean"
                    },
                    "id":{
                        "description":"ID of specification.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Order count of item type.",
                        "type":"integer"
                    }
                }
            }
        },
        "specifications":{
            "description":"List of properties for user-defined item type.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "validationPattern":{
                        "description":"Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.",
                        "type":"string"
                    },
                    "itemType":{
                        "description":"Item type for user-defined product.",
                        "type":"string"
                    },
                    "hidden":{
                        "description":"Whether item is hidden.",
                        "type":"boolean"
                    },
                    "variantBasedDisplay":{
                        "description":"Whether this variant based display should be allowed ",
                        "type":"boolean"
                    },
                    "length":{
                        "description":"The length property of the variant",
                        "type":"integer"
                    },
                    "label":{
                        "description":"Label for new item type.",
                        "type":"string"
                    },
                    "type":{
                        "description":"Data type of variant.",
                        "type":"string"
                    },
                    "required":{
                        "description":"Whether it is required or not.",
                        "type":"boolean"
                    },
                    "writable":{
                        "description":"Whether writable or not.",
                        "type":"string"
                    },
                    "uiEditorType":{
                        "description":"The UIEditorType property of the variant",
                        "type":"string"
                    },
                    "default":{
                        "description":"Default specification of product type.",
                        "type":"string"
                    },
                    "listingVariant":{
                        "description":"Whether listing should be done based on this variant.",
                        "type":"boolean"
                    },
                    "localizable":{
                        "description":"Whether Localizable or not.",
                        "type":"boolean"
                    },
                    "id":{
                        "description":"ID of specification.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Order count of item type.",
                        "type":"integer"
                    }
                }
            }
        },
        "base":{
            "description":"Base type Details",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "itemType":{
                        "description":"Item type for user-defined product.",
                        "type":"string"
                    },
                    "hidden":{
                        "description":"Whether item is hidden.",
                        "type":"boolean"
                    },
                    "variantBasedDisplay":{
                        "description":"Whether this variant based display should be allowed ",
                        "type":"boolean"
                    },
                    "length":{
                        "description":"The length property of the variant",
                        "type":"integer"
                    },
                    "label":{
                        "description":"Label for new item type.",
                        "type":"string"
                    },
                    "type":{
                        "description":"Data type of variant.",
                        "type":"string"
                    },
                    "required":{
                        "description":"Whether it is required or not.",
                        "type":"boolean"
                    },
                    "writable":{
                        "description":"Whether writable or not.",
                        "type":"string"
                    },
                    "uiEditorType":{
                        "description":"The UIEditorType property of the variant",
                        "type":"string"
                    },
                    "default":{
                        "description":"Default specification of product type.",
                        "type":"string"
                    },
                    "listingVariant":{
                        "description":"Whether listing should be done based on this variant.",
                        "type":"boolean"
                    },
                    "localizable":{
                        "description":"Whether Localizable or not.",
                        "type":"boolean"
                    },
                    "id":{
                        "description":"ID of specification.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Order count of item type.",
                        "type":"integer"
                    }
                }
            }
        }
    }
}

Nested Schema : base

Type: array

Base type Details

Show Source

• Array of: object items

{
    "description":"Base type Details",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "itemType":{
                "description":"Item type for user-defined product.",
                "type":"string"
            },
            "hidden":{
                "description":"Whether item is hidden.",
                "type":"boolean"
            },
            "variantBasedDisplay":{
                "description":"Whether this variant based display should be allowed ",
                "type":"boolean"
            },
            "length":{
                "description":"The length property of the variant",
                "type":"integer"
            },
            "label":{
                "description":"Label for new item type.",
                "type":"string"
            },
            "type":{
                "description":"Data type of variant.",
                "type":"string"
            },
            "required":{
                "description":"Whether it is required or not.",
                "type":"boolean"
            },
            "writable":{
                "description":"Whether writable or not.",
                "type":"string"
            },
            "uiEditorType":{
                "description":"The UIEditorType property of the variant",
                "type":"string"
            },
            "default":{
                "description":"Default specification of product type.",
                "type":"string"
            },
            "listingVariant":{
                "description":"Whether listing should be done based on this variant.",
                "type":"boolean"
            },
            "localizable":{
                "description":"Whether Localizable or not.",
                "type":"boolean"
            },
            "id":{
                "description":"ID of specification.",
                "type":"string"
            },
            "order":{
                "description":"Order count of item type.",
                "type":"integer"
            }
        }
    }
}

Nested Schema : shopperInputs

Type: array

Shopper Inputs corresponding to the productType

Show Source

• Array of: object items

{
    "description":"Shopper Inputs corresponding to the productType",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "uiEditorType":{
                "description":"The UIEditorType property of the shopperInput",
                "type":"string"
            },
            "values":{
                "description":"List of allowed values in case of Single Selection List type.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "name":{
                "description":"The name of the shopperInput",
                "type":"string"
            },
            "label":{
                "description":"The display label of the shopperInput",
                "type":"string"
            },
            "id":{
                "description":"Id corresponding to the shopperInput",
                "type":"string"
            },
            "promptText":{
                "description":"The descriptive text for the shopperInput",
                "type":"string"
            },
            "type":{
                "description":"Data type of shopperInput.",
                "type":"string"
            },
            "required":{
                "description":"Whether it is required or not.",
                "type":"boolean"
            }
        }
    }
}

Nested Schema : specifications

Type: array

List of properties for user-defined item type.

Show Source

• Array of: object items

{
    "description":"List of properties for user-defined item type.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "validationPattern":{
                "description":"Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.",
                "type":"string"
            },
            "itemType":{
                "description":"Item type for user-defined product.",
                "type":"string"
            },
            "hidden":{
                "description":"Whether item is hidden.",
                "type":"boolean"
            },
            "variantBasedDisplay":{
                "description":"Whether this variant based display should be allowed ",
                "type":"boolean"
            },
            "length":{
                "description":"The length property of the variant",
                "type":"integer"
            },
            "label":{
                "description":"Label for new item type.",
                "type":"string"
            },
            "type":{
                "description":"Data type of variant.",
                "type":"string"
            },
            "required":{
                "description":"Whether it is required or not.",
                "type":"boolean"
            },
            "writable":{
                "description":"Whether writable or not.",
                "type":"string"
            },
            "uiEditorType":{
                "description":"The UIEditorType property of the variant",
                "type":"string"
            },
            "default":{
                "description":"Default specification of product type.",
                "type":"string"
            },
            "listingVariant":{
                "description":"Whether listing should be done based on this variant.",
                "type":"boolean"
            },
            "localizable":{
                "description":"Whether Localizable or not.",
                "type":"boolean"
            },
            "id":{
                "description":"ID of specification.",
                "type":"string"
            },
            "order":{
                "description":"Order count of item type.",
                "type":"integer"
            }
        }
    }
}

Nested Schema : variants

Type: array

Variants of the product

Show Source

• Array of: object items

{
    "description":"Variants of the product",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "itemType":{
                "description":"Item type for user-defined product.",
                "type":"string"
            },
            "hidden":{
                "description":"Whether item is hidden.",
                "type":"boolean"
            },
            "variantBasedDisplay":{
                "description":"Whether this variant based display should be allowed ",
                "type":"boolean"
            },
            "length":{
                "description":"The length property of the variant",
                "type":"integer"
            },
            "label":{
                "description":"Label for new item type.",
                "type":"string"
            },
            "type":{
                "description":"Data type of variant.",
                "type":"string"
            },
            "required":{
                "description":"Whether it is required or not.",
                "type":"boolean"
            },
            "writable":{
                "description":"Whether writable or not.",
                "type":"string"
            },
            "uiEditorType":{
                "description":"The UIEditorType property of the variant",
                "type":"string"
            },
            "default":{
                "description":"Default specification of product type.",
                "type":"string"
            },
            "listingVariant":{
                "description":"Whether listing should be done based on this variant.",
                "type":"boolean"
            },
            "localizable":{
                "description":"Whether Localizable or not.",
                "type":"boolean"
            },
            "id":{
                "description":"ID of specification.",
                "type":"string"
            },
            "order":{
                "description":"Order count of item type.",
                "type":"integer"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• default(optional): string
  Default specification of product type.
• hidden(optional): boolean
  Whether item is hidden.
• id(optional): string
  ID of specification.
• itemType(optional): string
  Item type for user-defined product.
• label(optional): string
  Label for new item type.
• length(optional): integer
  The length property of the variant
• listingVariant(optional): boolean
  Whether listing should be done based on this variant.
• localizable(optional): boolean
  Whether Localizable or not.
• order(optional): integer
  Order count of item type.
• required(optional): boolean
  Whether it is required or not.
• type(optional): string
  Data type of variant.
• uiEditorType(optional): string
  The UIEditorType property of the variant
• variantBasedDisplay(optional): boolean
  Whether this variant based display should be allowed
• writable(optional): string
  Whether writable or not.

{
    "type":"object",
    "properties":{
        "itemType":{
            "description":"Item type for user-defined product.",
            "type":"string"
        },
        "hidden":{
            "description":"Whether item is hidden.",
            "type":"boolean"
        },
        "variantBasedDisplay":{
            "description":"Whether this variant based display should be allowed ",
            "type":"boolean"
        },
        "length":{
            "description":"The length property of the variant",
            "type":"integer"
        },
        "label":{
            "description":"Label for new item type.",
            "type":"string"
        },
        "type":{
            "description":"Data type of variant.",
            "type":"string"
        },
        "required":{
            "description":"Whether it is required or not.",
            "type":"boolean"
        },
        "writable":{
            "description":"Whether writable or not.",
            "type":"string"
        },
        "uiEditorType":{
            "description":"The UIEditorType property of the variant",
            "type":"string"
        },
        "default":{
            "description":"Default specification of product type.",
            "type":"string"
        },
        "listingVariant":{
            "description":"Whether listing should be done based on this variant.",
            "type":"boolean"
        },
        "localizable":{
            "description":"Whether Localizable or not.",
            "type":"boolean"
        },
        "id":{
            "description":"ID of specification.",
            "type":"string"
        },
        "order":{
            "description":"Order count of item type.",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  Id corresponding to the shopperInput
• label(optional): string
  The display label of the shopperInput
• name(optional): string
  The name of the shopperInput
• promptText(optional): string
  The descriptive text for the shopperInput
• required(optional): boolean
  Whether it is required or not.
• type(optional): string
  Data type of shopperInput.
• uiEditorType(optional): string
  The UIEditorType property of the shopperInput
• values(optional): array values
  List of allowed values in case of Single Selection List type.

{
    "type":"object",
    "properties":{
        "uiEditorType":{
            "description":"The UIEditorType property of the shopperInput",
            "type":"string"
        },
        "values":{
            "description":"List of allowed values in case of Single Selection List type.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "name":{
            "description":"The name of the shopperInput",
            "type":"string"
        },
        "label":{
            "description":"The display label of the shopperInput",
            "type":"string"
        },
        "id":{
            "description":"Id corresponding to the shopperInput",
            "type":"string"
        },
        "promptText":{
            "description":"The descriptive text for the shopperInput",
            "type":"string"
        },
        "type":{
            "description":"Data type of shopperInput.",
            "type":"string"
        },
        "required":{
            "description":"Whether it is required or not.",
            "type":"boolean"
        }
    }
}

Nested Schema : values

Type: array

List of allowed values in case of Single Selection List type.

Show Source

• Array of: string

{
    "description":"List of allowed values in case of Single Selection List type.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

• default(optional): string
  Default specification of product type.
• hidden(optional): boolean
  Whether item is hidden.
• id(optional): string
  ID of specification.
• itemType(optional): string
  Item type for user-defined product.
• label(optional): string
  Label for new item type.
• length(optional): integer
  The length property of the variant
• listingVariant(optional): boolean
  Whether listing should be done based on this variant.
• localizable(optional): boolean
  Whether Localizable or not.
• order(optional): integer
  Order count of item type.
• required(optional): boolean
  Whether it is required or not.
• type(optional): string
  Data type of variant.
• uiEditorType(optional): string
  The UIEditorType property of the variant
• validationPattern(optional): string
  Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.
• variantBasedDisplay(optional): boolean
  Whether this variant based display should be allowed
• writable(optional): string
  Whether writable or not.

{
    "type":"object",
    "properties":{
        "validationPattern":{
            "description":"Regex string for the validations to be applied on the field. Applicable only for ContactInfo item type.",
            "type":"string"
        },
        "itemType":{
            "description":"Item type for user-defined product.",
            "type":"string"
        },
        "hidden":{
            "description":"Whether item is hidden.",
            "type":"boolean"
        },
        "variantBasedDisplay":{
            "description":"Whether this variant based display should be allowed ",
            "type":"boolean"
        },
        "length":{
            "description":"The length property of the variant",
            "type":"integer"
        },
        "label":{
            "description":"Label for new item type.",
            "type":"string"
        },
        "type":{
            "description":"Data type of variant.",
            "type":"string"
        },
        "required":{
            "description":"Whether it is required or not.",
            "type":"boolean"
        },
        "writable":{
            "description":"Whether writable or not.",
            "type":"string"
        },
        "uiEditorType":{
            "description":"The UIEditorType property of the variant",
            "type":"string"
        },
        "default":{
            "description":"Default specification of product type.",
            "type":"string"
        },
        "listingVariant":{
            "description":"Whether listing should be done based on this variant.",
            "type":"boolean"
        },
        "localizable":{
            "description":"Whether Localizable or not.",
            "type":"boolean"
        },
        "id":{
            "description":"ID of specification.",
            "type":"string"
        },
        "order":{
            "description":"Order count of item type.",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• default(optional): string
  Default specification of product type.
• hidden(optional): boolean
  Whether item is hidden.
• id(optional): string
  ID of specification.
• itemType(optional): string
  Item type for user-defined product.
• label(optional): string
  Label for new item type.
• length(optional): integer
  The length property of the variant
• listingVariant(optional): boolean
  Whether listing should be done based on this variant.
• localizable(optional): boolean
  Whether Localizable or not.
• order(optional): integer
  Order count of item type.
• required(optional): boolean
  Whether it is required or not.
• type(optional): string
  Data type of variant.
• uiEditorType(optional): string
  The UIEditorType property of the variant
• variantBasedDisplay(optional): boolean
  Whether this variant based display should be allowed
• writable(optional): string
  Whether writable or not.

{
    "type":"object",
    "properties":{
        "itemType":{
            "description":"Item type for user-defined product.",
            "type":"string"
        },
        "hidden":{
            "description":"Whether item is hidden.",
            "type":"boolean"
        },
        "variantBasedDisplay":{
            "description":"Whether this variant based display should be allowed ",
            "type":"boolean"
        },
        "length":{
            "description":"The length property of the variant",
            "type":"integer"
        },
        "label":{
            "description":"Label for new item type.",
            "type":"string"
        },
        "type":{
            "description":"Data type of variant.",
            "type":"string"
        },
        "required":{
            "description":"Whether it is required or not.",
            "type":"boolean"
        },
        "writable":{
            "description":"Whether writable or not.",
            "type":"string"
        },
        "uiEditorType":{
            "description":"The UIEditorType property of the variant",
            "type":"string"
        },
        "default":{
            "description":"Default specification of product type.",
            "type":"string"
        },
        "listingVariant":{
            "description":"Whether listing should be done based on this variant.",
            "type":"boolean"
        },
        "localizable":{
            "description":"Whether Localizable or not.",
            "type":"boolean"
        },
        "id":{
            "description":"ID of specification.",
            "type":"string"
        },
        "order":{
            "description":"Order count of item type.",
            "type":"integer"
        }
    }
}

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

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top