1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Order Promises (Deprecated)

Create an order promise

post

/fscmRestApi/resources/11.13.18.05/orderPromises

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 does not 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
Type: object
Show Source
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 : orderPromises-AlternateOptions-item-post-request
Type: object
Show Source
Nested Schema : Pegging Details
Type: array
Title: Pegging Details
The Pegging Details resource manages the supply and demand pegging for a given fulfillment line.
Show Source
Nested Schema : schema
Type: object
Show Source
  • Maximum Length: 255
    Value that identifies the allocation rule applicable to the demand class associated with the order.
  • 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 isn't considered. This attribute doesn't have a default value.
  • Date when the purchased supply will be available at the destination organization.
  • Number that indicates the cost associated with the available-to-promise inventory used for promising the fulfillment line.
  • 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.
  • Maximum Length: 38
    Value that identifies an availability option.
  • Maximum Length: 255
    Value that uniquely identifies the item that's available.
  • 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 isn't a back to back enabled item. This attribute doesn't have a default value.
  • Maximum Length: 255
    Abbreviation that identifies the bill of material used in the capable to promise calculations for the fulfillment line request.
  • Maximum Length: 255
    Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.
  • Date when resource availability information needs to be returned.
  • Maximum Length: 255
    Value that identifies the demand class that the order is associated with.
  • Maximum Length: 255
    Value that identifies the department or work center to which a resource belongs.
  • Maximum Length: 255
    Value that uniquely identifies the organization that represents the destination of supply for the transfer of supply.
  • Maximum Length: 255
    Name of the drop ship supplier that ships items directly to the customer.
  • Maximum Length: 255
    Name of the drop ship supplier site that ships items directly to the customer.
  • Date when manufacturing ends for the item.
  • Maximum Length: 255
    Value that identifies the suggested carrier from the source inventory organization to destination inventory organization.
  • 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.
  • Maximum Length: 255
    Value that identifies the suggested service level used for shipping the material from the source inventory organization to destination inventory organization.
  • Maximum Length: 255
    Number of days of manufacturing lead time that's independent of the order quantity.
  • Maximum Length: 38
    Value that indicates the unique order identifier for the request.
  • Maximum Length: 255
    Value that uniquely identifies the item that's requested.
  • Maximum Length: 255
    Value that indicates the number of days of lead time.
  • Value that uniquely identifies the order line.
  • Maximum Length: 255
    Calendar that's associated with the manufacturing operations at an organization.
  • Number that indicates the rank of the availability option.
  • Maximum Length: 255
    Value that uniquely identifies the organization associated with the item.
  • Maximum Length: 255
    Type of the supply.
  • Maximum Length: 255
    Value that uniquely identifies the supply and demand pegging.
  • Maximum Length: 255
    Number of days required to make an item available in inventory from the time it received.
  • Maximum Length: 255
    Number of days required to release a purchase order or create a job from the time the requirement is identified.
  • Maximum Length: 255
    Number of days required to procure or manufacture an item.
  • Number that indicates the quantity of the available item.
  • Maximum Length: 255
    Value that indicates the unit of measure used for quantity.
  • Maximum Length: 255
    Value that identifies the receiving calendar used for receiving the material at the inventory organization or customer ship-to site.
  • Date when the material is required.
  • Number that indicates the quantity required for promising the fulfillment line.
  • Maximum Length: 255
    Value that identifies the calendar of the resource for which the availability is to be determined.
  • Maximum Length: 255
    Value that identifies the manufacturing resource.
  • Maximum Length: 255
    Abbreviation that identifies the routing used in the capable to promise calculations for the fulfillment line request.
  • Date when the supply will be shipped from the supplier site or source organization.
  • 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.
  • Maximum Length: 255
    Value that uniquely identifies the organization that's the source of supply.
  • Date when manufacturing is expected to start for the item.
  • Maximum Length: 255
    Value that uniquely identifies the item supplier from whom supply is procured.
  • Maximum Length: 255
    Value that uniquely identifies the item supplier site from which supply is procured.
  • Maximum Length: 255
    Number of days required for transporting the requested item from source organization to the destination organization.
  • Maximum Length: 38
    Value that uniquely identifies the fulfillment line.
  • Maximum Length: 255
    Number that indicates the portion of manufacturing lead time that's dependent on order quantity.
