Jump to

• Request
• Response
• Examples

Get one line

get

/fscmRestApi/resources/11.13.18.05/linesToReceive/{linesToReceiveUniqID}

Request

Path Parameters

• linesToReceiveUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- SourceDocumentCode and DocumentLineId ---for the Lines to Receive resource and used to uniquely identify an instance of Lines to Receive. The client should not generate the hash key value. Instead, the client should query on the Lines to Receive collection resource with a filter on the primary key values in order to navigate to a specific instance of Lines to Receive.
  
  For example: linesToReceive?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:
  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(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 : linesToReceive-item-response

Type: object

Show Source

• ASNLineNumber: integer (int64)
  Read Only: true

  Line number of the advanced shipment notice.
• ASNNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the advanced shipment notice for the shipment from the supplier.
• AvailableQuantity: number
  Read Only: true

  Quantity that is available to receive.
• BackToBack: string
  Read Only: true

  Maximum Length: 4

  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: 4

  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.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the currency, such as USD.
• CurrencyConversionDate: string (date)
  Read Only: true

  Date to use when determining the rates to use when calculating the currency conversion.
• CurrencyConversionRate: number
  Read Only: true

  Rate to use when calculating the currency conversion.
• CurrencyConversionType: string
  Read Only: true

  Maximum Length: 30

  Type of currency conversion.
• CustomerId: integer (int64)
  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.
• DestinationType: string
  Read Only: true

  Maximum Length: 80

  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.
• 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.
• DocumentDistributionNumber: integer (int64)
  Read Only: true

  Distribution number for the document schedule. This attribute applies only for a purchase order or transfer order.
• DocumentLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the document line.
• DocumentLineNumber: string
  Read Only: true

  Maximum Length: 30

  Line number for the document number.
• DocumentNumber: string
  Read Only: true

  Maximum Length: 30

  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.
• DocumentScheduleNumber: 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.
• FromOrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices.
• FromOrganizationId: integer (int64)
  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.
• FromOrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices.
• HeaderNoteToReceiver: string
  Read Only: true

  Maximum Length: 4000

  Note to the receiver on the header.
• IntegrationStatus: string
  Read Only: true

  Maximum Length: 25

  Status of integration for the line when communicating with an application that resides outside of Oracle. A list of accepted values is defined in the lookup type ORA_RCV_EXT_SYS_INTG_STATUS.
• InventoryTransactionTypeId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory transaction type.
• ItemDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the item.
• ItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item.
• 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.
• ItemRevision: string
  Read Only: true

  Maximum Length: 18

  Revision of the item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• manufacturerParts: array Manufacturer Parts
  Title: Manufacturer Parts

  The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line.
• MatchOption: string
  Read Only: true

  Maximum Length: 25

  Describes the matching criteria to use for the invoice.
• 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.
• PODistributionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order distribution.
• POHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order header.
• POLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order line.
• POLineLocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order schedule.
• PORevisionNumber: integer (int64)
  Read Only: true

  Revision number of the purchase order.
• POUnitPrice: number
  Read Only: true

  Unit price on the document line.
• ReceiptAdviceHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the receipt advice header.
• ReceiptAdviceLineId: integer (int64)
  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.
• 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: 4000

  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: integer (int64)
  Read Only: true

  Value that uniquely identifies the shipment header.
• ShipmentLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the 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.
• ToOrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the ship-to organization of the received line.
• ToOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the ship-to organization of the received line.
• TOShipmentNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the transfer order shipment.
• TransferOrderDistId: integer (int64)
  Read Only: true

  Value that uniquely identifies the transfer order distribution.
• TransferOrderHeaderId: integer (int64)
  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: integer (int64)
  Read Only: true

  Value that uniquely identifies the transfer order line.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 25

  Unit of measure to use for the quantity that is available to receive.
• 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: integer
  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: 240

  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: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier site.

{
    "type":"object",
    "properties":{
        "ASNNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the advanced shipment notice for the shipment from the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderNoteToReceiver":{
            "maxLength":4000,
            "type":"string",
            "description":"Note to the receiver on the header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Secondary unit of measure to use for the quantity that is available to receive.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleNoteToReceiver":{
            "maxLength":4000,
            "type":"string",
            "description":"Note to the receiver on the schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POLineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AvailableQuantity":{
            "type":"number",
            "description":"Quantity that is available to receive.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentDistributionNumber":{
            "type":"integer",
            "description":"Distribution number for the document schedule. This attribute applies only for a purchase order or transfer order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency, such as USD.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MatchOption":{
            "maxLength":25,
            "type":"string",
            "description":"Describes the matching criteria to use for the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptSourceCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the source type of the shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentLineNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Line number for the document number.",
            "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"
            }
        },
        "ItemRevision":{
            "maxLength":18,
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipmentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VendorSiteCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the buying organization that conducts business with the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure to use for the quantity that is available to receive.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PODistributionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order distribution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FromOrganizationId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VendorName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the company that provides a product in return for an item that might or might not require payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferOrderLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer order line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure to use for the quantity that is available to receive.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ToOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to organization of the received line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VendorSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipToLocation":{
            "maxLength":60,
            "type":"string",
            "description":"Physical location of the warehouse that receives the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryTransactionTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory transaction type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FromOrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceDocumentCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the document type of the shipment. Values include PO, RMA, TRANSFER ORDER, or INVENTORY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VendorItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that the supplier uses to identify the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerPartyName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the party who purchases the product, typically for a fee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category name.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FromOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization that is the point of origin of the shipment. This value is empty for purchase orders and advanced shipment notices.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ToOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the ship-to organization of the received line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SoldtoLegalEntity":{
            "maxLength":240,
            "type":"string",
            "description":"Legal entity that is liable for the purchase order amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VendorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the vendor who supplies the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyConversionType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of currency conversion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferOrderDistId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer order distribution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReceiptAdviceLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receipt advice line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyConversionDate":{
            "type":"string",
            "description":"Date to use when determining the rates to use when calculating the currency conversion.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationType":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentScheduleNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Schedule number for the document line number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryAvailableQuantity":{
            "type":"number",
            "description":"Quantity that is available to receive, using the secondary unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RoutingHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receiving routing.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BackToBack":{
            "maxLength":4,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure to use for the quantity that is available to receive.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DueDate":{
            "type":"string",
            "description":"Date when the warehouse expects to receive the item.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferOrderHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer order header. Each transfer order can request to move items from one location to another location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DestinationTypeCode":{
            "maxLength":25,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyConversionRate":{
            "type":"number",
            "description":"Rate to use when calculating the currency conversion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receiving location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ASNLineNumber":{
            "type":"integer",
            "description":"Line number of the advanced shipment notice.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntegrationStatus":{
            "maxLength":25,
            "type":"string",
            "description":"Status of integration for the line when communicating with an application that resides outside of Oracle. A list of accepted values is defined in the lookup type ORA_RCV_EXT_SYS_INTG_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentType":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TOShipmentNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the transfer order shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Routing":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsignedItems":{
            "maxLength":4,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentNumber":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PORevisionNumber":{
            "type":"integer",
            "description":"Revision number of the purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReceiptAdviceHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receipt advice header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderedQuantity":{
            "type":"number",
            "description":"Quantity ordered on the document line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "manufacturerParts":{
            "title":"Manufacturer Parts",
            "type":"array",
            "description":"The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line.",
            "items":{
                "$ref":"#/components/schemas/linesToReceive-manufacturerParts-item-response"
            }
        },
        "OrderedUnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"The unit of measure for the ordered quantity as per the document line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":250,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POUnitPrice":{
            "type":"number",
            "description":"Unit price on the document line.",
            "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 : Manufacturer Parts

Type: array

Title: Manufacturer Parts

The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line.

Show Source

• Array of: object linesToReceive-manufacturerParts-item-response

{
    "title":"Manufacturer Parts",
    "type":"array",
    "description":"The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line.",
    "items":{
        "$ref":"#/components/schemas/linesToReceive-manufacturerParts-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 : linesToReceive-manufacturerParts-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ManufacturerPartNumber":{
            "title":"Manufacturer Part Number",
            "maxLength":255,
            "type":"string",
            "description":"Number issued by the manufacturer that uniquely identifies the individual product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ManufacturerName":{
            "title":"Manufacturer",
            "maxLength":700,
            "type":"string",
            "description":"Name of the manufacturer.",
            "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

manufacturerParts

Operation: /fscmRestApi/resources/11.13.18.05/linesToReceive/{linesToReceiveUniqID}/child/manufacturerParts

Parameters:

• linesToReceiveUniqID: $request.path.linesToReceiveUniqID

The Manufacturer Parts resource manages the manufacturer parts associated with a receipt line.

Back to Top

Examples

This example describes how to get one line to receive.

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/linesToReceive?q=DocumentLineId=value"

For example, the following command gets one line to receive for document 100000015028304:

curl -u username:password "https://servername/fscmRestApi/resources/version/linesToReceive?q=DocumentLineId=100000015028304"

Example Response Body

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

{
"items": [
  {
"ToOrganizationCode": "M1",
"ToOrganizationId": 207,
"FromOrganizationName": null,
"FromOrganizationCode": null,
"FromOrganizationId": null,
"ItemNumber": null,
"ItemDescription": "PEN",
"ItemId": null,
"ItemRevision": null,
"DocumentType": "Purchase order",
"SourceDocumentCode": "PO",
"DocumentNumber": "1000408",
"DocumentLineNumber": "1",
"DocumentScheduleNumber": "1",
"DocumentDistributionNumber": 1,
"SoldtoLegalEntity": "Vision Operations",
"SourceSystem": null,
"DocumentLineId": 100000015028304,
"DueDate": "2009-01-27",
"VendorName": "Star Gate Ltd",
"VendorSiteCode": "SAN JOSE-CTR_HQ",
"VendorId": 5,
"VendorSiteId": 2556,
"VendorItemNumber": "SG101",
"TOShipmentNumber": null,
"ASNNumber": null,
"ASNLineNumber": null,
"CustomerPartyName": null,
"CustomerId": null,
"AvailableQuantity": 100,
"UOMCode": "Ea",
"UnitOfMeasure": "Each",
"SecondaryAvailableQuantity": 0,
"SecondaryUOMCode": null,
"SecondaryUnitOfMeasure": null,
"DestinationType": "Expense",
"DestinationTypeCode": "EXPENSE",
"ShipToLocation": "M1- Seattle Mfg",
"ShipToLocationId": 207,
"Routing": "Direct delivery",
"RoutingHeaderId": 3,
"OrderedQuantity": 100,
"OrderedUnitOfMeasure": "Each",
"POHeaderId": 100000015028302,
"POLineLocationId": 100000015028305,
"POLineId": 100000015028304,
"PODistributionId": 100000015028306,
"PORevisionNumber": 0,
"ShipmentHeaderId": null,
"ShipmentLineId": null,
"TransferOrderHeaderId": null,
"TransferOrderLineId": null,
"TransferOrderDistId": null,
"ReceiptAdviceHeaderId": null,
"ReceiptAdviceLineId": null,
"ReceiptSourceCode": "VENDOR",
"ConsignedItems": "N",
"BackToBack": "N",
"CategoryName": "Miscellaneous_1",
"CategoryId": 1,
"CurrencyCode": "USD",
"CurrencyConversionRate": null,
"CurrencyConversionDate": null,
"CurrencyConversionType": null,
"InventoryTransactionTypeId": 18,
"POUnitPrice": 10,
"MatchOption": "P",
"HeaderNoteToReceiver": null,
"ScheduleNoteToReceiver": null,
"IntegrationStatus": "Ready to interface",
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
  {
"rel": "self",
"href": "https://servername/logisticsApi/resources/version/linesToReceive",
"name": "linesToReceive",
"kind": "collection"
}
],
}

Back to Top