Bulk update orders
post
/fscmRestApi/resources/11.13.18.05/buyerPlanningSupplies/buyerPlanningSupplies/
Bulk update orders
Request
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 doesn't specify this header in the request the server picks a default version for the API.
Supported Media Types
- application/batch+json
Nested Schema : buyerPlanningSupplies-bulkItems
Type:
Show Source
object-
$context: object
$context
-
$key: object
$key
-
ConsolidationTransactionId: integer
(int64)
Title:
Consolidation Transaction IdValue that uniquely identifies associated consolidated orders. -
ImplementDockDate: string
(date)
Title:
Implement Dock DateDate when the material should be on the receiving dock when the order is released. -
ImplementFirm: integer
(int64)
Title:
Implement FirmValue that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO. -
ImplementQuantity: integer
(int64)
Title:
Implement QuantityQuantity of the order that's released. -
MarkForReleaseOption: integer
(int64)
Title:
Mark For Release OptionValue that indicates the release status of the order. Valid values are 1: Marked For Release or 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute. -
ReleaseGroupCode: string
Title:
Release Group CodeAbbreviation??that??identifies??a??custom??grouping??created??in??buyer??planning??used??by??procurement??in??the??purchase??order??creation??process.
Nested Schema : $context
Type:
Show Source
object-
id: string
Context Identifier.
-
if-match: string
Change indicator or the ETag value of the resource instance.
-
operation: string
Describe type of operation: update.
Nested Schema : $key
Type:
Show Source
object-
PartKey1: integer
(int64)
Value that uniquely identifies the order based on planId, transactionID and a system generated part key.
-
PlanId: integer
(int64)
Value that uniquely identifies the plan.
-
TransactionId: integer
(int64)
Value that uniquely identifies the supply transaction. This value is internally generated by the application.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : buyerPlanningSupplies-bulkItemsStatus-response
Match All
Show Source
-
object
ItemsBulkProperties
-
integer
The number of resource instances returned in the current range.
-
object
buyerPlanningSupplies-bulkItemsStatus-response-allOf[2]
Nested Schema : ItemsBulkProperties
Type:
Show Source
object-
items: array
Items
Title:
ItemsThe item relations associated with the resource instance.
Nested Schema : buyerPlanningSupplies-bulkItemsStatus-response-allOf[2]
Type:
objectNested Schema : Items
Type:
arrayTitle:
ItemsThe item relations associated with the resource instance.
Show Source
Nested Schema : bulk-post-item
Type:
Show Source
object-
ConsolidationTransactionId: integer
(int64)
Value that uniquely identifies associated consolidated orders.
-
FirmDate: string
(date)
Title:
Firm DateDate when supply is due. This attribute is a fixed value that can't be rescheduled by planning and is only populated when the firm status is firm. -
FirmQuantity: integer
(int64)
Title:
Firm QuantityFixed quantity of supply. This attribute value can't be changed by planning and is only populated when the firm status is firm. -
ImplementDate: string
(date)
Title:
Implement DateDate when the order is released. -
ImplementDockDate: string
(date)
Title:
Implement Dock DateDate when the material should be on the receiving dock when the order is released. -
ImplementFirm: integer
(int64)
Title:
Implement FirmValue that indicates whether the order is firm or not. Valid values are 1: Firm and 2: Not Firm. A list of accepted values is defined in the lookup type MSC_YES_NO. -
ImplementQuantity: integer
(int64)
Title:
Implement QuantityQuantity of the order that's released. -
ImplementShipDate: string
(date)
Title:
Implement Ship DateDate when the order is shipped. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item associated with the supply.
-
MarkForReleaseOption: integer
(int64)
Title:
Mark For Release OptionValue that indicates the release status of the order. Valid values are 1: Marked For Release or 2: Not Marked For Release. When marking or not marking orders for release, the request body must include only the MarkForReleaseOption attribute. -
ObjectVersionNumber: string
Title:
Object Version NumberNumber of times the supply row was updated. This attribute is used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried. -
OrderType: string
Title:
Order TypeType??of??order??such??as??planned??order,??purchase??order,??or??purchase??requisition.??A??list??of??accepted??values??is??defined??in??the??lookup??type??MSC_ORDER_TYPE. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization associated with the order.
-
PartKey1: string
Value that uniquely identifies the order based on planId, transactionID and a system generated part key.
-
PlanId: integer
(int64)
Value that uniquely identifies the plan.
-
PriceSavings: number
(float)
Title:
Price SavingsValue that indicates the amount of savings realized from actions taken against the order in buyer planning. -
ReleaseGroupCode: string
Title:
Release Group CodeAbbreviation??that??identifies??a??custom??grouping??created??in??buyer??planning??used??by??procurement??in??the??purchase??order??creation??process. -
ReleaseStatus: string
Title:
Release StatusValue that indicates the release status of the order. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_RELEASE_STATUS. -
ReleaseStatusCode: string
Title:
Release Status CodeRelease status of the order such as ready for release, marked for release or released. A list of accepted values is defined in the lookup type ORA_MSC_BP_RELEASE_STATUS. -
SupplierId: integer
(int64)
Value that uniquely identifies the source supplier.
-
SupplierSiteId: integer
(int64)
Value that uniquely identifies the specific supplier site from where the item is being sourced.
-
TransactionId: integer
(int64)
Value that uniquely identifies the supply transaction. This value is internally generated by the application.
Examples
This example describes how to bulk update orders.
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/buyerPlanningSupplies"
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.
{
"$context": {
"if-match": "C4CA4238A0B923820DCC509A6F75849B",
"operation": "update"
},
"$key": {
"PartKey1": "999999999999999999",
"PlanId": "300100577750737",
"TransactionId": "99549201"
},
"ConsolidationTransactionId": "99549201",
"ImplementFirm": 1,
"ImplementQuantity": 0
},
{
"$context": {
"if-match": "C4CA4238A0B923820DCC509A6F75849B",
"operation": "update"
},
"$key": {
"PartKey1": "999999999999999999",
"PlanId": "300100577750737",
"TransactionId": "99549241"
},
"ConsolidationTransactionId": "99549201",
"ImplementFirm": 2,
"ImplementQuantity": 0
},
{
"$context": {
"if-match": "C4CA4238A0B923820DCC509A6F75849B",
"operation": "update"
},
"$key": {
"PartKey1": "999999999999999999",
"PlanId": "300100577750737",
"TransactionId": "99549280"
},
"ConsolidationTransactionId": "99549201",
"ImplementFirm": 2,
"ImplementQuantity": 0
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"items": [
{
"PlanId": "300100577750737",
"PlanName": null,
"TransactionId": "99549201",
"ConsolidatedFlag": null,
"ConsolidationTransactionId": "99549201",
"PartKey1": "999999999999999999",
"SrInstanceId": null,
"OrderTypeCode": null,
"OrderType": "Planned order",
"OrderNumber": null,
"ReleaseStatusCode": 14,
"ReleaseStatus": "Marked for release",
"MarkForReleaseOption": 1,
"SegmentId": null,
"SegmentName": null,
"ReleaseGroupCode": null,
"MappedSupplierId": null,
"SupplierId": "2736186",
"Supplier": null,
"SupplierSiteId": "7463792",
"SupplierSite": null,
"MappedOrganizationId": null,
"OrganizationId": "147201",
"SubInventoryId": null,
"ActualLocation": "BP1",
"Organization": null,
"OrganizationCode": null,
"OrganizationCalendarCode": null,
"SubinventoryCode": null,
"MappedItemId": null,
"InventoryItemId": "26563118",
"Item": null,
"ItemDescription": null,
"NewOrderQuantity": null,
"OldOrderQuantity": null,
"NewDockDate": null,
"NewShipDate": null,
"OldDockDate": null,
"OldShipDate": null,
"FirmStatusCode": null,
"FirmStatus": null,
"FirmQuantity": null,
"FirmDate": null,
"ImplementQuantity": 168,
"ImplementDockDate": "2024-01-10",
"ImplementShipDate": "2024-01-10",
"ImplementDate": "2024-01-12",
"MappedImplementLocationId": null,
"ImplementFirm": 1,
"ImplementLocationId": null,
"PrimaryUomCode": null,
"ImplementLocation": null,
"PrimaryUom": null,
"ImplementLocationCode": null,
"SourceUomCode": null,
"SourceUom": null,
"UnitVolume": null,
"VolumeUomCode": null,
"UnitWeight": null,
"VolumeUom": null,
"WeightUomCode": null,
"WeightUom": null,
"CarryingCost": null,
"HasPriceBreakFlag": true,
"ListPrice": null,
"OrderCost": null,
"StandardCost": null,
"PriceSavings": 588,
"OrganizationCurrency": null,
"FixedDaysOfSupply": null,
"FixedLotMultiplier": null,
"FixedOrderQuantity": null,
"MaximumOrderQuantity": null,
"MinimumOrderQuantity": null,
"PlanningTimeFenceDays": null,
"ProcessingLeadTime": null,
"PostProcessingLeadTime": null,
"ItemPlanner": null,
"EmployeeId": null,
"PoLineId": null,
"PoLineLocationId": null,
"RangeFilterDate": null,
"PlannerCode": null,
"ObjectVersionNumber": 2,
"CreatedBy": null,
"CreationDate": null,
"LastUpdatedBy": null,
"LastUpdateDate": null,
"links": [
{
. . .
}
]
},
{
"PlanId": "300100577750737",
"PlanName": null,
"TransactionId": "99549241",
"ConsolidatedFlag": null,
"ConsolidationTransactionId": "99549201",
"PartKey1": "999999999999999999",
"SrInstanceId": null,
"OrderTypeCode": null,
"OrderType": "Planned order",
"OrderNumber": null,
"ReleaseStatusCode": 14,
"ReleaseStatus": "Marked for release",
"MarkForReleaseOption": 1,
"SegmentId": null,
"SegmentName": null,
"ReleaseGroupCode": null,
"MappedSupplierId": null,
"SupplierId": "2736186",
"Supplier": null,
"SupplierSiteId": "7463792",
"SupplierSite": null,
"MappedOrganizationId": null,
"OrganizationId": "147201",
"SubInventoryId": null,
"ActualLocation": "BP1",
"Organization": null,
"OrganizationCode": null,
"OrganizationCalendarCode": null,
"SubinventoryCode": null,
"MappedItemId": null,
"InventoryItemId": "26563118",
"Item": null,
"ItemDescription": null,
"NewOrderQuantity": null,
"OldOrderQuantity": null,
"NewDockDate": null,
"NewShipDate": null,
"OldDockDate": null,
"OldShipDate": null,
"FirmStatusCode": null,
"FirmStatus": null,
"FirmQuantity": null,
"FirmDate": null,
"ImplementQuantity": 0,
"ImplementDockDate": "2024-01-12",
"ImplementShipDate": "2024-01-12",
"ImplementDate": "2024-01-16",
"MappedImplementLocationId": null,
"ImplementFirm": 2,
"ImplementLocationId": null,
"PrimaryUomCode": null,
"ImplementLocation": null,
"PrimaryUom": null,
"ImplementLocationCode": null,
"SourceUomCode": null,
"SourceUom": null,
"UnitVolume": null,
"VolumeUomCode": null,
"UnitWeight": null,
"VolumeUom": null,
"WeightUomCode": null,
"WeightUom": null,
"CarryingCost": null,
"HasPriceBreakFlag": true,
"ListPrice": null,
"OrderCost": null,
"StandardCost": null,
"PriceSavings": null,
"OrganizationCurrency": null,
"FixedDaysOfSupply": null,
"FixedLotMultiplier": null,
"FixedOrderQuantity": null,
"MaximumOrderQuantity": null,
"MinimumOrderQuantity": null,
"PlanningTimeFenceDays": null,
"ProcessingLeadTime": null,
"PostProcessingLeadTime": null,
"ItemPlanner": null,
"EmployeeId": null,
"PoLineId": null,
"PoLineLocationId": null,
"RangeFilterDate": null,
"PlannerCode": null,
"ObjectVersionNumber": 2,
"CreatedBy": null,
"CreationDate": null,
"LastUpdatedBy": null,
"LastUpdateDate": null,
"links": [
{
. . .
}
]
},
{
"PlanId": "300100577750737",
"PlanName": null,
"TransactionId": "99549280",
"ConsolidatedFlag": null,
"ConsolidationTransactionId": "99549201",
"PartKey1": "999999999999999999",
"SrInstanceId": null,
"OrderTypeCode": null,
"OrderType": "Planned order",
"OrderNumber": null,
"ReleaseStatusCode": 14,
"ReleaseStatus": "Marked for release",
"MarkForReleaseOption": 1,
"SegmentId": null,
"SegmentName": null,
"ReleaseGroupCode": null,
"MappedSupplierId": null,
"SupplierId": "2736186",
"Supplier": null,
"SupplierSiteId": "7463792",
"SupplierSite": null,
"MappedOrganizationId": null,
"OrganizationId": "147201",
"SubInventoryId": null,
"ActualLocation": "BP1",
"Organization": null,
"OrganizationCode": null,
"OrganizationCalendarCode": null,
"SubinventoryCode": null,
"MappedItemId": null,
"InventoryItemId": "26563118",
"Item": null,
"ItemDescription": null,
"NewOrderQuantity": null,
"OldOrderQuantity": null,
"NewDockDate": null,
"NewShipDate": null,
"OldDockDate": null,
"OldShipDate": null,
"FirmStatusCode": null,
"FirmStatus": null,
"FirmQuantity": null,
"FirmDate": null,
"ImplementQuantity": 0,
"ImplementDockDate": "2024-01-15",
"ImplementShipDate": "2024-01-14",
"ImplementDate": "2024-01-17",
"MappedImplementLocationId": null,
"ImplementFirm": 2,
"ImplementLocationId": null,
"PrimaryUomCode": null,
"ImplementLocation": null,
"PrimaryUom": null,
"ImplementLocationCode": null,
"SourceUomCode": null,
"SourceUom": null,
"UnitVolume": null,
"VolumeUomCode": null,
"UnitWeight": null,
"VolumeUom": null,
"WeightUomCode": null,
"WeightUom": null,
"CarryingCost": null,
"HasPriceBreakFlag": true,
"ListPrice": null,
"OrderCost": null,
"StandardCost": null,
"PriceSavings": null,
"OrganizationCurrency": null,
"FixedDaysOfSupply": null,
"FixedLotMultiplier": null,
"FixedOrderQuantity": null,
"MaximumOrderQuantity": null,
"MinimumOrderQuantity": null,
"PlanningTimeFenceDays": null,
"ProcessingLeadTime": null,
"PostProcessingLeadTime": null,
"ItemPlanner": null,
"EmployeeId": null,
"PoLineId": null,
"PoLineLocationId": null,
"RangeFilterDate": null,
"PlannerCode": null,
"ObjectVersionNumber": 2,
"CreatedBy": null,
"CreationDate": null,
"LastUpdatedBy": null,
"LastUpdateDate": null,
"links": [
{
. . .
}
]
}
],
"count": 3
}