getShopperInput
get
/ccadmin/v1/shopperInputs/{id}
Get Shopper Input. Get information about the specified ID.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID of Shopper Input.
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : ShopperInput_response
Type:
Show Source
object
-
label(optional):
string
Display name of the Shopper Input
-
name(optional):
string
Name of the Shopper Input
-
promptText(optional):
string
Helper text for the Shopper Input
-
repositoryId(optional):
string
Repository ID of the Shopper Input
-
required(optional):
boolean
Whether the Shopper Input is required
-
type(optional):
string
Data type of the Shopper Input. The valid types are shortText, longText, date, number, checkbox and enumerated. The type enumerated is for Single Selection List.
-
uiEditorType(optional):
string
UI editor type of the Shopper Input. The valid types are shortText, longText, date, number, checkbox and singleSelectionList.
-
values(optional):
array values
Values when the type=enumerated. Can also be set as a map of base -> localized values, for localization. For other data types array will be empty.
Nested Schema : values
Type:
array
Values when the type=enumerated. Can also be set as a map of base -> localized values, for localization. For other data types array will be empty.
Show Source
Example Response (application/json)
{
"uiEditorType":null,
"values":[
],
"repositoryId":"giftMessage",
"name":"Gift Message",
"label":"Gift Message",
"type":"shortText",
"promptText":"Enter the gift message",
"required":false
}
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|
|------------------|------------------|
|26402|Cannot find shopper input Id.|
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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