Get one shipment line
get
/fscmRestApi/resources/11.13.18.05/shipmentLineTransactionRequests/{TransactionId}/child/shipmentLines/{DeliveryDetailInterfaceId}
Request
Path Parameters
-
DeliveryDetailInterfaceId(required): integer(int64)
Value that uniquely identifies the shipment line.
-
TransactionId(required): integer(int64)
Value that uniquely identifies the shipment line transaction request.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : shipmentLineTransactionRequests-shipmentLines-item-response
Type:
Show Source
object
-
ArrivalSet: string
Maximum Length:
150
Arrival set that contains the order line. -
AssessableValue: number
Deemed price at which a product is valued by a tax authority for tax calculation purposes. The same product can have more than one assessable value as given by different tax authorities.
-
attachments: array
Attachments
Title:
Attachments
The Attachments resource manages details about shipment line attachments. -
BackorderedQuantity: number
Read Only:
true
Quantity that was withheld from processing until inventory becomes available. -
BaseItem: string
Maximum Length:
300
Name of the base item. -
BaseItemId: integer
(int64)
Value that uniquely identifies the base Assemble to Order (ATO) model information used for internal processing.
-
BillToContact: string
Maximum Length:
360
Person to contact at the bill-to customer site. -
BillToContactId: integer
(int64)
Value that uniquely identifies the bill-to contact for the order line.
-
BillToContactNumber: string
Maximum Length:
30
Number that identifies the person to contact at the bill-to customer. -
BillToCustomer: string
Maximum Length:
360
Name of the party to bill for the sales order line. -
BillToCustomerNumber: string
Maximum Length:
30
Number that identifies the person to be contacted for any billing details. -
BillToPartyId: integer
(int64)
Value that uniquely identifies the bill-to party for the order line.
-
BillToPartySiteId: integer
(int64)
Value that uniquely identifies the bill-to party site.
-
BillToPartySiteNumber: string
Maximum Length:
150
Number that identifies the bill-to party site. -
BusinessUnit: string
Maximum Length:
240
Name of the selling business unit. -
BusinessUnitId: integer
(int64)
Value that uniquely identifies the selling business unit.
-
Carrier: string
Maximum Length:
360
Name of the carrier that transports the shipment. -
CarrierId: integer
(int64)
Value that uniquely identifies the carrier.
-
CarrierNumber: string
Maximum Length:
30
Number that identifies the carrier that transports the shipment. -
ConvertedQuantity: number
Read Only:
true
Shipped or backordered quantity of the line converted to ordered UOM. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the shipment line. -
CreationDate: string
(date-time)
Read Only:
true
Date when the shipment line was created. -
Currency: string
Maximum Length:
15
Abbreviation that identifies the currency of the shipment line. -
CustomerItem: string
Maximum Length:
240
Customer item number. -
CustomerPONumber: string
Maximum Length:
50
Number that identifies the customer purchase order. -
DeliveryDetailInterfaceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the shipment line. -
DFF: array
Flexfields for Shipment Lines
Title:
Flexfields for Shipment Lines
The Flexfields for Shipment Lines resource manages details about shipment lines. -
DocumentFiscalClassificationCode: string
Maximum Length:
240
Abbreviation that identifies the document fiscal classification code. -
DoNotShipAfterDate: string
(date-time)
Date after which the line cannot be shipped.
-
DoNotShipBeforeDate: string
(date-time)
Date before which the line cannot be shipped.
-
EarliestDropoffDate: string
(date-time)
Earliest date when the shipment line can be delivered to the customer.
-
EarliestPickupDate: string
(date-time)
Earliest date when the shipment line can be picked up.
-
EndAssemblyItem: string
Maximum Length:
300
Number that identifies the finished assembled item to build by using the item shipped on this shipment line. -
errors: array
Errors
Title:
Errors
The Errors resource manages errors encountered while processing an order from the interface to the base tables. -
FirstPartyTaxRegistrationId: integer
(int64)
Value that uniquely identifies the first party tax registration for the transaction.
-
FirstPartyTaxRegistrationNumber: string
Maximum Length:
30
Number that identifies the first-party tax registration for the transaction. -
FOBCode: string
Maximum Length:
30
Abbreviation that identifies ownership of the items that are in transit. A list of acceptable values is defined in the lookup FOB. -
FreightTermsCode: string
Maximum Length:
30
Abbreviation that identifies the agreement that describes whether the buyer or seller pays the shipping cost of the sales order and when is the payment due. A list of acceptable values is defined in the lookup WSH_FREIGHT_CHARGE_TERMS. -
GradeCode: string
Maximum Length:
150
Abbreviation that identifies the preferred grade of the item. -
holds: array
Holds
Title:
Holds
The Holds resource manages details about shipment line holds. -
InitialDestinationId: integer
(int64)
Value that uniquely identifies the initial leg of the transportation planned to deliver the shipment to the final destination.
-
IntendedUse: string
Maximum Length:
30
Name of the intended use classification identifier. -
IntendedUseClassificationId: number
Value that uniquely identifies the intended use classification.
-
Item: string
Maximum Length:
240
Value that uniquely identifies the item. -
ItemDescription: string
Maximum Length:
250
Description of the inventory item. -
ItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the shipment line was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the shipment line. -
LatestDropoffDate: string
(date-time)
Latest date when the shipment line can be delivered to the customer.
-
LatestPickupDate: string
(date-time)
Latest date when the shipment line can be picked up.
-
LineActionType: string
Maximum Length:
30
Abbreviation that identifies how to process this shipment line. Valid values are CREATE and UPDATE. This attribute is ignored when the action code at the header level is ValidateAndLock, Lock, ReleaseLock, TPUpdate, or TPDelete. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationOfFinalDischargeCode: string
Maximum Length:
60
Value that indicates the final destination location for the purchases made by the customer. The location code of the final customer or where the goods would be used is not necessarily the same as the initial ship-to location. -
LocationOfFinalDischargeId: integer
(int64)
Value that uniquely identifies the final discharge location.
-
MaximumOvershipmentPercentage: number
Maximum percent above the requested quantity that can ship on a shipment line.
-
MaximumUndershipmentPercentage: number
Maximum percent below the requested quantity that can ship on a shipment line.
-
ModeOfTransportCode: string
Maximum Length:
30
Abbreviation that identifies the mode of transport for the shipping method. A list of accepted values is defined in the lookup WSH_MODE_OF_TRANSPORT. -
notes: array
Notes
Title:
Notes
The Notes resource manages details about shipment line notes, such as packing instructions and shipping instructions. -
Order: string
Read Only:
true
Maximum Length:150
Sales order number from the application that stores the order. -
OrderLine: string
Maximum Length:
150
Sales order line number from the application that stores the order. -
OrderSchedule: string
Maximum Length:
150
Sales order shipment number from the application that stores the order. -
OrderTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation the identifies the type of source document. The default value is SALES_ORDER. A list of accepted values is defined in the lookup ORA_WSH_ORDER_LINE_TYPE. -
OrganizationCode: string
Maximum Length:
240
Abbreviation that identifies the ship-from organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
OrganizationName: string
Maximum Length:
240
Name of the inventory organization. -
OriginalItemConvertedQuantity: number
Read Only:
true
Shipped or backordered quantity of the line converted to an original item and ordered UOM. -
ParentItem: string
Maximum Length:
240
Name of the parent item. -
ParentItemId: integer
(int64)
Value that uniquely identifies the parent item.
-
ParentSourceOrderFulfillmentLineId: integer
(int64)
Value that uniquely identifies the source shipment of the parent item.
-
ProductCategoryCode: string
Maximum Length:
240
Abbreviation that identifies the product category of the transaction line. -
ProductFiscalClassification: string
Maximum Length:
250
Category of the attachment. -
ProductFiscalClassificationId: integer
(int64)
Value that uniquely identifies the product fiscal classification of the transaction line.
-
ProductTypeCode: string
Maximum Length:
240
Abbreviation that identifies the product type of the inventory item. -
ProjectCostingProjectId: integer
(int64)
Value that uniquely identifies the project for standardized project cost collection.
-
ProjectCostingProjectName: string
Maximum Length:
240
Name of the project for standardized project cost collection. This attribute is associated with a feature that requires opt in. -
ProjectCostingProjectNumber: string
Maximum Length:
25
Number that identifies the project for standardized project cost collection. -
ProjectCostingTaskId: integer
(int64)
Value that uniquely identifies the task for standardized project cost collection.
-
ProjectCostingTaskName: string
Maximum Length:
255
Name of the task for standardized project cost collection. This attribute is associated with a feature that requires opt in. -
ProjectCostingTaskNumber: string
Maximum Length:
100
Number that identifies the task for standardized project cost collection. -
ProjectSalesOrderFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then project details available with source application. If false, then project details are not available with source application. This attribute does not have a default value. -
QuantityUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure for the requested quantity on the source order line. -
ReleaseLockFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then release any existing lock against the fulfillment lines. If false, then retain any existing locks. The default value is false. -
RequestedDate: string
(date-time)
Date when the customer requested the order line.
-
RequestedDateTypeCode: string
Maximum Length:
30
Abbreviation that indicates whether the requested date occurs when the material ships or when it arrives. -
ScheduledShipDate: string
(date-time)
Date when the order line is scheduled to be shipped.
-
SecondaryBackorderedQuantity: number
Read Only:
true
Backordered quantity in the secondary unit of measure. -
SecondaryConvertedQuantity: number
Read Only:
true
Secondary shipped or backordered quantity converted into ordered quantity unit. -
SecondaryQuantityUOM: string
Read Only:
true
Maximum Length:25
Secondary unit of measure for the requested quantity on the source order line. -
SecondaryQuantityUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the secondary unit of measure for the requested quantity on the source order line. -
SecondarySourceRequestedQuantity: number
Quantity, in the item's secondary unit of measure, requested on the source order line.
-
SecondarySourceRequestedQuantityUOM: string
Maximum Length:
25
Secondary unit of measure for the requested quantity on the source order line. -
SecondarySourceRequestedQuantityUOMCode: string
Maximum Length:
3
Abbreviation that identifies the secondary unit of measure for the requested quantity on the source order line. -
SecondaryStagedQuantity: number
Read Only:
true
Quantity of the order line that is staged in the secondary unit of measure. -
SellingPrice: number
Unit of measure for the requested quantity on the source order line.
-
SellingPriceCurrency: string
Maximum Length:
15
Value that uniquely identifies the type of currency used for the selling price. -
ServiceLevelCode: string
Maximum Length:
30
Abbreviation that identifies the service level for the shipping method. A list of accepted values is defined in the lookup WSH_SERVICE_LEVELS. -
ShipmentPriorityCode: string
Maximum Length:
30
Abbreviation that identifies the priority of the demand lines to ship. A list of acceptable values is defined in the lookup WSH_SHIPPING_PRIORITY. -
ShipmentSet: string
Maximum Length:
150
Shipment set that contains the order line. -
ShippedQuantity: number
Read Only:
true
Quantity that was shipped in the requested unit of measure. -
ShipToContact: string
Maximum Length:
360
Person to contact at the ship-to customer site. -
ShipToContactId: integer
(int64)
Value that uniquely identifies the ship-to contact for the shipment line.
-
ShipToContactNumber: string
Maximum Length:
30
Number that identifies the person to contact at the ship-to customer. -
ShipToCustomer: string
Maximum Length:
360
Name of the party who receives the sales order line that ships. -
ShipToCustomerNumber: string
Maximum Length:
30
Number that identifies the ship-to party. -
ShipToPartyId: integer
(int64)
Value that uniquely identifies the ship-to party.
-
ShipToPartySiteId: integer
(int64)
Value that uniquely identifies the ship-to party site.
-
ShipToPartySiteNumber: string
Maximum Length:
150
Number that identifies the ship-to party site. -
SoldToContact: string
Maximum Length:
360
Person to contact at the sold-to customer site. -
SoldToContactId: integer
(int64)
Value that uniquely identifies the sold-to contact for the shipment line.
-
SoldToContactNumber: string
Maximum Length:
30
Number that identifies the person to contact at the sold-to customer. -
SoldToCustomer: string
Maximum Length:
360
Name of the party who purchased the sales order line. -
SoldToCustomerNumber: string
Maximum Length:
30
Number that identifies the sold-to party. -
SoldToPartyId: integer
(int64)
Value that uniquely identifies the sold-to party.
-
SourceLineUpdateDate: string
(date-time)
Date when the source line was most recently updated.
-
SourceOrder: string
Read Only:
true
Maximum Length:150
Number that identifies the source order header. -
SourceOrderFulfillmentLine: string
Maximum Length:
150
Number that identifies the source order fulfillment line within the source order line. -
SourceOrderFulfillmentLineId: integer
(int64)
Value that uniquely identifies the source order fulfillment line.
-
SourceOrderLine: string
Maximum Length:
150
Number that identifies the source order line within the source order header. -
SourceRequestedQuantity: number
Quantity requested by the customer on the source order line.
-
SourceRequestedQuantityUOM: string
Maximum Length:
25
Unit of measure for the requested quantity on the source order line. -
SourceRequestedQuantityUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for the requested quantity on the source order line. -
SourceSubinventory: string
Subinventory from which the requested item should be picked if the material is available.
-
SourceSystem: string
Read Only:
true
Maximum Length:80
Name of the source application. -
SourceSystemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the source application. -
SrcAttribute1: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the first user descriptive flexfield. -
SrcAttribute10: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the tenth user descriptive flexfield. -
SrcAttribute11: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the eleventh user descriptive flexfield. -
SrcAttribute12: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the twelfth user descriptive flexfield. -
SrcAttribute13: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the thirteenth user descriptive flexfield. -
SrcAttribute14: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the fourteenth user descriptive flexfield. -
SrcAttribute15: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the fifteenth user descriptive flexfield. -
SrcAttribute16: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the sixteenth user descriptive flexfield. -
SrcAttribute17: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the seventeenth user descriptive flexfield. -
SrcAttribute18: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the eighteenth user descriptive flexfield. -
SrcAttribute19: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the nineteenth user descriptive flexfield. -
SrcAttribute2: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the second user descriptive flexfield. -
SrcAttribute20: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the twentieth user descriptive flexfield. -
SrcAttribute3: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the third user descriptive flexfield. -
SrcAttribute4: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield. -
SrcAttribute5: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield. -
SrcAttribute6: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the sixth user descriptive flexfield. -
SrcAttribute7: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the seventh user descriptive flexfield. -
SrcAttribute8: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the eighth user descriptive flexfield. -
SrcAttribute9: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the ninth user descriptive flexfield. -
SrcAttributeCategory: string
Maximum Length:
30
Value that identifies the category for the source application descriptive flexfields. -
SrcAttributeDate1: string
(date)
Date that indicates the source application descriptive flexfield segment of the first user descriptive flexfield.
-
SrcAttributeDate2: string
(date)
Date that indicates the source application descriptive flexfield segment of the second user descriptive flexfield.
-
SrcAttributeDate3: string
(date)
Date that indicates the source application descriptive flexfield segment of the third user descriptive flexfield.
-
SrcAttributeDate4: string
(date)
Date that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield.
-
SrcAttributeDate5: string
(date)
Date that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield.
-
SrcAttributeNumber1: number
Number that indicates the source application descriptive flexfield segment of the first user descriptive flexfield.
-
SrcAttributeNumber10: number
Number that indicates the source application descriptive flexfield segment of the tenth user descriptive flexfield.
-
SrcAttributeNumber2: number
Number that indicates the source application descriptive flexfield segment of the second user descriptive flexfield.
-
SrcAttributeNumber3: number
Number that indicates the source application descriptive flexfield segment of the third user descriptive flexfield.
-
SrcAttributeNumber4: number
Number that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield.
-
SrcAttributeNumber5: number
Number that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield.
-
SrcAttributeNumber6: number
Number that indicates the source application descriptive flexfield segment of the sixth user descriptive flexfield.
-
SrcAttributeNumber7: number
Number that indicates the source application descriptive flexfield segment of the seventh user descriptive flexfield.
-
SrcAttributeNumber8: number
Number that indicates the source application descriptive flexfield segment of the eighth user descriptive flexfield.
-
SrcAttributeNumber9: number
Number that indicates the source application descriptive flexfield segment of the ninth user descriptive flexfield.
-
SrcAttributeTimestamp1: string
(date-time)
Date and time that indicates the source application descriptive flexfield segment of the first user descriptive flexfield.
-
SrcAttributeTimestamp2: string
(date-time)
Date and time that indicates the source application descriptive flexfield segment of the second user descriptive flexfield.
-
SrcAttributeTimestamp3: string
(date-time)
Date and time that indicates the source application descriptive flexfield segment of the third user descriptive flexfield.
-
SrcAttributeTimestamp4: string
(date-time)
Date and time that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield.
-
SrcAttributeTimestamp5: string
(date-time)
Date and time that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield.
-
StagedQuantity: number
Read Only:
true
Quantity of the order line that is staged. -
TaxationCountryCode: string
Maximum Length:
2
Abbreviation that identifies the country where the transaction has taken place for taxation purposes. -
TaxClassificationCode: string
Maximum Length:
50
Abbreviation that identifies the tax classification, a grouping of taxes for reporting, and processing purposes. -
TaxExemptionCertificateNumber: string
Maximum Length:
80
Number that identifies the tax exemption certificate. -
TaxExemptionReasonCode: string
Maximum Length:
30
Abbreviation that identifies the tax exemption reason. -
TaxInvoiceDate: string
(date)
Date and time when the tax invoice used to meet specific tax reporting requirements of different countries was generated.
-
TaxInvoiceNumber: string
Maximum Length:
150
Number of the tax invoice used to meet specific tax reporting requirements of different countries. -
ThirdPartyTaxRegistrationId: integer
(int64)
Value that uniquely identifies the third party tax registration for the transaction.
-
ThirdPartyTaxRegistrationNumber: string
Maximum Length:
30
Number that identifies the third-party tax registration for the transaction. -
TradeComplianceDate: string
(date-time)
Date when the trade compliance status was updated.
-
TradeComplianceReason: string
Maximum Length:
2000
Reason for the trade compliance screening status. -
TradeComplianceStatusCode: string
Maximum Length:
30
Abbreviation that identifies the status of the trade compliance screening of the shipment line. A list of acceptable values is defined in the lookup ORA_WSH_TRD_COMP_STATUS. -
TransactionBusinessCategoryCode: string
Maximum Length:
240
Abbreviation that identifies the business classification used by Oracle Fusion Tax to identify and categorize an external transaction into a Oracle Fusion Tax transaction. -
TransportationPlanningDate: string
(date-time)
Date when the transportation planning of the shipment line is received.
-
TransportationPlanningStatusCode: string
Maximum Length:
30
Abbreviation that identifies the status of the transportation planning of the shipment line. A list of acceptable values is defined in the lookup ORA_WSH_TRAN_PLAN_STATUS. -
TransportationShipment: string
Maximum Length:
101
Value that identifies the planned shipment from the transportation management application. -
TransportationShipmentLine: string
Maximum Length:
101
Value that identifies the planned shipment line from the transportation management application. -
UnitPrice: number
Price of item for each unit.
-
UserDefinedFiscalClassificationCode: string
Maximum Length:
30
Abbreviation that identifies the classification for any tax requirement that you cannot define using the existing fiscal classification types.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource manages details about shipment line attachments.
Show Source
Nested Schema : Flexfields for Shipment Lines
Type:
array
Title:
Flexfields for Shipment Lines
The Flexfields for Shipment Lines resource manages details about shipment lines.
Show Source
Nested Schema : Errors
Type:
array
Title:
Errors
The Errors resource manages errors encountered while processing an order from the interface to the base tables.
Show Source
Nested Schema : Holds
Type:
array
Title:
Holds
The Holds resource manages details about shipment line holds.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The Notes resource manages details about shipment line notes, such as packing instructions and shipping instructions.
Show Source
Nested Schema : shipmentLineTransactionRequests-shipmentLines-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the document. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON formatted string containing information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attached file. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) that locates the attachment. This attribute contains a value only if the attachment type is a URL. This is the reference to the file uploaded in the Oracle WebCenter Content server. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the user most recently updated the attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application that is identified by the MODULE_ID. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. This attribute contains a value only if the attachment type is a URL. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : shipmentLineTransactionRequests-shipmentLines-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for shipment lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for shipment lines. -
DeliveryDetailInterfaceId: integer
(int64)
Value that uniquely identifies the shipment line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLineTransactionRequests-shipmentLines-errors-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who received the error. -
CreationDate: string
(date-time)
Read Only:
true
Date when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the error. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30
Name of the error message. -
MessageText: string
Maximum Length:
4000
Text of the error message.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLineTransactionRequests-shipmentLines-holds-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the hold. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the hold. -
HoldActionCode: string
Maximum Length:
30
Abbreviation that identifies the action code for the hold. -
HoldId: integer
(int64)
Value that uniquely identifies the hold type.
-
HoldReason: string
Maximum Length:
2000
Description of the reason for the hold. -
HoldReasonCode: string
Maximum Length:
100
Value that uniquely identifies the action to be run for this hold request. Valid vales are APPLY_HOLD and RELEASE_HOLD. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the hold. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the hold. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLineTransactionRequests-shipmentLines-notes-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
Value that uniquely identifies the relationship. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
Abbreviation that identifies the corporate currency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the note. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the note. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Value that uniquely identifies the person who created the note. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
Type of currency conversion rate. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Abbreviation that identifies the currency. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Contains one of the following values: true or false. If true, then the user can delete the note. If false, then the user cannot delete the note. The default value is false. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
Email address of the user who created the note. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
Address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
Phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the user most recently updated the note. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the note. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Login that the user used when updating the note. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
Value that uniquely identifies the note. -
NoteNumber: string
Maximum Length:
30
The alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
Text of the actual note. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
Abbreviation that identifies the category of the note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
Value that uniquely identifies the parent note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
Value that uniquely identifies the party for the note. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
Name of the user who created the record. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
Abbreviation that identifies the object that the OBJECTS metadata defines for the note. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
Value that uniquely identifies the object that the OBJECTS metadata defines for the note. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Contains one of the following values: true or false. If true, then the user can update the note. If false, then the user cannot update the note. The default value is false. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
Abbreviation that identifies the visibility level of the note.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- DFF
-
Parameters:
- DeliveryDetailInterfaceId:
$request.path.DeliveryDetailInterfaceId
- TransactionId:
$request.path.TransactionId
The Flexfields for Shipment Lines resource manages details about shipment lines. - DeliveryDetailInterfaceId:
- attachments
-
Parameters:
- DeliveryDetailInterfaceId:
$request.path.DeliveryDetailInterfaceId
- TransactionId:
$request.path.TransactionId
The Attachments resource manages details about shipment line attachments. - DeliveryDetailInterfaceId:
- errors
-
Parameters:
- DeliveryDetailInterfaceId:
$request.path.DeliveryDetailInterfaceId
- TransactionId:
$request.path.TransactionId
The Errors resource manages errors encountered while processing an order from the interface to the base tables. - DeliveryDetailInterfaceId:
- holds
-
Parameters:
- DeliveryDetailInterfaceId:
$request.path.DeliveryDetailInterfaceId
- TransactionId:
$request.path.TransactionId
The Holds resource manages details about shipment line holds. - DeliveryDetailInterfaceId:
- notes
-
Parameters:
- DeliveryDetailInterfaceId:
$request.path.DeliveryDetailInterfaceId
- TransactionId:
$request.path.TransactionId
The Notes resource manages details about shipment line notes, such as packing instructions and shipping instructions. - DeliveryDetailInterfaceId:
Examples
This example describes how to get one shipment line.
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/shipmentLineTransactionRequests/TransactionId/child/shipmentLines/DeliveryDetailInterfaceId"
For example, the following command gets one shipment line:
curl -u username:password "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines/300100171231594"
Example Response Body
The following shows an example of the response body in JSON format.
{ "DeliveryDetailInterfaceId": 300100171231594, "LineActionType": "CREATE", "OrderTypeCode": "SALES_ORDER", "Order": "WSH-1541616290", "OrderLine": "1", "OrderSchedule": null, "SourceOrder": "WSH-1541616290", "SourceOrderLine": "1", "SourceOrderFulfillmentLine": "1", "SourceOrderFulfillmentLineId": 1001, "OrganizationId": 208, "OrganizationCode": null, "OrganizationName": null, "ItemId": 149, "Item": null, "ItemDescription": null, "RequestedDate": "2012-08-26T00:00:00+00:00", "ScheduledShipDate": "2012-08-26T00:00:00+00:00", "RequestedDateTypeCode": null, "FreightTermsCode": null, "ShipmentPriorityCode": null, "FOBCode": null, "GradeCode": null, "CustomerPONumber": null, "CustomerItem": null, "ShippedQuantity": null, "ConvertedQuantity": null, "StagedQuantity": null, "BackorderedQuantity": null, "QuantityUOMCode": null, "SecondaryConvertedQuantity": null, "SecondaryStagedQuantity": null, "SecondaryBackorderedQuantity": null, "SecondaryQuantityUOMCode": null, "SecondaryQuantityUOM": null, "SourceRequestedQuantity": 3, "SourceRequestedQuantityUOMCode": "Ea", "SourceRequestedQuantityUOM": null, "SecondarySourceRequestedQuantity": null, "SecondarySourceRequestedQuantityUOMCode": null, "SecondarySourceRequestedQuantityUOM": null, "BusinessUnitId": 204, "BusinessUnit": null, "CarrierId": 12521, "Carrier": null, "CarrierNumber": null, "ModeOfTransportCode": "AIR", "ServiceLevelCode": "2DA", "EarliestPickupDate": null, "LatestPickupDate": null, "EarliestDropoffDate": null, "LatestDropoffDate": null, "ShipToPartyId": 1006, "ShipToCustomer": null, "ShipToCustomerNumber": null, "ShipToPartySiteId": 1089, "ShipToPartySiteNumber": null, "ShipToContactId": 1560, "ShipToContact": null, "ShipToContactNumber": null, "SoldToPartyId": 1006, "SoldToCustomer": null, "SoldToCustomerNumber": null, "SoldToContactId": null, "SoldToContact": null, "SoldToContactNumber": null, "BillToPartyId": 1006, "BillToCustomer": null, "BillToCustomerNumber": null, "BillToPartySiteId": 1090, "BillToPartySiteNumber": null, "BillToContactId": 1560, "BillToContact": null, "BillToContactNumber": null, "ShipmentSet": null, "ArrivalSet": null, "SourceLineUpdateDate": "2018-11-07T18:44:51+00:00", "SourceSystemId": 100000011825006, "SourceSystem": "OPS, "UnitPrice": 100, "Currency": "USD", "SellingPrice": null, "SellingPriceCurrency": "USD", "ReleaseLockFlag": null, "ParentItemId": null, "ParentItem": null, "ParentSourceOrderFulfillmentLineId": null, "BaseItemId": null, "BaseItem": null, "EndAssemblyItem": null, "SourceSubinventory": null, "DoNotShipBeforeDate": null, "DoNotShipAfterDate": null, "MaximumOvershipmentPercentage": null, "MaximumUndershipmentPercentage": null, "TaxationCountryCode": null, "FirstPartyTaxRegistrationId": null, "FirstPartyTaxRegistrationNumber": null, "ThirdPartyTaxRegistrationId": null, "ThirdPartyTaxRegistrationNumber": null, "LocationOfFinalDischargeId": null, "LocationOfFinalDischargeCode": null, "DocumentFiscalClassificationCode": null, "TransactionBusinessCategoryCode": null, "UserDefinedFiscalClassificationCode": null, "TaxInvoiceNumber": null, "TaxInvoiceDate": null, "ProductCategoryCode": null, "IntendedUseClassificationId": null, "IntendedUse": null, "ProductTypeCode": null, "AssessableValue": null, "TaxClassificationCode": null, "TaxExemptionCertificateNumber": null, "TaxExemptionReasonCode": null, "ProductFiscalClassificationId": null, "ProductFiscalClassification": null, "TransportationPlanningStatusCode": null, "TransportationPlanningDate": null, "TransportationShipment": null, "TransportationShipmentLine": null, "InitialDestinationId": null, "TradeComplianceStatusCode": null, "TradeComplianceDate": null, "TradeComplianceReason": null, "ProjectSalesOrderFlag": null, "SrcAttributeCategory": null, "SrcAttribute1": null, "SrcAttribute2": null, "SrcAttribute3": null, "SrcAttribute4": null, "SrcAttribute5": null, "SrcAttribute6": null, "SrcAttribute7": null, "SrcAttribute8": null, "SrcAttribute9": null, "SrcAttribute10": null, "SrcAttribute11": null, "SrcAttribute12": null, "SrcAttribute13": null, "SrcAttribute14": null, "SrcAttribute15": null, "SrcAttribute16": null, "SrcAttribute17": null, "SrcAttribute18": null, "SrcAttribute19": null, "SrcAttribute20": null, "SrcAttributeNumber1": null, "SrcAttributeNumber2": null, "SrcAttributeNumber3": null, "SrcAttributeNumber4": null, "SrcAttributeNumber5": null, "SrcAttributeNumber6": null, "SrcAttributeNumber7": null, "SrcAttributeNumber8": null, "SrcAttributeNumber9": null, "SrcAttributeNumber10": null, "SrcAttributeDate1": null, "SrcAttributeDate2": null, "SrcAttributeDate3": null, "SrcAttributeDate4": null, "SrcAttributeDate5": null, "SrcAttributeTimestamp1": null, "SrcAttributeTimestamp2": null, "SrcAttributeTimestamp3": null, "SrcAttributeTimestamp4": null, "SrcAttributeTimestamp5": null, "CreatedBy": "WHSE_MGR_ALL_INV_ORGS", "CreationDate": "2018-11-07T18:44:51.042+00:00", "LastUpdateDate": "2018-11-07T18:44:51+00:00", "LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines/300100171231594", "name": "shipmentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines/300100171231594", "name": "shipmentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593", "name": "shipmentLineTransactionRequests", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines/300100171231594/child/errors", "name": "errors", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines/300100171231594/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines/300100171231594/child/attachments", "name": "attachments", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines/300100171231594/child/holds", "name": "holds", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/shipmentLineTransactionRequests/300100171231593/child/shipmentLines/300100171231594/child/notes", "name": "notes", "kind": "collection" } ] }