Jump to

• Request
• Response

Create one request

post

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

Request

Path Parameters

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

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActionCode(required): string
  Maximum Length: 30

  Code to identify the action.
• ActionRequestId: integer (int64)
  Unique identifier for the child action request.
• ActionRequestTrackingId(required): integer (int64)
  Identifier to track action requests in the request resource.
• FulfillLineId: integer (int64)
  Uniquer identifier for fulfilment line.
• HeaderId(required): integer (int64)
  Unique identifier for the saler order header.
• MassActionFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates that the action is a mass action.
• orderDetails: array OrderDetails
  Title: OrderDetails

  Order Details resource fetches the order details of the sales order processed by the request.
• OutcomeCode: string
  Maximum Length: 30

  Code to indicate the outcome of the child action request. These can be SUCCESS, ERROR.
• StatusCode: string
  Maximum Length: 30

  Default Value: PRE_PROCESSING

  Code to indicate the status of the child action request. COMPLETE, PRE_PROCESSING, PROCESSING etc.

{
    "required":[
        "ActionCode",
        "ActionRequestTrackingId",
        "HeaderId"
    ],
    "type":"object",
    "properties":{
        "FulfillLineId":{
            "type":"integer",
            "description":"Uniquer identifier for fulfilment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ActionRequestTrackingId":{
            "type":"integer",
            "description":"Identifier to track action requests in the request resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "orderDetails":{
            "title":"OrderDetails",
            "type":"array",
            "description":"Order Details resource fetches the order details of the sales order processed by the request.",
            "items":{
                "$ref":"#/components/schemas/salesOrderActionRequests-requests-orderDetails-item-post-request"
            },
            "x-cardinality":"1"
        },
        "OutcomeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code to indicate the outcome of the child action request. These can be SUCCESS, ERROR.",
            "nullable":true
        },
        "MassActionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the action is a mass action.",
            "nullable":false,
            "default":false
        },
        "ActionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code to identify the action.",
            "nullable":false
        },
        "HeaderId":{
            "type":"integer",
            "description":"Unique identifier for the saler order header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ActionRequestId":{
            "type":"integer",
            "description":"Unique identifier for the child action request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code to indicate the status of the child action request. COMPLETE, PRE_PROCESSING, PROCESSING etc.",
            "nullable":false,
            "default":"PRE_PROCESSING"
        }
    }
}

Nested Schema : OrderDetails

Type: array

Title: OrderDetails

Order Details resource fetches the order details of the sales order processed by the request.

Show Source

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

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

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

Type: object

Show Source

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

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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-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 request resource.
• FulfillLineId: integer (int64)
  Uniquer identifier for fulfilment line.
• HeaderId: integer (int64)
  Unique identifier for the saler 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.
• orderDetails: array OrderDetails
  Title: OrderDetails

  Order Details resource fetches the order details of the sales order processed by the request.
• OutcomeCode: string
  Maximum Length: 30

  Code to indicate the outcome of the child action request. These can be SUCCESS, ERROR.
• RequestStatus: string
  Read Only: true

  Maximum Length: 255

  Contains status of the order submission child request.
• StatusCode: string
  Maximum Length: 30

  Default Value: PRE_PROCESSING

  Code to indicate the status of the child action request. COMPLETE, PRE_PROCESSING, PROCESSING etc.
• SummaryMessageText: string
  Read Only: true

  Maximum Length: 1000

  Contains errors, warnings, information messages on the sales order or on process.

{
    "type":"object",
    "properties":{
        "SummaryMessageText":{
            "maxLength":1000,
            "type":"string",
            "description":"Contains errors, warnings, information messages on the sales order or on process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FulfillLineId":{
            "type":"integer",
            "description":"Uniquer identifier for fulfilment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionRequestTrackingId":{
            "type":"integer",
            "description":"Identifier to track action requests in the request resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "orderDetails":{
            "title":"OrderDetails",
            "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"
        },
        "OutcomeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code to indicate the outcome of the child action request. These can be SUCCESS, 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 saler 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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code to indicate the status of the child action request. COMPLETE, PRE_PROCESSING, PROCESSING etc.",
            "nullable":false,
            "default":"PRE_PROCESSING",
            "x-queryable":true
        },
        "RequestStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Contains status of the order submission child request.",
            "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 : OrderDetails

Type: array

Title: OrderDetails

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":"OrderDetails",
    "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 : 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-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.
• CustomerPONumber: string
  Title: Purchase Order

  Read Only: true

  Maximum Length: 50

  Code to identify the customer purchase order of the sales order processed by the action request.
• HeaderId: integer (int64)
  Read Only: true

  Unique identifier for the saler 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

  Identifer of the sales order number.
• SoldToPartyId: integer (int64)
  Read Only: true

  Unique identifier of the customer These can be DRAFT, PROCESSING etc.
• SourceOrderNumber: string
  Title: Source Order

  Read Only: true

  Maximum Length: 50

  Unique identifier for the saler 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 status of the sales order. These can be DRAFT, PROCESSING etc.

{
    "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":"Code to identify the 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 saler order in the source system.",
            "nullable":false,
            "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
        },
        "HeaderId":{
            "type":"integer",
            "description":"Unique identifier for the saler 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":"Identifer of the sales order number.",
            "nullable":false,
            "readOnly":true,
            "default":"-1",
            "x-queryable":true
        },
        "SoldToPartyId":{
            "type":"integer",
            "description":"Unique identifier of the customer These can be DRAFT, PROCESSING etc.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code to identify status of the sales order. These can be DRAFT, PROCESSING etc.",
            "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"
    }
}

Links

orderDetails

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

Parameters:

• ActionRequestId: $request.path.ActionRequestId
• ActionRequestId2: $request.path.ActionRequestId2

Order Details resource fetches the order details of the sales order processed by the request.

Back to Top