Jump to

• Request
• Response
• Examples

Get one sales order action request

get

/fscmRestApi/resources/11.13.18.05/salesOrderActionRequests/{ActionRequestId}

Request

Path Parameters

• ActionRequestId(required): integer(int64)
  Unique identifier for the master action request.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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.
• AdditionalInformation: string
  Maximum Length: 10000

  Additional details that extensible flexfields store for the sales order.
• CancelBackordersFlag: boolean
  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.
• 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.
• CustomerPOLineNumber: string
  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.
• CustomerPONumber: string
  Maximum Length: 50

  Value that identifies the purchase order.
• DemandClass: string
  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.
• DemandClassCode: string
  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.
• EarliestAcceptableDate: string (date-time)
  Value that identifies the earliest date the customer either requested to ship or deliver the order.
• EnforceSingleShipmentFlag: boolean
  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.
• 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.
• FOBPoint: string
  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.
• FOBPointCode: string
  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.
• FreightTerms: string
  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.
• FreightTermsCode: string
  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.
• 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.
• LatestAcceptableDate: string (date-time)
  Value that identifies the latest date the customer either requested to ship or deliver the order.
• 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.
• OrderRevisionComments: string
  Maximum Length: 255

  Comments that detail the reason for revising the sales order.
• OrderRevisionReasonCode: string
  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.
• OutcomeCode: string
  Maximum Length: 30

  Code to indicate the outcome of the master action request. It can be SUCCESS or ERROR.
• OverrideScheduleDateFlag: boolean
  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.
• PackingInstructions: string
  Maximum Length: 1000

  Document that contains packing details for the item.
• PaymentTerms: string
  Maximum Length: 255

  Payment terms to use to collect payment.
• PaymentTermsCode: integer
  Abbreviation that identifies payment terms.
• 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.
• RequestedDate: string (date-time)
  Value that identifies the date the customer either requested to ship or deliver the order.
• RequestedFulfillmentOrganizationCode: string
  Maximum Length: 255

  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
  Maximum Length: 255

  Name of the organization that ships the shipment.
• requests: array Requests
  Title: Requests

  The request executes the action performed on the sales order. It's a child of the action request.
• RequestType: string
  Maximum Length: 255

  Specifies whether the scheduling request is ship or arrival.
• RequestTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of scheduling request.
• RequireReasonCodeFlag: boolean
  Contains one of the following values: true or false. If true, then you must send a reason code. If false, then it's optional for you to send a reason code. The default value is false.
• SalespersonId: integer
  Value that identifies the primary salesperson.
• ScheduleArrivalDate: string (date-time)
  Date when the application scheduled the shipment to arrive.
• ScheduleShipDate: string (date-time)
  Date when the application scheduled the shipment to ship.
• ShipmentPriority: string
  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.
• ShipmentPriorityCode: string
  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.
• ShippingCarrier: string
  Maximum Length: 255

  Value that uniquely identifies the carrier who delivered the item.
• ShippingCarrierId: integer
  Value that uniquely identifies the carrier that delivered the item.
• ShippingInstructions: string
  Maximum Length: 1000

  Detailed instructions about cargo and other requirements for shipping.
• ShippingMode: string
  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.
• ShippingModeCode: string
  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.
• ShippingServiceLevel: string
  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.
• ShippingServiceLevelCode: string
  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.
• ShipSetName: string
  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.
• 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.
• Subinventory: string
  Maximum Length: 255

  Physical or logical location of the item.
• SubinventoryCode: string
  Maximum Length: 255

  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
  Maximum Length: 255

  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
  Maximum Length: 255

  Name of the supplier site for the purchase order.
• 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.
• TransactionLineTypeCode: string
  Maximum Length: 30

  Type of action in the channel system. For example, buy, replace with, return for credit, upgrade, and so on.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date on which action request is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "ShipSetName":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "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
        },
        "ShippingInstructions":{
            "maxLength":"1000",
            "type":"string",
            "description":"Detailed instructions about cargo and other requirements for shipping.",
            "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
        },
        "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
        },
        "OrderRevisionReasonCode":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalRecords":{
            "type":"integer",
            "description":"Total number of records processed by the action request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShippingMode":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequestedDate":{
            "type":"string",
            "description":"Value that identifies the date the customer either requested to ship or deliver the order.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ShippingCarrierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the carrier that delivered the item.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the organization that ships the shipment.",
            "nullable":true,
            "x-queryable":true
        },
        "LatestAcceptableDate":{
            "type":"string",
            "description":"Value that identifies the latest date the customer either requested to ship or deliver the order.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the organization that ships the shipment.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the action request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestedFulfillmentOrganizationId":{
            "type":"integer",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderRevisionComments":{
            "maxLength":"255",
            "type":"string",
            "description":"Comments that detail the reason for revising the sales order.",
            "nullable":true,
            "x-queryable":true
        },
        "ShippingModeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "FOBPoint":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "FulfillLineId":{
            "type":"integer",
            "description":"Unique identifier for fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerPOLineNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionRequestTrackingId":{
            "type":"integer",
            "description":"Identifier to track action requests.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier for the purchase order.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleShipDate":{
            "type":"string",
            "description":"Date when the application scheduled the shipment to ship.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CancelReasonCode":{
            "type":"string",
            "description":"Code to indicate the reason for the cancelation.",
            "nullable":true,
            "x-queryable":true
        },
        "EarliestAcceptableDate":{
            "type":"string",
            "description":"Value that identifies the earliest date the customer either requested to ship or deliver the order.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RequestType":{
            "maxLength":"255",
            "type":"string",
            "description":"Specifies whether the scheduling request is ship or arrival.",
            "nullable":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
        },
        "FOBPointCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "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
        },
        "TransactionLineTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of action in the channel system. For example, buy, replace with, return for credit, upgrade, and so on.",
            "nullable":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
        },
        "SupplierSiteName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier site for the purchase order.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentTerms":{
            "maxLength":"255",
            "type":"string",
            "description":"Payment terms to use to collect payment.",
            "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"
            }
        },
        "OverrideScheduleDateFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the physical or logical location of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelBackordersFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipmentPriorityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerPONumber":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that identifies the purchase order.",
            "nullable":true,
            "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
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site for the purchase order.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of scheduling request.",
            "nullable":true,
            "x-queryable":true
        },
        "SalespersonId":{
            "type":"integer",
            "description":"Value that identifies the primary salesperson.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalPassed":{
            "type":"integer",
            "description":"Total number of records successfully processed by the action request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalInformation":{
            "maxLength":"10000",
            "type":"string",
            "description":"Additional details that extensible flexfields store for the sales order.",
            "nullable":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
        },
        "ShippingServiceLevel":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ShippingServiceLevelCode":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleArrivalDate":{
            "type":"string",
            "description":"Date when the application scheduled the shipment to arrive.",
            "format":"date-time",
            "nullable":true,
            "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
        },
        "DemandClass":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PackingInstructions":{
            "maxLength":"1000",
            "type":"string",
            "description":"Document that contains packing details for the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ShippingCarrier":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the carrier who delivered the item.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentTermsCode":{
            "type":"integer",
            "description":"Abbreviation that identifies payment terms.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipmentPriority":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier who supplies the item. You can use a supplier according to a contractual obligation in drop ship.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandClassCode":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "FreightTermsCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Subinventory":{
            "maxLength":"255",
            "type":"string",
            "description":"Physical or logical location of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "HoldCode":{
            "type":"string",
            "description":"Abbreviation that identifies the hold.",
            "nullable":true,
            "x-queryable":true
        },
        "EnforceSingleShipmentFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "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
        },
        "FreightTerms":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "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

This example describes how to get details of one master action request.

We can see the details of the master action request ID 300100608436027. ActionCode denotes that the request is for the order submission. This master request displays TotalRecords 3, TotalFailed 2 and TotalPassed 1, indicating that it processed 3 child requests out of which 2 failed and one has passed.

StatusCode displays that the process has completed and OutcomeCode denotes that some child action requests may be in ERROR. Based on this the ProcessStatus indicates the status of the master action request is set as COMPLETED WITH ERRORS.

Example cURL Command

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

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

For example:

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

Example Response Body

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

{
    "ActionCode": "ORA_FOM_SUBMIT_ORDER",
    "ActionRequestId": 300100608436027,
    "ActionRequestTrackingId": 427736,
    "CreatedBy": "SCMOPERATIONS",
    "CreationDate": "2023-10-20T06:19:28.001+00:00",
    "FulfillLineId": null,
    "HeaderId": -1,
    "LastUpdateDate": "2023-10-20T06:19:28.102+00:00",
    "MassActionFlag": true,
    "OutcomeCode": "ERROR",
    "StatusCode": "COMPLETE",
    "Action": "Submit Order",
    "ProcessId": 474122,
    "TotalRecords": 3,
    "TotalFailed": 2,
    "TotalPassed": 1,
    "ProcessStatus": "COMPLETED_WITH_ERRORS",
    "FilterCriteria": null
}

Back to Top