Get one detail
get
/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/lines/{linesUniqID}/child/lineDetails/{FulfillLineDetailId}
Request
Path Parameters
-
FulfillLineDetailId(required): integer(int64)
Value that uniquely identifies details for the fulfillment line.
-
OrderKey(required): string
Value that uniquely identifies the sales order. It can have the following formats.
- Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".
- Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.
When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId. -
linesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines to get the hash key.
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 TopResponse
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.
Root Schema : salesOrdersForOrderHub-lines-lineDetails-item-response
Type:
Show Source
object
-
ActualDeliveryDate: string
(date-time)
Date when the carrier delivered the item that the fulfillment line contains.
-
AvailabilityShipDate: string
(date-time)
Ship date for each fulfillment line that the carrier sends to order management.
-
BillingTransactionAmount: number
Title:
Charge Amount
Amount of the billing transaction. -
BillingTransactionDate: string
(date-time)
Title:
Invoice Date
Date on the customer invoice. The application uses this date to calculate the invoice due date according to the payment terms for the customer. -
BillingTransactionNumber: string
Title:
Invoice Number
Maximum Length:30
Value that uniquely identifies the billing transaction. -
BillOfLadingNumber: string
Title:
Bill of Lading
Maximum Length:120
Contract and receipt from the carrier for the item that the carrier agrees to transport to the destination address. -
CustomerTransactionLineId: integer
(int64)
Value that uniquely identifies the billing line.
-
DeliveryName: string
Title:
Delivery
Maximum Length:120
Group of items that the carrier carries under the terms of one bill of lading. -
ExceptionFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the available-to-ship date for the line on the supply order has past the requested date, or supply is not available for the fulfillment line. If false, then this available-to-ship date has not past the requested date, or supply is available for the fulfillment line. -
FulfillLineDetailId: integer
(int64)
Value that uniquely identifies details for the fulfillment line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Quantity: number
Title:
Shipped Quantity
Quantity of the item that the supplier fulfilled. -
RMAReceiptDate: string
(date)
Date when the fulfillment application sent the receipt.
-
RMAReceiptDateTime: string
(date-time)
Date and time when the fulfillment application sent the receipt.
-
RMAReceiptLineNumber: string
Maximum Length:
50
Line number of the receipt sent by the receiving application. -
RMAReceiptNumber: string
Maximum Length:
50
Receipt header number sent by the receiving application. -
RMAReceiptTransactionId: string
Maximum Length:
18
Value that uniquely identifies receiving. -
SecondaryQuantity: number
Read Only:
true
Shipped, received, or delivered quantity on the fulfillment line for the item or service in the secondary unit of measure. This attribute is applicable when more than one unit of measure is used to measure and track the item. -
Status: string
Read Only:
true
Maximum Length:255
Status of the fulfillment line. -
StatusAsOfDate: string
(date-time)
Title:
Transaction Date
Date when the transaction occurred. -
StatusCode: string
Title:
Status
Maximum Length:30
Abbreviation that identifies the status of the fulfillment line. -
TaskType: string
Title:
Task Type
Maximum Length:50
Task classification that assigns default attributes to tasks and controls task processing. -
TrackingNumber: string
Title:
Tracking Number
Maximum Length:120
Unique value that the carriers provides to track shipment during transportation. -
TradeComplianceCode: string
Maximum Length:
30
Abbreviation that identifies the trade compliance screening. -
TradeComplianceExplanation: string
Maximum Length:
1000
Explanation that describes the result of trade compliance screening. -
TradeComplianceResultCode: string
Maximum Length:
30
Abbreviation that identifies the result of trade compliance screening. -
TradeComplianceType: string
Read Only:
true
Maximum Length:255
Type of trade compliance screening. -
TradeComplianceTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of trade compliance screening. -
WaybillNumber: string
Title:
Waybill Number
Maximum Length:30
Waybill or airbill number for the shipment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to get one detail.
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/salesOrdersForOrderHub/OrderKey/child/lines/linesUniqID/child/lineDetails/FulfillLineDetailId"
For example, the following command gets one detail. You muse use a hash key for FulfillLineId:
curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AFOM_1574942498623/child/lines/00020000000EACED00057708000110F0851697C30000000EACED00057708000110F0851697C2/child/lineDetails/300100187757277"
Example Response Body
The following shows an example of the response body in JSON format.
{ "ActualDeliveryDate" : null, "AvailabilityShipDate" : null, "BillOfLadingNumber" : null, "BillingTransactionAmount" : 1320, "BillingTransactionDate" : "2019-11-28T12:00:00+00:00", "BillingTransactionNumber" : "123021", "CustomerTransactionLineId" : 1538937, "DeliveryName" : null, "ExceptionFlag" : null, "FulfillLineDetailId" : 300100187757277, "Quantity" : null, "RMAReceiptDate" : null, "RMAReceiptLineNumber" : null, "RMAReceiptNumber" : null, "RMAReceiptTransactionId" : null, "StatusCode" : "BILLED", "Status" : "Billed", "StatusAsOfDate" : "2019-11-28T12:28:31+00:00", "TaskType" : "Invoice", "TrackingNumber" : null, "TradeComplianceCode" : null, "TradeComplianceExplanation" : null, "TradeComplianceResultCode" : null, "TradeComplianceTypeCode" : null, "TradeComplianceType" : null, "WaybillNumber" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AFOM_1574942498623/child/lines/00020000000EACED00057708000110F0851697C30000000EACED00057708000110F0851697C2/child/lineDetails/300100187757277", "name" : "lineDetails", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AFOM_1574942498623/child/lines/00020000000EACED00057708000110F0851697C30000000EACED00057708000110F0851697C2/child/lineDetails/300100187757277", "name" : "lineDetails", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AFOM_1574942498623/child/lines/00020000000EACED00057708000110F0851697C30000000EACED00057708000110F0851697C2", "name" : "lines", "kind" : "item" } ] }