Jump to

• Request
• Response
• Examples

Get a sales promotion

get

/crmRestApi/resources/11.13.18.05/salesPromotions/{SalesPromotionId}

Request

Path Parameters

• SalesPromotionId(required): integer(int64)
  The unique identifier of the sales promotion.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 get a sales promotion by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesPromotions/300100089846373

Example of Response Body

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

{
  SalesPromotionId: 300100089846373
  SalesPromotionCode: "56014333-0377-41a3-a886-c5cdd5adec0d"
  Name: "REST_PRO_61703667926"
  Description: "REST_PRO_61703667926"
  StartDate: "2015-10-22"
  EndDate: "2015-11-22"
  StatusCode: "INACTIVE"
  AdjustmentTypeCode: "LNDISCPERC"
  AdjustmentValue: null
  AdjustmentBasisCode: "LISTPRICE"
  ...
}

Back to Top