Nested Schema : schema
Type: object
Show Source
  • Date when the purchased supply will be available at the destination organization.
  • Maximum Length: 255
    Value that indicates the availability basis for selecting the ship method. Valid values include Fastest Delivery and Cost.
  • Maximum Length: 255
    Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.
  • 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.
  • Maximum Length: 255
    This attribute is for future use.
  • Value that indicates the delivery cost that you enter on the fulfillment line.
  • Value that indicates the delivery lead time that you enter on the fulfillment line.
  • Maximum Length: 255
    Value that identifies the demand class that the order is associated with.
  • Maximum Length: 255
    Abbreviation that identifies the organization that represents the destination of supply, for transfer of supply.
  • Maximum Length: 255
    Value that identifies the receiving calendar for the customer or destination organization in case in internal order.
  • Maximum Length: 255
    Value that uniquely identifies the drop ship supplier from which material is to be shipped to the customer ship-to site.
  • 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.
  • Date before which the fulfillment line must not be promised.
  • Maximum Length: 255
    Abbreviation that identifies the error code, if any, returned by Oracle Global Order Promising Cloud for the service request.
  • Maximum Length: 255
    Text of the error message, if any, for the error code.
  • Date when the fulfillment line is expected to be available at the customer ship-to site.
  • Number that indicates the available to promise inventory quantity on the requested date.
  • Maximum Length: 255
    Value that identifies the item that's expected to be used for satisfying the customer demand. This attribute can be either the requested item or substitute of the requested item.
  • 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.
  • Maximum Length: 255
    Value that identifies the unit of measure used to represent the available quantity.
  • Value that identifies the suggested carrier from the ship-from organization to the customer ship-to site.
  • Value that identifies the demand class that the order is associated with.
  • Maximum Length: 255
    Value that identifies the suggested drop ship supplier.
  • 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.
  • Maximum Length: 255
    Source application to which the drop ship supplier and supplier belong to.
  • Date when the set of fulfillment lines are expected to arrive at the customer ship-to site.
  • Date when the set of fulfillment lines are expected to be shipped together from the shipping organization.
  • 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.
  • Value that identifies the suggested transport mode from the source inventory organization to destination inventory organization.
  • Date when the item is expected to be picked at the ship-from organization.
  • 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.
  • Date when the requested item line is expected to be shipped from the ship-from organization to the customer ship-to site.
  • Maximum Length: 255
    Value that identifies the expected shipping organization to the customer ship-to site for the fulfillment line or availability option.
  • Expected shipping cost associated with the fulfillment line or availability option.
  • Total expected cost associated with the fulfillment line or availability option.
  • Value that indicates the percentage of quantity that can be promised on the requested date.
  • Maximum Length: 255
    Value that uniquely identifies the fulfillment line.
  • 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 doesn't have a default value.
  • 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.
  • 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 doesn't have a default value.
  • 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 doesn't have a default value. This attribute is applicable only for drop ship requests.
  • 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 doesn't have a default value. This is applicable only for drop ship orders.
  • 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.
  • Maximum Length: 255
    Value that identifies the source system from which the order promising service request originated.
  • Maximum Length: 255
    Value that indicates the type of internal order. Valid values include TO, ISO, and SO.
  • Maximum Length: 255
    Value that identifies the supply document in case of internal material transfer.
  • Date beyond which the fulfillment line must not be promised.
  • Number that indicates the percentage of quantity that can be promised by the requested date.
  • Minimum promise quantity calculated based on both MinPromiseQuantity and MinPromisePercentage, where the higher value becomes the constraint.
  • Minimum availability required to create a promise.
  • Total number of availability options generated for the fulfillment line service request.
  • Number of items for which available to promise inventory was used in the availability option.
  • Number of items for which capable to promise supplies were used in the availability option.
  • Number of split lines generated for the fulfillment line.
  • Number of end item substitutions generated for the fulfillment line.
  • Maximum Length: 255
    Number that represents the unique identifier for the fulfillment line availability option.
  • Maximum Length: 255
    Short description of the availability option.
  • Maximum Length: 255
    Value that indicates the immediate parent of the fulfillment line. This attribute is applicable only for configured to order items.
  • 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.
  • Maximum Length: 255
    Value that identifies the party representing the customer.
  • Maximum Length: 255
    Value that identifies the party site corresponding to the customer ship-to site.
  • Pegging Details
    Title: Pegging Details
    The Pegging Details resource manages the supply and demand pegging for a given fulfillment line.
  • Date when the shipment is actually picked at the pickup organization by the customer.
  • Value that indicates the multiples in which items in the fulfillment line are grouped.
  • Price per unit associated with the availability option.
  • Number that indicates the relative priority of the fulfillment line when multiple fulfillment lines are sent for promising.
  • Projected profit generated by this split line item.
  • 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.
  • Maximum Length: 255
    Type of promise. This attribute can represent either ship date or arrival date based promising.
  • Maximum Length: 255
    Value that uniquely identifies the region from which material is to be shipped to the customer ship-to site.
  • 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.
  • Date when the material is requested to be available. Depending on the request type this represents the requested ship date or requested arrival date.
  • Maximum Length: 255
    Value that uniquely identifies the item that's being requested.
  • 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.
  • Maximum Length: 255
    Value that indicates the desired organization from which the material needs to be shipped to the customer ship-to site.
  • Quantity of the item requested on the fulfillment line.
  • Maximum Length: 255
    Unit of measure associated with the item requested on the fulfillment line.
  • 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.
  • 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.
  • Date when the reservation between supply and the demand line is created.
  • Quantity of the fulfillment line that has been reserved in the fulfillment application.
  • 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.
  • Maximum Length: 255
    Value that uniquely identifies the sales order for which the fulfillment line is created.
  • 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.
  • 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.
  • Date when the supply will be shipped from the supplier site or source organization.
  • 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.
  • Maximum Length: 255
    Number that identifies the shipment quantity of the item.
  • Maximum Length: 255
    Value that uniquely identifies the sourcing rule used.
  • 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 aren't allowed. This attribute doesn't have a default value.
  • Maximum Length: 255
    Value that uniquely identifies the fulfillment line split. A unique number is generated in case of the order that was split.
  • 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 doesn't have a default value.
  • Total margin for the fulfillment line or availability option.
  • Total price for the fulfillment line or availability option.
  • Total profit for the fulfillment line or availability option.
  • Total value for the fulfillment line or availability option.
  • Maximum Length: 255
    Value that uniquely identifies the order for the request.
  • Price per unit that needs to be considered by order promising to calculate the margin information.
  • Date and time when the result was updated.
  • Value associated with the fulfillment line availability response.
Nested Schema : Pegging Details
Type: array
Title: Pegging Details
The Pegging Details resource manages the supply and demand pegging for a given fulfillment line.
Show Source
Nested Schema : schema
Type: object
Show Source
  • Maximum Length: 255
    Value that identifies the allocation rule applicable to the demand class associated with the order.
  • 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 isn't considered. This attribute doesn't have a default value.
  • Date when the purchased supply will be available at the destination organization.
  • Number that indicates the cost associated with the available-to-promise inventory used for promising the fulfillment line.
  • 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.
  • Maximum Length: 38
    Value that identifies an availability option.
  • Maximum Length: 255
    Value that uniquely identifies the item that's available.
  • 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 isn't a back to back enabled item. This attribute doesn't have a default value.
  • Maximum Length: 255
    Abbreviation that identifies the bill of material used in the capable to promise calculations for the fulfillment line request.
  • Maximum Length: 255
    Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.
  • Date when resource availability information needs to be returned.
  • Maximum Length: 255
    Value that identifies the demand class that the order is associated with.
  • Maximum Length: 255
    Value that identifies the department or work center to which a resource belongs.
  • Maximum Length: 255
    Value that uniquely identifies the organization that represents the destination of supply for the transfer of supply.
  • Maximum Length: 255
    Name of the drop ship supplier that ships items directly to the customer.
  • Maximum Length: 255
    Name of the drop ship supplier site that ships items directly to the customer.
  • Date when manufacturing ends for the item.
  • Maximum Length: 255
    Value that identifies the suggested carrier from the source inventory organization to destination inventory organization.
  • 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.
  • Maximum Length: 255
    Value that identifies the suggested service level used for shipping the material from the source inventory organization to destination inventory organization.
  • Maximum Length: 255
    Number of days of manufacturing lead time that's independent of the order quantity.
  • Maximum Length: 38
    Value that indicates the unique order identifier for the request.
  • Maximum Length: 255
    Value that uniquely identifies the item that's requested.
  • Maximum Length: 255
    Value that indicates the number of days of lead time.
  • Value that uniquely identifies the order line.
  • Maximum Length: 255
    Calendar that's associated with the manufacturing operations at an organization.
  • Number that indicates the rank of the availability option.
  • Maximum Length: 255
    Value that uniquely identifies the organization associated with the item.
  • Maximum Length: 255
    Type of the supply.
  • Maximum Length: 255
    Value that uniquely identifies the supply and demand pegging.
  • Maximum Length: 255
    Number of days required to make an item available in inventory from the time it received.
  • Maximum Length: 255
    Number of days required to release a purchase order or create a job from the time the requirement is identified.
  • Maximum Length: 255
    Number of days required to procure or manufacture an item.
  • Number that indicates the quantity of the available item.
  • Maximum Length: 255
    Value that indicates the unit of measure used for quantity.
  • Maximum Length: 255
    Value that identifies the receiving calendar used for receiving the material at the inventory organization or customer ship-to site.
  • Date when the material is required.
  • Number that indicates the quantity required for promising the fulfillment line.
  • Maximum Length: 255
    Value that identifies the calendar of the resource for which the availability is to be determined.
  • Maximum Length: 255
    Value that identifies the manufacturing resource.
  • Maximum Length: 255
    Abbreviation that identifies the routing used in the capable to promise calculations for the fulfillment line request.
  • Date when the supply will be shipped from the supplier site or source organization.
  • 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.
  • Maximum Length: 255
    Value that uniquely identifies the organization that's the source of supply.
  • Date when manufacturing is expected to start for the item.
  • Maximum Length: 255
    Value that uniquely identifies the item supplier from whom supply is procured.
  • Maximum Length: 255
    Value that uniquely identifies the item supplier site from which supply is procured.
  • Maximum Length: 255
    Number of days required for transporting the requested item from source organization to the destination organization.
  • Maximum Length: 38
    Value that uniquely identifies the fulfillment line.
  • Maximum Length: 255
    Number that indicates the portion of manufacturing lead time that's dependent on order quantity.
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 does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : orderPromises-item-response
Type: object
Show Source
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 : orderPromises-AlternateOptions-item-response
Type: object
Show Source
Nested Schema : Pegging Details
Type: array
Title: Pegging Details
The Pegging Details resource manages the supply and demand pegging for a given fulfillment line.
Show Source
Nested Schema : orderPromises-AlternateOptions-PeggingDetails-item-response
Type: object
Show Source
  • Maximum Length: 255
    Value that identifies the allocation rule applicable to the demand class associated with the order.
  • 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 isn't considered. This attribute doesn't have a default value.
  • Date when the purchased supply will be available at the destination organization.
  • Number that indicates the cost associated with the available-to-promise inventory used for promising the fulfillment line.
  • 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.
  • Maximum Length: 38
    Value that identifies an availability option.
  • Maximum Length: 255
    Value that uniquely identifies the item that's available.
  • 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 isn't a back to back enabled item. This attribute doesn't have a default value.
  • Maximum Length: 255
    Abbreviation that identifies the bill of material used in the capable to promise calculations for the fulfillment line request.
  • Maximum Length: 255
    Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.
  • Date when resource availability information needs to be returned.
  • Maximum Length: 255
    Value that identifies the demand class that the order is associated with.
  • Maximum Length: 255
    Value that identifies the department or work center to which a resource belongs.
  • Maximum Length: 255
    Value that uniquely identifies the organization that represents the destination of supply for the transfer of supply.
  • Maximum Length: 255
    Name of the drop ship supplier that ships items directly to the customer.
  • Maximum Length: 255
    Name of the drop ship supplier site that ships items directly to the customer.
  • Date when manufacturing ends for the item.
  • Maximum Length: 255
    Value that identifies the suggested carrier from the source inventory organization to destination inventory organization.
  • 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.
  • Maximum Length: 255
    Value that identifies the suggested service level used for shipping the material from the source inventory organization to destination inventory organization.
  • Maximum Length: 255
    Number of days of manufacturing lead time that's independent of the order quantity.
  • Maximum Length: 38
    Value that indicates the unique order identifier for the request.
  • Maximum Length: 255
    Value that uniquely identifies the item that's requested.
  • Maximum Length: 255
    Value that indicates the number of days of lead time.
  • Value that uniquely identifies the order line.
  • Links
  • Maximum Length: 255
    Calendar that's associated with the manufacturing operations at an organization.
  • Number that indicates the rank of the availability option.
  • Maximum Length: 255
    Value that uniquely identifies the organization associated with the item.
  • Maximum Length: 255
    Type of the supply.
  • Maximum Length: 255
    Value that uniquely identifies the supply and demand pegging.
  • Maximum Length: 255
    Number of days required to make an item available in inventory from the time it received.
  • Maximum Length: 255
    Number of days required to release a purchase order or create a job from the time the requirement is identified.
  • Maximum Length: 255
    Number of days required to procure or manufacture an item.
  • Number that indicates the quantity of the available item.
  • Maximum Length: 255
    Value that indicates the unit of measure used for quantity.
  • Maximum Length: 255
    Value that identifies the receiving calendar used for receiving the material at the inventory organization or customer ship-to site.
  • Date when the material is required.
  • Number that indicates the quantity required for promising the fulfillment line.
  • Maximum Length: 255
    Value that identifies the calendar of the resource for which the availability is to be determined.
  • Maximum Length: 255
    Value that identifies the manufacturing resource.
  • Maximum Length: 255
    Abbreviation that identifies the routing used in the capable to promise calculations for the fulfillment line request.
  • Date when the supply will be shipped from the supplier site or source organization.
  • 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.
  • Maximum Length: 255
    Value that uniquely identifies the organization that's the source of supply.
  • Date when manufacturing is expected to start for the item.
  • Maximum Length: 255
    Value that uniquely identifies the item supplier from whom supply is procured.
  • Maximum Length: 255
    Value that uniquely identifies the item supplier site from which supply is procured.
  • Maximum Length: 255
    Number of days required for transporting the requested item from source organization to the destination organization.
  • Maximum Length: 38
    Value that uniquely identifies the fulfillment line.
  • Maximum Length: 255
    Number that indicates the portion of manufacturing lead time that's dependent on order quantity.
