REST API for Oracle Commerce Cloud December 2017

createProductTypeVariant

post

/ccadmin/v1/productVariants

Create Product Type Variant. Create a variant. **Requires the x-ccasset-language header so translated content can be set for a specific language.**

Request

Supported Media Types

application/json

Header Parameters

X-CCAsset-Language: Type: string

Required: true

The asset language of the request

Body Parameter

Root Schema : createProductTypeVariant_request

Example


{
    "listingVariant":false,
    "values":[
        "Beige",
        "Black"
    ],
    "variantBasedDisplay":false,
    "id":"color",
    "label":"Color",
    "productTypeId":"MensApparel"
}

Properties

productTypeId: Type: string

Required: true

The ID of the product type.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : createProductTypeVariant_response

Properties

count: Type: integer

Number of products of the current user-defined product type.
id: Type: string

ID of product type.
variants: Type: array variants

Additional Properties Allowed:

List of variants for user-defined product type.

Nested Schema : variants

Type: array

List of variants for user-defined product type.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

default: Type: string

Default value of variant.
dimension: Type: string

Dimension of variant.
editableAttributes: Type: array editableAttributes

Additional Properties Allowed:

List of editable attributes
id: Type: string

ID of variant.
internalOnly: Type: boolean

Whether variant is internal.
itemType: Type: string

Item type for user-defined product type.
label: Type: string

Label for new product type.
listingVariant: Type: boolean

Whether listing should be done based on this variant.
textSearchable: Type: boolean

Whether text is searchable or not.
type: Type: string

Data type of variant.
values: Type: array values

Additional Properties Allowed:

Values for variant.
variantBasedDisplay: Type: boolean

Whether this variant based display should be allowed
wildcardSearchable: Type: boolean

Whether wildcard is searchable or not.
writable: Type: string

Whether writable or not.

Nested Schema : editableAttributes

Type: array

List of editable attributes

Items

Type: object items

Additional Properties Allowed:

Nested Schema : values

Type: array

Values for variant.

Items

Type: string

Nested Schema : items

Type: object

Properties

default: Type: string

Default editable attribute.
dimension: Type: string

Dimensions of item type.
hidden: Type: boolean

Whether item is hidden.
internalOnly: Type: boolean

Whether variant is internal.
label: Type: string

Label for the item type.
listingVariant: Type: boolean

Whether listing should be done based on this variant.
order: Type: integer

Order count of item type.
required: Type: boolean

Whether it is required or not.
searchable: Type: boolean

Whether item searchable or not.
textSearchable: Type: boolean

Whether variant is searchable or not.
variantBasedDisplay: Type: boolean

Whether this variant based display should be allowed
wildcardSearchable: Type: boolean

Whether wildcard searchable or not.

Example application/json


{
    "count":4,
    "id":"MensApparel",
    "variants":[
        {
            "itemType":"sku-MensApparel",
            "hidden":false,
            "values":[
                "Beige",
                "Black"
            ],
            "length":19,
            "variantBasedDisplay":"true",
            "wildcardSearchable":null,
            "label":"Color",
            "type":"enumerated",
            "required":false,
            "searchable":null,
            "writable":"true",
            "uiEditorType":null,
            "internalOnly":"false",
            "default":null,
            "listingVariant":"true",
            "textSearchable":null,
            "id":"color",
            "dimension":null,
            "editableAttributes":[
                "dimension",
                "multiSelect",
                "textSearchable",
                "default",
                "internalOnly",
                "order",
                "listingVariant",
                "hidden",
                "label",
                "required",
                "variantBasedDisplay",
                "wildcardSearchable",
                "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| |------------------|------------------| |20123|No item descriptor name supplied when adding dynamic property| |20023|invalid listing and display variant combination| |20122|No property type supplied when adding dynamic property| |20022|Product Type cannot have multiple display variants| |20021|Error while updating the listing variant| |20120|No property name supplied when adding dynamic property| |20175|Create Product Type Null Properties Internal Error| |20020|Error while updating the display variant| |20196|No backing type found for UI property type {0}| |20019|Product Type cannot have multiple listing variants| |33015|Create Property ItemDescriptor Error| |26034|Could not find type of {0}.| |20170|Create Product Type Variant Internal Error| |20191|No product type id provided.|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{
  "listingVariant": false,
  "values": [
    "Beige",
    "Black"
  ],
  "variantBasedDisplay": false,
  "id": "color",
  "label": "Color",
  "productTypeId": "MensApparel"
}

Sample Response Payload returned by endpoint:

{
  "count": 4,
  "id": "MensApparel",
  "variants": [{
    "itemType": "sku-MensApparel",
    "hidden": false,
    "values": [
      "Beige",
      "Black"
    ],
    "length": 19,
    "variantBasedDisplay": "true",
    "wildcardSearchable": null,
    "label": "Color",
    "type": "enumerated",
    "required": false,
    "searchable": null,
    "writable": "true",
    "uiEditorType": null,
    "internalOnly": "false",
    "default": null,
    "listingVariant": "true",
    "textSearchable": null,
    "id": "color",
    "dimension": null,
    "editableAttributes": [
      "dimension",
      "multiSelect",
      "textSearchable",
      "default",
      "internalOnly",
      "order",
      "listingVariant",
      "hidden",
      "label",
      "required",
      "variantBasedDisplay",
      "wildcardSearchable",
      "searchable"
    ],
    "multiSelect": null,
    "order": null
  }]
}