Get one shipment line
get
/fscmRestApi/resources/11.13.18.05/shipmentLines/{ShipmentLine}
Request
Path Parameters
-
ShipmentLine(required): integer(int64)
Value that uniquely identifies the shipment line.
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:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : shipmentLines-item-response
Type:
Show Source
object-
AllowItemSubstitutionFlag: boolean
Read Only:
trueMaximum Length:1Contains one of the following values: true or false. If true, then allow item substitution. If false, then do not allow item substitution. This attribute does not have a default value. This attribute is not currently used. -
ArrivalSet: string
Read Only:
trueMaximum Length:150Arrival set that contains the order line. -
AssessableValue: number
Read Only:
trueValue of the item. Each tax authority can use a different assessable value for each item. The tax authority uses this attribute for taxation purposes. -
attachments: array
Attachments for Shipment Lines
Title:
Attachments for Shipment LinesThe Attachments for Shipment Lines resource manages details about shipment line attachments. -
BackorderedQuantity: number
Read Only:
trueQuantity that the application withholds from processing until inventory becomes available. -
BaseItem: string
Read Only:
trueMaximum Length:300Name of the model to use for an assemble-to-order configured item. -
BaseItemDescription: string
Read Only:
trueMaximum Length:240Description of the model to use for an assemble-to-order configured item. -
BaseItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the model to use for an assemble-to-order configured item. -
BillToAddress1: string
Maximum Length:
240First line of the bill-to customer address. -
BillToAddress2: string
Maximum Length:
240Second line of the bill-to customer address. -
BillToAddress3: string
Maximum Length:
240Third line of the bill-to customer address. -
BillToAddress4: string
Maximum Length:
240Fourth line of the bill-to customer address. -
BillToCity: string
Maximum Length:
60City of the bill-to customer address. -
BillToContact: string
Maximum Length:
360Name of the person to contact at the bill-to customer site. -
BillToContactFirstName: string
Read Only:
trueFirst name of the person to contact at the bill-to customer site. -
BillToContactId: integer
(int64)
Read Only:
trueValue that uniquely identifies the bill-to contact for the order line. -
BillToContactLastName: string
Read Only:
trueLast name of the person to contact at the bill-to customer site. -
BillToContactPhone: string
Maximum Length:
40Phone number of the person to contact at the bill-to customer site. -
BillToCountry: string
Maximum Length:
80Country of the bill-to customer address. -
BillToCounty: string
Maximum Length:
60County of the bill-to customer address. -
BillToCustomer: string
Read Only:
trueMaximum Length:360Name of the party to bill for the sales order line. -
BillToCustomerNumber: string
Read Only:
trueMaximum Length:30Number that identifies the party to bill for the sales order line. -
BillToEmail: string
Read Only:
trueEmail of the person to contact at the bill-to customer site. -
BillToFax: string
Maximum Length:
40Fax number of the bill-to customer. -
BillToLocationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the bill-to location for the order line. -
BillToPartyId: integer
(int64)
Read Only:
trueValue that uniquely identifies the bill-to party for the order line. -
BillToPartySiteId: integer
(int64)
Read Only:
trueValue that uniquely identifies the bill-to party site. -
BillToPartySiteNumber: string
Read Only:
trueMaximum Length:30Number that identifies the bill-to party site. -
BillToPostalCode: string
Maximum Length:
60Postal code of the bill-to customer address. -
BillToRegion: string
Maximum Length:
60Region of the bill-to customer address. -
BillToState: string
Maximum Length:
60State of the bill-to customer address. -
BillToURL: string
Maximum Length:
2000URL (Uniform Resource Locator) of the bill-to customer. -
BusinessUnit: string
Read Only:
trueName of the selling business unit. -
BusinessUnitId: integer
(int64)
Read Only:
trueValue that uniquely identifies the selling business unit. -
CancelBackorders: string
Read Only:
trueMaximum Length:1Indicates if the remaining quantity on the shipment line can be automatically canceled during the pick release, pick confirm, and ship confirm processes. -
CancelledQuantity: number
Read Only:
trueQuantity that was canceled. -
Carrier: string
Title:
NameRead Only:trueMaximum Length:360Name of the carrier who transports the shipment. -
CarrierId: integer
(int64)
Read Only:
trueValue that uniquely identifies the carrier. -
CarrierNumber: string
Title:
Registry IDRead Only:trueMaximum Length:30Number that identifies the carrier who transports the shipment. -
ConversionDate: string
(date)
Read Only:
trueDate when the currency conversion occurred. -
ConversionRate: number
Read Only:
trueRate of the currency conversion. -
ConversionTypeCode: string
Read Only:
trueMaximum Length:80If the sales order does not use the same currency that the shipping cost uses, then this attribute specifies the abbreviation that identifies the currency conversion type to use when converting the currency. -
ConvertedQuantity: number
Read Only:
trueShipped or backordered quantity of the line converted to the ordered UOM. -
ConvertedRequestedQuantity: number
Read Only:
trueRequested quantity of the shipment line in order UOM. -
costs: array
Costs for Shipment Lines
Title:
Costs for Shipment LinesThe Costs for Shipment Lines resource manages details about the shipping costs for an item. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the shipment line. -
CreationDate: string
(date-time)
Read Only:
trueDate when the application created the shipment line. -
CurrencyCode: string
Read Only:
trueMaximum Length:15Abbreviation that identifies the currency of the shipment line. -
CurrencyName: string
Read Only:
trueMaximum Length:80Currency of the shipment line. -
CurrentBackorderedQuantityFromEvent: number
Read Only:
trueQuantity back ordered currently for the shipment line when publishing a back order. -
CustomerItem: string
Read Only:
trueMaximum Length:150Number that identifies the customer item. -
CustomerItemDescription: string
Read Only:
trueMaximum Length:240Description of the customer item. -
CustomerItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the customer item. -
CustomerPONumber: string
Read Only:
trueMaximum Length:50Number that identifies the customer purchase order. -
DeliveredQuantity: number
Read Only:
trueQuantity that the shipper delivers. -
DestinationOrganizationCode: string
Read Only:
trueMaximum Length:255Value of the Destination Organization Code that's retrieved when the Source Document Type is Transfer Order. -
DocumentFiscalClassification: string
Read Only:
trueValue that indicates the document fiscal classification. -
DocumentFiscalClassificationCode: string
Read Only:
trueMaximum Length:240Abbreviation that identifies the document fiscal classification. -
DoNotShipAfterDate: string
(date-time)
Read Only:
trueDate before when the shipper must ship. -
DoNotShipBeforeDate: string
(date-time)
Read Only:
trueDate after when the shipper must ship. -
EndAssemblyItemNumber: string
Title:
End AssemblyRead Only:trueMaximum Length:300Finished, assembled item to build, using the item shipped on this shipment line. -
EnforceSingleShipment: string
Read Only:
trueMaximum Length:1Indicates if the order can be fulfilled using a single shipment and the remaining quantity can be automatically canceled during the ship confirm process. -
FirstPartyTaxRegistrationId: integer
(int64)
Read Only:
trueValue that uniquely identifies tax registration for the first party of the transaction. The tax authority uses this attribute for taxation purposes. -
FirstPartyTaxRegistrationNumber: string
Read Only:
trueNumber that identifies tax registration for the first party of the transaction. The tax authority uses this attribute for taxation purposes. -
FOB: string
Title:
MeaningRead Only:trueMaximum Length:80Free on board, which indicates the ownership of items that are in transit. A list of accepted values is defined in the lookup type FOB. -
FOBCode: string
Read Only:
trueMaximum Length:30Abbreviation that indicates the ownership of the items that are in transit. A list of accepted values is defined in the lookup type FOB. -
FreightTerms: string
Title:
MeaningRead Only:trueMaximum Length:80Agreement that describes whether the buyer or seller pays the shipping cost of the sales order, and when payment is due. A list of accepted values is defined in the lookup type WSH_FREIGHT_CHARGE_TERMS. -
FreightTermsCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the freight terms. A list of accepted values is defined in the lookup type WSH_FREIGHT_CHARGE_TERMS. -
GrossWeight: integer
Read Only:
trueGross weight of the shipment line. -
InitialDestination: string
Read Only:
trueFirst leg of transportation that the transportation management application planned to deliver the shipment to the final destination. -
InitialDestinationId: integer
(int64)
Title:
Initial DestinationRead Only:trueValue that uniquely identifies the first leg of transportation that the transportation management application planned to deliver the shipment to the final destination. -
IntegrationStatus: string
Title:
MeaningRead Only:trueMaximum Length:80Value that indicates the integration status of a shipment line in an application that resides outside of Oracle applications. A list of accepted values is defined in the lookup type ORA_RCV_EXT_SYS_INTG_STATUS. -
IntegrationStatusCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the integration status of a shipment line in an application that resides outside of Oracle applications. A list of accepted values is defined in the lookup type ORA_RCV_EXT_SYS_INTG_STATUS. -
IntendedUse: string
Read Only:
trueName of the intended use classification. -
IntendedUseClassificationId: number
Read Only:
trueValue that uniquely identifies the Intended use classification. -
InventoryItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the inventory item. -
inventoryStripingDFF: array
Flexfields for Inventory Striping Attributes
Title:
Flexfields for Inventory Striping AttributesThe Flexfields for Inventory Striping Attributes resource manages the details of the inventory striping attributes. The inventory striping attributes are a set of named attributes, project, task, and country of origin. This resource is associated with a feature that requires opt in. -
Item: string
Read Only:
trueMaximum Length:300Value that uniquely identifies the item. -
ItemDescription: string
Read Only:
trueMaximum Length:240Description of the inventory item. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the shipment line. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the shipment line. -
LegalEntity: string
Read Only:
trueName of the legal entity. -
LegalEntityId: integer
Read Only:
trueValue that uniquely identifies the legal entity. -
lineDFF: array
Flexfields for Shipment Lines
Title:
Flexfields for Shipment LinesThe Flexfields for Shipment Lines resource manages details about shipment lines. -
LineGrossWeight: number
Read Only:
trueGross weight of the shipment line. This attribute is associated with a feature that requires opt in. -
LineNetWeight: number
Read Only:
trueNet weight of the shipment line. This attribute is associated with a feature that requires opt in. -
LineSellingPrice: number
Read Only:
trueSelling price of the item. -
LineStatus: string
Read Only:
trueMaximum Length:80Value that indicates the status of the shipment line. Valid values include ready to release, released, staged, shipped, or backordered. A list of accepted values is defined in the lookup type WSH_PICK_STATUS. -
LineStatusCode: string
Read Only:
trueMaximum Length:1Abbreviation that identifies the status code of the shipment line. A list of accepted values is defined in the lookup type WSH_PICK_STATUS. -
LineUnitPrice: number
Read Only:
truePrice of item for each unit. -
LineUnitVolume: number
Read Only:
trueUnit volume of the item on the shipment line. -
LineUnitWeight: number
Read Only:
trueUnit weight of the item on the shipment line. -
LineVolume: number
Read Only:
trueVolume of the material for the shipment line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoadingSequence: integer
Read Only:
trueSequence to use when loading the shipment line. -
LocationOfFinalDischarge: string
Read Only:
trueValue that indicates the location of the final discharge. -
LocationOfFinalDischargeCode: string
Read Only:
trueAbbreviation that identifies the final discharge location. -
LocationOfFinalDischargeId: integer
(int64)
Read Only:
trueValue that uniquely identifies the location of the final discharge. -
Locator: string
Maximum Length:
4000Concatenated name of the inventory locator that provides the source for material that ships. -
LocatorId: integer
(int64)
Read Only:
trueValue that uniquely identifies the item locator for the shipment line. -
LogisticsServiceProviderCustomer: string
Read Only:
trueMaximum Length:360Name of the customer who provides logistics services. This customer sends the order line. -
LogisticsServiceProviderCustomerId: integer
(int64)
Read Only:
trueValue that uniquely identifies the customer who provides logistics services. This customer sends the order line. -
LogisticsServiceProviderCustomerNumber: string
Read Only:
trueMaximum Length:30Number that identifies the customer who provides logistics services. This customer sends the order line. -
lotAttributeDFF: array
Flexfields for Lot Attributes
Title:
Flexfields for Lot AttributesThe Flexfields for Lot Attributes resource manages details about lot attributes. -
LotNumber: string
Read Only:
trueMaximum Length:80Number that identifies the lot for the item. The application uses this attribute when the warehouse places the item under lot control. -
lotStandardDFF: array
Flexfields for Lots
Title:
Flexfields for LotsThe Flexfields for Lots resource manages details about lots. -
MaximumOvershipmentPercentage: integer
Read Only:
trueMaximum percent above the requested quantity that can be shipped for the shipment line. This attribute is not currently used. Use the new tolerance attributes. -
MaximumUndershipmentPercentage: integer
Read Only:
trueMaximum percent below the requested quantity that can be shipped for the shipment line. This attribute is not currently used. Use the new tolerance attributes. -
ModeOfTransport: string
Title:
MeaningRead Only:trueMaximum Length:80Mode of transportation that ships the item. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. -
ModeOfTransportCode: string
Read Only:
trueMaximum Length:30Abbreviation 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. -
MovementRequestLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the movement request line. -
NetWeight: integer
Read Only:
trueNet weight of the shipment line. -
notes: array
Notes for Shipment Lines
Title:
Notes for Shipment LinesThe Notes for Shipment Lines resource manages details about shipment line notes. -
Order: string
Title:
Sales OrderRead Only:trueMaximum Length:150Order number from the order capture application. -
OrderLine: string
Title:
Sales Order LineRead Only:trueMaximum Length:150Order line number from the order capture application. -
OrderSchedule: string
Title:
Sales Order ScheduleRead Only:trueMaximum Length:150Order shipment number from the order capture application. -
OrderType: string
Title:
MeaningRead Only:trueMaximum Length:80Type of source line. -
OrderTypeCode: string
Title:
Order TypeRead Only:trueMaximum Length:30Abbreviation that identifies the type of source line. -
OrganizationCode: string
Read Only:
trueMaximum Length:18Abbreviation that identifies the ship-from organization. -
OrganizationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the inventory organization. -
OrganizationName: string
Read Only:
trueMaximum Length:240Name of the inventory organization. -
OriginalDeliveryDetailId: integer
(int64)
Read Only:
trueValue that uniquely identifies the original shipment line. This attribute is not currently used. -
OriginalItemConvertedQuantity: number
Read Only:
trueShipped or backordered quantity of the line converted to the original item and ordered UOM. -
OriginalItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the original inventory item. This attribute is not currently used. -
OriginalItemNumber: string
Read Only:
trueMaximum Length:255Value that uniquely identifies the original item. This attribute is not currently used. -
OriginalShipmentLineFromEvent: integer
Read Only:
trueValue that uniquely identifies the shipment line from which the quantity was originally backordered. This attribute contains a value different from the shipment line when the parameter to consolidate backorders is enabled. -
OriginalSourceOrderFulfillmentLine: string
Maximum Length:
255Original fulfillment number that identifies the fulfillment line for the order line in the source order. -
OriginalSourceOrderFulfillmentLineId: integer
Original fulfillment value that uniquely identifies the fulfillment line in the source order.
-
OverShipTolerancePercentage: number
Read Only:
trueMaximum percent above the requested quantity that can be shipped on an order line. This attribute is associated with a feature that requires opt in. -
ParentItem: string
Read Only:
trueMaximum Length:300Name of the parent item. -
ParentItemDescription: string
Read Only:
trueMaximum Length:240Description of the parent item. -
ParentItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the parent item. -
ParentPackingUnit: string
Read Only:
trueMaximum Length:30Parent packing unit that contains the item that the shipment line references. -
ParentPackingUnitId: integer
(int64)
Read Only:
trueValue that uniquely identifies the parent packing unit to which the shipment line is packed. -
ParentSourceOrderFulfillmentLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the source shipment of the parent item. -
PendingQuantity: number
Read Only:
trueQuantity from the source order line that the shipper has not yet shipped. -
PendingQuantityFlag: boolean
Read Only:
trueContains one of the following values: true or false. If true, then the pending quantity is greater than zero. If false, then pending quantity is less than or equal to zero. The default value is false. -
PickedQuantity: number
Read Only:
trueQuantity that fulfillment takes from the warehouse to fulfill the sales order. -
PickWave: string
Read Only:
trueMaximum Length:30Name of the group of sales orders that the application released into picking. -
PickWaveId: integer
(int64)
Read Only:
trueValue that uniquely identifies the group of sales orders that the application released into picking. -
POBillToBusinessUnit: string
Read Only:
trueValue that identifies the business unit of purchase order. -
POBillToBusinessUnitId: integer
Read Only:
trueValue that uniquely identifies the bill-to business unit of the purchase order. -
POHeaderId: integer
Read Only:
trueValue that uniquely identifies the purchase order header. -
PONumber: string
Read Only:
trueNumber that identifies the purchase order. -
POSoldToLegalEntity: string
Read Only:
trueName of the sold-to legal entity for the purchase order. -
POSoldToLegalEntityId: integer
Read Only:
trueValue that uniquely identifies the sold-to legal entity of the purchase order. -
PreferredGrade: string
Read Only:
trueMaximum Length:150Abbreviation that identifies the preferred grade of the item. -
PreferredGradeName: string
Read Only:
trueMaximum Length:240Value that indicates the preferred grade of the item. -
ProductCategory: string
Read Only:
trueProduct category of the transaction line. -
ProductCategoryCode: string
Read Only:
trueMaximum Length:240Abbreviation that identifies the product category of the transaction line. -
ProductFiscalClassification: string
Read Only:
trueProduct fiscal classification of the transaction line. -
ProductFiscalClassificationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the product fiscal classification of the transaction line. -
ProductType: string
Read Only:
trueProduct type of the inventory item. -
ProductTypeCode: string
Read Only:
trueMaximum Length:240Abbreviation that identifies the product type of the inventory item. -
ProjectCostingProjectId: integer
(int64)
Read Only:
trueValue that uniquely identifies the project for standardized project cost collection. This attribute is associated with a feature that requires opt in. -
ProjectCostingProjectName: string
Read Only:
trueMaximum Length:240Name of the project for standardized project cost collection. This attribute is associated with a feature that requires opt in. -
ProjectCostingProjectNumber: string
Read Only:
trueMaximum Length:25Number that identifies the project for standardized project cost collection. This attribute is associated with a feature that requires opt in. -
ProjectCostingTaskId: integer
(int64)
Read Only:
trueValue that uniquely identifies the task for standardized project cost collection. This attribute is associated with a feature that requires opt in. -
ProjectCostingTaskName: string
Read Only:
trueMaximum Length:255Name of the task for standardized project cost collection. This attribute is associated with a feature that requires opt in. -
ProjectCostingTaskNumber: string
Read Only:
trueMaximum Length:100Number that identifies the task for standardized project cost collection. This attribute is associated with a feature that requires opt in. -
ProjectSalesOrderFlag: boolean
Title:
Project Sales OrderRead Only:trueMaximum Length:1Contains 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. -
QuickShipStatus: string
Read Only:
trueMaximum Length:30Status of the quick ship process for the shipment line. -
RcvShipmentLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the advanced shipment notice (ASN) for the shipment line that the supplier supplies in receiving. -
RequestedDate: string
(date-time)
Read Only:
trueDate when the customer requested to ship the order line. -
RequestedDateType: string
Title:
MeaningRead Only:trueMaximum Length:80Value that determines whether the requested date occurs when the material ships or when it arrives. -
RequestedDateTypeCode: string
Read Only:
trueMaximum Length:30Abbreviation that indicates whether the requested date occurs when the material ships or when it arrives. -
RequestedQuantity: number
Read Only:
trueQuantity of the item that the sales order line requests, in the primary unit of measure. -
RequestedQuantityUOM: string
Title:
UOM NameRead Only:trueMaximum Length:25Primary unit of measure for the ordered quantity. -
RequestedQuantityUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the primary unit of measure for the ordered quantity. -
reservations: array
Reservations for Shipment Lines
Title:
Reservations for Shipment LinesThe Reservations for Shipment Lines resource manages details about the reservations for a shipment line when the supply is not the on-hand quantity. -
Revision: string
Read Only:
trueMaximum Length:3Revision of the item. -
ScheduledShipDate: string
(date-time)
Read Only:
trueDate when the order line is scheduled to ship. -
SealNumber: string
Read Only:
trueMaximum Length:30Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport. -
SecondaryBackorderedQuantity: number
Read Only:
trueQuantity in the secondary unit of measure for the item that the application withheld from processing until inventory becomes available. -
SecondaryCancelledQuantity: number
Read Only:
trueCanceled quantity in the secondary unit of measure for the item. -
SecondaryConvertedQuantity: number
Read Only:
trueConverted quantity in the secondary unit of measure for the item. -
SecondaryDeliveredQuantity: number
Read Only:
trueDelivered quantity in the secondary unit of measure for the item. -
SecondaryPickedQuantity: number
Read Only:
trueQuantity in the secondary unit of measure for item that fulfillment takes from the warehouse to fulfill the sales order. -
SecondaryRequestedQuantity: number
Read Only:
trueQuantity of the item requested on the sales order line, in the secondary unit of measure. -
SecondaryRequestedQuantityUOM: string
Title:
UOM NameRead Only:trueMaximum Length:25Secondary unit of measure for the ordered quantity. -
SecondaryRequestedQuantityUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the secondary unit of measure for the ordered quantity. -
SecondaryShippedQuantity: number
Read Only:
trueShipped quantity, in the secondary unit of measure. -
SecondarySourceRequestedQuantity: number
Read Only:
trueSecondary unit of measure for the requested quantity on the source order line. -
SecondarySourceRequestedQuantityUOM: string
Title:
UOM NameRead Only:trueMaximum Length:25Secondary unit of measure for the requested quantity on the source order line. -
SecondarySourceRequestedQuantityUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the secondary unit of measure for the requested quantity on the source order line. -
SecondaryStagedQuantity: number
Read Only:
trueStaged quantity in the secondary unit of measure for the item. -
SellingPrice: integer
Read Only:
trueSelling price of the item. -
serials: array
Serials for Shipment Lines
Title:
Serials for Shipment LinesThe Serials for Shipment Lines resource manages details about serial numbers for items in shipment lines. -
ServiceLevel: string
Title:
MeaningRead Only:trueMaximum Length:80Transportation priority that determines how quickly to transport the item. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. -
ServiceLevelCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the service level for the shipping method. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. -
ShipFromAddress1: string
Title:
Address Line 1Read Only:trueMaximum Length:240First line of the ship-from address. -
ShipFromAddress2: string
Title:
Address Line 2Read Only:trueMaximum Length:240Second line of the ship-from address. -
ShipFromAddress3: string
Title:
Address Line 3Read Only:trueMaximum Length:240Third line of the ship-from address. -
ShipFromAddress4: string
Title:
Address Line 4Read Only:trueMaximum Length:240Fourth line of the ship-from address. -
ShipFromCity: string
Title:
Town or CityRead Only:trueMaximum Length:30City of the ship-from address. -
ShipFromCountry: string
Title:
CountryRead Only:trueMaximum Length:60Country of the ship-from address. -
ShipFromCounty: string
Title:
Region 1Read Only:trueMaximum Length:120County of the ship-from address. -
ShipFromLocationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the ship-from location. -
ShipFromPostalCode: string
Title:
Postal CodeRead Only:trueMaximum Length:30Postal code of the ship-from address. -
ShipFromRegion: string
Title:
Region 3Read Only:trueMaximum Length:120Region of the ship-from address. -
ShipFromState: string
Title:
Region 2Read Only:trueMaximum Length:120State of the ship-from address. -
Shipment: string
Read Only:
trueMaximum Length:30Name of the material shipment. -
ShipmentAdviceStatusFlag: boolean
Read Only:
trueMaximum Length:1Contains one of the following values: true or false. If true, then the application sent the shipment advice for the shipped line to the source application. If false, then shipment advice not sent. The default value is false. -
ShipmentId: integer
(int64)
Read Only:
trueValue that uniquely identifies the shipment. -
ShipmentLine: integer
(int64)
Title:
LineRead Only:trueValue that uniquely identifies the shipment line. -
ShipmentSet: string
Read Only:
trueMaximum Length:150Shipment set that contains the order line. -
ShippedQuantity: number
Read Only:
trueShipped quantity, in the requested unit of measure. -
ShippingMethod: string
Read Only:
trueMaximum Length:522Transportation method for the shipment line. -
ShippingMethodCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the transportation method for the shipment line. -
ShippingPriority: string
Title:
MeaningRead Only:trueMaximum Length:80Value that indicates the priority of the demand lines to be shipped. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. -
ShippingPriorityCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the priority of the demand lines to ship. A list of accepted values is defined in the lookup type WSH_SHIPPING_PRIORITY. -
ShippingToleranceBehavior: string
Read Only:
trueValue that indicates the tolerance level while shipping the order lines. Contains one of the following values: Under tolerance or Requested quantity. If Under tolerance, then the order line is closed as soon as the shipped quantity meets the under tolerance level. If Requested quantity, then the order line is closed as soon as the shipped quantity meets the requested quantity level. This attribute is associated with a feature that requires opt in. -
ShipToAddress1: string
Maximum Length:
240First line of the ship-to customer address. -
ShipToAddress2: string
Maximum Length:
240Second line of the ship-to customer address. -
ShipToAddress3: string
Maximum Length:
240Third line of the ship-to customer address. -
ShipToAddress4: string
Maximum Length:
240Fourth line of the ship-to customer address. -
ShipToCity: string
Maximum Length:
60City of the ship-to customer address. -
ShipToContact: string
Maximum Length:
360Name of the person to contact at the ship-to customer site. -
ShipToContactFirstName: string
Read Only:
trueFirst name of the person to contact at the ship-to customer site. -
ShipToContactId: integer
(int64)
Read Only:
trueValue that uniquely identifies the contact at the ship-to location. -
ShipToContactLastName: string
Read Only:
trueLast name of the person to contact at the ship-to customer site. -
ShipToContactPhone: string
Maximum Length:
40Telephone number for the person to contact at the ship-to customer site. -
ShipToCountry: string
Maximum Length:
80Country of the ship-to customer address. -
ShipToCounty: string
Maximum Length:
120County of the ship-to customer address. -
ShipToCustomer: string
Read Only:
trueMaximum Length:360Name of the party who will receive the sales order line that ships. -
ShipToCustomerNumber: string
Read Only:
trueMaximum Length:30Number that identifies the ship-to party. -
ShipToEmail: string
Read Only:
trueEmail of the person to contact at the ship-to customer site. -
ShipToFax: string
Maximum Length:
40Fax number of the ship-to customer. -
ShipToLocationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the ship-to location. -
ShipToLocationType: string
Read Only:
trueMaximum Length:1Defines the ship-to location type. -
ShipToPartyId: integer
(int64)
Read Only:
trueValue that uniquely identifies the ship-to party. -
ShipToPartySiteId: integer
(int64)
Read Only:
trueValue that uniquely identifies the ship-to party site. -
ShipToPartySiteNumber: string
Read Only:
trueMaximum Length:30Number that identifies the ship-to party site. -
ShipToPostalCode: string
Maximum Length:
60Postal code of the ship-to customer address. -
ShipToRegion: string
Maximum Length:
120Region of the ship-to customer address. -
ShipToState: string
Maximum Length:
120State of the ship-to customer address. -
ShipToURL: string
Maximum Length:
2000URL (Uniform Resource Locator) that locates the ship-to customer. -
SoldToContact: string
Maximum Length:
360Name of the person to contact at the sold-to customer site. -
SoldToContactFirstName: string
Read Only:
trueFirst name of the person to contact at the sold-to customer site. -
SoldToContactId: integer
(int64)
Read Only:
trueValue that uniquely identifies the sold-to contact for the shipment line. -
SoldToContactLastName: string
Read Only:
trueLast name of the person to contact at the sold-to customer site. -
SoldToContactPhone: string
Maximum Length:
40Phone number for the person to contact at the sold-to customer site. -
SoldToCustomer: string
Read Only:
trueMaximum Length:360Name of the party who purchased the sales order line. -
SoldToCustomerNumber: string
Read Only:
trueMaximum Length:30Number that identifies the sold-to party. -
SoldToEmail: string
Read Only:
trueEmail of the person to contact at the sold-to customer site. -
SoldToFax: string
Maximum Length:
40Fax number of the sold-to customer. -
SoldToPartyId: integer
(int64)
Read Only:
trueValue that uniquely identifies the sold-to party. -
SoldToURL: string
Maximum Length:
2000URL (Uniform Resource Locator) of the sold-to customer. -
SourceDocumentTypeId: integer
(int64)
Read Only:
trueValue that uniquely identifies the type of source document. -
SourceLineUpdateDate: string
(date-time)
Read Only:
trueDate when the application most recently updated the source line. -
SourceOrder: string
Read Only:
trueMaximum Length:150Number that identifies the source order header. -
SourceOrderFulfillmentLine: string
Read Only:
trueMaximum Length:150Number that identifies the fulfillment line for the order line in the source order. -
SourceOrderFulfillmentLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the fulfillment line in source order. -
SourceOrderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the source order header. -
SourceOrderLine: string
Read Only:
trueMaximum Length:150Number that identifies the source order line in the source order header. -
SourceOrderLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the source order line. -
SourceRequestedQuantity: number
Read Only:
trueQuantity that the customer requested on the source order line. -
SourceRequestedQuantityUOM: string
Title:
UOM NameRead Only:trueMaximum Length:25Unit of measure for the requested quantity on the source order line. -
SourceRequestedQuantityUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the unit of measure for the requested quantity on the source order line. -
SourceSubinventory: string
Read Only:
trueMaximum Length:10If material is available, then this attribute contains the subinventory that the warehouse uses to pick the requested item. -
SourceSystem: string
Read Only:
trueMaximum Length:80Name of the source application. -
SourceSystemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the source application. -
SplitFromShipmentLine: integer
(int64)
Read Only:
trueValue that uniquely identifies the shipment line that the application originally split this line from. -
SrcAttribute1: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the first user descriptive flexfield. -
SrcAttribute10: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the tenth user descriptive flexfield. -
SrcAttribute11: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the eleventh user descriptive flexfield. -
SrcAttribute12: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the twelfth user descriptive flexfield. -
SrcAttribute13: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the thirteenth user descriptive flexfield. -
SrcAttribute14: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the fourteenth user descriptive flexfield. -
SrcAttribute15: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the fifteenth user descriptive flexfield. -
SrcAttribute16: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the sixteenth user descriptive flexfield. -
SrcAttribute17: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the seventeenth user descriptive flexfield. -
SrcAttribute18: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the eighteenth user descriptive flexfield. -
SrcAttribute19: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the nineteenth user descriptive flexfield. -
SrcAttribute2: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the second user descriptive flexfield. -
SrcAttribute20: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the twentieth user descriptive flexfield. -
SrcAttribute3: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the third user descriptive flexfield. -
SrcAttribute4: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield. -
SrcAttribute5: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield. -
SrcAttribute6: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the sixth user descriptive flexfield. -
SrcAttribute7: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the seventh user descriptive flexfield. -
SrcAttribute8: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the eighth user descriptive flexfield. -
SrcAttribute9: string
Read Only:
trueMaximum Length:150Value that indicates the source application descriptive flexfield segment of the ninth user descriptive flexfield. -
SrcAttributeCategory: string
Read Only:
trueMaximum Length:30Value that indicates the source application descriptive flexfield segment. -
SrcAttributeDate1: string
(date)
Read Only:
trueDate that indicates the source application descriptive flexfield segment of the first user descriptive flexfield. -
SrcAttributeDate2: string
(date)
Read Only:
trueDate that indicates the source application descriptive flexfield segment of the second user descriptive flexfield. -
SrcAttributeDate3: string
(date)
Read Only:
trueDate that indicates the source application descriptive flexfield segment of the third user descriptive flexfield. -
SrcAttributeDate4: string
(date)
Read Only:
trueDate that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield. -
SrcAttributeDate5: string
(date)
Read Only:
trueDate that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield. -
SrcAttributeNumber1: number
Read Only:
trueNumber that indicates the source application descriptive flexfield segment of the first user descriptive flexfield. -
SrcAttributeNumber10: number
Read Only:
trueNumber that indicates the source application descriptive flexfield segment of the tenth user descriptive flexfield. -
SrcAttributeNumber2: number
Read Only:
trueNumber that indicates the source application descriptive flexfield segment of the second user descriptive flexfield. -
SrcAttributeNumber3: number
Read Only:
trueNumber that indicates the source application descriptive flexfield segment of the third user descriptive flexfield. -
SrcAttributeNumber4: number
Read Only:
trueNumber that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield. -
SrcAttributeNumber5: number
Read Only:
trueNumber that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield. -
SrcAttributeNumber6: number
Read Only:
trueNumber that indicates the source application descriptive flexfield segment of the sixth user descriptive flexfield. -
SrcAttributeNumber7: number
Read Only:
trueNumber that indicates the source application descriptive flexfield segment of the seventh user descriptive flexfield. -
SrcAttributeNumber8: number
Read Only:
trueNumber that indicates the source application descriptive flexfield segment of the eighth user descriptive flexfield. -
SrcAttributeNumber9: number
Read Only:
trueNumber that indicates the source application descriptive flexfield segment of the ninth user descriptive flexfield. -
SrcAttributeTimestamp1: string
(date-time)
Read Only:
trueDate and time that indicates the source application descriptive flexfield segment of the first user descriptive flexfield. -
SrcAttributeTimestamp2: string
(date-time)
Read Only:
trueDate and time that indicates the source application descriptive flexfield segment of the second user descriptive flexfield. -
SrcAttributeTimestamp3: string
(date-time)
Read Only:
trueDate and time that indicates the source application descriptive flexfield segment of the third user descriptive flexfield. -
SrcAttributeTimestamp4: string
(date-time)
Read Only:
trueDate and time that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield. -
SrcAttributeTimestamp5: string
(date-time)
Read Only:
trueDate and time that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield. -
StagedQuantity: number
Read Only:
trueStaged quantity from items in the sales order. -
Subinventory: string
Read Only:
trueMaximum Length:10Subinventory to use when fulfilling the item to shipped. -
Supplier: string
Read Only:
trueMaximum Length:360Name of the supplier. -
SupplierLotNumber: string
Read Only:
trueMaximum Length:255Number that identifies the lot assigned to the item by the supplier. -
SupplierPartyNumber: string
Read Only:
trueMaximum Length:30Number that identifies the supplier party. -
TareWeight: number
Read Only:
trueWeight of the container of the shipment line. This value is the difference between the gross weight and the net weight. -
TaxationCountry: string
Read Only:
trueCountry where the transaction occurs. The tax authority uses this attribute for taxation purposes. -
TaxationCountryCode: string
Read Only:
trueMaximum Length:2Abbreviation that identifies the country where the transaction occurs. The tax authority uses this attribute for taxation purposes. -
TaxClassification: string
Read Only:
trueValue that indicates the group of taxes for reporting and processing. The tax authority uses this attribute for taxation purposes. -
TaxClassificationCode: string
Read Only:
trueMaximum Length:50Abbreviation that identifies a group of taxes for reporting and processing. The tax authority uses this attribute for taxation purposes. -
TaxExemptionCertificateNumber: string
Read Only:
trueMaximum Length:80Number that identifies the certificate for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxExemptionReason: string
Read Only:
trueValue that indicates the reason for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxExemptionReasonCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the reason for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxInvoiceDate: string
(date)
Read Only:
trueDate and time of the tax invoice that you use to meet tax reporting that different countries require. -
TaxInvoiceNumber: string
Read Only:
trueMaximum Length:150Number of the tax invoice that you use to meet tax reporting that different countries require. -
ThirdPartyTaxRegistrationId: integer
(int64)
Read Only:
trueValue that uniquely identifies tax registration for the third party of the transaction. The tax authority uses this attribute for taxation purposes. -
ThirdPartyTaxRegistrationNumber: string
Read Only:
trueNumber that identifies tax registration for the third party of the transaction. The tax authority uses this attribute for taxation purposes. -
TrackingNumber: string
Read Only:
trueMaximum Length:30Number that uniquely identifies the tracking for the shipment during transportation. The carrier provides this number. -
TradeComplianceDate: string
(date-time)
Title:
Trade Compliance DateRead Only:trueDate when the application updated the trade compliance status. -
TradeComplianceReason: string
Title:
Trade Compliance ReasonRead Only:trueMaximum Length:2000Reason for the trade compliance screening. -
TradeComplianceScreenedFromEvent: string
Read Only:
trueValue that indicates if the shipment line is screened for trade compliance when publishing a back order. -
TradeComplianceScreeningMethod: string
Title:
MeaningRead Only:trueMaximum Length:80Method the application uses to screen the order line for trade compliance. A list of accepted values is defined in the lookup type ORA_WSH_TRD_COMP_SCRN_MTHD. -
TradeComplianceScreeningMethodCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the method the application uses to screen the order line for trade compliance. A list of accepted values is defined in the lookup type ORA_WSH_TRD_COMP_SCRN_MTHD. -
TradeComplianceStatus: string
Title:
MeaningRead Only:trueMaximum Length:80Value that indicates the status of trade compliance screening for the shipment line. -
TradeComplianceStatusCode: string
Title:
Trade Compliance StatusRead Only:trueMaximum Length:30Abbreviation that identifies the status of trade compliance screening for the shipment line. -
TransactionBusinessCategory: string
Read Only:
trueName of the business classification. Oracle Fusion Tax uses this value to identify and categorize each transaction that resides outside of Oracle Fusion Tax into a transaction that resides inside Oracle Fusion Tax. -
TransactionBusinessCategoryCode: string
Read Only:
trueMaximum Length:240Abbreviation that identifies the business classification. Oracle Fusion Tax uses this value to identify and categorize each transaction that resides outside of Oracle Fusion Tax into a transaction that resides inside Oracle Fusion Tax. -
TransportationPlanningDate: string
(date-time)
Title:
Transportation Planning DateRead Only:trueDate when the application received transportation planning for the shipment line. -
TransportationPlanningStatus: string
Title:
MeaningRead Only:trueMaximum Length:80Value that indicates the status of transportation planning for the shipment line. A list of accepted values is defined in the lookup type ORA_WSH_TRAN_PLAN_STATUS. -
TransportationPlanningStatusCode: string
Title:
Transportation Planning StatusRead Only:trueMaximum Length:30Abbreviation that identifies the status of transportation planning for the shipment line. A list of accepted values is defined in the lookup type ORA_WSH_TRAN_PLAN_STATUS. -
TransportationShipment: string
Title:
Transportation ShipmentRead Only:trueMaximum Length:101Value that identifies the planned shipment that the transportation management application provides. -
TransportationShipmentCompleteFromEvent: string
Read Only:
trueValue that indicates if the transportation shipment is completed when publishing a back order. -
TransportationShipmentFromEvent: string
Read Only:
trueValue that identifies the planned shipment from the transportation management application when publishing a back order. -
TransportationShipmentLine: string
Title:
Transportation Shipment LineRead Only:trueMaximum Length:101Value that identifies the planned shipment line that the transportation management application provides. -
TransportationShipmentLineFromEvent: string
Read Only:
trueValue that identifies the planned shipment line from the transportation management application when publishing a back order. -
UnderShipTolerancePercentage: number
Read Only:
trueMaximum percent below the requested quantity that can be shipped on an order line. This attribute is associated with a feature that requires opt in. -
UnitPrice: integer
Read Only:
truePrice of item for each unit. -
UnitVolume: integer
Read Only:
trueUnit volume of the item on the shipment line. -
UnitWeight: integer
Read Only:
trueUnit weight of the item on the shipment line. -
UserDefinedFiscalClassification: string
Read Only:
trueClassification for each tax requirement that you cannot define using the fiscal classification types that already exist. -
UserDefinedFiscalClassificationCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the classification for each tax requirement that you cannot define using the fiscal classification types that already exist. -
Volume: integer
Read Only:
trueVolume of the material for the shipment line. -
VolumeUOM: string
Title:
UOM NameRead Only:trueMaximum Length:25Unit of measure for volume. -
VolumeUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the unit of measure to use for volume. -
WeightUOM: string
Title:
UOM NameRead Only:trueMaximum Length:25Unit of measure for weight. -
WeightUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the unit of measure to use for weight.
Nested Schema : Attachments for Shipment Lines
Type:
arrayTitle:
Attachments for Shipment LinesThe Attachments for Shipment Lines resource manages details about shipment line attachments.
Show Source
Nested Schema : Costs for Shipment Lines
Type:
arrayTitle:
Costs for Shipment LinesThe Costs for Shipment Lines resource manages details about the shipping costs for an item.
Show Source
Nested Schema : Flexfields for Inventory Striping Attributes
Type:
arrayTitle:
Flexfields for Inventory Striping AttributesThe Flexfields for Inventory Striping Attributes resource manages the details of the inventory striping attributes. The inventory striping attributes are a set of named attributes, project, task, and country of origin. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : Flexfields for Shipment Lines
Type:
arrayTitle:
Flexfields for Shipment LinesThe Flexfields for Shipment Lines resource manages details about shipment lines.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Lot Attributes
Type:
arrayTitle:
Flexfields for Lot AttributesThe Flexfields for Lot Attributes resource manages details about lot attributes.
Show Source
Nested Schema : Flexfields for Lots
Type:
arrayTitle:
Flexfields for LotsThe Flexfields for Lots resource manages details about lots.
Show Source
Nested Schema : Notes for Shipment Lines
Type:
arrayTitle:
Notes for Shipment LinesThe Notes for Shipment Lines resource manages details about shipment line notes.
Show Source
Nested Schema : Reservations for Shipment Lines
Type:
arrayTitle:
Reservations for Shipment LinesThe Reservations for Shipment Lines resource manages details about the reservations for a shipment line when the supply is not the on-hand quantity.
Show Source
Nested Schema : Serials for Shipment Lines
Type:
arrayTitle:
Serials for Shipment LinesThe Serials for Shipment Lines resource manages details about serial numbers for items in shipment lines.
Show Source
Nested Schema : shipmentLines-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdIdentifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that uniquely identifies the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueLogin that the user used when creating the document. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the attachment. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the attached document. This attribute is associated with a feature that requires opt in. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the version of the attached document. This attribute is associated with a feature that requires opt in. -
DownloadInfo: string
Title:
DownloadInfoJSON formatted string containing information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) that locates the attachment. This attribute contains a value only if the attachment type is a URL. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when the user most recently updated the attachment. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who most recently updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the document. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeLength of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attachment file. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that the shipment appends to the URI. The shipment gets this value from the endpoint for the application that MODULE_ID identifies. -
Url: string
Title:
UrlMaximum Length:4000URL (Uniform Resource Locator) that locates the attachment. This attribute contains a value only if the attachment type is a URL. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : shipmentLines-costs-item-response
Type:
Show Source
object-
Amount: number
Amount for the shipping cost for each unit.
-
ConversionDate: string
(date)
Date when the application converted the currency.
-
ConversionRate: number
Rate of the currency conversion.
-
ConversionRateType: string
Read Only:
trueMaximum Length:30Type of currency conversion. -
ConversionRateTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of currency conversion. -
CreatedBy: string
Maximum Length:
64User who created the shipping cost. -
CreationDate: string
(date-time)
Date when the user created the shipping cost.
-
CurrencyCode: string
Maximum Length:
15Abbreviation that identifies the currency of the shipping cost. -
CurrencyName: string
Read Only:
trueMaximum Length:80Currency of the shipping cost. -
DeliveryDetailId: integer
(int64)
Value that uniquely identifies the shipment line.
-
DFF: array
Flexfields for Shipping Costs
Title:
Flexfields for Shipping CostsThe Flexfields for Shipping Costs resource manages details about shipping costs. -
FreightCostId: integer
(int64)
Value that uniquely identifies the shipping cost.
-
LastUpdateDate: string
(date-time)
Date when the user most recently updated the shipping cost.
-
LastUpdatedBy: string
Maximum Length:
64User who most recently updated the shipping cost. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LPNId: integer
(int64)
Value that uniquely identifies the container to use when packing the shipment line.
-
PackingUnit: string
Read Only:
trueMaximum Length:30Name of the container to use when packing the item. -
ShippingCost: string
Read Only:
trueMaximum Length:60Name of the cost type that comes predefined in the application. -
ShippingCostTypeCategory: string
Read Only:
trueMaximum Length:80Category of the shipping cost that the application uses to group shipping costs according to similar characteristics. A list of accepted values is defined in the lookup type WSH_FREIGHT_COST_TYPE. -
ShippingCostTypeCategoryCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the category of the shipping cost. A list of accepted values is defined in the lookup type WSH_FREIGHT_COST_TYPE. -
ShippingCostTypeId: integer
(int64)
Value that uniquely identifies the category of the shipping cost.
Nested Schema : Flexfields for Shipping Costs
Type:
arrayTitle:
Flexfields for Shipping CostsThe Flexfields for Shipping Costs resource manages details about shipping costs.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLines-costs-DFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for shipping costs. -
__FLEX_Context_DisplayValue: string
Title:
Context Value -
FreightCostId: integer
(int64)
Value that uniquely identifies the shipping cost.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLines-inventoryStripingDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Descriptive flexfield context name of the inventory striping attributes for shipment lines. This attribute is associated with a feature that requires opt in. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value of the inventory striping attributes for shipment lines. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of OriginName of the country of origin. This attribute is associated with a feature that requires opt in. -
DeliveryDetailId: integer
(int64)
Title:
LineValue that uniquely identifies the shipment line. This attribute is associated with a feature that requires opt in. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectValue that uniquely identifies the inventory attribute project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
ProjectNumber that identifies the inventory attribute project. This attribute is associated with a feature that requires opt in. -
taskId: integer
(int64)
Title:
TaskValue that uniquely identifies the inventory attribute task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
TaskNumber that identifies the inventory attribute task. This attribute is associated with a feature that requires opt in.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLines-lineDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueRead Only:trueMaximum Length:30Descriptive flexfield context name for shipment lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Value -
DeliveryDetailId: integer
(int64)
Title:
LineRead Only:trueValue that uniquely identifies the shipment line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLines-lotAttributeDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for lot attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Value -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotNumber: string
Title:
LotMaximum Length:80Number that identifies the lot for the item. This attribute is used when the warehouse places the item under lot control. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLines-lotStandardDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for lot standards. -
__FLEX_Context_DisplayValue: string
Title:
Context Value -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotNumber: string
Title:
LotMaximum Length:80Number that identifies the lot for the item. The warehouse uses this attribute when it places the item under lot control. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLines-notes-item-response
Type:
Show Source
object-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDValue that uniquely identifies the relationship. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15Abbreviation that identifies the corporate currency. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the note. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the note. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDValue that uniquely identifies the person who created the note. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30Type of currency conversion rate. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15Abbreviation that identifies the currency. -
DeleteFlag: boolean
Title:
Delete IndicatorRead Only:trueContains 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 EmailRead Only:trueMaximum Length:320Email address of the user who created the note. -
FormattedAddress: string
Title:
Primary AddressRead Only:trueAddress of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary PhoneRead Only:truePhone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when the user most recently updated the note. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who most recently updated the note. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32Login that the user used when updating the note. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note IDRead Only:trueValue that uniquely identifies the note. -
NoteNumber: string
Maximum Length:
30The alternate unique identifier of the note. A user key that is system generated or from an external system. -
NoteTitle: string
Title:
TitleMaximum Length:500The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
NoteText of the actual note. -
NoteTypeCode: string
Title:
TypeMaximum Length:30Abbreviation that identifies the category of the note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDValue that uniquely identifies the parent note. -
PartyId: integer
(int64)
Title:
Party IDRead Only:trueValue that uniquely identifies the party for the note. -
PartyName: string
Title:
AuthorRead Only:trueMaximum Length:360Name of the user who created the record. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30Abbreviation that identifies the object that the OBJECTS metadata defines for the note. SHIPPING_LINE identifies the object for each shipment line. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64Value that uniquely identifies the shipment line. -
UpdateFlag: boolean
Title:
Update IndicatorRead Only:trueContains 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:
PrivateMaximum Length:30Default Value:INTERNALAbbreviation that identifies the visibility level of the note.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLines-reservations-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PrimaryReservedQuantity: number
Read Only:
trueReserved quantity in primary unit of measure. -
PrimaryUOM: string
Read Only:
trueMaximum Length:25Primary unit of measure for the reservation quantity. -
PrimaryUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the primary unit of measure for the reservation quantity. -
ProjectId: integer
(int64)
Read Only:
trueValue that uniquely identifies the inventory attribute project. This attribute is associated with a feature that requires opt in. -
ProjectName: string
Read Only:
trueName of the inventory attribute project. This attribute is associated with a feature that requires opt in. -
ProjectNumber: string
Read Only:
trueNumber that identifies the inventory attribute project. This attribute is associated with a feature that requires opt in. -
ReservationId: integer
(int64)
Read Only:
trueValue that uniquely identifies a reservation. -
SecondaryReservedQuantity: number
Read Only:
trueReserved quantity in secondary unit of measure. -
SecondaryUOM: string
Read Only:
trueMaximum Length:25Secondary unit of measure for the reservation quantity. -
SecondaryUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the secondary unit of measure for the reservation quantity. -
SupplyDocumentLine: number
Read Only:
trueNumber that identifies the order line in the supply document. -
SupplyDocumentNumber: string
Read Only:
trueMaximum Length:120Number that identifies the supply document. -
SupplyDocumentSchedule: number
Read Only:
trueNumber that identifies the fulfillment line for the order line in the supply document. -
SupplyDocumentType: string
Read Only:
trueType of order that is supplying the quantity for the reservation. -
TaskId: integer
(int64)
Read Only:
trueValue that uniquely identifies the inventory attribute task. This attribute is associated with a feature that requires opt in. -
TaskName: string
Read Only:
trueName of the inventory attribute task. This attribute is associated with a feature that requires opt in. -
TaskNumber: string
Read Only:
trueNumber that identifies the inventory attribute task. This attribute is associated with a feature that requires opt in.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLines-serials-item-response
Type:
Show Source
object-
attributeDFF: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial AttributesThe Flexfields for Serial Attributes resource manages details about serial attributes for serial numbers. -
DeliveryDetailId: number
Read Only:
trueValue that uniquely identifies the shipment line. -
FromSerialNumber: string
Read Only:
trueMaximum Length:255Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
serialNumbers: array
Serial Numbers
Title:
Serial NumbersThe Serial Numbers resource manages details about individual serial numbers. -
standardDFF: array
Flexfields for Serials
Title:
Flexfields for SerialsThe Flexfields for Serials resource manages details about serial numbers. -
SupplierSerialNumber: string
Read Only:
trueMaximum Length:80Serial number assigned to the item by the supplier. -
ToSerialNumber: string
Read Only:
trueMaximum Length:80Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
TransactionTempId: number
Read Only:
trueValue that uniquely identifies a row in the transaction table for temporary inventory. -
UniqueLineNumber: integer
(int64)
Value that creates a relationship between the serial number and the shipment line. If the line already shipped, then this attribute identifies the shipment line. If the line has not shipped, then this attribute identifies the transaction for a row in a temporary transaction table that references the serial number.
Nested Schema : Flexfields for Serial Attributes
Type:
arrayTitle:
Flexfields for Serial AttributesThe Flexfields for Serial Attributes resource manages details about serial attributes for serial numbers.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Serial Numbers
Type:
arrayTitle:
Serial NumbersThe Serial Numbers resource manages details about individual serial numbers.
Show Source
Nested Schema : Flexfields for Serials
Type:
arrayTitle:
Flexfields for SerialsThe Flexfields for Serials resource manages details about serial numbers.
Show Source
Nested Schema : shipmentLines-serials-attributeDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for serial attributes. -
FmSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionTempId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLines-serials-serialNumbers-item-response
Type:
Show Source
object-
attributeDFF: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial AttributesThe Flexfields for Serial Attributes resource manages details about serial attributes for serial numbers. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial NumberRead Only:trueMaximum Length:80Serial number for the item. The application uses this attribute when the warehouse places the item under serial control. -
standardDFF: array
Flexfields for Serials
Title:
Flexfields for SerialsThe Flexfields for Serials resource manages details about serial numbers.
Nested Schema : Flexfields for Serial Attributes
Type:
arrayTitle:
Flexfields for Serial AttributesThe Flexfields for Serial Attributes resource manages details about serial attributes for serial numbers.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Serials
Type:
arrayTitle:
Flexfields for SerialsThe Flexfields for Serials resource manages details about serial numbers.
Show Source
Nested Schema : shipmentLines-serials-serialNumbers-attributeDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for serial attributes. -
CurrentOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial NumberMaximum Length:80Serial number for the item. The application uses this attribute when the warehouse places the item under serial control.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLines-serials-serialNumbers-standardDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial standards. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for serial standards. -
CurrentOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial NumberMaximum Length:80Serial number for the item. The application uses this attribute when the warehouse places the item under serial control.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLines-serials-standardDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial standards. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for serial standards. -
FmSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionTempId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- attachments
-
Parameters:
- ShipmentLine:
$request.path.ShipmentLine
The Attachments for Shipment Lines resource manages details about shipment line attachments. - ShipmentLine:
- costs
-
Parameters:
- ShipmentLine:
$request.path.ShipmentLine
The Costs for Shipment Lines resource manages details about the shipping costs for an item. - ShipmentLine:
- inventoryStripingDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/shipmentLines/{ShipmentLine}/child/inventoryStripingDFFParameters:
- ShipmentLine:
$request.path.ShipmentLine
The Flexfields for Inventory Striping Attributes resource manages the details of the inventory striping attributes. The inventory striping attributes are a set of named attributes, project, task, and country of origin. This resource is associated with a feature that requires opt in. - ShipmentLine:
- lineDFF
-
Parameters:
- ShipmentLine:
$request.path.ShipmentLine
The Flexfields for Shipment Lines resource manages details about shipment lines. - ShipmentLine:
- lotAttributeDFF
-
Parameters:
- ShipmentLine:
$request.path.ShipmentLine
The Flexfields for Lot Attributes resource manages details about lot attributes. - ShipmentLine:
- lotStandardDFF
-
Parameters:
- ShipmentLine:
$request.path.ShipmentLine
The Flexfields for Lots resource manages details about lots. - ShipmentLine:
- notes
-
Parameters:
- ShipmentLine:
$request.path.ShipmentLine
The Notes for Shipment Lines resource manages details about shipment line notes. - ShipmentLine:
- reservations
-
Parameters:
- ShipmentLine:
$request.path.ShipmentLine
The Reservations for Shipment Lines resource manages details about the reservations for a shipment line when the supply is not the on-hand quantity. - ShipmentLine:
- serials
-
Parameters:
- ShipmentLine:
$request.path.ShipmentLine
The Serials for Shipment Lines resource manages details about serial numbers for items in shipment lines. - ShipmentLine:
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/shipmentLines/ShipmentLine"
For example, the following command gets one shipment line:
curl -u username:password "https://servername/fscmRestApi/resources/version/shipmentLines/203814"
Example Response Body
The following shows an example of the response body in JSON format.
{
"ShipmentLine": 203814,
"OrderTypeCode": "SALES_ORDER",
"OrderType": "Sales order",
"Order": "56190",
"OrderLine": "4.1",
"OrderSchedule": null,
"InventoryItemId": 606,
"Item": "CM11222",
"ItemDescription": "Battery - Extended Life",
"Revision": null,
"UnitPrice": 48,
"SellingPrice": null,
"RequestedQuantity": 56,
"RequestedQuantityUOMCode": "Ea",
"RequestedQuantityUOM": "Each",
"SecondaryRequestedQuantity": null,
"SecondaryRequestedQuantityUOMCode": null,
"SecondaryRequestedQuantityUOM": null,
"FOBCode": "DEST",
"FOB": "DEST",
"FreightTermsCode": "Due",
"FreightTerms": null,
"ShippingPriorityCode": null,
"ShippingPriority": null,
"PreferredGrade": null,
"PreferredGradeName": null,
"CurrencyCode": "USD",
"CurrencyName": "US Dollar",
"ShipmentSet": null,
"ArrivalSet": null,
"CustomerPONumber": null,
"CustomerItemId": null,
"CustomerItem": null,
"CustomerItemDescription": null,
"RequestedDate": "2003-09-29T06:04:37+00:00",
"ScheduledShipDate": "2003-09-29T23:59:59+00:00",
"RequestedDateTypeCode": null,
"RequestedDateType": null,
"ShipToPartyId": 7891,
"ShipToCustomer": "Michael Smith",
"ShipToCustomerNumber": "6328",
"ShipToPartySiteId": null,
"ShipToPartySiteNumber": null,
"ShipToContactId": null,
"ShipToContact": null,
"ShipToContactFirstName": null,
"ShipToContactLastName": null,
"ShipToContactPhone": null,
"ShipToURL": null,
"ShipToFax": null,
"ShipToEmail": null,
"ShipToLocationId": 2541,
"ShipToLocationType": null,
"ShipToAddress1": "2391 L Street",
"ShipToAddress2": null,
"ShipToAddress3": null,
"ShipToAddress4": null,
"ShipToCity": "San Jose",
"ShipToCounty": "Santa Clara",
"ShipToPostalCode": "95106",
"ShipToRegion": null,
"ShipToState": "CA",
"ShipToCountry": "US",
"SoldToPartyId": 7891,
"SoldToCustomer": "Michael Smith",
"SoldToCustomerNumber": "6328",
"Supplier": null,
"SupplierPartyNumber": null,
"SoldToContactId": null,
"SoldToContact": null,
"SoldToContactFirstName": null,
"SoldToContactLastName": null,
"SoldToContactPhone": null,
"SoldToURL": null,
"SoldToFax": null,
"SoldToEmail": null,
"BillToPartyId": null,
"BillToCustomer": null,
"BillToCustomerNumber": null,
"BillToPartySiteId": null,
"BillToPartySiteNumber": null,
"BillToContactId": null,
"BillToContact": null,
"BillToContactFirstName": null,
"BillToContactLastName": null,
"BillToContactPhone": null,
"BillToURL": null,
"BillToFax": null,
"BillToEmail": null,
"BillToLocationId": null,
"BillToAddress1": null,
"BillToAddress2": null,
"BillToAddress3": null,
"BillToAddress4": null,
"BillToCity": null,
"BillToCounty": null,
"BillToPostalCode": null,
"BillToRegion": null,
"BillToState": null,
"BillToCountry": null,
"Subinventory": "Staging1",
"LocatorId": null,
"Locator": null,
"ShippedQuantity": 56,
"SecondaryShippedQuantity": null,
"NetWeight": 168,
"GrossWeight": 168,
"TareWeight": 0,
"WeightUOMCode": "Lbs",
"WeightUOM": "Pounds",
"Volume": 2,
"VolumeUOMCode": "FT3",
"VolumeUOM": "Cubic foot",
"LoadingSequence": null,
"LotNumber": "S50000",
"EndAssemblyItemNumber": null,
"OrganizationId": 207,
"OrganizationCode": "M1",
"OrganizationName": "Tall Manufacturing",
"ParentPackingUnitId": null,
"ParentPackingUnit": null,
"ShipmentId": 57896,
"Shipment": "57896",
"ProjectSalesOrderFlag": null,
"RcvShipmentLineId": null,
"LineStatusCode": "C",
"LineStatus": "Interfaced",
"TrackingNumber": null,
"SealNumber": null,
"PickWaveId": 41214,
"PickWave": "41214",
"SourceOrderId": 88983,
"SourceOrder": "56190",
"SourceOrderLineId": 185573,
"SourceOrderLine": "4.1",
"SourceOrderFulfillmentLineId": null,
"SourceOrderFulfillmentLine": null,
"TaxationCountryCode": null,
"TaxationCountry": null,
"FirstPartyTaxRegistrationId": null,
"FirstPartyTaxRegistrationNumber": null,
"ThirdPartyTaxRegistrationId": null,
"ThirdPartyTaxRegistrationNumber": null,
"LocationOfFinalDischargeId": null,
"LocationOfFinalDischargeCode": null,
"LocationOfFinalDischarge": null,
"DocumentFiscalClassificationCode": null,
"DocumentFiscalClassification": null,
"TransactionBusinessCategoryCode": null,
"TransactionBusinessCategory": null,
"UserDefinedFiscalClassificationCode": null,
"UserDefinedFiscalClassification": null,
"TaxInvoiceNumber": null,
"TaxInvoiceDate": null,
"ProductCategoryCode": null,
"ProductCategory": null,
"IntendedUseClassificationId": null,
"IntendedUse": null,
"ProductTypeCode": null,
"ProductType": null,
"AssessableValue": null,
"TaxClassificationCode": null,
"TaxClassification": null,
"TaxExemptionCertificateNumber": null,
"TaxExemptionReasonCode": null,
"TaxExemptionReason": null,
"ProductFiscalClassificationId": null,
"ProductFiscalClassification": null,
"TransportationPlanningStatusCode": null,
"TransportationPlanningStatus": null,
"TransportationPlanningDate": null,
"TransportationShipment": null,
"TransportationShipmentLine": null,
"InitialDestinationId": null,
"InitialDestination": null,
"TradeComplianceStatusCode": null,
"TradeComplianceStatus": null,
"TradeComplianceDate": null,
"TradeComplianceReason": null,
"TradeComplianceScreeningMethodCode": null,
"TradeComplianceScreeningMethod": null,
"ShipFromLocationId": 207,
"ShipFromAddress1": "3455 108th Avenue",
"ShipFromAddress2": null,
"ShipFromAddress3": null,
"ShipFromAddress4": null,
"ShipFromCity": "Seattle",
"ShipFromCounty": "King",
"ShipFromPostalCode": "98101",
"ShipFromRegion": null,
"ShipFromState": "WA",
"ShipFromCountry": "US",
"MaximumOvershipmentPercentage": 10,
"MaximumUndershipmentPercentage": 40,
"SourceRequestedQuantity": 56,
"SourceRequestedQuantityUOMCode": "Ea",
"SourceRequestedQuantityUOM": "Each",
"SecondarySourceRequestedQuantity": null,
"SecondarySourceRequestedQuantityUOMCode": null,
"SecondarySourceRequestedQuantityUOM": null,
"DeliveredQuantity": null,
"SecondaryDeliveredQuantity": null,
"CancelledQuantity": null,
"SecondaryCancelledQuantity": null,
"BackorderedQuantity": 0,
"SecondaryBackorderedQuantity": null,
"PickedQuantity": 56,
"SecondaryPickedQuantity": null,
"ConvertedQuantity": null,
"SecondaryConvertedQuantity": null,
"StagedQuantity": 0,
"SecondaryStagedQuantity": 0,
"PendingQuantity": 0,
"PendingQuantityFlag": false,
"CreationDate": "2003-09-29T00:00:00+00:00",
"CreatedBy": "1000148",
"LastUpdateDate": "2017-02-06T01:10:54+00:00",
"LastUpdatedBy": "FUSION",
"SplitFromShipmentLine": null,
"SourceSubinventory": null,
"CarrierId": null,
"Carrier": null,
"CarrierNumber": null,
"ModeOfTransportCode": null,
"ModeOfTransport": null,
"ServiceLevelCode": null,
"ServiceLevel": null,
"ShippingMethodCode": null,
"ShippingMethod": null,
"SourceDocumentTypeId": 2,
"UnitWeight": null,
"UnitVolume": null,
"LogisticsServiceProviderCustomerId": null,
"LogisticsServiceProviderCustomer": null,
"LogisticsServiceProviderCustomerNumber": null,
"SourceLineUpdateDate": null,
"SourceSystemId": null,
"SourceSystem": null,
"ShipmentAdviceStatusFlag": null,
"DoNotShipBeforeDate": null,
"DoNotShipAfterDate": null,
"IntegrationStatusCode": null,
"IntegrationStatus": null,
"QuickShipStatus": null,
"BusinessUnitId": 204,
"BusinessUnit": "Vision Operations",
"LegalEntityId": 204,
"LegalEntity": "Vision Operations",
"POHeaderId": null,
"PONumber": null,
"POBillToBusinessUnitId": null,
"POBillToBusinessUnit": null,
"POSoldToLegalEntityId": null,
"POSoldToLegalEntity": null,
"ConversionTypeCode": null,
"ConversionDate": null,
"ConversionRate": null,
"ParentItemId": null,
"ParentItem": null,
"ParentItemDescription": null,
"ParentSourceOrderFulfillmentLineId": null,
"BaseItemId": null,
"BaseItem": null,
"BaseItemDescription": 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,
"SrcAttributeDate1": null,
"SrcAttributeDate2": null,
"SrcAttributeDate3": null,
"SrcAttributeDate4": null,
"SrcAttributeDate5": null,
"SrcAttributeNumber1": null,
"SrcAttributeNumber2": null,
"SrcAttributeNumber3": null,
"SrcAttributeNumber4": null,
"SrcAttributeNumber5": null,
"SrcAttributeNumber6": null,
"SrcAttributeNumber7": null,
"SrcAttributeNumber8": null,
"SrcAttributeNumber9": null,
"SrcAttributeNumber10": null,
"SrcAttributeTimestamp1": null,
"SrcAttributeTimestamp2": null,
"SrcAttributeTimestamp3": null,
"SrcAttributeTimestamp4": null,
"SrcAttributeTimestamp5": null,
"TransportationShipmentFromEvent": null,
"TransportationShipmentLineFromEvent": null,
"TransportationShipmentCompleteFromEvent": null,
"TradeComplianceScreenedFromEvent": null,
"CurrentBackorderedQuantityFromEvent": null,
"OriginalShipmentLineFromEvent": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814",
"name": "shipmentLines",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814",
"name": "shipmentLines",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/lotStandardDFF",
"name": "lotStandardDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/lotAttributeDFF",
"name": "lotAttributeDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/lineDFF",
"name": "lineDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/serials",
"name": "serials",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/notes",
"name": "notes",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/costs",
"name": "costs",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentLines/203814/child/reservations",
"name": "reservations",
"kind": "collection"
}
]
}