Automatically schedule
/fscmRestApi/msp/latest/globalOrderPromises/autoSchedule
Request
There are no request parameters for this operation.
- application/json
object
-
CallingInstance: string
Value that indicates the unique identifier of the source application from which the order promising service request originated.
-
CallingModule: string
Value that indicates the identifier of the module from which the order promising service request originated.
-
FulfillmentLineEntryList: array
FulfillmentLineEntryList
Values that contain the attributes of the fulfillment line request entry.
-
ReleaseNumber: string
Number that indicates the release of Oracle Distributed Order Orchestration Cloud that is calling Oracle Global Order Promising Cloud services.
-
RequestCreationDate: string
(date-time)
Date and time when the check availability request was created for the fulfillment line.
-
RequestTimeZone: string
Time zone from which the ship method request originated.
-
UniqueOrderIdentifier: string
Value that uniquely identifies the order.
array
object
-
AllocationNodeFirstLevel: string
Level 1 of the allocation node for the fulfillment line.
-
AllocationNodeSecondLevel: string
Level 2 of the allocation node for the fulfillment line.
-
AllocationNodeThirdLevel: string
Level 3 of the allocation node for the fulfillment line.
-
AvailabilityBasis: string
Value that indicates the availability basis for selecting the ship method. Valid values include Fastest Delivery and Cost.
-
ConfigItem: string
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
This attribute is not currently used.
-
CustomerDetails: object
CustomerDetails
-
DeliveryCost: number
(double)
Value that indicates the delivery cost that you enter on the fulfillment line.
-
DeliveryLeadTime: number
(double)
Value that indicates the delivery lead time that you enter on the fulfillment line.
-
DemandClass: string
Value that identifies the demand class that the order is associated with.
-
DemandSourceLineIdentifier: string
The order line identifier for the quote or shopping cart demand originating from the external source system.
-
DestinationOrg: object
OrgInfo
-
DropShipSupplier: string
Value that uniquely identifies the drop supplier from which material is requested to be shipped to the customer ship-to site. This attribute is not currently used.
-
DropShipSupplierSite: string
Value that uniquely identifies the drop supplier site from which material is requested to be shipped to the customer ship-to site. This indicates the drop ship supplier location from where material is shipped to the customer ship-to site.
-
EarliestAcceptableDateTime: string
(date-time)
Date and time before which the fulfillment line must not be promised.
-
FulfillmentLineIdentifier: string
Value that uniquely identifies the order for the request.
-
GenerateAltAvailabilityFlag: boolean
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.
-
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.
-
InstanceNumber: string
Value that identifies the source application from which the order promising service request originated.
-
InternalOrderType: string
Type of the internal order. Valid values are TO, ISO, and SO.
-
InternalSupplyIdentifier: string
Value that uniquely identifies the source document for the internal order fulfillment line request.
-
LatestAcceptableDateTime: string
(date-time)
Date and time beyond which the fulfillment line must not be promised.
-
ParentFulfillIdentifier: string
Value that uniquely identifies the immediate parent of the fulfillment line. This attribute is applicable only for configured to order items.
-
PlanningMultiple: number
(double)
Value that indicates the multiples in which items in the fulfillment line are grouped.
-
Priority: integer
(int32)
This attribute is not currently used.
-
PromisingType: string
Type of promise. This attribute can represent either ship date or arrival date based promising.
-
RequestedCarrier: string
Value that identifies the carrier from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
-
RequestedCreationDate: string
(date-time)
Date and time when the check availability request was created for the fulfillment line.
-
RequestedDateTime: 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
Value that uniquely identifies the item that is being requested.
-
RequestedMode: string
Mode of transport from the source inventory organization to the destination inventory organization that you enter on the fulfillment line.
-
RequestedQuantity: number
(double)
Quantity of the item requested on the fulfillment line.
-
RequestedQuantityUOM: string
Unit of measure associated with the item requested on the fulfillment line.
-
RequestedServiceLevel: string
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.
-
RequestedShipFromOrg: object
OrgInfo
-
RequestType: string
Type of the request. Valid values include arrival date or ship date. Depending on the request type, the requested date represents the requested ship date and requested arrival date respectively.
-
SalesOrderLineNumber: string
A string unique identifier for the sales order line in the source system for which the fulfillment line is created.
-
SalesOrderNumber: string
Value that uniquely identifies the sales order for which the fulfillment line is created.
-
ShippingPreference: string
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.
-
SplitLineIdentifier: string
Value that uniquely identifies the fulfillment line split. A unique number is generated in case of an order that was split.
-
SplitParameters: object
SplitParameters
-
SplitsAllowedFlag: 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.
-
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.
-
UnitPrice: number
(double)
Price per unit that needs to be considered by order promising to calculate the margin information.
object
-
FulfillmentLineList: array
FulfillmentLineList
Values that represent the fulfillment line attributes.
-
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 does not have a default value.
-
ModelType: string
Type of the configure to order communicated in the service request. Valid values include ATO, PTO-SMC, and PTO-NSMC.
-
RootParentFulfillIdentifier: string
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.
object
-
FulfillmentLineList: array
FulfillmentLineList
Values that represent the fulfillment line attributes.
-
FulfillmentLineModelList: array
FulfillmentLineModelList
Values that represent the fulfillment line model attributes.
-
SetIdentifier: string
Value that uniquely identifies the fulfillment line set.
-
SetType: string
Type of fulfillment line set sent for promising. Valid values are ship, arrival, pickup, and consolidation. Only ship sets are currently supported.
object
-
Party: string
Value that indicates the party representing the customer.
-
PartySite: string
Value that indicates the party site corresponding to the customer ship-to site.
-
Region: string
Value that uniquely identifies the region from which material is to be shipped to the customer ship-to site.
object
-
InstanceNumber: string
Number that identifies the source application from which the order promising service request originated.
-
OrgIdentifier: string
Value that uniquely identifies the organization associated with the item.
object
-
MinSplitPercentage: integer
(int32)
Minimum proportion of the requested quantity required by the requested date in order to create a split fulfillment line. This attribute is not currently used.
-
MinSplitQuantity: number
(double)
Minimum promise quantity required to be available by the requested date in order to create a split fulfillment line.
array
array
array
Response
- application/json
Default Response
object
-
FulfillmentLineEntryResultList: array
FulfillmentLineEntryResultList
Values that contain the web response for the fulfillment line entry.
-
PromiseDateTime: string
(date-time)
Date and time when the promise is generated by Oracle Global Order Promising Cloud.
-
PromisingInstance: string
Value that uniquely identifies the source application in which order promising is performed.
-
PromisingSystem: string
Value that identifies the Oracle Global Order Promising Cloud application that performed the availability check.
array
object
-
ErrorCode: string
Abbreviation that identifies the error code, if any, returned by Oracle Global Order Promising Cloud for the service request.
-
ErrorMessage: string
Text of the error message, if any, for the error code.
-
FulfillmentLineModelReplyList: array
FulfillmentLineModelReplyList
Values for the fulfillment line model service request.
-
FulfillmentLineReplyList: array
FulfillmentLineReplyList
Values that contain the web response for the fulfillment line.
-
FulfillmentLineSetReplyList: array
FulfillmentLineSetReplyList
Values that contain the web response for the fulfillment line set.
array
array
array
object
-
AlternateAvailabilityModelOptionList: array
AlternateAvailabilityModelOptionList
Values that indicate the multiple availability options generated by the order promising web services for the model request.
-
DefaultAvailabilityModelOption: object
AvailabilityModelOption
-
NumberOfAltOptions: integer
(int32)
Total number of availability options generated for the fulfillment line service request.
-
RootParentFulfillIdentifier: string
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.
array
object
-
FulfillmentLineModelResultList: array
FulfillmentLineModelResultList
Values that represent the attributes of the fulfillment line model.
-
OptionRank: integer
(int32)
Number that indicates the rank of the availability option.
-
OptionSummary: string
Summary of how the current set availability option is different from the default availability option.
array
object
-
ErrorCode: string
Abbreviation that identifies the error code, if any, returned by Oracle Global Order Promising Cloud for the service request.
-
ErrorMessage: string
Text of the error message, if any, for the error code.
-
FulfillmentLineResultList: array
FulfillmentLineResultList
Values that represent the response attributes for the fulfillment line model service request.
-
RootParentFulfillIdentifier: string
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.
array
object
-
FillRate: number
(double)
Percent of quantity that can be promised on the requested date.
-
FulfillmentLineIdentifier: string
Value that uniquely identifies the order for the request.
-
InstanceNumber: string
Number that identifies the source application from which the order promising service request originated.
-
InternalOrderType: string
Type of the internal order. Valid values include TO, ISO, and SO.
-
InternalSupplyIdentifier: string
Value that identifies the supply document in case of internal material transfer.
-
NumberOfAtpItems: integer
(int32)
Number of items for which the available to promise inventory was used in the availability option.
-
NumberOfCtpItems: integer
(int32)
Number of items for which the capable to promise supply was used in the availability option.
-
NumberOfSplits: integer
(int32)
Number of split lines generated for the fulfillment line.
-
NumberOfSubstitutions: integer
(int32)
Number of end item substitutions generated for the fulfillment line.
-
ParentFulfillLineIdentifier: string
Value that uniquely identifies the immediate parent of the fulfillment line. This attribute is applicable only for configured to order items.
-
ResultDetailList: array
ResultDetailList
Values that identify the unique configuration item corresponding to the configuration sent for promising. This attribute is applicable only in the case of assemble to order demands.
-
SalesOrderLineNumber: string
Value that identifies the sales order line in the source application for which the fulfillment line is created.
-
SalesOrderNumber: string
Value that uniquely identifies the sales order for which the fulfillment line is created.
-
SourcingRule: string
Value that identifies the sourcing rule that was used.
-
TotalMargin: number
(double)
Total margin for the fulfillment line or availability option.
-
TotalPrice: number
(double)
Total price for the fulfillment line or availability option.
-
TotalProfit: number
(double)
Total profit for the fulfillment line or availability option.
-
TotalValue: number
(double)
Total value for the fulfillment line or availability option.
array
object
-
CarrierCalendar: string
Calendar used by the carrier of material from the ship-from organization to the customer ship-to site.
-
ConfigItem: string
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.
-
Customer: string
Value that identifies the party representing the customer.
-
CustomerSite: string
Value that identifies the party site corresponding to the customer ship-to site.
-
DestinationOrgList: array
DestinationOrgList
Values that represent the attributes of the destination organization.
-
DestinationReceivingCalendar: string
Calendar used for receiving the material at the customer or destination organization in case of an internal order.
-
ErrorCode: string
Abbreviation that identifies the error code, if any, returned by Oracle Global Order Promising Cloud for the service request.
-
ErrorMessage: string
Text of the error message, if any, for the error code.
-
ExpectedArrivalDateTime: string
(date-time)
Date and time when the fulfillment line is expected to be available at the customer ship-to site.
-
ExpectedAvailabilityOnRequestedDate: number
(double)
Quantity of the material that can be promised on the requested date.
-
ExpectedAvailableItem: string
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
(double)
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
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
Value that identifies the suggested drop ship supplier.
-
ExpectedDropShipSupplierSite: string
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
Source application to which the drop ship supplier and supplier belong to.
-
ExpectedMargin: number
(double)
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.
-
ExpectedPickDateTime: string
(date-time)
Date and time when the shipment is expected to be picked for shipping
-
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.
-
ExpectedShipDateTime: string
(date-time)
Date and time when the requested item line is expected to be shipped from the ship-from organization to the customer ship-to site.
-
ExpectedShipFromOrgList: array
ExpectedShipFromOrgList
List that identifies the expected shipping organization to the customer ship-to site for the fulfillment line or availability option.
-
ExpectedShippingCost: number
(double)
Expected shipping cost associated with the fulfillment line or availability option.
-
ExpectedTotalFulfilmentCost: number
(double)
Total expected cost associated with the fulfillment line or availability option.
-
LineFillRate: number
(double)
Percent of quantity that can be promised by the requested date.
-
ParentSplitLineIdentifier: string
Value that uniquely identifies the fulfillment line split. A unique number is generated in case of an order that was split.
-
Party: string
Value that identifies the party representing the customer.
-
PartySite: string
Value that identifies the party site corresponding to the customer ship-to site.
-
PeggingDetailList: array
PeggingDetailList
List that identifies the supply and demand pegging details for a given fulfillment line.
-
Price: number
(double)
Price per unit associated with the availability option.
-
Profit: number
(double)
Projected profit generated by this split line item.
-
PromisingStatus: string
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 does not have a default value.
-
PromisingType: string
Type of promise. This attribute can represent either ship date or arrival date based promising.
-
RequestedDateTime: string
(date-time)
Date and time 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
Value that uniquely identifies the item that is being requested.
-
SplitLineIdentifier: string
Value that uniquely identifies the fulfillment line split. A unique number is generated in case of an order that was split.
-
Value: number
(double)
Value associated with the fulfillment line availability response.
array
array
array
object
-
InstanceNumber: string
Number that identifies the source application from which the order promising service request originated.
-
OrgIdentifier: string
Value that uniquely identifies the organization associated with the item.
object
-
AllocationDetailList: array
AllocationDetailList
Details about the allocation that promising uses. Displays on the allocation header.
-
AtpDetailList: array
AtpDetailList
Values that temporarily link the input objects. Value is populated by the service.
-
BacktoBackFlag: boolean
Contains one of the following values: true or false. If true, then an alternate resources was considered. If false, then an alternate resources was not considered. This attribute does not have a default value.
-
BuyFromDetailList: array
BuyFromDetailList
Values that represent the unique identifier of the department to which the consumed resource belongs to.
-
CtpDetailList: array
CtpDetailList
Values that indicate the date when the resource consumption ends.
-
ItemIdentifier: string
Value that uniquely identifies the requested item.
-
ManufacturingCalendar: string
Calendar that is associated with the manufacturing operations at an organization.
-
OrgInfoList: array
OrgInfoList
Values that identify the resource used to determine the resource availability.
-
ReceivingCalendar: string
Calendar used for receiving the material at the inventory organization or customer ship-to site.
-
ShippingCalendar: string
Calendar used for shipping the material from supplier site to the inventory organization or the customer ship-to site.
-
SupplierInfoList: array
SupplierInfoList
Values that temporarily link the input objects. This value is populated by the service.
-
TransferFromDetailList: array
TransferFromDetailList
Values that represent the unique identifier of the department to which the consumed resource belongs.
array
array
array
array
array
array
array
object
-
AllocationConsumptionWeekStartDate: string
(date-time)
Start of the week when promising consumed the allocation.
-
AllocationNodeId: string
Value that uniquely identifies the allocation node.
-
ConsumedAllocation: number
(double)
Quantity that promising consumed for the allocation.
-
RedeployedFlag: boolean
Contains one of the following values: true or false. if true, then promising can redeploy quantity from allocation node. If false, promising cant redeploy.
object
-
AllocationDetailList: array
AllocationDetailList
Details about the allocation that promising uses. Displays on the allocation header.
-
AllocationRule: string
Value that identifies the allocation rule applicable to the demand class associated with the order.
-
AtpCost: number
(double)
Number that indicates the cost associated with the available-to-promise inventory used for promising the fulfillment line.
-
AtpMode: string
Value that indicates the mode of order promising used to promise the order. Valid values are infinite, lead-time, and supply chain search.
-
AvailableItem: string
Value that uniquely identifies the item that is available.
-
DemandClass: string
Value that identifies the demand class that the order is associated with.
-
LeadTime: number
(double)
Value that indicates the number of days of lead time.
-
PeggedATPType: string
Type of the supply.
-
PeggingDocIdentifier: string
Value that uniquely identifies the supply and demand pegging.
-
Quantity: number
(double)
Quantity of the available item.
-
QuantityUom: string
Unit of measure used for the quantity.
-
RequiredDateTime: string
(date-time)
Date and time when the material is required.
-
RequiredQuantity: number
(double)
Quantity required for promising the fulfillment line.
-
SupplyConsumeMode: string
Value that indicates whether the available-to-promise (ATP) supply came from infinite supply or regular supply. Valid values are true for regular supply and false for infinite supply.
array
object
-
ArrivalDateTime: string
(date-time)
Date and time when the purchased supply will be available at the destination organization.
-
AvailableItem: string
Value that uniquely identifies the item that is available.
-
CarrierCalendar: string
Calendar used by the carrier of material from the ship-from organization to the customer ship-to site.
-
ExpectedCarrier: string
Value that identifies the suggested carrier from the ship-from organization to the customer ship-to site.
-
ExpectedMode: string
Value that identifies the suggested transport mode from the source inventory organization to destination inventory organization.
-
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.
-
PostprocessingLeadTime: number
(double)
Number of days required to make an item available in inventory from the time it received.
-
PreprocessingLeadTime: number
(double)
Number of days required to release a purchase order or create a job from the time the requirement is identified.
-
ProcessingLeadTime: number
(double)
Number of days required to procure or manufacture an item.
-
Quantity: number
(double)
Quantity of the available item.
-
QuantityUom: string
Unit of measure used for the quantity.
-
ShipDateTime: string
(date-time)
Date and time when the supply will be shipped from the supplier site or source organization.
-
ShippingCalendar: string
Calendar used for shipping the material from supplier site to the inventory organization or the customer ship-to site.
-
SupplierIdentifier: string
Value that uniquely identifies the item supplier from whom supply is procured.
-
SupplierSiteIdentifier: string
Value that uniquely identifies the item supplier site from which supply is procured.
object
-
AvailableItem: string
Value that uniquely identifies the item that is available.
-
BomCode: string
Abbreviation that identifies the bill of material used in the capable to promise calculations for the fulfillment line request.
-
ConsumedMaterialList: array
ConsumedMaterialList
Values that identify the material consumed in the manufacturing process.
-
ConsumedResourceList: array
ConsumedResourceList
Values that identify the resource consumed in the manufacturing process.
-
EndDateTime: string
(date-time)
Date and time when manufacturing ends for the item.
-
FixedLeadTime: number
(double)
Number of days of manufacturing lead time that is independent of the order quantity.
-
PostprocessingLeadTime: number
(double)
Number that represents the number of days required to make an item available in inventory from the time it is received.
-
PreprocessingLeadTime: number
(double)
Number that represents the number of days required to procure or manufacture an item.
-
Quantity: number
(double)
Quantity of the available item.
-
QuantityUom: string
Unit of measure used for the quantity.
-
RoutingCode: string
Abbreviation that identifies the routing used in the capable to promise calculations for the fulfillment line request.
-
StartDateTime: string
(date-time)
Date and time when manufacturing is expected to start for the item.
-
VariableLeadTime: number
(double)
Number that indicates the portion of manufacturing lead time that is dependent on order quantity.
array
array
object
-
ConsumptionDateTime: string
(date-time)
Date and time when resource availability information is returned.
-
Cost: number
(double)
Value that indicates the standard cost of component item.
-
ItemIdentifier: string
Value that uniquely identifies the component item.
-
LeadTimeOffset: number
(double)
Number that represents the number of days required to manufacture an item using a critical component or critical resource.
-
OrgIdentifier: string
Value that uniquely identifies the organization associated with the item.
-
PeggingDetailList: array
PeggingDetailList
Values that indicate the supply and demand pegging for a given fulfillment line.
-
Quantity: number
(double)
Quantity of the available item.
-
QuantityUnit: string
Unit of measure used for the quantity.
array
object
-
AlternateResourceFlag: boolean
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.
-
DeptIdentifier: string
Value that uniquely identifies the department or work center to which a resource belongs.
-
EndDateTime: string
(date-time)
Date and time when manufacturing ends for the item.
-
LeadTimeOffset: number
(double)
Number that represents the number of days required to manufacture an item using a critical component or critical resource.
-
OrgIdentifier: string
Value that uniquely identifies the organization associated with the item.
-
Quantity: number
(double)
Quantity of the available item.
-
QuantityUnit: string
Unit of measure used for quantity.
-
ResourceCalendar: string
Calendar of the resource for which the availability is to be determined.
-
ResourceIdentifier: string
Value that uniquely identifies the manufacturing resource.
-
StartDate: string
(date-time)
Date and time when manufacturing is expected to start for the item.
object
-
Supplier: string
Name of the drop ship supplier that ships items directly to the customer.
-
SupplierSite: string
Name of the drop ship supplier site that ships items directly to the customer.
object
-
ArrivalDateTime: string
(date-time)
Date and time when the purchased supply will be available at the destination organization.
-
CarrierCalendar: string
Calendar used by the carrier of material from the ship-from organization to the customer ship-to site.
-
ExpectedCarrier: string
Value that identifies the suggested carrier from the ship-from organization to the customer ship-to site.
-
ExpectedMode: string
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
Value that identifies the suggested service level used for shipping the material from the source inventory organization to destination inventory organization.
-
PeggingDetailList: array
PeggingDetailList
Values that indicate the list of supply and demand pegging for a given fulfillment line.
-
Quantity: number
(double)
Number that indicates the quantity of the available item.
-
QuantityUom: string
Unit of measure used for the quantity.
-
ShipDateTime: string
(date-time)
Date and time when the supply will be shipped from the supplier site or source organization.
-
SourceOrgInfoList: array
SourceOrgInfoList
Values that represent the attributes of the source organization.
-
TransitLeadTime: number
(double)
Number of days required for transporting the requested item from source organization to the destination organization.
array
array
object
-
AlternateAvailabilityOptionsList: array
AlternateAvailabilityOptionsList
Values that indicate the multiple availability options generated by the order promising web services.
-
DefaultAvailabilityOption: object
AvailabilityOption
-
fulillmentLineIdentifier: string
Value that uniquely identifies the request.
-
NumberOfAltOptions: integer
(int32)
Total number of availability options generated for the fulfillment line service request.
array
object
-
FulfillmentLineResultList: array
FulfillmentLineResultList
Values that represent the response attributes of the fulfillment line availability option.
-
OptionRank: integer
(int32)
Number that indicates the rank of the availability option.
-
OptionSummary: string
Summary of how the current set availability option is different from the default availability option.
array
object
-
AlternateAvailabilitySetOptionList: array
AlternateAvailabilitySetOptionList
Values that represent the alternate availability options generated for the fulfillment line request set.
-
DefaultAvailabilitySetOption: object
AvailabilitySetOption
-
NumberOfAltOptions: integer
(int32)
Total number of availability options generated for the fulfillment line service request.
-
SetIdentifier: string
Value that uniquely identifies the fulfillment line set.
array
object
-
FulfillmentLineSetResultList: array
FulfillmentLineSetResultList
Values that contain the response attributes for the fulfillment line set.
-
OptionRank: integer
(int32)
Number that represents the unique identifier for the fulfillment line availability option.
-
OptionSummary: string
Short description of the availability option.
array
object
-
ErrorCode: string
Abbreviation that identifies the error code, if any, returned by Oracle Global Order Promising Cloud for the service request.
-
ErrorMessage: string
Text of the error message, if any, for the error code.
-
ExpectedGroupArrivalDateTime: string
(date-time)
Date and time when the set of fulfillment lines are expected to arrive at the customer ship-to site.
-
ExpectedGroupShipDateTime: string
(date-time)
Date and time when the set of fulfillment lines are expected to be shipped together from the shipping organization.
-
FulfillmentLineModelResultList: array
FulfillmentLineModelResultList
Values that represent the response attributes for the fulfillment line model.
-
FulfillmentLineResultList: array
FulfillmentLineResultList
Values that represent the response attributes for the fulfillment line.
-
SetIdentifier: string
Value that uniquely identifies the fulfillment line set.
array
array
Examples
This example describes how to automatically schedule.
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/json" -d 'request payload' "https://servername/fscmRestApi/resources/version/globalOrderPromises/autoSchedule"
Example 1 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.
{ "CallingModule": "GOP", "CallingInstance": "GOP", "RequestCreationDate": "2020-09-15", "RequestTimeZone": "EST", "ReleaseNumber": "1110900", "UniqueOrderIdentifier": "1234", "FulfillmentLineEntryList":{ "FulfillmentLine":{ "FulfillmentLineIdentifier":"1", "SalesOrderNumber":"SO1", "InstanceNumber": "GOP", "SalesOrderLineNumber": "001", "RequestType": "Order", "RequestedCreationDate": "2020-09-15", "RequestedItem": "RI-HV-GOP-Laptop", "PromisingType": "Ship", "RequestedDateTime": "2020-09-15", "RequestedQuantity": "20", "RequestedQuantityUOM": "Ea", "UnitPrice": "5", "PlanningMultiple": "1", "SubstitutionsAllowedFlag": "true", "SplitsAllowedFlag": "true", "GenerateAltAvailabilityFlag": "true", "AvailabilityBasis": "Delivery", "GeneratePeggingFlag": "true", "IgnoreReservationFlag": "false", "IgnoreDateReservationFlag": "false", "CustomerDetails" : { "Party":"Singapore Distribution Center-GOP", "PartySite":"Customer Location LG1" }, "RequestedShipFromOrg" :{ "OrgIdentifier" : "GOP:HVGOPE01" } } } }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "AutoScheduleOutput": { "PromisingSystem": "NewGop", "PromisingInstance": "GOP", "PromiseDateTime": "2020-09-15T00:00:00.000+0000", "FulfillmentLineEntryResultList": [ { "FulfillmentLineReplyList": [ { "FulillmentLineIdentifier": "1", "NumberOfAltOptions": 0, "DefaultAvailabilityOption": { "OptionRank": 0, "OptionSummary": "0", "FulfillmentLineResultList": [ { "FulfillmentLineIdentifier": "1", "TotalPrice": 100, "TotalProfit": 100, "TotalMargin": 100, "TotalValue": 0, "NumberOfSplits": 0, "NumberOfSubstitutions": 0, "FillRate": 100, "NumberOfAtpItems": 1, "NumberOfCtpItems": 0, "ResultDetailList": [ { "SplitLineIdentifier": "", "PromisingStatus": "", "RequestedDateTime": "2020-09-15T00:00:00.000+0000", "PromisingType": "Ship", "ExpectedArrivalDateTime": "2020-09-16T23:59:59.000+0000", "ExpectedShipDateTime": "2020-09-15T23:59:59.000+0000", "ExpectedPickDateTime": "2020-09-15T23:59:59.000+0000", "RequestedItem": "RI-HV-GOP-Laptop", "ExpectedAvailableItem": "RI-HV-GOP-Laptop", "ExpectedAvailabilityOnRequestedDate": 20, "ExpectedAvailableQuantity": 20, "ExpectedAvailableQuantityUOM": "Ea", "ExpectedDropShipSupplierSourceSystem": "", "ExpectedMode": "Ship_GOP", "ExpectedService": "PorttoPort_GOP", "ExpectedCarrier": "UPS-GOP", "CarrierCalendar": "", "ExpectedDemandClass": "", "ExpectedTotalFulfilmentCost": 0, "ExpectedShippingCost": 0, "LineFillRate": 100, "Party": "Singapore Distribution Center-GOP", "PartySite": "Customer Location LG1", "DestinationReceivingCalendar": "GOP REC 2012-30", "ExpectedShipFromOrgList": [ { "OrgIdentifier": "GOP:HVGOPE01" } ], "PeggingDetailList": [ { "ItemIdentifier": "RI-HV-GOP-Laptop", "ShippingCalendar": "GOP CAL 2012-30", "ReceivingCalendar": "GOP CAL 2012-30", "ManufacturingCalendar": "GOP CAL 2012-30", "BackToBackFlag": false, "AtpDetailList": [ { "Quantity": 20, "QuantityUom": "Ea", "AtpCost": 0, "AtpMode": "3", "LeadTime": 0, "RequiredQuantity": 20, "RequiredDateTime": "2020-09-15T23:59:59.000+0000" } ], "OrgInfoList": [ { "OrgIdentifier": "GOP:HVGOPE01" } ] } ] } ] } ] } } ] } ] } }
Example 2 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.
{ "CallingModule": "GOP", "CallingInstance": "GOP", "RequestCreationDate": "2020-09-15", "RequestTimeZone": "EST", "ReleaseNumber": "1110900", "UniqueOrderIdentifier": "1234", "FulfillmentLineEntryList":{ "FulfillmentLine":{ "FulfillmentLineIdentifier":"1", "SalesOrderNumber":"SO1", "InstanceNumber": "GOP", "SalesOrderLineNumber": "001", "RequestType": "Order", "RequestedCreationDate": "2020-09-15", "RequestedItem": "RI-HV-GOP-Laptop", "PromisingType": "Ship", "RequestedDateTime": "2020-09-15", "RequestedQuantity": "20", "RequestedQuantityUOM": "Ea", "UnitPrice": "5", "PlanningMultiple": "1", "SubstitutionsAllowedFlag": "true", "SplitsAllowedFlag": "true", "GenerateAltAvailabilityFlag": "true", "AvailabilityBasis": "Delivery", "GeneratePeggingFlag": "true", "RequestedCarrier": "UPS-GOP", "RequestedServiceLevel": "PorttoPort_GOP", "RequestedMode": "Ship_GOP", "IgnoreReservationFlag": "false", "IgnoreDateReservationFlag": "false", "CustomerDetails" : { "Party":"Singapore Distribution Center-GOP", "PartySite":"Customer Location LG1" }, "RequestedShipFromOrg" :{ "OrgIdentifier" : "GOP:HVGOPE01" } } } }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "AutoScheduleOutput": { "PromisingSystem": "NewGop", "PromisingInstance": "GOP", "PromiseDateTime": "2020-09-15T00:00:00.000+0000", "FulfillmentLineEntryResultList": [ { "FulfillmentLineReplyList": [ { "FulillmentLineIdentifier": "1", "NumberOfAltOptions": 0, "DefaultAvailabilityOption": { "OptionRank": 0, "OptionSummary": "0", "FulfillmentLineResultList": [ { "FulfillmentLineIdentifier": "1", "TotalPrice": 100, "TotalProfit": 100, "TotalMargin": 100, "TotalValue": 0, "NumberOfSplits": 0, "NumberOfSubstitutions": 0, "FillRate": 100, "NumberOfAtpItems": 1, "NumberOfCtpItems": 0, "ResultDetailList": [ { "SplitLineIdentifier": "", "PromisingStatus": "", "RequestedDateTime": "2020-09-15T00:00:00.000+0000", "PromisingType": "Ship", "ExpectedArrivalDateTime": "2020-09-16T23:59:59.000+0000", "ExpectedShipDateTime": "2020-09-15T23:59:59.000+0000", "ExpectedPickDateTime": "2020-09-15T23:59:59.000+0000", "RequestedItem": "RI-HV-GOP-Laptop", "ExpectedAvailableItem": "RI-HV-GOP-Laptop", "ExpectedAvailabilityOnRequestedDate": 20, "ExpectedAvailableQuantity": 20, "ExpectedAvailableQuantityUOM": "Ea", "ExpectedDropShipSupplierSourceSystem": "", "ExpectedMode": "Ship_GOP", "ExpectedService": "PorttoPort_GOP", "ExpectedCarrier": "UPS-GOP", "CarrierCalendar": "", "ExpectedDemandClass": "", "ExpectedTotalFulfilmentCost": 0, "ExpectedShippingCost": 0, "LineFillRate": 100, "Party": "Singapore Distribution Center-GOP", "PartySite": "Customer Location LG1", "DestinationReceivingCalendar": "GOP REC 2012-30", "ExpectedShipFromOrgList": [ { "OrgIdentifier": "GOP:HVGOPE01" } ], "PeggingDetailList": [ { "ItemIdentifier": "RI-HV-GOP-Laptop", "ShippingCalendar": "GOP CAL 2012-30", "ReceivingCalendar": "GOP CAL 2012-30", "ManufacturingCalendar": "GOP CAL 2012-30", "BackToBackFlag": false, "AtpDetailList": [ { "Quantity": 20, "QuantityUom": "Ea", "AtpCost": 0, "AtpMode": "3", "LeadTime": 0, "RequiredQuantity": 20, "RequiredDateTime": "2020-09-15T23:59:59.000+0000" } ], "OrgInfoList": [ { "OrgIdentifier": "GOP:HVGOPE01" } ] } ] } ] } ] } } ] } ] } }
Example 3 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.
{ "CallingModule": "GOP", "CallingInstance": "GOP", "RequestCreationDate": "2020-09-15", "RequestTimeZone": "EST", "ReleaseNumber": "1110900", "UniqueOrderIdentifier": "1234", "FulfillmentLineEntryList":{ "FulfillmentLine":{ "FulfillmentLineIdentifier":"1", "SalesOrderNumber":"SO1", "InstanceNumber": "GOP", "SalesOrderLineNumber": "001", "RequestType": "Order", "RequestedCreationDate": "2020-09-15", "RequestedItem": "RI-HV-GOP-Laptop", "PromisingType": "Arrival", "RequestedDateTime": "2020-09-15", "RequestedQuantity": "20", "RequestedQuantityUOM": "Ea", "UnitPrice": "5", "PlanningMultiple": "1", "SubstitutionsAllowedFlag": "true", "SplitsAllowedFlag": "true", "GenerateAltAvailabilityFlag": "true", "AvailabilityBasis": "Delivery", "GeneratePeggingFlag": "true", "IgnoreReservationFlag": "false", "IgnoreDateReservationFlag": "false", "CustomerDetails" : { "Party":"Singapore Distribution Center-GOP", "PartySite":"Customer Location LG1" }, "RequestedShipFromOrg" :{ "OrgIdentifier" : "GOP:HVGOPE01" } } } }
Example 3 Response Body
The following example includes the contents of the response body in JSON format:
{ "AutoScheduleOutput": { "PromisingSystem": "NewGop", "PromisingInstance": "GOP", "PromiseDateTime": "2020-09-15T00:00:00.000+0000", "FulfillmentLineEntryResultList": [ { "FulfillmentLineReplyList": [ { "FulillmentLineIdentifier": "1", "NumberOfAltOptions": 0, "DefaultAvailabilityOption": { "OptionRank": 0, "OptionSummary": "0", "FulfillmentLineResultList": [ { "FulfillmentLineIdentifier": "1", "TotalPrice": 100, "TotalProfit": 100, "TotalMargin": 100, "TotalValue": 0, "NumberOfSplits": 0, "NumberOfSubstitutions": 0, "FillRate": 100, "NumberOfAtpItems": 1, "NumberOfCtpItems": 0, "ResultDetailList": [ { "SplitLineIdentifier": "", "PromisingStatus": "", "RequestedDateTime": "2020-09-15T00:00:00.000+0000", "PromisingType": "Arrival", "ExpectedArrivalDateTime": "2020-09-16T23:59:59.000+0000", "ExpectedShipDateTime": "2020-09-15T23:59:59.000+0000", "ExpectedPickDateTime": "2020-09-15T23:59:59.000+0000", "RequestedItem": "RI-HV-GOP-Laptop", "ExpectedAvailableItem": "RI-HV-GOP-Laptop", "ExpectedAvailabilityOnRequestedDate": 0, "ExpectedAvailableQuantity": 20, "ExpectedAvailableQuantityUOM": "Ea", "ExpectedDropShipSupplierSourceSystem": "", "ExpectedMode": "Ship_GOP", "ExpectedService": "PorttoPort_GOP", "ExpectedCarrier": "UPS-GOP", "CarrierCalendar": "", "ExpectedDemandClass": "", "ExpectedTotalFulfilmentCost": 0, "ExpectedShippingCost": 0, "LineFillRate": 100, "Party": "Singapore Distribution Center-GOP", "PartySite": "Customer Location LG1", "DestinationReceivingCalendar": "GOP REC 2012-30", "ExpectedShipFromOrgList": [ { "OrgIdentifier": "GOP:HVGOPE01" } ], "PeggingDetailList": [ { "ItemIdentifier": "RI-HV-GOP-Laptop", "ShippingCalendar": "GOP CAL 2012-30", "ReceivingCalendar": "GOP CAL 2012-30", "ManufacturingCalendar": "GOP CAL 2012-30", "BackToBackFlag": false, "AtpDetailList": [ { "Quantity": 20, "QuantityUom": "Ea", "AtpCost": 0, "AtpMode": "3", "LeadTime": 0, "RequiredQuantity": 20, "RequiredDateTime": "2020-09-15T23:59:59.000+0000" } ], "OrgInfoList": [ { "OrgIdentifier": "GOP:HVGOPE01" } ] } ] } ] } ] } } ] } ] } }
Example 4 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.
{ "CallingModule": "GOP", "CallingInstance": "GOP", "RequestCreationDate": "2020-09-15", "RequestTimeZone": "EST", "ReleaseNumber": "1110900", "UniqueOrderIdentifier": "1234", "FulfillmentLineEntryList":{ "FulfillmentLine":{ "FulfillmentLineIdentifier":"1", "SalesOrderNumber":"SO1", "InstanceNumber": "GOP", "SalesOrderLineNumber": "001", "RequestType": "Order", "RequestedCreationDate": "2020-09-15", "RequestedItem": "RI-HV-GOP-Laptop", "PromisingType": "Arrival", "RequestedDateTime": "2020-09-15", "RequestedQuantity": "20", "RequestedQuantityUOM": "Ea", "UnitPrice": "5", "PlanningMultiple": "1", "SubstitutionsAllowedFlag": "true", "SplitsAllowedFlag": "true", "GenerateAltAvailabilityFlag": "true", "AvailabilityBasis": "Delivery", "GeneratePeggingFlag": "true", "RequestedCarrier": "UPS-GOP", "RequestedServiceLevel": "PorttoPort_GOP", "RequestedMode": "Ship_GOP", "IgnoreReservationFlag": "false", "IgnoreDateReservationFlag": "false", "CustomerDetails" : { "Party":"Singapore Distribution Center-GOP", "PartySite":"Customer Location LG1" }, "RequestedShipFromOrg" :{ "OrgIdentifier" : "GOP:HVGOPE01" } } } }
Example 4 Response Body
The following example includes the contents of the response body in JSON format:
{ "AutoScheduleOutput": { "PromisingSystem": "NewGop", "PromisingInstance": "GOP", "PromiseDateTime": "2020-09-15T00:00:00.000+0000", "FulfillmentLineEntryResultList": [ { "FulfillmentLineReplyList": [ { "FulillmentLineIdentifier": "1", "NumberOfAltOptions": 0, "DefaultAvailabilityOption": { "OptionRank": 0, "OptionSummary": "0", "FulfillmentLineResultList": [ { "FulfillmentLineIdentifier": "1", "TotalPrice": 100, "TotalProfit": 100, "TotalMargin": 100, "TotalValue": 0, "NumberOfSplits": 0, "NumberOfSubstitutions": 0, "FillRate": 100, "NumberOfAtpItems": 1, "NumberOfCtpItems": 0, "ResultDetailList": [ { "SplitLineIdentifier": "", "PromisingStatus": "", "RequestedDateTime": "2020-09-15T00:00:00.000+0000", "PromisingType": "Arrival", "ExpectedArrivalDateTime": "2020-09-16T23:59:59.000+0000", "ExpectedShipDateTime": "2020-09-15T23:59:59.000+0000", "ExpectedPickDateTime": "2020-09-15T23:59:59.000+0000", "RequestedItem": "RI-HV-GOP-Laptop", "ExpectedAvailableItem": "RI-HV-GOP-Laptop", "ExpectedAvailabilityOnRequestedDate": 0, "ExpectedAvailableQuantity": 20, "ExpectedAvailableQuantityUOM": "Ea", "ExpectedDropShipSupplierSourceSystem": "", "ExpectedMode": "Ship_GOP", "ExpectedService": "PorttoPort_GOP", "ExpectedCarrier": "UPS-GOP", "CarrierCalendar": "", "ExpectedDemandClass": "", "ExpectedTotalFulfilmentCost": 0, "ExpectedShippingCost": 0, "LineFillRate": 100, "Party": "Singapore Distribution Center-GOP", "PartySite": "Customer Location LG1", "DestinationReceivingCalendar": "GOP REC 2012-30", "ExpectedShipFromOrgList": [ { "OrgIdentifier": "GOP:HVGOPE01" } ], "PeggingDetailList": [ { "ItemIdentifier": "RI-HV-GOP-Laptop", "ShippingCalendar": "GOP CAL 2012-30", "ReceivingCalendar": "GOP CAL 2012-30", "ManufacturingCalendar": "GOP CAL 2012-30", "BackToBackFlag": false, "AtpDetailList": [ { "Quantity": 20, "QuantityUom": "Ea", "AtpCost": 0, "AtpMode": "3", "LeadTime": 0, "RequiredQuantity": 20, "RequiredDateTime": "2020-09-15T23:59:59.000+0000" } ], "OrgInfoList": [ { "OrgIdentifier": "GOP:HVGOPE01" } ] } ] } ] } ] } } ] } ] } }
Example 5 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.
{ "CallingModule": "GOP", "CallingInstance": "300100110961352", "RequestCreationDate": "2020-09-02", "RequestTimeZone": "EST", "ReleaseNumber": "1110900", "UniqueOrderIdentifier": "1234", "FulfillmentLineEntryList":{ "FulfillmentLine":{ "FulfillmentLineIdentifier":"1", "SalesOrderNumber":"SO1", "InstanceNumber": "GOP", "SalesOrderLineNumber": "001", "RequestType": "Order", "RequestedCreationDate": "2020-09-02", "RequestedItem": "RI-HV-GOP-Laptop", "PromisingType": "Ship", "RequestedDateTime": "2020-09-02", "RequestedQuantity": "110", "RequestedQuantityUOM": "Ea", "UnitPrice": "5", "PlanningMultiple": "1", "SubstitutionsAllowedFlag": "true", "SplitsAllowedFlag": "true", "GenerateAltAvailabilityFlag": "true", "AvailabilityBasis": "Delivery", "GeneratePeggingFlag": "true", "IgnoreReservationFlag": "false", "IgnoreDateReservationFlag": "false", "CustomerDetails" : { "Party":"Singapore Distribution Center-GOP", "PartySite":"Customer Location LG17" }, "RequestedShipFromOrg" :{ "OrgIdentifier" : "GOP:HVGOPE02" } } } }
Example 5 Response Body
The following example includes the contents of the response body in JSON format:
{ "AutoScheduleOutput": { "PromisingSystem": "NewGop", "PromisingInstance": "GOP", "PromiseDateTime": "2020-09-17T00:00:00.000+0000", "FulfillmentLineEntryResultList": [ { "FulfillmentLineReplyList": [ { "FulillmentLineIdentifier": "1", "NumberOfAltOptions": 0, "DefaultAvailabilityOption": { "OptionRank": 0, "OptionSummary": "0", "FulfillmentLineResultList": [ { "FulfillmentLineIdentifier": "1", "TotalPrice": 550, "TotalProfit": 550, "TotalMargin": 100, "TotalValue": 0, "NumberOfSplits": 1, "NumberOfSubstitutions": 0, "FillRate": 100, "NumberOfAtpItems": 0, "NumberOfCtpItems": 0, "ResultDetailList": [ { "SplitLineIdentifier": "", "PromisingStatus": "", "RequestedDateTime": "2020-09-17T00:00:00.000+0000", "PromisingType": "Ship", "ExpectedArrivalDateTime": "2020-09-17T23:59:59.000+0000", "ExpectedShipDateTime": "2020-09-17T23:59:59.000+0000", "ExpectedPickDateTime": "2020-09-17T23:59:59.000+0000", "RequestedItem": "RI-HV-GOP-Laptop", "ExpectedAvailableItem": "RI-HV-GOP-Laptop", "ExpectedAvailabilityOnRequestedDate": 100, "ExpectedAvailableQuantity": 100, "ExpectedAvailableQuantityUOM": "Ea", "ExpectedDropShipSupplierSourceSystem": "", "ExpectedMode": "", "ExpectedService": "", "ExpectedCarrier": "", "CarrierCalendar": "", "ExpectedDemandClass": "", "ExpectedTotalFulfilmentCost": 0, "ExpectedShippingCost": 0, "LineFillRate": 90.91000366210938, "Party": "Singapore Distribution Center-GOP", "PartySite": "Customer Location LG17", "ExpectedShipFromOrgList": [ { "OrgIdentifier": "GOP:HVGOPE02" } ] }, { "SplitLineIdentifier": "1.1600333416292.1", "PromisingStatus": "", "RequestedDateTime": "2020-09-17T00:00:00.000+0000", "PromisingType": "Ship", "ExpectedArrivalDateTime": "2020-09-17T23:59:59.000+0000", "ExpectedShipDateTime": "2020-09-17T23:59:59.000+0000", "ExpectedPickDateTime": "2020-09-17T23:59:59.000+0000", "RequestedItem": "RI-HV-GOP-Laptop", "ExpectedAvailableItem": "RI-HV-GOP-Laptop-S", "ExpectedAvailabilityOnRequestedDate": 10, "ExpectedAvailableQuantity": 10, "ExpectedAvailableQuantityUOM": "Ea", "ExpectedDropShipSupplierSourceSystem": "", "ExpectedMode": "", "ExpectedService": "", "ExpectedCarrier": "", "CarrierCalendar": "", "ExpectedDemandClass": "", "ExpectedTotalFulfilmentCost": 0, "ExpectedShippingCost": 0, "LineFillRate": 9.09000015258789, "Party": "Singapore Distribution Center-GOP", "PartySite": "Customer Location LG17", "ExpectedShipFromOrgList": [ { "OrgIdentifier": "GOP:HVGOPE02" } ] } ] } ] } } ] } ] } }
Example 6 Request Body
{ "CallingModule": "GOP", "CallingInstance": "GOP", "RequestCreationDate": "2022-08-26", "RequestTimeZone": "EST", "ReleaseNumber": "1110900", "UniqueOrderIdentifier": "1234", "FulfillmentLineEntryList": { "FulfillmentLine": { "FulfillmentLineIdentifier": "12345", "SalesOrderNumber": "SO1", "SalesOrderLineNumber": "001", "InstanceNumber": "GPR", "RequestType": "Order", "RequestedItem": "RI-HV-ANALOG-MS2", "PromisingType": "Ship", "RequestedDateTime": "2022-08-26", "RequestedQuantity": "55", "RequestedQuantityUOM": "Ea", "UnitPrice": "5", "PlanningMultiple": "1", "SubstitutionsAllowedFlag": "false", "SplitsAllowedFlag": "false", "GeneratePeggingFlag": "true", "IgnoreReservationFlag": "false", "IgnoreDateReservationFlag": "false", "AllocationNodeFirstLevel":"ALL", "AllocationNodeSecondLevel":"BLM-South", "AllocationNodeThirdLevel":"BLM-South-High Priority", "CustomerDetails": { "Party": "Computer Service and Rentals", "PartySite": "1220" }, "RequestedShipFromOrg": { "OrgIdentifier": "M2" } } } }
Example 6 Response Body
{ "AutoScheduleOutput": { "PromisingSystem": "HVGOP", "PromisingInstance": "GOP", "PromiseDateTime": "2022-08-26T00:00:00.000+0000", "FulfillmentLineEntryResultList": [ { "FulfillmentLineReplyList": [ { "FulillmentLineIdentifier": "12345", "NumberOfAltOptions": 0, "DefaultAvailabilityOption": { "OptionRank": 0, "OptionSummary": "0", "FulfillmentLineResultList": [ { "FulfillmentLineIdentifier": "12345", "TotalPrice": 275, "TotalProfit": 275, "TotalMargin": 100, "TotalValue": 0, "NumberOfSplits": 0, "NumberOfSubstitutions": 0, "FillRate": 100, "NumberOfAtpItems": 1, "NumberOfCtpItems": 0, "ResultDetailList": [ { "SplitLineIdentifier": "", "PromisingStatus": "", "RequestedDateTime": "2022-08-26T00:00:00.000+0000", "PromisingType": "Ship", "ExpectedArrivalDateTime": "2022-08-26T23:59:59.000+0000", "ExpectedShipDateTime": "2022-08-26T23:59:59.000+0000", "ExpectedPickDateTime": "2022-08-26T23:59:59.000+0000", "RequestedItem": "RI-HV-ANALOG-MS2", "ExpectedAvailableItem": "RI-HV-ANALOG-MS2", "ExpectedAvailabilityOnRequestedDate": 55, "ExpectedAvailableQuantity": 55, "ExpectedAvailableQuantityUOM": "Ea", "ExpectedDropShipSupplierSourceSystem": "", "ExpectedMode": "", "ExpectedService": "", "ExpectedCarrier": "", "CarrierCalendar": "", "ExpectedDemandClass": "", "ExpectedTotalFulfilmentCost": 0, "ExpectedShippingCost": 0, "LineFillRate": 100, "Party": "Computer Service and Rentals", "PartySite": "1220", "ExpectedShipFromOrgList": [ { "OrgIdentifier": "M2" } ], "PeggingDetailList": [ { "ItemIdentifier": "RI-HV-ANALOG-MS2", "ShippingCalendar": "APS Calendar", "ReceivingCalendar": "APS Calendar", "ManufacturingCalendar": "APS Calendar", "BackToBackFlag": false, "AtpDetailList": [ { "Quantity": 55, "QuantityUom": "Ea", "AtpCost": 0, "AtpMode": "3", "LeadTime": 0, "RequiredQuantity": 55, "RequiredDateTime": "2022-08-26T23:59:59.000+0000", "AllocationDetailList": [ { "AllocationNodeId": "BLM-South-High Priority", "RedeployedFlag": false, "ConsumedAllocation": 12, "AllocationConsumptionWeekStartDate": "2022-08-22T23:59:59.000+0000" }, { "AllocationNodeId": "BLM-South", "RedeployedFlag": false, "ConsumedAllocation": 23, "AllocationConsumptionWeekStartDate": "2022-08-22T23:59:59.000+0000" }, { "AllocationNodeId": "ALL", "RedeployedFlag": false, "ConsumedAllocation": 10, "AllocationConsumptionWeekStartDate": "2022-08-22T23:59:59.000+0000" }, { "AllocationNodeId": "BLM-Low Priority", "RedeployedFlag": true, "ConsumedAllocation": 7, "AllocationConsumptionWeekStartDate": "2022-08-22T23:59:59.000+0000" }, { "AllocationNodeId": "BLM-SouthEast", "RedeployedFlag": true, "ConsumedAllocation": 3, "AllocationConsumptionWeekStartDate": "2022-08-22T23:59:59.000+0000" } ] } ], "OrgInfoList": [ { "OrgIdentifier": "M2" } ] } ] } ] } ] } } ] } ] } }
Example 7 Request Body
This example illustrates how to prepare your payload for Kit items when you use the feature Temporarily Reserve Supply While Shopping or Quoting.
{ "CallingModule": "CART", "CallingInstance": "CART", "RequestCreationDate": "2022-10-28", "RequestTimeZone": "EST", "ReleaseNumber": "1110900", "UniqueOrderIdentifier": "12345", "FulfillmentLineEntryList": [ { "FulfillmentLineSet": { "SetIdentifier": "KIT1", "SetType": "Ship", "FulfillmentLineList": [ { "FulfillmentLineIdentifier": "KIT1-CAB1", "SalesOrderNumber": "SO1", "SalesOrderLineNumber": "001", "InstanceNumber": "GPR", "RequestType": "Order", "RequestedItem": "HV-CAB1", "PromisingType": "Ship", "RequestedDateTime": "2022-12-10", "RequestedQuantity": "5", "RequestedQuantityUOM": "Ea", "UnitPrice": "5", "PlanningMultiple": "1", "SubstitutionsAllowedFlag": "false", "SplitsAllowedFlag": "false", "GeneratePeggingFlag": "true", "IgnoreReservationFlag": "false", "IgnoreDateReservationFlag": "false", "GenerateAltAvailabilityFlag": "false", "CustomerDetails": { "Party": "Customer A", "PartySite": "1003" }, "RequestedShipFromOrg": { "OrgIdentifier": "M1" } }, { "FulfillmentLineIdentifier": "KIT1-SPK1", "SalesOrderNumber": "SO1", "SalesOrderLineNumber": "002", "InstanceNumber": "GPR", "RequestType": "Order", "RequestedItem": "HV-SPK1", "PromisingType": "ship", "RequestedDateTime": "2022-12-10", "RequestedQuantity": "5", "RequestedQuantityUOM": "Ea", "UnitPrice": "5", "PlanningMultiple": "1", "SubstitutionsAllowedFlag": "false", "SplitsAllowedFlag": "false", "GeneratePeggingFlag": "true", "IgnoreReservationFlag": "false", "IgnoreDateReservationFlag": "false", "GenerateAltAvailabilityFlag": "false", "AllocationNodeFirstLevel": "ALL", "AllocationNodeSecondLevel": "BLM-Rest", "AllocationNodeThirdLevel": "BLM-Online", "CustomerDetails": { "Party": "Customer A", "PartySite": "1003" }, "RequestedShipFromOrg": { "OrgIdentifier": "M1" } }, { "FulfillmentLineIdentifier": "KIT1-SPK2", "SalesOrderNumber": "SO1", "SalesOrderLineNumber": "003", "InstanceNumber": "GPR", "RequestType": "Order", "RequestedItem": "HV-SPK2", "PromisingType": "Ship", "RequestedDateTime": "2022-12-10", "RequestedQuantity": "5", "RequestedQuantityUOM": "Ea", "UnitPrice": "5", "PlanningMultiple": "1", "SubstitutionsAllowedFlag": "false", "SplitsAllowedFlag": "false", "GeneratePeggingFlag": "true", "IgnoreReservationFlag": "false", "IgnoreDateReservationFlag": "false", "GenerateAltAvailabilityFlag": "false", "AllocationNodeFirstLevel": "ALL", "AllocationNodeSecondLevel": "BLM-South", "AllocationNodeThirdLevel": "BLM-South-High Priority", "CustomerDetails": { "Party": "Customer A", "PartySite": "1003" }, "RequestedShipFromOrg": { "OrgIdentifier": "M1" } } ] } } ] }
Example 8 Request Body
This example illustrates how to prepare your payload for standard items when you use the feature Temporarily Reserve Supply While Shopping or Quoting.
{ "CallingModule": "CART", "CallingInstance": "CART", "RequestCreationDate": "2022-10-10", "RequestTimeZone": "EST", "ReleaseNumber": "1110900", "UniqueOrderIdentifier": "12345", "FulfillmentLineEntryList": [ { "FulfillmentLine": { "FulfillmentLineIdentifier": "CART202214001", "SalesOrderNumber": "SO1", "SalesOrderLineNumber": "001", "InstanceNumber": "GPR", "RequestType": "Order", "RequestedItem": "ANALOG-MS2", "PromisingType": "Ship", "RequestedDateTime": "2022-11-08", "RequestedQuantity": "5", "RequestedQuantityUOM": "Ea", "UnitPrice": "5", "PlanningMultiple": "1", "SubstitutionsAllowedFlag": "false", "SplitsAllowedFlag": "true", "GeneratePeggingFlag": "true", "IgnoreReservationFlag": "false", "IgnoreDateReservationFlag": "false", "GenerateAltAvailabilityFlag": "true", "RequestedCarrier": "ABC", "RequestedMode": "AIR", "RequestedServiceLevel": "2DAY", "CustomerDetails": { "Party": "Customer A", "PartySite": "1003" }, "RequestedShipFromOrg": { "OrgIdentifier": "M1" } } } ] }