Get all seller negotiation bids

get

/fscmRestApi/resources/11.13.18.05/sellerNegotiationBids

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • EligibleBidsForBidderContactFinder Finds the bids eligible for the logged-in bidder contact in the bids workbench. This is used to return only bids on which the user can take action.
      Finder Variables
      • FindActiveBidsByLine Finds all the active bids for a specific seller negotiation line.
        Finder Variables
        • LineId; integer; Value that uniquely identifies the line in the negotiation.
        • SellerAuctionHeaderId; integer; Value that uniquely identifies the seller's negotiation.
      • PrimaryKey Finds the unique seller negotiation bid using the primary key, which is BidNumber; integer; .
        Finder Variables
        • BidNumber; integer; Value that uniquely identifies the seller's negotiation bid.
    • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
    • 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
    • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
    • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

      Format: ?q=expression1;expression2

      You can use these queryable attributes to filter this collection resource using the q query parameter:
      • AwardDate; string; Date when the negotiation award process is complete.
      • AwardStatusCode; string; Abbreviation that identifies whether the bid was awarded or rejected.
      • BidNumber; integer; Value that uniquely identifies the seller negotiation bid.
      • BidderId; integer; Value that identifies the bidder who responds to the seller's negotiation.
      • BidderSiteId; integer; Value that identifies the bidder site.
      • CloseDate; string; Date when the negotiation stops accepting bids from bidders.
      • DraftUnlockedByContact; string; Name of the bidder contact who has unlocked the draft bid.
      • Negotiation; string; Number that identifies the seller negotiation.
      • NegotiationStatusCode; string; Abbreviation that uniquely identifies the status of the negotiation. A list of accepted values is defined in the lookup type PON_AUCTION_STATUS.
      • NegotiationTitle; string; Text that describes the purpose of the negotiation.
      • ResponseStatusCode; string; Abbreviation that identifies the status of the bid.
      • SellerAuctionHeaderId; integer; Value that uniquely identifies the seller negotiation.
      • TimeRemainingOrder; number; Sort order of the negotiation based on the time remaining to close the negotiation.
      • VendorId; integer; Value that identifies the bidder who responds to the seller's negotiation.
    • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
    Header Parameters
    • 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".
    • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

    There's no request body for this operation.

    Back to Top

    Response

    Supported Media Types

    Default Response

    The following table describes the default response for this task.
    Headers
    • 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".
    • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
    Body ()
    Root Schema : sellerNegotiationBids
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : sellerNegotiationBids-item-response
    Type: object
    Show Source
    Nested Schema : Attachments
    Type: array
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
    Show Source
    Nested Schema : Seller Negotiation Bid Lines
    Type: array
    Title: Seller Negotiation Bid Lines
    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.
    Show Source
    Nested Schema : sellerNegotiationBids-attachments-item-response
    Type: object
    Show Source
    Nested Schema : sellerNegotiationBids-lines-item-response
    Type: object
    Show Source
    • Attachments
      Title: Attachments
      The attachments resource is used to view, create, and update attachments.
    • Title: Award Quantity
      Read Only: true
      The quantity awarded to the bid line.
    • Title: Award Reason
      Read Only: true
      Maximum Length: 4000
      Reason provided by the auctioneer for awarding the seller negotiation line to the bidder.
    • Title: Award Status
      Read Only: true
      Maximum Length: 80
      Value that indicates whether the bid line is awarded or rejected.
    • Read Only: true
      Maximum Length: 25
      Abbreviation that identifies whether the bid line was awarded or rejected.
    • Title: Best Bid Price
      Read Only: true
      The best price quoted for the line item among all the bids.
    • Read Only: true
      Value that uniquely identifies the seller's negotiation bid.
    • Title: Bid Price
      Price quoted by the bidder for a line item in the seller negotiation.
    • Title: Bid Quantity
      Quantity proposed by the bidder for the seller negotiation line.
    • Title: Start Price
      Read Only: true
      Starting price at which bidding begins for the line.
    • Read Only: true
      Maximum Length: 64
      User who created the seller negotiation bid line.
    • Read Only: true
      Date and time when the user created the seller negotiation bid line.
    • Read Only: true
      Maximum Length: 1
      Contains 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.
    • Title: Reserve Price Met
      Read Only: true
      Maximum Length: 255
      Contains 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.
    • Title: Item
      Read Only: true
      Maximum Length: 300
      Name of the item offered for sale in the seller negotiation.
    • Title: Revision
      Read Only: true
      Maximum Length: 18
      Value that identifies the revision of the item.
    • Read Only: true
      Date and time when the user most recently updated the bid line.
    • Read Only: true
      Maximum Length: 64
      User who most recently updated the bid line.
    • Title: Line Amount
      Read Only: true
      Amount calculated for a line as price times quantity in a bid submitted to a seller negotiation.
    • Read Only: true
      Awarded amount for the bid line.
    • Title: Description
      Read Only: true
      Maximum Length: 2500
      Description of the item offered for sale on the line in the seller negotiation.
    • Read Only: true
      Value that uniquely identifies the line in a bid.
    • Title: Line
      Read Only: true
      Number that uniquely identifies the line within the seller negotiation bid.
    • Links
    • Read Only: true
      The smallest increment a bidder needs to raise the price above the last bid for the new bid to be valid.
    • Title: Note to Auctioneer
      Maximum Length: 4000
      Note that the bidder enters the information for a particular line on behalf of the auction owner when responding to the seller negotiation.
    • Read Only: true
      Price specified for the line item in the previous bid.
    • Read Only: true
      Quantity specified for the line item in the previous bid.
    • Title: Rank
      Read Only: true
      Value that identifies the rank of the bidder's response compared to other competing bids for a particular line.
    • Read Only: true
      Value that uniquely identifies the seller negotiation.
    • Title: Target Quantity
      Read Only: true
      Quantity of the item offered for sale in the seller negotiation.
    • Title: UOM Name
      Read Only: true
      Maximum Length: 25
      Unit of measure of the item in the seller negotiation.
    • Title: UOM Code
      Read Only: true
      Maximum Length: 3
      Abbreviation that identifies the unit of measure of the item in the seller negotiation.
    Nested Schema : Attachments
    Type: array
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
    Show Source
    Nested Schema : sellerNegotiationBids-lines-attachments-item-response
    Type: object
    Show Source
    Back to Top