Get one order promise
get
/fscmRestApi/resources/11.13.18.05/orderPromises/{UniqueOrderId}
Request
Path Parameters
-
UniqueOrderId(required): string
Value that uniquely identifies the order.
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : orderPromises-item-response
Type:
Show Source
object
-
AlternateOptions: array
Alternate Options
Title:
Alternate Options
The Alternate Options resource manages the potential promising result for a fulfillment line. -
CallingInstance: string
Maximum Length:
255
Value that indicates the unique identifier of the source application from which the order promising service request originated. -
CallingModule: string
Maximum Length:
255
Value that indicates the identifier of the module from which the order promising service request originated. -
ErrorCode: string
Maximum Length:
255
Abbreviation that identifies the error code, if any, returned by Oracle Global Order Promising Cloud for the service request. -
ErrorMessage: string
Maximum Length:
255
Text of the error message, if any, for the error code. -
ExpectedGroupArrivalDate: string
(date-time)
Date when the set of fulfillment lines are expected to arrive at the customer ship-to site.
-
ExpectedGroupShipDate: string
(date-time)
Date when the set of fulfillment lines are expected to be shipped together from the shipping organization.
-
FulFillmentLine: array
Fulfillment Lines
Title:
Fulfillment Lines
The Fulfillment Lines resource manages the details of a sales order line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModelType: string
Maximum Length:
255
Type of configure to order communicated in the service request. Valid values include ATO, PTO-SMC, and PTO-NSMC. -
NumberOfAltOptions: string
Maximum Length:
255
Total number of availability options generated for the fulfillment line service request. -
OperationName: string
Maximum Length:
255
Name of the request that needs to be performed for the fulfillment line. -
PromiseDate: string
(date-time)
Date and time when the promise is generated by Oracle Global Order Promising Cloud.
-
PromisingInstance: string
Maximum Length:
255
Value that uniquely identifies the source system in which order promising is performed. -
PromisingSystem: string
Maximum Length:
255
Value that identifies the Oracle Global Order Promising Cloud application that performed the availability check. -
ReleaseNumber: string
Maximum Length:
255
Number that indicates the release of Oracle Distributed Order Orchestration Cloud that's calling Oracle Global Order Promising Cloud services. -
RequestedCreationDate: string
(date)
Date and time when the check availability request was created for the fulfillment line.
-
RootParentFulFillIdentifier: string
Maximum Length:
255
Value that uniquely identifies the fulfillment line for the root parent configure to order (CTO) model. This attribute is applicable only for configured to order items. -
SalesOrderNumber: string
Maximum Length:
255
Value that uniquely identifies the sales order for which the fulfillment line is created. -
SetIdentifier: string
Maximum Length:
255
Value that uniquely identifies the fulfillment line set. -
SetType: string
Maximum Length:
255
Type of fulfillment line set sent for promising. Valid values are ship, arrival, pickup, and consolidation. Only ship sets are currently supported. -
UniqueOrderId: string
Maximum Length:
255
Value that uniquely identifies the order.
Nested Schema : Alternate Options
Type:
array
Title:
Alternate Options
The Alternate Options resource manages the potential promising result for a fulfillment line.
Show Source
Nested Schema : Fulfillment Lines
Type:
array
Title:
Fulfillment Lines
The Fulfillment Lines resource manages the details of a sales order line.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : orderPromises-AlternateOptions-item-response
Type:
Show Source
object
-
CarrierCalendar: string
Maximum Length:
255
Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site. -
ConfigItem: string
Maximum Length:
255
Value that identifies the unique configuration item corresponding to the configuration sent for promising. This attribute is applicable only in the case of assemble to order demands. -
DestinationOrg: string
Maximum Length:
255
Abbreviation that identifies the organization that represents the destination of supply for a transfer of supply. -
DestinationReceivingCalendar: string
Maximum Length:
255
Value that indicates the receiving calendar for the customer or destination organization in case of an internal order. -
ExpectedArrivalDate: string
(date-time)
Date when the fulfillment line is expected to be available at the customer ship-to site.
-
ExpectedAvailabilityOnRequestedDate: number
Number that indicates the available to promise inventory quantity on the requested date.
-
ExpectedAvailableItem: string
Maximum Length:
255
Value that identifies the item that is expected to be used for satisfying the customer demand. This attribute can be either the requested item or substitute of the requested item. -
ExpectedAvailableQuantity: number
Number that indicates the quantity of the material that can be promised on the expected shipment date. In the case of splits, this quantity can be less than the requested quantity.
-
ExpectedAvailableQuantityUOM: string
Maximum Length:
255
Value that identifies the unit of measure used to represent the available quantity. -
ExpectedCarrier: string
Value that identifies the suggested carrier from the ship-from organization to the customer ship-to site.
-
ExpectedDemandClass: string
Value that identifies the demand class that the order is associated with.
-
ExpectedDropShipSupplier: string
Maximum Length:
255
Value that identifies the suggested drop ship supplier. -
ExpectedDropShipSupplierSite: string
Maximum Length:
255
Value that identifies the suggested drop ship supplier site. This attribute indicates the drop ship supplier location from where material is shipped to the customer ship-to site. -
ExpectedDropShipSupplierSourceSystem: string
Maximum Length:
255
Value that identifies the source system to which the drop ship supplier and the supplier belong. -
ExpectedMargin: number
Number that indicates the expected margin for the fulfillment line or availability option. Margin is calculated as the difference between the revenue and fulfillment cost associated with the availability option.
-
ExpectedMode: string
Value that identifies the suggested transport mode from the source inventory organization to destination inventory organization.
-
ExpectedPickDate: string
(date-time)
Date when the shipment is expected to be picked at the pickup organization by the customer.
-
ExpectedService: string
Value that represents the expected service level used for shipping from the ship-from organization to the customer ship-to site for the fulfillment line or availability option.
-
ExpectedShipDate: string
(date-time)
Date when the requested item line is expected to be shipped from the ship-from organization to the customer ship-to site.
-
ExpectedShipFromOrg: string
Maximum Length:
255
Value that indicates the expected shipping organization to the customer ship-to site for the fulfillment line or availability option. -
ExpectedShippingCost: number
Number that indicates the expected shipping cost associated with the fulfillment line or availability option.
-
ExpectedTotalFulfilmentCost: integer
(int64)
Number that indicates the total expected cost associated with the fulfillment line or availability option.
-
FillRate: number
Percentage of quantity that can be promised on the requested date.
-
FulfillmentLineId: string
Maximum Length:
255
Value that uniquely identifies the fulfillment line. -
InstanceNumber: string
Maximum Length:
255
Value that identifies the source system from which the order promising service request originated. -
InternalOrderType: string
Maximum Length:
255
Value that indicates the type of internal order. Valid values are TO, ISO, and SO. -
InternalSupplyIdentifier: string
Maximum Length:
255
Number that identifies the source document for the internal order fulfillment line request. -
LineFillRate: number
Number that indicates the percentage of quantity that can be promised by the requested date.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfATPItems: integer
Number of items for which the available to promise inventory was used in the availability option.
-
NumberOfCTPItems: integer
Number of items for which the capable to promise supply was used in the availability option.
-
NumberOfSplits: integer
Number of split lines generated for the fulfillment line.
-
NumberOfSubstitutions: integer
Number of end item substitutions generated for the fulfillment line.
-
OptionRank: string
Maximum Length:
255
Number that represents the unique identifier for the fulfillment line availability option. -
OptionSummary: string
Maximum Length:
255
Summary of how the current set availability option is different from the default availability option. -
ParentfulfillIdentifier: string
Maximum Length:
255
Value that indicates the immediate parent of the fulfillment line. This attribute is applicable only for configured to order items. -
ParentSplitLineIdentifier: string
Maximum Length:
255
Value that indicates the parent of the split fulfillment line. This attribute is generated only in case of an order that was split. -
Party: string
Maximum Length:
255
Value that indicates the party representing the customer. -
Partysite: string
Maximum Length:
255
Value that indicates the party site corresponding to the customer ship-to site. -
PeggingDetails: array
Pegging Details
Title:
Pegging Details
The Pegging Details resource manages the supply and demand peggings for a given fulfillment line. -
Price: number
Price per unit associated with the availability option.
-
Profit: number
Projected profit generated by this split line item.
-
PromisingStatus: string
Maximum Length:
255
Contains one of the following values: true or false. If true, then the request can be completely met by the requested arrival date. If false, then can't be met. This attribute doesn't have a default value. -
PromisingType: string
Maximum Length:
255
Type of promise. This attribute can represent either ship date or arrival date based promising. -
RequestedDate: string
(date-time)
Date when the material is requested to be available. Depending on the request type this attribute represents the requested ship date or the request arrival date.
-
RequestedItem: string
Maximum Length:
255
Value that uniquely identifies the item that is being requested. -
SalesOrderNumber: string
Maximum Length:
255
Value that uniquely identifies the sales order for which the fulfillment line is created. -
SourcingRule: string
Maximum Length:
255
Value that identifies the sourcing rule that was used. -
SplitLineIdentifier: string
Maximum Length:
255
Value that uniquely identifies the fulfillment line split. A unique number is generated in case of an order that was split. -
TotalMargin: number
Total margin for the fulfillment line or availability option.
-
TotalPrice: number
Total price for the fulfillment line or availability option.
-
TotalProfit: number
Total profit for the fulfillment line or availability option.
-
TotalValue: number
Total value for the fulfillment line or availability option.
-
UniqueOrderId: string
Maximum Length:
255
Value that uniquely identifies the order for the request. -
Value: number
Value associated with the fulfillment line availability response.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Pegging Details
Type:
array
Title:
Pegging Details
The Pegging Details resource manages the supply and demand peggings for a given fulfillment line.
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.
Nested Schema : orderPromises-AlternateOptions-PeggingDetails-item-response
Type:
Show Source
object
-
AllocationRule: string
Maximum Length:
255
Value that identifies the allocation rule applicable to the demand class associated with the order. -
AlternateResource: string
Maximum Length:
255
Contains one of the following values: true or false. If true, then an alternate resources is considered. If false, then an alternate resources is not considered. This attribute does not have a default value. -
ArrivalDate: string
(date-time)
Date when the purchased supply will be available at the destination organization.
-
ATPCost: integer
(int64)
Number that indicates the cost associated with the available-to-promise inventory used for promising the fulfillment line.
-
ATPmode: string
Maximum Length:
255
Value that indicates the mode of order promising used to promise the order. Valid values are infinite, lead-time, and supply chain search. -
AvailabilityOption: string
Maximum Length:
38
Value that identifies an availability option. -
AvailableItem: string
Maximum Length:
255
Value that uniquely identifies the item that is available. -
BackToBackFlag: boolean
Contains one of the following values: true or false. If true, then the item is a back to back enabled item. If false, then the item is not a back to back enabled item. This attribute does not have a default value.
-
BOMCode: string
Maximum Length:
255
Abbreviation that identifies the bill of material used in the capable to promise calculations for the fulfillment line request. -
CarrierCalendar: string
Maximum Length:
255
Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site. -
ConsumptionDate: string
(date-time)
Date when resource availability information needs to be returned.
-
DemandClass: string
Maximum Length:
255
Value that identifies the demand class that the order is associated with. -
DepartmentId: string
Maximum Length:
255
Value that identifies the department or work center to which a resource belongs. -
DestinationOrgId: string
Maximum Length:
255
Abbreviation that identifies the organization that represents the destination of supply for the transfer of supply. -
DropshipSupplier: string
Maximum Length:
255
Name of the drop ship supplier that ships items directly to the customer. -
DropshipSupplierSite: string
Maximum Length:
255
Name of the drop ship supplier site that ships items directly to the customer. -
EndDate: string
(date-time)
Date when manufacturing ends for the item.
-
ExpectedCarrier: string
Maximum Length:
255
Value that identifies the suggested carrier from the source inventory organization to destination inventory organization. -
ExpectedMode: string
Maximum Length:
255
Value that identifies the mode of transport for shipping the material from the source inventory organization to the destination inventory organization, suggested by order promising. -
ExpectedService: string
Maximum Length:
255
Value that identifies the suggested service level used for shipping the material from the source inventory organization to destination inventory organization. -
FixedLeadTime: string
Maximum Length:
255
Number of days of manufacturing lead time that is independent of the order quantity. -
FulfillmentlineId: string
Maximum Length:
38
Value that indicates the unique order identifier for the request. -
Item: string
Maximum Length:
255
Value that uniquely identifies the item that is requested. -
LeadTime: string
Maximum Length:
255
Value that indicates the number of days of lead time. -
LineId: integer
(int64)
Value that uniquely identifies the order line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManufacturingCalendar: string
Maximum Length:
255
Calendar that is associated with the manufacturing operations at an organization. -
OptionRank: integer
(int64)
Number that indicates the rank of the availability option.
-
OrgId: string
Maximum Length:
255
Value that uniquely identifies the organization associated with the item. -
PeggedATPType: string
Maximum Length:
255
Type of the supply. -
PeggingdocId: string
Maximum Length:
255
Value that uniquely identifies the supply and demand pegging. -
PostprocessingLeadTime: string
Maximum Length:
255
Number of days required to make an item available in inventory from the time it received. -
PreprocessingLeadTime: string
Maximum Length:
255
Number of days required to release a purchase order or create a job from the time the requirement is identified. -
ProcessingLeadTime: string
Maximum Length:
255
Number of days required to procure or manufacture an item. -
Quantity: integer
(int64)
Number that indicates the quantity of the available item.
-
QuantityUOM: string
Maximum Length:
255
Value that indicates the unit of measure used for quantity. -
ReceivingCalendar: string
Maximum Length:
255
Value that identifies the receiving calendar used for receiving the material at the inventory organization or customer ship-to site. -
RequiredDate: string
(date-time)
Date when the material is required.
-
RequiredQuantity: number
Number that indicates the quantity required for promising the fulfillment line.
-
ResourceCalendar: string
Maximum Length:
255
Value that identifies the calendar of the resource for which the availability is to be determined. -
ResourceId: string
Maximum Length:
255
Value that identifies the manufacturing resource. -
RoutingCode: string
Maximum Length:
255
Abbreviation that identifies the routing used in the capable to promise calculations for the fulfillment line request. -
ShipDate: string
(date-time)
Date when the supply will be shipped from the supplier site or source organization.
-
ShippingCalendar: string
Maximum Length:
255
Value that identifies the shipping calendar used for shipping the material from supplier site to the inventory organization or the customer ship-to site. -
SourceOrgId: string
Maximum Length:
255
Value that uniquely identifies the organization that is the source of supply. -
StartDate: string
(date-time)
Date when manufacturing is expected to start for the item.
-
SupplierId: string
Maximum Length:
255
Value that uniquely identifies the item supplier from whom supply is procured. -
SupplierSiteId: string
Maximum Length:
255
Value that uniquely identifies the item supplier site from which supply is procured. -
TransitLeadTime: string
Maximum Length:
255
Number of days required for transporting the requested item from source organization to the destination organization. -
UniqueOrderId: string
Maximum Length:
38
Value that uniquely identifies the fulfillment line. -
VariableLeadTime: string
Maximum Length:
255
Number that indicates the portion of manufacturing lead time that is dependent on order quantity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : orderPromises-FulFillmentLine-item-response
Type:
Show Source
object
-
ArrivalDate: string
(date-time)
Date when the purchased supply will be available at the destination organization.
-
AvailabilityBasis: string
Maximum Length:
255
Value that indicates the availability basis for selecting the ship method. Valid values include Fastest Delivery and Cost. -
CarrierCalendar: string
Maximum Length:
255
Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site. -
ConfigItem: string
Maximum Length:
255
Value that identifies the unique configuration item corresponding to the configuration sent for promising. This attribute is applicable only in the case of assemble to order demands. -
CustomerClass: string
Maximum Length:
255
This attribute is for future use. -
DeliveryCost: integer
(int64)
Value that indicates the delivery cost that you enter on the fulfillment line.
-
DeliveryLeadTime: integer
(int64)
Value that indicates the delivery lead time that you enter on the fulfillment line.
-
DemandClass: string
Maximum Length:
255
Value that identifies the demand class that the order is associated with. -
DestinationOrg: string
Maximum Length:
255
Abbreviation that identifies the organization that represents the destination of supply, for transfer of supply. -
DestinationReceivingCalendar: string
Maximum Length:
255
Value that identifies the receiving calendar for the customer or destination organization in case in internal order. -
DropshipSupplier: string
Maximum Length:
255
Value that uniquely identifies the drop ship supplier from which material is to be shipped to the customer ship-to site. -
DropshipSupplierSite: string
Maximum Length:
255
Value that uniquely identifies the drop ship supplier site from which material is to be shipped to the customer ship-to site. -
EarliestAcceptableDate: string
(date-time)
Date before which the fulfillment line must not be promised.
-
ErrorCode: string
Maximum Length:
255
Abbreviation that identifies the error code, if any, returned by Oracle Global Order Promising Cloud for the service request. -
ErrorMessage: string
Maximum Length:
255
Text of the error message, if any, for the error code. -
ExpectedArrivalDate: string
(date-time)
Date when the fulfillment line is expected to be available at the customer ship-to site.
-
ExpectedAvailabilityOnRequestedDate: number
Number that indicates the available to promise inventory quantity on the requested date.
-
ExpectedAvailableItem: string
Maximum Length:
255
Value that identifies the item that is expected to be used for satisfying the customer demand. This attribute can be either the requested item or substitute of the requested item. -
ExpectedAvailableQuantity: number
Quantity of the material that can be promised on the expected shipment date. In the case of splits, this quantity can be less than the requested quantity.
-
ExpectedAvailableQuantityUOM: string
Maximum Length:
255
Value that identifies the unit of measure used to represent the available quantity. -
ExpectedCarrier: string
Value that identifies the suggested carrier from the ship-from organization to the customer ship-to site.
-
ExpectedDemandClass: string
Value that identifies the demand class that the order is associated with.
-
ExpectedDropShipSupplier: string
Maximum Length:
255
Value that identifies the suggested drop ship supplier. -
ExpectedDropShipSupplierSite: string
Maximum Length:
255
Value that identifies the suggested drop ship supplier site. This attribute indicates the drop ship supplier location from where material is shipped to the customer ship-to site. -
ExpectedDropShipSupplierSourceSystem: string
Maximum Length:
255
Value that identifies the source system to which the drop ship supplier and supplier belong to. -
ExpectedGroupArrivalDate: string
(date-time)
Date when the set of fulfillment lines are expected to arrive at the customer ship-to site.
-
ExpectedGroupShipDate: string
(date-time)
Date when the set of fulfillment lines are expected to be shipped together from the shipping organization.
-
ExpectedMargin: number
Value that identifies the expected margin for the fulfillment line or availability option. Margin is calculated as the difference between the revenue and fulfillment cost associated with the availability option.
-
ExpectedMode: string
Value that identifies the suggested transport mode from the source inventory organization to destination inventory organization.
-
ExpectedPickDate: string
(date-time)
Date when the shipment is expected to be picked at the pickup organization by the customer.
-
ExpectedService: string
Value that identifies the expected service level used for shipping from the ship-from organization to the customer ship-to site for the fulfillment line or availability option.
-
ExpectedShipDate: string
(date-time)
Date when the requested item line is expected to be shipped from the ship-from organization to the customer ship-to site.
-
ExpectedShipFromOrg: string
Maximum Length:
255
Value that identifies the expected shipping organization to the customer ship-to site for the fulfillment line or availability option. -
ExpectedShippingCost: number
Expected shipping cost associated with the fulfillment line or availability option.
-
ExpectedTotalFulfilmentCost: number
Total expected cost associated with the fulfillment line or availability option.
-
FillRate: number
Value that indicates the percentage of quantity that can be promised on the requested date.
-
FulfillmentLineId: string
Maximum Length:
255
Value that uniquely identifies the fulfillment line. -
GenerateAltAvailability: string
Maximum Length:
255
Contains one of the following values: true or false. If true, then alternate availability options should be generated. If false, then alternate availability options should not be generated. This attribute does not have a default value. -
GeneratePeggingFlag: boolean
Contains one of the following values: Yes or No. If Yes, then the pegging information needs to be sent by Oracle Global Order Promising Cloud as a response to the request. If No, then pegging information doesn't need to be sent by Oracle Global Order Promising Cloud in addition to the promise information, which is always sent. The default value is No.
-
GetAvailforSubstituteItems: string
Maximum Length:
255
Contains one of the following values: true or false. If true, then availability of substitute items should be considered. If false, then availability of substitute items should not be considered. This attribute does not have a default value. -
IgnoreDateReservationFlag: boolean
Contains one of the following values: true or false. If true, then the reserved supply dates can be rescheduled. If false, then the reserved supply dates can't be rescheduled. This attribute does not have a default value. This attribute is applicable only for drop ship requests.
-
IgnoreReservationFlag: boolean
Contains one of the following values: true or false. If true, then the existing reservations can be ignored during rescheduling. If false, then the existing reservations can't be ignored during rescheduling. This attribute does not have a default value. This is applicable only for drop ship orders.
-
IncludedItemsFlag: boolean
Contains one of the following values: true or false. If true, then the included items for PTO model are specified on the request. If false, then the included items for PTO model are derived internally. This attribute doesn't have a default value.
-
InstanceNumber: string
Maximum Length:
255
Value that identifies the source system from which the order promising service request originated. -
InternalOrderType: string
Maximum Length:
255
Value that indicates the type of internal order. Valid values include TO, ISO, and SO. -
InternalSupplyIdentifier: string
Maximum Length:
255
Value that identifies the supply document in case of internal material transfer. -
LatestAcceptableDate: string
(date-time)
Date beyond which the fulfillment line must not be promised.
-
LineFillRate: number
Number that indicates the percentage of quantity that can be promised by the requested date.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumPromisePercentage: integer
Minimum promise quantity calculated based on both MinPromiseQuantity and MinPromisePercentage, where the higher value becomes the constraint.
-
MinimumPromiseQuantity: number
Minimum availability required to create a promise.
-
NumberofAltOptions: number
Total number of availability options generated for the fulfillment line service request.
-
NumberOfATPItems: integer
Number of items for which available to promise inventory was used in the availability option.
-
NumberOfCTPItems: integer
Number of items for which capable to promise supplies were used in the availability option.
-
NumberOfSplits: integer
Number of split lines generated for the fulfillment line.
-
NumberOfSubstitutions: integer
Number of end item substitutions generated for the fulfillment line.
-
OptionRank: string
Maximum Length:
255
Number that represents the unique identifier for the fulfillment line availability option. -
OptionSummary: string
Maximum Length:
255
Short description of the availability option. -
ParentfulfillIdentifier: string
Maximum Length:
255
Value that indicates the immediate parent of the fulfillment line. This attribute is applicable only for configured to order items. -
ParentSplitLineIdentifier: string
Maximum Length:
255
Value that indicates the parent of the split fulfillment line. This attribute is generated only in case of the order that was split. -
Party: string
Maximum Length:
255
Value that identifies the party representing the customer. -
Partysite: string
Maximum Length:
255
Value that identifies the party site corresponding to the customer ship-to site. -
PeggingDetails: array
Pegging Details
Title:
Pegging Details
The Pegging Details resource manages the supply and demand peggings for a given fulfillment line. -
PickDate: string
(date-time)
Date when the shipment is actually picked at the pickup organization by the customer.
-
PlanningMultiple: integer
(int64)
Value that indicates the multiples in which items in the fulfillment line are grouped.
-
Price: number
Price per unit associated with the availability option.
-
Priority: number
Number that indicates the relative priority of the fulfillment line when multiple fulfillment lines are sent for promising.
-
Profit: number
Projected profit generated by this split line item.
-
PromisingStatus: string
Maximum Length:
255
Contains one of the following values: true or false. If true, then the request can be completely met by the requested arrival date. If false, then can't be met. This attribute doesn't have a default value. -
PromisingType: string
Maximum Length:
255
Type of promise. This attribute can represent either ship date or arrival date based promising. -
Region: string
Maximum Length:
255
Value that uniquely identifies the region from which material is to be shipped to the customer ship-to site. -
RequestedCarrier: string
Maximum Length:
255
Value that identifies the carrier from the ship-from organization to the customer ship-to site that you enter on the fulfillment line. -
RequestedDate: string
(date-time)
Date when the material is requested to be available. Depending on the request type this represents the requested ship date or requested arrival date.
-
RequestedItem: string
Maximum Length:
255
Value that uniquely identifies the item that is being requested. -
RequestedMode: string
Maximum Length:
255
Value that identifies the transport mode from the source inventory organization to destination inventory organization that you enter on the fulfillment line. -
RequestedOrgIdentifier: string
Maximum Length:
255
Value that indicates the desired organization from which the material needs to be shipped to the customer ship-to site. -
RequestedQuantity: number
Quantity of the item requested on the fulfillment line.
-
RequestedQuantityUOM: string
Maximum Length:
255
Unit of measure associated with the item requested on the fulfillment line. -
RequestedService: string
Maximum Length:
255
Value that identifies the service level used for shipping from the ship-from organization to the customer ship-to site that you enter on the fulfillment line. -
RequestedType: string
Maximum Length:
255
Value that indicates whether the request is of arrival date or ship date type. Depending on the request type, the requested date represents the requested ship date and requested arrival date respectively. -
ReservationDate: string
(date-time)
Date when the reservation between supply and the demand line is created.
-
ReservedQuantity: integer
(int64)
Quantity of the fulfillment line that has been reserved in the fulfillment application.
-
RoundToNearestFlag: boolean
Contains one of the following values: true or false. If true, then enable rounding of items to the nearest planning multiple. If false, then disable rounding of items to the nearest planning multiple. This attribute doesn't have a default value.
-
SalesOrderNumber: string
Maximum Length:
255
Value that uniquely identifies the sales order for which the fulfillment line is created. -
SetLineFlag: boolean
Contains one of the following values: true or false. If true, then the line is for a Set. If false, then the line isn't for a Set. The default value is false.
-
SetModelFlag: boolean
Contains one of the following values: true or false. If true, then the line is for Model. If false, then the line isn't for Model. The default value is false.
-
ShipDate: string
(date-time)
Date when the supply will be shipped from the supplier site or source organization.
-
ShippingPreference: string
Maximum Length:
255
Value that indicates that Oracle Global Order Promising Cloud must consider the fastest or lowest cost shipping option from the source organization to customer. Valid values are FASTEST or LOWESTCOST. -
ShipQuantity: string
Maximum Length:
255
Number that identifies the shipment quantity of the item. -
SourcingRule: string
Maximum Length:
255
Value that uniquely identifies the sourcing rule used. -
SplitAllowedFlag: boolean
Contains one of the following values: true or false. If true, then splits of the fulfillment line are allowed. If false, then splits of the fulfillment line are not allowed. This attribute does not have a default value.
-
SplitLineId: string
Maximum Length:
255
Value that uniquely identifies the fulfillment line split. A unique number is generated in case of the order that was split. -
SubstitutionsAllowedFlag: boolean
Contains one of the following values: true or false. If true, then the fulfillment line can be split based on supply availability dates in the case of order delays. If false, then the fulfillment line can't be split. This attribute does not have a default value.
-
TotalMargin: number
Total margin for the fulfillment line or availability option.
-
TotalPrice: number
Total price for the fulfillment line or availability option.
-
TotalProfit: number
Total profit for the fulfillment line or availability option.
-
TotalValue: number
Total value for the fulfillment line or availability option.
-
UniqueOrderId: string
Maximum Length:
255
Value that uniquely identifies the order for the request. -
UnitPrice: number
Per unit price that needs to be considered by order promising to calculate the margin information.
-
UpdateTime: string
(date-time)
Date and time when the result was updated.
-
Value: number
Value associated with the fulfillment line availability response.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Pegging Details
Type:
array
Title:
Pegging Details
The Pegging Details resource manages the supply and demand peggings for a given fulfillment line.
Show Source
Nested Schema : orderPromises-FulFillmentLine-PeggingDetails-item-response
Type:
Show Source
object
-
AllocationRule: string
Maximum Length:
255
Value that identifies the allocation rule applicable to the demand class associated with the order. -
AlternateResource: string
Maximum Length:
255
Contains one of the following values: true or false. If true, then an alternate resources is considered. If false, then an alternate resources is not considered. This attribute does not have a default value. -
ArrivalDate: string
(date-time)
Date when the purchased supply will be available at the destination organization.
-
ATPCost: integer
(int64)
Number that indicates the cost associated with the available-to-promise inventory used for promising the fulfillment line.
-
ATPmode: string
Maximum Length:
255
Value that indicates the mode of order promising used to promise the order. Valid values are infinite, lead-time, and supply chain search. -
AvailabilityOption: string
Maximum Length:
38
Value that identifies an availability option. -
AvailableItem: string
Maximum Length:
255
Value that uniquely identifies the item that is available. -
BackToBackFlag: boolean
Contains one of the following values: true or false. If true, then the item is a back to back enabled item. If false, then the item is not a back to back enabled item. This attribute does not have a default value.
-
BOMCode: string
Maximum Length:
255
Abbreviation that identifies the bill of material used in the capable to promise calculations for the fulfillment line request. -
CarrierCalendar: string
Maximum Length:
255
Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site. -
ConsumptionDate: string
(date-time)
Date when resource availability information needs to be returned.
-
DemandClass: string
Maximum Length:
255
Value that identifies the demand class that the order is associated with. -
DepartmentId: string
Maximum Length:
255
Value that identifies the department or work center to which a resource belongs. -
DestinationOrgId: string
Maximum Length:
255
Abbreviation that identifies the organization that represents the destination of supply for the transfer of supply. -
DropshipSupplier: string
Maximum Length:
255
Name of the drop ship supplier that ships items directly to the customer. -
DropshipSupplierSite: string
Maximum Length:
255
Name of the drop ship supplier site that ships items directly to the customer. -
EndDate: string
(date-time)
Date when manufacturing ends for the item.
-
ExpectedCarrier: string
Maximum Length:
255
Value that identifies the suggested carrier from the source inventory organization to destination inventory organization. -
ExpectedMode: string
Maximum Length:
255
Value that identifies the mode of transport for shipping the material from the source inventory organization to the destination inventory organization, suggested by order promising. -
ExpectedService: string
Maximum Length:
255
Value that identifies the suggested service level used for shipping the material from the source inventory organization to destination inventory organization. -
FixedLeadTime: string
Maximum Length:
255
Number of days of manufacturing lead time that is independent of the order quantity. -
FulfillmentlineId: string
Maximum Length:
38
Value that indicates the unique order identifier for the request. -
Item: string
Maximum Length:
255
Value that uniquely identifies the item that is requested. -
LeadTime: string
Maximum Length:
255
Value that indicates the number of days of lead time. -
LineId: integer
(int64)
Value that uniquely identifies the order line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManufacturingCalendar: string
Maximum Length:
255
Calendar that is associated with the manufacturing operations at an organization. -
OptionRank: integer
(int64)
Number that indicates the rank of the availability option.
-
OrgId: string
Maximum Length:
255
Value that uniquely identifies the organization associated with the item. -
PeggedATPType: string
Maximum Length:
255
Type of the supply. -
PeggingdocId: string
Maximum Length:
255
Value that uniquely identifies the supply and demand pegging. -
PostprocessingLeadTime: string
Maximum Length:
255
Number of days required to make an item available in inventory from the time it received. -
PreprocessingLeadTime: string
Maximum Length:
255
Number of days required to release a purchase order or create a job from the time the requirement is identified. -
ProcessingLeadTime: string
Maximum Length:
255
Number of days required to procure or manufacture an item. -
Quantity: integer
(int64)
Number that indicates the quantity of the available item.
-
QuantityUOM: string
Maximum Length:
255
Value that indicates the unit of measure used for quantity. -
ReceivingCalendar: string
Maximum Length:
255
Value that identifies the receiving calendar used for receiving the material at the inventory organization or customer ship-to site. -
RequiredDate: string
(date-time)
Date when the material is required.
-
RequiredQuantity: number
Number that indicates the quantity required for promising the fulfillment line.
-
ResourceCalendar: string
Maximum Length:
255
Value that identifies the calendar of the resource for which the availability is to be determined. -
ResourceId: string
Maximum Length:
255
Value that identifies the manufacturing resource. -
RoutingCode: string
Maximum Length:
255
Abbreviation that identifies the routing used in the capable to promise calculations for the fulfillment line request. -
ShipDate: string
(date-time)
Date when the supply will be shipped from the supplier site or source organization.
-
ShippingCalendar: string
Maximum Length:
255
Value that identifies the shipping calendar used for shipping the material from supplier site to the inventory organization or the customer ship-to site. -
SourceOrgId: string
Maximum Length:
255
Value that uniquely identifies the organization that is the source of supply. -
StartDate: string
(date-time)
Date when manufacturing is expected to start for the item.
-
SupplierId: string
Maximum Length:
255
Value that uniquely identifies the item supplier from whom supply is procured. -
SupplierSiteId: string
Maximum Length:
255
Value that uniquely identifies the item supplier site from which supply is procured. -
TransitLeadTime: string
Maximum Length:
255
Number of days required for transporting the requested item from source organization to the destination organization. -
UniqueOrderId: string
Maximum Length:
38
Value that uniquely identifies the fulfillment line. -
VariableLeadTime: string
Maximum Length:
255
Number that indicates the portion of manufacturing lead time that is dependent on order quantity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AlternateOptions
-
Parameters:
- UniqueOrderId:
$request.path.UniqueOrderId
The Alternate Options resource manages the potential promising result for a fulfillment line. - UniqueOrderId:
- FulFillmentLine
-
Parameters:
- UniqueOrderId:
$request.path.UniqueOrderId
The Fulfillment Lines resource manages the details of a sales order line. - UniqueOrderId: