getMetadata

get

/ccadmin/v1/metadata/{id}

Get Metadata. Get the metadata information for an item descriptor by ID. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
Path Parameters
Query Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getMetadata_response
Type: object
Show Source
Nested Schema : items
Type: array
An array of metadata/ properties information for an item descriptor.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : editableAttributes
Type: array
List of attributes of the property which can be edited from UI.
Show Source
Example Response (application/json)
[
    {
        "itemType":"product",
        "hidden":false,
        "length":1,
        "variantBasedDisplay":false,
        "label":"Discountable",
        "type":"checkbox",
        "required":false,
        "searchable":false,
        "writable":null,
        "internalOnly":false,
        "uiEditorType":null,
        "default":true,
        "listingVariant":false,
        "localizable":false,
        "textSearchable":false,
        "id":"discountable",
        "dimension":false,
        "editableAttributes":[
            "internalOnly",
            "default",
            "listingVariant",
            "hidden",
            "variantBasedDisplay",
            "textSearchable",
            "label",
            "dimension",
            "required",
            "searchable",
            "order",
            "multiSelect"
        ],
        "order":"-2",
        "multiSelect":null
    },
    {
        "itemType":"product",
        "hidden":false,
        "wildcardSearchable":true,
        "label":"Name",
        "type":"shortText",
        "required":true,
        "searchable":true,
        "writable":"true",
        "internalOnly":null,
        "default":null,
        "textSearchable":true,
        "id":"displayName",
        "dimension":null,
        "editableAttributes":[
            "textSearchable",
            "dimension",
            "internalOnly",
            "default",
            "order",
            "hidden",
            "label",
            "wildcardSearchable",
            "searchable"
        ],
        "order":"0"
    },
    {
        "itemType":"product",
        "hidden":false,
        "wildcardSearchable":null,
        "label":"Product Number",
        "type":"shortText",
        "required":true,
        "searchable":null,
        "writable":false,
        "internalOnly":null,
        "default":"p1815",
        "textSearchable":null,
        "id":"productNumber",
        "dimension":null,
        "editableAttributes":[
            "textSearchable",
            "dimension",
            "internalOnly",
            "default",
            "order",
            "hidden",
            "label",
            "wildcardSearchable",
            "searchable"
        ],
        "order":"10"
    },
    {
        "itemType":"product",
        "hidden":false,
        "wildcardSearchable":true,
        "label":"Description",
        "type":"shortText",
        "required":false,
        "searchable":true,
        "writable":"true",
        "internalOnly":null,
        "default":"A Cloud Lake Product.",
        "textSearchable":true,
        "id":"description",
        "dimension":null,
        "editableAttributes":[
            "textSearchable",
            "dimension",
            "internalOnly",
            "default",
            "order",
            "hidden",
            "label",
            "required",
            "wildcardSearchable",
            "searchable"
        ],
        "order":"10"
    },
    {
        "itemType":"product",
        "hidden":false,
        "wildcardSearchable":null,
        "label":"Brand",
        "type":"shortText",
        "required":false,
        "searchable":null,
        "writable":"true",
        "internalOnly":null,
        "default":null,
        "textSearchable":null,
        "id":"brand",
        "dimension":null,
        "editableAttributes":[
            "textSearchable",
            "dimension",
            "internalOnly",
            "default",
            "order",
            "hidden",
            "label",
            "required",
            "wildcardSearchable",
            "searchable"
        ],
        "order":"15"
    },
    {
        "itemType":"product",
        "hidden":false,
        "wildcardSearchable":null,
        "label":"Default List Price",
        "type":"currency",
        "required":true,
        "searchable":true,
        "writable":"true",
        "internalOnly":null,
        "default":null,
        "textSearchable":null,
        "id":"listPrice",
        "dimension":null,
        "editableAttributes":[
            "textSearchable",
            "dimension",
            "internalOnly",
            "default",
            "order",
            "hidden",
            "label",
            "wildcardSearchable",
            "searchable"
        ],
        "order":"20"
    },
    {
        "itemType":"product",
        "hidden":false,
        "wildcardSearchable":null,
        "label":"Default Sale Price",
        "type":"currency",
        "required":false,
        "searchable":true,
        "writable":"true",
        "internalOnly":null,
        "default":null,
        "textSearchable":null,
        "id":"salePrice",
        "dimension":null,
        "editableAttributes":[
            "textSearchable",
            "dimension",
            "internalOnly",
            "default",
            "order",
            "hidden",
            "label",
            "required",
            "wildcardSearchable",
            "searchable"
        ],
        "order":"20"
    },
    {
        "itemType":"product",
        "hidden":false,
        "wildcardSearchable":null,
        "label":"Product Code for US Taxes",
        "type":"shortText",
        "required":false,
        "searchable":null,
        "writable":"true",
        "internalOnly":null,
        "default":null,
        "textSearchable":null,
        "id":"taxCode",
        "dimension":null,
        "editableAttributes":[
            "textSearchable",
            "dimension",
            "internalOnly",
            "default",
            "order",
            "hidden",
            "label",
            "required",
            "wildcardSearchable",
            "searchable"
        ],
        "order":"25"
    },
    {
        "itemType":"product",
        "hidden":false,
        "wildcardSearchable":true,
        "label":"Long Description",
        "type":"shortText",
        "required":false,
        "searchable":true,
        "writable":"true",
        "internalOnly":null,
        "default":null,
        "textSearchable":true,
        "id":"longDescription",
        "dimension":null,
        "editableAttributes":[
            "textSearchable",
            "dimension",
            "internalOnly",
            "default",
            "order",
            "hidden",
            "label",
            "required",
            "wildcardSearchable",
            "searchable"
        ],
        "order":"30"
    },
    {
        "itemType":"product",
        "hidden":false,
        "wildcardSearchable":true,
        "label":"Active",
        "type":"checkbox",
        "required":false,
        "searchable":true,
        "writable":"true",
        "internalOnly":null,
        "default":null,
        "textSearchable":true,
        "id":"active",
        "dimension":null,
        "editableAttributes":[
            "textSearchable",
            "dimension",
            "internalOnly",
            "default",
            "order",
            "hidden",
            "label",
            "required",
            "wildcardSearchable",
            "searchable"
        ],
        "order":"50"
    },
    {
        "itemType":"product",
        "hidden":false,
        "wildcardSearchable":null,
        "label":"Arrival Date",
        "type":"date",
        "required":false,
        "searchable":null,
        "writable":"true",
        "internalOnly":null,
        "default":null,
        "textSearchable":null,
        "id":"arrivalDate",
        "dimension":null,
        "editableAttributes":[
            "textSearchable",
            "dimension",
            "internalOnly",
            "default",
            "order",
            "hidden",
            "label",
            "required",
            "wildcardSearchable",
            "searchable"
        ],
        "order":"60"
    },
    {
        "itemType":"product",
        "hidden":false,
        "wildcardSearchable":true,
        "label":"Height",
        "type":"number",
        "required":true,
        "searchable":true,
        "writable":"true",
        "internalOnly":false,
        "default":4,
        "textSearchable":true,
        "id":"height",
        "dimension":true,
        "editableAttributes":[
            "textSearchable",
            "dimension",
            "internalOnly",
            "default",
            "order",
            "hidden",
            "label",
            "required",
            "wildcardSearchable",
            "searchable"
        ],
        "order":"70"
    },
    {
        "itemType":"product",
        "hidden":false,
        "wildcardSearchable":null,
        "label":"Length",
        "type":"number",
        "required":false,
        "searchable":null,
        "writable":"true",
        "internalOnly":null,
        "default":null,
        "textSearchable":null,
        "id":"length",
        "dimension":null,
        "editableAttributes":[
            "textSearchable",
            "dimension",
            "internalOnly",
            "default",
            "order",
            "hidden",
            "label",
            "required",
            "wildcardSearchable",
            "searchable"
        ],
        "order":"80"
    },
    {
        "itemType":"product",
        "hidden":false,
        "wildcardSearchable":null,
        "label":"Width",
        "type":"number",
        "required":false,
        "searchable":false,
        "writable":"true",
        "internalOnly":false,
        "default":6,
        "textSearchable":false,
        "id":"width",
        "dimension":false,
        "editableAttributes":[
            "textSearchable",
            "dimension",
            "internalOnly",
            "default",
            "order",
            "hidden",
            "label",
            "required",
            "wildcardSearchable",
            "searchable"
        ],
        "order":"90"
    },
    {
        "itemType":"product",
        "hidden":false,
        "wildcardSearchable":null,
        "label":"Weight",
        "type":"number",
        "required":false,
        "searchable":null,
        "writable":"true",
        "internalOnly":null,
        "default":null,
        "textSearchable":null,
        "id":"weight",
        "dimension":null,
        "editableAttributes":[
            "textSearchable",
            "dimension",
            "internalOnly",
            "default",
            "order",
            "hidden",
            "label",
            "required",
            "wildcardSearchable",
            "searchable"
        ],
        "order":"100"
    },
    {
        "itemType":"product",
        "hidden":false,
        "wildcardSearchable":null,
        "label":"Order Limit",
        "type":"digit",
        "required":false,
        "searchable":null,
        "writable":"true",
        "internalOnly":null,
        "default":null,
        "textSearchable":null,
        "id":"orderLimit",
        "dimension":null,
        "editableAttributes":[
            "textSearchable",
            "dimension",
            "internalOnly",
            "default",
            "order",
            "hidden",
            "label",
            "required",
            "wildcardSearchable",
            "searchable"
        ],
        "order":"110"
    },
    {
        "itemType":"product",
        "hidden":false,
        "length":0,
        "variantBasedDisplay":null,
        "label":"salePrices",
        "type":"currencyMap",
        "required":false,
        "searchable":false,
        "writable":true,
        "internalOnly":null,
        "default":{
        },
        "listingVariant":null,
        "localizable":false,
        "textSearchable":false,
        "id":"salePrices",
        "dimension":false,
        "editableAttributes":[
            "dimension",
            "multiSelect",
            "textSearchable",
            "default",
            "internalOnly",
            "order",
            "listingVariant",
            "hidden",
            "label",
            "required",
            "variantBasedDisplay",
            "searchable"
        ],
        "multiSelect":null,
        "order":null
    },
    {
        "itemType":"product",
        "hidden":false,
        "length":0,
        "variantBasedDisplay":null,
        "label":"shippingSurcharges",
        "type":"currencyMap",
        "required":false,
        "searchable":false,
        "writable":true,
        "internalOnly":null,
        "default":{
        },
        "listingVariant":null,
        "localizable":false,
        "textSearchable":false,
        "id":"shippingSurcharges",
        "dimension":false,
        "editableAttributes":[
            "dimension",
            "multiSelect",
            "textSearchable",
            "default",
            "internalOnly",
            "order",
            "listingVariant",
            "hidden",
            "label",
            "required",
            "variantBasedDisplay",
            "searchable"
        ],
        "multiSelect":null,
        "order":null
    },
    {
        "itemType":"product",
        "hidden":false,
        "length":0,
        "variantBasedDisplay":null,
        "label":"listPrices",
        "type":"currencyMap",
        "required":false,
        "searchable":false,
        "writable":true,
        "internalOnly":null,
        "default":{
        },
        "listingVariant":null,
        "localizable":false,
        "textSearchable":false,
        "id":"listPrices",
        "dimension":false,
        "editableAttributes":[
            "dimension",
            "multiSelect",
            "textSearchable",
            "default",
            "internalOnly",
            "order",
            "listingVariant",
            "hidden",
            "label",
            "required",
            "variantBasedDisplay",
            "searchable"
        ],
        "multiSelect":null,
        "order":null
    }
]

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |33013|Get ItemDescriptor Error|
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