1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Buyer Planning Agreements

Get one price agreement for an order

get

/fscmRestApi/resources/11.13.18.05/buyerPlanningAgreements/buyerPlanningAgreements

A GET action to retrieve data for a price agreement against an order.

Request

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 doesn't specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Match All
Show Source
Nested Schema : buyerPlanningAgreements-item
Type: object
Show Source
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 doesn't specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : buyerPlanningAgreements-item-response
Match All
Show Source
Nested Schema : buyerPlanningAgreements-item
Type: object
Show Source
Nested Schema : buyerPlanningAgreements-item-response-allOf[1]
Type: object
Show Source
Nested Schema : priceBreaks
Type: array
Show Source
Nested Schema : buyerPlanningAgreements-priceBreaks-item-response
Match All
Show Source
Nested Schema : buyerPlanningAgreements-priceBreaks-item
Type: object
Show Source
Back to Top

Examples

This example describes how to get one price agreement for an order using a POST action.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/buyerPlanningAgreements/buyerPlanningAgreements"

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 gets. 

{
	"DockDate":"2024-01-09",
	"MappedSupplierId":"300100569163913",
	"SupplierSite":"SpringField-S1",
	"ItemId":"26563215",
	"ItemRevisionCode":null,
	"UomCode":"Ea",
	"ConfiguredItemFlag":null,
	"MappedOrganizationId":"300100569182010",
	"OrderQuantity":200,
	"MappedLocationId":null,
	"PoHeaderId":null,
	"PoLineId":null
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "MappedSupplierId" : 300100569163913,
  "SupplierSite" : "SpringField-S1",
  "ItemId" : 26563215,
  "MappedItemId" : 300100569156726,
  "ItemPrice" : 127.8,
  "ItemRevisionCode" : null,
  "ConfiguredItemFlag" : null,
  "UomCode" : "Ea",
  "MappedOrganizationId" : 300100569182010,
  "OrderQuantity" : 200,
  "DockDate" : "2024-01-09",
  "LocationId" : null,
  "MappedLocationId" : null,
  "CurrencyCode" : "USD",
  "PoHeaderId" : null,
  "PoLineId" : null,
  "AgreementHeaderId" : 605277,
  "AgreementLineId" : 584317,
  "AgreementNumber" : "1002877",
  "AgreementHeaderReleaseAmount" : 0,
  "AgreementHeaderAmount" : 0,
  "AgreementStartDate" : null,
  "AgreementEndDate" : null,
  "AgreementHeaderMinReleaseAmount" : 0,
  "AgreementCurrencyCode" : "USD",
  "LineNumber" : "43",
  "LineMinimumReleaseAmount" : 92,
  "LineReleaseAmount" : 0,
  "LineAgreementQuantity" : 0,
  "LineAgreementAmount" : 0,
  "LineExpiryDate" : null,
  "OrderTotalPrice" : 25560,
  "PurchasingUomCode" : "Ea",
  "PriceBreakTypeCode" : "NON CUMULATIVE",
  "PriceBreakTypeName" : "Noncumulative",
  "PoDiscountType" : null,
  "PoDiscount" : 0,
  "PoIsNewPriceApplicable" : null,
  "UOMConversionRate" : 1,
  "priceBreaks" : [ {
    "PurchaseAgreementHeaderId" : 605277,
    "PurchaseAgreemenLineId" : 584317,
    "LocationId" : null,
    "LocationCode" : null,
    "MappedOrganizationId" : null,
    "OrganizationCode" : null,
    "PriceBreakId" : 531518,
    "Quantity" : 40,
    "PrimaryUOMQuantity" : 40,
    "Price" : 127.8,
    "PrimaryUOMPrice" : 127.8,
    "PriceDiscount" : 10,
    "StartDate" : null,
    "EndDate" : null
  } ]
}
Back to Top