Jump to

• Request
• Response
• Examples

Create one sales action request

post

/fscmRestApi/resources/11.13.18.05/salesOrderActionRequests

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActionCode(required): string
  Maximum Length: 30

  Code such as ORA_FOM_SUBMIT_ORDER to identify the action.
• ActionRequestId: integer (int64)
  Unique identifier for the master action request.
• ActionRequestTrackingId(required): integer (int64)
  Identifier to track action requests.
• CancelReasonCode: string
  Code to indicate the reason for the cancelation.
• Comments: string
  Contains user comments for the cancelation.
• 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.
• FulfillLineId: integer (int64)
  Unique identifier for fulfillment line.
• HeaderId(required): integer (int64)
  Unique identifier for the sales order header.
• HoldCode: string
  Abbreviation that identifies the hold.
• MassActionFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates that the action is a mass action.
• OutcomeCode: string
  Maximum Length: 30

  Code to indicate the outcome of the master action request. It can be SUCCESS or ERROR.
• ReleaseReasonCode: string
  Reason for releasing the hold.
• requests: array Requests
  Title: Requests

  The request executes the action performed on the sales order. It's a child of the action 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.
• StatusCode: string
  Maximum Length: 30

  Default Value: PRE_PROCESSING

  Code to indicate the status of the master action request such as COMPLETE, PRE_PROCESSING, or PROCESSING.

