1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Order Management
  4. Sales Order Action Requests

Get all sales order action requests

get

/fscmRestApi/resources/11.13.18.05/salesOrderActionRequests

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • MassActionsFilter: Finds all sales order action requests for mass actions.
      Finder Variables:
      • PrimaryKey: Finds a sales order action request by the primary key.
        Finder Variables:
        • ActionRequestId; integer; Unique identifier for the action request.
    • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
    • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

      Example:
      self,canonical
    • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
    • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

      Format: ?q=expression1;expression2

      You can use these queryable attributes to filter this collection resource using the q query parameter:
      • Action; string; Value attribute for the action such as Submit Order, Cancel Order, Reprice Order, or Cancel Line.
      • ActionCode; string; Code such as ORA_FOM_SUBMIT_ORDER to identify the action.
      • ActionRequestId; integer; Unique identifier for the master action request.
      • ActionRequestTrackingId; integer; Identifier to track action requests.
      • AdditionalInformation; string; Additional details that extensible flexfields store for the sales order.
      • CancelBackordersFlag; boolean; Contains one of the following values: true or false. If true, then order lines backordered during picking or shipping are canceled. If false, then backorders aren't canceled. The default value is false.
      • CancelReasonCode; string; Code to indicate the reason for the cancelation.
      • Comments; string; Contains user comments for the cancelation.
      • CreatedBy; string; User who created the action request.
      • CreationDate; string; Date on which action request is created.
      • CustomerPOLineNumber; string; Value that uniquely identifies the purchase order line. The purchase order line describes the item or service and it includes the price and quantity ordered.
      • CustomerPONumber; string; Value that identifies the purchase order.
      • DemandClass; string; Demand class that represents a group of customers, such as government, commercial, sales channel, or region. Demand class can represent different sources of demand, such as retail, mail order, or wholesale. A list of accepted values is defined in the lookup type ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
      • DemandClassCode; string; Abbreviation that identifies the demand class. A list of accepted values is defined in the lookup ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
      • EarliestAcceptableDate; string; Value that identifies the earliest date the customer either requested to ship or deliver the order.
      • EnforceSingleShipmentFlag; boolean; Contains one of the following values: true or false. If true, during ship confirm the order line quantity that can't be shipped in one shipment is canceled. If false, then backorders with multiple shipments aren't canceled. This attribute can be set to true only if CancelBackordersFlag is also set to true. The default value is false.
      • FOBPoint; string; Freight on board. Identifies the ownership of the item while it is in transit. A list of accepted values is defined in the lookup type ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
      • FOBPointCode; string; Abbreviation that identifies the freight on board. A list of accepted values is defined in the lookup ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
      • 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.
      • FreightTerms; string; Terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup type ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
      • FreightTermsCode; string; Abbreviation that identifies the terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
      • FulfillLineId; integer; Unique identifier for fulfillment line.
      • HeaderId; integer; Unique identifier for the sales order header.
      • HoldCode; string; Abbreviation that identifies the hold.
      • LastUpdateDate; string; Date on which action request was last updated.
      • LatestAcceptableDate; string; Value that identifies the latest date the customer either requested to ship or deliver the order.
      • MassActionFlag; boolean; Indicates that the action is a mass action.
      • OrderRevisionComments; string; Comments that detail the reason for revising the sales order.
      • OrderRevisionReasonCode; string; Abbreviation that identifies the reason to revise the sales order. A list of accepted values is defined in the lookup DOO_CHANGE_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
      • OutcomeCode; string; Code to indicate the outcome of the master action request. It can be SUCCESS or ERROR.
      • OverrideScheduleDateFlag; boolean; Contains one of the following values: true or false. If true, then the user can manually override the scheduled date. If false, then the user can't override it. The default value is false.
      • PackingInstructions; string; Document that contains packing details for the item.
      • PaymentTerms; string; Payment terms to use to collect payment.
      • PaymentTermsCode; integer; Abbreviation that identifies payment terms.
      • ProcessId; integer; Unique identifier for the process to initiate the process in the request resource.
      • ProcessStatus; string; 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.
      • RequestType; string; Specifies whether the scheduling request is ship or arrival.
      • RequestTypeCode; string; Abbreviation that identifies the type of scheduling request.
      • RequestedDate; string; Value that identifies the date the customer either requested to ship or deliver the order.
      • RequestedFulfillmentOrganizationCode; string; Abbreviation that identifies the organization that ships the shipment.
      • RequestedFulfillmentOrganizationId; integer; Value that uniquely identifies the organization that fulfills the item. If the item is shippable, then this value references the warehouse that ships the item. A contract or an agreement is an example of an item that isn't shippable.
      • RequestedFulfillmentOrganizationName; string; Name of the organization that ships the shipment.
      • 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.
      • SalespersonId; integer; Value that identifies the primary salesperson.
      • ScheduleArrivalDate; string; Date when the application scheduled the shipment to arrive.
      • ScheduleShipDate; string; Date when the application scheduled the shipment to ship.
      • ShipSetName; string; Group of order lines in the sales order that must ship together from one location to one destination, and that use the same scheduled ship date.
      • ShipmentPriority; string; Priority of shipment that allows you to group shipments into different categories depending on the urgency. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
      • ShipmentPriorityCode; string; Abbreviation that identifies the priority of the shipment. A list of accepted values is defined in the lookup WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
      • ShippingCarrier; string; Value that uniquely identifies the carrier who delivered the item.
      • ShippingCarrierId; integer; Value that uniquely identifies the carrier that delivered the item.
      • ShippingInstructions; string; Detailed instructions about cargo and other requirements for shipping.
      • ShippingMode; string; Mode of shipping that delivers the item. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
      • ShippingModeCode; string; Abbreviation that identifies the mode of shipping that delivers the shipment. A list of accepted values is defined in the lookup WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
      • ShippingServiceLevel; string; Level of service for the shipping that delivers the shipment. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
      • ShippingServiceLevelCode; string; Abbreviation that identifies the shipping level of service to use to deliver the shipment. A list of accepted values is defined in the lookup WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
      • StatusCode; string; Code to indicate the status of the master action request such as COMPLETE, PRE_PROCESSING, or PROCESSING.
      • Subinventory; string; Physical or logical location of the item.
      • SubinventoryCode; string; Abbreviation that identifies the physical or logical location of the item.
      • SupplierId; integer; Value that uniquely identifies the supplier for the purchase order.
      • SupplierName; string; Name of the supplier who supplies the item. You can use a supplier according to a contractual obligation in drop ship.
      • SupplierSiteId; integer; Value that uniquely identifies the supplier site for the purchase order.
      • SupplierSiteName; string; Name of the supplier site for the purchase order.
      • TotalFailed; integer; Total number of records failed to process by the action request.
      • TotalPassed; integer; Total number of records successfully processed by the action request.
      • TotalRecords; integer; Total number of records processed by the action request.
      • TransactionLineTypeCode; string; Type of action in the channel system. For example, buy, replace with, return for credit, upgrade, and so on.
    • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
    Header Parameters
    • 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".
    • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

    There's no request body for this operation.

    Back to Top

    Response

    Supported Media Types

    Default Response

    The following table describes the default response for this task.
    Headers
    • 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".
    • 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
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : salesOrderActionRequests-item-response
    Type: object
    Show Source
    • Read Only: true
      Maximum Length: 255
      Value attribute for the action such as Submit Order, Cancel Order, Reprice Order, or Cancel Line.
    • Maximum Length: 30
      Code such as ORA_FOM_SUBMIT_ORDER to identify the action.
    • Unique identifier for the master action request.
    • Identifier to track action requests.
    • Maximum Length: 10000
      Additional details that extensible flexfields store for the sales order.
    • Maximum Length: 1
      Contains one of the following values: true or false. If true, then order lines backordered during picking or shipping are canceled. If false, then backorders aren't canceled. The default value is false.
    • Code to indicate the reason for the cancelation.
    • Contains user comments for the cancelation.
    • Read Only: true
      Maximum Length: 64
      User who created the action request.
    • Read Only: true
      Date on which action request is created.
    • Maximum Length: 50
      Value that uniquely identifies the purchase order line. The purchase order line describes the item or service and it includes the price and quantity ordered.
    • Maximum Length: 50
      Value that identifies the purchase order.
    • Maximum Length: 255
      Demand class that represents a group of customers, such as government, commercial, sales channel, or region. Demand class can represent different sources of demand, such as retail, mail order, or wholesale. A list of accepted values is defined in the lookup type ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
    • Maximum Length: 255
      Abbreviation that identifies the demand class. A list of accepted values is defined in the lookup ORA_DOO_DEMAND_CLASS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
    • Value that identifies the earliest date the customer either requested to ship or deliver the order.
    • Maximum Length: 1
      Contains one of the following values: true or false. If true, during ship confirm the order line quantity that can't be shipped in one shipment is canceled. If false, then backorders with multiple shipments aren't canceled. This attribute can be set to true only if CancelBackordersFlag is also set to true. The default value is false.
    • 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.
    • Maximum Length: 255
      Freight on board. Identifies the ownership of the item while it is in transit. A list of accepted values is defined in the lookup type ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
    • Maximum Length: 30
      Abbreviation that identifies the freight on board. A list of accepted values is defined in the lookup ORA_FOB. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
    • Maximum Length: 255
      Terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup type ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
    • Maximum Length: 30
      Abbreviation that identifies the terms for paying freight charges. For example, paid by shipper, collect, or prepaid. A list of accepted values is defined in the lookup ORA_FREIGHT_TERMS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
    • Unique identifier for fulfillment line.
    • Unique identifier for the sales order header.
    • Abbreviation that identifies the hold.
    • Read Only: true
      Date on which action request was last updated.
    • Value that identifies the latest date the customer either requested to ship or deliver the order.
    • Links
    • Maximum Length: 1
      Default Value: false
      Indicates that the action is a mass action.
    • Maximum Length: 255
      Comments that detail the reason for revising the sales order.
    • Maximum Length: 255
      Abbreviation that identifies the reason to revise the sales order. A list of accepted values is defined in the lookup DOO_CHANGE_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Order Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
    • Maximum Length: 30
      Code to indicate the outcome of the master action request. It can be SUCCESS or ERROR.
    • Maximum Length: 1
      Contains one of the following values: true or false. If true, then the user can manually override the scheduled date. If false, then the user can't override it. The default value is false.
    • Maximum Length: 1000
      Document that contains packing details for the item.
    • Maximum Length: 255
      Payment terms to use to collect payment.
    • Abbreviation that identifies payment terms.
    • Read Only: true
      Unique identifier for the process to initiate the process in the request resource.
    • 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.
    • Reason for releasing the hold.
    • Value that identifies the date the customer either requested to ship or deliver the order.
    • Maximum Length: 255
      Abbreviation that identifies the organization that ships the shipment.
    • Value that uniquely identifies the organization that fulfills the item. If the item is shippable, then this value references the warehouse that ships the item. A contract or an agreement is an example of an item that isn't shippable.
    • Maximum Length: 255
      Name of the organization that ships the shipment.
    • Requests
      Title: Requests
      The request executes the action performed on the sales order. It's a child of the action request.
    • Maximum Length: 255
      Specifies whether the scheduling request is ship or arrival.
    • Maximum Length: 30
      Abbreviation that identifies the type of scheduling request.
    • 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.
    • Value that identifies the primary salesperson.
    • Date when the application scheduled the shipment to arrive.
    • Date when the application scheduled the shipment to ship.
    • Maximum Length: 255
      Priority of shipment that allows you to group shipments into different categories depending on the urgency. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
    • Maximum Length: 30
      Abbreviation that identifies the priority of the shipment. A list of accepted values is defined in the lookup WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
    • Maximum Length: 255
      Value that uniquely identifies the carrier who delivered the item.
    • Value that uniquely identifies the carrier that delivered the item.
    • Maximum Length: 1000
      Detailed instructions about cargo and other requirements for shipping.
    • Maximum Length: 255
      Mode of shipping that delivers the item. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
    • Maximum Length: 255
      Abbreviation that identifies the mode of shipping that delivers the shipment. A list of accepted values is defined in the lookup WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
    • Maximum Length: 255
      Level of service for the shipping that delivers the shipment. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
    • Maximum Length: 255
      Abbreviation that identifies the shipping level of service to use to deliver the shipment. A list of accepted values is defined in the lookup WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task. To collect data for this attribute, use the Collect Order Reference Data task for Fusion Source.
    • Maximum Length: 50
      Group of order lines in the sales order that must ship together from one location to one destination, and that use the same scheduled ship date.
    • Maximum Length: 30
      Default Value: PRE_PROCESSING
      Code to indicate the status of the master action request such as COMPLETE, PRE_PROCESSING, or PROCESSING.
    • Maximum Length: 255
      Physical or logical location of the item.
    • Maximum Length: 255
      Abbreviation that identifies the physical or logical location of the item.
    • Value that uniquely identifies the supplier for the purchase order.
    • Maximum Length: 255
      Name of the supplier who supplies the item. You can use a supplier according to a contractual obligation in drop ship.
    • Value that uniquely identifies the supplier site for the purchase order.
    • Maximum Length: 255
      Name of the supplier site for the purchase order.
    • Read Only: true
      Total number of records failed to process by the action request.
    • Read Only: true
      Total number of records successfully processed by the action request.
    • Read Only: true
      Total number of records processed by the action request.
    • Maximum Length: 30
      Type of action in the channel system. For example, buy, replace with, return for credit, upgrade, and so on.
    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
    Nested Schema : salesOrderActionRequests-requests-item-response
    Type: object
    Show Source
    Nested Schema : Message Details
    Type: array
    Title: Message Details
    The Message Details resource fetches the details of the messages logged for the action request.
    Show Source
    Nested Schema : Order Details
    Type: array
    Title: Order Details
    Order Details resource fetches the order details of the sales order processed by the request.
    Show Source
    Nested Schema : Order Line Details
    Type: array
    Title: Order Line Details
    The Order Line Details resource fetches the order line details of the sales order processed by the request.
    Show Source
    Nested Schema : salesOrderActionRequests-requests-messageDetails-item-response
    Type: object
    Show Source
    Nested Schema : salesOrderActionRequests-requests-orderDetails-item-response
    Type: object
    Show Source
    • Read Only: true
      Maximum Length: 255
      Sold-to party name of the customer on the sales order.
    • Read Only: true
      Maximum Length: 30
      Identifies the interface using which the order was captured such as OrderImport, REST_salesOrdersForOrderHub, REST_omSalesOrders, or UI.
    • Title: Purchase Order
      Read Only: true
      Maximum Length: 50
      Customer purchase order of the sales order processed by the action request.
    • Read Only: true
      Unique identifier for the sales order header.
    • Links
    • Title: Orchestration Order
      Read Only: true
      Maximum Length: 50
      Default Value: -1
      Identifier of the sales order number.
    • Read Only: true
      Value that identifies the revision number of the order.
    • Read Only: true
      Unique identifier of the sold-to party on the sales order.
    • Title: Source Order
      Read Only: true
      Maximum Length: 50
      Unique identifier for the sales order in the source system.
    • Read Only: true
      Maximum Length: 255
      Status of the sales order.
    • Read Only: true
      Maximum Length: 30
      Default Value: OPEN
      Code to identify the status of the sales order such as DRAFT, PROCESSING, or CLOSED.
    Nested Schema : salesOrderActionRequests-requests-orderLineDetails-item-response
    Type: object
    Show Source
    Back to Top

    Examples

    This example describes how to get details of all sales order action requests.

    Example cURL Command

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

    curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrderActionRequests"

    Example Response Body

    The following example includes the contents of the response body in JSON format:
    {
  "items" : [ {
    "ActionCode" : "ORA_FOM_SUBMIT_ORDER",
    "ActionRequestId" : 300100582712043,
    "ActionRequestTrackingId" : 270717,
    "CreatedBy" : "SCMOPERATIONS",
    "CreationDate" : "2023-09-15T05:42:46.002+00:00",
    "FulfillLineId" : null,
    "HeaderId" : -1,
    "LastUpdateDate" : "2023-09-15T05:42:46.150+00:00",
    "MassActionFlag" : true,
    "OutcomeCode" : "ERROR",
    "StatusCode" : "COMPLETE",
    "Action" : "Submit Order",
    "ProcessId" : 41510,
    "TotalRecords" : 1,
    "TotalFailed" : 1,
    "TotalPassed" : 0,
    "ProcessStatus" : "COMPLETED_WITH_ERRORS",
    "FilterCriteria" : null,
    "Comments" : null,
    "CancelReasonCode" : null,
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100582712043",
      "name" : "salesOrderActionRequests",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100582712043",
      "name" : "salesOrderActionRequests",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100582712043/child/requests",
      "name" : "requests",
      "kind" : "collection"
    } ]
  }, {
    "ActionCode" : "ORA_FOM_SUBMIT_ORDER",
    "ActionRequestId" : 300100582712044,
    "ActionRequestTrackingId" : 270717,
    "CreatedBy" : "SCMOPERATIONS",
    "CreationDate" : "2023-09-15T05:42:46.147+00:00",
    "FulfillLineId" : null,
    "HeaderId" : 300100582710255,
    "LastUpdateDate" : "2023-09-15T05:43:03+00:00",
    "MassActionFlag" : false,
    "OutcomeCode" : "ERROR",
    "StatusCode" : "COMPLETE",
    "Action" : "Submit Order",
    "ProcessId" : null,
    "TotalRecords" : null,
    "TotalFailed" : null,
    "TotalPassed" : null,
    "ProcessStatus" : null,
    "FilterCriteria" : null,
    "Comments" : null,
    "CancelReasonCode" : null,
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100582712044",
      "name" : "salesOrderActionRequests",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100582712044",
      "name" : "salesOrderActionRequests",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100582712044/child/requests",
      "name" : "requests",
      "kind" : "collection"
    } ]
  }, 
  ....
  ....
   {
    "ActionCode" : "ORA_FOM_SUBMIT_ORDER",
    "ActionRequestId" : 300100587379652,
    "ActionRequestTrackingId" : 307774,
    "CreatedBy" : "SCMOPERATIONS",
    "CreationDate" : "2023-09-22T16:26:01.003+00:00",
    "FulfillLineId" : null,
    "HeaderId" : 300100159179760,
    "LastUpdateDate" : "2023-09-22T16:26:10+00:00",
    "MassActionFlag" : false,
    "OutcomeCode" : "ERROR",
    "StatusCode" : "COMPLETE",
    "Action" : "Submit Order",
    "ProcessId" : null,
    "TotalRecords" : null,
    "TotalFailed" : null,
    "TotalPassed" : null,
    "ProcessStatus" : null,
    "FilterCriteria" : null,
    "Comments" : null,
    "CancelReasonCode" : null,
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379652",
      "name" : "salesOrderActionRequests",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379652",
      "name" : "salesOrderActionRequests",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379652/child/requests",
      "name" : "requests",
      "kind" : "collection"
    } ]
  }, {
    "ActionCode" : "ORA_FOM_SUBMIT_ORDER",
    "ActionRequestId" : 300100587379653,
    "ActionRequestTrackingId" : 307774,
    "CreatedBy" : "SCMOPERATIONS",
    "CreationDate" : "2023-09-22T16:26:01.004+00:00",
    "FulfillLineId" : null,
    "HeaderId" : 300100152676621,
    "LastUpdateDate" : "2023-09-22T16:26:09+00:00",
    "MassActionFlag" : false,
    "OutcomeCode" : "ERROR",
    "StatusCode" : "COMPLETE",
    "Action" : "Submit Order",
    "ProcessId" : null,
    "TotalRecords" : null,
    "TotalFailed" : null,
    "TotalPassed" : null,
    "ProcessStatus" : null,
    "FilterCriteria" : null,
    "Comments" : null,
    "CancelReasonCode" : null,
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379653",
      "name" : "salesOrderActionRequests",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379653",
      "name" : "salesOrderActionRequests",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379653/child/requests",
      "name" : "requests",
      "kind" : "collection"
    } ]
  }, {
    "ActionCode" : "ORA_FOM_SUBMIT_ORDER",
    "ActionRequestId" : 300100587379654,
    "ActionRequestTrackingId" : 307774,
    "CreatedBy" : "SCMOPERATIONS",
    "CreationDate" : "2023-09-22T16:26:01.005+00:00",
    "FulfillLineId" : null,
    "HeaderId" : 300100152859477,
    "LastUpdateDate" : "2023-09-22T16:26:09+00:00",
    "MassActionFlag" : false,
    "OutcomeCode" : "ERROR",
    "StatusCode" : "COMPLETE",
    "Action" : "Submit Order",
    "ProcessId" : null,
    "TotalRecords" : null,
    "TotalFailed" : null,
    "TotalPassed" : null,
    "ProcessStatus" : null,
    "FilterCriteria" : null,
    "Comments" : null,
    "CancelReasonCode" : null,
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379654",
      "name" : "salesOrderActionRequests",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379654",
      "name" : "salesOrderActionRequests",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379654/child/requests",
      "name" : "requests",
      "kind" : "collection"
    } ]
  }, {
    "ActionCode" : "ORA_FOM_SUBMIT_ORDER",
    "ActionRequestId" : 300100587379655,
    "ActionRequestTrackingId" : 307774,
    "CreatedBy" : "SCMOPERATIONS",
    "CreationDate" : "2023-09-22T16:26:01.007+00:00",
    "FulfillLineId" : null,
    "HeaderId" : 300100151165022,
    "LastUpdateDate" : "2023-09-22T16:26:10+00:00",
    "MassActionFlag" : false,
    "OutcomeCode" : "ERROR",
    "StatusCode" : "COMPLETE",
    "Action" : "Submit Order",
    "ProcessId" : null,
    "TotalRecords" : null,
    "TotalFailed" : null,
    "TotalPassed" : null,
    "ProcessStatus" : null,
    "FilterCriteria" : null,
    "Comments" : null,
    "CancelReasonCode" : null,
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379655",
      "name" : "salesOrderActionRequests",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379655",
      "name" : "salesOrderActionRequests",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests/300100587379655/child/requests",
      "name" : "requests",
      "kind" : "collection"
    } ]
  } ],
  "count" : 25,
  "hasMore" : true,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/salesOrderActionRequests",
    "name" : "salesOrderActionRequests",
    "kind" : "collection"
  } ]
}
    Back to Top