Jump to

• Request
• Response
• Examples

Create a sales promotion

post

/crmRestApi/resources/11.13.18.05/salesPromotions

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdjustmentBasisCode: string
  Title: Apply To

  Maximum Length: 30

  Default Value: LISTPRICE

  The code indicating the basis of the sales promotion adjustment when the adjustment type is Percent. For example List Price or Net Price.
• AdjustmentTypeCode: string
  Title: Adjustment Type

  Maximum Length: 30

  Default Value: LNDISCPERC

  The code indicating the type of the sales promotion adjustment. For example, Line Discount Amount or Line Discount Percent.
• AdjustmentValue: number
  Title: Adjustment Value

  The value of the sales promotion adjustment.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code of the sales promotion adjustment when the adjustment type is Amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• Description: string
  Title: Description

  Maximum Length: 1999

  The user-defined free form description of the sales promotion.
• EndDate: string (date)
  Title: End Date

  The end of the active period for the sales promotion, one second before midnight on the date indicated.
• Name: string
  Title: Name

  Maximum Length: 150

  The user-defined free form name of the sales promotion.
• SalesPromotionCode: string
  Title: Promotion Code

  Maximum Length: 80

  The code indicating the type of the sales promotion. This value is generated when a sales promotion is created.
• SalesPromotionId: integer (int64)
  The unique identifier of the sales promotion.
• StartDate: string (date)
  Title: Start Date

  The start of the active period for the sales promotion, one second after midnight on the date indicated.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: INACTIVE

  The status of the sales promotion.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start of the active period for the sales promotion, one second after midnight on the date indicated.",
            "format":"date",
            "nullable":true
        },
        "AdjustmentTypeCode":{
            "title":"Adjustment Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the sales promotion adjustment. For example, Line Discount Amount or Line Discount Percent.",
            "nullable":false,
            "default":"LNDISCPERC",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the sales promotion adjustment when the adjustment type is Amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"1999",
            "type":"string",
            "description":"The user-defined free form description of the sales promotion.",
            "nullable":true
        },
        "AdjustmentValue":{
            "title":"Adjustment Value",
            "type":"number",
            "description":"The value of the sales promotion adjustment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AdjustmentTypeCode"
                ]
            }
        },
        "SalesPromotionCode":{
            "title":"Promotion Code",
            "maxLength":"80",
            "type":"string",
            "description":"The code indicating the type of the sales promotion. This value is generated when a sales promotion is created.",
            "nullable":false
        },
        "SalesPromotionId":{
            "type":"integer",
            "description":"The unique identifier of the sales promotion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end of the active period for the sales promotion, one second before midnight on the date indicated.",
            "format":"date",
            "nullable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the sales promotion.",
            "nullable":false,
            "default":"INACTIVE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentBasisCode":{
            "title":"Apply To",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the basis of the sales promotion adjustment when the adjustment type is Percent. For example List Price or Net Price.",
            "nullable":true,
            "default":"LISTPRICE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The user-defined free form name of the sales promotion.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : salesPromotions-item-response

Type: object

Show Source

• AdjustmentBasisCode: string
  Title: Apply To

  Maximum Length: 30

  Default Value: LISTPRICE

  The code indicating the basis of the sales promotion adjustment when the adjustment type is Percent. For example List Price or Net Price.
• AdjustmentTypeCode: string
  Title: Adjustment Type

  Maximum Length: 30

  Default Value: LNDISCPERC

  The code indicating the type of the sales promotion adjustment. For example, Line Discount Amount or Line Discount Percent.
• AdjustmentValue: number
  Title: Adjustment Value

  The value of the sales promotion adjustment.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the sales promotion record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the sales promotion record was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code of the sales promotion adjustment when the adjustment type is Amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the promotion record can be deleted. The default value is true.
• Description: string
  Title: Description

  Maximum Length: 1999

  The user-defined free form description of the sales promotion.
• EndDate: string (date)
  Title: End Date

  The end of the active period for the sales promotion, one second before midnight on the date indicated.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the sales promotion record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the sales promotion record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the sales promotion record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 150

  The user-defined free form name of the sales promotion.
• SalesPromotionCode: string
  Title: Promotion Code

  Maximum Length: 80

  The code indicating the type of the sales promotion. This value is generated when a sales promotion is created.
• SalesPromotionId: integer (int64)
  The unique identifier of the sales promotion.
• StartDate: string (date)
  Title: Start Date

  The start of the active period for the sales promotion, one second after midnight on the date indicated.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: INACTIVE

  The status of the sales promotion.
• StatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  The meaning of the sales promotion status.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the promotion record can be updated. The default value is true.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the sales promotion record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the sales promotion record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the sales promotion record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"1999",
            "type":"string",
            "description":"The user-defined free form description of the sales promotion.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesPromotionId":{
            "type":"integer",
            "description":"The unique identifier of the sales promotion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end of the active period for the sales promotion, one second before midnight on the date indicated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the sales promotion.",
            "nullable":false,
            "default":"INACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the promotion record can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The user-defined free form name of the sales promotion.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start of the active period for the sales promotion, one second after midnight on the date indicated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentTypeCode":{
            "title":"Adjustment Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the sales promotion adjustment. For example, Line Discount Amount or Line Discount Percent.",
            "nullable":false,
            "default":"LNDISCPERC",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the sales promotion adjustment when the adjustment type is Amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the sales promotion status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the promotion record can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AdjustmentValue":{
            "title":"Adjustment Value",
            "type":"number",
            "description":"The value of the sales promotion adjustment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AdjustmentTypeCode"
                ]
            },
            "x-queryable":true
        },
        "SalesPromotionCode":{
            "title":"Promotion Code",
            "maxLength":"80",
            "type":"string",
            "description":"The code indicating the type of the sales promotion. This value is generated when a sales promotion is created.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AdjustmentBasisCode":{
            "title":"Apply To",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the basis of the sales promotion adjustment when the adjustment type is Percent. For example List Price or Net Price.",
            "nullable":true,
            "default":"LISTPRICE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the sales promotion record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the sales promotion record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

AdjustmentTypeSearchVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_QSC_PROMO_ADJ_TYPE

The list of values for the type of the sales promotion adjustment, such as Line Discount Amount or Line Discount Percent.

The following properties are defined on the LOV link relation:

• Source Attribute: AdjustmentTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

ApplyOnSearchVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_QSC_PROMO_ADJ_APPLON

The list of values for the basis of the sales promotion adjustment when the adjustment type is Percent, such as List Price or Net Price.

The following properties are defined on the LOV link relation:

• Source Attribute: AdjustmentBasisCode; Target Attribute: LookupCode
• Display Attribute: Meaning

StatusSearchLovVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_QSC_PROMO_STATUS

The list of values for the status of the sales promotion, such as Active or Inactive.

The following properties are defined on the LOV link relation:

• Source Attribute: StatusCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top

Examples

The following example shows how to create a sales promotion by submitting a post request on the REST resource using cURL.

cURL Command

: curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesPromotions

Example of Request Body

The following shows an example of the request body in JSON format.

{
  "Name" : "REST_PRO_a3803831037"
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
  SalesPromotionId: 300100089846378
  SalesPromotionCode: "e16fdcfc-e8cb-4e28-8082-162a3d911797"
  Name: "REST_PRO_a3803831037"
  Description: "Long description for the promotion"
  StartDate: "2016-11-22"
  EndDate: "2016-12-22"
  StatusCode: "INACTIVE"
  AdjustmentTypeCode: "LNDISCPERC"
  AdjustmentValue: null
  AdjustmentBasisCode: "LISTPRICE"
  CurrencyCode: null
  ...
}

Back to Top