REST API for Oracle Commerce Cloud 22A

addShopperInput

post

/ccadmin/v1/productTypes/{typeId}/shopperInputs

Adds a Shopper Input to Product Type.

Request

Supported Media Types

application/json

Path Parameters

typeId: string

ID of product type to which shopper input is to be attached.

Root Schema : addShopperInput_request

Type: object

Show Source

id: string

ID of Shopper Input to be attached to product type.

{
    "properties":{
        "id":{
            "description":"ID of Shopper Input to be attached to product type.",
            "type":"string"
        }
    },
    "required":[
        "id"
    ],
    "example":{
        "id":"giftMessage"
    }
}

Example:

{
    "id":"giftMessage"
}

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : addShopperInput_response

Type: object

Show Source

displayName(optional): string

Display name of product type.
id(optional): string

ID of the product type to which shopper input is attached.
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":{
                    "localizedValues":{
                        "description":"Localized enumerated values map (base -> localized), returned when type=enumerated and there is localization.",
                        "additionalProperties":{
                            "type":"string"
                        },
                        "type":"object"
                    },
                    "values":{
                        "description":"Values when the type=enumerated.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "name":{
                        "description":"Name of the Shopper Input",
                        "type":"string"
                    },
                    "id":{
                        "description":"Repository ID of the Shopper Input",
                        "type":"string"
                    },
                    "label":{
                        "description":"Display name of the Shopper Input",
                        "type":"string"
                    },
                    "type":{
                        "description":"Data type of the Shopper Input",
                        "type":"string"
                    },
                    "promptText":{
                        "description":"Helper text for the Shopper Input",
                        "type":"string"
                    },
                    "required":{
                        "description":"Whether the Shopper Input is required",
                        "type":"boolean"
                    }
                }
            }
        },
        "displayName":{
            "description":"Display name of product type.",
            "type":"string"
        },
        "id":{
            "description":"ID of the product type to which shopper input is attached.",
            "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":{
            "localizedValues":{
                "description":"Localized enumerated values map (base -> localized), returned when type=enumerated and there is localization.",
                "additionalProperties":{
                    "type":"string"
                },
                "type":"object"
            },
            "values":{
                "description":"Values when the type=enumerated.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "name":{
                "description":"Name of the Shopper Input",
                "type":"string"
            },
            "id":{
                "description":"Repository ID of the Shopper Input",
                "type":"string"
            },
            "label":{
                "description":"Display name of the Shopper Input",
                "type":"string"
            },
            "type":{
                "description":"Data type of the Shopper Input",
                "type":"string"
            },
            "promptText":{
                "description":"Helper text for the Shopper Input",
                "type":"string"
            },
            "required":{
                "description":"Whether the Shopper Input is required",
                "type":"boolean"
            }
        }
    }
}

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

id(optional): string

Repository ID of the Shopper Input
label(optional): string

Display name of the Shopper Input
localizedValues(optional): object localizedValues

Additional Properties Allowed: additionalProperties

Localized enumerated values map (base -> localized), returned when type=enumerated and there is localization.
name(optional): string

Name of the Shopper Input
promptText(optional): string

Helper text for the Shopper Input
required(optional): boolean

Whether the Shopper Input is required
type(optional): string

Data type of the Shopper Input
values(optional): array values

Values when the type=enumerated.

{
    "type":"object",
    "properties":{
        "localizedValues":{
            "description":"Localized enumerated values map (base -> localized), returned when type=enumerated and there is localization.",
            "additionalProperties":{
                "type":"string"
            },
            "type":"object"
        },
        "values":{
            "description":"Values when the type=enumerated.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "name":{
            "description":"Name of the Shopper Input",
            "type":"string"
        },
        "id":{
            "description":"Repository ID of the Shopper Input",
            "type":"string"
        },
        "label":{
            "description":"Display name of the Shopper Input",
            "type":"string"
        },
        "type":{
            "description":"Data type of the Shopper Input",
            "type":"string"
        },
        "promptText":{
            "description":"Helper text for the Shopper Input",
            "type":"string"
        },
        "required":{
            "description":"Whether the Shopper Input is required",
            "type":"boolean"
        }
    }
}

Nested Schema : localizedValues

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Localized enumerated values map (base -> localized), returned when type=enumerated and there is localization.",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Localized enumerated values map (base -> localized), returned when type=enumerated and there is localization.

Nested Schema : values

Type: array

Values when the type=enumerated.

Show Source

Array of: string

{
    "description":"Values when the type=enumerated.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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)

{
    "shopperInputs":[
        {
            "values":[
            ],
            "name":"Gift Message",
            "id":"giftMessage",
            "label":"Gift Message",
            "type":"shortText",
            "promptText":"Enter the gift message:",
            "required":false
        }
    ],
    "displayName":"New Product Type",
    "count":0,
    "id":"NewProductType",
    "variants":[
        {
            "itemType":"sku-NewProductType",
            "localizedValues":{
                "red":"rojo",
                "blue":"azul"
            },
            "hidden":false,
            "values":[
                "red",
                "blue"
            ],
            "variantBasedDisplay":"false",
            "wildcardSearchable":null,
            "label":"color",
            "type":"enumerated",
            "required":false,
            "searchable":null,
            "writable":"true",
            "internalOnly":null,
            "default":null,
            "listingVariant":"true",
            "textSearchable":null,
            "id":"color",
            "dimension":null,
            "editableAttributes":[
                "textSearchable",
                "dimension",
                "internalOnly",
                "default",
                "order",
                "listingVariant",
                "hidden",
                "label",
                "required",
                "variantBasedDisplay",
                "wildcardSearchable",
                "searchable"
            ],
            "order":null
        }
    ],
    "specifications":[
        {
            "itemType":"NewProductType",
            "hidden":false,
            "wildcardSearchable":true,
            "label":"New Property",
            "type":"shortText",
            "required":true,
            "searchable":"true",
            "writable":"true",
            "internalOnly":"false",
            "default":"null",
            "textSearchable":"true",
            "id":"newProperty",
            "dimension":"false",
            "editableAttributes":[
                "textSearchable",
                "dimension",
                "internalOnly",
                "default",
                "order",
                "hidden",
                "label",
                "required",
                "wildcardSearchable",
                "searchable"
            ],
            "order":null
        }
    ],
    "skuPropeties":[
    ]
}

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| |------------------|------------------| |20581|Could not find product type| |26402|Cannot find shopper input|

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"
        }
    }
}