Get one line
get
/fscmRestApi/resources/11.13.18.05/receivingReceiptExpectedShipmentLines/{receivingReceiptExpectedShipmentLinesUniqID}
Request
Path Parameters
-
receivingReceiptExpectedShipmentLinesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- SourceDocumentCode and DocumentLineId ---for the Receiving Receipt Expected Shipment Lines resource and used to uniquely identify an instance of Receiving Receipt Expected Shipment Lines. The client should not generate the hash key value. Instead, the client should query on the Receiving Receipt Expected Shipment Lines collection resource with a filter on the primary key values in order to navigate to a specific instance of Receiving Receipt Expected Shipment Lines.
For example: receivingReceiptExpectedShipmentLines?q=SourceDocumentCode=<value1>;DocumentLineId=<value2>
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: string
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: string
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:
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.
Root Schema : receivingReceiptExpectedShipmentLines-item-response
Type:
Show Source
object
-
AllowSubstituteReceipts: string
Read Only:
true
Maximum Length:1
Value that indicates whether substitute items can be received in place of the ordered items. -
ASNNumber: string
Read Only:
true
Maximum Length:30
Number that uniquely identifies the advanced shipment notice. -
AvailableQuantity: number
Read Only:
true
Quantity that is available to receive. -
BackToBack: string
Read Only:
true
Maximum Length:1
Contains one of the following values: Y or N. If Y, then use back-to-back shipping. If N, then reference a transfer order. Note that the order line for the supply source for the reservation references this purchase order. The default value is N. -
CategoryId: integer
(int64)
Read Only:
true
Value that uniquely identifies the category name. -
CategoryName: string
Read Only:
true
Maximum Length:250
Name of the category that classifies the item. A category groups items that possess similar characteristics, such as plastics, paints, inks, foods, and so on. -
ConsignedItems: string
Read Only:
true
Maximum Length:1
Contains one of the following values: Y or N. If Y, then the item is consigned. If N, then item is not consigned. The default value is N. -
CountryOfOriginCode: string
Read Only:
true
Maximum Length:2
Abbreviation that identifies the country of manufacture for this item. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the currency. -
CurrencyConversionDate: string
(date)
Read Only:
true
Currency conversion date. -
CurrencyConversionRate: number
Read Only:
true
Currency conversion rate. -
CurrencyConversionType: string
Read Only:
true
Maximum Length:30
Type of currency conversion rate. -
CustomerId: number
Read Only:
true
Value that uniquely identifies the customer. -
CustomerPartyName: string
Read Only:
true
Maximum Length:360
Name of the party who purchases the product, typically for a fee. -
DeliverToLocationId: integer
Read Only:
true
Value that uniquely identifies the delivery location. -
DeliverToPersonId: integer
Read Only:
true
Value that uniquely identifies the requestor. -
DestinationTypeCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the destination type for the item on the transaction line. It determines the accounting behavior of the transaction line. The RCV_DESTINATION_TYPE lookup defines the values that you can use with this attribute. -
DistributionCount: number
Read Only:
true
Value that represents the total number of distributions for the purchase order schedule or the transfer order line. -
DocumentLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the document line. -
DocumentLineNumber: string
Read Only:
true
Maximum Length:80
Line number for the document number. -
DocumentNumber: string
Read Only:
true
Maximum Length:80
Number that identifies the document. This attribute identifies one of the following: the purchase order number for the purchase order, advance shipment notice, or advance shipment billing notice; the number for the return material authorization for the source document code of type RMA; the in-transit shipment number for the source document code of type INVENTORY; or the transfer order number for the source document code of type TRANSFER ORDER. -
DocumentShipmentLineNumber: string
Read Only:
true
Maximum Length:80
Schedule number for the document line number. -
DocumentType: string
Read Only:
true
Maximum Length:80
Type of document according to the originating source, such as purchase order or return material authorization. A list of accepted values is defined in the lookup type RCV_SOURCE_DOCUMENT_TYPE. -
DueDate: string
(date)
Read Only:
true
Date when the warehouse expects to receive the item. -
EffectiveLocatorControl: integer
Read Only:
true
Value that indicates the locator control. -
EnforceShipToLocationCode: string
Read Only:
true
Maximum Length:25
Value that indicates what action is taken when the receiving location differs from the ship-to location. -
FromItemLotControlCode: integer
Read Only:
true
Value that indicates the ability to use lot numbers during material transactions for tracking batches of the item in the source organization. A list of accepted values is defined in the lookup EGP_LOT_CONTROL_CODE_TYPE. -
FromItemSerialNumberControlCode: integer
Read Only:
true
Value that identifies the number assigned to each unit of an item and is used to track the item in the source organization. A list of accepted values is defined in the lookup EGP_SERIAL_NUMBER_CONTROL_TYPE. -
FromOrganizationCode: string
Read Only:
true
Abbreviation that identifies the organization that is the point of origin of the in-transit shipment. This value is empty for purchase orders, RMAs and advanced shipment notices. -
FromOrganizationId: number
Read Only:
true
Value that uniquely identifies the organization that is the point of origin of the shipment. This value is empty for purchase orders and advance shipment notices. -
HeaderNoteToReceiver: string
Read Only:
true
Maximum Length:1000
Note to the receiver on the header. -
IntegrationStatus: string
Read Only:
true
Maximum Length:80
Value that indicates the meaning of the integration of the status code column. -
IntegrationStatusCode: string
Read Only:
true
Maximum Length:25
Value that indicates if the shipment is interfaced to the external system. -
IntransitShipmentNumber: string
Read Only:
true
Maximum Length:30
Number that uniquely identifies the in-transit shipment header. -
InvoiceMatchOptionCode: string
Read Only:
true
Maximum Length:25
Value that indicates whether the invoice for the shipment should be matched to the purchase order or receipt. -
ItemControlCode: string
Read Only:
true
Maximum Length:255
Value that indicates the list of inventory controls needed for this item. Valid values are LOT (lot must be specified during correction), SERIAL (serial numbers must be specified during correction), and LOTSERIAL (both lots and serial numbers must be specified during correction). -
ItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item. -
ItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item. -
ItemLocatorControlCode: integer
Read Only:
true
Value that indicates the physical area within a subinventory where you store material, such as a row, aisle, bin, or shelf. A list of accepted values is defined in the lookup type EGP_LOCATOR_CONTROL_CODE_TYPE. -
ItemLotControlCode: integer
Read Only:
true
Value that indicates the ability to use lot numbers during material transactions for tracking batches of the item in the receiving organization. A list of accepted values is defined in the lookup EGP_LOT_CONTROL_CODE_TYPE. -
ItemLotStatusEnabled: string
Read Only:
true
Maximum Length:1
Value that indicates if this item is controlled by the material status at the lot level. Valid values are Y (the material status is specified for all lots for this item) and N (lots for this item are not status-controlled). -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the item to receive. This item is any part, material, product, or service that contains unique attributes when compared to other items. -
ItemOutsideProcessServiceIndicator: string
Read Only:
true
Maximum Length:1
Value that indicates whether the item can be added to an outside processing purchase order. -
ItemPrimaryImageURL: string
Read Only:
true
Maximum Length:4000
URL for the primary image of the item being received. -
ItemRestrictLocatorsCode: integer
Read Only:
true
Value that indicates whether to restrict transaction of this item to or from a locator specified. -
ItemRevision: string
Read Only:
true
Maximum Length:18
Type of document according to the originating source, such as purchase order or return material authorization. A list of accepted values is defined in the lookup type RCV_SOURCE_DOCUMENT_TYPE. -
ItemRevisionControlCode: integer
Read Only:
true
Value that indicates if the item is under revision control. Valid values are 1 (not under revision control) and 2 (revision is mandatory when transacting this item). -
ItemSecondaryDefaultIndicator: string
Read Only:
true
Maximum Length:30
Value that indicates how the conversion between primary and secondary units of measure is handled. Valid values are Default (D), Fixed (F), and No Default (N). -
ItemSerialNumberControlCode: integer
Read Only:
true
Value that identifies the number assigned to each unit of an item and is used to track the item in the receiving organization. A list of accepted values is defined in the lookup EGP_SERIAL_NUMBER_CONTROL_TYPE. -
ItemSerialStatusEnabled: string
Read Only:
true
Maximum Length:1
Value that indicates if this item is controlled by the material status at the serial-number level. Valid values are Y (the material status is specified for all the serial numbers for this item) and N (serial numbers for this item are not status-controlled). -
ItemShelfLifeCode: integer
Read Only:
true
Value that indicates when the lot expires. Valid values are 1 (lot never expires), 2 (lot expires after a predefined number of days), and 4 (lot expires on the date entered by the user). -
ItemShelfLifeDays: number
Read Only:
true
Number of days after which the lot expires. -
ItemTrackingQuantityIndicator: string
Read Only:
true
Maximum Length:30
Value that uniquely identifies the unit of measure (UOM) that tracks the on-hand stock for the item. Valid values are P (tracks on-hand stock only in the primary UOM) and PS (tracks on-hand stock in both primary and secondary UOMs). -
KanbanCardNumber: string
Read Only:
true
Value that indicates the user identifier of the kanban card. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Read Only:
true
Maximum Length:255
Name of the locator where the item currently resides. -
LocatorId: integer
Read Only:
true
Value that uniquely identifies the locator where the item currently resides. -
manufacturerParts: array
Manufacturer Parts
Title:
Manufacturer Parts
Manufacturer parts associated with an expected shipment line. -
OrderedQuantity: number
Read Only:
true
Quantity ordered on the document line. -
OrderedUnitOfMeasure: string
Read Only:
true
Maximum Length:25
The unit of measure for the ordered quantity as per the document line. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the ship-to organization of the expected shipment line. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the ship-to organization of the expected shipment line. -
OrganizationLocatorControlCode: string
Read Only:
true
Maximum Length:30
Value that indicates the stock locator code for the organization. -
OwningEntityId: integer
Read Only:
true
Value that uniquely identifies the organization or the party that owns the transaction. -
OwningType: integer
Read Only:
true
Type of trading partner for the party who owns the transaction. -
POHeaderId: number
Read Only:
true
Value that uniquely identifies the purchase order header. -
POLineId: number
Read Only:
true
Value that uniquely identifies the purchase order line. -
POLineLocationId: number
Read Only:
true
Value that uniquely identifies the purchase order schedule. -
POLineNumber: number
Read Only:
true
Number that uniquely identifies the purchase order line. -
PONumber: string
Read Only:
true
Maximum Length:30
Number that uniquely identifies the purchase order header. -
POScheduleNumber: number
Read Only:
true
Number that uniquely identifies the purchase order schedule. -
POUnitPrice: number
Read Only:
true
Unit price on the purchase order line. -
PrimaryUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the primary unit of measure of the item. -
ProjectId: integer
Read Only:
true
Value that uniquely identifies the project for standardized project-cost collection. -
ProjectNumber: string
Read Only:
true
Maximum Length:255
Number that identifies the project for standardized project cost collection. -
RADocumentCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the document corresponding to the receipt advice.Always defaulted to RMA. -
ReceiptAdviceHeaderId: number
Read Only:
true
Value that uniquely identifies the receipt advice header. -
ReceiptAdviceLineId: number
Read Only:
true
Value that uniquely identifies the receipt advice line. -
ReceiptSourceCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the source type of the shipment. -
RMALineNumber: string
Read Only:
true
Maximum Length:80
Number that uniquely identifies the return material authorization line. -
RMANumber: string
Read Only:
true
Maximum Length:80
Number that uniquely identifies the return material authorization header. -
Routing: string
Read Only:
true
Maximum Length:80
Routing name for the type of transaction entry that determines the steps that receive the item. The RCV_ROUTING_HEADERS lookup defines the values that you can use with this attribute. -
RoutingHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receiving routing. -
ScheduleNoteToReceiver: string
Read Only:
true
Maximum Length:1000
Note to the receiver on the schedule. -
SecondaryAvailableQuantity: number
Read Only:
true
Quantity that is available to receive, using the secondary unit of measure. -
SecondaryUnitOfMeasure: string
Read Only:
true
Maximum Length:25
Secondary unit of measure to use for the quantity that is available to receive. -
SecondaryUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the secondary unit of measure to use for the quantity that is available to receive. -
ShipmentHeaderId: number
Read Only:
true
Value that uniquely identifies the shipment header. -
ShipmentLineId: number
Read Only:
true
Value that uniquely identifies the shipment line. -
ShipmentLineNumber: number
Read Only:
true
Number that uniquely identifies the in-transit shipment line. -
ShipToLocation: string
Read Only:
true
Maximum Length:60
Physical location of the warehouse that receives the item. -
ShipToLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receiving location. -
SoldtoLegalEntity: string
Read Only:
true
Maximum Length:240
Legal entity that is liable for the purchase order amount. -
SourceDocumentCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the document type of the shipment. Values include PO, RMA, TRANSFER ORDER, or INVENTORY. -
SourceSystem: string
Read Only:
true
Maximum Length:80
Application that captures the source document for the order line. The source system identifies the trading partner systems that receiving uses, such as Order Management Cloud, the customer of a logistics service, or an order management system that resides outside of Oracle. -
Subinventory: string
Read Only:
true
Maximum Length:255
Name of the subinventory where the item currently resides. -
SupplierShipmentNumber: string
Read Only:
true
Maximum Length:30
Value that identifies the supplier shipment number. -
TaskId: integer
Read Only:
true
Value that uniquely identifies the task for standardized project-cost collection. -
TaskNumber: string
Read Only:
true
Maximum Length:255
Number that identifies the task for standardized project cost collection. -
ToOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the ship-to organization of the expected shipment line. -
TransactionActionId: integer
Read Only:
true
Value that uniquely identifies the inventory transaction action. -
TransactionSourceTypeId: integer
Read Only:
true
Value that uniquely identifies the type of transaction source. -
TransactionTypeId: integer
Read Only:
true
Value that uniquely identifies the type of the inventory transaction. -
TransferOrderHeaderId: number
Read Only:
true
Value that uniquely identifies the transfer order header. Each transfer order can request to move items from one location to another location. -
TransferOrderLineId: number
Read Only:
true
Value that uniquely identifies the transfer order line. -
TransferOrderLineNumber: string
Read Only:
true
Maximum Length:40
Number that uniquely identifies the transfer order line. -
TransferOrderNumber: string
Read Only:
true
Maximum Length:50
Number that uniquely identifies the transfer order header. -
UnitOfMeasure: string
Read Only:
true
Maximum Length:25
Unit of measure to use for the quantity that is available to receive. -
UOMClass: string
Read Only:
true
Maximum Length:10
Value that identifies unit of measure class. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure to use for the quantity that is available to receive. -
VendorId: number
Read Only:
true
Value that uniquely identifies the vendor who supplies the item. -
VendorItemNumber: string
Read Only:
true
Maximum Length:300
Number that the supplier uses to identify the item. -
VendorName: string
Read Only:
true
Maximum Length:360
Name of the company that provides a product in return for an item that might or might not require payment. -
VendorSiteCode: string
Read Only:
true
Maximum Length:240
Abbreviation that identifies the buying organization that conducts business with the supplier. -
VendorSiteId: number
Read Only:
true
Value that uniquely identifies the supplier site.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Manufacturer Parts
Type:
array
Title:
Manufacturer Parts
Manufacturer parts associated with an expected shipment line.
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.
Nested Schema : receivingReceiptExpectedShipmentLines-manufacturerParts-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManufacturerName: string
Title:
Manufacturer
Read Only:true
Maximum Length:700
Name of the manufacturer. -
ManufacturerPartNumber: string
Title:
Manufacturer Part Number
Read Only:true
Maximum Length:255
Number issued by the manufacturer that uniquely identifies the individual product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- manufacturerParts
-
Parameters:
- receivingReceiptExpectedShipmentLinesUniqID:
$request.path.receivingReceiptExpectedShipmentLinesUniqID
Manufacturer parts associated with an expected shipment line. - receivingReceiptExpectedShipmentLinesUniqID: