Operations and Attributes You Can Use with the Receive Order Request Service
Get details about operations and attributes you can use with the Receive Order Request Service when you integrate Order Management with other systems.
|
Operation |
Description |
Input Payload |
|---|---|---|
|
ProcessOrderRequest |
Submit a sales order to start a transformation. |
Not applicable |
|
SubmitDraftOrder |
Create a sales order in a draft status, or create and submit a sales order according to the submitFlag in the SDO. |
Not applicable |
|
RequestHold |
Request to put the sales order or fulfillment process on hold. |
RequestHoldProcessRequest |
|
ReleaseHold |
Release a hold that's currently holding a sales order or fulfillment process. |
ReleaseHoldProcessRequest |
|
GetAvailabilityCheck |
Get the supply of an item that's currently available in an organization or supplier. |
GetAvailabilityCheckProcessRequ |
|
ReleasePausedTasks |
Release paused tasks according to a combination of search parameters. |
ReleasePausedEventTaskRequest |
|
CheckAvailability |
Allow an order capture system to get, view, and analyze the availability of a sales order item and the promising options for this item. |
CheckAvailabilityInput |
|
ProcessOrderRequestSync |
Submit a sales order to start transformation. |
Not applicable |
|
SubmitDraftOrderSync |
Create a sales order in a draft status, or create and submit a sales order according to the submitFlag in the SDO. |
Not applicable |
|
GetAvailabilityCheckSync |
Get the supply of an item that's currently available in an organization or supplier. |
GetAvailabilityCheckProcessRequ |
ReleasePausedTasks Operation
The ReleasePausedTasks operation releases paused tasks according to a combination of search parameters. You can use it only as an asynchronous web service. You must include these attributes in a request that uses ReleasePausedTasks.
|
Attribute |
Type |
Required |
Description |
|---|---|---|---|
|
SourceSystem |
String |
Yes |
Source system that provides the release pause request. |
|
EventName |
String |
Yes |
Name of the pause event to release. |
|
InventoryItemId |
Long |
Yes |
Item identifier. |
|
OrderNumber |
String |
Yes |
Sales order number. |
|
LineNumber |
Long |
Yes |
Order line number. |
|
FulfillLineNumber |
Long |
Yes |
Number of the order fulfillment line. |
|
SoldToCustomerId |
Long |
Yes |
Customer identifier. |
|
FulfillOrgId |
Long |
Yes |
Warehouse identifier. |
|
PauseTaskId |
Long |
Yes |
Paused task identifier. |
|
FromOrderDate |
DateTime |
Yes |
Filter sales orders that happen on or after FromOrderDate. |
|
ToOrderDate |
DateTime |
Yes |
Filter sales orders that happen on or before ToOrderDate. |
|
FromScheduledShipDate |
DateTime |
Yes |
Filter sales orders that are scheduled to ship on or after FromScheduledShipDate. |
|
ToScheduledShipDate |
DateTime |
Yes |
Filter sales orders that are scheduled to ship on or before ToScheduledShipDate. |
|
FromPauseWaitUntilDate |
DateTime |
Yes |
Filter pause tasks that are scheduled to release on or after FromPauseWaitUntilDate. |
|
ToPauseWaitUntilDate |
DateTime |
Yes |
Filter pause tasks that are scheduled to release on or before ToPauseWaitUntilDate. |
|
SourceOrderSystem |
String |
Yes |
Source system that provides the source order. |
|
SourceOrderNumber |
String |
Yes |
Order number in the source system. |
|
TaskInstanceId |
Long |
Yes |
Task Instance Identifier. |
ReleasePausedTasks provides this response.
|
Attribute |
Type |
Description |
|---|---|---|
|
NumberOfTasksReleased |
Long |
Number of tasks released. |
|
ErrorMessage |
String |
Error message if the service doesn't complete successfully. |
|
ReturnStatus |
String |
Return status. |
CheckAvailability Operation
The CheckAvailability operation allows your order capture system to get, view, and analyze the availability of a sales order item and the promising options for this item. You can use it only as an asynchronous web service. An asterisk ( * ) in the Required column indicates a group of attributes. You must include at least one attribute from the group.
|
Fully Qualified Name of the Payload Attribute |
Attribute |
Type |
Required |
Description |
|---|---|---|---|---|
|
CheckAvailabilityInput SourceOrderSystem |
SourceOrderSystem |
String |
Yes |
Source system. |
|
CheckAvailabilityInput PromisingSet |
Promising Set |
Group |
No |
Promising set. |
|
CheckAvailabilityInput PromisingLine |
Promising Line |
Group |
No |
List of promising line attributes in the shipment set. Each promising line contains the attributes of the promising line attribute. |
|
CheckAvailabilityInput PromisingModel |
PromisingModel |
Group |
No |
Groups promising lines into a configure-to order (CTO) model. |
|
CheckAvailabilityInput PromisingSet |
Promising Set |
Group |
No |
Groups promising lines into a shipment set. |
|
CheckAvailabilityInput PromisingSet SetName |
SetName |
String |
Conditional |
Name of the shipment set. Required only if you also use promising set. |
|
CheckAvailabilityInput PromisingSet PromisingLine |
Promising Line |
Group |
No |
List of promising line attributes that the shipment set contains. Each promising line contains the attributes of the promising line attribute. |
|
CheckAvailabilityInput PromisingModel |
PromisingModel |
Group |
No |
Groups promising lines into a configure-to order (CTO) model. |
|
CheckAvailabilityInput PromisingModel RootParentFulfillId |
RootParentFulfillId |
String |
Conditional |
Root parent line of the model. Required only if you also use the promising model. |
|
CheckAvailabilityInput PromisingModel ModelType |
ModelType |
String |
Conditional |
Type of model. Valid values include ATO (assemble-to order) or PTO-SMC. Required only if you also use the promising model. |
|
CheckAvailabilityInput PromisingModel IncludedItemsFlag |
IncludedItemsFlag |
Boolean |
No |
Indicates whether to provide items of the pick-to order (PTO) model as input. Valid values include True or False. If False, Order Management determines the items. Default value is True. |
|
CheckAvailabilityInput PromisingModel PromisingLine |
Promising Line |
Group |
No |
List of promising line attributes that the model contains. Each promising line includes the same set of attributes that the promising line attribute contains. |
|
CheckAvailabilityInput PromisingLine |
PromisingLine |
Group |
No |
Groups the list of attributes that you can specify for the check availability service. |
|
CheckAvailabilityInput PromisingLine PromisingLineIdentifier |
PromisingLineIdentifier |
String |
Yes |
Unique identifier for the order line. |
|
CheckAvailabilityInput PromisingLine MasterOrganization |
MasterOrganization |
String |
No |
Not used. |
|
CheckAvailabilityInput PromisingLine InventoryOrganization |
InventoryOrganization |
String |
Yes |
Item validation organization. |
|
CheckAvailabilityInput PromisingLine ProductName |
ProductName |
String |
No |
Not used. |
|
CheckAvailabilityInput PromisingLine RequestedItemId |
RequestedItemId |
String |
Yes |
Requested Item. |
|
CheckAvailabilityInput PromisingLine PromisingType |
PromisingType |
String |
Yes |
Used with the requested date to determine whether its the Requested Ship Date from the warehouse or the Requested Delivery Date for the ship-to address. Valid values include Ship or Arrival. |
|
CheckAvailabilityInput PromisingLine RequestedDate |
RequestedDate |
Date |
Yes |
Date when the item is requested to ship or deliver. |
|
CheckAvailabilityInput PromisingLine RequestedQuantity |
RequestedQuantity |
Double |
Yes |
Requested quantity of the item. |
|
CheckAvailabilityInput PromisingLine RequestedQuantityUOM |
RequestedQuantityUOM |
String |
Yes |
Unit of measure in the item quantity that's requested. |
|
CheckAvailabilityInput PromisingLine DemandClass |
DemandClass |
String |
No |
Demand class of the order line. |
|
CheckAvailabilityInput PromisingLine DeliveryLeadTime |
DeliveryLeadTime |
Double |
No |
Default value for the delivery lead time to use when calculating the ship date or arrival date. This value applies only if you don't specify Carrier, Mode, or Service Level. Used in conjunction with DeliveryCostPerUnit. |
|
CheckAvailabilityInput PromisingLine DeliveryCostPerUnit |
DeliveryCostPerUnit |
Double |
No |
Delivery cost for each unit of the delivered item. This value applies only if you don't specify Carrier, Mode, or Service Level. Used in conjunction with DeliveryLeadTime. |
|
CheckAvailabilityInput PromisingLine UnitPrice |
UnitPrice |
Double |
Yes |
Unit price of the requested item. |
|
CheckAvailabilityInput PromisingLine EarliestAcceptableDate |
EarliestAcceptableDate |
Date |
No |
Don't use this attribute. |
|
CheckAvailabilityInput PromisingLine LatestAcceptableDate |
LatestAcceptableDate |
Date |
No |
Latest date when the item can ship or deliver. |
|
CheckAvailabilityInput PromisingLine RequestedCarrier |
RequestedCarrier |
String |
No |
Carrier to use for the shipment. |
|
CheckAvailabilityInput PromisingLine RequestedServiceLevel |
RequestedServiceLevel |
String |
No |
Level of service of the shipment. |
|
CheckAvailabilityInput PromisingLine RequestedMode |
RequestedMode |
String |
No |
Mode of transport of the shipment. |
|
CheckAvailabilityInput PromisingLine SubstitutionsAllowed |
SubstitutionsAllowed |
Boolean |
Yes |
Determines whether to allow substitutions. Valid values include True or False. |
|
CheckAvailabilityInput PromisingLine SplitsAllowed |
SplitsAllowed |
Boolean |
Yes |
Determines whether the line can split into smaller quantities across dates or source of supply for fulfilling the request. Valid values include True or False. |
|
CheckAvailabilityInput PromisingLine GenerateAlternateAvailability |
GenerateAlternateAvailability |
Boolean |
Yes |
Determines whether to create alternative availability options. Valid values include True or False. |
|
CheckAvailabilityInput PromisingLine AlternateAvailabilityBasis |
AlternateAvailabilityBasis |
String |
No |
Used to sort the alternate options according to fastest delivery or cost. Valid values include Delivery or Cost. Default value is Delivery. |
|
CheckAvailabilityInput PromisingLine GeneratePegging |
GeneratePegging |
Boolean |
Yes |
Determines whether to create pegging. Valid values include True or False. |
|
CheckAvailabilityInput PromisingLine MaxNumberOfAvailabilities |
MaxNumberOfAvailabilities |
Integer |
No |
Maximum number of alternative availability options to provide. |
|
CheckAvailabilityInput PromisingLine MinPromiseQuantity |
MinPromiseQuantity |
Double |
No |
Not used currently. |
|
CheckAvailabilityInput PromisingLine MinPromisePercentage |
MinPromisePercentage |
Integer |
No |
Not used currently. |
|
CheckAvailabilityInput PromisingLine RequestedDropShipSupplier |
RequestedDropShipSupplier |
String |
No |
Supplier selected to fulfill the request. You can specify only one supplier or one warehouse. |
|
CheckAvailabilityInput PromisingLine RequestedDropShipSupplierSite |
RequestedDropShipSupplierSite |
String |
No |
Site of the supplier. You can specify this value only if you also select the supplier. |
|
CheckAvailabilityInput PromisingLine InternalOrderType |
InternalOrderType |
String |
No |
Type of internal order. Valid values include TO or ISO. |
|
CheckAvailabilityInput PromisingLine ParentFulfillId |
ParentFulfillId |
String |
Conditional |
Parent line of the current order line. Used only for configure-to-order (CTO) models. If the Promising Line resides in a promising model, then this attribute is required. |
|
CheckAvailabilityInput PromisingLine ConfiguredItem |
ConfiguredItem |
String |
No |
Configuration item of an assemble-to-order (ATO) model. Used only for configure-to-order (CTO) models. |
|
CheckAvailabilityInput PromisingLine DestinationOrgId |
DestinationOrgId |
String |
No |
Destination organization of an order. |
|
CheckAvailabilityInput PromisingLine RequestedShipFromOrg InstanceId |
InstanceId |
String |
No |
Instance where the warehouse is defined. |
|
CheckAvailabilityInput PromisingLine RequestedShipFromOrg OrgId |
OrgId |
String |
No |
Warehouse (inventory organization) selected to fulfill the request. You can specify only one supplier or one warehouse. |
|
CheckAvailabilityInput PromisingLine MinSplitQuantity |
MinSplitQuantity |
Double |
No |
Minimum quantity that must be available in the first delivery when splitting the order line. |
|
CheckAvailabilityInput PromisingLine MinSplitPercentage |
MinSplitPercentage |
Integer |
No |
Minimum quantity as a percentage of the ordered quantity that must be available in the first delivery when splitting the order line. |
|
CheckAvailabilityInput PromisingLine CustomerAccountId |
CustomerAccountId |
String |
No |
Use Party. Don't use Sold-to customer. |
|
CheckAvailabilityInput PromisingLine CustomerShipTo ShipToSiteId |
ShipToSiteId |
String |
No |
Use ShipTo PartySite. Don't use Ship-to customer Site. |
|
CheckAvailabilityInput PromisingLine CustomerShipTo RequestedRegion |
RequestedRegion |
String |
Yes* |
Region that receives the item. Sold To Party and Ship To Party Site, or RequestedRegion, is required. |
|
CheckAvailabilityInput PromisingLine PartyInfo PartyId |
PartyId |
String |
Yes* |
Sold-to party. If you provide Sold-to Party, then you must also provide Ship-to Party Site. |
|
CheckAvailabilityInput PromisingLine PartyInfo ShipToPartySiteId |
ShipToPartySiteId |
String |
Yes* |
Ship-to party site. Sold To Party and Ship To Party Site, or RequestedRegion, is required. |
CheckAvailability provides this response.
|
Fully Qualified Name of the Payload Attribute |
Attribute |
Type |
Description |
|---|---|---|---|
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply |
PromisingLineSetReply |
Group |
Groups the promising result for promising lines in a shipment set. |
|
checkAvailabilityOutput PromisingResult PromisingModelReply |
PromisingModelReply |
Group |
Groups the promising result for promising lines in a configure-to order (CTO) model. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply |
PromisingLineReply |
Group |
Groups the promising result for a promising line. |
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply |
PromisingLineSetReply |
Group |
Groups the promising result for promising lines in a shipment set. |
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply SetId |
SetId |
String |
Name of the shipment set. |
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply NumberOfAltOptions |
NumberOfAltOptions |
Integer |
Number of alternate availability options. |
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply DefaultAvailabilitySetOption |
PromisingLineSetReply > Default AvailabilitySetOption |
Group |
Groups the default availability option of the promising result for promising lines in a shipment set. |
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply DefaultAvailabilitySetOption PromisingLineSetResult ExpectedGroupShipDate |
ExpectedGroupShipDate |
Date |
Expected date when the shipment set will ship. |
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply DefaultAvailabilitySetOption PromisingLineSetResult ExpectedGroupArrivalDate |
ExpectedGroupArrivalDate |
Date |
Not used. |
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply DefaultAvailabilitySetOption PromisingLineSetResult PromisingLineResult |
PromisingLineResult |
Group |
Promising result for the list of promising line attributes in the shipment set. |
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply AlternateAvailabilitySetOptions |
PromisingLineSetReply AlternateAvailabilitySetOptions |
Group |
Groups the alternate availability options of the promising result for promising lines in a shipment set. |
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply AlternateAvailabilitySetOptions PromisingLineSetResult ExpectedGroupShipDate |
ExpectedGroupShipDate |
Date |
Date when the shipment set is expected to ship. |
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply DefaultAvailabilitySetOption PromisingLineSetResult ExpectedGroupArrivalDate |
ExpectedGroupArrivalDate |
Date |
Not used. |
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply DefaultAvailabilitySetOption PromisingLineSetResult PromisingLineResult |
PromisingLineResult |
Group |
Promising result for the list of promising line attributes in the shipment set. |
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply AlternateAvailabilitySetOptions |
PromisingLineSetReply > AlternateAvailabilitySetOptions |
Group |
Groups the alternate availability options of the promising result for promising lines in a shipment set. |
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply AlternateAvailabilitySetOptions PromisingLineSetResult ExpectedGroupShipDate |
ExpectedGroupShipDate |
Date |
Date when the shipment set is expected to ship. |
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply AlternateAvailabilitySetOptions PromisingLineSetResult ExpectedGroupArrivalDate |
ExpectedGroupArrivalDate |
Date |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineSetReply AlternateAvailabilitySetOptions PromisingLineSetResult PromisingLineResult |
PromisingLineResult |
Group |
Promising result for the list of promising line attributes in the shipment set. |
|
checkAvailabilityOutput PromisingResult PromisingModelReply |
PromisingModelReply |
Group |
Groups the promising result for promising lines in a configure-to order (CTO) model. |
|
checkAvailabilityOutput PromisingResult PromisingModelReply RootParentFulfillId |
RootParentFulfillId |
String |
Root parent of the model. |
|
checkAvailabilityOutput PromisingResult PromisingModelReply NumberOfAltOptions |
NumberOfAltOptions |
Integer |
Number of alternate availability options. |
|
checkAvailabilityOutput PromisingResult PromisingModelReply DefaultAvailabilityModelOption |
PromisingModelReply->DefaultAvailabilityModelOption |
Group |
Groups the default availability option of the promising result for promising lines in a configure-to order (CTO) model. |
|
checkAvailabilityOutput PromisingResult PromisingModelReply DefaultAvailabilityModelOption PromisingLineModelResult RootParentFulfillId |
RootParentFulfillId |
String |
Root parent of the model. |
|
checkAvailabilityOutput PromisingResult PromisingModelReply DefaultAvailabilityModelOption PromisingLineModelResult ErrorCode |
ErrorCode |
String |
Error code to use if an error happens. |
|
checkAvailabilityOutput PromisingResult PromisingModelReply DefaultAvailabilityModelOption PromisingLineModelResult ErrorMessage |
ErrorMessage |
String |
Error message to use if an error happens. |
|
checkAvailabilityOutput PromisingResult PromisingModelReply DefaultAvailabilityModelOption PromisingLineModelResult PromisingLineResult |
PromisingLineResult |
Group |
Promising result for the list of promising line attributes in the configure-to order (CTO) model. |
|
checkAvailabilityOutput PromisingResult PromisingModelReply AlternateAvailabilityModelOptions |
PromisingModelReply->AlternateAvailabilityModelOptions |
Group |
Groups the alternate availability options of the promising result for promising lines in a configure-to order (CTO) model. |
|
checkAvailabilityOutput PromisingResult PromisingModelReply AlternateAvailabilityModelOptions PromisingLineModelResult RootParentFulfillId |
RootParentFulfillId |
String |
Root parent of the model. |
|
checkAvailabilityOutput PromisingResult PromisingModelReply AlternateAvailabilityModelOptions PromisingLineModelResult ErrorCode |
ErrorCode |
String |
Error code to use if an error happens. |
|
checkAvailabilityOutput PromisingResult PromisingModelReply AlternateAvailabilityModelOptions PromisingLineModelResult ErrorMessage |
ErrorMessage |
String |
Error message to use if an error happens. |
|
checkAvailabilityOutput PromisingResult PromisingModelReply AlternateAvailabilityModelOptions PromisingLineModelResult PromisingLineResult |
PromisingLineResult |
Group |
Promising result for the list of promising line attributes in the configure-to order (CTO) model. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply |
PromisingLineReply |
Group |
Groups the promising result for a promising line. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply NumberOfAltOptions |
NumberOfAltOptions |
Integer |
Number of alternate availability options. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption |
PromisingLineReply->DefaultAvailabilityOption |
Group |
Groups the default availability option of the promising result for a promising line. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption OptionRank |
OptionRank |
Integer |
Rank of the availability option. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption OptionSummary |
OptionSummary |
String |
Determines whether the summary of the availability option is available. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult |
PromisingLineResult |
Group |
Groups the alternate availability options of the promising result for a promising line. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult PromisingLineIdentifier |
PromisingLineIdentifier |
String |
Line identifier. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult TotalPrice |
TotalPrice |
Double |
Total price of the availability option. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult TotalProfit |
TotalProfit |
Double |
Total profit when using the availability option. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult TotalMargin |
TotalMargin |
Double |
Total margin when using the availability. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult TotalValue |
TotalValue |
Double |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult NumberOfSplits |
NumberOfSplits |
Integer |
Number of split shipments that the availability option recommends. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult NumberOfSubstitutions |
NumberOfSubstitutions |
Integer |
Number of item substitutions that the availability option recommends. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult FillRate |
FillRate |
Double |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult NumberOfAtpItems |
NumberOfAtpItems |
Integer |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult NumberOfCtpItems |
NumberOfCtpItems |
Integer |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult SourcingRule |
SourcingRule |
String |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail CustomerAccountId |
CustomerAccountId |
String |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail CustomerShipToSiteId |
CustomerShipToSiteId |
String |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail RequestedRegion |
RequestedRegion |
String |
Region that requested the shipment. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail PartyId |
PartyId |
String |
Sold-to party of the customer. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ShipToPartySiteId |
ShipToPartySiteId |
String |
Ship-to party site of the customer. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail InternalSalesOrderDestOrg InstanceId |
InstanceId |
String |
Instance where the warehouse is defined. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail InternalSalesOrderDestOrg OrgId |
OrgId |
String |
Warehouse that supplies the item that will ship. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail PromisingStatus |
PromisingStatus |
String |
Determines whether the request is met completely or not completely. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail RequestedDate |
RequestedDate |
Date |
Date when the item is requested to ship or deliver. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail PromisingType |
PromisingType |
String |
Determines whether to set the requested date to the Requested Ship Date from the warehouse, or to the Requested Delivery Date to the ship-to address. Valid Values include Ship or Arrival. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedArrivalDate |
ExpectedArrivalDate |
Date |
Expected date to deliver the item to the customer address. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedShipDate |
ExpectedShipDate |
Date |
Expected date to ship the item from the warehouse or the supplier. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedPickDate |
ExpectedPickDate |
Date |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail RequestedItemId |
RequestedItemId |
String |
Item requested. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedAvailableItem |
ExpectedAvailableItem |
String |
Expected item to ship. If an item substitution happens, then this attribute references the item substitution instead of the requested item. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedAvailabilityOnRequestedDate |
ExpectedAvailabilityOnRequestedDate |
Double |
Expected item availability on the request date. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedAvailableQuantity |
ExpectedAvailableQuantity |
Double |
Expected item quantity that's available through the availability option. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedAvailableQuantityUOM |
ExpectedAvailableQuantityUOM |
String |
Unit of Measure of the Expected Available Quantity. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedDropShipSupplier |
ExpectedDropShipSupplier |
String |
Supplier that the availability option recommends to supply the item that ships. The availability option recommends only one warehouse or one supplier at one point in time. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedDropShipSupplierSite |
ExpectedDropShipSupplierSite |
String |
Site of the supplier that the availability option recommends to ship the item. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedMode |
ExpectedMode |
String |
Mode of transport that the availability option recommends for the shipment. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedService |
ExpectedService |
String |
Level of service that the availability option recommends for the shipment. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedCarrier |
ExpectedCarrier |
String |
Carrier who ships the item. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail CarrierCalendar |
CarrierCalendar |
String |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedDemandClass |
ExpectedDemandClass |
String |
Demand class. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedTotalFulfilmentCost |
ExpectedTotalFulfilmentCost |
Double |
Expected total fulfillment cost. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedShippingCost |
ExpectedShippingCost |
Double |
Expected shipping cost. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedMargin |
ExpectedMargin |
Double |
Expected margin. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail Price |
Price |
Double |
Unit price of the item. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail Profit |
Profit |
Double |
Profit projected. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail Value |
Value |
Double |
Value projected. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail LineFillRate |
LineFillRate |
Double |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ErrorCode |
ErrorCode |
String |
Error code to use if an error happens. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ErrorMessage |
ErrorMessage |
String |
Error message to use if an error happens. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply DefaultAvailabilityOption PromisingLineResult ResultDetail ExpectedShipFromOrg |
ExpectedShipFromOrg |
String |
Warehouse that the availability option recommends to ship the item. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions |
PromisingLineReply->AlternateAvailabilityOptions |
Group |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions OptionRank |
OptionRank |
Integer |
Rank of the availability option. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions OptionSummary |
OptionSummary |
String |
Determines whether the summary of the availability option is available. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult` |
PromisingLineResult |
Group |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult PromisingLineIdentifier |
PromisingLineIdentifier |
String |
Line identifier. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult TotalPrice |
TotalPrice |
Double |
Total price of the availability option. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult TotalProfit |
TotalProfit |
Double |
Total profit when using the availability option. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult TotalMargin |
TotalMargin |
Double |
Total margin when using the availability. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult TotalValue |
TotalValue |
Double |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult NumberOfSplits |
NumberOfSplits |
Integer |
Number of split shipments that the availability option recommends. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult NumberOfSubstitutions |
NumberOfSubstitutions |
Integer |
Number of item substitutions that the availability option recommends. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult FillRate |
FillRate |
Double |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult NumberOfAtpItems |
NumberOfAtpItems |
Integer |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult NumberOfCtpItems |
NumberOfCtpItems |
Integer |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult SourcingRule |
SourcingRule |
String |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail CustomerAccountId |
CustomerAccountId |
String |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail CustomerShipToSiteId |
CustomerShipToSiteId |
String |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail RequestedRegion |
RequestedRegion |
String |
Region that requested the shipment. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail PartyId |
PartyId |
String |
Sold-to party of the customer. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ShipToPartySiteId |
ShipToPartySiteId |
String |
Ship-to party site of the customer. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail InternalSalesOrderDestOrg InstanceId |
InstanceId |
String |
Instance where the warehouse is defined. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail InternalSalesOrderDestOrg OrgId |
OrgId |
String |
Warehouse that supplies the item that will ship. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail PromisingStatus |
PromisingStatus |
String |
Determines whether the request is met completely or not completely. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail RequestedDate |
RequestedDate |
Date |
Date when the item is requested to ship or deliver. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail PromisingType |
PromisingType |
String |
Determines whether to set the requested date to the Requested Ship Date from the warehouse, or to the Requested Delivery Date to the ship-to address. Valid Values include Ship or Arrival. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedArrivalDate |
ExpectedArrivalDate |
Date |
Expected date to deliver the item to the customer address. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedShipDate |
ExpectedShipDate |
Date |
Expected date to ship the item from the warehouse or the supplier. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedPickDate |
ExpectedPickDate |
Date |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail RequestedItemId |
RequestedItemId |
String |
Item requested. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedAvailableItem |
ExpectedAvailableItem |
String |
Expected item to ship. If an item substitution happens, then this attribute references the item substitution instead of the requested item. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedAvailabilityOnRequestedDate |
ExpectedAvailabilityOnRequestedDate |
Double |
Expected item availability on the request date. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedAvailableQuantity |
ExpectedAvailableQuantity |
Double |
Expected item quantity that's available through the availability option. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedAvailableQuantityUOM |
ExpectedAvailableQuantityUOM |
String |
Unit of Measure of the Expected Available Quantity. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedDropShipSupplier |
ExpectedDropShipSupplier |
String |
Supplier that the availability option recommends to supply the item that ships. The availability option recommends only one warehouse or one supplier at one point in time. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedDropShipSupplierSite |
ExpectedDropShipSupplierSite |
String |
Site of the supplier that the availability option recommends to ship the item. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedMode |
ExpectedMode |
String |
Mode of transport that the availability option recommends for the shipment. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedService |
ExpectedService |
String |
Level of service that the availability option recommends for the shipment. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedCarrier |
ExpectedCarrier |
String |
Carrier who ships the item. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail CarrierCalendar |
CarrierCalendar |
String |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedDemandClass |
ExpectedDemandClass |
String |
Demand class. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedTotalFulfilmentCost |
ExpectedTotalFulfilmentCost |
Double |
Expected total fulfillment cost. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedShippingCost |
ExpectedShippingCost |
Double |
Expected shipping cost. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedMargin |
ExpectedMargin |
Double |
Expected margin. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail Price |
Price |
Double |
Unit price of the item. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail Profit |
Profit |
Double |
Projected profit. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail Value |
Value |
Double |
Projected value. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail LineFillRate |
LineFillRate |
Double |
Not applicable |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ErrorCode |
ErrorCode |
String |
Error code to use if an error happens. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ErrorMessage |
ErrorMessage |
String |
Error message to use if an error happens. |
|
checkAvailabilityOutput PromisingResult PromisingLineReply AlternateAvailabilityOptions PromisingLineResult ResultDetail ExpectedShipFromOrg |
ExpectedShipFromOrg |
String |
Warehouse that the availability option recommends to ship the item. |
GetAvailabilityCheck and GetAvailabilityCheckSync Operations
The GetAvailabilityCheck operation and the GetAvailabilityCheckSync operation gets the supply of an item that's currently available in an organization or supplier. You can use them as a synchronous or asynchronous web service. You must include these required attributes in a request that uses GetAvailabilityCheck or GetAvailabilityCheckSync.
|
Attribute |
Type |
Required |
Description |
|---|---|---|---|
|
SourceOrderSystem |
String |
Yes |
Source order system. |
|
MasterOrganization |
String |
Yes |
Item validation organization. |
|
BusinessUnit |
String |
Yes |
Business unit. |
|
ItemEntry |
Group |
No |
One or more repetitions. |
|
ItemEntry |
Group |
No |
One or more repetitions. |
|
ItemId |
String |
Yes |
Item to reference when determining supply availability. |
|
RequestedDate |
Date |
Yes |
Date when the supply availability is requested. |
|
DestinationOrgId |
String |
No |
Destination organization of a sales order. |
|
SupplierId |
String |
No |
Supplier to reference when determining supply availability. |
|
SupplierSiteId |
String |
No |
Supplier site to reference when determining supply availability. You can specify the supplier site only if you also specify the supplier. |
|
OrgInput |
Group |
No |
Zero or more repetitions. |
|
OrgInput |
Not applicable |
No |
Group that captures the warehouse. |
|
OrgId |
String |
No |
Warehouse (inventory organization) that requires the availability of the supply for the item. |
GetAvailabilityCheck or GetAvailabilityCheckSync provides this response.
|
Attribute |
Type |
Description |
|---|---|---|
|
ErrorMessage |
String |
Error message that displays if a problem happens in the data or in the setup. |
|
InvalidItems |
Group |
One or more repetitions. |
|
PromisingSystem |
String |
Name of the promising system. |
|
PromisingInstance |
String |
Instance of the promising system. |
|
PromiseDate |
Date |
Date when the promise is created. |
|
ItemAvailability |
Group |
One or more repetitions. |
|
InvalidItems |
Group |
Group that identifies invalid items. |
|
ItemId |
String |
Item identifier. |
|
ItemAvailability |
Group |
Group that includes availability details for one item. |
|
ItemId |
String |
Identifies the item that this operation references when it determines how much supply is available to fulfill this item. |
|
RequestedDate |
Date |
Date when supply availability is requested. |
|
ErrorCode |
String |
Error code. |
|
ErrorMessage |
String |
Error message that displays if a problem happens in the data or in the setup. |
|
InstanceId |
String |
Instance identifier. |
|
OrgId |
String |
Warehouse (inventory organization) that stores the item. If the request doesn't include a warehouse or supplier, then this operation calculates the supply availability for all warehouses and suppliers. |
|
ShelfQty |
Double |
Total supply that's available for the item. Its the cumulative supply minus the cumulative supply that's consumed. |
|
AvailableQty |
Double |
Total supply that's available for the item and that's not allocated to demand. Its the cumulative supply minus the cumulative demand. |
RequestHold Operation
The RequestHold operation put the sales order or fulfillment process on hold. You can use it only as an asynchronous web service. You must include these required attributes in a request that uses RequestHold.
|
Fully Qualified Name of the Payload Attribute |
Attribute |
Type |
Required |
Description |
|---|---|---|---|---|
|
RequestHoldProcessRequest ApplyHoldRequestParams |
ApplyHoldRequestParams |
Group |
No |
One or more repetitions. |
|
RequestHoldProcessRequest ApplyHoldRequestParams |
ApplyHoldRequestParams |
Group |
No |
Not applicable |
|
RequestHoldProcessRequest ApplyHoldRequestParams SourceOrderSystem |
SourceOrderSystem |
string |
Yes |
Source system that provides the source order. |
|
RequestHoldProcessRequest ApplyHoldRequestParams SourceOrderId |
SourceOrderId |
string |
Yes |
Identifier of the source order in the source system. |
|
RequestHoldProcessRequest ApplyHoldRequestParams SourceLineId |
SourceLineId |
string |
No |
Order line identifier in the source system. |
|
RequestHoldProcessRequest ApplyHoldRequestParams SourceHoldCode |
SourceHoldCode |
string |
Yes |
Hold code that's requested. |
|
RequestHoldProcessRequest ApplyHoldRequestParams HoldComments |
HoldComments |
string |
No |
Comments for the hold request. |
RequestHold provides this response.
|
Fully Qualified Name of the Payload Attribute |
Attribute |
Type |
Description |
|---|---|---|---|
|
RequestHoldProcessResponse ErrorMessage |
ErrorMessage |
String |
Error message for the call. |
|
RequestHoldProcessResponse ApplyHoldResponseParams |
ApplyHoldResponseParams |
Group |
One or more repetitions. |
|
RequestHoldProcessResponse ApplyHoldResponseParams |
ApplyHoldResponseParams |
Group |
Group that contains the results of the requestHold operation. |
|
RequestHoldProcessResponse ApplyHoldResponseParams SourceOrderSystem |
SourceOrderSystem |
String |
Source system that provides the source order. |
|
RequestHoldProcessResponse ApplyHoldResponseParams SourceOrderId |
SourceOrderId |
String |
Order identifier in the source system. |
|
RequestHoldProcessResponse ApplyHoldResponseParams SourceLineId |
SourceLineId |
String |
Order line identifier in the source system. |
|
RequestHoldProcessResponse ApplyHoldResponseParams SourceHoldCode |
SourceHoldCode |
String |
Hold code that was requested. |
|
RequestHoldProcessResponse ApplyHoldResponseParams RequestStatus |
RequestStatus |
String |
Status of the call. |
|
RequestHoldProcessResponse ApplyHoldResponseParams HoldErrorMessages |
HoldErrorMessages |
Group |
Zero or more repetitions. |
|
RequestHoldProcessResponse ApplyHoldResponseParams HoldErrorMessages |
HoldErrorMessages |
Group |
Group that contains the order line Id and the error message for this line Id record. |
|
RequestHoldProcessResponse ApplyHoldResponseParams HoldErrorMessages DooLineId |
DooLineId |
String |
Order line identifier in Order Management. |
|
RequestHoldProcessResponse ApplyHoldResponseParams HoldErrorMessages ErrorMessage |
ErrorMessage |
String |
Error message for each line. |
ReleaseHold Operation
The ReleaseHold operation releases a hold that's currently holding a sales order or fulfillment process. You can use it only as an asynchronous web service. You must include these required attributes in a request that uses ReleaseHold.
|
Fully Qualified Name of the Payload Attribute |
Attribute |
Type |
Required |
Description |
|---|---|---|---|---|
|
ReleaseHoldProcessRequest ReleaseHoldRequestParams |
ReleaseHoldRequestParams |
Group |
No |
One or more repetitions. |
|
ReleaseHoldProcessRequest ReleaseHoldRequestParams |
ReleaseHoldRequestParams |
Group |
No |
Groups the request details for the release hold. |
|
ReleaseHoldProcessRequest ReleaseHoldRequestParams SourceOrderSystem |
SourceOrderSystem |
String |
Yes |
Source system that provides the source order. |
|
ReleaseHoldProcessRequest ReleaseHoldRequestParams SourceOrderId |
SourceOrderId |
String |
Yes |
Order identifier in the source system. |
|
ReleaseHoldProcessRequest ReleaseHoldRequestParams SourceLineId |
SourceLineId |
String |
No |
Order line identifier in the source system. |
|
ReleaseHoldProcessRequest ReleaseHoldRequestParams SourceHoldCode |
SourceHoldCode |
String |
Yes |
Hold code to release. |
|
ReleaseHoldProcessRequest ReleaseHoldRequestParams HoldReleaseReasonCode |
HoldReleaseReasonCode |
String |
Yes |
Reason code for the release of the hold. |
|
ReleaseHoldProcessRequest ReleaseHoldRequestParams HoldReleaseComments |
HoldReleaseComments |
String |
No |
Comments that describe the release reason. |
ReleaseHold provides this response.
|
Fully Qualified Name of the Payload Attribute |
Attribute |
Type |
Description |
|---|---|---|---|
|
ReleaseHoldProcessResponse ErrorMessage |
ErrorMessage |
String |
Error message for the call. |
|
ReleaseHoldProcessResponse ReleaseHoldResponseParams |
ReleaseHoldResponseParams |
Group |
One or more repetitions. |
|
ReleaseHoldProcessResponse ReleaseHoldResponseParams |
ReleaseHoldResponseParams |
Group |
One or more repetitions. |
|
ReleaseHoldProcessResponse ReleaseHoldResponseParams SourceOrderSystem |
SourceOrderSystem |
String |
Source system that provides the source order. |
|
ReleaseHoldProcessResponse ReleaseHoldResponseParams SourceOrderId |
SourceOrderId |
String |
Order identifier in the source system. |
|
ReleaseHoldProcessResponse ReleaseHoldResponseParams SourceHoldCode |
SourceHoldCode |
String |
Hold code that was released. |
|
ReleaseHoldProcessResponse ReleaseHoldResponseParams SourceLineId |
SourceLineId |
String |
Order line identifier in the source system. |
|
ReleaseHoldProcessResponse ReleaseHoldResponseParams HoldReleaseStatus |
HoldReleaseStatus |
String |
Status of the call. |
|
ReleaseHoldProcessResponse ReleaseHoldResponseParams HoldReleaseDate |
HoldReleaseDate |
String |
Date when the hold was released. |
|
ReleaseHoldProcessResponse ReleaseHoldResponseParams HoldErrorMessages |
HoldErrorMessages |
Group |
Zero or more repetitions. |
|
ReleaseHoldProcessResponse ReleaseHoldResponseParams HoldErrorMessages |
HoldErrorMessages |
Group |
Group that contains the order line Id and error message for this line Id record. |
|
ReleaseHoldProcessResponse ReleaseHoldResponseParams HoldErrorMessages DooLineId |
DooLineId |
String |
Order line identifier in Order Management. |
|
ReleaseHoldProcessResponse ReleaseHoldResponseParams HoldErrorMessages ErrorMessage |
ErrorMessage |
String |
Error message for each order line. |