Nested Schema : orderPromises-FulFillmentLine-item-response
Type: object
Show Source
  • Date when the purchased supply will be available at the destination organization.
  • Maximum Length: 255
    Value that indicates the availability basis for selecting the ship method. Valid values include Fastest Delivery and Cost.
  • Maximum Length: 255
    Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.
  • 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.
  • Maximum Length: 255
    This attribute is for future use.
  • Value that indicates the delivery cost that you enter on the fulfillment line.
  • Value that indicates the delivery lead time that you enter on the fulfillment line.
  • Maximum Length: 255
    Value that identifies the demand class that the order is associated with.
  • Maximum Length: 255
    Abbreviation that identifies the organization that represents the destination of supply, for transfer of supply.
  • Maximum Length: 255
    Value that identifies the receiving calendar for the customer or destination organization in case in internal order.
  • Maximum Length: 255
    Value that uniquely identifies the drop ship supplier from which material is to be shipped to the customer ship-to site.
  • 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.
  • Date before which the fulfillment line must not be promised.
  • Maximum Length: 255
    Abbreviation that identifies the error code, if any, returned by Oracle Global Order Promising Cloud for the service request.
  • Maximum Length: 255
    Text of the error message, if any, for the error code.
  • Date when the fulfillment line is expected to be available at the customer ship-to site.
  • Number that indicates the available to promise inventory quantity on the requested date.
  • Maximum Length: 255
    Value that identifies the item that's expected to be used for satisfying the customer demand. This attribute can be either the requested item or substitute of the requested item.
  • 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.
  • Maximum Length: 255
    Value that identifies the unit of measure used to represent the available quantity.
  • Value that identifies the suggested carrier from the ship-from organization to the customer ship-to site.
  • Value that identifies the demand class that the order is associated with.
  • Maximum Length: 255
    Value that identifies the suggested drop ship supplier.
  • 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.
  • Maximum Length: 255
    Source application to which the drop ship supplier and supplier belong to.
  • Date when the set of fulfillment lines are expected to arrive at the customer ship-to site.
  • Date when the set of fulfillment lines are expected to be shipped together from the shipping organization.
  • 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.
  • Value that identifies the suggested transport mode from the source inventory organization to destination inventory organization.
  • Date when the item is expected to be picked at the ship-from organization.
  • 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.
  • Date when the requested item line is expected to be shipped from the ship-from organization to the customer ship-to site.
  • Maximum Length: 255
    Value that identifies the expected shipping organization to the customer ship-to site for the fulfillment line or availability option.
  • Expected shipping cost associated with the fulfillment line or availability option.
  • Total expected cost associated with the fulfillment line or availability option.
  • Value that indicates the percentage of quantity that can be promised on the requested date.
  • Maximum Length: 255
    Value that uniquely identifies the fulfillment line.
  • 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 doesn't have a default value.
  • 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.
  • 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 doesn't have a default value.
  • 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 doesn't have a default value. This attribute is applicable only for drop ship requests.
  • 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 doesn't have a default value. This is applicable only for drop ship orders.
  • 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.
  • Maximum Length: 255
    Value that identifies the source system from which the order promising service request originated.
  • Maximum Length: 255
    Value that indicates the type of internal order. Valid values include TO, ISO, and SO.
  • Maximum Length: 255
    Value that identifies the supply document in case of internal material transfer.
  • Date beyond which the fulfillment line must not be promised.
  • Number that indicates the percentage of quantity that can be promised by the requested date.
  • Links
  • Minimum promise quantity calculated based on both MinPromiseQuantity and MinPromisePercentage, where the higher value becomes the constraint.
  • Minimum availability required to create a promise.
  • Total number of availability options generated for the fulfillment line service request.
  • Number of items for which available to promise inventory was used in the availability option.
  • Number of items for which capable to promise supplies were used in the availability option.
  • Number of split lines generated for the fulfillment line.
  • Number of end item substitutions generated for the fulfillment line.
  • Maximum Length: 255
    Number that represents the unique identifier for the fulfillment line availability option.
  • Maximum Length: 255
    Short description of the availability option.
  • Maximum Length: 255
    Value that indicates the immediate parent of the fulfillment line. This attribute is applicable only for configured to order items.
  • 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.
  • Maximum Length: 255
    Value that identifies the party representing the customer.
  • Maximum Length: 255
    Value that identifies the party site corresponding to the customer ship-to site.
  • Pegging Details
    Title: Pegging Details
    The Pegging Details resource manages the supply and demand pegging for a given fulfillment line.
  • Date when the shipment is actually picked at the pickup organization by the customer.
  • Value that indicates the multiples in which items in the fulfillment line are grouped.
  • Price per unit associated with the availability option.
  • Number that indicates the relative priority of the fulfillment line when multiple fulfillment lines are sent for promising.
  • Projected profit generated by this split line item.
  • 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.
  • Maximum Length: 255
    Type of promise. This attribute can represent either ship date or arrival date based promising.
  • Maximum Length: 255
    Value that uniquely identifies the region from which material is to be shipped to the customer ship-to site.
  • 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.
  • Date when the material is requested to be available. Depending on the request type this represents the requested ship date or requested arrival date.
  • Maximum Length: 255
    Value that uniquely identifies the item that's being requested.
  • 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.
  • Maximum Length: 255
    Value that indicates the desired organization from which the material needs to be shipped to the customer ship-to site.
  • Quantity of the item requested on the fulfillment line.
  • Maximum Length: 255
    Unit of measure associated with the item requested on the fulfillment line.
  • 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.
  • 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.
  • Date when the reservation between supply and the demand line is created.
  • Quantity of the fulfillment line that has been reserved in the fulfillment application.
  • 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.
  • Maximum Length: 255
    Value that uniquely identifies the sales order for which the fulfillment line is created.
  • 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.
  • 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.
  • Date when the supply will be shipped from the supplier site or source organization.
  • 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.
  • Maximum Length: 255
    Number that identifies the shipment quantity of the item.
  • Maximum Length: 255
    Value that uniquely identifies the sourcing rule used.
  • 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 aren't allowed. This attribute doesn't have a default value.
  • Maximum Length: 255
    Value that uniquely identifies the fulfillment line split. A unique number is generated in case of the order that was split.
  • 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 doesn't have a default value.
  • Total margin for the fulfillment line or availability option.
  • Total price for the fulfillment line or availability option.
  • Total profit for the fulfillment line or availability option.
  • Total value for the fulfillment line or availability option.
  • Maximum Length: 255
    Value that uniquely identifies the order for the request.
  • Price per unit that needs to be considered by order promising to calculate the margin information.
  • Date and time when the result was updated.
  • Value associated with the fulfillment line availability response.
