Get one sales order action request
/fscmRestApi/resources/11.13.18.05/salesOrderActionRequests/{ActionRequestId}
Request
-
ActionRequestId(required): integer(int64)
Unique identifier for the master action request.
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
- application/json
Default Response
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
object-
AccountingRule: string
Maximum Length:
255Indicates the accounting timeframe or timeframes to use when distributing revenue for an invoice line. -
AccountingRuleCode: integer
Abbreviation that identifies the accounting rule.
-
Action: string
Read Only:
trueMaximum Length:255Value attribute for the action such as Submit Order, Cancel Order, Reprice Order, or Cancel Line. -
ActionCode: string
Maximum Length:
30Code such as ORA_FOM_SUBMIT_ORDER to identify the action. -
ActionRequestId: integer
(int64)
Unique identifier for the master action request.
-
ActionRequestTrackingId: integer
(int64)
Identifier to track action requests.
-
AdditionalInformation: string
Maximum Length:
10000Additional details that extensible flexfields store for the sales order. -
BillingTransactionTypeId: integer
Value that identifies the billing type.
-
BillingTransactionTypeName: string
Maximum Length:
255Name of the billing type. -
BillToAccountContactName: string
Maximum Length:
255Contact person at the bill-to customer site. -
BillToAccountContactNumber: string
Maximum Length:
255Telephone number or email id of the contact person at the bill-to customer site. -
BillToAccountNumber: string
Maximum Length:
255Number of the customer account legally responsible for the payment. This account exists when a selling relationship exists between the deploying company and the party. -
BillToAccountSiteUseId: integer
Value that uniquely identifies the account site legally responsible for the payment.
-
BillToAddress1: string
Maximum Length:
255First line of the bill-to customer address. -
BillToAddress2: string
Maximum Length:
255Second line of the bill-to customer address. -
BillToAddress3: string
Maximum Length:
255Third line of the bill-to customer address. -
BillToAddress4: string
Maximum Length:
255Fourth line of the bill-to customer address. -
BillToCity: string
Maximum Length:
255City of the bill-to customer address. -
BillToContactId: integer
Value that uniquely identifies the contact for the billing account.
-
BillToContactPointId: integer
Value that uniquely identifies the email or the phone number of the contact person at the bill-to customer site.
-
BillToCountry: string
Maximum Length:
255Country of the bill-to customer address. -
BillToCounty: string
Maximum Length:
255County of the bill-to customer address. -
BillToCustomerId: integer
Value that uniquely identifies the account legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
-
BillToCustomerName: string
Maximum Length:
255Name of the account legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party. -
BillToPostalCode: string
Maximum Length:
255Postal code of the bill-to customer address. -
BillToProvince: string
Maximum Length:
255Province of the bill-to customer address. -
BillToState: string
Maximum Length:
255State of the bill-to customer address. -
CancelBackordersFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then order lines backordered during picking or shipping are canceled. If false, then backorders aren't canceled. The default value is false. -
CancelReasonCode: string
Code to indicate the reason for the cancelation.
-
Comments: string
Contains user comments for the cancelation.
-
ContractEndDateTime: string
(date-time)
The date and time when the contract will end, based on the contract start date, time, and duration.
-
ContractStartDateTime: string
(date-time)
Date and time when the contract is effective.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the action request. -
CreationDate: string
(date-time)
Read Only:
trueDate on which action request is created. -
CustomerPOLineNumber: string
Maximum Length:
50Value that uniquely identifies the purchase order line. The purchase order line describes the item or service and it includes the price and quantity ordered. -
CustomerPONumber: string
Maximum Length:
50Value that identifies the purchase order. -
DemandClass: string
Maximum Length:
255Demand class that represents a group of customers, such as government, commercial, sales channel, or region. Demand class can represent different sources of demand, such as retail, mail order, or wholesale. A list of accepted values is defined in the lookup type ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
DemandClassCode: string
Maximum Length:
255Abbreviation that identifies the demand class. A list of accepted values is defined in the lookup ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
EarliestAcceptableDate: string
(date-time)
Value that identifies the earliest date the customer either requested to ship or deliver the order.
-
EnforceSingleShipmentFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, during ship confirm the order line quantity that can't be shipped in one shipment is canceled. If false, then backorders with multiple shipments aren't canceled. This attribute can be set to true only if CancelBackordersFlag is also set to true. The default value is false. -
FilterCriteria: string
Contains the filter criterion of the sales orders to be submitted for the Select All action. This criterion is used to get the sales order numbers as specific sales order numbers are not sent by the application.
-
FinalDischargeLocationAddressCity: string
Maximum Length:
255City of the final destination location for the purchase. -
FinalDischargeLocationAddressCountry: string
Maximum Length:
255Country of the final destination location for the purchase. -
FinalDischargeLocationAddressCounty: string
Maximum Length:
255County of the final destination location for the purchase. -
FinalDischargeLocationAddressLine1: string
Maximum Length:
255First line of the final destination location for the purchase. -
FinalDischargeLocationAddressLine2: string
Maximum Length:
255Second line of the final destination location for the purchase. -
FinalDischargeLocationAddressLine3: string
Maximum Length:
255Third line of the final destination location for the purchase. -
FinalDischargeLocationAddressLine4: string
Maximum Length:
255Fourth line of the final destination location for the purchase. -
FinalDischargeLocationAddressPostalCode: string
Maximum Length:
255Postal code of the final destination location for the purchase. -
FinalDischargeLocationAddressProvince: string
Maximum Length:
255Province of the final destination location for the purchase. -
FinalDischargeLocationAddressState: string
Maximum Length:
255State of the final destination location for the purchase. -
FinalDischargeLocationId: integer
Value that identifies the final destination location for the purchase.
-
FOBPoint: string
Maximum Length:
255Freight on board. Identifies the ownership of the item while it is in transit. A list of accepted values is defined in the lookup type ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
FOBPointCode: string
Maximum Length:
30Abbreviation that identifies the freight on board. A list of accepted values is defined in the lookup ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
FreightTerms: string
Maximum Length:
255Terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup type ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
FreightTermsCode: string
Maximum Length:
30Abbreviation that identifies the terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
FulfillLineId: integer
(int64)
Unique identifier for fulfillment line.
-
HeaderId: integer
(int64)
Unique identifier for the sales order header.
-
HoldCode: string
Abbreviation that identifies the hold.
-
IntendedUseClassification: string
Maximum Length:
255Classification name for the intended use of the item for tax calculation. -
IntendedUseClassificationId: integer
Value that uniquely identifies the intended use of the item for tax calculation.
-
InventoryItemId: integer
Value that uniquely identifies the inventory item.
-
InvoicingRule: string
Maximum Length:
255Indicates when to recognize a receivable for an invoice. -
InvoicingRuleCode: integer
Abbreviation that identifies the invoicing rules used to determine when to recognize a receivable for an invoice.
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate on which action request was last updated. -
LatestAcceptableDate: string
(date-time)
Value that identifies the latest date the customer either requested to ship or deliver the order.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MassActionFlag: boolean
Maximum Length:
1Default Value:falseIndicates that the action is a mass action. -
OrderRevisionComments: string
Maximum Length:
255Comments that detail the reason for revising the sales order. -
OrderRevisionReasonCode: string
Maximum Length:
255Abbreviation that identifies the reason to revise the sales order. A list of accepted values is defined in the lookup DOO_CHANGE_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
OutcomeCode: string
Maximum Length:
30Code to indicate the outcome of the master action request. It can be SUCCESS or ERROR. -
OverrideScheduleDateFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the user can manually override the scheduled date. If false, then the user can't override it. The default value is false. -
PackingInstructions: string
Maximum Length:
1000Document that contains packing details for the item. -
PaymentTerms: string
Maximum Length:
255Payment terms to use to collect payment. -
PaymentTermsCode: integer
Abbreviation that identifies payment terms.
-
ProcessId: integer
Read Only:
trueUnique identifier for the process to initiate the process in the request resource. -
ProcessStatus: string
Read Only:
trueMaximum Length:255Status of the process initiated by the action request to process the action such as COMPLETED, IN_QUEUE, IN_PROGRESS, or COMPLETED_WITH_ERRORS. -
ProductFiscalCategory: string
Maximum Length:
255Tax classification of the item that the tax authority uses to tax the item. -
ProductFiscalCategoryId: integer
Value that uniquely identifies the tax classification of the item.
-
ReleaseReasonCode: string
Reason for releasing the hold.
-
RequestedDate: string
(date-time)
Value that identifies the date the customer either requested to ship or deliver the order.
-
RequestedFulfillmentOrganizationCode: string
Maximum Length:
255Abbreviation that identifies the organization that ships the shipment. -
RequestedFulfillmentOrganizationId: integer
Value that uniquely identifies the organization that fulfills the item. If the item is shippable, then this value references the warehouse that ships the item. A contract or an agreement is an example of an item that isn't shippable.
-
RequestedFulfillmentOrganizationName: string
Maximum Length:
255Name of the organization that ships the shipment. -
requests: array
Requests
Title:
RequestsThe request executes the action performed on the sales order. It's a child of the action request. -
RequestType: string
Maximum Length:
255Specifies whether the scheduling request is ship or arrival. -
RequestTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of scheduling request. -
RequireReasonCodeFlag: boolean
Contains one of the following values: true or false. If true, then you must send a reason code. If false, then it's optional for you to send a reason code. The default value is false.
-
ReservationPriority: string
Maximum Length:
255Contains attributes, their sequence, and sorting order for prioritizing reservations across the order lines. -
ReservationPriorityRuleId: integer
Value that uniquely identifies a reservation priority rule.
-
ReservationPriorityRuleName: string
Maximum Length:
255Name of the reservation priority rule used for prioritizing reservations across order lines. -
SalespersonId: integer
Value that identifies the primary salesperson.
-
ScheduleArrivalDate: string
(date-time)
Date when the application scheduled the shipment to arrive.
-
ScheduleShipDate: string
(date-time)
Date when the application scheduled the shipment to ship.
-
ServiceDuration: number
Duration for the coverage item or subscription item on the fulfillment line.
-
ServiceDurationPeriodCode: string
Maximum Length:
10Abbreviation that identifies the unit of measure for the coverage item or subscription item on the fulfillment line. -
ServiceDurationPeriodName: string
Maximum Length:
255Name of the unit of measure for the coverage item or subscription item on the fulfillment line. -
ShipmentPriority: string
Maximum Length:
255Priority of shipment that allows you to group shipments into different categories depending on the urgency. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
ShipmentPriorityCode: string
Maximum Length:
30Abbreviation that identifies the priority of the shipment. A list of accepted values is defined in the lookup WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
ShippingCarrier: string
Maximum Length:
255Value that uniquely identifies the carrier who delivered the item. -
ShippingCarrierId: integer
Value that uniquely identifies the carrier that delivered the item.
-
ShippingInstructions: string
Maximum Length:
1000Detailed instructions about cargo and other requirements for shipping. -
ShippingMode: string
Maximum Length:
255Mode of shipping that delivers the item. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
ShippingModeCode: string
Maximum Length:
255Abbreviation that identifies the mode of shipping that delivers the shipment. A list of accepted values is defined in the lookup WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
ShippingServiceLevel: string
Maximum Length:
255Level of service for the shipping that delivers the shipment. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
ShippingServiceLevelCode: string
Maximum Length:
255Abbreviation that identifies the shipping level of service to use to deliver the shipment. A list of accepted values is defined in the lookup WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
ShipSetName: string
Maximum Length:
50Group of order lines in the sales order that must ship together from one location to one destination, and that use the same scheduled ship date. -
ShipToAddress1: string
Maximum Length:
255First line of the ship-to customer address. -
ShipToAddress2: string
Maximum Length:
255Second line of the ship-to customer address. -
ShipToAddress3: string
Maximum Length:
255Third line of the ship-to customer address. -
ShipToAddress4: string
Maximum Length:
255Fourth line of the ship-to customer address. -
ShipToCity: string
Maximum Length:
255City of the ship-to customer address. -
ShipToContactId: integer
Value that uniquely identifies the contact at the ship-to party site.
-
ShipToContactPointId: integer
Value that uniquely identifies the email or phone number of the contact person at the ship-to party site.
-
ShipToCountry: string
Maximum Length:
255Country of the ship-to customer address. -
ShipToCounty: string
Maximum Length:
255County of the ship-to customer address. -
ShipToPartyContactName: string
Maximum Length:
255Name of the person to contact at the ship-to party site. -
ShipToPartyContactNumber: string
Maximum Length:
255Telephone number or email id of the contact person at the ship-to party site. -
ShipToPartyId: integer
Value that uniquely identifies the ship-to party.
-
ShipToPartyName: string
Maximum Length:
255Name of the ship-to party. -
ShipToPartyNumber: string
Maximum Length:
255Number of the ship-to party. -
ShipToPartySiteId: integer
Value that uniquely identifies the ship-to customer address.
-
ShipToPostalCode: string
Maximum Length:
255Postal code of the ship-to customer address. -
ShipToProvince: string
Maximum Length:
255Province of the ship-to customer address. -
ShipToState: string
Maximum Length:
255State of the ship-to customer address. -
StatusCode: string
Maximum Length:
30Default Value:PRE_PROCESSINGCode to indicate the status of the master action request such as COMPLETE, PRE_PROCESSING, or PROCESSING. -
Subinventory: string
Maximum Length:
255Physical or logical location of the item. -
SubinventoryCode: string
Maximum Length:
255Abbreviation that identifies the physical or logical location of the item. -
SubstituteReasonCode: string
Maximum Length:
255Abbreviation that explains why the application substituted the item on the fulfillment line. -
SubstitutionAllowedFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, the application allows item substitution on the fulfillment line, for reasons such as material shortages or goodwill gestures to the customer. If false, substitution is not allowed. This attribute has no default value. -
SupplierId: integer
Value that uniquely identifies the supplier for the purchase order.
-
SupplierName: string
Maximum Length:
255Name of the supplier who supplies the item. You can use a supplier according to a contractual obligation in drop ship. -
SupplierSiteId: integer
Value that uniquely identifies the supplier site for the purchase order.
-
SupplierSiteName: string
Maximum Length:
255Name of the supplier site for the purchase order. -
TaxClassification: string
Maximum Length:
255Group of taxes for reporting and processing. -
TaxClassificationCode: string
Maximum Length:
30Abbreviation that identifies a group of taxes. -
ThirdPartyTaxRegistration: integer
Value that uniquely identifies the customer registration number.
-
ThirdPartyTaxRegistrationNumber: string
Maximum Length:
255Customer registration number that the customer specifies in the purchase order. -
TotalFailed: integer
Read Only:
trueTotal number of records failed to process by the action request. -
TotalPassed: integer
Read Only:
trueTotal number of records successfully processed by the action request. -
TotalRecords: integer
Read Only:
trueTotal number of records processed by the action request. -
TransactionBusinessCategory: string
Maximum Length:
240Tax classification that the tax authority requires. -
TransactionBusinessCategoryName: string
Maximum Length:
255Name of the tax classification that the tax authority requires. -
TransactionLineTypeCode: string
Maximum Length:
30Type of action in the channel system. For example, buy, replace with, return for credit, upgrade, and so on.
arrayLinksarrayRequestsobject-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object-
ActionCode: string
Maximum Length:
30Code to identify the action. -
ActionRequestId: integer
(int64)
Unique identifier for the child action request.
-
ActionRequestTrackingId: integer
(int64)
Identifier to track action requests in the Requests resource.
-
CarrierId: integer
Value that uniquely identifies the carrier responsible for delivering the item.
-
DemandClassCode: string
Maximum Length:
255Abbreviation that identifies the demand class. A list of accepted values is defined in the lookup ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute in the Setup and Maintenance work area using the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
FlineObjectVersionNumber: integer
(int32)
Value that uniquely identifies the fulfillment line prior to the split.
-
FulfillLineId: integer
(int64)
Unique identifier for the fulfillment line.
-
FulfillOrgId: integer
Value that uniquely identifies the organization fulfilling the item. If the item is shippable, this value references the warehouse responsible for shipping it. A contract or agreement is an example of an item that isn't shippable.
-
HeaderId: integer
(int64)
Unique identifier for the sales order header.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MassActionFlag: boolean
Maximum Length:
1Default Value:falseIndicates that the action is a mass action. -
messageDetails: array
Message Details
Title:
Message DetailsThe Message Details resource fetches the details of the messages logged for the action request. -
orderDetails: array
Order Details
Title:
Order DetailsOrder Details resource fetches the order details of the sales order processed by the request. -
OrderedQuantity: number
Quantity of the item or service on the fulfillment line.
-
orderLineDetails: array
Order Line Details
Title:
Order Line DetailsThe Order Line Details resource fetches the order line details of the sales order processed by the request. -
OutcomeCode: string
Maximum Length:
30Code to indicate the outcome of the child action request. It can be SUCCESS or ERROR. -
RequestStatus: string
Read Only:
trueMaximum Length:255Status of the request submitted for an order or line such as COMPLETED, FAILED, or IN_QUEUE -
ShipClassOfService: string
Maximum Length:
255Level of service for the shipping that delivers the shipment. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
ShipModeOfTransport: string
Maximum Length:
255Mode of shipping that delivers the item. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute in the Setup and Maintenance work area using the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source. -
SplitFromFlineId: integer
(int64)
Value that uniquely identifies the fulfillment line before the split.
-
StatusCode: string
Maximum Length:
30Default Value:PRE_PROCESSINGCode to indicate the status of the child action request such as COMPLETE, PRE_PROCESSING, or PROCESSING. -
SummaryMessageText: string
Read Only:
trueMaximum Length:1000Contains errors, warnings, and information messages for the action request. -
SupplierId: integer
Value that uniquely identifies the supplier for the purchase order.
-
SupplierSiteId: integer
Value that uniquely identifies the supplier site for the purchase order.
arrayLinksarrayMessage DetailsarrayOrder DetailsarrayOrder Line Detailsobject-
ActionRequestId: integer
(int64)
Read Only:
trueUnique identifier for the child action request. -
EntityDisplayNumber: string
Read Only:
trueMaximum Length:255Line number on which message was logged. -
EntityType: string
Read Only:
trueMaximum Length:255Indicates the level at which the message was logged. It can be Order or Line. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time on which message was logged. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageId: integer
(int64)
Read Only:
trueValue that uniquely identifies a message. -
MessageText: string
Read Only:
trueMaximum Length:1000Contains errors, warnings, and information messages for the action request. -
MessageType: string
Read Only:
trueMaximum Length:30Indicates the severity of the message. It can be Error, Warning, or Information.
arrayLinksobject-
BuyingPartyName: string
Read Only:
trueMaximum Length:255Sold-to party name of the customer on the sales order. -
CreationMode: string
Read Only:
trueMaximum Length:30Identifies the interface using which the order was captured such as OrderImport, REST_salesOrdersForOrderHub, REST_omSalesOrders, or UI. -
CustomerPONumber: string
Title:
Purchase OrderRead Only:trueMaximum Length:50Customer purchase order of the sales order processed by the action request. -
HeaderId: integer
(int64)
Read Only:
trueUnique identifier for the sales order header. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrderNumber: string
Title:
Orchestration OrderRead Only:trueMaximum Length:50Default Value:-1Identifier of the sales order number. -
Revision: integer
(int64)
Read Only:
trueValue that identifies the revision number of the order. -
SoldToPartyId: integer
(int64)
Read Only:
trueUnique identifier of the sold-to party on the sales order. -
SourceOrderNumber: string
Title:
Source OrderRead Only:trueMaximum Length:50Unique identifier for the sales order in the source system. -
Status: string
Read Only:
trueMaximum Length:255Status of the sales order. -
StatusCode: string
Read Only:
trueMaximum Length:30Default Value:OPENCode to identify the status of the sales order such as DRAFT, PROCESSING, or CLOSED.
arrayLinksobject-
FulfillLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the fulfillment line. -
HeaderId: integer
(int64)
Read Only:
trueUnique identifier for the sales order header. -
InventoryItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the inventory item. -
Item: string
Read Only:
trueMaximum Length:255Stock keeping unit for the item that the application fulfills. -
ItemDescription: string
Read Only:
trueMaximum Length:255Description of the item that the application fulfills. -
LineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the order line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrderLine: string
Read Only:
trueMaximum Length:255Number that identifies the order line.
arrayLinks- requests
-
Operation: /fscmRestApi/resources/11.13.18.05/salesOrderActionRequests/{ActionRequestId}/child/requestsParameters:
- ActionRequestId:
$request.path.ActionRequestId
The request executes the action performed on the sales order. It's a child of the action request. - ActionRequestId:
Examples
This example describes how to get details of one master action request.
We can see the details of the master action request ID 300100608436027. ActionCode denotes that the request is for the order submission. This master request displays TotalRecords 3, TotalFailed 2 and TotalPassed 1, indicating that it processed 3 child requests out of which 2 failed and one has passed.
StatusCode displays that the process has completed and OutcomeCode denotes that some child action requests may be in ERROR. Based on this the ProcessStatus indicates the status of the master action request is set as COMPLETED WITH ERRORS.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/ActionRequestId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027"
Example Response Body
{
"ActionCode": "ORA_FOM_SUBMIT_ORDER",
"ActionRequestId": 300100608436027,
"ActionRequestTrackingId": 427736,
"CreatedBy": "SCMOPERATIONS",
"CreationDate": "2023-10-20T06:19:28.001+00:00",
"FulfillLineId": null,
"HeaderId": -1,
"LastUpdateDate": "2023-10-20T06:19:28.102+00:00",
"MassActionFlag": true,
"OutcomeCode": "ERROR",
"StatusCode": "COMPLETE",
"Action": "Submit Order",
"ProcessId": 474122,
"TotalRecords": 3,
"TotalFailed": 2,
"TotalPassed": 1,
"ProcessStatus": "COMPLETED_WITH_ERRORS",
"FilterCriteria": null
}