Get one seller negotiation bid
get
/fscmRestApi/resources/11.13.18.05/sellerNegotiationBids/{BidNumber}
Request
Path Parameters
-
BidNumber(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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: 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.
There's no request body for this operation.
Back to TopResponse
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 : sellerNegotiationBids-item-response
Type:
Show Source
object-
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
AwardDate: string
(date-time)
Read Only:
trueDate when the negotiation award process is complete. -
AwardedLinesCount: number
Read Only:
trueValue that identifies the bidder who responds to the seller's negotiation. -
AwardReason: string
Title:
Award ReasonRead Only:trueMaximum Length:4000Reason provided by the auctioneer for awarding the seller negotiation to bidders. -
AwardStatus: string
Title:
MeaningRead Only:trueMaximum Length:80Value that indicates whether the bid is awarded or rejected. -
AwardStatusCode: string
Read Only:
trueMaximum Length:25Abbreviation that identifies whether the bid was awarded or rejected. -
Bidder: string
Title:
BidderRead Only:trueMaximum Length:360Name of the bidder who responds to the seller's negotiation. -
BidderBusinessRelationship: string
Title:
Business RelationshipRead Only:trueMaximum Length:30Business relationship of the bidder. -
BidderContact: string
Title:
Bidder ContactRead Only:trueMaximum Length:255Name of the contact person at the bidder who responds to the seller's negotiation. -
BidderContactId: integer
(int64)
Read Only:
trueValue that uniquely identifies the contact person at the bidder who responded to the seller negotiation. -
BidderId: integer
(int64)
Read Only:
trueValue that identifies the bidder who responds to the seller's negotiation. -
BidderReferenceNumber: string
Title:
Reference NumberMaximum Length:25Identification number used for the bidder's internal tracking. -
BidderSite: string
Title:
Bidder SiteRead Only:trueMaximum Length:240Name of the bidder site. -
BidderSiteId: integer
(int64)
Read Only:
trueValue that identifies the bidder site. -
BidExpirationDate: string
(date-time)
Title:
Bid Valid UntilDate on which the bid expires. -
BidNumber: integer
(int64)
Read Only:
trueValue that uniquely identifies the seller negotiation bid. -
BidTime: string
Read Only:
trueMaximum Length:255Time when the bid was submitted. -
BidTotal: number
Title:
Bid AmountTotal amount calculated from all individual line item bids placed by the bidder in response to a seller negotiation. -
CloseDate: string
(date-time)
Title:
Close DateRead Only:trueDate when the negotiation stops accepting bids from bidders. -
CloseDatePauseAdjusted: string
(date-time)
Read Only:
trueClose date of the negotiation, adjusted for when the negotiation is paused. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the seller negotiation bid. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the seller negotiation bid. -
CurrencyCode: string
Title:
CurrencyRead Only:trueMaximum Length:15Abbreviation that identifies the negotiation currency. -
CurrencyPricePrecision: integer
(int32)
Title:
Price PrecisionRead Only:trueValue that specifies the precision in the number of digits after the decimal for the negotiation currency. -
DraftLockedByContact: string
Title:
NameRead Only:trueMaximum Length:360Name of the bidder contact who has locked the draft bid, preventing others from editing or deleting it. -
DraftLockedByContactId: integer
(int64)
Read Only:
truePerson ID of the bidder contact who has locked the draft bid, preventing others from editing or deleting it. -
DraftLockedDate: string
(date)
Read Only:
trueDate and time when the draft was locked. -
DraftLockedFlag: boolean
Read Only:
trueMaximum Length:1Contains one of the following values: true or false. If true, the draft is locked for editing or deleting. If false, the draft isn't locked for editing or deleting. The default value is true. -
DraftUnlockedByContact: string
Title:
NameRead Only:trueMaximum Length:360Name of the bidder contact who has unlocked the draft bid. -
DraftUnlockedByContactId: integer
(int64)
Read Only:
truePerson ID of the bidder contact who has unlocked the draft bid. -
DraftUnlockedDate: string
(date)
Read Only:
trueDate and time when the draft was unlocked. -
HasRevisedBidCreatedFlag: boolean
Read Only:
trueMaximum Length:255Contains one of the following values: true or false. If true, a revised bid has been created using this bid as the source bid. If false, no revised bid has been created using this bid as the source bid. -
InstructionText: string
(byte)
Title:
InstructionsRead Only:trueText that provides instructions for participants in the seller negotiation. -
IsSingleActiveBidFlag: boolean
Read Only:
trueMaximum Length:255Contains one of the following values: true or false. If true, the bid is the only active bid in the negotiation. If false, more than one active bid is available. The default value is false. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user last updated the seller negotiation bid. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the seller negotiation bid. -
lines: array
Seller Negotiation Bid Lines
Title:
Seller Negotiation Bid LinesDetails regarding the bids made by participants in a seller negotiation, highlighting the proposed price and quantity for each auction item. These figures illustrate the competitive nature of bidders for specific products in a forward auction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoggedInBidderContactId: integer
Read Only:
trueValue that uniquely identifies the supplier contact who's logged into the supplier portal. -
Negotiation: string
Title:
Seller NegotiationRead Only:trueMaximum Length:240Number that identifies the seller negotiation. -
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 TitleRead Only:trueMaximum Length:80Text that describes the purpose of the negotiation. -
NoteToAuctionOwner: string
Title:
Note to AuctioneerMaximum Length:4000Note that the bidder enters information on behalf of the auction owner when responding to the seller negotiation. -
PartialResponseFlag: boolean
Read Only:
trueMaximum Length:1Contains one of the following values: true or false. If true, the bidder has submitted a partial response. A partial response means the bidder hasn't bid on all lines or is offering a lesser quantity than asked for in the negotiation line. -
PreviousBidNumber: integer
(int64)
Read Only:
trueValue that uniquely identifies the previous bid whose values were copied to create this bid during a revise action. -
ResponseStatus: string
Title:
Bid StatusRead Only:trueMaximum Length:255Status of the seller negotiation bid. -
ResponseStatusCode: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the status of the bid. -
SellerAuctionHeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the seller negotiation. -
TimeOfBid: string
(date-time)
Read Only:
trueDate and time when the bid was submitted for the seller negotiation. -
TimeRemaining: string
Title:
Time RemainingRead Only:trueMaximum Length:255Indicates the time remaining before the seller negotiation closes. -
TimeRemainingOrder: number
Read Only:
trueSort order of the negotiation based on the time remaining to close the negotiation. -
TotalAwardAmount: number
Title:
Award AmountRead Only:trueThe total amount awarded to the bidder. -
TotalLineAmount: number
Read Only:
trueTotal amount calculated as the sum of all line item amounts for which the bidder has submitted a response in the seller negotiation. -
VendorId: integer
(int64)
Read Only:
trueValue that identifies the bidder who responds to the seller's negotiation.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Seller Negotiation Bid Lines
Type:
arrayTitle:
Seller Negotiation Bid LinesDetails regarding the bids made by participants in a seller negotiation, highlighting the proposed price and quantity for each auction item. These figures illustrate the competitive nature of bidders for specific products in a forward auction.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : sellerNegotiationBids-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 IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document 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 CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
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:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last 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:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of 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 : sellerNegotiationBids-lines-item-response
Type:
Show Source
object-
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
AwardQuantity: number
Title:
Award QuantityRead Only:trueThe quantity awarded to the bid line. -
AwardReason: string
Title:
Award ReasonRead Only:trueMaximum Length:4000Reason provided by the auctioneer for awarding the seller negotiation line to the bidder. -
AwardStatus: string
Title:
Award StatusRead Only:trueMaximum Length:80Value that indicates whether the bid line is awarded or rejected. -
AwardStatusCode: string
Read Only:
trueMaximum Length:25Abbreviation that identifies whether the bid line was awarded or rejected. -
BestBidPrice: number
Title:
Best Bid PriceRead Only:trueThe best price quoted for the line item among all the bids. -
BidNumber: integer
(int64)
Read Only:
trueValue that uniquely identifies the seller's negotiation bid. -
BidPrice: number
Title:
Bid PricePrice quoted by the bidder for a line item in the seller negotiation. -
BidQuantity: number
Title:
Bid QuantityQuantity proposed by the bidder for the seller negotiation line. -
BidStartPrice: number
Title:
Start PriceRead Only:trueStarting price at which bidding begins for the line. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the seller negotiation bid line. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the seller negotiation bid line. -
IsBidQuantityEditableFlag: boolean
Read Only:
trueMaximum Length:1Contains one of the following values: true or false. If true, the bid quantity is editable. If false, the bid quantity isn't editable. The default value is true. -
IsReservePriceMetFlag: boolean
Title:
Reserve Price MetRead Only:trueMaximum Length:255Contains one of the following values: true, false, or null. If true, the bidder's bid meets or exceeds the reserve price for the line defined in the seller negotiation. If false, the bid doesn't meet the reserve price. If null, the reserve price hasn't been defined for the line in the seller negotiation. -
Item: string
Title:
ItemRead Only:trueMaximum Length:300Name of the item offered for sale in the seller negotiation. -
ItemRevision: string
Title:
RevisionRead Only:trueMaximum 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 bid line. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the bid line. -
LineAmount: integer
(int64)
Title:
Line AmountRead Only:trueAmount calculated for a line as price times quantity in a bid submitted to a seller negotiation. -
LineAwardAmount: number
Read Only:
trueAwarded amount for the bid line. -
LineDescription: string
Title:
DescriptionRead Only:trueMaximum Length:2500Description of the item offered for sale on the line in the seller negotiation. -
LineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the line in a bid. -
LineNumber: number
Title:
LineRead Only:trueNumber that uniquely identifies the line within the seller negotiation bid. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MinimumBidPriceIncrement: number
Read Only:
trueThe smallest increment a bidder needs to raise the price above the last bid for the new bid to be valid. -
NoteToAuctionOwner: string
Title:
Note to AuctioneerMaximum Length:4000Note that the bidder enters the information for a particular line on behalf of the auction owner when responding to the seller negotiation. -
PreviousBidPrice: number
Read Only:
truePrice specified for the line item in the previous bid. -
PreviousBidQuantity: number
Read Only:
trueQuantity specified for the line item in the previous bid. -
Rank: number
Title:
RankRead Only:trueValue that identifies the rank of the bidder's response compared to other competing bids for a particular line. -
SellerAuctionHeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the seller negotiation. -
TargetQuantity: number
Title:
Target QuantityRead Only:trueQuantity of the item offered for sale in the seller negotiation. -
UOM: string
Title:
UOM NameRead Only:trueMaximum Length:25Unit of measure of the item in the seller negotiation. -
UOMCode: string
Title:
UOM CodeRead Only:trueMaximum Length:3Abbreviation that identifies the unit of measure of the item in the seller negotiation.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : sellerNegotiationBids-lines-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 IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document 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 CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
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:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last 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:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- DisqualifyBid
-
Operation: /fscmRestApi/resources/11.13.18.05/sellerNegotiationBids/{BidNumber}/action/DisqualifyBidParameters:
- BidNumber:
$request.path.BidNumber
Disqualifies a bid submitted by a bidder in a seller negotiation. - BidNumber:
- LockDraftBid
-
Parameters:
- BidNumber:
$request.path.BidNumber
Locks a draft bid in a seller negotiation to prevent other users from the bidder from editing it. - BidNumber:
- SubmitBid
-
Parameters:
- BidNumber:
$request.path.BidNumber
Validates and submits a bid for a seller negotiation. - BidNumber:
- UnlockDraftBid
-
Operation: /fscmRestApi/resources/11.13.18.05/sellerNegotiationBids/{BidNumber}/action/UnlockDraftBidParameters:
- BidNumber:
$request.path.BidNumber
Unlocks a draft bid in a seller negotiation to allow it to be edited. - BidNumber:
- attachments
-
Parameters:
- BidNumber:
$request.path.BidNumber
The attachments resource is used to view, create, and update attachments. - BidNumber:
- lines
-
Parameters:
- BidNumber:
$request.path.BidNumber
Details regarding the bids made by participants in a seller negotiation, highlighting the proposed price and quantity for each auction item. These figures illustrate the competitive nature of bidders for specific products in a forward auction. - BidNumber: