Use REST API to Adjust Allocation Percentages
Use REST API to adjust the percentage of supply that Global Order Promising assigns to an allocation node with a quantity that you specify in your import payload. Use this feature to help meet a short term fulfillment requirement.
Use REST API to set the supply that's available for one or more allocation nodes to a specific quantity during a promotion, marketing campaign, holiday, or some other time when you don't want to apply the regular percentage allocation. Promising will adjust the quantity on each of the remaining nodes in your allocation hierarchy to maintain the total amount of supply that promising already allocated for the week.
For details and examples, go to REST API for Oracle Supply Chain Management Cloud, then expand Supply Chain Planning.
Guidelines
- Consider the total weekly supply that's available for the item across all nodes in your allocation hierarchy when you adjust the supply for a node.
- To examine the results of your adjustment, go to the Order Promising work area, then view the Manual Allocation attribute on the Review Supply Allocation page.
- You can adjust allocation only for nodes that you have set up to allocate according to a percentage.
- You can't update your allocation rule or add nodes to your allocation hierarchy anytime during the promotion.
Examples
Assume you use REST API to adjust quantities for the AS54888 Desktop Computer and the total supply for the item is 1,000 units for the week.
Example 1
Your imported quantities don't exceed the total supply that's available for the week.
| Allocation Node | Percentage Allocation | Quantity That You Allocate Through a Rule | Quantity That You Update Through REST API | Allocated Supply for the Week |
|---|---|---|---|---|
| N1 | 25 | 250 | 300 | 300 |
| N2 | 25 | 250 | 200 | 200 |
| N3 | 25 | 250 | 100 | 100 |
| N4 | 25 | 250 | 400 | 400 |
Promising will use the values that you import through REST API.
Example 2
Your imported quantities exceed the total supply that's available for the week.
| Allocation Node | Percentage Allocation | Quantity That You Allocate Through a Rule | Quantity That You Update Through REST API | Allocated Supply for the Week | Math |
|---|---|---|---|---|---|
| N1 | 15 | 150 | 500 | 395 | 500 minus (700 multiplied by 0.15) |
| N2 | 30 | 300 | 400 | 190 | 400 minus (700 multiplied by 0.30) |
| N3 | 20 | 200 | 300 | 160 | 300 minus (700 multiplied by 0.20) |
| N4 | 35 | 350 | 500 | 255 | 500 minus (700 multiplied by 0.35) |
Note
- Your imported quantities exceed the total supply that's available by 700 units.
- Promising decreases your imported quantity for each node according to the node's
percentage allocation. Promising uses this equation to determine the supply to
allocate for each node.
Your imported quantity minus (the total supply that's available multiplied by the node's percentage allocation)
Here's the math for N1.
500 imported quantity minus (700 total supply multiplied by N1's 0.15
percentage allocation)
- The allocated supply for the week remains at 1,000 units after Promising adjusts your imported values.
Example 3
Your imported quantities decrease the quantity for some nodes and increase it for other nodes.| Allocation Node | Percentage Allocation | Quantity That You Allocate Through a Rule | Quantity That You Update Through REST API | Allocated Supply for the Week | Math |
|---|---|---|---|---|---|
| N1 | 25 | 250 | 400 | 400 | - |
| N2 | 20 | 200 | - | 166.666 | 200 minus 33% of 100 |
| N3 | 15 | 150 | 100 | 100 | - |
| N4 | 40 | 400 | - | 333.333 | 400 minus 66% of 100 |
Note
- Your imported quantities exceed the total supply that's available by 100 units.
- Promising uses the quantity that you import for each node.
- Promising decreases the quantity for each node that your import doesn't adjust.
It adjusts the quantity according to the node's percentage allocation. Promising
uses this equation to determine the allocated supply for the
node.
Node's rule quantity minus the node's proportion of the excess
Here's the math for N2.
- Determine the node's percentage among nodes that you don't adjust through REST API. In this example, you don't adjust node 2 or node 4.
- Node 2's rule allocation is 200, and node 4's is 400.
- So, node 2 represents 33% of the rule allocations and node 4 represents 66% of the rule allocations.
- Promising needs to proportion the 100 excess across nodes 2 and 4.
- 33% of 100 equals 33. So Promising subtracts 33 from N2's rule quantity of 200,
resulting in an allocated supply of 166.666 for N2:
N2's rule quantity of 200 minus (33% of the 100 excess)
Promising might round the decimal quantities according to your setups.
Example Payload
Use the AllocUserDef attribute in the backlogManagementPlans REST API.
URL: https://(FADomain,FSCMServices)/backlogManagementPlans/-1/child/allocations
Input Header:
{"BmRunId": -1,
"AllocationDate": “<date>",
"Level1AttributeName": "All",
"Level2AttributeName": "CustParentGrp",
"Level3AttributeName": "CustGrp",
"Level1AttributeValName": "ALL",
"Level2AttributeValName": “North",
"Level3AttributeValName": “NorthEast",
"InventoryItemName": “Item A",
"OrganizationName": "Denver Manufacturing",
"OrganizationCode": "M2"
"AllocUserDef": 10
}
For example, this payload sets the allocation percentage to 10 for the NorthEast node in the Denver Manufacturing organization.
For details about this REST API, see Backlog Management Plans.