Create one negotiation
post
/fscmRestApi/resources/11.13.18.05/sellerNegotiations
Request
Header Parameters
-
Effective-Of: string
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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:
AttachmentsInformation about the attachments added to a seller negotiation line. -
AutoExtendDuration: number
Code for the current status of the auction.
-
AutoExtendFlag: boolean
Title:
Allow autoextendMaximum Length:1Contains one of the following values: true, false, or null. If the value is true, automatic extension on the close date is permitted based on the settings established in the negotiation. If the value is null, it indicates that no value has been assigned. The default setting is null. -
AutoExtendTriggerPeriod: number
Time period (in minutes) before the negotiation close date during which a submitted bid can trigger an automatic extension.
-
AutoExtensionsNumber: number
Number of times the application can extend the negotiation.
-
AwardByDate: string
(date-time)
Date when the application awards the negotiation.
-
bidders: array
Bidders
Title:
BiddersInformation about invited bidders who participate in negotiations with the seller and place bids on the available items. -
CloseDate: string
(date-time)
Date when the negotiation stops accepting bids from bidders.
-
Currency: string
Title:
Currency NameMaximum Length:80Name of the negotiation currency. -
CurrencyCode: string
Maximum Length:
15Abbreviation that identifies the negotiation currency. -
InstructionText: string
(byte)
Text that provides instructions for participants in the seller negotiation.
-
lines: array
Lines
Title:
LinesInformation about the products available for sale during a seller negotiation, such as laptop computers, machinery, or surplus materials. These products may be listed as individual line items in a forward auction. -
NegotiationTitle(required): string
Title:
Negotiation TitleMaximum Length:80Text that describes the purpose of the negotiation. -
OpenDate: string
(date-time)
Date when the negotiation starts accepting bids from bidders.
-
OpenImmediatelyFlag: boolean
Maximum Length:
1Contains one of the following values: true, false, or null. If true, bidders can submit bids immediately after the seller's negotiation is published. If false, bidders can submit bids only when the negotiation opens at its scheduled start time. If null, the value hasn't been set. The default value is null. -
PreviewDate: string
(date-time)
Date and time when the seller negotiation becomes available for bidder preview.
-
PreviewImmediatelyFlag: boolean
Maximum Length:
1Contains one of the following values: true, false, or null. If true, then bidders can preview the seller negotiation immediately after it's published. If false, then bidders can preview the negotiation only when it opens at its scheduled start time. If null, then the value hasn't been set. The default value is null. -
ProcurementBU: string
Title:
Business UnitMaximum Length:240Name of the procurement business unit that owns the seller negotiation. -
ProcurementBUId: integer
(int64)
Value that uniquely identifies the procurement business unit that owns the seller negotiation.
-
publishNegotiationErrors: array
Publish Negotiation Errors
Title:
Publish Negotiation ErrorsLists the errors rendered during the validation and publishing of a negotiation. -
Synopsis: string
Maximum Length:
4000Brief summary of the seller negotiation.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsInformation about the attachments added to a seller negotiation line.
Show Source
Nested Schema : Bidders
Type:
arrayTitle:
BiddersInformation about invited bidders who participate in negotiations with the seller and place bids on the available items.
Show Source
Nested Schema : Lines
Type:
arrayTitle:
LinesInformation about the products available for sale during a seller negotiation, such as laptop computers, machinery, or surplus materials. These products may be listed as individual line items in a forward auction.
Show Source
Nested Schema : Publish Negotiation Errors
Type:
arrayTitle:
Publish Negotiation ErrorsLists the errors rendered during the validation and publishing of a negotiation.
Show Source
Nested Schema : sellerNegotiations-attachments-item-post-request
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attachment. It's a primary key that the application creates when the user attaches a document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. Values include FILE, FOLDER, TEXT, or WEB_PAGE. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfoJSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) of the attachment. -
PostProcessingAction: string
Title:
PostProcessingActionName 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 SizeLength of the attached file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached file. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
UrlMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment.
Nested Schema : schema
Type:
Show Source
object-
Bidder: string
Title:
BidderMaximum Length:360Name of the bidder that the application invited to participate in the seller negotiation. -
BidderContact: string
Title:
Bidder ContactMaximum Length:255Name of the contact person associated with the bidder invited to participate in the seller negotiation. -
BidderContactId: integer
(int64)
Value that uniquely identifies the contact person associated with the bidder invited to participate in the seller negotiation.
-
BidderId: integer
(int64)
Value that uniquely identifies the bidder that the application invited to participate in the seller negotiation.
-
BidderSite: string
Title:
Bidder SiteMaximum Length:240Bidder site name linked to the bidder invited for seller negotiation. -
BidderSiteId: integer
(int64)
Value that uniquely identifies the bidder site associated with the bidder invited to participate in the seller negotiation.
-
RequestedBidderContact: string
Title:
Bidder ContactMaximum Length:255The name of the contact person at the bidding company who should respond to the negotiation. This value applies when the bidder approval is pending. -
RequestedBidderContactId: integer
(int64)
The value identifies the contact person at the bidder who's invited to respond to the negotiation. This value applies when the bidder approval is pending.
-
RequestedBidderId: integer
(int64)
Value that identifies the bidder that the application invites to respond to the negotiation. Applies during approval pending.
Nested Schema : schema
Type:
Show Source
object-
attachments: array
Attachments
Title:
AttachmentsInformation about the attachments added to a seller negotiation line. -
BidStartPrice: number
Starting price at which bidding begins for the line.
-
Category: string
Maximum Length:
2400Name of the category of the line. -
CategoryId: integer
(int64)
Value that uniquely identifies the category of the line.
-
Item: string
Maximum Length:
300Name of the item offered for sale in the seller negotiation. -
ItemId: integer
(int64)
Value that uniquely identifies the item available for sale in the seller negotiation.
-
ItemRevision: string
Maximum Length:
18Value that identifies the revision of the item. -
LineDescription: string
Maximum Length:
2500Description of the item offered for sale on the line in the seller negotiation. -
LineNumber: number
Title:
LineNumber that uniquely identifies the line within the seller negotiation. -
MinimumBidPriceIncrement: number
Title:
Price IncrementThe smallest increment a bidder needs to raise the price above the last bid for the new bid to be valid. -
NoteToBidders: string
Title:
Note to BiddersMaximum Length:4000Instructions given to bidders by the buyer regarding the specific item in the seller negotiation. -
PartialQuantityAllowedFlag: boolean
Maximum Length:
1Contains one of the following values: true, false, or null. If true, bidders can submit bids for a partial quantity of the line. If false, bidders must bid on the full quantity of the line. If null, the value hasn't been set. The default value is null. -
Quantity: number
Quantity of the item offered for sale in the seller negotiation.
-
ReservePrice: number
Title:
Reserve PriceThe minimum price that must be met or exceeded for the buyer to be obligated to sell the line item. -
SellerAuctionHeaderId(required): integer
(int64)
Value that uniquely identifies the seller negotiation.
-
SellerAuctionLineId: integer
(int64)
Value that uniquely identifies the line in the seller negotiation.
-
UOM: string
Title:
UOM NameMaximum Length:25Unit of measure of the item in the seller negotiation. -
UOMCode: string
Maximum Length:
3Abbreviation that identifies the unit of measure of the item in the seller negotiation.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsInformation about the attachments added to a seller negotiation line.
Show Source
Nested Schema : schema
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attachment. It's a primary key that the application creates when the user attaches a document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. Values include FILE, FOLDER, TEXT, or WEB_PAGE. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfoJSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) of the attachment. -
PostProcessingAction: string
Title:
PostProcessingActionName 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 SizeLength of the attached file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached file. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
UrlMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment.
Nested Schema : sellerNegotiations-publishNegotiationErrors-item-post-request
Type:
Show Source
objectResponse
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 : sellerNegotiations-item-response
Type:
Show Source
object-
attachments: array
Attachments
Title:
AttachmentsInformation about the attachments added to a seller negotiation line. -
AuctionStatusCode: string
Title:
StatusRead Only:trueMaximum Length:25Code for the current status of the auction. -
AutoExtendDuration: number
Code for the current status of the auction.
-
AutoExtendFlag: boolean
Title:
Allow autoextendMaximum Length:1Contains one of the following values: true, false, or null. If the value is true, automatic extension on the close date is permitted based on the settings established in the negotiation. If the value is null, it indicates that no value has been assigned. The default setting is null. -
AutoExtendTriggerPeriod: number
Time period (in minutes) before the negotiation close date during which a submitted bid can trigger an automatic extension.
-
AutoExtensionsNumber: number
Number of times the application can extend the negotiation.
-
AwardByDate: string
(date-time)
Date when the application awards the negotiation.
-
AwardStatusCode: string
Read Only:
trueMaximum Length:25Status of the negotiation award. -
BidderNegotiationStatus: string
Read Only:
trueMaximum Length:255The status of the negotiation as displayed to the bidder. -
BidderNegotiationStatusCode: string
Read Only:
trueMaximum Length:255Abbreviation that uniquely identifies the status of the negotiation displayed to the bidder. -
bidders: array
Bidders
Title:
BiddersInformation about invited bidders who participate in negotiations with the seller and place bids on the available items. -
CategorySetId: integer
Read Only:
trueCollection of items grouped into categories. -
CloseDate: string
(date-time)
Date when the negotiation stops accepting bids from bidders.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the seller negotiation. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the seller negotiation. -
Currency: string
Title:
Currency NameMaximum Length:80Name of the negotiation currency. -
CurrencyCode: string
Maximum Length:
15Abbreviation that identifies the negotiation currency. -
CurrentDateTime: string
(date-time)
Read Only:
trueCurrent system date and time. -
DraftLockedBy: string
Title:
NameRead Only:trueMaximum Length:240Name of the person who locked the draft negotiation. -
DraftLockedByPersonId: integer
(int64)
Read Only:
trueUnique identifier for the user who locked the draft negotiation. -
DraftLockedDate: string
(date-time)
Read Only:
trueDate when the draft negotiation was locked. -
DraftLockedFlag: boolean
Read Only:
trueMaximum Length:1Contains one of the following values: true, false, or null. If true, the draft negotiation is locked for editing. If false, the negotiation isn't locked for editing. If null, the value hasn't been set. The default value is null. -
DraftUnlockedByPersonId: integer
(int64)
Read Only:
trueUnique identifier for the user who unlocked the draft negotiation. -
DraftUnlockedDate: string
(date-time)
Read Only:
trueDate when the draft negotiation was unlocked. -
InstructionText: string
(byte)
Text that provides instructions for participants in the seller negotiation.
-
InventoryOrganizationId: integer
Read Only:
trueDefault inventory organization ID for the procurement business unit. -
IsPausedFlag: boolean
Read Only:
trueMaximum Length:1Contains one of the following values: true or false. If true, the negotiation is paused, if false, the negotiation isn't paused. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the seller negotiation. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the seller negotiation. -
lines: array
Lines
Title:
LinesInformation about the products available for sale during a seller negotiation, such as laptop computers, machinery, or surplus materials. These products may be listed as individual line items in a forward auction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Negotiation: string
Title:
NegotiationRead Only:trueMaximum Length:240Number that identifies the seller negotiation. -
NegotiationStatus: string
Title:
StatusRead Only:trueMaximum Length:255Status of the negotiation. A list of accepted values is defined in the lookup type PON_AUCTION_STATUS. -
NegotiationStatusCode: string
Read Only:
trueMaximum Length:255Abbreviation that uniquely identifies the status of the negotiation. A list of accepted values is defined in the lookup type PON_AUCTION_STATUS. -
NegotiationTitle: string
Title:
Negotiation TitleMaximum Length:80Text that describes the purpose of the negotiation. -
NumberOfActiveBids: integer
(int64)
Title:
BidsRead Only:trueTotal number of active bids currently valid in the seller negotiation. -
NumberOfBids: integer
(int64)
Title:
All BidsRead Only:trueTotal number of bids submitted for the seller negotiation. -
NumberOfExtensionsOccured: number
Read Only:
trueValue that identifies the number of extensions that have occurred when Autoextend is enabled. -
OpenDate: string
(date-time)
Date when the negotiation starts accepting bids from bidders.
-
OpenImmediatelyFlag: boolean
Maximum Length:
1Contains one of the following values: true, false, or null. If true, bidders can submit bids immediately after the seller's negotiation is published. If false, bidders can submit bids only when the negotiation opens at its scheduled start time. If null, the value hasn't been set. The default value is null. -
Owner: string
Title:
OwnerRead Only:trueMaximum Length:240Name of the person who created the negotiation. -
OwnerId: integer
(int64)
Read Only:
trueValue that uniquely identifies the person who created the negotiation. -
PausedDate: string
(date-time)
Read Only:
trueDate and time when the seller negotiation was paused. -
PausedRemarks: string
Read Only:
trueMaximum Length:2000Note to bidders provided by the buyer when pausing a seller negotiation. -
PreviewDate: string
(date-time)
Date and time when the seller negotiation becomes available for bidder preview.
-
PreviewImmediatelyFlag: boolean
Maximum Length:
1Contains one of the following values: true, false, or null. If true, then bidders can preview the seller negotiation immediately after it's published. If false, then bidders can preview the negotiation only when it opens at its scheduled start time. If null, then the value hasn't been set. The default value is null. -
ProcurementBU: string
Title:
Business UnitMaximum Length:240Name of the procurement business unit that owns the seller negotiation. -
ProcurementBUId: integer
(int64)
Value that uniquely identifies the procurement business unit that owns the seller negotiation.
-
publishNegotiationErrors: array
Publish Negotiation Errors
Title:
Publish Negotiation ErrorsLists the errors rendered during the validation and publishing of a negotiation. -
ResumeRemarks: string
Read Only:
trueMaximum Length:2000Note to bidders provided by the buyer when resuming a paused seller negotiation. -
SellerAuctionHeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the seller negotiation. -
Synopsis: string
Maximum Length:
4000Brief summary of the seller negotiation. -
TimeRemaining: string
Title:
Time RemainingRead Only:trueMaximum Length:255Indicates the time remaining before the seller negotiation closes.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsInformation about the attachments added to a seller negotiation line.
Show Source
Nested Schema : Bidders
Type:
arrayTitle:
BiddersInformation about invited bidders who participate in negotiations with the seller and place bids on the available items.
Show Source
Nested Schema : Lines
Type:
arrayTitle:
LinesInformation about the products available for sale during a seller negotiation, such as laptop computers, machinery, or surplus materials. These products may be listed as individual line items in a forward auction.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Publish Negotiation Errors
Type:
arrayTitle:
Publish Negotiation ErrorsLists the errors rendered during the validation and publishing of a negotiation.
Show Source
Nested Schema : sellerNegotiations-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attachment. It's a primary key that the application creates when the user attaches a document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueLogin that the user used when creating the attachment for the negotiation. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the attachment record. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. Values include FILE, FOLDER, TEXT, or WEB_PAGE. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfoJSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) of the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe Base64-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 and time when the user most recently updated the attachment. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who most recently updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the attachment for the negotiation. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionName 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 SizeLength of the attached file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached file. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
UrlMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Sign in details that the user used when adding or modifying 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 : sellerNegotiations-bidders-item-response
Type:
Show Source
object-
Bidder: string
Title:
BidderMaximum Length:360Name of the bidder that the application invited to participate in the seller negotiation. -
BidderContact: string
Title:
Bidder ContactMaximum Length:255Name of the contact person associated with the bidder invited to participate in the seller negotiation. -
BidderContactId: integer
(int64)
Value that uniquely identifies the contact person associated with the bidder invited to participate in the seller negotiation.
-
BidderCreationStatus: string
Read Only:
trueMaximum Length:255Display name of the status indicating whether supplier creation was successful after approval. Values include Canceled, Completed, and Error. A list of accepted values is defined in the lookup type POZ_SUPPLIER_CREATION_STATUS. -
BidderCreationStatusCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the status indicating whether supplier creation was successful after approval. Values include CANCELED, COMPLETED, and ERROR. A list of accepted values is defined in the lookup type POZ_SUPPLIER_CREATION_STATUS. -
BidderId: integer
(int64)
Value that uniquely identifies the bidder that the application invited to participate in the seller negotiation.
-
BidderInvitationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the bidder invited to the negotiation. -
BidderSite: string
Title:
Bidder SiteMaximum Length:240Bidder site name linked to the bidder invited for seller negotiation. -
BidderSiteId: integer
(int64)
Value that uniquely identifies the bidder site associated with the bidder invited to participate in the seller negotiation.
-
BusinessRelationship: string
Read Only:
trueMaximum Length:255Type of business relationship that the bidder has with the organization conducting the seller negotiation. Values include None, Prospective, and Spend Authorized. -
BusinessRelationshipCode: string
Title:
Business RelationshipRead Only:trueMaximum Length:30Abbreviation that identifies the type of business relationship that the bidder has with the organization conducting the seller negotiation. Values include NONE, PROSPECTIVE, and SPEND_AUTHORIZED. A list of accepted values is defined in the lookup type ORA_POZ_PURCHASING_RELATIONSHIP. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who added the bidder to the negotiation. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user added the bidder to the negotiation. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the bidder. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the bidder. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RegistrationStatus: string
Read Only:
trueMaximum Length:255Status of the bidder's registration request. Values include Approved, Not Submitted, Pending Approval, and Rejected. -
RegistrationStatusCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the status of the bidder's registration request. Values include APPROVED, DRAFT, PENDING, and REJECTED. -
RequestedBidder: string
Read Only:
trueMaximum Length:240Name of the bidder invited to the negotiation whose registration is pending approval. -
RequestedBidderContact: string
Title:
Bidder ContactMaximum Length:255The name of the contact person at the bidding company who should respond to the negotiation. This value applies when the bidder approval is pending. -
RequestedBidderContactId: integer
(int64)
The value identifies the contact person at the bidder who's invited to respond to the negotiation. This value applies when the bidder approval is pending.
-
RequestedBidderId: integer
(int64)
Value that identifies the bidder that the application invites to respond to the negotiation. Applies during approval pending.
-
SellerAuctionHeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the seller negotiation. -
SpendAuthorizationReviewStatus: string
Read Only:
trueMaximum Length:255Status of the bidder's spend authorization review. Values include Pending Approval and Rejected. -
SpendAuthorizationReviewStatusCode: string
Read Only:
trueMaximum Length:30Abbreviation that indicates the status of the bidder's spend authorization review. The possible statuses are PENDING_APPROVAL and REJECTED. Accepted statuses can be found in the lookup type ORA_POZ_SPEND_AUTH_REV_STATUS. -
VendorId: integer
(int64)
Read Only:
trueNumber that uniquely identifies the supplier.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : sellerNegotiations-lines-item-response
Type:
Show Source
object-
attachments: array
Attachments
Title:
AttachmentsInformation about the attachments added to a seller negotiation line. -
BestBidProxyMaximumPrice: number
Read Only:
trueThe highest amount the proxy bidding feature is allowed to bid for the bidder on this line. -
BidStartPrice: number
Starting price at which bidding begins for the line.
-
Category: string
Maximum Length:
2400Name of the category of the line. -
CategoryId: integer
(int64)
Value that uniquely identifies the category of the line.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who added the line to the negotiation. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user added the line to the negotiation. -
Item: string
Maximum Length:
300Name of the item offered for sale in the seller negotiation. -
ItemId: integer
(int64)
Value that uniquely identifies the item available for sale in the seller negotiation.
-
ItemRevision: string
Maximum Length:
18Value that identifies the revision of the item. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the line. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the line. -
LineDescription: string
Maximum Length:
2500Description of the item offered for sale on the line in the seller negotiation. -
LineNumber: number
Title:
LineNumber that uniquely identifies the line within the seller negotiation. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MinimumBidPriceIncrement: number
Title:
Price IncrementThe smallest increment a bidder needs to raise the price above the last bid for the new bid to be valid. -
NoteToBidders: string
Title:
Note to BiddersMaximum Length:4000Instructions given to bidders by the buyer regarding the specific item in the seller negotiation. -
PartialQuantityAllowedFlag: boolean
Maximum Length:
1Contains one of the following values: true, false, or null. If true, bidders can submit bids for a partial quantity of the line. If false, bidders must bid on the full quantity of the line. If null, the value hasn't been set. The default value is null. -
Quantity: number
Quantity of the item offered for sale in the seller negotiation.
-
ReservePrice: number
Title:
Reserve PriceThe minimum price that must be met or exceeded for the buyer to be obligated to sell the line item. -
SellerAuctionHeaderId: integer
(int64)
Value that uniquely identifies the seller negotiation.
-
SellerAuctionLineId: integer
(int64)
Value that uniquely identifies the line in the seller negotiation.
-
UOM: string
Title:
UOM NameMaximum Length:25Unit of measure of the item in the seller negotiation. -
UOMCode: string
Maximum Length:
3Abbreviation that identifies the unit of measure of the item in the seller negotiation.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsInformation about the attachments added to a seller negotiation line.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : sellerNegotiations-lines-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attachment. It's a primary key that the application creates when the user attaches a document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueLogin that the user used when creating the attachment for the negotiation. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the attachment record. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. Values include FILE, FOLDER, TEXT, or WEB_PAGE. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfoJSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) of the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe Base64-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 and time when the user most recently updated the attachment. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who most recently updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the attachment for the negotiation. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionName 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 SizeLength of the attached file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attached file. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
UrlMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Sign in details that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : sellerNegotiations-publishNegotiationErrors-item-response
Type:
Show Source
object-
ErrorMessageCode: string
Read Only:
trueMaximum Length:2000Value that uniquely identifies a specific error message, allowing for consistent error handling and troubleshooting. -
ErrorMessageDisplay: string
Read Only:
trueMaximum Length:255Value that uniquely identifies the user friendly text for error message. -
ErrorsListId: integer
(int64)
Read Only:
trueValue that uniquely identifies a group of related error messages. -
ErrorType: string
Read Only:
trueMaximum Length:30Value that uniquely identifies the category of the error. Applicable values are Error and Warning. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SellerAuctionHeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the seller negotiation.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- Cancel
-
Operation: /fscmRestApi/resources/11.13.18.05/sellerNegotiations/{sellerNegotiationsUniqID}/action/CancelParameters:
- sellerNegotiationsUniqID:
$request.path.sellerNegotiationsUniqID
Cancels a negotiation. - sellerNegotiationsUniqID:
- Close
-
Operation: /fscmRestApi/resources/11.13.18.05/sellerNegotiations/{sellerNegotiationsUniqID}/action/CloseParameters:
- sellerNegotiationsUniqID:
$request.path.sellerNegotiationsUniqID
Closes a seller negotiation immediately or by advancing the close date. - sellerNegotiationsUniqID:
- Extend
-
Operation: /fscmRestApi/resources/11.13.18.05/sellerNegotiations/{sellerNegotiationsUniqID}/action/ExtendParameters:
- sellerNegotiationsUniqID:
$request.path.sellerNegotiationsUniqID
Extends a seller negotiation by adjusting the close date and autoextend settings, allowing bidders more time to review, modify, and submit their bids. - sellerNegotiationsUniqID:
- Lock
-
Operation: /fscmRestApi/resources/11.13.18.05/sellerNegotiations/{sellerNegotiationsUniqID}/action/LockParameters:
- sellerNegotiationsUniqID:
$request.path.sellerNegotiationsUniqID
Locks a draft negotiation. - sellerNegotiationsUniqID:
- Pause
-
Operation: /fscmRestApi/resources/11.13.18.05/sellerNegotiations/{sellerNegotiationsUniqID}/action/PauseParameters:
- sellerNegotiationsUniqID:
$request.path.sellerNegotiationsUniqID
Pauses a negotiation. - sellerNegotiationsUniqID:
- Publish
-
Operation: /fscmRestApi/resources/11.13.18.05/sellerNegotiations/{sellerNegotiationsUniqID}/action/PublishParameters:
- sellerNegotiationsUniqID:
$request.path.sellerNegotiationsUniqID
Validates the completeness and correctness of the negotiation before publishing, displaying errors or warnings for correction. - sellerNegotiationsUniqID:
- RenumberLines
-
Parameters:
- sellerNegotiationsUniqID:
$request.path.sellerNegotiationsUniqID
Renumber negotiation lines to fill in gaps in line numbers created by deletion of negotiation lines. - sellerNegotiationsUniqID:
- Resume
-
Operation: /fscmRestApi/resources/11.13.18.05/sellerNegotiations/{sellerNegotiationsUniqID}/action/ResumeParameters:
- sellerNegotiationsUniqID:
$request.path.sellerNegotiationsUniqID
Resumes a paused negotiation. - sellerNegotiationsUniqID:
- Unlock
-
Operation: /fscmRestApi/resources/11.13.18.05/sellerNegotiations/{sellerNegotiationsUniqID}/action/UnlockParameters:
- sellerNegotiationsUniqID:
$request.path.sellerNegotiationsUniqID
Unlocks a draft negotiation. - sellerNegotiationsUniqID:
- attachments
-
Operation: /fscmRestApi/resources/11.13.18.05/sellerNegotiations/{sellerNegotiationsUniqID}/child/attachmentsParameters:
- sellerNegotiationsUniqID:
$request.path.sellerNegotiationsUniqID
Information about the attachments added to a seller negotiation. - sellerNegotiationsUniqID:
- bidders
-
Operation: /fscmRestApi/resources/11.13.18.05/sellerNegotiations/{sellerNegotiationsUniqID}/child/biddersParameters:
- sellerNegotiationsUniqID:
$request.path.sellerNegotiationsUniqID
Information about invited bidders who participate in negotiations with the seller and place bids on the available items. - sellerNegotiationsUniqID:
- lines
-
Operation: /fscmRestApi/resources/11.13.18.05/sellerNegotiations/{sellerNegotiationsUniqID}/child/linesParameters:
- sellerNegotiationsUniqID:
$request.path.sellerNegotiationsUniqID
Information about the products available for sale during a seller negotiation, such as laptop computers, machinery, or surplus materials. These products may be listed as individual line items in a forward auction. - sellerNegotiationsUniqID:
- publishNegotiationErrors
-
Parameters:
- sellerNegotiationsUniqID:
$request.path.sellerNegotiationsUniqID
Lists the errors rendered during the validation and publishing of a negotiation. - sellerNegotiationsUniqID: