Get all order lines

get

/fscmRestApi/resources/11.13.18.05/transferOrders/{HeaderId}/child/transferOrderLines

Request

Path Parameters
Query Parameters
  • 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>
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds transfer order lines according to the line identifier.
      Finder Variables:
      • LineId; integer; Value that uniquely identifies the transfer order line.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActionSourceType; string; Source type of the action.
    • AgreementPtrId; integer; Value that uniquely identifies the partner agreement.
    • AllowItemSubstitution; string; Value that identifies if item substitution is allowed on the transfer order line. Contains one of the following values: Y, N, or Null. If Y, then item substitution is allowed. If N or Null, then item substitution isn't allowed. There is no default value for this attribute. This attribute is associated with a feature that requires opt in.
    • AllowItemSubstitutionMeaning; string; Abbreviation that identifies if item substitution is allowed on the transfer order line. A list of accepted values is defined in the lookup type INV_YES_NO_CHAR. If Yes, then item substitution is allowed. If No, then item substitution isn't allowed. There is no default value for this attribute. This attribute is associated with a feature that requires opt in.
    • BackToBack; string; Value that indicates whether the transfer order is a back-to-back transfer order.
    • CarrierName; string; Name of the carrier used on the transfer order line.
    • ChangeInitiatingPersonName; string; Name of the person who started the change request.
    • ChangePartyId; integer; Value that uniquely identifies the person who started the change request.
    • ChangeRequestedDate; string; Date when the user requested the change for this transfer order.
    • ChangeStatus; string; Status of the current change request. A list of accepted values is defined in the lookup type INV_TO_CHANGE_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task.
    • ChangeStatusLookup; string; Abbreviation that identifies the status of the change request. A list of accepted values is defined in the lookup type INV_TO_CHANGE_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task.
    • Comments; string; Comments that the user entered, such as the reason for the return.
    • CurrencyCode; string; Abbreviation that identifies the default currency of the requesting organization.
    • DeliveredQuantity; number; Quantity delivered for the item.
    • DestinationAddressFirstLine; string; First line of address of the destination organization.
    • DestinationAddressFourthLine; string; Fourth line of address of the destination organization.
    • DestinationAddressSecondLine; string; Second line of address of the destination organization.
    • DestinationAddressThirdLine; string; Third line of address of the destination organization.
    • DestinationCity; string; City of the destination organization.
    • DestinationCountry; string; Country of the destination organization.
    • DestinationLocationCode; string; Abbreviation that identifies the destination location.
    • DestinationLocationId; integer; Value that uniquely identifies the destination location.
    • DestinationLocationName; string; Name of the destination location.
    • DestinationOrganizationCode; string; Abbreviation that identifies the destination organization.
    • DestinationOrganizationId; integer; Value that uniquely identifies the destination organization.
    • DestinationOrganizationName; string; Name of the destination organization.
    • DestinationPostalCode; string; Abbreviation that identifies the destination organization.
    • DestinationState; string; State of the destination organization.
    • DestinationSubinventoryCode; string; Abbreviation that identifies the destination subinventory.
    • DestinationType; string; Description of the type of destination whether a transfer order line is an inventory or expense destination type. A list of acceptable values is defined in the lookup type ORA_INV_TO_DESTINATION_TYPE. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
    • DestinationTypeLookup; string; Abbreviation that identifies the type of destination. A list of acceptable values is defined in the lookup type ORA_INV_TO_DESTINATION_TYPE. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
    • DisplayLineNumber; string; Transfer order line number including kit component number.
    • FirmPlanningSchedule; string; Value that indicates whether the planning schedule is firm or not. Valid values include Firm or Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
    • FirmPlanningScheduleLookup; string; Value that indicates whether the planning schedule is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
    • FreightCarrierId; integer; Value that uniquely identifies the carrier used on the transfer order line.
    • FulfillStatusMeaning; string; Values that identify the fulfillment status. A list of acceptable values is defined in the lookup type INV_TO_FULFILL_STATUS. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
    • FulfillmentStatusLookup; string; Abbreviation that identifies the fulfillment status. A list of acceptable values is defined in the lookup type INV_TO_FULFILL_STATUS. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
    • HeaderId; integer; Value that uniquely identifies the transfer order header.
    • HeaderNumber; string; Number that identifies the transfer order.
    • InclNonrecoverableTax; number; Tax that is inclusive and not recoverable.
    • InclRecoverableTax; number; Tax that is inclusive and recoverable.
    • InitialRequestedQuantity; number; Requested quantity when the transfer order line was first created.
    • InterfaceErrMsgCode; string; Abbreviation that identifies the error message for the interface.
    • InterfaceErrMsgText; string; Text of the error message, if any, for the interface.
    • InterfaceSourceCode; string; Abbreviation that identifies the interface source.
    • InterfaceStatus; string; Value that indicates the interface status of the transfer order line. A list of acceptable values is defined in the lookup type INV_TO_INTERFACE_STATUS. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
    • InterfaceStatusLookup; string; Abbreviation that identifies the interfacing status of the transfer order line. A list of acceptable values is defined in the lookup type INV_TO_INTERFACE_STATUS. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
    • InventoryItemId; integer; Value that uniquely identifies the inventory item.
    • ItemDescription; string; Description of the inventory item.
    • ItemNumber; string; Item number of the inventory item.
    • ItemRevision; string; Item revision of the inventory item.
    • ItemSubstituted; string; Value that identifies if substitute items are shipped for the transfer order line. Contains one of the following values: Y, N, or Null. If Y, then substitute items are shipped. If N or Null, then substitute items are not shipped. There is no default value for this attribute. This attribute is associated with a feature that requires opt in.
    • ItemSubstitutedMeaning; string; Abbreviation that identifies if substitute items are shipped for the transfer order line. A list of accepted values is defined in the lookup type INV_YES_NO_CHAR. If Yes, then substitute items are shipped. If No, then substitute items are not shipped. There is no default value for this attribute. This attribute is associated with a feature that requires opt in.
    • LineId; integer; Value that uniquely identifies the transfer order line.
    • LineNumber; integer; Number that identifies the line of the transfer order.
    • MaterialReturnRequired; string; Contains one of the following values: Yes or No. If Yes, then the return transfer order is required to return the physical material to the destination organization. If No, then do not require this return. This attribute does not have a default value.
    • ModeOfTransport; string; Mode of transport for the shipping method. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
    • ModeOfTransportLookup; string; Abbreviation that identifies the mode of transport for the shipping method. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
    • NeedByDate; string; Date when this transfer order line is requested for arrival.
    • NoninclNonrecoverableTax; number; Tax that is not inclusive and not recoverable.
    • NoninclRecoverableTax; number; Tax that is not inclusive and recoverable.
    • NoteToReceiver; string; Note to the receiver on the receiving documents.
    • NoteToSupplier; string; Note to the supplier on the shipping documents.
    • OriginalHeaderId; integer; Value that uniquely identifies the original transfer order header for the return transfer order.
    • OriginalLineId; integer; Value that uniquely identifies the transfer order line for the return transfer order.
    • OriginalRequestLineId; integer; Value that uniquely identifies the original request line.
    • OriginalTransferOrder; string; Number that identifies the original transfer order for a return transfer order.
    • OriginalTransferOrderLine; string; Number that identifies the original transfer order line for a return transfer order.
    • PlannerId; integer; Value that uniquely identifies the planner for the item.
    • PlannerName; string; Name of the planner for the item.
    • QuantityUOMCode; string; Abbreviation that identifies the unit of measure of the line quantity.
    • QuantityUOMName; string; Name of the unit of measure of the line quantity.
    • ReceivedQuantity; number; Quantity received for the item.
    • Region; string; Region where the transfer order is located.
    • Reprice; string; Value that indicates whether pricing can price the transfer order.
    • RequestedQuantity; number; Quantity requested for the item.
    • RequesterId; integer; Value that uniquely identifies the requestor.
    • RequesterName; string; Name of the person requesting the transfer order.
    • RequisitionId; integer; Value that uniquely identifies the requisition number that the application uses to create the transfer order.
    • RequisitionLineId; integer; Value that uniquely identifies the requisition line that the application uses to create the transfer order.
    • RequisitionLineNumber; string; Number that uniquely identifies the requisition line that the application uses to create the transfer order.
    • RequisitionNumber; string; Number that uniquely identifies the requisition number that the application uses to create the transfer order.
    • ScheduledShipDate; string; Date when this transfer order is scheduled to ship.
    • SecondaryDeliveredQuantity; number; Quantity delivered and put away in inventory in the secondary unit of measure.
    • SecondaryQuantityUOMCode; string; Abbreviation that identifies the secondary unit of measure of the line quantity.
    • SecondaryQuantityUOMName; string; Name of the secondary unit of measure of the line quantity.
    • SecondaryReceivedQuantity; number; Quantity received in the secondary unit of measure.
    • SecondaryRequestedQuantity; number; Quantity requested in the secondary unit of measure.
    • SecondaryShippedQuantity; number; Quantity shipped in the secondary unit of measure.
    • ServiceLevel; string; Service level for the shipping method. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
    • ServiceLevelLookup; string; Abbreviation that identifies the service level for the shipping method. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
    • ShipMethodDescription; string; Description of the shipping method.
    • ShipmentPriority; string; Priority of the transfer order line to ship. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task.
    • ShipmentPriorityLookup; string; Abbreviation that identifies the priority of the shipment. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task.
    • ShippedQuantity; number; Quantity shipped for the item.
    • SourceHeaderId; integer; Value that uniquely identifies the source of the header for the transfer order.
    • SourceLineId; integer; Value that uniquely identifies the source of the line for the transfer order.
    • SourceOfTransferOrder; string; Abbreviation that identifies the source that originally created the transfer order line. A list of acceptable values is defined in the lookup type INV_TO_TXN_ORIGIN. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
    • SourceOrganizationCode; string; Abbreviation that identifies the source organization.
    • SourceOrganizationId; integer; Value that uniquely identifies the source organization.
    • SourceOrganizationName; string; Name of the source organization.
    • SourceSubinventoryCode; string; Abbreviation that identifies the source subinventory.
    • SourceTypeLookup; string; Values that identify the source that originally created the transfer order line. A list of acceptable values is defined in the lookup type INV_TO_TXN_ORIGIN. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
    • StatusLookup; string; Abbreviation that identifies the status of the transfer order line. A list of acceptable values is defined in the lookup type INV_TO_LINE_STATUS. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
    • SupplyOrderReferenceLineNumber; string; Number that uniquely identifies supply request line.
    • SupplyOrderReferenceNumber; string; Number that uniquely identifies the supply request.
    • TransferOrderLineStatus; string; Status of the transfer order line. A list of acceptable values is defined in the lookup type INV_TO_LINE_STATUS. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
    • UnitPrice; number; Unit price of requested item.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : transferOrders-transferOrderLines
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : transferOrders-transferOrderLines-item-response
Type: object
Show Source
  • Action to perform on transfer order line. Valid value is CANCEL.
  • Read Only: true
    Maximum Length: 30
    Source type of the action.
  • Read Only: true
    Value that uniquely identifies the partner agreement.
  • Maximum Length: 1
    Value that identifies if item substitution is allowed on the transfer order line. Contains one of the following values: Y, N, or Null. If Y, then item substitution is allowed. If N or Null, then item substitution isn't allowed. There is no default value for this attribute. This attribute is associated with a feature that requires opt in.
  • Maximum Length: 255
    Abbreviation that identifies if item substitution is allowed on the transfer order line. A list of accepted values is defined in the lookup type INV_YES_NO_CHAR. If Yes, then item substitution is allowed. If No, then item substitution isn't allowed. There is no default value for this attribute. This attribute is associated with a feature that requires opt in.
  • Title: Back-to-Back
    Read Only: true
    Maximum Length: 1
    Value that indicates whether the transfer order is a back-to-back transfer order.
  • Name of the carrier used on the transfer order line.
  • Read Only: true
    Maximum Length: 255
    Name of the person who started the change request.
  • Read Only: true
    Value that uniquely identifies the person who started the change request.
  • Title: Change Request Date
    Read Only: true
    Date when the user requested the change for this transfer order.
  • Read Only: true
    Maximum Length: 255
    Status of the current change request. A list of accepted values is defined in the lookup type INV_TO_CHANGE_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task.
  • Title: Change Status
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the status of the change request. A list of accepted values is defined in the lookup type INV_TO_CHANGE_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task.
  • Title: Comment
    Maximum Length: 240
    Comments that the user entered, such as the reason for the return.
  • Read Only: true
    Maximum Length: 15
    Abbreviation that identifies the default currency of the requesting organization.
  • Title: Delivered
    Read Only: true
    Quantity delivered for the item.
  • Title: Address Line 1
    Read Only: true
    Maximum Length: 240
    First line of address of the destination organization.
  • Title: Address Line 4
    Read Only: true
    Maximum Length: 240
    Fourth line of address of the destination organization.
  • Title: Address Line 2
    Read Only: true
    Maximum Length: 240
    Second line of address of the destination organization.
  • Title: Address Line 3
    Read Only: true
    Maximum Length: 240
    Third line of address of the destination organization.
  • Title: Town or City
    Read Only: true
    Maximum Length: 30
    City of the destination organization.
  • Title: Country
    Read Only: true
    Maximum Length: 60
    Country of the destination organization.
  • Title: Name
    Read Only: true
    Maximum Length: 60
    Abbreviation that identifies the destination location.
  • Read Only: true
    Value that uniquely identifies the destination location.
  • Title: Display Name
    Read Only: true
    Maximum Length: 240
    Name of the destination location.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the destination organization.
  • Read Only: true
    Value that uniquely identifies the destination organization.
  • Read Only: true
    Maximum Length: 255
    Name of the destination organization.
  • Title: Postal Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the destination organization.
  • Title: Region 2
    Read Only: true
    Maximum Length: 120
    State of the destination organization.
  • Title: Destination Subinventory
    Maximum Length: 10
    Abbreviation that identifies the destination subinventory.
  • Read Only: true
    Maximum Length: 255
    Description of the type of destination whether a transfer order line is an inventory or expense destination type. A list of acceptable values is defined in the lookup type ORA_INV_TO_DESTINATION_TYPE. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
  • Title: Destination Type
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of destination. A list of acceptable values is defined in the lookup type ORA_INV_TO_DESTINATION_TYPE. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
  • Title: Line
    Read Only: true
    Maximum Length: 100
    Transfer order line number including kit component number.
  • Maximum Length: 80
    Value that indicates whether the planning schedule is firm or not. Valid values include Firm or Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Title: Firm Status
    Maximum Length: 1
    Value that indicates whether the planning schedule is firm or not. Valid values include Firm and Not firm. A list of accepted values is defined in the lookup type ORA_MSC_ORDER_FIRM_STATUS.
  • Value that uniquely identifies the carrier used on the transfer order line.
  • Title: Fulfillment Status
    Read Only: true
    Abbreviation that identifies the fulfillment status. A list of acceptable values is defined in the lookup type INV_TO_FULFILL_STATUS. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
  • Title: Fulfillment Status
    Read Only: true
    Values that identify the fulfillment status. A list of acceptable values is defined in the lookup type INV_TO_FULFILL_STATUS. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
  • Value that uniquely identifies the transfer order header.
  • Title: Transfer Order
    Read Only: true
    Maximum Length: 50
    Number that identifies the transfer order.
  • Read Only: true
    Tax that is inclusive and not recoverable.
  • Read Only: true
    Tax that is inclusive and recoverable.
  • Title: Initial Requested Quantity
    Read Only: true
    Requested quantity when the transfer order line was first created.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the error message for the interface.
  • Title: Interface Error Message
    Read Only: true
    Maximum Length: 480
    Text of the error message, if any, for the interface.
  • Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the interface source.
  • Read Only: true
    Maximum Length: 255
    Value that indicates the interface status of the transfer order line. A list of acceptable values is defined in the lookup type INV_TO_INTERFACE_STATUS. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
  • Title: Interface Status
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the interfacing status of the transfer order line. A list of acceptable values is defined in the lookup type INV_TO_INTERFACE_STATUS. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
  • Read Only: true
    Value that uniquely identifies the inventory item.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the inventory item.
  • Read Only: true
    Maximum Length: 300
    Item number of the inventory item.
  • Read Only: true
    Maximum Length: 18
    Item revision of the inventory item.
  • Read Only: true
    Maximum Length: 1
    Value that identifies if substitute items are shipped for the transfer order line. Contains one of the following values: Y, N, or Null. If Y, then substitute items are shipped. If N or Null, then substitute items are not shipped. There is no default value for this attribute. This attribute is associated with a feature that requires opt in.
  • Read Only: true
    Maximum Length: 255
    Abbreviation that identifies if substitute items are shipped for the transfer order line. A list of accepted values is defined in the lookup type INV_YES_NO_CHAR. If Yes, then substitute items are shipped. If No, then substitute items are not shipped. There is no default value for this attribute. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the transfer order line.
  • Title: Line Including Kit
    Read Only: true
    Number that identifies the line of the transfer order.
  • Links
  • Title: Physical Material Return Required
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: Yes or No. If Yes, then the return transfer order is required to return the physical material to the destination organization. If No, then do not require this return. This attribute does not have a default value.
  • Mode of transport for the shipping method. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
  • Maximum Length: 30
    Abbreviation that identifies the mode of transport for the shipping method. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
  • Title: Requested Delivery Date
    Date when this transfer order line is requested for arrival.
  • Read Only: true
    Tax that is not inclusive and not recoverable.
  • Read Only: true
    Tax that is not inclusive and recoverable.
  • Title: Note to Receiver
    Maximum Length: 1000
    Note to the receiver on the receiving documents.
  • Title: Note to Supplier
    Maximum Length: 1000
    Note to the supplier on the shipping documents.
  • Read Only: true
    Value that uniquely identifies the original transfer order header for the return transfer order.
  • Read Only: true
    Value that uniquely identifies the transfer order line for the return transfer order.
  • Read Only: true
    Value that uniquely identifies the original request line.
  • Read Only: true
    Maximum Length: 255
    Number that identifies the original transfer order for a return transfer order.
  • Read Only: true
    Maximum Length: 255
    Number that identifies the original transfer order line for a return transfer order.
  • Read Only: true
    Value that uniquely identifies the planner for the item.
  • Read Only: true
    Maximum Length: 255
    Name of the planner for the item.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure of the line quantity.
  • Read Only: true
    Maximum Length: 255
    Name of the unit of measure of the line quantity.
  • Title: Received
    Read Only: true
    Quantity received for the item.
  • Read Only: true
    Region where the transfer order is located.
  • Read Only: true
    Maximum Length: 1
    Value that indicates whether pricing can price the transfer order.
  • Title: Requested Quantity
    Quantity requested for the item.
  • Read Only: true
    Value that uniquely identifies the requestor.
  • Read Only: true
    Maximum Length: 255
    Name of the person requesting the transfer order.
  • Read Only: true
    Value that uniquely identifies the requisition number that the application uses to create the transfer order.
  • Read Only: true
    Value that uniquely identifies the requisition line that the application uses to create the transfer order.
  • Read Only: true
    Maximum Length: 255
    Number that uniquely identifies the requisition line that the application uses to create the transfer order.
  • Title: Requisition
    Read Only: true
    Maximum Length: 64
    Number that uniquely identifies the requisition number that the application uses to create the transfer order.
  • Title: Scheduled Ship Date
    Read Only: true
    Date when this transfer order is scheduled to ship.
  • Title: Delivered
    Read Only: true
    Quantity delivered and put away in inventory in the secondary unit of measure.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the secondary unit of measure of the line quantity.
  • Read Only: true
    Maximum Length: 255
    Name of the secondary unit of measure of the line quantity.
  • Title: Received
    Read Only: true
    Quantity received in the secondary unit of measure.
  • Title: Secondary Requested Quantity
    Quantity requested in the secondary unit of measure.
  • Title: Shipped
    Read Only: true
    Quantity shipped in the secondary unit of measure.
  • Service level for the shipping method. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
  • Maximum Length: 30
    Abbreviation that identifies the service level for the shipping method. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
  • Maximum Length: 255
    Priority of the transfer order line to ship. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task.
  • Title: Shipping Priority
    Maximum Length: 30
    Abbreviation that identifies the priority of the shipment. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Shipping Lookups task.
  • Description of the shipping method.
  • Title: Shipped
    Read Only: true
    Quantity shipped for the item.
  • Read Only: true
    Value that uniquely identifies the source of the header for the transfer order.
  • Read Only: true
    Value that uniquely identifies the source of the line for the transfer order.
  • Read Only: true
    Maximum Length: 255
    Abbreviation that identifies the source that originally created the transfer order line. A list of acceptable values is defined in the lookup type INV_TO_TXN_ORIGIN. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
  • Maximum Length: 18
    Abbreviation that identifies the source organization.
  • Value that uniquely identifies the source organization.
  • Read Only: true
    Maximum Length: 255
    Name of the source organization.
  • Title: Source Subinventory
    Maximum Length: 10
    Abbreviation that identifies the source subinventory.
  • Title: Transaction Origin Type
    Read Only: true
    Maximum Length: 30
    Values that identify the source that originally created the transfer order line. A list of acceptable values is defined in the lookup type INV_TO_TXN_ORIGIN. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
  • Title: Line Status
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the status of the transfer order line. A list of acceptable values is defined in the lookup type INV_TO_LINE_STATUS. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
  • Title: Request Reference Line
    Read Only: true
    Maximum Length: 20
    Number that uniquely identifies supply request line.
  • Title: Request Reference
    Read Only: true
    Maximum Length: 200
    Number that uniquely identifies the supply request.
  • Title: Total Transfer Price
    Read Only: true
    Value that indicates the total transfer price.
  • Distributions
    Title: Distributions
    The Transfer Order Distributions resource manages distributions for the transfer order.
  • Flexfields for Order Lines
    Title: Flexfields for Order Lines
    The Flexfields for Transfer Order Lines resource stores details for order line attributes in the transfer order.
  • Read Only: true
    Maximum Length: 255
    Status of the transfer order line. A list of acceptable values is defined in the lookup type INV_TO_LINE_STATUS. Review and update the value for the attribute using the Setup and Maintenance work area, and the Manage Inventory Lookups task.
  • Read Only: true
    Unit price of requested item.
Nested Schema : Distributions
Type: array
Title: Distributions
The Transfer Order Distributions resource manages distributions for the transfer order.
Show Source
Nested Schema : Flexfields for Order Lines
Type: array
Title: Flexfields for Order Lines
The Flexfields for Transfer Order Lines resource stores details for order line attributes in the transfer order.
Show Source
Nested Schema : transferOrders-transferOrderLines-transferOrderDistributions-item-response
Type: object
Show Source
Nested Schema : Flexfields for Distributions
Type: array
Title: Flexfields for Distributions
The Flexfields for Transfer Order Distributions resource stores details for distribution attributes in the transfer order.
Show Source
Nested Schema : Flexfields for Projects
Type: array
Title: Flexfields for Projects
The Flexfields for Transfer Order Projects resource stores details for project attributes in the transfer order.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AP_Distribution_Sets":"#/components/schemas/oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFAP__5FDistribution__5FSetsVO-item-response", "AP_Invoice_Distribution":"#/components/schemas/oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFAP__5FInvoice__5FDistributionVO-item-response", "AP_Invoice_Line":"#/components/schemas/oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFAP__5FInvoice__5FLineVO-item-response", "EXM_Expense_Report":"#/components/schemas/oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFEXM__5FExpense__5FReportVO-item-response", "EXM_Expense_Report_Line":"#/components/schemas/oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFEXM__5FExpense__5FReport__5FLineVO-item-response", "INV_Misc_Transactions":"#/components/schemas/oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFINV__5FMisc__5FTransactionsVO-item-response", "OM_Sales_Order":"#/components/schemas/oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFOM__5FSales__5FOrderVO-item-response", "PJC_All":"#/components/schemas/oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFPJC__5FAllVO-item-response", "PJC_Expenditure_Batch":"#/components/schemas/oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFPJC__5FExpenditure__5FBatchVO-item-response", "POR_Requisition":"#/components/schemas/oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFPOR__5FRequisitionVO-item-response", "POR_User_Preferences":"#/components/schemas/oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFPOR__5FUser__5FPreferencesVO-item-response", "PO_Purchase_Order":"#/components/schemas/oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFPO__5FPurchase__5FOrderVO-item-response", "PO_Purchase_Order_Line":"#/components/schemas/oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFPO__5FPurchase__5FOrder__5FLineVO-item-response", "PO_Purchase_Order_Schedule":"#/components/schemas/oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFPO__5FPurchase__5FOrder__5FScheduleVO-item-response" } }
Nested Schema : transferOrders-transferOrderLines-transferOrderDistributions-transferOrderDistributionDFFs-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFAP__5FDistribution__5FSetsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFAP__5FInvoice__5FDistributionVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFAP__5FInvoice__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFEXM__5FExpense__5FReportVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFEXM__5FExpense__5FReport__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFINV__5FMisc__5FTransactionsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFOM__5FSales__5FOrderVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFPJC__5FAllVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFPJC__5FExpenditure__5FBatchVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFPOR__5FRequisitionVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFPOR__5FUser__5FPreferencesVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFPO__5FPurchase__5FOrderVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFPO__5FPurchase__5FOrder__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_scm_inventory_transferOrders_protectedModel_flex_pjcTODistrDFF_view_PJCDFFPO__5FPurchase__5FOrder__5FScheduleVO-item-response
Type: object
Show Source
Nested Schema : transferOrders-transferOrderLines-transferOrderLineDFFs-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get one transfer order line detail using the transfer order number.

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/transferOrders?onlyData=true &q=HeaderNumber=HeaderNumber &expand=transferOrderLines"

