Jump to

• Request
• Response

createProductType

post

/ccadmin/v1/productTypes

Create Product Type. Create a new user-defined product type based on ID.

Request

Supported Media Types

• application/json

Body ()

Root Schema : createProductType_request

Type: object

Show Source

• displayName: string
  Display name of product type.
• id: string
  ID of product type.

{
    "properties":{
        "displayName":{
            "description":"Display name of product type.",
            "type":"string"
        },
        "id":{
            "description":"ID of product type.",
            "type":"string"
        }
    },
    "required":[
        "displayName",
        "id"
    ],
    "example":{
        "displayName":"Sample Product",
        "id":"sampleProductType"
    }
}

Example:

{
    "displayName":"Sample Product",
    "id":"sampleProductType"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createProductType_response

Type: object

Show Source

• count(optional): integer
  Number of products of the current user-defined product type.
• displayName(optional): string
  Display name of item type.
• id(optional): string
  ID of product type.
• shopperInputs(optional): array shopperInputs
  List of Shopper Inputs for user-defined product type.
• skuProperties(optional): array skuProperties
  List of SKU properties for user-defined product type.
• specifications(optional): array specifications
  List of specifications for user-defined product type.
• variants(optional): array variants
  List of variants for user-defined product type

{
    "properties":{
        "skuProperties":{
            "description":"List of SKU properties for user-defined product type.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "shopperInputs":{
            "description":"List of Shopper Inputs for user-defined product type.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "displayName":{
            "description":"Display name of item type.",
            "type":"string"
        },
        "count":{
            "description":"Number of products of the current user-defined product type.",
            "type":"integer"
        },
        "id":{
            "description":"ID of product type.",
            "type":"string"
        },
        "variants":{
            "description":"List of variants for user-defined product type",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "specifications":{
            "description":"List of specifications for user-defined product type.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        }
    }
}

Nested Schema : shopperInputs

Type: array

List of Shopper Inputs for user-defined product type.

Show Source

• Array of: object items

{
    "description":"List of Shopper Inputs for user-defined product type.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : skuProperties

Type: array

List of SKU properties for user-defined product type.

Show Source

• Array of: object items

{
    "description":"List of SKU properties for user-defined product type.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : specifications

Type: array

List of specifications for user-defined product type.

Show Source

• Array of: object items

{
    "description":"List of specifications for user-defined product type.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : variants

Type: array

List of variants for user-defined product type

Show Source

• Array of: object items

{
    "description":"List of variants for user-defined product type",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Example Response (application/json)

[
    {
        "skuProperties":[
        ],
        "shopperInputs":[
        ],
        "displayName":"Sample Product",
        "count":0,
        "id":"sampleProductType",
        "variants":[
        ],
        "specifications":[
        ]
    }
]

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| |20122|No property type supplied when adding dynamic property| |20177|Invalid product type name provided| |20176|Cannot create duplicate product type| |20120|No property name supplied when adding dynamic property| |20174|Display name cannot be blank| |20634|Attempt to create a variant option with invalid type, Valid values are: enumerated.| |33013|Get ItemDescriptor Error| |20173|No display name provided| |20195|Product Type named already exists| |20172|Blank product type id provided| |20171|No product type id provided| |20170|Find Catalog Internal Error|

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