Jump to

• Request
• Response

createShopperInput

post

/ccadmin/v1/shopperInputs

Create a new Shopper Input. Creates a new Shopper Input based on request parameters. **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: string
  The asset language of the request

Body ()

Root Schema : ShopperInput_request

Type: object

Show Source

• id(optional): string
  ID of the Shopper Input
• label: 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: 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.

{
    "properties":{
        "uiEditorType":{
            "description":"UI editor type of the Shopper Input. \n The valid types are shortText, longText, date, number, checkbox and singleSelectionList.",
            "type":"string"
        },
        "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. Can also be set as a map of base -> localized values, for localization. For other data types array will be empty.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "name":{
            "description":"Name of the Shopper Input",
            "type":"string"
        },
        "id":{
            "description":"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. \n The valid types are shortText, longText, date, number, checkbox and enumerated. \n The type enumerated is for Single Selection List.",
            "type":"string"
        },
        "promptText":{
            "description":"Helper text for the Shopper Input",
            "type":"string"
        },
        "required":{
            "description":"Whether the Shopper Input is required",
            "type":"boolean"
        }
    },
    "required":[
        "type",
        "label"
    ],
    "example":{
        "name":"Gift Message",
        "id":"giftMessage",
        "label":"Gift Message",
        "type":"shortText",
        "promptText":"Enter the gift message",
        "required":false
    }
}

Example:

{
    "name":"Gift Message",
    "id":"giftMessage",
    "label":"Gift Message",
    "type":"shortText",
    "promptText":"Enter the gift message",
    "required":false
}

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. Can also be set as a map of base -> localized values, for localization. For other data types array will be empty.

Show Source

• Array of: string

{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : ShopperInput_response

Type: object

Show Source

• 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.

{
    "properties":{
        "uiEditorType":{
            "description":"UI editor type of the Shopper Input. \n The valid types are shortText, longText, date, number, checkbox and singleSelectionList.",
            "type":"string"
        },
        "values":{
            "description":"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.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "repositoryId":{
            "description":"Repository ID of the Shopper Input",
            "type":"string"
        },
        "name":{
            "description":"Name of the Shopper Input",
            "type":"string"
        },
        "label":{
            "description":"Display name of the Shopper Input",
            "type":"string"
        },
        "type":{
            "description":"Data type of the Shopper Input. \n The valid types are shortText, longText, date, number, checkbox and enumerated. \n The type enumerated is for Single Selection List.",
            "type":"string"
        },
        "promptText":{
            "description":"Helper text for the Shopper Input",
            "type":"string"
        },
        "required":{
            "description":"Whether the Shopper Input is required",
            "type":"boolean"
        }
    }
}

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

• Array of: string

{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response (application/json)

{
    "uiEditorType":null,
    "values":[
    ],
    "name":"Gift Message",
    "id":"giftMessage",
    "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| |------------------|------------------| |26400|Invalid data error. The exact error message will vary based on the property.| |26409|Id of a Shopper Input must be unique.|

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