Create one special price agreement
post
/fscmRestApi/resources/11.13.18.05/channelSpecialPriceAgreements
Request
Header Parameters
-
Metadata-Context: string
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: string
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: string
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
Root Schema : schema
Type:
Show Source
object-
attachments: array
Attachments
Title:
AttachmentsThe Attachments resource is used to view, create, and update attachments. -
BusinessUnit: string
Maximum Length:
255Name of the business unit. -
BusinessUnitId(required): integer
(int64)
Value that uniquely identifies the business unit.
-
Competitor: string
Maximum Length:
255Value that uniquely identifies the competitor. -
CompetitorContact: string
Maximum Length:
1440Name of the competitor contact. -
CompetitorContactEmail: string
Maximum Length:
1280Competitor's contact email address. -
CompetitorContactPhoneCountryCode: string
Maximum Length:
10Competitor's contact phone country code. -
CompetitorContactPhoneExtension: string
Maximum Length:
20Competitor's contact phone number extension. -
CompetitorContactPhoneNumber: string
Maximum Length:
160Competitor's contact phone number. -
CompetitorId: integer
(int64)
Name of the competitor.
-
CompetitorRegistryId: string
Maximum Length:
255Number that uniquely identifies the competitor. -
Currency: string
Maximum Length:
255Name of the currency used for the special price agreement. -
CurrencyCode: string
Maximum Length:
15Abbreviation that identifies the currency used for the special price agreement. -
DateContextType: string
Maximum Length:
255Name of the effective date type used for evaluating the special price agreement eligibility. A list of accepted values is defined in the lookup ORA_CJM_SPA_DATE_QUAL. -
DateContextTypeCode(required): string
Maximum Length:
30Abbreviation that identifies the effective date type used for evaluating the special price agreement eligibility. -
Description: string
Maximum Length:
1000Description of the special price agreement. -
DFF: array
Channel Special Price Agreements Descriptive Flexfields
Title:
Channel Special Price Agreements Descriptive FlexfieldsThe Descriptive Flexfields for Channel Special Price Agreements resource manages additional details. -
Distributor: string
Maximum Length:
255Name of the distributor. -
DistributorBillToAccountId: integer
(int64)
Value that uniquely identifies the bill-to customer account of the distributor.
-
DistributorBillToAccountNumber: string
Maximum Length:
255Number that identifies the bill-to customer account of the distributor. -
DistributorContact: string
Maximum Length:
255Name of the distributor's bill-to customer account's contact. -
DistributorContactId: integer
(int64)
Value that uniquely represents the distributor's bill-to customer account's contact.
-
DistributorContactNumber: string
Maximum Length:
255Number that identifies the distributor's bill-to customer account's contact. -
EndCustomer: string
Maximum Length:
255Name of the end customer. -
EndCustomerContact: string
Maximum Length:
1440Name of the end customer contact. -
EndCustomerContactEmail: string
Maximum Length:
1280End customer's contact email address. -
EndCustomerContactPhoneCountryCode: string
Maximum Length:
10End customer's contact phone country code. -
EndCustomerContactPhoneExtension: string
Maximum Length:
20End customer's contact phone number extension. -
EndCustomerContactPhoneNumber: string
Maximum Length:
160End customer's contact phone number. -
EndCustomerId: integer
(int64)
Value that uniquely identifies the end customer.
-
EndCustomerRegistryId: string
Maximum Length:
255Number that uniquely identifies the end customer. -
EndDate(required): string
(date)
Date until when the special price agreement is applicable.
-
Justification: string
Maximum Length:
4000Comments submitted to provide additional information to the approvers. -
notes: array
Notes
Title:
NotesThe Notes resource captures comments, information, or instructions for a special price agreement. -
Outcome: string
Maximum Length:
255Outcome of the special price agreement. A list of accepted values is defined in the lookup ORA_CJM_SPA_OUTCOME. -
OutcomeCode: string
Maximum Length:
30Abbreviation that identifies the outcome of the special price agreement. -
Owner: string
Maximum Length:
255Name of the person who owns the special price agreement. This attribute defaults to the name of the person who creates the special price agreement. -
OwnerId: integer
(int64)
Value that uniquely identifies the person who owns the special price agreement.
-
OwnerPersonNumber: string
Maximum Length:
255Number that uniquely identifies the person who owns the special price agreement. -
products: array
Products
Title:
ProductsManages products of a special price agreement. -
ProgramType: string
Maximum Length:
255Type of program on which the special price agreement is based. -
ProgramTypeId(required): integer
(int64)
Value that uniquely identifies the type of program on which the special price agreement is based.
-
RequestType: string
Maximum Length:
255Request type for special price agreements. A list of accepted values is defined in the lookup ORA_CJM_SPA_REQUEST_TYPE. -
RequestTypeCode(required): string
Maximum Length:
30Abbreviation that identifies the request type for special price agreements. -
SpecialPriceAgreementName(required): string
Maximum Length:
240Name of the special price agreement. -
SpecialPriceAgreementNumber: string
Maximum Length:
30Number that uniquely identifies the special price agreement. -
StartDate(required): string
(date)
Date from when the special price agreement is applicable.
-
Status: string
Maximum Length:
255Status of the special price agreement. -
StatusId(required): integer
(int64)
Value that uniquely identifies the status of the special price agreement.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe Attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Channel Special Price Agreements Descriptive Flexfields
Type:
arrayTitle:
Channel Special Price Agreements Descriptive FlexfieldsThe Descriptive Flexfields for Channel Special Price Agreements resource manages additional details.
Show Source
Nested Schema : Notes
Type:
arrayTitle:
NotesThe Notes resource captures comments, information, or instructions for a special price agreement.
Show Source
Nested Schema : Products
Type:
arrayTitle:
ProductsManages products of a special price agreement.
Show Source
Nested Schema : schema
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEValue that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255Document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageError message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeSize of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameName to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextText content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000URL of a web page type attachment.
Nested Schema : channelSpecialPriceAgreements-DFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Descriptive flexfield context name for special price agreement. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for special price agreement. -
SpecialPriceAgreementId: integer
(int64)
Value that uniquely identifies the special price agreement.
Nested Schema : schema
Type:
Show Source
object-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDRelationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15Corporate currency code for extensibility. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDParty ID for the note creator. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30Currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15Currency code for extensibility. -
NoteNumber: string
Maximum Length:
30Alternate unique identifier of the note. This is a user key that is system generated or from an external system. -
NoteTitle: string
Title:
TitleMaximum Length:500Title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
NoteColumn that stores the actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30Note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDValue that uniquely identifies the parent source object associated to the note. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30Source object code for the source object as defined in the OBJECTS metadata. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64Value that uniquely identifies the parent source object associated to the note. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
VisibilityCode: string
Title:
PrivateMaximum Length:30Default Value:INTERNALAttribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
Nested Schema : schema
Type:
Show Source
object-
CompetitorItem: string
Maximum Length:
960Name of the competitor item. -
CompetitorItemPrice: number
Price of the competitor item.
-
Item: string
Maximum Length:
255Name of the item in the inventory. -
ItemId: string
Maximum Length:
240Value that uniquely identifies the item in the inventory. -
LineNumber: number
Number that identifies the product line.
-
OriginalUnitSellingPrice: number
Unit selling price of the item.
-
ProductId: integer
Value that uniquely identifies the product.
-
Quantity: number
Quantity of the items.
-
RebateAmount: number
Amount of the rebate.
-
RebateType: string
Maximum Length:
255Name of the rebate type. -
RebateTypeCode: string
Maximum Length:
30Abbreviation that identifies the rebate type. -
SpecialPriceAgreementId: integer
(int64)
Value that uniquely identifies the special price agreement program.
-
UnitOfMeasure: string
Maximum Length:
255Unit of measure of the item. -
UnitOfMeasureCode: string
Maximum Length:
30Abbreviation that identifies the unit of measure.
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.
Root Schema : channelSpecialPriceAgreements-item-response
Type:
Show Source
object-
AccountedEstimatedAmount: number
Read Only:
trueEstimated amount in the ledger currency. -
ApprovedDate: string
(date)
Read Only:
trueDate when the special price agreement is approved. -
attachments: array
Attachments
Title:
AttachmentsThe Attachments resource is used to view, create, and update attachments. -
BusinessUnit: string
Maximum Length:
255Name of the business unit. -
BusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit.
-
Competitor: string
Maximum Length:
255Value that uniquely identifies the competitor. -
CompetitorAddress: string
Read Only:
trueMaximum Length:255Address of the competitor. -
CompetitorContact: string
Maximum Length:
1440Name of the competitor contact. -
CompetitorContactEmail: string
Maximum Length:
1280Competitor's contact email address. -
CompetitorContactPhoneCountryCode: string
Maximum Length:
10Competitor's contact phone country code. -
CompetitorContactPhoneExtension: string
Maximum Length:
20Competitor's contact phone number extension. -
CompetitorContactPhoneNumber: string
Maximum Length:
160Competitor's contact phone number. -
CompetitorId: integer
(int64)
Name of the competitor.
-
CompetitorRegistryId: string
Maximum Length:
255Number that uniquely identifies the competitor. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
Currency: string
Maximum Length:
255Name of the currency used for the special price agreement. -
CurrencyCode: string
Maximum Length:
15Abbreviation that identifies the currency used for the special price agreement. -
DateContextType: string
Maximum Length:
255Name of the effective date type used for evaluating the special price agreement eligibility. A list of accepted values is defined in the lookup ORA_CJM_SPA_DATE_QUAL. -
DateContextTypeCode: string
Maximum Length:
30Abbreviation that identifies the effective date type used for evaluating the special price agreement eligibility. -
Description: string
Maximum Length:
1000Description of the special price agreement. -
DFF: array
Channel Special Price Agreements Descriptive Flexfields
Title:
Channel Special Price Agreements Descriptive FlexfieldsThe Descriptive Flexfields for Channel Special Price Agreements resource manages additional details. -
Distributor: string
Maximum Length:
255Name of the distributor. -
DistributorBillToAccountAddress: string
Read Only:
trueMaximum Length:255Primary bill-to account address of the distributor's bill-to customer account. -
DistributorBillToAccountId: integer
(int64)
Value that uniquely identifies the bill-to customer account of the distributor.
-
DistributorBillToAccountNumber: string
Maximum Length:
255Number that identifies the bill-to customer account of the distributor. -
DistributorContact: string
Maximum Length:
255Name of the distributor's bill-to customer account's contact. -
DistributorContactEmail: string
Read Only:
trueMaximum Length:255Email of the distributor's bill-to customer account's contact. -
DistributorContactId: integer
(int64)
Value that uniquely represents the distributor's bill-to customer account's contact.
-
DistributorContactNumber: string
Maximum Length:
255Number that identifies the distributor's bill-to customer account's contact. -
DistributorContactPhoneNumber: string
Read Only:
trueMaximum Length:255Phone number of the distributor's bill-to customer account's contact. -
DistributorContactPhoneNumberExtension: string
Read Only:
trueMaximum Length:255Phone number extension of the distributor's bill-to customer account's contact. -
EndCustomer: string
Maximum Length:
255Name of the end customer. -
EndCustomerAddress: string
Read Only:
trueMaximum Length:255Address of the end customer. -
EndCustomerContact: string
Maximum Length:
1440Name of the end customer contact. -
EndCustomerContactEmail: string
Maximum Length:
1280End customer's contact email address. -
EndCustomerContactPhoneCountryCode: string
Maximum Length:
10End customer's contact phone country code. -
EndCustomerContactPhoneExtension: string
Maximum Length:
20End customer's contact phone number extension. -
EndCustomerContactPhoneNumber: string
Maximum Length:
160End customer's contact phone number. -
EndCustomerId: integer
(int64)
Value that uniquely identifies the end customer.
-
EndCustomerRegistryId: string
Maximum Length:
255Number that uniquely identifies the end customer. -
EndDate: string
(date)
Date until when the special price agreement is applicable.
-
EstimatedAmount: number
Read Only:
trueEstimated amount for the special price agreement. -
FunctionalCurrency: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the functional currency used for the special price agreement. -
FunctionalCurrencyCode: string
Read Only:
trueMaximum Length:255Name of the functional currency used for the special price agreement. -
Justification: string
Maximum Length:
4000Comments submitted to provide additional information to the approvers. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
notes: array
Notes
Title:
NotesThe Notes resource captures comments, information, or instructions for a special price agreement. -
Outcome: string
Maximum Length:
255Outcome of the special price agreement. A list of accepted values is defined in the lookup ORA_CJM_SPA_OUTCOME. -
OutcomeCode: string
Maximum Length:
30Abbreviation that identifies the outcome of the special price agreement. -
Owner: string
Maximum Length:
255Name of the person who owns the special price agreement. This attribute defaults to the name of the person who creates the special price agreement. -
OwnerId: integer
(int64)
Value that uniquely identifies the person who owns the special price agreement.
-
OwnerPersonNumber: string
Maximum Length:
255Number that uniquely identifies the person who owns the special price agreement. -
products: array
Products
Title:
ProductsManages products of a special price agreement. -
ProgramTemplate: string
Read Only:
trueMaximum Length:255Name of the predefined program template on which the special price agreement is based. A list of accepted values is defined in the lookup ORA_CJM_PROGRAM_TYPE. -
ProgramTemplateCode: string
Read Only:
trueMaximum Length:30Default Value:SPECIAL_PRICE_AGREEMENTAbbreviation that identifies the predefined program template on which the special price agreement is based. -
ProgramType: string
Maximum Length:
255Type of program on which the special price agreement is based. -
ProgramTypeId: integer
(int64)
Value that uniquely identifies the type of program on which the special price agreement is based.
-
RejectedDate: string
(date)
Read Only:
trueDate when the special price agreement is rejected. -
RequestType: string
Maximum Length:
255Request type for special price agreements. A list of accepted values is defined in the lookup ORA_CJM_SPA_REQUEST_TYPE. -
RequestTypeCode: string
Maximum Length:
30Abbreviation that identifies the request type for special price agreements. -
ShipFromDistributorInventoryFlag: boolean
Read Only:
trueMaximum Length:1Default Value:trueContains one of the following values: true or false. If true, then the special price agreement is for the distributor's existing inventory. If false, then the special price agreement is for a new inventory. This attribute is defaulted to true. -
SpecialPriceAgreementId: integer
(int64)
Read Only:
trueValue that uniquely identifies the special price agreement. -
SpecialPriceAgreementName: string
Maximum Length:
240Name of the special price agreement. -
SpecialPriceAgreementNumber: string
Maximum Length:
30Number that uniquely identifies the special price agreement. -
StartDate: string
(date)
Date from when the special price agreement is applicable.
-
Status: string
Maximum Length:
255Status of the special price agreement. -
StatusId: integer
(int64)
Value that uniquely identifies the status of the special price agreement.
-
SubmittedBy: string
Read Only:
trueMaximum Length:255Name that identifies the user who submitted the special price agreement for approval. -
SubmittedDate: string
(date)
Read Only:
trueDate when the special price agreement is submitted. -
SystemStatus: string
Read Only:
trueMaximum Length:255System status of the special price agreement. -
SystemStatusCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the system status of the special price agreement.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe Attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Channel Special Price Agreements Descriptive Flexfields
Type:
arrayTitle:
Channel Special Price Agreements Descriptive FlexfieldsThe Descriptive Flexfields for Channel Special Price Agreements resource manages additional details.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Notes
Type:
arrayTitle:
NotesThe Notes resource captures comments, information, or instructions for a special price agreement.
Show Source
Nested Schema : Products
Type:
arrayTitle:
ProductsManages products of a special price agreement.
Show Source
Nested Schema : channelSpecialPriceAgreements-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueUser who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEValue that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255Document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageError message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueBase64 encoded image of the file displayed in .png format, if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueUser who most recently updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeSize of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameName to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextText content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Session login associated with the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : channelSpecialPriceAgreements-DFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Descriptive flexfield context name for special price agreement. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for special price agreement. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SpecialPriceAgreementId: integer
(int64)
Value that uniquely identifies the special price agreement.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : channelSpecialPriceAgreements-notes-item-response
Type:
Show Source
object-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDRelationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15Corporate currency code for extensibility. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDParty ID for the note creator. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30Currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15Currency code for extensibility. -
DeleteFlag: boolean
Title:
Delete IndicatorRead Only:trueIndicates whether the user has access to delete the note. -
EmailAddress: string
Read Only:
trueMaximum Length:320Email address of the user who created the note. -
FormattedAddress: string
Read Only:
trueAddress of the user who created the note. -
FormattedPhoneNumber: string
Read Only:
truePhone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who most recently updated the record. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32Session login associated with the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note IDRead Only:trueValue that uniquely identifies the note. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30Alternate unique identifier of the note. This is a user key that is system generated or from an external system. -
NoteTitle: string
Title:
TitleMaximum Length:500Title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
NoteColumn that stores the actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30Note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDValue that uniquely identifies the parent source object associated to the note. -
PartyId: integer
(int64)
Read Only:
trueValue that uniquely identifies the party. -
PartyName: string
Title:
AuthorRead Only:trueMaximum Length:360Name of the party. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30Source object code for the source object as defined in the OBJECTS metadata. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64Value that uniquely identifies the parent source object associated to the note. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
UpdateFlag: boolean
Title:
Update IndicatorRead Only:trueIndicates whether the user can update the note. -
VisibilityCode: string
Title:
PrivateMaximum Length:30Default Value:INTERNALAttribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : channelSpecialPriceAgreements-products-item-response
Type:
Show Source
object-
CompetitorItem: string
Maximum Length:
960Name of the competitor item. -
CompetitorItemPrice: number
Price of the competitor item.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the record. -
EstimatedAmount: number
Read Only:
trueEstimated rebate amount for the item. -
Item: string
Maximum Length:
255Name of the item in the inventory. -
ItemDescription: string
Read Only:
trueMaximum Length:255Description of the item in the inventory. -
ItemId: string
Maximum Length:
240Value that uniquely identifies the item in the inventory. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the record. -
LineNumber: number
Number that identifies the product line.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OriginalUnitSellingPrice: number
Unit selling price of the item.
-
ProductId: integer
Value that uniquely identifies the product.
-
Quantity: number
Quantity of the items.
-
RebateAmount: number
Amount of the rebate.
-
RebateType: string
Maximum Length:
255Name of the rebate type. -
RebateTypeCode: string
Maximum Length:
30Abbreviation that identifies the rebate type. -
SpecialPriceAgreementId: integer
(int64)
Value that uniquely identifies the special price agreement program.
-
UnitOfMeasure: string
Maximum Length:
255Unit of measure of the item. -
UnitOfMeasureCode: string
Maximum Length:
30Abbreviation that identifies the unit of measure.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- DFF
-
Operation: /fscmRestApi/resources/11.13.18.05/channelSpecialPriceAgreements/{SpecialPriceAgreementId}/child/DFFParameters:
- SpecialPriceAgreementId:
$request.path.SpecialPriceAgreementId
The Descriptive Flexfields for Channel Special Price Agreements resource manages additional details. - SpecialPriceAgreementId:
- DateContextTypeVVO
-
Parameters:
- finder:
findProgramTypeDateQualifiers%3BbindProgramTypeId%3D{ProgramTypeId}
The following properties are defined on the LOV link relation:- Source Attribute: DateContextTypeCode; Target Attribute: QualifierTypeCode
- Display Attribute: QualifierType
- finder:
- DistributorAccountVO
-
Parameters:
- finder:
default%3BbindOrgId%3D{BusinessUnitId}
The following properties are defined on the LOV link relation:- Source Attribute: DistributorBillToAccountNumber; Target Attribute: AccountNumber
- Display Attribute: AccountNumber, CustomerName
- finder:
- DistributorContactVO
-
Parameters:
- finder:
default%3BbindBillToCustomerId%3D{DistributorBillToAccountId}%2CbindSiteUseCode%3DBILL_TO
The following properties are defined on the LOV link relation:- Source Attribute: DistributorContactId; Target Attribute: ContactId
- Display Attribute: Name, Email, JobTitle
- finder:
- DistributorVO
-
Parameters:
- finder:
default%3BbindOrgId%3D{BusinessUnitId}
The following properties are defined on the LOV link relation:- Source Attribute: DistributorBillToAccountId; Target Attribute: CustomerAccountId
- Display Attribute: CustomerName
- finder:
- FinFunBusinessUnitVO
-
Parameters:
- finder:
ModuleIdFinder%3BIntent%3DCJM_MANAGE_CHANNEL_PROGRAMS_DATA%2CModuleId%3D30
The following properties are defined on the LOV link relation:- Source Attribute: BusinessUnitId; Target Attribute: BusinessUnitId
- Display Attribute: BusinessUnitName
- finder:
- OutcomeLookupVVO
-
Parameters:
- finder:
LookupTypeFinder%3BbindLookupType%3DORA_CJM_SPA_OUTCOME
The following properties are defined on the LOV link relation:- Source Attribute: OutcomeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- OwnersVVO
-
Parameters:
- finder:
ActiveOwnerFinder
The following properties are defined on the LOV link relation:- Source Attribute: OwnerId; Target Attribute: PersonId
- Display Attribute: Name, Email, BusinessTitle
- finder:
- ProgramTypeVO
-
Parameters:
- finder:
FindByProgramTemplate%3BbindProgramTemplateCode%3DSPECIAL_PRICE_AGREEMENT
The following properties are defined on the LOV link relation:- Source Attribute: ProgramTypeId; Target Attribute: ProgramTypeId
- Display Attribute: ProgramTypeName
- finder:
- RequestTypeLookupVVO
-
Parameters:
- finder:
LookupTypeFinder%3BbindLookupType%3DORA_CJM_SPA_REQUEST_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: RequestTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- UserStatusVO
-
Parameters:
- finder:
SellSideStatusFinder%3BbindUserStatusForCode%3DSPECIAL_PRICE_AGREEMENT
The following properties are defined on the LOV link relation:- Source Attribute: StatusId; Target Attribute: UserStatusId
- Display Attribute: UserStatusName
- finder:
- attachments
-
Parameters:
- SpecialPriceAgreementId:
$request.path.SpecialPriceAgreementId
The Attachments resource is used to view, create, and update attachments. - SpecialPriceAgreementId:
- notes
-
Parameters:
- SpecialPriceAgreementId:
$request.path.SpecialPriceAgreementId
The Notes resource captures comments, information, or instructions for a special price agreement. - SpecialPriceAgreementId:
- products
-
Parameters:
- SpecialPriceAgreementId:
$request.path.SpecialPriceAgreementId
Manages products of a special price agreement. - SpecialPriceAgreementId:
- submit
-
Parameters:
- SpecialPriceAgreementId:
$request.path.SpecialPriceAgreementId
Action to submit a special price agreement. - SpecialPriceAgreementId:
Examples
This example describes how to create special price agreements.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/channelSpecialPriceAgreements"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{
"SpecialPriceAgreementName": "Seven Corporation Bid Request",
"BusinessUnit": "Vision Operations",
"ProgramType": "CR_SPA_AUTO",
"RequestType": "Bid Request",
"Status": "Draft",
"DateContextType": "Actual Ship Date",
"StartDate": "2025-07-01",
"EndDate": "2025-11-20",
"CurrencyCode": "USD",
"Description": "Special Price Agreement description",
"Justification": "Justification",
"Outcome": "Won",
"Distributor": "Seven Corporation",
"DistributorBillToAccountId": 300100581001701,
"DistributorBillToAccountNumber": "226331",
// "DistributorContact": "Mark Jackson",
// "DistributorContactId": 1401,
"DistributorContactNumber": "CDRM_311274",
"EndCustomerId": 1718236,
"EndCustomer": "SMALL INC",
"EndCustomerRegistryId": "1521032",
"EndCustomerContact": "Patric@small.com",
"EndCustomerContactEmail": null,
"EndCustomerContactPhoneCountryCode": null,
"EndCustomerContactPhoneNumber": null,
"EndCustomerContactPhoneExtension": null,
"Competitor": null,
"CompetitorId": 1008,
"CompetitorRegistryId": null,
"CompetitorContact": null,
"CompetitorContactEmail": "evans@nine.com",
"CompetitorContactPhoneCountryCode": null,
"CompetitorContactPhoneNumber": null,
"CompetitorContactPhoneExtension": null,
"products": [
{
"Item": "AS72111",
"UnitOfMeasure": "Each",
"RebateType": "Percent",
"RebateAmount": 10.5,
"OriginalUnitSellingPrice": 125,
"Quantity": 12
},
{
"Item": "AS54999",
"UnitOfMeasure": "Each",
"RebateType": "Amount",
"RebateAmount": 12.54,
"OriginalUnitSellingPrice": 150,
"Quantity": 15
}
]
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"SpecialPriceAgreementId": 300100667476911,
"SpecialPriceAgreementNumber": "SPA68012",
"SpecialPriceAgreementName": "Seven Corporation Bid Request",
"BusinessUnitId": 204,
"BusinessUnit": "Vision Operations",
"ProgramTypeId": 300100638425358,
"ProgramType": "CR_SPA_AUTO",
"ProgramTemplateCode": "SPECIAL_PRICE_AGREEMENT",
"ProgramTemplate": "Special Price Agreement",
"RequestTypeCode": "ORA_BID_REQUEST",
"RequestType": "Bid Request",
"ShipFromDistributorInventoryFlag": true,
"StatusId": 100106596209338,
"Status": "Draft",
"SystemStatusCode": "ORA_DRAFT",
"SystemStatus": "Draft",
"OwnerId": 300100592838596,
"Owner": "Evans Sonneshien1",
"OwnerPersonNumber": "955160008195285",
"DateContextTypeCode": "ORA_ACTUAL_SHIP_DATE",
"DateContextType": "Actual Ship Date",
"StartDate": "2025-07-01",
"EndDate": "2025-11-20",
"Currency": "US Dollar",
"CurrencyCode": "USD",
"FunctionalCurrency": "US Dollar",
"FunctionalCurrencyCode": "USD",
"EstimatedAmount": 345.6,
"AccountedEstimatedAmount": null,
"Description": "Special Price Agreement description",
"Justification": "Justification",
"OutcomeCode": "ORA_WON",
"Outcome": "Won",
"Distributor": "Seven Corporation",
"DistributorBillToAccountId": 300100581001701,
"DistributorBillToAccountNumber": "226331",
"DistributorBillToAccountAddress": "234 10th Avenue,ELMONT, NY 11003",
"DistributorContact": null,
"DistributorContactId": null,
"DistributorContactNumber": "CDRM_311274",
"DistributorContactEmail": null,
"DistributorContactPhoneNumber": null,
"DistributorContactPhoneNumberExtension": null,
"EndCustomerId": 1718236,
"EndCustomerRegistryId": "1521032",
"EndCustomer": "SMALL INC",
"EndCustomerAddress": "610 N MATSON ST,48402 \r\r,KERSHAW, SC 290671014",
"EndCustomerContact": "Patric@small.com",
"EndCustomerContactEmail": null,
"EndCustomerContactPhoneCountryCode": null,
"EndCustomerContactPhoneNumber": null,
"EndCustomerContactPhoneExtension": null,
"Competitor": null,
"CompetitorId": null,
"CompetitorRegistryId": null,
"CompetitorAddress": null,
"CompetitorContact": null,
"CompetitorContactEmail": null,
"CompetitorContactPhoneCountryCode": null,
"CompetitorContactPhoneNumber": null,
"CompetitorContactPhoneExtension": null,
"CreatedBy": "channel_user",
"CreationDate": "2025-09-09T06:22:36+00:00",
"LastUpdateDate": "2025-09-09T06:22:38.722+00:00",
"LastUpdatedBy": "channel_user",
"SubmittedBy": null,
"SubmittedDate": null,
"ApprovedDate": null,
"RejectedDate": null,
"products": [
{
"ProductId": 300100667476913,
"SpecialPriceAgreementId": 300100667476911,
"LineNumber": 1,
"ItemId": "628",
"UnitOfMeasureCode": "Ea",
"OriginalUnitSellingPrice": 125,
"RebateTypeCode": "ORA_PERCENT",
"RebateAmount": 10.5,
"Quantity": 12,
"EstimatedAmount": 157.50,
"CompetitorItem": null,
"CompetitorItemPrice": null,
"CreatedBy": "channel_user",
"CreationDate": "2025-09-09T06:22:37.476+00:00",
"LastUpdatedBy": "channel_user",
"LastUpdateDate": "2025-09-09T06:22:38.759+00:00",
"Item": "AS72111",
"ItemDescription": "Envoy Deluxe Laptop",
"UnitOfMeasure": "Each",
"RebateType": "Percent",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/channelSpecialPriceAgreements/300100667476911/child/products/300100667476913",
"name": "products",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/channelSpecialPriceAgreements/300100667476911/child/products/300100667476913",
"name": "products",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/channelSpecialPriceAgreements/300100667476911",
"name": "channelSpecialPriceAgreements",
"kind": "item"
}
]
},
{
"ProductId": 300100667476914,
"SpecialPriceAgreementId": 300100667476911,
"LineNumber": 2,
"ItemId": "2155",
"UnitOfMeasureCode": "Ea",
"OriginalUnitSellingPrice": 150,
"RebateTypeCode": "ORA_AMOUNT",
"RebateAmount": 12.54,
"Quantity": 15,
"EstimatedAmount": 188.10,
"CompetitorItem": null,
"CompetitorItemPrice": null,
"CreatedBy": "channel_user",
"CreationDate": "2025-09-09T06:22:38.540+00:00",
"LastUpdatedBy": "channel_user",
"LastUpdateDate": "2025-09-09T06:22:38.769+00:00",
"Item": "AS54999",
"ItemDescription": "Sentinel Standard Desktop - Rugged",
"UnitOfMeasure": "Each",
"RebateType": "Amount",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/channelSpecialPriceAgreements/300100667476911/child/products/300100667476914",
"name": "products",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/channelSpecialPriceAgreements/300100667476911/child/products/300100667476914",
"name": "products",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/channelSpecialPriceAgreements/300100667476911",
"name": "channelSpecialPriceAgreements",
"kind": "item"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/channelSpecialPriceAgreements/300100667476911",
"name": "channelSpecialPriceAgreements",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/channelSpecialPriceAgreements/300100667476911",
"name": "channelSpecialPriceAgreements",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/channelSpecialPriceAgreements/300100667476911/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/channelSpecialPriceAgreements/300100667476911/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/channelSpecialPriceAgreements/300100667476911/child/notes",
"name": "notes",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/channelSpecialPriceAgreements/300100667476911/child/products",
"name": "products",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/channelSpecialPriceAgreements/300100667476911/action/submit",
"name": "submit",
"kind": "other"
}
]
}