Create one request
post
/fscmRestApi/resources/11.13.18.05/salesOrderActionRequests/{ActionRequestId}/child/requests
Request
Path Parameters
-
ActionRequestId(required): integer(int64)
Unique identifier for the master action request.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActionCode(required): string
Maximum Length:
30
Code to identify the action. -
ActionRequestId: integer
(int64)
Unique identifier for the child action request.
-
ActionRequestTrackingId(required): integer
(int64)
Identifier to track action requests in the Requests resource.
-
FulfillLineId: integer
(int64)
Unique identifier for the fulfillment line.
-
HeaderId(required): integer
(int64)
Unique identifier for the sales order header.
-
MassActionFlag: boolean
Maximum Length:
1
Default Value:false
Indicates that the action is a mass action. -
messageDetails: array
Message Details
Title:
Message Details
The Message Details resource fetches the details of the messages logged for the action request. -
orderDetails: array
Order Details
Title:
Order Details
Order Details resource fetches the order details of the sales order processed by the request. -
orderLineDetails: array
Order Line Details
Title:
Order Line Details
The Order Line Details resource fetches the order line details of the sales order processed by the request. -
OutcomeCode: string
Maximum Length:
30
Code to indicate the outcome of the child action request. It can be SUCCESS or ERROR. -
StatusCode: string
Maximum Length:
30
Default Value:PRE_PROCESSING
Code to indicate the status of the child action request such as COMPLETE, PRE_PROCESSING, or PROCESSING.
Nested Schema : Message Details
Type:
array
Title:
Message Details
The Message Details resource fetches the details of the messages logged for the action request.
Show Source
Nested Schema : Order Details
Type:
array
Title:
Order Details
Order Details resource fetches the order details of the sales order processed by the request.
Show Source
Nested Schema : Order Line Details
Type:
array
Title:
Order Line Details
The Order Line Details resource fetches the order line details of the sales order processed by the request.
Show Source
Nested Schema : salesOrderActionRequests-requests-messageDetails-item-post-request
Type:
Show Source
object
Nested Schema : salesOrderActionRequests-requests-orderDetails-item-post-request
Type:
Show Source
object
Nested Schema : salesOrderActionRequests-requests-orderLineDetails-item-post-request
Type:
Show Source
object
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : salesOrderActionRequests-requests-item-response
Type:
Show Source
object
-
ActionCode: string
Maximum Length:
30
Code 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.
-
FulfillLineId: integer
(int64)
Unique identifier for the fulfillment line.
-
HeaderId: integer
(int64)
Unique identifier for the sales order header.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Maximum Length:
1
Default Value:false
Indicates that the action is a mass action. -
messageDetails: array
Message Details
Title:
Message Details
The Message Details resource fetches the details of the messages logged for the action request. -
orderDetails: array
Order Details
Title:
Order Details
Order Details resource fetches the order details of the sales order processed by the request. -
orderLineDetails: array
Order Line Details
Title:
Order Line Details
The Order Line Details resource fetches the order line details of the sales order processed by the request. -
OutcomeCode: string
Maximum Length:
30
Code to indicate the outcome of the child action request. It can be SUCCESS or ERROR. -
RequestStatus: string
Read Only:
true
Maximum Length:255
Status of the request submitted for an order or line such as COMPLETED, FAILED, or IN_QUEUE -
StatusCode: string
Maximum Length:
30
Default Value:PRE_PROCESSING
Code to indicate the status of the child action request such as COMPLETE, PRE_PROCESSING, or PROCESSING. -
SummaryMessageText: string
Read Only:
true
Maximum Length:1000
Contains errors, warnings, and information messages for the action request.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Message Details
Type:
array
Title:
Message Details
The Message Details resource fetches the details of the messages logged for the action request.
Show Source
Nested Schema : Order Details
Type:
array
Title:
Order Details
Order Details resource fetches the order details of the sales order processed by the request.
Show Source
Nested Schema : Order Line Details
Type:
array
Title:
Order Line Details
The Order Line Details resource fetches the order line details of the sales order processed by the request.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : salesOrderActionRequests-requests-messageDetails-item-response
Type:
Show Source
object
-
ActionRequestId: integer
(int64)
Read Only:
true
Unique identifier for the child action request. -
EntityDisplayNumber: string
Read Only:
true
Maximum Length:255
Line number on which message was logged. -
EntityType: string
Read Only:
true
Maximum Length:255
Indicates the level at which the message was logged. It can be Order or Line. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time on which message was logged. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageId: integer
(int64)
Read Only:
true
Value that uniquely identifies a message. -
MessageText: string
Read Only:
true
Maximum Length:1000
Contains errors, warnings, and information messages for the action request. -
MessageType: string
Read Only:
true
Maximum Length:30
Indicates the severity of the message. It can be Error, Warning, or Information.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesOrderActionRequests-requests-orderDetails-item-response
Type:
Show Source
object
-
BuyingPartyName: string
Read Only:
true
Maximum Length:255
Sold-to party name of the customer on the sales order. -
CreationMode: string
Read Only:
true
Maximum Length:30
Identifies the interface using which the order was captured such as OrderImport, REST_salesOrdersForOrderHub, REST_omSalesOrders, or UI. -
CustomerPONumber: string
Title:
Purchase Order
Read Only:true
Maximum Length:50
Customer purchase order of the sales order processed by the action request. -
HeaderId: integer
(int64)
Read Only:
true
Unique identifier for the sales order header. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: string
Title:
Orchestration Order
Read Only:true
Maximum Length:50
Default Value:-1
Identifier of the sales order number. -
Revision: integer
(int64)
Read Only:
true
Value that identifies the revision number of the order. -
SoldToPartyId: integer
(int64)
Read Only:
true
Unique identifier of the sold-to party on the sales order. -
SourceOrderNumber: string
Title:
Source Order
Read Only:true
Maximum Length:50
Unique identifier for the sales order in the source system. -
Status: string
Read Only:
true
Maximum Length:255
Status of the sales order. -
StatusCode: string
Read Only:
true
Maximum Length:30
Default Value:OPEN
Code to identify the status of the sales order such as DRAFT, PROCESSING, or CLOSED.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesOrderActionRequests-requests-orderLineDetails-item-response
Type:
Show Source
object
-
FulfillLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the fulfillment line. -
HeaderId: integer
(int64)
Read Only:
true
Unique identifier for the sales order header. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory item. -
Item: string
Read Only:
true
Maximum Length:255
Stock keeping unit for the item that the application fulfills. -
ItemDescription: string
Read Only:
true
Maximum Length:255
Description of the item that the application fulfills. -
LineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the order line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderLine: string
Read Only:
true
Maximum Length:255
Number that identifies the order line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- messageDetails
-
Parameters:
- ActionRequestId:
$request.path.ActionRequestId
- ActionRequestId2:
$request.path.ActionRequestId2
The Message Details resource fetches the details of the messages logged for the action request. - ActionRequestId:
- orderDetails
-
Parameters:
- ActionRequestId:
$request.path.ActionRequestId
- ActionRequestId2:
$request.path.ActionRequestId2
Order Details resource fetches the order details of the sales order processed by the request. - ActionRequestId:
- orderLineDetails
-
Parameters:
- ActionRequestId:
$request.path.ActionRequestId
- ActionRequestId2:
$request.path.ActionRequestId2
The Order Line Details resource fetches the order line details of the sales order processed by the request. - ActionRequestId: