Jump to

• Request
• Response

Get all active seller negotiations

get

/fscmRestApi/resources/11.13.18.05/bidderSellerNegotiations

Request

Query Parameters

• 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
• finder: string
  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
  
  

  • PrimaryKey Finds the seller negotiation based on the primary key, which is the combination of SellerAuctionHeaderId; integer; , BidderId; integer; , and BidderSiteId; integer; .
    Finder Variables
    • BidderId; integer; Value that uniquely identifies the bidder that the application invited to participate in the seller negotiation.
    • BidderSiteId; integer; Value that uniquely identifies the bidder site associated with the bidder invited to participate in the seller negotiation.
    • SellerAuctionHeaderId; integer; Value that uniquely identifies the seller negotiation.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • BidderSiteId; integer; Value that uniquely identifies the bidder site associated with the bidder invited to participate in the seller negotiation.
  • CloseDate; string; Date when the negotiation stops accepting bids from bidders.
  • IsBidSubmittedFlag; boolean; Contains one of the following values: true or false. If true, the bidder has submitted at least one bid for the seller negotiation. If false, no bids have been submitted.
  • IsInvitationReceivedFlag; boolean; Contains one of the following values: true or false. It's true when the bidder has been invited to participate in the seller negotiation. otherwise, false.
  • Negotiation; string; Number that identifies the seller negotiation.
  • NegotiationTitle; string; Text that describes the purpose of the negotiation.
  • OpenDate; string; Date when the negotiation starts accepting bids from bidders.
  • SellerAuctionHeaderId; integer; Value that uniquely identifies the seller negotiation.
• totalResults: boolean
  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

• 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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : bidderSellerNegotiations

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/bidderSellerNegotiations-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "subgroup":"BidderSellerNegotiations",
        "usage":"BusinessObject",
        "group":"PRC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object bidderSellerNegotiations-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/bidderSellerNegotiations-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : bidderSellerNegotiations-item-response

Type: object

Show Source

• AllActiveBids: number
  Read Only: true

  Total number of active bids submitted by all bidders for a seller negotiation.
• AuctionStatusCode: string
  Read Only: true

  Maximum Length: 25

  Code for the current status of the auction.
• BidderContactId: integer (int64)
  Read Only: true

  Value that uniquely identifies the contact person associated with the bidder invited to participate in the seller negotiation.
• BidderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the bidder that the application invited to participate in the seller negotiation.
• BidderNegotiationStatus: string
  Read Only: true

  Maximum Length: 4000

  The status of the negotiation as displayed to the bidder.
• BidderNegotiationStatusCode: string
  Read Only: true

  Maximum Length: 4000

  Abbreviation that uniquely identifies the status of the negotiation displayed to the bidder.
• BidderSite: string
  Read Only: true

  Maximum Length: 240

  Bidder site name linked to the bidder invited for seller negotiation.
• BidderSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the bidder site associated with the bidder invited to participate in the seller negotiation.
• CloseDate: string (date)
  Read Only: true

  Date when the negotiation stops accepting bids from bidders.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the seller negotiation.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the seller negotiation.
• DraftBidNumber: number
  Read Only: true

  Value that identifies the bid number in Draft status, pending submission by the bidder for the seller negotiation.
• IsBidSubmittedFlag: boolean
  Read Only: true

  Contains one of the following values: true or false. If true, the bidder has submitted at least one bid for the seller negotiation. If false, no bids have been submitted.
• IsInvitationReceivedFlag: boolean
  Read Only: true

  Contains one of the following values: true or false. It's true when the bidder has been invited to participate in the seller negotiation. otherwise, false.
• IsPausedFlag: boolean
  Contains one of the following values: true or false. If true, the seller negotiation is paused. If false, the seller negotiation isn't paused.
• LatestBidNumber: number
  Read Only: true

  Value that uniquely identifies the latest submitted bid number, either active or disqualified, for the bidder in the seller negotiation.
• LatestBidStatusCode: string
  Read Only: true

  Maximum Length: 25

  Value that uniquely identifies the status of the latest submitted bid, either active or disqualified, for the bidder in the seller negotiation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Negotiation: string
  Read Only: true

  Maximum Length: 240

  Number that identifies the seller negotiation.
• NegotiationTitle: string
  Read Only: true

  Maximum Length: 80

  Text that describes the purpose of the negotiation.
• OpenDate: string (date)
  Read Only: true

  Date when the negotiation starts accepting bids from bidders.
• Owner: string
  Read Only: true

  Maximum Length: 240

  Name of the person who created the negotiation.
• OwnerId: integer (int64)
  Read Only: true

  Value that uniquely identifies the person who created the negotiation.
• PreviewDate: string (date)
  Read Only: true

  Date and time when the seller negotiation becomes available for bidder preview.
• ProcurementBU: string
  Read Only: true

  Maximum Length: 240

  Name of the procurement business unit that owns the seller negotiation.
• ProcurementBUId: integer (int64)
  Read Only: true

  Value that uniquely identifies the procurement business unit that owns the seller negotiation.
• PublishDate: string (date)
  Read Only: true

  Date when the seller negotiation was published.
• SellerAuctionHeaderId: integer
  Read Only: true

  Value that uniquely identifies the seller negotiation.
• Synopsis: string
  Read Only: true

  Maximum Length: 25

  Brief summary of the seller negotiation.
• TimeRemaining: string
  Read Only: true

  Maximum Length: 4000

  Indicates the time remaining before the seller negotiation closes.
• TimeRemainingOrder: number
  Read Only: true

  Sort order of the negotiation based on the time remaining to close the negotiation.
• YourBids: number
  Read Only: true

  Total number of bids submitted by the bidder for the seller negotiation.

{
    "type":"object",
    "properties":{
        "AllActiveBids":{
            "type":"number",
            "description":"Total number of active bids submitted by all bidders for a seller negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "AuctionStatusCode":{
            "maxLength":25,
            "type":"string",
            "description":"Code for the current status of the auction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BidderContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the contact person associated with the bidder invited to participate in the seller negotiation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "BidderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bidder that the application invited to participate in the seller negotiation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "BidderNegotiationStatus":{
            "maxLength":4000,
            "type":"string",
            "description":"The status of the negotiation as displayed to the bidder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BidderNegotiationStatusCode":{
            "maxLength":4000,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the status of the negotiation displayed to the bidder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BidderSite":{
            "maxLength":240,
            "type":"string",
            "description":"Bidder site name linked to the bidder invited for seller negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BidderSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bidder site associated with the bidder invited to participate in the seller negotiation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "CloseDate":{
            "type":"string",
            "description":"Date when the negotiation stops accepting bids from bidders.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the seller negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the seller negotiation.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DraftBidNumber":{
            "type":"number",
            "description":"Value that identifies the bid number in Draft status, pending submission by the bidder for the seller negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "IsBidSubmittedFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the bidder has submitted at least one bid for the seller negotiation. If false, no bids have been submitted.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "IsInvitationReceivedFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. It's true when the bidder has been invited to participate in the seller negotiation. otherwise, false.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "IsPausedFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the seller negotiation is paused. If false, the seller negotiation isn't paused.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LatestBidNumber":{
            "type":"number",
            "description":"Value that uniquely identifies the latest submitted bid number, either active or disqualified, for the bidder in the seller negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LatestBidStatusCode":{
            "maxLength":25,
            "type":"string",
            "description":"Value that uniquely identifies the status of the latest submitted bid, either active or disqualified, for the bidder in the seller negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Negotiation":{
            "maxLength":240,
            "type":"string",
            "description":"Number that identifies the seller negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NegotiationTitle":{
            "maxLength":80,
            "type":"string",
            "description":"Text that describes the purpose of the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "OpenDate":{
            "type":"string",
            "description":"Date when the negotiation starts accepting bids from bidders.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "Owner":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the person who created the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who created the negotiation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "PreviewDate":{
            "type":"string",
            "description":"Date and time when the seller negotiation becomes available for bidder preview.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ProcurementBU":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the procurement business unit that owns the seller negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit that owns the seller negotiation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "PublishDate":{
            "type":"string",
            "description":"Date when the seller negotiation was published.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SellerAuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the seller negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "Synopsis":{
            "maxLength":25,
            "type":"string",
            "description":"Brief summary of the seller negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TimeRemaining":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates the time remaining before the seller negotiation closes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TimeRemainingOrder":{
            "type":"number",
            "description":"Sort order of the negotiation based on the time remaining to close the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "YourBids":{
            "type":"number",
            "description":"Total number of bids submitted by the bidder for the seller negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top