Nested Schema : Pegging Details
Type: array
Title: Pegging Details
The Pegging Details resource manages the supply and demand pegging for a given fulfillment line.
Show Source
Nested Schema : orderPromises-FulFillmentLine-PeggingDetails-item-response
Type: object
Show Source
  • Maximum Length: 255
    Value that identifies the allocation rule applicable to the demand class associated with the order.
  • 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 isn't considered. This attribute doesn't have a default value.
  • Date when the purchased supply will be available at the destination organization.
  • Number that indicates the cost associated with the available-to-promise inventory used for promising the fulfillment line.
  • 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.
  • Maximum Length: 38
    Value that identifies an availability option.
  • Maximum Length: 255
    Value that uniquely identifies the item that's available.
  • 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 isn't a back to back enabled item. This attribute doesn't have a default value.
  • Maximum Length: 255
    Abbreviation that identifies the bill of material used in the capable to promise calculations for the fulfillment line request.
  • Maximum Length: 255
    Value that identifies the calendar for the suggested carrier from the ship-from organization to the customer ship-to site.
  • Date when resource availability information needs to be returned.
  • Maximum Length: 255
    Value that identifies the demand class that the order is associated with.
  • Maximum Length: 255
    Value that identifies the department or work center to which a resource belongs.
  • Maximum Length: 255
    Value that uniquely identifies the organization that represents the destination of supply for the transfer of supply.
  • Maximum Length: 255
    Name of the drop ship supplier that ships items directly to the customer.
  • Maximum Length: 255
    Name of the drop ship supplier site that ships items directly to the customer.
  • Date when manufacturing ends for the item.
  • Maximum Length: 255
    Value that identifies the suggested carrier from the source inventory organization to destination inventory organization.
  • 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.
  • Maximum Length: 255
    Value that identifies the suggested service level used for shipping the material from the source inventory organization to destination inventory organization.
  • Maximum Length: 255
    Number of days of manufacturing lead time that's independent of the order quantity.
  • Maximum Length: 38
    Value that indicates the unique order identifier for the request.
  • Maximum Length: 255
    Value that uniquely identifies the item that's requested.
  • Maximum Length: 255
    Value that indicates the number of days of lead time.
  • Value that uniquely identifies the order line.
  • Links
  • Maximum Length: 255
    Calendar that's associated with the manufacturing operations at an organization.
  • Number that indicates the rank of the availability option.
  • Maximum Length: 255
    Value that uniquely identifies the organization associated with the item.
  • Maximum Length: 255
    Type of the supply.
  • Maximum Length: 255
    Value that uniquely identifies the supply and demand pegging.
  • Maximum Length: 255
    Number of days required to make an item available in inventory from the time it received.
  • Maximum Length: 255
    Number of days required to release a purchase order or create a job from the time the requirement is identified.
  • Maximum Length: 255
    Number of days required to procure or manufacture an item.
  • Number that indicates the quantity of the available item.
  • Maximum Length: 255
    Value that indicates the unit of measure used for quantity.
  • Maximum Length: 255
    Value that identifies the receiving calendar used for receiving the material at the inventory organization or customer ship-to site.
  • Date when the material is required.
  • Number that indicates the quantity required for promising the fulfillment line.
  • Maximum Length: 255
    Value that identifies the calendar of the resource for which the availability is to be determined.
  • Maximum Length: 255
    Value that identifies the manufacturing resource.
  • Maximum Length: 255
    Abbreviation that identifies the routing used in the capable to promise calculations for the fulfillment line request.
  • Date when the supply will be shipped from the supplier site or source organization.
  • 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.
  • Maximum Length: 255
    Value that uniquely identifies the organization that's the source of supply.
  • Date when manufacturing is expected to start for the item.
  • Maximum Length: 255
    Value that uniquely identifies the item supplier from whom supply is procured.
  • Maximum Length: 255
    Value that uniquely identifies the item supplier site from which supply is procured.
  • Maximum Length: 255
    Number of days required for transporting the requested item from source organization to the destination organization.
  • Maximum Length: 38
    Value that uniquely identifies the fulfillment line.
  • Maximum Length: 255
    Number that indicates the portion of manufacturing lead time that's dependent on order quantity.
