Update one price break
patch
/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/lines/{LineId}/child/priceBreaks/{PriceBreakId}
Request
Path Parameters
-
LineId(required): number
Value that uniquely identifies the negotiation line.
-
PriceBreakId(required): number
Value that identifies the price break.
-
supplierNegotiationsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Supplier Negotiations resource and used to uniquely identify an instance of Supplier Negotiations. The client should not generate the hash key value. Instead, the client should query on the Supplier Negotiations collection resource in order to navigate to a specific instance of Supplier Negotiations to get the hash key.
Header Parameters
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Line: string
Number that identifies the negotiation line.
-
PriceBreakEndDate: string
(date)
Title:
End Date
Date when the price break expires. -
PriceBreakStartDate: string
(date)
Title:
Start Date
Date when the price break goes into effect. -
Quantity: number
Title:
Quantity
Quantity for the price break. -
ShipToLocation: string
Title:
Location
Maximum Length:60
Name of the location where the supplier ships the item. -
ShipToLocationId: integer
(int64)
Title:
Ship-to Location ID
Value that uniquely identifies the location where the supplier ships the item. -
ShipToOrganization: string
Title:
Ship-to Organization
Maximum Length:240
Name of the inventory organization where the supplier ships the item. -
ShipToOrganizationId: integer
(int64)
Title:
Ship-to Organization ID
Value that uniquely identifies the inventory organization where the supplier ships the item. -
TargetPrice: number
Title:
Target Price
Target price for the price break.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : supplierNegotiations-lines-priceBreaks-item-response
Type:
Show Source
object
-
AuctionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the negotiation. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the price break. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the price break. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the price break. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the price break. -
Line: string
Number that identifies the negotiation line.
-
LineDescription: string
Description of the negotiation line.
-
LineId: number
Read Only:
true
Value that uniquely identifies the negotiation line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriceBreakEndDate: string
(date)
Title:
End Date
Date when the price break expires. -
PriceBreakId: number
Title:
Price Break ID
Read Only:true
Value that identifies the price break. -
PriceBreakStartDate: string
(date)
Title:
Start Date
Date when the price break goes into effect. -
Quantity: number
Title:
Quantity
Quantity for the price break. -
ShipToLocation: string
Title:
Location
Maximum Length:60
Name of the location where the supplier ships the item. -
ShipToLocationId: integer
(int64)
Title:
Ship-to Location ID
Value that uniquely identifies the location where the supplier ships the item. -
ShipToOrganization: string
Title:
Ship-to Organization
Maximum Length:240
Name of the inventory organization where the supplier ships the item. -
ShipToOrganizationId: integer
(int64)
Title:
Ship-to Organization ID
Value that uniquely identifies the inventory organization where the supplier ships the item. -
TargetPrice: number
Title:
Target Price
Target price for the price break.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to update a price break.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/supplierNegotiations/supplierNegotiationsUniqID/child/lines/LineId/child/priceBreaks/PriceBreakId"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "ShipToLocation": "Sydney", "Quantity": 150 }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "AuctionHeaderId": 300100195048752, "LineId": 1, "PriceBreakId": 1, "ShipToOrganizationId": 204, "ShipToOrganization": "Tall Manufacturing", "ShipToLocationId": 207932, "ShipToLocation": "Sydney", "Quantity": 150, "TargetPrice": 150, "PriceBreakStartDate": null, "PriceBreakEndDate": null, "CreatedBy": "CLARE.JONES", "CreationDate": "2020-05-28T17:50:29+00:00", "LastUpdatedBy": "CLARE.JONES", "LastUpdateDate": "2020-05-28T18:04:02+00:00", "links": [...] }