{
    "required":[
        "ActionCode",
        "ActionRequestTrackingId",
        "HeaderId"
    ],
    "type":"object",
    "properties":{
        "OutcomeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate the outcome of the master action request. It can be SUCCESS or ERROR.",
            "nullable":true
        },
        "Comments":{
            "type":"string",
            "description":"Contains user comments for the cancelation.",
            "nullable":true
        },
        "MassActionFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the action is a mass action.",
            "nullable":false,
            "default":false
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code such as ORA_FOM_SUBMIT_ORDER to identify the action.",
            "nullable":false
        },
        "HeaderId":{
            "type":"integer",
            "description":"Unique identifier for the sales order header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ActionRequestId":{
            "type":"integer",
            "description":"Unique identifier for the master action request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ReleaseReasonCode":{
            "type":"string",
            "description":"Reason for releasing the hold.",
            "nullable":true
        },
        "RequireReasonCodeFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "FilterCriteria":{
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "requests":{
            "title":"Requests",
            "type":"array",
            "description":"The request executes the action performed on the sales order. It's a child of the action request.",
            "items":{
                "$ref":"#/components/schemas/salesOrderActionRequests-requests-item-post-request"
            }
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate the status of the master action request such as COMPLETE, PRE_PROCESSING, or PROCESSING.",
            "nullable":false,
            "default":"PRE_PROCESSING"
        },
        "FulfillLineId":{
            "type":"integer",
            "description":"Unique identifier for fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ActionRequestTrackingId":{
            "type":"integer",
            "description":"Identifier to track action requests.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "HoldCode":{
            "type":"string",
            "description":"Abbreviation that identifies the hold.",
            "nullable":true
        },
        "CancelReasonCode":{
            "type":"string",
            "description":"Code to indicate the reason for the cancelation.",
            "nullable":true
        }
    }
}

Nested Schema : Requests

Type: array

Title: Requests

The request executes the action performed on the sales order. It's a child of the action request.

Show Source

• Array of: object schema

{
    "title":"Requests",
    "type":"array",
    "description":"The request executes the action performed on the sales order. It's a child of the action request.",
    "items":{
        "$ref":"#/components/schemas/salesOrderActionRequests-requests-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

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

{
    "required":[
        "ActionCode",
        "ActionRequestTrackingId",
        "HeaderId"
    ],
    "type":"object",
    "properties":{
        "FulfillLineId":{
            "type":"integer",
            "description":"Unique identifier for the fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ActionRequestTrackingId":{
            "type":"integer",
            "description":"Identifier to track action requests in the Requests resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "orderDetails":{
            "title":"Order Details",
            "type":"array",
            "description":"Order Details resource fetches the order details of the sales order processed by the request.",
            "items":{
                "$ref":"#/components/schemas/salesOrderActionRequests-requests-orderDetails-item-post-request"
            },
            "x-cardinality":"1"
        },
        "OutcomeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate the outcome of the child action request. It can be SUCCESS or ERROR.",
            "nullable":true
        },
        "messageDetails":{
            "title":"Message Details",
            "type":"array",
            "description":"The Message Details resource fetches the details of the messages logged for the action request.",
            "items":{
                "$ref":"#/components/schemas/salesOrderActionRequests-requests-messageDetails-item-post-request"
            }
        },
        "MassActionFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the action is a mass action.",
            "nullable":false,
            "default":false
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code to identify the action.",
            "nullable":false
        },
        "HeaderId":{
            "type":"integer",
            "description":"Unique identifier for the sales order header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "orderLineDetails":{
            "title":"Order Line Details",
            "type":"array",
            "description":"The Order Line Details resource fetches the order line details of the sales order processed by the request.",
            "items":{
                "$ref":"#/components/schemas/salesOrderActionRequests-requests-orderLineDetails-item-post-request"
            },
            "x-cardinality":"1"
        },
        "ActionRequestId":{
            "type":"integer",
            "description":"Unique identifier for the child action request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate the status of the child action request such as COMPLETE, PRE_PROCESSING, or PROCESSING.",
            "nullable":false,
            "default":"PRE_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

• Array of: object salesOrderActionRequests-requests-messageDetails-item-post-request

{
    "title":"Message Details",
    "type":"array",
    "description":"The Message Details resource fetches the details of the messages logged for the action request.",
    "items":{
        "$ref":"#/components/schemas/salesOrderActionRequests-requests-messageDetails-item-post-request"
    }
}

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

• Array of: object salesOrderActionRequests-requests-orderDetails-item-post-request

{
    "title":"Order Details",
    "type":"array",
    "description":"Order Details resource fetches the order details of the sales order processed by the request.",
    "items":{
        "$ref":"#/components/schemas/salesOrderActionRequests-requests-orderDetails-item-post-request"
    },
    "x-cardinality":"1"
}

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

• Array of: object salesOrderActionRequests-requests-orderLineDetails-item-post-request

{
    "title":"Order Line Details",
    "type":"array",
    "description":"The Order Line Details resource fetches the order line details of the sales order processed by the request.",
    "items":{
        "$ref":"#/components/schemas/salesOrderActionRequests-requests-orderLineDetails-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : salesOrderActionRequests-requests-messageDetails-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : salesOrderActionRequests-requests-orderDetails-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : salesOrderActionRequests-requests-orderLineDetails-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

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.

Body ()

Root Schema : salesOrderActionRequests-item-response

Type: object

Show Source

• Action: string
  Read Only: true

  Maximum Length: 255

  Value attribute for the action such as Submit Order, Cancel Order, Reprice Order, or Cancel Line.
• ActionCode: string
  Maximum Length: 30

  Code 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.
• CancelReasonCode: string
  Code to indicate the reason for the cancelation.
• Comments: string
  Contains user comments for the cancelation.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the action request.
• CreationDate: string (date-time)
  Read Only: true

  Date on which action request is created.
• 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.
• 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.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date on which action request was last updated.
• 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.
• OutcomeCode: string
  Maximum Length: 30

  Code to indicate the outcome of the master action request. It can be SUCCESS or ERROR.
• ProcessId: integer
  Read Only: true

  Unique identifier for the process to initiate the process in the request resource.
• ProcessStatus: string
  Read Only: true

  Maximum Length: 255

  Status of the process initiated by the action request to process the action such as COMPLETED, IN_QUEUE, IN_PROGRESS, or COMPLETED_WITH_ERRORS.
• ReleaseReasonCode: string
  Reason for releasing the hold.
• requests: array Requests
  Title: Requests

  The request executes the action performed on the sales order. It's a child of the action 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.
• StatusCode: string
  Maximum Length: 30

  Default Value: PRE_PROCESSING

  Code to indicate the status of the master action request such as COMPLETE, PRE_PROCESSING, or PROCESSING.
• TotalFailed: integer
  Read Only: true

  Total number of records failed to process by the action request.
• TotalPassed: integer
  Read Only: true

  Total number of records successfully processed by the action request.
• TotalRecords: integer
  Read Only: true

  Total number of records processed by the action request.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date on which action request is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Action":{
            "maxLength":"255",
            "type":"string",
            "description":"Value attribute for the action such as Submit Order, Cancel Order, Reprice Order, or Cancel Line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ActionCode"
                ]
            },
            "x-queryable":true
        },
        "OutcomeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate the outcome of the master action request. It can be SUCCESS or ERROR.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Status of the process initiated by the action request to process the action such as COMPLETED, IN_QUEUE, IN_PROGRESS, or COMPLETED_WITH_ERRORS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code such as ORA_FOM_SUBMIT_ORDER to identify the action.",
            "nullable":false,
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Unique identifier for the sales order header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReleaseReasonCode":{
            "type":"string",
            "description":"Reason for releasing the hold.",
            "nullable":true,
            "x-queryable":true
        },
        "RequireReasonCodeFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "FilterCriteria":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "requests":{
            "title":"Requests",
            "type":"array",
            "description":"The request executes the action performed on the sales order. It's a child of the action request.",
            "items":{
                "$ref":"#/components/schemas/salesOrderActionRequests-requests-item-response"
            }
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate the status of the master action request such as COMPLETE, PRE_PROCESSING, or PROCESSING.",
            "nullable":false,
            "default":"PRE_PROCESSING",
            "x-queryable":true
        },
        "TotalFailed":{
            "type":"integer",
            "description":"Total number of records failed to process by the action request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalRecords":{
            "type":"integer",
            "description":"Total number of records processed by the action request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TotalPassed":{
            "type":"integer",
            "description":"Total number of records successfully processed by the action request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the action request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "type":"string",
            "description":"Contains user comments for the cancelation.",
            "nullable":true,
            "x-queryable":true
        },
        "MassActionFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the action is a mass action.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ActionRequestId":{
            "type":"integer",
            "description":"Unique identifier for the master action request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FulfillLineId":{
            "type":"integer",
            "description":"Unique identifier for fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActionRequestTrackingId":{
            "type":"integer",
            "description":"Identifier to track action requests.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HoldCode":{
            "type":"string",
            "description":"Abbreviation that identifies the hold.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"Unique identifier for the process to initiate the process in the request resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelReasonCode":{
            "type":"string",
            "description":"Code to indicate the reason for the cancelation.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date on which action request was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Requests

Type: array

Title: Requests

The request executes the action performed on the sales order. It's a child of the action request.

Show Source

• Array of: object salesOrderActionRequests-requests-item-response

{
    "title":"Requests",
    "type":"array",
    "description":"The request executes the action performed on the sales order. It's a child of the action request.",
    "items":{
        "$ref":"#/components/schemas/salesOrderActionRequests-requests-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : salesOrderActionRequests-requests-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "SummaryMessageText":{
            "maxLength":"1000",
            "type":"string",
            "description":"Contains errors, warnings, and information messages for the action request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OutcomeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate the outcome of the child action request. It can be SUCCESS or ERROR.",
            "nullable":true,
            "x-queryable":true
        },
        "MassActionFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the action is a mass action.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code to identify the action.",
            "nullable":false,
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Unique identifier for the sales order header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActionRequestId":{
            "type":"integer",
            "description":"Unique identifier for the child action request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate the status of the child action request such as COMPLETE, PRE_PROCESSING, or PROCESSING.",
            "nullable":false,
            "default":"PRE_PROCESSING",
            "x-queryable":true
        },
        "FulfillLineId":{
            "type":"integer",
            "description":"Unique identifier for the fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActionRequestTrackingId":{
            "type":"integer",
            "description":"Identifier to track action requests in the Requests resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "orderDetails":{
            "title":"Order Details",
            "type":"array",
            "description":"Order Details resource fetches the order details of the sales order processed by the request.",
            "items":{
                "$ref":"#/components/schemas/salesOrderActionRequests-requests-orderDetails-item-response"
            },
            "x-cardinality":"1"
        },
        "messageDetails":{
            "title":"Message Details",
            "type":"array",
            "description":"The Message Details resource fetches the details of the messages logged for the action request.",
            "items":{
                "$ref":"#/components/schemas/salesOrderActionRequests-requests-messageDetails-item-response"
            }
        },
        "orderLineDetails":{
            "title":"Order Line Details",
            "type":"array",
            "description":"The Order Line Details resource fetches the order line details of the sales order processed by the request.",
            "items":{
                "$ref":"#/components/schemas/salesOrderActionRequests-requests-orderLineDetails-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequestStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Status of the request submitted for an order or line such as COMPLETED, FAILED, or IN_QUEUE",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object salesOrderActionRequests-requests-messageDetails-item-response

{
    "title":"Message Details",
    "type":"array",
    "description":"The Message Details resource fetches the details of the messages logged for the action request.",
    "items":{
        "$ref":"#/components/schemas/salesOrderActionRequests-requests-messageDetails-item-response"
    }
}

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

• Array of: object salesOrderActionRequests-requests-orderDetails-item-response

{
    "title":"Order Details",
    "type":"array",
    "description":"Order Details resource fetches the order details of the sales order processed by the request.",
    "items":{
        "$ref":"#/components/schemas/salesOrderActionRequests-requests-orderDetails-item-response"
    },
    "x-cardinality":"1"
}

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

• Array of: object salesOrderActionRequests-requests-orderLineDetails-item-response

{
    "title":"Order Line Details",
    "type":"array",
    "description":"The Order Line Details resource fetches the order line details of the sales order processed by the request.",
    "items":{
        "$ref":"#/components/schemas/salesOrderActionRequests-requests-orderLineDetails-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : salesOrderActionRequests-requests-messageDetails-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "EntityType":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the level at which the message was logged. It can be Order or Line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionRequestId":{
            "type":"integer",
            "description":"Unique identifier for the child action request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EntityDisplayNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Line number on which message was logged.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MessageText":{
            "maxLength":"1000",
            "type":"string",
            "description":"Contains errors, warnings, and information messages for the action request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the severity of the message. It can be Error, Warning, or Information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageId":{
            "type":"integer",
            "description":"Value that uniquely identifies a message.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time on which message was logged.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : salesOrderActionRequests-requests-orderDetails-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"255",
            "type":"string",
            "description":"Status of the sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerPONumber":{
            "title":"Purchase Order",
            "maxLength":"50",
            "type":"string",
            "description":"Customer purchase order of the sales order processed by the action request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrderNumber":{
            "title":"Source Order",
            "maxLength":"50",
            "type":"string",
            "description":"Unique identifier for the sales order in the source system.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationMode":{
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the interface using which the order was captured such as OrderImport, REST_salesOrdersForOrderHub, REST_omSalesOrders, or UI.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuyingPartyName":{
            "maxLength":"255",
            "type":"string",
            "description":"Sold-to party name of the customer on the sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Revision":{
            "type":"integer",
            "description":"Value that identifies the revision number of the order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Unique identifier for the sales order header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrderNumber":{
            "title":"Orchestration Order",
            "maxLength":"50",
            "type":"string",
            "description":"Identifier of the sales order number.",
            "nullable":false,
            "readOnly":true,
            "default":"-1",
            "x-queryable":true
        },
        "SoldToPartyId":{
            "type":"integer",
            "description":"Unique identifier of the sold-to party on the sales order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code to identify the status of the sales order such as DRAFT, PROCESSING, or CLOSED.",
            "nullable":false,
            "readOnly":true,
            "default":"OPEN",
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : salesOrderActionRequests-requests-orderLineDetails-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "FulfillLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the fulfillment line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Item":{
            "maxLength":"255",
            "type":"string",
            "description":"Stock keeping unit for the item that the application fulfills.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the order line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrderLine":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Unique identifier for the sales order header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the item that the application fulfills.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

requests

Operation: /fscmRestApi/resources/11.13.18.05/salesOrderActionRequests/{ActionRequestId}/child/requests

Parameters:

• ActionRequestId: $request.path.ActionRequestId

The request executes the action performed on the sales order. It's a child of the action request.

Back to Top

Examples

These examples describe how to create a sales order action request to apply different actions on multiple orders or lines.

Table -

Example Number	Description
Example 1	Create a sales order action request to submit multiple orders.
Example 2	Create a sales order action request to cancel multiple orders.
Example 3	Create a sales order action request to cancel multiple order lines.
Example 4	Create a sales order action request to reprice multiple orders.
Example 5	Create a sales order action request to apply hold on multiple orders.
Example 6	Create a sales order action request to release holds on multiple orders.
Example 7	Create a sales order action request to apply hold on multiple order lines.
Example 8	Create a sales order action request to release holds on multiple order lines.
Example 9	Create a sales order action request to release pause task on multiple order lines.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/salesOrderActionRequests"

Example 1

In this example we submit sales order action requests for three sales orders.

Example 1 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. In this example we submit sales order action request for three sales orders with Header IDs 300100608434819, 300100608434932, and 300100608434934. We specify ActionCode: ORA_FOM_SUBMIT_ORDER to indicate that the sales order action request is for order submission. HeaderId attribute carries the unique identifier of the sales order to be submitted.

{
    "ActionCode": "ORA_FOM_SUBMIT_ORDER",
    "requests": [
        {
            "HeaderId": 300100608434819
        },
        {
            "HeaderId": 300100608434932
        },
        {
            "HeaderId": 300100608434934
        }
    ]
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format. We can see one master request and 3 child action requests for sumitting 3 sales orders with header IDs mentioned in the request payload. The order is submitted through a batch process. The response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as the batch process is yet to start processing. You can use the Get operation to check the status of the sales order action request.

{
    "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": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 474122,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "requests": [
        {
            "ActionCode": "ORA_FOM_SUBMIT_ORDER",
            "ActionRequestId": 300100608436028,
            "ActionRequestTrackingId": 427736,
            "FulfillLineId": null,
            "HeaderId": 300100608434819,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436028",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436028",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436028/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_SUBMIT_ORDER",
            "ActionRequestId": 300100608436029,
            "ActionRequestTrackingId": 427736,
            "FulfillLineId": null,
            "HeaderId": 300100608434932,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436029",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436029",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436029/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_SUBMIT_ORDER",
            "ActionRequestId": 300100608436030,
            "ActionRequestTrackingId": 427736,
            "FulfillLineId": null,
            "HeaderId": 300100608434934,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436030",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436030",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests/300100608436030/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100608436027/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}

Example 2

This example describes how to create a sales order action request to cancel multiple orders.

Example 2 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. In this example you submit a sales order action request for three sales orders with Header IDs 300100608647565, 300100609916691, and 300100608453169. You specify ActionCode: ORA_FOM_CANCEL_ORDER to indicate that the sales order action request is for order cancellation. You can also specify CancelReasonCode and Comments, if needed. The HeaderId attribute carries the unique identifier of the sales order to be cancelled.

{
    "ActionCode": "ORA_FOM_CANCEL_ORDER",
    "CancelReasonCode": "LATE",
    "Comments": "Canceled as per customer request",
    "requests": [
        {
            "HeaderId": 300100608647565
        },
        {
            "HeaderId": 300100609916691
        },
        {
            "HeaderId": 300100608453169
        }
    ]
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format. You can see one master request and three child action requests for cancelling three sales orders with header IDs mentioned in the request payload. The order is cancelled through a batch process. The response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as the batch process is yet to start processing. You can use the Get operation to check the status of the sales order action request. It provides you the overall status of the order cancellation request. You can also use the Get operation to check the status of the child request action requests. It provides the status of the order cancellation and the error or warning details if any for each order.

For details, see the use cases for Order Management.

{
    "ActionCode": "ORA_FOM_CANCEL_ORDER",
    "ActionRequestId": 300100609916275,
    "ActionRequestTrackingId": 347710,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-02-08T06:59:11.002+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-02-08T06:59:11.234+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 300945,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": "Canceled as per customer request",
    "CancelReasonCode": "LATE",
    "HoldCode": null,
    "ReleaseReasonCode": null,
    "requests": [
        {
            "ActionCode": "ORA_FOM_CANCEL_ORDER",
            "ActionRequestId": 300100609916279,
            "ActionRequestTrackingId": 347710,
            "FulfillLineId": null,
            "HeaderId": 300100608647565,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916279",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916279",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916279/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916279/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916279/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_CANCEL_ORDER",
            "ActionRequestId": 300100609916280,
            "ActionRequestTrackingId": 347710,
            "FulfillLineId": null,
            "HeaderId": 300100609916691,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916280",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916280",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916280/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916280/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916280/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_CANCEL_ORDER",
            "ActionRequestId": 300100609916281,
            "ActionRequestTrackingId": 347710,
            "FulfillLineId": null,
            "HeaderId": 300100608453169,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916281",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916281",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916281/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916281/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests/300100609916281/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100609916275/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}

Example 3

This example describes how to create a sales order action request to cancel multiple order lines.

Example 3 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. In this example you submit sales order action request for three fulfillment lines with Fulfill Line IDs 300100610023895, 300100610023690, and 300100610023731. You specify ActionCode: ORA_FOM_CANCEL_LINE to indicate that the sales order action request is for order line cancellation. You can also specify CancelReasonCode and Comments if needed. The FulfillLineId attribute carries the unique identifier of the sales order line to be cancelled.

 {
    "ActionCode": "ORA_FOM_CANCEL_LINE",
    "CancelReasonCode": "ORA_WRONG_ITEM",
    "Comments": "Incorrect Item ordered",
    "requests": [
        {
            "FulfillLineId": 300100610023895
        },
        {
            "FulfillLineId": 300100610023690
        },
        {
            "FulfillLineId": 300100610023731
        }
    ]
}

Example 3 Response Body

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

You can see one master request and three child action requests for cancelling three sales order lines with Fulfill Line IDs mentioned in the request payload. The order line is cancelled through a batch process. The response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as the batch process is yet to start processing. You can use the Get operation to check the status of the sales order action request. It provides you the overall status of the order line cancellation request. You can also use the Get operation to check the status of the child request action requests. It provides you status of the order line cancellation and the error or warning details if any for each order line.

For details, see the use cases for Order Management.

{
    "ActionCode": "ORA_FOM_CANCEL_LINE",
    "ActionRequestId": 300100610036489,
    "ActionRequestTrackingId": 349735,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-02-08T17:11:48.001+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-02-08T17:11:48.162+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 308326,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": "Incorrect Item ordered",
    "CancelReasonCode": "ORA_WRONG_ITEM",
    "HoldCode": null,
    "ReleaseReasonCode": null,
    "requests": [
        {
            "ActionCode": "ORA_FOM_CANCEL_LINE",
            "ActionRequestId": 300100610036493,
            "ActionRequestTrackingId": 349735,
            "FulfillLineId": 300100610023895,
            "HeaderId": 300100610023843,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036493",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036493",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036493/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036493/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036493/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_CANCEL_LINE",
            "ActionRequestId": 300100610036494,
            "ActionRequestTrackingId": 349735,
            "FulfillLineId": 300100610023690,
            "HeaderId": 300100610023665,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036494",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036494",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036494/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036494/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036494/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_CANCEL_LINE",
            "ActionRequestId": 300100610036495,
            "ActionRequestTrackingId": 349735,
            "FulfillLineId": 300100610023731,
            "HeaderId": 300100610023665,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036495",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036495",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036495/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036495/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests/300100610036495/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610036489/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}

Example 4

This example describes how to create a sales order action request to reprice multiple orders.

Example 4 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. In this example you submit sales order action request for three sales orders with Header IDs 300100609979963, 300100610845045, and 300100601830766. You specify ActionCode: ORA_FOM_REPRICE_ORDER to indicate that the sales order action request is for reprice order. The HeaderId attribute carries the unique identifier of the sales order to be repriced.

{
    "ActionCode": "ORA_FOM_REPRICE_ORDER",
    "requests": [
        {
            "HeaderId": 300100609979963
        },
        {
            "HeaderId": 300100610845045
        },
        {
            "HeaderId": 300100601830766
        }
    ]
}

Example 4 Response Body

The following example includes the contents of the response body in JSON format. You can see one master request and three child action requests for repricing 3 sales orders with header IDs mentioned in the request payload. The order is repriced through a batch process. The response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as the batch process is yet to start processing. You can use the Get operation to check the status of the sales order action request. It provides you the overall status of the reprice order request. You can also use the Get operation to check the status of the child request action requests. It provides you status of the reprice order and the error or warning details if any for each order.

For details, see the use cases for Order Management.

{
    "ActionCode": "ORA_FOM_REPRICE_ORDER",
    "ActionRequestId": 300100610889715,
    "ActionRequestTrackingId": 353752,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-02-09T11:28:25.028+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-02-09T11:28:25.063+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 313824,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": null,
    "CancelReasonCode": null,
    "HoldCode": null,
    "ReleaseReasonCode": null,
    "RequireReasonCodeFlag": null,
    "requests": [
        {
            "ActionCode": "ORA_FOM_REPRICE_ORDER",
            "ActionRequestId": 300100610889716,
            "ActionRequestTrackingId": 353752,
            "FulfillLineId": null,
            "HeaderId": 300100609979963,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889716",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889716",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889716/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889716/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889716/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_REPRICE_ORDER",
            "ActionRequestId": 300100610889717,
            "ActionRequestTrackingId": 353752,
            "FulfillLineId": null,
            "HeaderId": 300100610845045,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889717",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889717",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889717/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889717/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889717/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_REPRICE_ORDER",
            "ActionRequestId": 300100610889718,
            "ActionRequestTrackingId": 353752,
            "FulfillLineId": null,
            "HeaderId": 300100601830766,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889718",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889718",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889718/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889718/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests/300100610889718/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100610889715/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}

Example 5

This example describes how to create a sales order action request to apply hold on multiple orders.

Example 5 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. In this example you submit a sales order action request for three sales orders with header IDs 300100608313927, 300100608314069, and 300100608314211. You specify ActionCode: ORA_FOM_APPLY_ORDER_HOLD and HoldCode: ADMINISTRATIVE_HOLD to indicate that the sales order action request is to apply the ADMINISTRATIVE_HOLD hold on all the three orders. You can also specify comments, if needed. You can specify only one HoldCode in a request. The HeaderId attribute carries the unique identifier of the sales order for applying the order hold.

{
    "ActionCode": "ORA_FOM_APPLY_ORDER_HOLD",
    "HoldCode": "ADMINISTRATIVE_HOLD",  
    "Comments": "Complete Administrative Check on the orders",
    "requests": [
        {
            "HeaderId": 300100608313927
        },
        {
            "HeaderId": 300100608314069
        },
        {
            "HeaderId": 300100608314211
        }
    ]
}

Example 5 Response Body

The following example includes the contents of the response body in JSON format. You can see one master request and three child action requests to apply hold on three sales orders with the header IDs mentioned in the request payload. The hold is applied on the orders through a batch process. The response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as the batch process is yet to start processing. You can use the Get operation to check the status of the sales order action request. It provides you the overall status of the apply order hold request on the orders. You can also use the Get operation to check the status of the child action requests. It provides the status of the apply order hold request on each order and the corresponding error or warning details, if any.

For details, see the use cases for Order Management.

{
    "ActionCode": "ORA_FOM_APPLY_ORDER_HOLD",
    "ActionRequestId": 300100608320103,
    "ActionRequestTrackingId": 320703,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-04-26T14:13:43.001+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-04-26T14:13:43.365+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 214235,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": "Complete Administrative Check on the orders",
    "CancelReasonCode": null,
    "HoldCode": "ADMINISTRATIVE_HOLD",
    "ReleaseReasonCode": null,
    "RequireReasonCodeFlag": null,
    "requests": [
        {
            "ActionCode": "ORA_FOM_APPLY_ORDER_HOLD",
            "ActionRequestId": 300100608320106,
            "ActionRequestTrackingId": 320703,
            "FulfillLineId": null,
            "HeaderId": 300100608313927,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests/300100608320106",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests/300100608320106",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests/300100608320106/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests/300100608320106/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests/300100608320106/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_APPLY_ORDER_HOLD",
            "ActionRequestId": 300100608320107,
            "ActionRequestTrackingId": 320703,
            "FulfillLineId": null,
            "HeaderId": 300100608314069,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests/300100608320107",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests/300100608320107",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests/300100608320107/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests/300100608320107/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests/300100608320107/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_APPLY_ORDER_HOLD",
            "ActionRequestId": 300100608320108,
            "ActionRequestTrackingId": 320703,
            "FulfillLineId": null,
            "HeaderId": 300100608314211,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests/300100608320108",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests/300100608320108",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests/300100608320108/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests/300100608320108/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests/300100608320108/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608320103/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}

Example 6

This example describes how to create a sales order action request to release holds on multiple orders.

Example 6 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. In this example you submit a sales order action request for three sales orders with header IDs 300100608313927, 300100608314069, and 300100608314211. You specify ActionCode: ORA_FOM_RELEASE_ORDER_HOLD and HoldCode: ADMINISTRATIVE_HOLD and EXPORT_CHECK_HOLD to indicate that the sales order action request is to release the ADMINISTRATIVE_HOLD and EXPORT_CHECK_HOLD holds on all the three orders.. You can specify comma-separated HoldCode to release multiple holds on the orders in a request as illustrated in this example. You can also specify ReleaseReasonCode and comments, if needed. If you must send a ReleaseReasonCode, then set the RequireReasonCodeFlag to true. Otherwise, it's optional for you to send a ReleaseReasonCode. The HeaderId attribute carries the unique identifier of the sales order for releasing the order hold.

{
    "ActionCode":"ORA_FOM_RELEASE_ORDER_HOLD",
    "HoldCode": "ADMINISTRATIVE_HOLD,EXPORT_CHECK_HOLD",
    "Comments": "Administrative check completed for domestic and export orders",
    "ReleaseReasonCode": "ADMINISTRATIVE_CHECK_COMPLETE",
    "RequireReasonCodeFlag": true,

    "requests": [
        {
            "HeaderId": 300100608313927
        },
        {
            "HeaderId": 300100608314069
        },
        {
            "HeaderId": 300100608314211
        }
    ]
}

Example 6 Response Body

The following example includes the contents of the response body in JSON format. You can see one master request and three child action requests to release hold on three sales orders with the header IDs mentioned in the request payload. The holds on the orders are released through a batch process. The response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as the batch process is yet to start processing. You can use the Get operation to check the status of the sales order action request. It provides you the overall status of the apply order hold request on the orders. You can also use the Get operation to check the status of the child action requests. It provides the status of the release order hold request on each order and the corresponding error or warning details, if any.

For details, see the use cases for Order Management.

{
    "ActionCode": "ORA_FOM_RELEASE_ORDER_HOLD",
    "ActionRequestId": 300100608322602,
    "ActionRequestTrackingId": 320716,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-04-26T15:42:10.004+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-04-26T15:42:10.304+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 214485,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": "Administrative check completed for domestic and export orders",
    "CancelReasonCode": null,
    "HoldCode": "ADMINISTRATIVE_HOLD,EXPORT_CHECK_HOLD",
    "ReleaseReasonCode": "ADMINISTRATIVE_CHECK_COMPLETE",
    "RequireReasonCodeFlag": "true",
    "requests": [
        {
            "ActionCode": "ORA_FOM_RELEASE_ORDER_HOLD",
            "ActionRequestId": 300100608322607,
            "ActionRequestTrackingId": 320716,
            "FulfillLineId": null,
            "HeaderId": 300100608313927,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests/300100608322607",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests/300100608322607",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests/300100608322607/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests/300100608322607/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests/300100608322607/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_RELEASE_ORDER_HOLD",
            "ActionRequestId": 300100608322608,
            "ActionRequestTrackingId": 320716,
            "FulfillLineId": null,
            "HeaderId": 300100608314069,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests/300100608322608",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests/300100608322608",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests/300100608322608/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests/300100608322608/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests/300100608322608/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_RELEASE_ORDER_HOLD",
            "ActionRequestId": 300100608322609,
            "ActionRequestTrackingId": 320716,
            "FulfillLineId": null,
            "HeaderId": 300100608314211,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests/300100608322609",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests/300100608322609",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests/300100608322609/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests/300100608322609/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests/300100608322609/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100608322602/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}

Example 7

This example describes how to create a sales order action request to apply hold on multiple order lines.

Example 7 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. In this example you submit a sales order action request for three fulfillment lines with Fulfill Line IDs 300100608313952, 300100608314073, and 300100608314213. You specify ActionCode: ORA_FOM_APPLY_LINE_HOLD and HoldCode: QUALITY_CHECK_HOLD to indicate that the sales order action request is to apply the QUALITY_CHECK_HOLD hold on all the three fulfillment lines. You can specify only one HoldCode in a request. You can also specify comments, if needed. The FulfillLineId attribute carries the unique identifier of the order line for applying the line hold. You can apply hold at the fulfillment line entity. You can't apply hold at the order line entity.

{
    "ActionCode": "ORA_FOM_APPLY_LINE_HOLD",
    "HoldCode": "QUALITY_CHECK_HOLD",  
    "Comments": "Item Lot Requires Quality Check",
    "requests": [
        {
            "FulfillLineId": 300100608313952
        },
        {
            "FulfillLineId": 300100608314073
        },
        {
            "FulfillLineId": 300100608314213
        }
    ]
}

Example 7 Response Body

The following example includes the contents of the response body in JSON format. You can see one master request and three child action requests to apply hold on three fulfillment lines with the Fulfill Line IDs mentioned in the request payload. The hold is applied on the lines through a batch process. The response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as the batch process is yet to start processing. You can use the Get operation to check the status of the sales order action request. It provides you the overall status of the apply line hold request on the lines. You can also use the Get operation to check the status of the child action requests. It provides the status of the apply line hold request on each line and the corresponding error or warning details, if any.

For details, see the use cases for Order Management.

{
    "ActionCode": "ORA_FOM_APPLY_LINE_HOLD",
    "ActionRequestId": 300100611832170,
    "ActionRequestTrackingId": 331038,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-04-29T09:01:09.002+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-04-29T09:01:09.264+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 312634,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": "Item Lot Requires Quality Check",
    "CancelReasonCode": null,
    "HoldCode": "QUALITY_CHECK_HOLD",
    "ReleaseReasonCode": null,
    "RequireReasonCodeFlag": null,
    "requests": [
        {
            "ActionCode": "ORA_FOM_APPLY_LINE_HOLD",
            "ActionRequestId": 300100611832173,
            "ActionRequestTrackingId": 331038,
            "FulfillLineId": 300100608313952,
            "HeaderId": 300100608313927,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests/300100611832173",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests/300100611832173",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests/300100611832173/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests/300100611832173/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests/300100611832173/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_APPLY_LINE_HOLD",
            "ActionRequestId": 300100611832174,
            "ActionRequestTrackingId": 331038,
            "FulfillLineId": 300100608314073,
            "HeaderId": 300100608314069,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests/300100611832174",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests/300100611832174",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests/300100611832174/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests/300100611832174/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests/300100611832174/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_APPLY_LINE_HOLD",
            "ActionRequestId": 300100611832175,
            "ActionRequestTrackingId": 331038,
            "FulfillLineId": 300100608314213,
            "HeaderId": 300100608314211,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests/300100611832175",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests/300100611832175",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests/300100611832175/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests/300100611832175/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests/300100611832175/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611832170/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}

Example 8

This example describes how to create a sales order action request to release holds on multiple order lines.

Example 8 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. In this example you submit a sales order action request for three fulfillment lines with Fulfill Line IDs 300100608313952, 300100608314073, and 300100608314213. You specify ActionCode: ORA_FOM_RELEASE_LINE_HOLD and HoldCode: QUALITY_CHECK_HOLD and HOLD_INVOICE_CREATION to indicate that the sales order action request is to release the QUALITY_CHECK_HOLD and HOLD_INVOICE_CREATION holds on all the three fulfillment lines. You can specify comma-separated HoldCode to release multiple holds on the lines in a request as illustrated in this example. You can also specify ReleaseReasonCode and comments, if needed. If you must send a ReleaseReasonCode, then set the RequireReasonCodeFlag to true. Otherwise, it's optional for you to send a ReleaseReasonCode. The FulfillLineId attribute carries the unique identifier of the order lines for releasing the line hold. You can release hold that's applied at the fulfillment line entity. You can't release hold that's applied at the order line entity.

{
    "ActionCode":"ORA_FOM_RELEASE_LINE_HOLD",
    "HoldCode": "QUALITY_CHECK_HOLD,HOLD_INVOICE_CREATION",
    "Comments": "Item Lot Passed Quality Check.Ready to Ship and Invoice",
    "ReleaseReasonCode": "PASSED_QUALITY_CHECK",
    "RequireReasonCodeFlag": true,
    "requests": [
         {
            "FulfillLineId": 300100608313952
        },
        {
            "FulfillLineId": 300100608314073
        },
        {
            "FulfillLineId": 300100608314213
        }
    ]
}

Example 8 Response Body

The following example includes the contents of the response body in JSON format. You can see one master request and three child action requests to release hold on three Fulfill Line IDs mentioned in the request payload. The hold is released on the lines through a batch process. The response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as the batch process is yet to start processing. You can use the Get operation to check the status of the sales order action request. It provides you the overall status of the release line hold request on the lines. You can also use the Get operation to check the status of the child action requests. It provides the status of the release line hold request on each line and the corresponding error or warning details, if any.

For details, see the use cases for Order Management.

{
    "ActionCode": "ORA_FOM_RELEASE_LINE_HOLD",
    "ActionRequestId": 300100611833564,
    "ActionRequestTrackingId": 331049,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-04-29T09:29:14.126+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-04-29T09:29:14.469+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 316668,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": "Item Lot Passed Quality Check.Ready to Ship and Invoice",
    "CancelReasonCode": null,
    "HoldCode": "QUALITY_CHECK_HOLD,HOLD_INVOICE_CREATION",
    "ReleaseReasonCode": "PASSED_QUALITY_CHECK",
    "RequireReasonCodeFlag": "true",
    "requests": [
        {
            "ActionCode": "ORA_FOM_RELEASE_LINE_HOLD",
            "ActionRequestId": 300100611833569,
            "ActionRequestTrackingId": 331049,
            "FulfillLineId": 300100608313952,
            "HeaderId": 300100608313927,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests/300100611833569",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests/300100611833569",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests/300100611833569/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests/300100611833569/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests/300100611833569/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_RELEASE_LINE_HOLD",
            "ActionRequestId": 300100611833570,
            "ActionRequestTrackingId": 331049,
            "FulfillLineId": 300100608314073,
            "HeaderId": 300100608314069,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests/300100611833570",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests/300100611833570",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests/300100611833570/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests/300100611833570/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests/300100611833570/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_RELEASE_LINE_HOLD",
            "ActionRequestId": 300100611833571,
            "ActionRequestTrackingId": 331049,
            "FulfillLineId": 300100608314213,
            "HeaderId": 300100608314211,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests/300100611833571",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests/300100611833571",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests/300100611833571/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests/300100611833571/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests/300100611833571/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611833564/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}

Example 9

This example describes how to create a sales order action request to release pause task on multiple order lines.

Example 9 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates. In this example you submit a sales order action request for three lines with Fulfill Line IDs 300100611851727, 300100611851778, and 300100611851919. You specify ActionCode: ORA_FOM_RELEASE_PAUSE_TASK to indicate that the sales order action request is to release pause task on all the three lines. The FulfillLineId attribute carries the unique identifier of the lines for releasing the pause task.

{
    "ActionCode": "ORA_FOM_RELEASE_PAUSE_TASK",
    "requests": [
        {
            "FulfillLineId": 300100611851727
        },
        {
            "FulfillLineId": 300100611851778
        },
        {
            "FulfillLineId": 300100611851919
        }
    ]
}

Example 9 Response Body

The following example includes the contents of the response body in JSON format. You can see one master request and three child action requests to release pause task on three Fulfill Line IDs mentioned in the request payload. The pause task on the lines are released through a batch process. The response shows StatusCode as PRE_PROCESSING and ProcessStatus as IN_QUEUE as the batch process is yet to start processing. You can use the Get operation to check the status of the sales order action request. It provides you the overall status of the release pause task request on the lines. You can also use the Get operation to check the status of the child action requests. It provides the status of the status of release pause task request on each line and the corresponding error or warning details, if any.

For details, see the use cases for Order Management.

{
    "ActionCode": "ORA_FOM_RELEASE_PAUSE_TASK",
    "ActionRequestId": 300100611858237,
    "ActionRequestTrackingId": 331058,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2024-04-29T10:05:24.001+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2024-04-29T10:05:24.254+00:00",
    "MassActionFlag": true,
    "OutcomeCode": null,
    "StatusCode": "PRE_PROCESSING",
    "Action": null,
    "ProcessId": 318216,
    "TotalRecords": 3,
    "TotalFailed": 0,
    "TotalPassed": 0,
    "ProcessStatus": "IN_QUEUE",
    "FilterCriteria": null,
    "Comments": null,
    "CancelReasonCode": null,
    "HoldCode": null,
    "ReleaseReasonCode": null,
    "RequireReasonCodeFlag": null,
    "requests": [
        {
            "ActionCode": "ORA_FOM_RELEASE_PAUSE_TASK",
            "ActionRequestId": 300100611858238,
            "ActionRequestTrackingId": 331058,
            "FulfillLineId": 300100611851727,
            "HeaderId": 300100611851702,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests/300100611858238",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests/300100611858238",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests/300100611858238/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests/300100611858238/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests/300100611858238/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_RELEASE_PAUSE_TASK",
            "ActionRequestId": 300100611858239,
            "ActionRequestTrackingId": 331058,
            "FulfillLineId": 300100611851778,
            "HeaderId": 300100611851702,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests/300100611858239",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests/300100611858239",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests/300100611858239/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests/300100611858239/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests/300100611858239/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        },
        {
            "ActionCode": "ORA_FOM_RELEASE_PAUSE_TASK",
            "ActionRequestId": 300100611858240,
            "ActionRequestTrackingId": 331058,
            "FulfillLineId": 300100611851919,
            "HeaderId": 300100611851917,
            "MassActionFlag": false,
            "OutcomeCode": null,
            "StatusCode": "PRE_PROCESSING",
            "SummaryMessageText": null,
            "RequestStatus": "IN_QUEUE",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests/300100611858240",
                    "name": "requests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests/300100611858240",
                    "name": "requests",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237",
                    "name": "salesOrderActionRequests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests/300100611858240/child/messageDetails",
                    "name": "messageDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests/300100611858240/child/orderDetails",
                    "name": "orderDetails",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests/300100611858240/child/orderLineDetails",
                    "name": "orderLineDetails",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237",
            "name": "salesOrderActionRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237",
            "name": "salesOrderActionRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version5/salesOrderActionRequests/300100611858237/child/requests",
            "name": "requests",
            "kind": "collection"
        }
    ]
}

Back to Top