Jump to

• Request
• Response

Get all seller negotiation bid lines

get

/fscmRestApi/resources/11.13.18.05/sellerNegotiationBids/{BidNumber}/child/lines

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
• 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 specific line in the seller negotiation bid using the primary key, which is the combination of BidNumber; integer; and LineId; integer; .
    Finder Variables
    • BidNumber; integer; Value that uniquely identifies the seller negotiation bid.
    • LineId; integer; Value that uniquely identifies the line in a bid.
  • PrimaryKeyFinder Finds the unique seller negotiation bid line using LineId; integer; .
    Finder Variables
    • LineId; integer; Value that uniquely identifies the line in a bid.
• 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:
  

  • BidNumber; integer; Value that uniquely identifies the seller's negotiation bid.
  • LineId; integer; Value that uniquely identifies the line in a bid.
  • SellerAuctionHeaderId; integer; Value that uniquely identifies the seller negotiation.
  • UOM; string; Unit of measure of the item in 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 : sellerNegotiationBids-lines

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/sellerNegotiationBids-lines-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."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object sellerNegotiationBids-lines-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/sellerNegotiationBids-lines-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 : sellerNegotiationBids-lines-item-response

Type: object

Show Source

• BestBidPrice: number
  Title: Best Bid Price

  Read Only: true

  The best price quoted for the line item among all the bids.
• BidNumber: integer (int64)
  Read Only: true

  Value that uniquely identifies the seller's negotiation bid.
• BidPrice: number
  Title: Bid Price

  Price quoted by the bidder for a line item in the seller negotiation.
• BidQuantity: number
  Title: Bid Quantity

  Quantity proposed by the bidder for the seller negotiation line.
• BidStartPrice: number
  Title: Start Price

  Read Only: true

  Starting price at which bidding begins for the line.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the seller negotiation bid line.
• IsReservePriceMetFlag: boolean
  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.
• Item: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Name of the item offered for sale in the seller negotiation.
• ItemRevision: string
  Title: Revision

  Read Only: true

  Maximum Length: 18

  Value that identifies the revision of the item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the bid line.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the bid line.
• LineAmount: string
  Title: Line Amount

  Read Only: true

  Maximum Length: 255

  Amount calculated for a line as price times quantity in a bid submitted to a seller negotiation.
• LineDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 2500

  Description of the item offered for sale on the line in the seller negotiation.
• LineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the line in a bid.
• LineNumber: number
  Title: Line

  Read Only: true

  Number that uniquely identifies the line within the seller negotiation bid.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteToAuctionOwner: string
  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.
• Rank: number
  Title: Rank

  Read Only: true

  Value that identifies the rank of the bidder's response compared to other competing bids for a particular line.
• SellerAuctionHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the seller negotiation.
• TargetQuantity: number
  Title: Target Quantity

  Read Only: true

  Quantity of the item offered for sale in the seller negotiation.
• UOM: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure of the item in the seller negotiation.
• UOMCode: string
  Title: UOM Code

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure of the item in the seller negotiation.

{
    "type":"object",
    "properties":{
        "BestBidPrice":{
            "title":"Best Bid Price",
            "type":"number",
            "description":"The best price quoted for the line item among all the bids.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BidNumber":{
            "type":"integer",
            "description":"Value that uniquely identifies the seller's negotiation bid.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "BidPrice":{
            "title":"Bid Price",
            "type":"number",
            "description":"Price quoted by the bidder for a line item in the seller negotiation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BidQuantity":{
            "title":"Bid Quantity",
            "type":"number",
            "description":"Quantity proposed by the bidder for the seller negotiation line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "BidStartPrice":{
            "title":"Start Price",
            "type":"number",
            "description":"Starting price at which bidding begins for the line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the seller negotiation bid line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the seller negotiation bid line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "IsReservePriceMetFlag":{
            "title":"Reserve Price Met",
            "maxLength":255,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Item":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Name of the item offered for sale in the seller negotiation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ItemRevision":{
            "title":"Revision",
            "maxLength":18,
            "type":"string",
            "description":"Value that identifies the revision of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the bid line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the bid line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineAmount":{
            "title":"Line Amount",
            "maxLength":255,
            "type":"string",
            "description":"Amount calculated for a line as price times quantity in a bid submitted to a seller negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineDescription":{
            "title":"Description",
            "maxLength":2500,
            "type":"string",
            "description":"Description of the item offered for sale on the line in the seller negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the line in a bid.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line",
            "type":"number",
            "description":"Number that uniquely identifies the line within the seller negotiation bid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteToAuctionOwner":{
            "title":"Note to Auctioneer",
            "maxLength":4000,
            "type":"string",
            "description":"Note that the bidder enters the information for a particular line on behalf of the auction owner when responding to the seller negotiation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Rank":{
            "title":"Rank",
            "type":"number",
            "description":"Value that identifies the rank of the bidder's response compared to other competing bids for a particular line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SellerAuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the seller negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "TargetQuantity":{
            "title":"Target Quantity",
            "type":"number",
            "description":"Quantity of the item offered for sale in the seller negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "UOM":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure of the item in the seller negotiation.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure of the item in the seller negotiation.",
            "nullable":false,
            "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