For example, the following command gets one transfer rder line detail where the transfer order number is 100003:

curl -u username:password "https://servername/fscmRestApi/resources/version/transferOrders?onlyData=true &q=HeaderNumber=100003 &expand=transferOrderLines"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "HeaderId": 300100071637872,
            "HeaderNumber": "100003",
            "Description": null,
            "RequisitionBUId": 204,
            "BusinessUnitName": "Vision Operations",
            "SourceTypeLookup": "PLANNING",
            "SourceOfTransferOrder": "Planning",
            "OrderedDate": "2015-12-02T11:00:03+00:00",
            "FulfillOrchestrationRequired": "N",
            "BudgetControlEnabled": "N",
            "InterfaceStatus": "Interfaced to Shipping",
            "transferOrderLines": [
                {
                    "LineId": 5,
                    "LineNumber": 1,
                    "HeaderId": 300100071637872,
                    "HeaderNumber": "100003",
                    "InterfaceStatusLookup": "INT_WSH",
                    "InterfaceStatus": "Interfaced to Shipping",
                    "FulfillmentStatusLookup": "WAIT_FULFILL",
                    "FulfillStatusMeaning": "Awaiting fulfillment",
                    "SourceTypeLookup": "PLANNING",
                    "SourceOfTransferOrder": "Planning",
                    "SourceOrganizationId": 209,
                    "SourceOrganizationCode": "M2",
                    "SourceOrganizationName": "Tall Manufacturing",
                    "SourceSubinventoryCode": null,
                    "DestinationOrganizationId": 207,
                    "DestinationOrganizationCode": "M1",
                    "DestinationOrganizationName": "Tall Manufacturing",
                    "DestinationSubinventoryCode": null,
                    "DestinationTypeLookup": "INVENTORY",
                    "DestinationType": "Inventory",
                    "DestinationLocationId": 207,
                    "DestinationLocationCode": "M1- Seattle Mfg",
                    "DestinationLocationName": "M1- Seattle Mfg",
                    "DestinationAddressFirstLine": "3455 108th Avenue",
                    "DestinationAddressSecondLine": null,
                    "DestinationAddressThirdLine": null,
                    "DestinationAddressFourthLine": null,
                    "DestinationCity": "Seattle",
                    "DestinationPostalCode": "98101",
                    "DestinationCountry": "US",
                    "MaterialReturnRequired": null,
                    "StatusLookup": "OPEN",
                    "TransferOrderLineStatus": "Open",
                    "InventoryItemId": 100100036057544,
                    "ItemNumber": "DOS-BAT-Simple TO",
                    "ItemRevision": null,
                    "NeedByDate": "2015-12-07T01:01:12+00:00",
                    "ScheduledShipDate": "2015-12-07T01:01:12+00:00",
                    "QuantityUOMCode": "Ea",
                    "QuantityUOMName": "Each",
                    "RequestedQuantity": 10,
                    "ShippedQuantity": null,
                    "ReceivedQuantity": null,
                    "DeliveredQuantity": null,
                    "SecondaryQuantityUOMCode": null,
                    "SecondaryQuantityUOMName": null,
                    "SecondaryRequestedQuantity": null,
                    "SecondaryShippedQuantity": null,
                    "SecondaryReceivedQuantity": null,
                    "SecondaryDeliveredQuantity": null,
                    "UnitPrice": 100.049504950495049504950495049504950495,
                    "FreightCarrierId": null,
                    "CarrierName": null,
                    "ModeOfTransportLookup": null,
                    "ModeOfTransport": "AIR",
                    "ServiceLevelLookup": null,
                    "ServiceLevel": "2DA",
                    "ShipMethodDescription": "DHL-Air-2nd day air",
                    "ShipmentPriorityLookup": null,
                    "ShipmentPriority": null,
                    "OriginalHeaderId": null,
                    "OriginalTransferOrder": null,
                    "OriginalLineId": null,
                    "OriginalTransferOrderLine": null,
                    "RequisitionId": 1449053674634,
                    "RequisitionNumber": null,
                    "RequisitionLineId": 1449053674634,
                    "RequisitionLineNumber": null,
                    "RequesterId": 100010024202178,
                    "RequesterName": "Quinn,Olivia",
                    "InterfaceErrMsgCode": null,
                    "InterfaceErrMsgText": null,
                    "PlannerId": null,
                    "PlannerName": null,
                    "ChangeStatusLookup": null,
                    "ChangeStatus": null,
                    "ChangeRequestedDate": null,
                    "Comments": null,
                    "SourceHeaderId": 300100071803833,
                    "SourceLineId": 300100071803856,
                    "InclNonrecoverableTax": null,
                    "InclRecoverableTax": null,
                    "NoninclNonrecoverableTax": null,
                    "NoninclRecoverableTax": null,
                    "CurrencyCode": "USD",
                    "AgreementPtrId": null,
                    "FirmPlanningSchedule": null,
                    "InterfaceSourceCode": "SCOTRACK",
                    "BackToBack": "N",
                    "OriginalRequestLineId": null,
                    "ActionSourceType": null,
                    "NoteToReceiver": null,
                    "NoteToSupplier": null,
                    "Reprice": "Y",
                    "ChangePartyId": null,
                    "ChangeInitiatingPersonName": null,
                    "Region": "King,WA"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "https://servername/fscmRestApi/resources/version/transferOrders",
            "name": "transferOrders",
            "kind": "collection"
        }
    ]
} 
Back to Top