Links
AlternateOptions
Parameters:
  • UniqueOrderId: $request.path.UniqueOrderId
The Alternate Options resource manages the potential promising result for a fulfillment line.
FulFillmentLine
Parameters:
  • UniqueOrderId: $request.path.UniqueOrderId
The Fulfillment Lines resource manages the details of a sales order line.
Back to Top

Examples

This example describes how to create order promises.

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.batch+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/"

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

{
	"parts":[
	{
		"id":"Request",
		"path":"/orderPromises",
		"operation":"create",
		"payload":{
			"CallingModule": "GOP",
			"CallingInstance": "100010026240309",
			"RequestedCreationDate":"2017-01-01",
			"OperationName": "checkAvailability",
			"SetIdentifier": "set1",
			"SetType": "Ship",
			"FulFillmentLine" :
			[
			{ 
				"FulfillmentLineId": "1",
				"SalesOrderNumber": "s01",
				"RequestedDate": "2019-02-28",
				"RequestedQuantity": "5",
				"RequestedQuantityUOM": "EA",
				"RequestedType": "Order",
				"SplitAllowedFlag": "true",
				"PromisingType":"Ship",
				"Party": "1006",
				"Partysite": "1089",
				"RequestedItem": "12212",
				"UnitPrice":"10",
				"GenerateAltAvailability": "0",
				"RequestedOrgIdentifier": "10001"
			}
			]
		}
	}
	]
}

