Skip to main content
GET
/
commerce
/
catalog
/
admin
/
discounts
/
{discountId}
/
content
Error
A valid request URL is required to generate request examples
{
  "name": "<string>",
  "localeCode": "<string>",
  "friendlyDescription": "<string>",
  "customPropertyValues": {
    "value1": "<string>",
    "value2": "<string>",
    "value3": "<string>",
    "value4": "<string>",
    "value5": "<string>",
    "value6": "<string>",
    "value7": "<string>",
    "value8": "<string>",
    "value9": "<string>",
    "value10": "<string>"
  },
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
discountId
integer<int32>
required

Unique identifier of the discount. System-supplied and read-only.

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Response

Success

Container for the language-specific name of the discount. You will have a container for each supported language (LocaleCode). This enables you to display the discount name in multiple languages yet manage it as a single discount internally.

​
name
string
required

Name of the discount.

Maximum string length: 200
​
localeCode
string | null

Lanugage used for the discount in the current catalog. Defaults setting for the active catalog.

Maximum string length: 8
​
friendlyDescription
string | null

Promotional text or HTML that can be utilized as friendly content like "Buy this product now and get X!"

​
customPropertyValues
object
​
auditInfo
object