getShopperInput

get

/ccadmin/v1/shopperInputs/{id}

Get Shopper Input. Get information about the specified ID.

Request

Supported Media Types
Path Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : ShopperInput_response
Type: object
Show Source
  • Display name of the Shopper Input
  • Name of the Shopper Input
  • Helper text for the Shopper Input
  • Repository ID of the Shopper Input
  • Whether the Shopper Input is required
  • 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.
  • UI editor type of the Shopper Input. The valid types are shortText, longText, date, number, checkbox and singleSelectionList.
  • 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.|
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