Example Response Body

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

{"parts":[{"id":"Request1","path":"https://servername/fscmRestApi/resources/version/orderPromises","operation":"create","payload" : {
			"UniqueOrderId" : "204",
			"CallingModule" : "GOP",
			"CallingInstance" : "100010026240309",
			"PromisingSystem" : "GOP",
			"PromisingInstance" : "100010026240309",
			"SalesOrderNumber" : null,
			"NumberOfAltOptions" : null,
			"RequestedCreationDate" : "2017-01-01",
			"ExpectedGroupShipDate" : "2019-03-11T23:59:59+00:00",
			"ExpectedGroupArrivalDate" : "2019-03-11T23:59:59+00:00",
			"SetIdentifier" : "set1",
			"RootParentFulFillIdentifier" : null,
			"SetType" : "Ship",
			"ModelType" : null,
			"OperationName" : "checkAvailability",
			"ErrorCode" : "null",
			"FulFillmentLine" : [ {
				"UniqueOrderId" : "204",
				"InstanceNumber" : null,
				"InternalSupplyIdentifier" : null,
				"InternalOrderType" : null,
				"FulfillmentLineId" : "1",
				"ParentfulfillIdentifier" : null,
				"SalesOrderNumber" : "s01",
				"SplitLineId" : "1",
				"ParentSplitLineIdentifier" : null,
				"ConfigItem" : null,
				"RequestedDate" : "2019-02-28T00:00:00+00:00",
				"ShipDate" : null,
				"ArrivalDate" : null,
				"PickDate" : null,
				"RequestedQuantity" : 5,
				"RequestedQuantityUOM" : "EA",
				"UnitPrice" : 1E+1,
				"RequestedOrgIdentifier" : "10001",
				"RequestedType" : "Order",
				"RequestedItem" : "12212",
				"LatestAcceptableDate" : null,
				"EarliestAcceptableDate" : null,
				"SplitAllowedFlag" : true,
				"SubstitutionsAllowedFlag" : null,
				"Party" : "1006",
				"Partysite" : "1089",
				"Region" : null,
				"DestinationOrg" : "null",
				"DropshipSupplier" : null,
				"DropshipSupplierSite" : null,
				"PromisingType" : "Ship",
				"Priority" : null,
				"DemandClass" : null,
				"IgnoreReservationFlag" : null,
				"IgnoreDateReservationFlag" : null,
				"NumberofAltOptions" : 0,
				"TotalPrice" : 5E+1,
				"TotalProfit" : 5E+1,
				"TotalMargin" : 1E+2,
				"TotalValue" : 5E+1,
				"NumberOfSplits" : 0,
				"NumberOfSubstitutions" : 0,
				"FillRate" : 1E+2,
				"NumberOfATPItems" : 1,
				"NumberOfCTPItems" : 0,
				"SourcingRule" : "300100089893820",
				"ExpectedGoupShipDate" : null,
				"ExpectedGroupArrivalDate" : null,
				"ExpectedArrivalDate" : "2019-03-11T23:59:59+00:00",
				"ExpectedShipDate" : "2019-03-11T23:59:59+00:00",
				"ExpectedPickDate" : "2019-03-11T23:59:59+00:00",
				"ExpectedAvailableItem" : "12212",
				"ExpectedAvailabilityOnRequestedDate" : 0.0,
				"ExpectedAvailableQuantity" : 5,
				"ExpectedAvailableQuantityUOM" : "EA",
				"ExpectedDropShipSupplierSourceSystem" : null,
				"ExpectedDropShipSupplier" : null,
				"ExpectedDropShipSupplierSite" : null,
				"ExpectedMode" : null,
				"ExpectedService" : null,
				"ExpectedCarrier" : null,
				"ExpectedMargin" : 1E+2,
				"ExpectedDemandClass" : null,
				"ExpectedTotalFulfilmentCost" : 0.0,
				"ExpectedShippingCost" : 0.0,
				"LineFillRate" : 1E+2,
				"ExpectedShipFromOrg" : "10001",
				"CarrierCalendar" : null,
				"DestinationReceivingCalendar" : null,
				"CustomerClass" : null,
				"ShipQuantity" : null,
				"ReservedQuantity" : null,
				"ReservationDate" : null,
				"GetAvailforSubstituteItems" : null,
				"UpdateTime" : null,
				"GenerateAltAvailability" : null,
				"AvailabilityBasis" : null,
				"DeliveryCost" : null,
				"DeliveryLeadTime" : null,
				"PlanningMultiple" : null,
				"RequestedCarrier" : null,
				"RequestedMode" : null,
				"RequestedService" : null,
				"links" : [ {
					"rel" : "self",
					"href" : "https://servername/fscmRestApi/resources/version/orderPromises/204/child/FulFillmentLine/1",
					"name" : "FulFillmentLine",
					"kind" : "item"
				}, {
					"rel" : "canonical",
					"href" : "https://servername/fscmRestApi/resources/version/orderPromises/204/child/FulFillmentLine/1",
					"name" : "FulFillmentLine",
					"kind" : "item"
				}, {
					"rel" : "parent",
					"href" : "https://servername/fscmRestApi/resources/version/orderPromises/204",
					"name" : "orderPromises",
					"kind" : "item"
				}, {
					"rel" : "child",
					"href" : "https://servername/fscmRestApi/resources/version/orderPromises/204/child/FulFillmentLine/1/child/PeggingDetails",
					"name" : "PeggingDetails",
					"kind" : "collection"
				} ]
			} ],
			"links" : [ {
				"rel" : "self",
				"href" : "https://servername/fscmRestApi/resources/version/orderPromises/204",
				"name" : "orderPromises",
				"kind" : "item"
			}, {
				"rel" : "canonical",
				"href" : "https://servername/fscmRestApi/resources/version/orderPromises/204",
				"name" : "orderPromises",
				"kind" : "item"
			}, {
				"rel" : "child",
				"href" : "https://servername/fscmRestApi/resources/version/orderPromises/204/child/AlternateOptions",
				"name" : "AlternateOptions",
				"kind" : "collection"
			}, {
				"rel" : "child",
				"href" : "https://servername/fscmRestApi/resources/version/orderPromises/204/child/FulFillmentLine",
				"name" : "FulFillmentLine",
				"kind" : "collection"
			} ]
		}
	} ]
}
Back to Top