Create one request
/fscmRestApi/resources/11.13.18.05/shipmentTransactionRequests
Request
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
- application/json
object-
ActionCode: string
Value that uniquely identifies the action to be run for this transaction request. Valid values are CreateAndConfirmShipment, ShipmentCreate, and ShipmentUpdate.
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
shipments: array
Shipments
Title:
ShipmentsThe Shipments resource manages details about shipments.
arrayErrorsarrayShipmentsobject-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
ActualDeliveryDate: string
(date-time)
Date that the shipment was actually delivered.
-
ActualShipDate: string
(date-time)
Date when the shipment was shipped.
-
ASNSentDate: string
(date-time)
Date when the application sent the advanced shipment notice.
-
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
AutomaticallyPackFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the shipment is eligible for packing through the batch program. If false, then the shipment isn't eligible for packing through the batch program. The default value is true. -
BillOfLading: string
Maximum Length:
50Receipt that the carrier gives to the shipper. This receipt acknowledges receipt of the shipped goods and specifies the shipment terms. -
Carrier: string
Maximum Length:
360Name of the carrier that transports the shipment. -
CarrierNumber: string
Maximum Length:
30Number that identifies the carrier that transports the shipment. -
CODAmount: number
Collect on delivery amount.
-
CODCurrency: string
Maximum Length:
15Abbreviation that identifies the currency to use when collecting the delivery amount. -
CODPaidBy: string
Maximum Length:
150Person or party who paid the collect on delivery amount. -
CODRemitTo: string
Maximum Length:
150Person or party to reference when remitting the collect on delivery amount. -
ConfirmedBy: string
Maximum Length:
150Person or user who confirmed the shipment. -
ConfirmedDate: string
(date-time)
Date and time when the person or user confirmed the shipment.
-
costs: array
Costs for Shipments
Title:
Costs for ShipmentsThe Costs for Shipments resource manages details about the shipping costs for shipments. -
DeliveryRecipient: string
Maximum Length:
240Name of the person or entity who received the shipment. -
Description: string
Maximum Length:
240Description of the shipment. -
Dock: string
Maximum Length:
30Place of loading for the shipment. -
EnableAutoshipFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the shipment is eligible for shipping through the batch program. If false, then the shipment isn't eligible for shipping through the batch program. The default value is true. -
Equipment: string
Maximum Length:
35Registration number of vehicle or equipment that transports the shipment. -
EquipmentType: string
Maximum Length:
300Type of vehicle or equipment that transports the shipment. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
ExternalSystemTransactionReference: string
Maximum Length:
300Value that contains reference information for the corresponding transaction in external applications. This attribute is only valid for the CreateAndConfirmShipment action. -
FOBAddress1: string
Maximum Length:
240First line of the freight on board address. -
FOBAddress2: string
Maximum Length:
240Second line of the freight on board address. -
FOBAddress3: string
Maximum Length:
240Third line of the freight on board address. -
FOBAddress4: string
Maximum Length:
240Fourth line of the freight on board address. -
FOBCity: string
Maximum Length:
60Freight on board city. -
FOBCode: string
Maximum Length:
30Abbreviation that identifies ownership of the items that are in-transit. A list of accepted values is defined in the lookup type FOB. -
FOBCountry: string
Maximum Length:
2Freight on board country. -
FOBCounty: string
Maximum Length:
60Freight on board county. -
FOBLocationId: integer
(int64)
Value that uniquely identifies the freight on board the address location.
-
FOBPostalCode: string
Maximum Length:
60Abbreviation that identifies the postal code, such as a ZIP Code, for freight on board. -
FOBRegion: string
Maximum Length:
120Freight on board region. -
FOBSiteNumber: string
Maximum Length:
30Number that identifies the freight on board site. -
FOBState: string
Maximum Length:
60Freight on board state. -
FreightTerms: string
Maximum Length:
80Agreement that describes whether the shipping cost of the sales order is paid by the buyer or the seller, and when payment is due. A list of accepted values is defined in the lookup type WSH_FREIGHT_CHARGE_TERMS. -
FreightTermsCode: string
Maximum Length:
30Abbreviation that identifies the freight terms. A list of accepted values is defined in the lookup type WSH_FREIGHT_CHARGE_TERMS. -
globalDFF: array
globalDFF
-
GrossWeight: number
Gross weight of the shipment.
-
InitialShipDate: string
(date-time)
Date when the warehouse plans to ship the shipment.
-
LoadingSequenceRule: string
Maximum Length:
80Rule to apply on shipment lines for loading into the truck. A list of accepted values is defined in the lookup type WSH_LINES_LOADING_ORDER. -
ModeOfTransportCode: string
Maximum 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. -
NetWeight: number
Net weight of the shipment.
-
notes: array
Notes
Title:
NotesThe note objects resource is used to view the note objects. -
outerPackingUnits: array
Outer Packing Units
Title:
Outer Packing UnitsThe Outer Packing Units resource manages details about the outer packing units of a shipment. -
PackingSlip: string
Maximum Length:
50Document that itemizes and describes the contents of the shipment. -
PlannedDeliveryDate: string
(date-time)
Date when shipping expects the shipment to arrive at the customer location.
-
PlannedFlag(required): boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the contents of the shipment are planned. If false, then the contents of the shipment aren't planned. The default value is false. -
ProblemContactReference: string
Maximum Length:
500Person to contact if a problem occurs during shipment. -
ProrateWeightFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the weights are to be prorated. If false, then the weights won't be prorated. The default value is false. -
SealNumber: string
Maximum Length:
30Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport. -
ServiceLevelCode: string
Maximum 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. -
ShipFromOrganizationCode: string
Maximum Length:
240Abbreviation that identifies the ship-from organization. -
Shipment: string
Maximum Length:
30Name of the material shipment. -
shipmentDFF: array
shipmentDFF
-
ShipmentId: integer
(int64)
Value that uniquely identifies the shipment.
-
ShipToPartySiteNumber: string
Maximum Length:
30Number that identifies the ship-to party site. -
SoldToCustomer: string
Maximum Length:
360Name of the sold-to party. -
SoldToCustomerNumber: string
Maximum Length:
30Number that identifies the sold-to party. -
SourceName: string
Maximum Length:
50Unique identifier for the source that created the shipment transaction request. -
TransportationReasonCode: string
Maximum Length:
30Abbreviation that identifies the justification that the user selects when confirming the shipment to indicate a special situation or exception, such as to transfer the item, return it, or to send a sample. A list of accepted values is defined in the lookup type ORA_WSH_TRANSPORT_REASON. -
UltimateDropoffLocationId: integer
(int64)
Value that uniquely identifies ship-to location.
-
unpackedLines: array
Packed Shipment Lines
Title:
Packed Shipment LinesThe Packed Shipment Lines resource manages details about the shipment lines that are packed within a packing unit. -
Volume: number
Volume of the shipment.
-
VolumeUOM: string
Maximum Length:
25Unit of measure for the volume of the shipment. -
VolumeUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the volume of the shipment. -
Waybill: string
Maximum Length:
30Nonnegotiable document that describes the contract for transporting cargo. -
WeightUOM: string
Maximum Length:
25Unit of measure for the weight of the shipment. -
WeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the weight of the shipment.
arrayAttachmentsarrayCosts for ShipmentsarrayErrorsarray-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "WshITPackingSlip":"#/components/schemas/oracle_apps_flex_scm_shipping_shipConfirm_deliveries_restModel_WshNewDelIntGdfDFF_view_WshNewDelIntGdfDFFWshITPackingSlipVO-item-post-request", "WshPTShipmentInfo":"#/components/schemas/oracle_apps_flex_scm_shipping_shipConfirm_deliveries_restModel_WshNewDelIntGdfDFF_view_WshNewDelIntGdfDFFWshPTShipmentInfoVO-item-post-request" } }
arrayNotesarrayOuter Packing UnitsarrayPacked Shipment Linesobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
object-
Amount: number
Amount for the shipping cost for each unit.
-
ConversionDate: string
(date)
Date when the currency conversion occurred.
-
ConversionRate: number
Rate of the currency conversion.
-
ConversionRateTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of currency conversion. -
Currency: string
Maximum Length:
15Abbreviation that identifies the currency of the shipping cost. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
ShippingCostType: string
Maximum Length:
60Type of cost that's predefined in the application. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshFreightCostsInvDFF: array
wshFreightCostsInvDFF
arrayErrorsobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FreightCostInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FreightCostInterfaceId: integer
(int64)
-
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
objectDiscriminator Values
-
WshITPackingSlip -
object
oracle_apps_flex_scm_shipping_shipConfirm_deliveries_restModel_WshNewDelIntGdfDFF_view_WshNewDelIntGdfDFFWshITPackingSlipVO-item-post-request
-
WshPTShipmentInfo -
object
oracle_apps_flex_scm_shipping_shipConfirm_deliveries_restModel_WshNewDelIntGdfDFF_view_WshNewDelIntGdfDFFWshPTShipmentInfoVO-item-post-request
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:30Default Value:WshITPackingSlipRegional Information -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationRegional Information -
DeliveryInterfaceId: integer
(int64)
-
SecondaryCarrier: string
Title:
Secondary CarrierMaximum Length:150Secondary Carrier
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:30Default Value:WshPTShipmentInfoRegional Information -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationRegional Information -
AtDocCodeId: string
Title:
AT Doc Code IDMaximum Length:2000AT Doc Code ID -
DeliveryInterfaceId: integer
(int64)
object-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDThe relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code for extensibility. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDThe unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The currency code for extensibility. -
NoteNumber: string
Maximum Length:
30The alternate unique identifier of the note. A user key that's 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:
NoteThe column which stores the actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDThe unique identifier of the note. This is the primary key of the notes table. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64The unique identifier of the parent source object associated to the note. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
VisibilityCode: string
Title:
PrivateMaximum Length:30Default Value:INTERNALThe attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
object-
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
costs: array
Costs for Shipments
Title:
Costs for ShipmentsThe Costs for Shipments resource manages details about the shipping costs for shipments. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FOBCode: string
Maximum Length:
30Abbreviation that identifies ownership of the items that are in-transit. A list of accepted values is defined in the lookup type FOB. -
GrossWeight: number
Weight of the packing unit including contents.
-
GrossWeightUOM: string
Maximum Length:
25Unit of measure of the gross weight of the packing unit. -
GrossWeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure of the gross weight of the packing unit. -
innerPackingUnits: array
Outer Packing Units
Title:
Outer Packing UnitsThe Outer Packing Units resource manages details about the outer packing units of a shipment. -
MasterSerialNumber: string
Maximum Length:
80Master serial number that identifies the packing unit. -
notes: array
Notes
Title:
NotesThe note objects resource is used to view the note objects. -
packedLines: array
Packed Shipment Lines
Title:
Packed Shipment LinesThe Packed Shipment Lines resource manages details about the shipment lines that are packed within a packing unit. -
PackingUnit: string
Maximum Length:
30Name of the packing unit. -
PackingUnitType: string
Maximum Length:
300Item defining characteristics of a packing unit. -
SealNumber: string
Maximum Length:
30Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport. -
TareWeight: number
Weight of the container that contains the packing unit.
-
TareWeightUOM: string
Maximum Length:
25Unit of measure that the tare weight uses for the packing unit. -
TareWeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure that the tare weight uses for the packing unit. -
TrackingNumber: string
Maximum Length:
30Tracking number of the packing unit. -
Volume: number
Volume of material that the packing unit can hold.
-
VolumeUOM: string
Maximum Length:
25Unit of measure that the container volume uses for the packing unit. -
VolumeUOMCode: string
Maximum Length:
3Code that identifies the unit of measure that the container volume uses for the packing unit.
arrayAttachmentsarrayCosts for ShipmentsarrayErrorsarrayOuter Packing UnitsarrayNotesarrayPacked Shipment Linesobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
object-
Amount: number
Amount for the shipping cost for each unit.
-
ConversionDate: string
(date)
Date when the currency conversion occurred.
-
ConversionRate: number
Rate of the currency conversion.
-
ConversionRateTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of currency conversion. -
Currency: string
Maximum Length:
15Abbreviation that identifies the currency of the shipping cost. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
ShippingCostType: string
Maximum Length:
60Type of cost that's predefined in the application. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshFreightCostsInvDFF: array
wshFreightCostsInvDFF
arrayErrorsobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FreightCostInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FreightCostInterfaceId: integer
(int64)
-
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
LPNInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
costs: array
Costs for Shipments
Title:
Costs for ShipmentsThe Costs for Shipments resource manages details about the shipping costs for shipments. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FOBCode: string
Maximum Length:
30Abbreviation that identifies ownership of the items that are in-transit. A list of accepted values is defined in the lookup type FOB. -
GrossWeight: number
Weight of the packing unit including contents.
-
GrossWeightUOM: string
Maximum Length:
25Unit of measure of the gross weight of the packing unit. -
GrossWeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure of the gross weight of the packing unit. -
innerPackingUnits: array
Outer Packing Units
Title:
Outer Packing UnitsThe Outer Packing Units resource manages details about the outer packing units of a shipment. -
MasterSerialNumber: string
Maximum Length:
80Master serial number that identifies the packing unit. -
notes: array
Notes
Title:
NotesThe note objects resource is used to view the note objects. -
packedLines: array
Packed Shipment Lines
Title:
Packed Shipment LinesThe Packed Shipment Lines resource manages details about the shipment lines that are packed within a packing unit. -
PackingUnit: string
Maximum Length:
30Name of the packing unit. -
PackingUnitType: string
Maximum Length:
300Item defining characteristics of a packing unit. -
SealNumber: string
Maximum Length:
30Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport. -
TareWeight: number
Weight of the container that contains the packing unit.
-
TareWeightUOM: string
Maximum Length:
25Unit of measure that the tare weight uses for the packing unit. -
TareWeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure that the tare weight uses for the packing unit. -
TrackingNumber: string
Maximum Length:
30Tracking number of the packing unit. -
Volume: number
Volume of material that the packing unit can hold.
-
VolumeUOM: string
Maximum Length:
25Unit of measure that the container volume uses for the packing unit. -
VolumeUOMCode: string
Maximum Length:
3Code that identifies the unit of measure that the container volume uses for the packing unit.
arrayAttachmentsarrayCosts for ShipmentsarrayErrorsarrayOuter Packing UnitsarrayNotesarrayPacked Shipment Linesobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
object-
Amount: number
Amount for the shipping cost for each unit.
-
ConversionDate: string
(date)
Date when the currency conversion occurred.
-
ConversionRate: number
Rate of the currency conversion.
-
ConversionRateTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of currency conversion. -
Currency: string
Maximum Length:
15Abbreviation that identifies the currency of the shipping cost. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
ShippingCostType: string
Maximum Length:
60Type of cost that's predefined in the application. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshFreightCostsInvDFF: array
wshFreightCostsInvDFF
arrayErrorsobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FreightCostInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FreightCostInterfaceId: integer
(int64)
-
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
LPNInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
FOBCode: string
Maximum Length:
30Abbreviation that identifies ownership of the items that are in-transit. A list of accepted values is defined in the lookup type FOB. -
GrossWeight: number
Weight of the packing unit including contents.
-
GrossWeightUOM: string
Maximum Length:
25Unit of measure of the gross weight of the packing unit. -
GrossWeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure of the gross weight of the packing unit. -
MasterSerialNumber: string
Maximum Length:
80Master serial number that identifies the packing unit. -
PackingUnit: string
Maximum Length:
30Name of the packing unit. -
PackingUnitType: string
Maximum Length:
300Item defining characteristics of a packing unit. -
SealNumber: string
Maximum Length:
30Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport. -
TareWeight: number
Weight of the container that contains the packing unit.
-
TareWeightUOM: string
Maximum Length:
25Unit of measure that the tare weight uses for the packing unit. -
TareWeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure that the tare weight uses for the packing unit. -
TrackingNumber: string
Maximum Length:
30Tracking number of the packing unit. -
Volume: number
Volume of material that the packing unit can hold.
-
VolumeUOM: string
Maximum Length:
25Unit of measure that the container volume uses for the packing unit. -
VolumeUOMCode: string
Maximum Length:
3Code that identifies the unit of measure that the container volume uses for the packing unit.
object-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDThe relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code for extensibility. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDThe unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The currency code for extensibility. -
NoteNumber: string
Maximum Length:
30The alternate unique identifier of the note. A user key that's 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:
NoteThe column which stores the actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDThe unique identifier of the note. This is the primary key of the notes table. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64The unique identifier of the parent source object associated to the note. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
VisibilityCode: string
Title:
PrivateMaximum Length:30Default Value:INTERNALThe attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
object-
AssessableValue: number
Value 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
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
costs: array
Costs for Shipments
Title:
Costs for ShipmentsThe Costs for Shipments resource manages details about the shipping costs for shipments. -
DFF: array
DFF
-
DocumentFiscalClassification: string
Maximum Length:
240Document fiscal classification. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FirstPartyTaxRegistrationNumber: string
Maximum Length:
30Number that identifies tax registration for the first party of the transaction. The tax authority uses this attribute for taxation purposes. -
GrossWeight: number
Gross weight of the shipment line.
-
IntendedUse: string
Maximum Length:
30Name of the intended use classification. -
Item: string
Maximum Length:
240Name of the item. -
ItemRevision: string
Maximum Length:
18Revision of the item. -
LoadingSequence: number
Sequence to use when loading the shipment line.
-
LocationOfFinalDischargeCode: string
Maximum Length:
60Abbreviation that identifies the final discharge location. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
lots: array
Lots for Unpacked Shipment Lines
Title:
Lots for Unpacked Shipment LinesThe Lots for Unpacked Shipment Lines resource manages details about lot numbers for items under lot control in unpacked shipment lines. -
NetWeight: number
Net weight of the shipment line.
-
notes: array
Notes
Title:
NotesThe note objects resource is used to view the note objects. -
ProductCategory: string
Maximum Length:
240Product category of the transaction line. -
ProductFiscalClassification: string
Maximum Length:
250Product fiscal classification of the transaction line. -
ProductTypeCode: string
Maximum Length:
240Abbreviation that identifies the product type of the inventory item. -
QuantityToBackorder: number
Quantity requested to be back ordered for the shipment line.
This attribute is associated with a feature that requires opt in. -
RequestedQuantityToConsume: number
Requested quantity to consume for this shipment for the shipment line. This attribute is associated with a feature that requires opt in.
-
SecondaryShippedQuantity: number
Shipped quantity, in the secondary unit of measure.
-
SecondaryShippedQuantityUOM: string
Maximum Length:
25Secondary unit of measure for the shipped quantity. -
SecondaryShippedQuantityUOMCode: string
Maximum Length:
3Code that identifies the secondary unit of measure for the shipped quantity. -
serials: array
Serials for Unpacked Shipment Lines
Title:
Serials for Unpacked Shipment LinesThe Serials for Unpacked Shipment Lines resource manages details about serial numbers for items under serial control in unpacked shipment lines. -
ShipmentLine: integer
(int64)
Value that uniquely identifies the shipment line.
-
ShippedQuantity: number
Shipped quantity.
-
ShippedQuantityUOM: string
Maximum Length:
25Unit of measure for the shipped quantity. -
ShippedQuantityUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the shipped quantity. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
TaxationCountry: string
Maximum Length:
80Country where the transaction occurs. The tax authority uses this attribute for taxation purposes. -
TaxClassificationCode: string
Maximum Length:
50Abbreviation that identifies a group of taxes for reporting and processing. The tax authority uses this attribute for taxation purposes. -
TaxExemptionCertificateNumber: string
Maximum Length:
80Number that identifies the certificate for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxExemptionReasonCode: string
Maximum Length:
30Abbreviation that identifies the reason for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxInvoiceDate: string
(date)
Date and time of the tax invoice that you use to meet tax reporting that different countries require.
-
TaxInvoiceNumber: string
Maximum Length:
150Number of the tax invoice that you use to meet tax reporting that different countries require. -
ThirdPartyTaxRegistrationNumber: string
Maximum Length:
30Number that identifies tax registration for the third party of the transaction. The tax authority uses this attribute for taxation purposes. -
TrackingNumber: string
Maximum Length:
30Tracking number of the shipment line. -
TransactionBusinessCategory: string
Maximum Length:
240Name 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. -
UserDefinedFiscalClassificationCode: string
Maximum Length:
30Abbreviation that identifies the classification for each tax requirement that you can't define using the fiscal classification types that already exist. -
Volume: number
Volume of the shipment line.
-
VolumeUOM: string
Maximum Length:
25Unit of measure for the volume of the shipment line. -
VolumeUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the volume of the shipment line. -
WeightUOM: string
Maximum Length:
25Unit of measure for the weight of the shipment line. -
WeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the weight of the shipment line. -
wshInvStripingDFF: array
wshInvStripingDFF
arrayAttachmentsarrayCosts for ShipmentsarrayErrorsarrayLots for Unpacked Shipment LinesarrayNotesarraySerials for Unpacked Shipment Linesobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
object-
Amount: number
Amount for the shipping cost for each unit.
-
ConversionDate: string
(date)
Date when the currency conversion occurred.
-
ConversionRate: number
Rate of the currency conversion.
-
ConversionRateTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of currency conversion. -
Currency: string
Maximum Length:
15Abbreviation that identifies the currency of the shipping cost. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
ShippingCostType: string
Maximum Length:
60Type of cost that's predefined in the application. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshFreightCostsInvDFF: array
wshFreightCostsInvDFF
arrayErrorsobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FreightCostInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FreightCostInterfaceId: integer
(int64)
-
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
DeliveryDetailInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
Lot(required): string
Maximum Length:
80Number that identifies the lot for the item. This attribute is used when the warehouse places the item under lot control. -
Quantity(required): number
Quantity for the lot transaction.
-
SecondaryQuantity: number
Quantity for the lot transaction, in the secondary unit of measure.
-
serials: array
Serials for Unpacked Shipment Lines
Title:
Serials for Unpacked Shipment LinesThe Serials for Unpacked Shipment Lines resource manages details about serial numbers for items under serial control in unpacked shipment lines. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshLotsInvDFF: array
wshLotsInvDFF
arrayErrorsarraySerials for Unpacked Shipment Linesobject-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
attributeDFF: array
attributeDFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FromSerialNumber(required): string
Maximum Length:
80Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
standardDFF: array
standardDFF
-
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
wshSerialInvDFF: array
wshSerialInvDFF
arrayErrorsobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FromSerialNumber: string
Maximum Length:
80 -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
LotNumber: string
Maximum Length:
80 -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
object-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDThe relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code for extensibility. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDThe unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The currency code for extensibility. -
NoteNumber: string
Maximum Length:
30The alternate unique identifier of the note. A user key that's 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:
NoteThe column which stores the actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDThe unique identifier of the note. This is the primary key of the notes table. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64The unique identifier of the parent source object associated to the note. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
VisibilityCode: string
Title:
PrivateMaximum Length:30Default Value:INTERNALThe attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
object-
attributeDFF: array
attributeDFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FromSerialNumber(required): string
Maximum Length:
80Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
standardDFF: array
standardDFF
-
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
wshSerialInvDFF: array
wshSerialInvDFF
arrayErrorsobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FromSerialNumber: string
Maximum Length:
80 -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
DeliveryDetailInterfaceId: integer
(int64)
-
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
object-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDThe relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code for extensibility. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDThe unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The currency code for extensibility. -
NoteNumber: string
Maximum Length:
30The alternate unique identifier of the note. A user key that's 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:
NoteThe column which stores the actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDThe unique identifier of the note. This is the primary key of the notes table. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64The unique identifier of the parent source object associated to the note. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
VisibilityCode: string
Title:
PrivateMaximum Length:30Default Value:INTERNALThe attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
object-
AssessableValue: number
Value 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
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
costs: array
Costs for Shipments
Title:
Costs for ShipmentsThe Costs for Shipments resource manages details about the shipping costs for shipments. -
DFF: array
DFF
-
DocumentFiscalClassification: string
Maximum Length:
240Document fiscal classification. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FirstPartyTaxRegistrationNumber: string
Maximum Length:
30Number that identifies tax registration for the first party of the transaction. The tax authority uses this attribute for taxation purposes. -
GrossWeight: number
Gross weight of the shipment line.
-
IntendedUse: string
Maximum Length:
30Name of the intended use classification. -
Item: string
Maximum Length:
240Name of the item. -
ItemRevision: string
Maximum Length:
18Revision of the item. -
LoadingSequence: number
Sequence to use when loading the shipment line.
-
LocationOfFinalDischargeCode: string
Maximum Length:
60Abbreviation that identifies the final discharge location. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
lots: array
Lots for Unpacked Shipment Lines
Title:
Lots for Unpacked Shipment LinesThe Lots for Unpacked Shipment Lines resource manages details about lot numbers for items under lot control in unpacked shipment lines. -
NetWeight: number
Net weight of the shipment line.
-
notes: array
Notes
Title:
NotesThe note objects resource is used to view the note objects. -
ProductCategory: string
Maximum Length:
240Product category of the transaction line. -
ProductFiscalClassification: string
Maximum Length:
250Product fiscal classification of the transaction line. -
ProductTypeCode: string
Maximum Length:
240Abbreviation that identifies the product type of the inventory item. -
QuantityToBackorder: number
Quantity requested to be back ordered for the shipment line.
This attribute is associated with a feature that requires opt in. -
RequestedQuantityToConsume: number
Requested quantity to consume for this shipment for the shipment line. This attribute is associated with a feature that requires opt in.
-
SecondaryShippedQuantity: number
Shipped quantity, in the secondary unit of measure.
-
SecondaryShippedQuantityUOM: string
Maximum Length:
25Secondary unit of measure for the shipped quantity. -
SecondaryShippedQuantityUOMCode: string
Maximum Length:
3Code that identifies the secondary unit of measure for the shipped quantity. -
serials: array
Serials for Unpacked Shipment Lines
Title:
Serials for Unpacked Shipment LinesThe Serials for Unpacked Shipment Lines resource manages details about serial numbers for items under serial control in unpacked shipment lines. -
ShipmentLine: integer
(int64)
Value that uniquely identifies the shipment line.
-
ShippedQuantity: number
Shipped quantity.
-
ShippedQuantityUOM: string
Maximum Length:
25Unit of measure for the shipped quantity. -
ShippedQuantityUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the shipped quantity. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
TaxationCountry: string
Maximum Length:
80Country where the transaction occurs. The tax authority uses this attribute for taxation purposes. -
TaxClassificationCode: string
Maximum Length:
50Abbreviation that identifies a group of taxes for reporting and processing. The tax authority uses this attribute for taxation purposes. -
TaxExemptionCertificateNumber: string
Maximum Length:
80Number that identifies the certificate for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxExemptionReasonCode: string
Maximum Length:
30Abbreviation that identifies the reason for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxInvoiceDate: string
(date)
Date and time of the tax invoice that you use to meet tax reporting that different countries require.
-
TaxInvoiceNumber: string
Maximum Length:
150Number of the tax invoice that you use to meet tax reporting that different countries require. -
ThirdPartyTaxRegistrationNumber: string
Maximum Length:
30Number that identifies tax registration for the third party of the transaction. The tax authority uses this attribute for taxation purposes. -
TrackingNumber: string
Maximum Length:
30Tracking number of the shipment line. -
TransactionBusinessCategory: string
Maximum Length:
240Name 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. -
UserDefinedFiscalClassificationCode: string
Maximum Length:
30Abbreviation that identifies the classification for each tax requirement that you can't define using the fiscal classification types that already exist. -
Volume: number
Volume of the shipment line.
-
VolumeUOM: string
Maximum Length:
25Unit of measure for the volume of the shipment line. -
VolumeUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the volume of the shipment line. -
WeightUOM: string
Maximum Length:
25Unit of measure for the weight of the shipment line. -
WeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the weight of the shipment line. -
wshInvStripingDFF: array
wshInvStripingDFF
arrayAttachmentsarrayCosts for ShipmentsarrayErrorsarrayLots for Unpacked Shipment LinesarrayNotesarraySerials for Unpacked Shipment Linesobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
object-
Amount: number
Amount for the shipping cost for each unit.
-
ConversionDate: string
(date)
Date when the currency conversion occurred.
-
ConversionRate: number
Rate of the currency conversion.
-
ConversionRateTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of currency conversion. -
Currency: string
Maximum Length:
15Abbreviation that identifies the currency of the shipping cost. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
ShippingCostType: string
Maximum Length:
60Type of cost that's predefined in the application. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshFreightCostsInvDFF: array
wshFreightCostsInvDFF
arrayErrorsobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FreightCostInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FreightCostInterfaceId: integer
(int64)
-
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
DeliveryDetailInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
Lot(required): string
Maximum Length:
80Number that identifies the lot for the item. This attribute is used when the warehouse places the item under lot control. -
Quantity(required): number
Quantity for the lot transaction.
-
SecondaryQuantity: number
Quantity for the lot transaction, in the secondary unit of measure.
-
serials: array
Serials for Unpacked Shipment Lines
Title:
Serials for Unpacked Shipment LinesThe Serials for Unpacked Shipment Lines resource manages details about serial numbers for items under serial control in unpacked shipment lines. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshLotsInvDFF: array
wshLotsInvDFF
arrayErrorsarraySerials for Unpacked Shipment Linesobject-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
attributeDFF: array
attributeDFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FromSerialNumber(required): string
Maximum Length:
80Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
standardDFF: array
standardDFF
-
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
wshSerialInvDFF: array
wshSerialInvDFF
arrayErrorsobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FromSerialNumber: string
Maximum Length:
80 -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
LotNumber: string
Maximum Length:
80 -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
object-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDThe relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code for extensibility. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDThe unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The currency code for extensibility. -
NoteNumber: string
Maximum Length:
30The alternate unique identifier of the note. A user key that's 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:
NoteThe column which stores the actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDThe unique identifier of the note. This is the primary key of the notes table. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64The unique identifier of the parent source object associated to the note. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
VisibilityCode: string
Title:
PrivateMaximum Length:30Default Value:INTERNALThe attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
object-
attributeDFF: array
attributeDFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FromSerialNumber(required): string
Maximum Length:
80Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
standardDFF: array
standardDFF
-
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
wshSerialInvDFF: array
wshSerialInvDFF
arrayErrorsobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FromSerialNumber: string
Maximum Length:
80 -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
DeliveryDetailInterfaceId: integer
(int64)
-
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
DeliveryInterfaceId: integer
(int64)
object-
AssessableValue: number
Value 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
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
costs: array
Costs for Shipments
Title:
Costs for ShipmentsThe Costs for Shipments resource manages details about the shipping costs for shipments. -
DFF: array
DFF
-
DocumentFiscalClassification: string
Maximum Length:
240Document fiscal classification. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FirstPartyTaxRegistrationNumber: string
Maximum Length:
30Number that identifies tax registration for the first party of the transaction. The tax authority uses this attribute for taxation purposes. -
GrossWeight: number
Gross weight of the shipment line.
-
IntendedUse: string
Maximum Length:
30Name of the intended use classification. -
Item: string
Maximum Length:
240Name of the item. -
ItemRevision: string
Maximum Length:
18Revision of the item. -
LoadingSequence: number
Sequence to use when loading the shipment line.
-
LocationOfFinalDischargeCode: string
Maximum Length:
60Abbreviation that identifies the final discharge location. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
lots: array
Lots for Unpacked Shipment Lines
Title:
Lots for Unpacked Shipment LinesThe Lots for Unpacked Shipment Lines resource manages details about lot numbers for items under lot control in unpacked shipment lines. -
NetWeight: number
Net weight of the shipment line.
-
notes: array
Notes
Title:
NotesThe note objects resource is used to view the note objects. -
ProductCategory: string
Maximum Length:
240Product category of the transaction line. -
ProductFiscalClassification: string
Maximum Length:
250Product fiscal classification of the transaction line. -
ProductTypeCode: string
Maximum Length:
240Abbreviation that identifies the product type of the inventory item. -
QuantityToBackorder: number
Quantity requested to be back ordered for the shipment line.
This attribute is associated with a feature that requires opt in. -
RequestedQuantityToConsume: number
Requested quantity to consume for this shipment for the shipment line. This attribute is associated with a feature that requires opt in.
-
SecondaryShippedQuantity: number
Shipped quantity, in the secondary unit of measure.
-
SecondaryShippedQuantityUOM: string
Maximum Length:
25Secondary unit of measure for the shipped quantity. -
SecondaryShippedQuantityUOMCode: string
Maximum Length:
3Code that identifies the secondary unit of measure for the shipped quantity. -
serials: array
Serials for Unpacked Shipment Lines
Title:
Serials for Unpacked Shipment LinesThe Serials for Unpacked Shipment Lines resource manages details about serial numbers for items under serial control in unpacked shipment lines. -
ShipmentLine: integer
(int64)
Value that uniquely identifies the shipment line.
-
ShippedQuantity: number
Shipped quantity.
-
ShippedQuantityUOM: string
Maximum Length:
25Unit of measure for the shipped quantity. -
ShippedQuantityUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the shipped quantity. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
TaxationCountry: string
Maximum Length:
80Country where the transaction occurs. The tax authority uses this attribute for taxation purposes. -
TaxClassificationCode: string
Maximum Length:
50Abbreviation that identifies a group of taxes for reporting and processing. The tax authority uses this attribute for taxation purposes. -
TaxExemptionCertificateNumber: string
Maximum Length:
80Number that identifies the certificate for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxExemptionReasonCode: string
Maximum Length:
30Abbreviation that identifies the reason for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxInvoiceDate: string
(date)
Date and time of the tax invoice that you use to meet tax reporting that different countries require.
-
TaxInvoiceNumber: string
Maximum Length:
150Number of the tax invoice that you use to meet tax reporting that different countries require. -
ThirdPartyTaxRegistrationNumber: string
Maximum Length:
30Number that identifies tax registration for the third party of the transaction. The tax authority uses this attribute for taxation purposes. -
TrackingNumber: string
Maximum Length:
30Tracking number of the shipment line. -
TransactionBusinessCategory: string
Maximum Length:
240Name 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. -
UserDefinedFiscalClassificationCode: string
Maximum Length:
30Abbreviation that identifies the classification for each tax requirement that you can't define using the fiscal classification types that already exist. -
Volume: number
Volume of the shipment line.
-
VolumeUOM: string
Maximum Length:
25Unit of measure for the volume of the shipment line. -
VolumeUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the volume of the shipment line. -
WeightUOM: string
Maximum Length:
25Unit of measure for the weight of the shipment line. -
WeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the weight of the shipment line. -
wshInvStripingDFF: array
wshInvStripingDFF
arrayAttachmentsarrayCosts for ShipmentsarrayErrorsarrayLots for Unpacked Shipment LinesarrayNotesarraySerials for Unpacked Shipment Linesobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
object-
Amount: number
Amount for the shipping cost for each unit.
-
ConversionDate: string
(date)
Date when the currency conversion occurred.
-
ConversionRate: number
Rate of the currency conversion.
-
ConversionRateTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of currency conversion. -
Currency: string
Maximum Length:
15Abbreviation that identifies the currency of the shipping cost. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
ShippingCostType: string
Maximum Length:
60Type of cost that's predefined in the application. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshFreightCostsInvDFF: array
wshFreightCostsInvDFF
arrayErrorsobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FreightCostInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FreightCostInterfaceId: integer
(int64)
-
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
DeliveryDetailInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
Lot(required): string
Maximum Length:
80Number that identifies the lot for the item. This attribute is used when the warehouse places the item under lot control. -
Quantity(required): number
Quantity for the lot transaction.
-
SecondaryQuantity: number
Quantity for the lot transaction, in the secondary unit of measure.
-
serials: array
Serials for Unpacked Shipment Lines
Title:
Serials for Unpacked Shipment LinesThe Serials for Unpacked Shipment Lines resource manages details about serial numbers for items under serial control in unpacked shipment lines. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshLotsInvDFF: array
wshLotsInvDFF
arrayErrorsarraySerials for Unpacked Shipment Linesobject-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
attributeDFF: array
attributeDFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FromSerialNumber(required): string
Maximum Length:
80Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
standardDFF: array
standardDFF
-
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
wshSerialInvDFF: array
wshSerialInvDFF
arrayErrorsobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FromSerialNumber: string
Maximum Length:
80 -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
LotNumber: string
Maximum Length:
80 -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
object-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDThe relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code for extensibility. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDThe unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The currency code for extensibility. -
NoteNumber: string
Maximum Length:
30The alternate unique identifier of the note. A user key that's 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:
NoteThe column which stores the actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDThe unique identifier of the note. This is the primary key of the notes table. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64The unique identifier of the parent source object associated to the note. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
VisibilityCode: string
Title:
PrivateMaximum Length:30Default Value:INTERNALThe attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
object-
attributeDFF: array
attributeDFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FromSerialNumber(required): string
Maximum Length:
80Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
standardDFF: array
standardDFF
-
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
wshSerialInvDFF: array
wshSerialInvDFF
arrayErrorsobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FromSerialNumber: string
Maximum Length:
80 -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
DeliveryDetailInterfaceId: integer
(int64)
-
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
Response
- application/json
Default Response
-
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.
object-
ActionCode: string
Value that uniquely identifies the action to be run for this transaction request. Valid values are CreateAndConfirmShipment, ShipmentCreate, and ShipmentUpdate.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the shipment transaction request. -
CreationDate: string
(date-time)
Read Only:
trueDate when the shipment transaction request was created. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the shipment transaction request was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the shipment transaction request. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
shipments: array
Shipments
Title:
ShipmentsThe Shipments resource manages details about shipments. -
TransactionId: integer
(int64)
Read Only:
trueValue that uniquely identifies the shipment transaction request. -
TransactionStatus: string
Title:
MeaningRead Only:trueMaximum Length:80Value that indicates the status of the transaction. A list of accepted values is defined in the lookup type WSH_TXN_STATUS. -
TransactionStatusCode: string
Read Only:
trueMaximum Length:2Abbreviation that identifies the status of the transaction. A list of accepted values is defined in the lookup type WSH_TXN_STATUS.
arrayErrorsarrayLinksarrayShipmentsobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
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.
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object-
ActualDeliveryDate: string
(date-time)
Date that the shipment was actually delivered.
-
ActualShipDate: string
(date-time)
Date when the shipment was shipped.
-
ASNSentDate: string
(date-time)
Date when the application sent the advanced shipment notice.
-
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
AutomaticallyPackFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the shipment is eligible for packing through the batch program. If false, then the shipment isn't eligible for packing through the batch program. The default value is true. -
BillOfLading: string
Maximum Length:
50Receipt that the carrier gives to the shipper. This receipt acknowledges receipt of the shipped goods and specifies the shipment terms. -
Carrier: string
Maximum Length:
360Name of the carrier that transports the shipment. -
CarrierNumber: string
Maximum Length:
30Number that identifies the carrier that transports the shipment. -
CODAmount: number
Collect on delivery amount.
-
CODCurrency: string
Maximum Length:
15Abbreviation that identifies the currency to use when collecting the delivery amount. -
CODPaidBy: string
Maximum Length:
150Person or party who paid the collect on delivery amount. -
CODRemitTo: string
Maximum Length:
150Person or party to reference when remitting the collect on delivery amount. -
ConfirmedBy: string
Maximum Length:
150Person or user who confirmed the shipment. -
ConfirmedDate: string
(date-time)
Date and time when the person or user confirmed the shipment.
-
costs: array
Costs for Shipments
Title:
Costs for ShipmentsThe Costs for Shipments resource manages details about the shipping costs for shipments. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the candidate shipment. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the candidate shipment. -
DeliveryInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the candidate shipment. -
DeliveryRecipient: string
Maximum Length:
240Name of the person or entity who received the shipment. -
Description: string
Maximum Length:
240Description of the shipment. -
Dock: string
Maximum Length:
30Place of loading for the shipment. -
EnableAutoshipFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the shipment is eligible for shipping through the batch program. If false, then the shipment isn't eligible for shipping through the batch program. The default value is true. -
Equipment: string
Maximum Length:
35Registration number of vehicle or equipment that transports the shipment. -
EquipmentType: string
Maximum Length:
300Type of vehicle or equipment that transports the shipment. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
ExternalSystemTransactionReference: string
Maximum Length:
300Value that contains reference information for the corresponding transaction in external applications. This attribute is only valid for the CreateAndConfirmShipment action. -
FOBAddress1: string
Maximum Length:
240First line of the freight on board address. -
FOBAddress2: string
Maximum Length:
240Second line of the freight on board address. -
FOBAddress3: string
Maximum Length:
240Third line of the freight on board address. -
FOBAddress4: string
Maximum Length:
240Fourth line of the freight on board address. -
FOBCity: string
Maximum Length:
60Freight on board city. -
FOBCode: string
Maximum Length:
30Abbreviation that identifies ownership of the items that are in-transit. A list of accepted values is defined in the lookup type FOB. -
FOBCountry: string
Maximum Length:
2Freight on board country. -
FOBCounty: string
Maximum Length:
60Freight on board county. -
FOBLocationId: integer
(int64)
Value that uniquely identifies the freight on board the address location.
-
FOBPostalCode: string
Maximum Length:
60Abbreviation that identifies the postal code, such as a ZIP Code, for freight on board. -
FOBRegion: string
Maximum Length:
120Freight on board region. -
FOBSiteNumber: string
Maximum Length:
30Number that identifies the freight on board site. -
FOBState: string
Maximum Length:
60Freight on board state. -
FreightTerms: string
Maximum Length:
80Agreement that describes whether the shipping cost of the sales order is paid by the buyer or the seller, and when payment is due. A list of accepted values is defined in the lookup type WSH_FREIGHT_CHARGE_TERMS. -
FreightTermsCode: string
Maximum Length:
30Abbreviation that identifies the freight terms. A list of accepted values is defined in the lookup type WSH_FREIGHT_CHARGE_TERMS. -
globalDFF: array
globalDFF
-
GrossWeight: number
Gross weight of the shipment.
-
InitialShipDate: string
(date-time)
Date when the warehouse plans to ship the shipment.
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the candidate shipment. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the candidate shipment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoadingSequenceRule: string
Maximum Length:
80Rule to apply on shipment lines for loading into the truck. A list of accepted values is defined in the lookup type WSH_LINES_LOADING_ORDER. -
ModeOfTransportCode: string
Maximum 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. -
NetWeight: number
Net weight of the shipment.
-
notes: array
Notes
Title:
NotesThe note objects resource is used to view the note objects. -
outerPackingUnits: array
Outer Packing Units
Title:
Outer Packing UnitsThe Outer Packing Units resource manages details about the outer packing units of a shipment. -
PackingSlip: string
Maximum Length:
50Document that itemizes and describes the contents of the shipment. -
PlannedDeliveryDate: string
(date-time)
Date when shipping expects the shipment to arrive at the customer location.
-
PlannedFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the contents of the shipment are planned. If false, then the contents of the shipment aren't planned. The default value is false. -
ProblemContactReference: string
Maximum Length:
500Person to contact if a problem occurs during shipment. -
ProrateWeightFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the weights are to be prorated. If false, then the weights won't be prorated. The default value is false. -
SealNumber: string
Maximum Length:
30Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport. -
ServiceLevelCode: string
Maximum 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. -
ShipFromOrganizationCode: string
Maximum Length:
240Abbreviation that identifies the ship-from organization. -
Shipment: string
Maximum Length:
30Name of the material shipment. -
shipmentDFF: array
shipmentDFF
-
ShipmentId: integer
(int64)
Value that uniquely identifies the shipment.
-
ShipToPartySiteNumber: string
Maximum Length:
30Number that identifies the ship-to party site. -
SoldToCustomer: string
Maximum Length:
360Name of the sold-to party. -
SoldToCustomerNumber: string
Maximum Length:
30Number that identifies the sold-to party. -
SourceName: string
Maximum Length:
50Unique identifier for the source that created the shipment transaction request. -
TransportationReasonCode: string
Maximum Length:
30Abbreviation that identifies the justification that the user selects when confirming the shipment to indicate a special situation or exception, such as to transfer the item, return it, or to send a sample. A list of accepted values is defined in the lookup type ORA_WSH_TRANSPORT_REASON. -
UltimateDropoffLocationId: integer
(int64)
Value that uniquely identifies ship-to location.
-
unpackedLines: array
Packed Shipment Lines
Title:
Packed Shipment LinesThe Packed Shipment Lines resource manages details about the shipment lines that are packed within a packing unit. -
Volume: number
Volume of the shipment.
-
VolumeUOM: string
Maximum Length:
25Unit of measure for the volume of the shipment. -
VolumeUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the volume of the shipment. -
Waybill: string
Maximum Length:
30Nonnegotiable document that describes the contract for transporting cargo. -
WeightUOM: string
Maximum Length:
25Unit of measure for the weight of the shipment. -
WeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the weight of the shipment.
arrayAttachmentsarrayCosts for ShipmentsarrayErrorsarray-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "WshITPackingSlip":"#/components/schemas/oracle_apps_flex_scm_shipping_shipConfirm_deliveries_restModel_WshNewDelIntGdfDFF_view_WshNewDelIntGdfDFFWshITPackingSlipVO-item-response", "WshPTShipmentInfo":"#/components/schemas/oracle_apps_flex_scm_shipping_shipConfirm_deliveries_restModel_WshNewDelIntGdfDFF_view_WshNewDelIntGdfDFFWshPTShipmentInfoVO-item-response" } }
arrayLinksarrayNotesarrayOuter Packing UnitsarrayPacked Shipment Linesobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
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:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
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:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
arrayLinksobject-
Amount: number
Amount for the shipping cost for each unit.
-
ConversionDate: string
(date)
Date when the currency conversion occurred.
-
ConversionRate: number
Rate of the currency conversion.
-
ConversionRateTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of currency conversion. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the candidate shipping cost. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the candidate shipping cost. -
Currency: string
Maximum Length:
15Abbreviation that identifies the currency of the shipping cost. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FreightCostInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the candidate shipping cost. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the candidate shipping cost. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the candidate shipping cost. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
ShippingCostType: string
Maximum Length:
60Type of cost that's predefined in the application. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshFreightCostsInvDFF: array
wshFreightCostsInvDFF
arrayErrorsarrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FreightCostInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FreightCostInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobjectDiscriminator Values
-
WshITPackingSlip -
object
oracle_apps_flex_scm_shipping_shipConfirm_deliveries_restModel_WshNewDelIntGdfDFF_view_WshNewDelIntGdfDFFWshITPackingSlipVO-item-response
-
WshPTShipmentInfo -
object
oracle_apps_flex_scm_shipping_shipConfirm_deliveries_restModel_WshNewDelIntGdfDFF_view_WshNewDelIntGdfDFFWshPTShipmentInfoVO-item-response
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:30Default Value:WshITPackingSlipRegional Information -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationRegional Information -
DeliveryInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SecondaryCarrier: string
Title:
Secondary CarrierMaximum Length:150Secondary Carrier
object-
__FLEX_Context: string
Title:
Regional InformationMaximum Length:30Default Value:WshPTShipmentInfoRegional Information -
__FLEX_Context_DisplayValue: string
Title:
Regional InformationRegional Information -
AtDocCodeId: string
Title:
AT Doc Code IDMaximum Length:2000AT Doc Code ID -
DeliveryInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksarrayLinksobject-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDThe relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code for extensibility. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDThe unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The currency code for extensibility. -
DeleteFlag: boolean
Title:
Delete IndicatorRead Only:trueIndicates whether the user has access to delete the note. -
EmailAddress: string
Read Only:
trueMaximum Length:320The email address of the user who created the note. -
FormattedAddress: string
Read Only:
trueThe address of the user who created the note. -
FormattedPhoneNumber: string
Read Only:
trueThe phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The unique identifier of the note. This is the primary key of the notes table. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note IDRead Only:trueThe unique identifier of the note. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30The alternate unique identifier of the note. A user key that's 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:
NoteThe column which stores the actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDThe unique identifier of the note. This is the primary key of the notes table. -
PartyId: integer
(int64)
Read Only:
trueThe unique identifier of the party. -
PartyName: string
Title:
AuthorRead Only:trueMaximum Length:360The name of the party. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64The unique identifier of the parent source object associated to the note. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
UpdateFlag: boolean
Title:
Update IndicatorRead Only:trueIndicates whether the user can update the note. -
VisibilityCode: string
Title:
PrivateMaximum Length:30Default Value:INTERNALThe attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
arrayLinksobject-
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
costs: array
Costs for Shipments
Title:
Costs for ShipmentsThe Costs for Shipments resource manages details about the shipping costs for shipments. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the candidate packing unit. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the candidate packing unit. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FOBCode: string
Maximum Length:
30Abbreviation that identifies ownership of the items that are in-transit. A list of accepted values is defined in the lookup type FOB. -
GrossWeight: number
Weight of the packing unit including contents.
-
GrossWeightUOM: string
Maximum Length:
25Unit of measure of the gross weight of the packing unit. -
GrossWeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure of the gross weight of the packing unit. -
innerPackingUnits: array
Outer Packing Units
Title:
Outer Packing UnitsThe Outer Packing Units resource manages details about the outer packing units of a shipment. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the candidate packing unit. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the candidate packing unit. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LPNInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the candidate packing unit. -
MasterSerialNumber: string
Maximum Length:
80Master serial number that identifies the packing unit. -
notes: array
Notes
Title:
NotesThe note objects resource is used to view the note objects. -
packedLines: array
Packed Shipment Lines
Title:
Packed Shipment LinesThe Packed Shipment Lines resource manages details about the shipment lines that are packed within a packing unit. -
PackingUnit: string
Maximum Length:
30Name of the packing unit. -
PackingUnitType: string
Maximum Length:
300Item defining characteristics of a packing unit. -
SealNumber: string
Maximum Length:
30Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport. -
TareWeight: number
Weight of the container that contains the packing unit.
-
TareWeightUOM: string
Maximum Length:
25Unit of measure that the tare weight uses for the packing unit. -
TareWeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure that the tare weight uses for the packing unit. -
TrackingNumber: string
Maximum Length:
30Tracking number of the packing unit. -
Volume: number
Volume of material that the packing unit can hold.
-
VolumeUOM: string
Maximum Length:
25Unit of measure that the container volume uses for the packing unit. -
VolumeUOMCode: string
Maximum Length:
3Code that identifies the unit of measure that the container volume uses for the packing unit.
arrayAttachmentsarrayCosts for ShipmentsarrayErrorsarrayOuter Packing UnitsarrayLinksarrayNotesarrayPacked Shipment Linesobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
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:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
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:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
arrayLinksobject-
Amount: number
Amount for the shipping cost for each unit.
-
ConversionDate: string
(date)
Date when the currency conversion occurred.
-
ConversionRate: number
Rate of the currency conversion.
-
ConversionRateTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of currency conversion. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the candidate shipping cost. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the candidate shipping cost. -
Currency: string
Maximum Length:
15Abbreviation that identifies the currency of the shipping cost. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FreightCostInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the candidate shipping cost. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the candidate shipping cost. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the candidate shipping cost. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
ShippingCostType: string
Maximum Length:
60Type of cost that's predefined in the application. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshFreightCostsInvDFF: array
wshFreightCostsInvDFF
arrayErrorsarrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FreightCostInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FreightCostInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
arrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LPNInterfaceId: integer
(int64)
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
costs: array
Costs for Shipments
Title:
Costs for ShipmentsThe Costs for Shipments resource manages details about the shipping costs for shipments. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the candidate packing unit. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the candidate packing unit. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FOBCode: string
Maximum Length:
30Abbreviation that identifies ownership of the items that are in-transit. A list of accepted values is defined in the lookup type FOB. -
GrossWeight: number
Weight of the packing unit including contents.
-
GrossWeightUOM: string
Maximum Length:
25Unit of measure of the gross weight of the packing unit. -
GrossWeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure of the gross weight of the packing unit. -
innerPackingUnits: array
Outer Packing Units
Title:
Outer Packing UnitsThe Outer Packing Units resource manages details about the outer packing units of a shipment. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the candidate packing unit. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the candidate packing unit. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LPNInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the candidate packing unit. -
MasterSerialNumber: string
Maximum Length:
80Master serial number that identifies the packing unit. -
notes: array
Notes
Title:
NotesThe note objects resource is used to view the note objects. -
packedLines: array
Packed Shipment Lines
Title:
Packed Shipment LinesThe Packed Shipment Lines resource manages details about the shipment lines that are packed within a packing unit. -
PackingUnit: string
Maximum Length:
30Name of the packing unit. -
PackingUnitType: string
Maximum Length:
300Item defining characteristics of a packing unit. -
SealNumber: string
Maximum Length:
30Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport. -
TareWeight: number
Weight of the container that contains the packing unit.
-
TareWeightUOM: string
Maximum Length:
25Unit of measure that the tare weight uses for the packing unit. -
TareWeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure that the tare weight uses for the packing unit. -
TrackingNumber: string
Maximum Length:
30Tracking number of the packing unit. -
Volume: number
Volume of material that the packing unit can hold.
-
VolumeUOM: string
Maximum Length:
25Unit of measure that the container volume uses for the packing unit. -
VolumeUOMCode: string
Maximum Length:
3Code that identifies the unit of measure that the container volume uses for the packing unit.
arrayAttachmentsarrayCosts for ShipmentsarrayErrorsarrayOuter Packing UnitsarrayLinksarrayNotesarrayPacked Shipment Linesobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
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:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
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:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
arrayLinksobject-
Amount: number
Amount for the shipping cost for each unit.
-
ConversionDate: string
(date)
Date when the currency conversion occurred.
-
ConversionRate: number
Rate of the currency conversion.
-
ConversionRateTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of currency conversion. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the candidate shipping cost. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the candidate shipping cost. -
Currency: string
Maximum Length:
15Abbreviation that identifies the currency of the shipping cost. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FreightCostInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the candidate shipping cost. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the candidate shipping cost. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the candidate shipping cost. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
ShippingCostType: string
Maximum Length:
60Type of cost that's predefined in the application. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshFreightCostsInvDFF: array
wshFreightCostsInvDFF
arrayErrorsarrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FreightCostInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FreightCostInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
arrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LPNInterfaceId: integer
(int64)
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the candidate packing unit. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the candidate packing unit. -
FOBCode: string
Maximum Length:
30Abbreviation that identifies ownership of the items that are in-transit. A list of accepted values is defined in the lookup type FOB. -
GrossWeight: number
Weight of the packing unit including contents.
-
GrossWeightUOM: string
Maximum Length:
25Unit of measure of the gross weight of the packing unit. -
GrossWeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure of the gross weight of the packing unit. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the candidate packing unit. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the candidate packing unit. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LPNInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the candidate packing unit. -
MasterSerialNumber: string
Maximum Length:
80Master serial number that identifies the packing unit. -
PackingUnit: string
Maximum Length:
30Name of the packing unit. -
PackingUnitType: string
Maximum Length:
300Item defining characteristics of a packing unit. -
SealNumber: string
Maximum Length:
30Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport. -
TareWeight: number
Weight of the container that contains the packing unit.
-
TareWeightUOM: string
Maximum Length:
25Unit of measure that the tare weight uses for the packing unit. -
TareWeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure that the tare weight uses for the packing unit. -
TrackingNumber: string
Maximum Length:
30Tracking number of the packing unit. -
Volume: number
Volume of material that the packing unit can hold.
-
VolumeUOM: string
Maximum Length:
25Unit of measure that the container volume uses for the packing unit. -
VolumeUOMCode: string
Maximum Length:
3Code that identifies the unit of measure that the container volume uses for the packing unit.
arrayLinksobject-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDThe relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code for extensibility. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDThe unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The currency code for extensibility. -
DeleteFlag: boolean
Title:
Delete IndicatorRead Only:trueIndicates whether the user has access to delete the note. -
EmailAddress: string
Read Only:
trueMaximum Length:320The email address of the user who created the note. -
FormattedAddress: string
Read Only:
trueThe address of the user who created the note. -
FormattedPhoneNumber: string
Read Only:
trueThe phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The unique identifier of the note. This is the primary key of the notes table. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note IDRead Only:trueThe unique identifier of the note. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30The alternate unique identifier of the note. A user key that's 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:
NoteThe column which stores the actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDThe unique identifier of the note. This is the primary key of the notes table. -
PartyId: integer
(int64)
Read Only:
trueThe unique identifier of the party. -
PartyName: string
Title:
AuthorRead Only:trueMaximum Length:360The name of the party. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64The unique identifier of the parent source object associated to the note. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
UpdateFlag: boolean
Title:
Update IndicatorRead Only:trueIndicates whether the user can update the note. -
VisibilityCode: string
Title:
PrivateMaximum Length:30Default Value:INTERNALThe attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
arrayLinksobject-
AssessableValue: number
Value 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
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
costs: array
Costs for Shipments
Title:
Costs for ShipmentsThe Costs for Shipments resource manages details about the shipping costs for shipments. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the candidate shipment line. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the candidate shipment line. -
DeliveryDetailInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the candidate shipment line. -
DFF: array
DFF
-
DocumentFiscalClassification: string
Maximum Length:
240Document fiscal classification. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FirstPartyTaxRegistrationNumber: string
Maximum Length:
30Number that identifies tax registration for the first party of the transaction. The tax authority uses this attribute for taxation purposes. -
GrossWeight: number
Gross weight of the shipment line.
-
IntendedUse: string
Maximum Length:
30Name of the intended use classification. -
Item: string
Maximum Length:
240Name of the item. -
ItemRevision: string
Maximum Length:
18Revision of the item. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the candidate shipment line. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the candidate shipment line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoadingSequence: number
Sequence to use when loading the shipment line.
-
LocationOfFinalDischargeCode: string
Maximum Length:
60Abbreviation that identifies the final discharge location. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
lots: array
Lots for Unpacked Shipment Lines
Title:
Lots for Unpacked Shipment LinesThe Lots for Unpacked Shipment Lines resource manages details about lot numbers for items under lot control in unpacked shipment lines. -
NetWeight: number
Net weight of the shipment line.
-
notes: array
Notes
Title:
NotesThe note objects resource is used to view the note objects. -
Order: string
Title:
Sales OrderRead Only:trueMaximum Length:150Number that identifies the sales order from the order capture application. -
ProductCategory: string
Maximum Length:
240Product category of the transaction line. -
ProductFiscalClassification: string
Maximum Length:
250Product fiscal classification of the transaction line. -
ProductTypeCode: string
Maximum Length:
240Abbreviation that identifies the product type of the inventory item. -
QuantityToBackorder: number
Quantity requested to be back ordered for the shipment line.
This attribute is associated with a feature that requires opt in. -
RequestedQuantityToConsume: number
Requested quantity to consume for this shipment for the shipment line. This attribute is associated with a feature that requires opt in.
-
SecondaryShippedQuantity: number
Shipped quantity, in the secondary unit of measure.
-
SecondaryShippedQuantityUOM: string
Maximum Length:
25Secondary unit of measure for the shipped quantity. -
SecondaryShippedQuantityUOMCode: string
Maximum Length:
3Code that identifies the secondary unit of measure for the shipped quantity. -
serials: array
Serials for Unpacked Shipment Lines
Title:
Serials for Unpacked Shipment LinesThe Serials for Unpacked Shipment Lines resource manages details about serial numbers for items under serial control in unpacked shipment lines. -
ShipmentLine: integer
(int64)
Value that uniquely identifies the shipment line.
-
ShippedQuantity: number
Shipped quantity.
-
ShippedQuantityUOM: string
Maximum Length:
25Unit of measure for the shipped quantity. -
ShippedQuantityUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the shipped quantity. -
SoldToCustomer: string
Title:
NameRead Only:trueMaximum Length:360Name of the party who purchased the sales order line. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
TaxationCountry: string
Maximum Length:
80Country where the transaction occurs. The tax authority uses this attribute for taxation purposes. -
TaxClassificationCode: string
Maximum Length:
50Abbreviation that identifies a group of taxes for reporting and processing. The tax authority uses this attribute for taxation purposes. -
TaxExemptionCertificateNumber: string
Maximum Length:
80Number that identifies the certificate for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxExemptionReasonCode: string
Maximum Length:
30Abbreviation that identifies the reason for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxInvoiceDate: string
(date)
Date and time of the tax invoice that you use to meet tax reporting that different countries require.
-
TaxInvoiceNumber: string
Maximum Length:
150Number of the tax invoice that you use to meet tax reporting that different countries require. -
ThirdPartyTaxRegistrationNumber: string
Maximum Length:
30Number that identifies tax registration for the third party of the transaction. The tax authority uses this attribute for taxation purposes. -
TrackingNumber: string
Maximum Length:
30Tracking number of the shipment line. -
TransactionBusinessCategory: string
Maximum Length:
240Name 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. -
UserDefinedFiscalClassificationCode: string
Maximum Length:
30Abbreviation that identifies the classification for each tax requirement that you can't define using the fiscal classification types that already exist. -
Volume: number
Volume of the shipment line.
-
VolumeUOM: string
Maximum Length:
25Unit of measure for the volume of the shipment line. -
VolumeUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the volume of the shipment line. -
WeightUOM: string
Maximum Length:
25Unit of measure for the weight of the shipment line. -
WeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the weight of the shipment line. -
wshInvStripingDFF: array
wshInvStripingDFF
arrayAttachmentsarrayCosts for ShipmentsarrayErrorsarrayLinksarrayLots for Unpacked Shipment LinesarrayNotesarraySerials for Unpacked Shipment Linesobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
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:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
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:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
arrayLinksobject-
Amount: number
Amount for the shipping cost for each unit.
-
ConversionDate: string
(date)
Date when the currency conversion occurred.
-
ConversionRate: number
Rate of the currency conversion.
-
ConversionRateTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of currency conversion. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the candidate shipping cost. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the candidate shipping cost. -
Currency: string
Maximum Length:
15Abbreviation that identifies the currency of the shipping cost. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FreightCostInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the candidate shipping cost. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the candidate shipping cost. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the candidate shipping cost. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
ShippingCostType: string
Maximum Length:
60Type of cost that's predefined in the application. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshFreightCostsInvDFF: array
wshFreightCostsInvDFF
arrayErrorsarrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FreightCostInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FreightCostInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
arrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
DeliveryDetailInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the lot interface inventory transaction. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the lot interface inventory transaction. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the lot interface inventory transaction. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the lot interface inventory transaction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
Lot: string
Maximum Length:
80Number that identifies the lot for the item. This attribute is used when the warehouse places the item under lot control. -
Quantity: number
Quantity for the lot transaction.
-
SecondaryQuantity: number
Quantity for the lot transaction, in the secondary unit of measure.
-
serials: array
Serials for Unpacked Shipment Lines
Title:
Serials for Unpacked Shipment LinesThe Serials for Unpacked Shipment Lines resource manages details about serial numbers for items under serial control in unpacked shipment lines. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
TransactionInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the lot interface inventory transaction. -
wshLotsInvDFF: array
wshLotsInvDFF
arrayErrorsarrayLinksarraySerials for Unpacked Shipment Linesobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
attributeDFF: array
attributeDFF
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the serial interface inventory transaction. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the serial interface inventory transaction. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FromSerialNumber: string
Maximum Length:
80Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the serial interface inventory transaction. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the serial interface inventory transaction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
standardDFF: array
standardDFF
-
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
TransactionInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the serial interface inventory transaction. -
wshSerialInvDFF: array
wshSerialInvDFF
arrayErrorsarrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotNumber: string
Maximum Length:
80 -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDThe relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code for extensibility. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDThe unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The currency code for extensibility. -
DeleteFlag: boolean
Title:
Delete IndicatorRead Only:trueIndicates whether the user has access to delete the note. -
EmailAddress: string
Read Only:
trueMaximum Length:320The email address of the user who created the note. -
FormattedAddress: string
Read Only:
trueThe address of the user who created the note. -
FormattedPhoneNumber: string
Read Only:
trueThe phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The unique identifier of the note. This is the primary key of the notes table. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note IDRead Only:trueThe unique identifier of the note. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30The alternate unique identifier of the note. A user key that's 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:
NoteThe column which stores the actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDThe unique identifier of the note. This is the primary key of the notes table. -
PartyId: integer
(int64)
Read Only:
trueThe unique identifier of the party. -
PartyName: string
Title:
AuthorRead Only:trueMaximum Length:360The name of the party. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64The unique identifier of the parent source object associated to the note. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
UpdateFlag: boolean
Title:
Update IndicatorRead Only:trueIndicates whether the user can update the note. -
VisibilityCode: string
Title:
PrivateMaximum Length:30Default Value:INTERNALThe attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
arrayLinksobject-
attributeDFF: array
attributeDFF
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the serial interface inventory transaction. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the serial interface inventory transaction. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FromSerialNumber: string
Maximum Length:
80Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the serial interface inventory transaction. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the serial interface inventory transaction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
standardDFF: array
standardDFF
-
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
TransactionInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the serial interface inventory transaction. -
wshSerialInvDFF: array
wshSerialInvDFF
arrayErrorsarrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
DeliveryDetailInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
arrayLinksobject-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDThe relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code for extensibility. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDThe unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The currency code for extensibility. -
DeleteFlag: boolean
Title:
Delete IndicatorRead Only:trueIndicates whether the user has access to delete the note. -
EmailAddress: string
Read Only:
trueMaximum Length:320The email address of the user who created the note. -
FormattedAddress: string
Read Only:
trueThe address of the user who created the note. -
FormattedPhoneNumber: string
Read Only:
trueThe phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The unique identifier of the note. This is the primary key of the notes table. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note IDRead Only:trueThe unique identifier of the note. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30The alternate unique identifier of the note. A user key that's 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:
NoteThe column which stores the actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDThe unique identifier of the note. This is the primary key of the notes table. -
PartyId: integer
(int64)
Read Only:
trueThe unique identifier of the party. -
PartyName: string
Title:
AuthorRead Only:trueMaximum Length:360The name of the party. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64The unique identifier of the parent source object associated to the note. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
UpdateFlag: boolean
Title:
Update IndicatorRead Only:trueIndicates whether the user can update the note. -
VisibilityCode: string
Title:
PrivateMaximum Length:30Default Value:INTERNALThe attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
arrayLinksobject-
AssessableValue: number
Value 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
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
costs: array
Costs for Shipments
Title:
Costs for ShipmentsThe Costs for Shipments resource manages details about the shipping costs for shipments. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the candidate shipment line. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the candidate shipment line. -
DeliveryDetailInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the candidate shipment line. -
DFF: array
DFF
-
DocumentFiscalClassification: string
Maximum Length:
240Document fiscal classification. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FirstPartyTaxRegistrationNumber: string
Maximum Length:
30Number that identifies tax registration for the first party of the transaction. The tax authority uses this attribute for taxation purposes. -
GrossWeight: number
Gross weight of the shipment line.
-
IntendedUse: string
Maximum Length:
30Name of the intended use classification. -
Item: string
Maximum Length:
240Name of the item. -
ItemRevision: string
Maximum Length:
18Revision of the item. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the candidate shipment line. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the candidate shipment line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoadingSequence: number
Sequence to use when loading the shipment line.
-
LocationOfFinalDischargeCode: string
Maximum Length:
60Abbreviation that identifies the final discharge location. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
lots: array
Lots for Unpacked Shipment Lines
Title:
Lots for Unpacked Shipment LinesThe Lots for Unpacked Shipment Lines resource manages details about lot numbers for items under lot control in unpacked shipment lines. -
NetWeight: number
Net weight of the shipment line.
-
notes: array
Notes
Title:
NotesThe note objects resource is used to view the note objects. -
Order: string
Title:
Sales OrderRead Only:trueMaximum Length:150Number that identifies the sales order from the order capture application. -
ProductCategory: string
Maximum Length:
240Product category of the transaction line. -
ProductFiscalClassification: string
Maximum Length:
250Product fiscal classification of the transaction line. -
ProductTypeCode: string
Maximum Length:
240Abbreviation that identifies the product type of the inventory item. -
QuantityToBackorder: number
Quantity requested to be back ordered for the shipment line.
This attribute is associated with a feature that requires opt in. -
RequestedQuantityToConsume: number
Requested quantity to consume for this shipment for the shipment line. This attribute is associated with a feature that requires opt in.
-
SecondaryShippedQuantity: number
Shipped quantity, in the secondary unit of measure.
-
SecondaryShippedQuantityUOM: string
Maximum Length:
25Secondary unit of measure for the shipped quantity. -
SecondaryShippedQuantityUOMCode: string
Maximum Length:
3Code that identifies the secondary unit of measure for the shipped quantity. -
serials: array
Serials for Unpacked Shipment Lines
Title:
Serials for Unpacked Shipment LinesThe Serials for Unpacked Shipment Lines resource manages details about serial numbers for items under serial control in unpacked shipment lines. -
ShipmentLine: integer
(int64)
Value that uniquely identifies the shipment line.
-
ShippedQuantity: number
Shipped quantity.
-
ShippedQuantityUOM: string
Maximum Length:
25Unit of measure for the shipped quantity. -
ShippedQuantityUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the shipped quantity. -
SoldToCustomer: string
Title:
NameRead Only:trueMaximum Length:360Name of the party who purchased the sales order line. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
TaxationCountry: string
Maximum Length:
80Country where the transaction occurs. The tax authority uses this attribute for taxation purposes. -
TaxClassificationCode: string
Maximum Length:
50Abbreviation that identifies a group of taxes for reporting and processing. The tax authority uses this attribute for taxation purposes. -
TaxExemptionCertificateNumber: string
Maximum Length:
80Number that identifies the certificate for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxExemptionReasonCode: string
Maximum Length:
30Abbreviation that identifies the reason for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxInvoiceDate: string
(date)
Date and time of the tax invoice that you use to meet tax reporting that different countries require.
-
TaxInvoiceNumber: string
Maximum Length:
150Number of the tax invoice that you use to meet tax reporting that different countries require. -
ThirdPartyTaxRegistrationNumber: string
Maximum Length:
30Number that identifies tax registration for the third party of the transaction. The tax authority uses this attribute for taxation purposes. -
TrackingNumber: string
Maximum Length:
30Tracking number of the shipment line. -
TransactionBusinessCategory: string
Maximum Length:
240Name 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. -
UserDefinedFiscalClassificationCode: string
Maximum Length:
30Abbreviation that identifies the classification for each tax requirement that you can't define using the fiscal classification types that already exist. -
Volume: number
Volume of the shipment line.
-
VolumeUOM: string
Maximum Length:
25Unit of measure for the volume of the shipment line. -
VolumeUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the volume of the shipment line. -
WeightUOM: string
Maximum Length:
25Unit of measure for the weight of the shipment line. -
WeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the weight of the shipment line. -
wshInvStripingDFF: array
wshInvStripingDFF
arrayAttachmentsarrayCosts for ShipmentsarrayErrorsarrayLinksarrayLots for Unpacked Shipment LinesarrayNotesarraySerials for Unpacked Shipment Linesobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
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:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
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:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
arrayLinksobject-
Amount: number
Amount for the shipping cost for each unit.
-
ConversionDate: string
(date)
Date when the currency conversion occurred.
-
ConversionRate: number
Rate of the currency conversion.
-
ConversionRateTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of currency conversion. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the candidate shipping cost. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the candidate shipping cost. -
Currency: string
Maximum Length:
15Abbreviation that identifies the currency of the shipping cost. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FreightCostInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the candidate shipping cost. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the candidate shipping cost. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the candidate shipping cost. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
ShippingCostType: string
Maximum Length:
60Type of cost that's predefined in the application. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshFreightCostsInvDFF: array
wshFreightCostsInvDFF
arrayErrorsarrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FreightCostInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FreightCostInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
arrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
DeliveryDetailInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the lot interface inventory transaction. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the lot interface inventory transaction. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the lot interface inventory transaction. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the lot interface inventory transaction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
Lot: string
Maximum Length:
80Number that identifies the lot for the item. This attribute is used when the warehouse places the item under lot control. -
Quantity: number
Quantity for the lot transaction.
-
SecondaryQuantity: number
Quantity for the lot transaction, in the secondary unit of measure.
-
serials: array
Serials for Unpacked Shipment Lines
Title:
Serials for Unpacked Shipment LinesThe Serials for Unpacked Shipment Lines resource manages details about serial numbers for items under serial control in unpacked shipment lines. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
TransactionInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the lot interface inventory transaction. -
wshLotsInvDFF: array
wshLotsInvDFF
arrayErrorsarrayLinksarraySerials for Unpacked Shipment Linesobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
attributeDFF: array
attributeDFF
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the serial interface inventory transaction. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the serial interface inventory transaction. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FromSerialNumber: string
Maximum Length:
80Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the serial interface inventory transaction. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the serial interface inventory transaction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
standardDFF: array
standardDFF
-
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
TransactionInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the serial interface inventory transaction. -
wshSerialInvDFF: array
wshSerialInvDFF
arrayErrorsarrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotNumber: string
Maximum Length:
80 -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDThe relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code for extensibility. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDThe unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The currency code for extensibility. -
DeleteFlag: boolean
Title:
Delete IndicatorRead Only:trueIndicates whether the user has access to delete the note. -
EmailAddress: string
Read Only:
trueMaximum Length:320The email address of the user who created the note. -
FormattedAddress: string
Read Only:
trueThe address of the user who created the note. -
FormattedPhoneNumber: string
Read Only:
trueThe phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The unique identifier of the note. This is the primary key of the notes table. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note IDRead Only:trueThe unique identifier of the note. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30The alternate unique identifier of the note. A user key that's 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:
NoteThe column which stores the actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDThe unique identifier of the note. This is the primary key of the notes table. -
PartyId: integer
(int64)
Read Only:
trueThe unique identifier of the party. -
PartyName: string
Title:
AuthorRead Only:trueMaximum Length:360The name of the party. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64The unique identifier of the parent source object associated to the note. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
UpdateFlag: boolean
Title:
Update IndicatorRead Only:trueIndicates whether the user can update the note. -
VisibilityCode: string
Title:
PrivateMaximum Length:30Default Value:INTERNALThe attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
arrayLinksobject-
attributeDFF: array
attributeDFF
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the serial interface inventory transaction. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the serial interface inventory transaction. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FromSerialNumber: string
Maximum Length:
80Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the serial interface inventory transaction. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the serial interface inventory transaction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
standardDFF: array
standardDFF
-
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
TransactionInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the serial interface inventory transaction. -
wshSerialInvDFF: array
wshSerialInvDFF
arrayErrorsarrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
DeliveryDetailInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
arrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
DeliveryInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
AssessableValue: number
Value 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
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
costs: array
Costs for Shipments
Title:
Costs for ShipmentsThe Costs for Shipments resource manages details about the shipping costs for shipments. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the candidate shipment line. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the candidate shipment line. -
DeliveryDetailInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the candidate shipment line. -
DFF: array
DFF
-
DocumentFiscalClassification: string
Maximum Length:
240Document fiscal classification. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FirstPartyTaxRegistrationNumber: string
Maximum Length:
30Number that identifies tax registration for the first party of the transaction. The tax authority uses this attribute for taxation purposes. -
GrossWeight: number
Gross weight of the shipment line.
-
IntendedUse: string
Maximum Length:
30Name of the intended use classification. -
Item: string
Maximum Length:
240Name of the item. -
ItemRevision: string
Maximum Length:
18Revision of the item. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the candidate shipment line. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the candidate shipment line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoadingSequence: number
Sequence to use when loading the shipment line.
-
LocationOfFinalDischargeCode: string
Maximum Length:
60Abbreviation that identifies the final discharge location. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
lots: array
Lots for Unpacked Shipment Lines
Title:
Lots for Unpacked Shipment LinesThe Lots for Unpacked Shipment Lines resource manages details about lot numbers for items under lot control in unpacked shipment lines. -
NetWeight: number
Net weight of the shipment line.
-
notes: array
Notes
Title:
NotesThe note objects resource is used to view the note objects. -
Order: string
Title:
Sales OrderRead Only:trueMaximum Length:150Number that identifies the sales order from the order capture application. -
ProductCategory: string
Maximum Length:
240Product category of the transaction line. -
ProductFiscalClassification: string
Maximum Length:
250Product fiscal classification of the transaction line. -
ProductTypeCode: string
Maximum Length:
240Abbreviation that identifies the product type of the inventory item. -
QuantityToBackorder: number
Quantity requested to be back ordered for the shipment line.
This attribute is associated with a feature that requires opt in. -
RequestedQuantityToConsume: number
Requested quantity to consume for this shipment for the shipment line. This attribute is associated with a feature that requires opt in.
-
SecondaryShippedQuantity: number
Shipped quantity, in the secondary unit of measure.
-
SecondaryShippedQuantityUOM: string
Maximum Length:
25Secondary unit of measure for the shipped quantity. -
SecondaryShippedQuantityUOMCode: string
Maximum Length:
3Code that identifies the secondary unit of measure for the shipped quantity. -
serials: array
Serials for Unpacked Shipment Lines
Title:
Serials for Unpacked Shipment LinesThe Serials for Unpacked Shipment Lines resource manages details about serial numbers for items under serial control in unpacked shipment lines. -
ShipmentLine: integer
(int64)
Value that uniquely identifies the shipment line.
-
ShippedQuantity: number
Shipped quantity.
-
ShippedQuantityUOM: string
Maximum Length:
25Unit of measure for the shipped quantity. -
ShippedQuantityUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the shipped quantity. -
SoldToCustomer: string
Title:
NameRead Only:trueMaximum Length:360Name of the party who purchased the sales order line. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
TaxationCountry: string
Maximum Length:
80Country where the transaction occurs. The tax authority uses this attribute for taxation purposes. -
TaxClassificationCode: string
Maximum Length:
50Abbreviation that identifies a group of taxes for reporting and processing. The tax authority uses this attribute for taxation purposes. -
TaxExemptionCertificateNumber: string
Maximum Length:
80Number that identifies the certificate for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxExemptionReasonCode: string
Maximum Length:
30Abbreviation that identifies the reason for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxInvoiceDate: string
(date)
Date and time of the tax invoice that you use to meet tax reporting that different countries require.
-
TaxInvoiceNumber: string
Maximum Length:
150Number of the tax invoice that you use to meet tax reporting that different countries require. -
ThirdPartyTaxRegistrationNumber: string
Maximum Length:
30Number that identifies tax registration for the third party of the transaction. The tax authority uses this attribute for taxation purposes. -
TrackingNumber: string
Maximum Length:
30Tracking number of the shipment line. -
TransactionBusinessCategory: string
Maximum Length:
240Name 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. -
UserDefinedFiscalClassificationCode: string
Maximum Length:
30Abbreviation that identifies the classification for each tax requirement that you can't define using the fiscal classification types that already exist. -
Volume: number
Volume of the shipment line.
-
VolumeUOM: string
Maximum Length:
25Unit of measure for the volume of the shipment line. -
VolumeUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the volume of the shipment line. -
WeightUOM: string
Maximum Length:
25Unit of measure for the weight of the shipment line. -
WeightUOMCode: string
Maximum Length:
3Code that identifies the unit of measure for the weight of the shipment line. -
wshInvStripingDFF: array
wshInvStripingDFF
arrayAttachmentsarrayCosts for ShipmentsarrayErrorsarrayLinksarrayLots for Unpacked Shipment LinesarrayNotesarraySerials for Unpacked Shipment Linesobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
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:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
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:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
arrayLinksobject-
Amount: number
Amount for the shipping cost for each unit.
-
ConversionDate: string
(date)
Date when the currency conversion occurred.
-
ConversionRate: number
Rate of the currency conversion.
-
ConversionRateTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of currency conversion. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the candidate shipping cost. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the candidate shipping cost. -
Currency: string
Maximum Length:
15Abbreviation that identifies the currency of the shipping cost. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FreightCostInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the candidate shipping cost. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the candidate shipping cost. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the candidate shipping cost. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
ShippingCostType: string
Maximum Length:
60Type of cost that's predefined in the application. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshFreightCostsInvDFF: array
wshFreightCostsInvDFF
arrayErrorsarrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FreightCostInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FreightCostInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
arrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
DeliveryDetailInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the lot interface inventory transaction. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the lot interface inventory transaction. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the lot interface inventory transaction. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the lot interface inventory transaction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
Lot: string
Maximum Length:
80Number that identifies the lot for the item. This attribute is used when the warehouse places the item under lot control. -
Quantity: number
Quantity for the lot transaction.
-
SecondaryQuantity: number
Quantity for the lot transaction, in the secondary unit of measure.
-
serials: array
Serials for Unpacked Shipment Lines
Title:
Serials for Unpacked Shipment LinesThe Serials for Unpacked Shipment Lines resource manages details about serial numbers for items under serial control in unpacked shipment lines. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
TransactionInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the lot interface inventory transaction. -
wshLotsInvDFF: array
wshLotsInvDFF
arrayErrorsarrayLinksarraySerials for Unpacked Shipment Linesobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
attributeDFF: array
attributeDFF
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the serial interface inventory transaction. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the serial interface inventory transaction. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FromSerialNumber: string
Maximum Length:
80Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the serial interface inventory transaction. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the serial interface inventory transaction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
standardDFF: array
standardDFF
-
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
TransactionInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the serial interface inventory transaction. -
wshSerialInvDFF: array
wshSerialInvDFF
arrayErrorsarrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotNumber: string
Maximum Length:
80 -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDThe relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code for extensibility. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDThe unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The currency code for extensibility. -
DeleteFlag: boolean
Title:
Delete IndicatorRead Only:trueIndicates whether the user has access to delete the note. -
EmailAddress: string
Read Only:
trueMaximum Length:320The email address of the user who created the note. -
FormattedAddress: string
Read Only:
trueThe address of the user who created the note. -
FormattedPhoneNumber: string
Read Only:
trueThe phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The unique identifier of the note. This is the primary key of the notes table. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note IDRead Only:trueThe unique identifier of the note. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30The alternate unique identifier of the note. A user key that's 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:
NoteThe column which stores the actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDThe unique identifier of the note. This is the primary key of the notes table. -
PartyId: integer
(int64)
Read Only:
trueThe unique identifier of the party. -
PartyName: string
Title:
AuthorRead Only:trueMaximum Length:360The name of the party. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64The unique identifier of the parent source object associated to the note. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
UpdateFlag: boolean
Title:
Update IndicatorRead Only:trueIndicates whether the user can update the note. -
VisibilityCode: string
Title:
PrivateMaximum Length:30Default Value:INTERNALThe attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
arrayLinksobject-
attributeDFF: array
attributeDFF
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the serial interface inventory transaction. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the serial interface inventory transaction. -
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FromSerialNumber: string
Maximum Length:
80Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the serial interface inventory transaction. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the serial interface inventory transaction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
standardDFF: array
standardDFF
-
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
TransactionInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the serial interface inventory transaction. -
wshSerialInvDFF: array
wshSerialInvDFF
arrayErrorsarrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
CreatedBy: string
Read Only:
trueMaximum Length:64User who received the error. -
CreationDate: string
(date-time)
Read Only:
trueDate when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the error. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
arrayLinksobject-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask -
TransactionInterfaceId: integer
(int64)
arrayLinksobject-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
DeliveryDetailInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
arrayLinks- errors
-
Operation: /fscmRestApi/resources/11.13.18.05/shipmentTransactionRequests/{TransactionId}/child/errorsParameters:
- TransactionId:
$request.path.TransactionId
The Errors resource manages errors that occur when processing a transaction request. - TransactionId:
- shipments
-
Operation: /fscmRestApi/resources/11.13.18.05/shipmentTransactionRequests/{TransactionId}/child/shipmentsParameters:
- TransactionId:
$request.path.TransactionId
The Shipments resource manages details about shipments. - TransactionId:
Examples
This example describes how to create one request.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests"
Example 1 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{
"ActionCode": "CreateAndConfirmShipment",
"shipments": [
{
"Shipment": "SHP-11062018",
"ShipFromOrganizationCode": "M1",
"GrossWeight": 1000,
"NetWeight": 500,
"WeightUOM": "Pounds",
"Volume": 2000,
"VolumeUOM": "Cubic foot",
"Carrier": "DHL",
"ModeOfTransportCode": "AIR",
"ServiceLevelCode": "2DA",
"notes": [
{
"NoteTxt" : "Um91dGluZyBpbnN0cnVjdGlvbnMgb2YgdGhlIHNoaXBtZW50",
"NoteTypeCode" : "ROUTING_INSTRUCTIONS"
}
],
"shipmentDFF": [
{
"_Global1": "Global1",
"_Global2": "Global2"
}
],
"outerPackingUnits": [
{
"PackingUnit": "PU1",
"PackingUnitType": "Pallet",
"attachments": [
{
"DatatypeCode" : "FILE",
"Title": "Line att. from REST",
"Description": "TEXT UPLOAD for outer packing unit",
"FileName": "LineREST.txt",
"UploadedFileContentType": "text/plain",
"CategoryName" : "MISC",
"FileContents" : "TGluZSBSRVNUIGF0dGFjaG1lbnQgdGV4dA=="
}
],
"innerPackingUnits": [
{
"PackingUnit": "PU2",
"PackingUnitType": "BX54888",
"packedLines": [
{
"ShipmentLine": 3625811,
"Item": "INV-110",
"ShippedQuantity": 6,
"ShippedQuantityUOM": "Each",
"ItemRevision": "A",
"lots": [
{
"Lot": "YP-L001",
"Quantity": 4,
"serials": [
{
"FromSerialNumber": "SS0001",
"ToSerialNumber": "SS0004",
"Subinventory": "ABCSUB01",
"Locator": "ABC1.1.2"
}
]
},
{
"Lot": "YP-L002",
"Quantity": 2,
"serials": [
{
"FromSerialNumber": "SS0106",
"ToSerialNumber": "SS0107",
"Subinventory": "ABCSUB02"
}
]
}
]
}
]
}
],
"costs": [
{
"ShippingCostType": "Handling",
"Amount": 70,
"Currency": "USD",
"DFF": [
{
"_Global1": "PU GBL1",
"_Global2": "PU GBL2"
}
]
}
]
}
],
"unpackedLines": [
{
"ShipmentLine": 3625804,
"Item": "INV-100",
"Subinventory": "ABCSUB01",
"Locator": "ABC1.1.1",
"ShippedQuantity": 2,
"ShippedQuantityUOM": "Each"
}
],
"costs": [
{
"ShippingCostType": "CONTINUOUS MOVE DISTANCE RATE",
"Amount": 10,
"Currency": "USD"
}
]
}
]
}
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{
"TransactionId": 300100169688189,
"ActionCode": "CreateAndConfirmShipment",
"TransactionStatusCode": "AP",
"TransactionStatus": "Awaiting processing",
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:11.524+00:00",
"shipments": [
{
"DeliveryInterfaceId": 300100169688190,
"Shipment": "SHP-11062018",
"Description": null,
"ShipFromOrganizationCode": "M1",
"InitialShipDate": null,
"BillOfLading": null,
"GrossWeight": 1000,
"NetWeight": 500,
"WeightUOM": "Pounds",
"Volume": 2000,
"VolumeUOM": "Cubic foot",
"Equipment": null,
"EquipmentType": null,
"SealNumber": null,
"Carrier": "DHL",
"ModeOfTransportCode": "AIR",
"ServiceLevelCode": "2DA",
"Waybill": null,
"PackingSlip": null,
"ActualShipDate": null,
"PlannedDeliveryDate": null,
"FreightTermsCode": null,
"FOBCode": null,
"FOBAddress1": null,
"FOBAddress2": null,
"FOBAddress3": null,
"FOBAddress4": null,
"FOBCity": null,
"FOBCounty": null,
"FOBPostalCode": null,
"FOBRegion": null,
"FOBState": null,
"FOBCountry": null,
"Dock": null,
"CODAmount": null,
"CODCurrency": null,
"CODPaidBy": null,
"CODRemitTo": null,
"ASNSentDate": null,
"ConfirmedDate": null,
"ConfirmedBy": null,
"LoadingSequenceRule": null,
"ProblemContactReference": null,
"TransportationReasonCode": null,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11.031+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:11.525+00:00",
"shipmentDFF": [
{
"DeliveryInterfaceId": 300100169688190,
"_Global1": "Global1",
"_Global2": "Global2",
"_zBIADFF1": null,
"_BI_New_Deliveries_GBL": null,
"__FLEX_Context": null,
"__FLEX_Context_DisplayValue": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/shipmentDFF/300100169688190",
"name": "shipmentDFF",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/shipmentDFF/300100169688190",
"name": "shipmentDFF",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190",
"name": "shipments",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/shipmentDFF/300100169688190/lov/LVVO___FLEX_Context",
"name": "LVVO___FLEX_Context",
"kind": "collection"
}
]
}
],
"outerPackingUnits": [
{
"LPNInterfaceId": 300100169688193,
"PackingUnit": "PU1",
"TrackingNumber": null,
"MasterSerialNumber": null,
"SealNumber": null,
"PackingUnitType": "Pallet",
"FOBCode": null,
"Volume": null,
"VolumeUOM": null,
"GrossWeight": null,
"GrossWeightUOM": null,
"TareWeight": null,
"TareWeightUOM": null,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11.343+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:11.594+00:00",
"innerPackingUnits": [
{
"LPNInterfaceId": 300100169688196,
"PackingUnit": "PU2",
"TrackingNumber": null,
"MasterSerialNumber": null,
"SealNumber": null,
"PackingUnitType": "BX54888",
"FOBCode": null,
"Volume": null,
"VolumeUOM": null,
"GrossWeight": null,
"GrossWeightUOM": null,
"TareWeight": null,
"TareWeightUOM": null,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11.378+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:13.884+00:00",
"packedLines": [
{
"DeliveryDetailInterfaceId": 300100169688197,
"ShipmentLine": 3625811,
"Item": "INV-110",
"ItemRevision": "A",
"Subinventory": null,
"Locator": null,
"ShippedQuantity": 6,
"ShippedQuantityUOM": "Each",
"SecondaryShippedQuantity": null,
"SecondaryShippedQuantityUOM": null,
"NetWeight": null,
"GrossWeight": null,
"WeightUOM": null,
"Volume": null,
"VolumeUOM": null,
"LoadingSequence": null,
"TaxationCountry": null,
"TransactionBusinessCategory": null,
"DocumentFiscalClassification": null,
"UserDefinedFiscalClassificationCode": null,
"ProductFiscalClassification": null,
"IntendedUse": null,
"ProductCategory": null,
"LocationOfFinalDischargeCode": null,
"TaxClassificationCode": null,
"ProductTypeCode": null,
"FirstPartyTaxRegistrationNumber": null,
"ThirdPartyTaxRegistrationNumber": null,
"TaxInvoiceNumber": null,
"TaxInvoiceDate": null,
"AssessableValue": null,
"TaxExemptionCertificateNumber": null,
"TaxExemptionReasonCode": null,
"Order": null,
"SoldToCustomer": null,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11.398+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:13.885+00:00",
"lots": [
{
"TransactionInterfaceId": 300100169688198,
"Lot": "YP-L001",
"Subinventory": null,
"Locator": null,
"Quantity": 4,
"SecondaryQuantity": null,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11.419+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:13.887+00:00",
"serials": [
{
"TransactionInterfaceId": 300100169688199,
"FromSerialNumber": "SS0001",
"ToSerialNumber": "SS0004",
"Subinventory": "ABCSUB01",
"Locator": "ABC1.1.2",
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11.433+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:11.523+00:00",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031/child/serials/00020000000EACED00057708000110F08402E48700000006535330303031",
"name": "serials",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031/child/serials/00020000000EACED00057708000110F08402E48700000006535330303031",
"name": "serials",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031",
"name": "lots",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031/child/serials/00020000000EACED00057708000110F08402E48700000006535330303031/child/attributeDFF",
"name": "attributeDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031/child/serials/00020000000EACED00057708000110F08402E48700000006535330303031/child/errors",
"name": "errors",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031/child/serials/00020000000EACED00057708000110F08402E48700000006535330303031/child/standardDFF",
"name": "standardDFF",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031",
"name": "lots",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031",
"name": "lots",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197",
"name": "packedLines",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031/child/errors",
"name": "errors",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4860000000759502D4C303031/child/serials",
"name": "serials",
"kind": "collection"
}
]
},
{
"TransactionInterfaceId": 300100169688200,
"Lot": "YP-L002",
"Subinventory": null,
"Locator": null,
"Quantity": 2,
"SecondaryQuantity": null,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11.435+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:13.936+00:00",
"serials": [
{
"TransactionInterfaceId": 300100169688201,
"FromSerialNumber": "SS0106",
"ToSerialNumber": "SS0107",
"Subinventory": "ABCSUB02",
"Locator": null,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2018-11-07T00:15:11.438+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2018-11-07T00:15:11.523+00:00",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032/child/serials/00020000000EACED00057708000110F08402E48900000006535330313036",
"name": "serials",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032/child/serials/00020000000EACED00057708000110F08402E48900000006535330313036",
"name": "serials",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032",
"name": "lots",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032/child/serials/00020000000EACED00057708000110F08402E48900000006535330313036/child/attributeDFF",
"name": "attributeDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032/child/serials/00020000000EACED00057708000110F08402E48900000006535330313036/child/errors",
"name": "errors",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032/child/serials/00020000000EACED00057708000110F08402E48900000006535330313036/child/standardDFF",
"name": "standardDFF",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032",
"name": "lots",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032",
"name": "lots",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197",
"name": "packedLines",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032/child/errors",
"name": "errors",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100169688189/child/shipments/300100169688190/child/outerPackingUnits/300100169688193/child/innerPackingUnits/300100169688196/child/packedLines/300100169688197/child/lots/00020000000EACED00057708000110F08402E4880000000759502D4C303032/child/serials",
"name": "serials",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"https://servername/fscmRestApi/resources/version/shipmentTransactionRequests",
"name": "shipmentTransactionRequests",
"kind": "collection"
}
]
}
]
}
]
}
]
}
}
Example 2 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{
"ActionCode": "ShipmentCreate",
"shipments": [
{
"ShipFromOrganizationCode": "M1",
"SoldToCustomerNumber": "1006",
"ShipToPartySiteNumber": "1089",
"Description": "ShipmentCreate from REST",
"InitialShipDate": "2018-09-16T10:35:24-07:00",
"PlannedDeliveryDate": "2018-09-16T11:27:12-07:00",
"GrossWeight": 1000,
"NetWeight": 500,
"WeightUOM": "Pounds",
"Volume": 2000,
"VolumeUOM": "Cubic foot",
"Equipment": "veh-123456",
"EquipmentType": "PLCARGO",
"CarrierNumber": "10003",
"ModeOfTransportCode": "AIR",
"ServiceLevelCode": "2DA",
"Waybill": "Waybill-REST",
"SealNumber": "Seal-REST",
"FreightTerms": "Collect freight",
"FOBCode": "DEST",
"FOBSiteNumber": "1089",
"Dock": "Dock-REST",
"CODAmount": 100,
"CODCurrency": "AED",
"CODPaidBy": "Vision Operations",
"CODRemitTo": "Vision",
"LoadingSequenceRule": "Forward",
"ProblemContactReference": "Vision",
"TransportationReasonCode": "ORA_COMPLET",
"AutomaticallyPackFlag": true,
"EnableAutoshipFlag": false
}
]
}
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{
"TransactionId": 300100175337991,
"ActionCode": "ShipmentCreate",
"TransactionStatusCode": "SC",
"TransactionStatus": "Successfully completed",
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2019-03-05T23:43:38+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2019-03-05T23:43:38.042+00:00",
"shipments": {
"items": [
{
"DeliveryInterfaceId": 300100175337992,
"Shipment": "2342633",
"Description": "ShipmentCreate from REST",
"ShipFromOrganizationCode": "M1",
"SoldToCustomerNumber": "1006",
"SoldToCustomer": "Computer Service and Rentals",
"ShipToPartySiteNumber": "1089",
"InitialShipDate": "2018-09-16T17:35:24+00:00",
"BillOfLading": null,
"GrossWeight": 1000,
"NetWeight": 500,
"WeightUOM": "Pounds",
"Volume": 2000,
"VolumeUOM": "Cubic foot",
"Equipment": "veh-123456",
"EquipmentType": "PLCARGO",
"SealNumber": "Seal-REST",
"CarrierNumber": "10003",
"Carrier": "DHL",
"ModeOfTransportCode": "AIR",
"ServiceLevelCode": "2DA",
"Waybill": "Waybill-REST",
"PackingSlip": null,
"ActualShipDate": null,
"PlannedDeliveryDate": "2018-09-16T18:27:12+00:00",
"FreightTermsCode": "COLLECT",
"FreightTerms": "Collect freight",
"FOBCode": "DEST",
"FOBSiteNumber": "1089",
"FOBAddress1": null,
"FOBAddress2": null,
"FOBAddress3": null,
"FOBAddress4": null,
"FOBCity": null,
"FOBCounty": null,
"FOBPostalCode": null,
"FOBRegion": null,
"FOBState": null,
"FOBCountry": null,
"Dock": "Dock-REST",
"CODAmount": 100,
"CODCurrency": "AED",
"CODPaidBy": "Vision Operations",
"CODRemitTo": "Oracle",
"ASNSentDate": null,
"ConfirmedDate": null,
"ConfirmedBy": null,
"LoadingSequenceRule": "Forward",
"ProblemContactReference": "Oracle",
"TransportationReasonCode": "ORA_COMPLET",
"PlannedFlag": false,
"AutomaticallyPackFlag": true,
"EnableAutoshipFlag": false,
"ProrateWeightFlag": null,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2019-03-05T23:43:38+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2019-03-05T23:43:38+00:00",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991/child/shipments/300100175337992",
"name": "shipments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991/child/shipments/300100175337992",
"name": "shipments",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991",
"name": "shipmentTransactionRequests",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991/child/shipments/300100175337992/child/shipmentDFF",
"name": "shipmentDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991/child/shipments/300100175337992/child/errors",
"name": "errors",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991/child/shipments/300100175337992/child/outerPackingUnits",
"name": "outerPackingUnits",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991/child/shipments/300100175337992/child/globalDFF",
"name": "globalDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991/child/shipments/300100175337992/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991/child/shipments/300100175337992/child/unpackedLines",
"name": "unpackedLines",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991/child/shipments/300100175337992/child/notes",
"name": "notes",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991/child/shipments/300100175337992/child/costs",
"name": "costs",
"kind": "collection"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991/child/shipments",
"name": "shipments",
"kind": "collection"
}
]
},
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991",
"name": "shipmentTransactionRequests",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991",
"name": "shipmentTransactionRequests",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991/child/errors",
"name": "errors",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337991/child/shipments",
"name": "shipments",
"kind": "collection"
}
]
}
Example 3 Request Body
The following example includes the contents of the request body in JSON format to update a shipment. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{
"ActionCode": "ShipmentUpdate",
"shipments": [
{
"Shipment": "2342633",
"Description": "ShipmentUpdate from REST",
"GrossWeight": 1001,
"NetWeight": 501,
"WeightUOM": "Pounds",
"Volume": 2001,
"VolumeUOM": "Cubic foot",
"CarrierNumber": "10003",
"ModeOfTransportCode": "AIR",
"ServiceLevelCode": "2DA",
"PlannedFlag": false,
"AutomaticallyPackFlag": false,
"EnableAutoshipFlag": true,
"ProrateWeightFlag": true
}
]
}
Example 3 Response Body
The following example includes the contents of the response body in JSON format:
{
"TransactionId": 300100175337993,
"ActionCode": "ShipmentUpdate",
"TransactionStatusCode": "SC",
"TransactionStatus": "Successfully completed",
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2019-03-05T23:44:07+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2019-03-05T23:44:07.041+00:00",
"shipments": {
"items": [
{
"DeliveryInterfaceId": 300100175337994,
"Shipment": "2342633",
"Description": "ShipmentUpdate from REST",
"ShipFromOrganizationCode": "M1",
"SoldToCustomerNumber": "1006",
"SoldToCustomer": "Computer Service and Rentals",
"ShipToPartySiteNumber": "1089",
"InitialShipDate": "2018-09-16T17:35:24+00:00",
"BillOfLading": null,
"GrossWeight": 1001,
"NetWeight": 501,
"WeightUOM": "Pounds",
"Volume": 2001,
"VolumeUOM": "Cubic foot",
"Equipment": "veh-123456",
"EquipmentType": "PLCARGO",
"SealNumber": "Seal-REST",
"CarrierNumber": "10003",
"Carrier": "DHL",
"ModeOfTransportCode": "AIR",
"ServiceLevelCode": "2DA",
"Waybill": "Waybill-REST",
"PackingSlip": null,
"ActualShipDate": null,
"PlannedDeliveryDate": "2018-09-16T18:27:12+00:00",
"FreightTermsCode": "COLLECT",
"FreightTerms": "Collect freight",
"FOBCode": "DEST",
"FOBSiteNumber": "1089",
"FOBAddress1": null,
"FOBAddress2": null,
"FOBAddress3": null,
"FOBAddress4": null,
"FOBCity": null,
"FOBCounty": null,
"FOBPostalCode": null,
"FOBRegion": null,
"FOBState": null,
"FOBCountry": null,
"Dock": "Dock-REST",
"CODAmount": 100,
"CODCurrency": "AED",
"CODPaidBy": "Vision Operations",
"CODRemitTo": "Vision",
"ASNSentDate": null,
"ConfirmedDate": null,
"ConfirmedBy": null,
"LoadingSequenceRule": "Forward",
"ProblemContactReference": "Vision",
"TransportationReasonCode": "ORA_COMPLET",
"PlannedFlag": false,
"AutomaticallyPackFlag": false,
"EnableAutoshipFlag": true,
"ProrateWeightFlag": true,
"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
"CreationDate": "2019-03-05T23:43:38+00:00",
"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
"LastUpdateDate": "2019-03-05T23:44:07+00:00",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993/child/shipments/300100175337994",
"name": "shipments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993/child/shipments/300100175337994",
"name": "shipments",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993",
"name": "shipmentTransactionRequests",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993/child/shipments/300100175337994/child/shipmentDFF",
"name": "shipmentDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993/child/shipments/300100175337994/child/errors",
"name": "errors",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993/child/shipments/300100175337994/child/outerPackingUnits",
"name": "outerPackingUnits",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993/child/shipments/300100175337994/child/globalDFF",
"name": "globalDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993/child/shipments/300100175337994/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993/child/shipments/300100175337994/child/unpackedLines",
"name": "unpackedLines",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993/child/shipments/300100175337994/child/notes",
"name": "notes",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993/child/shipments/300100175337994/child/costs",
"name": "costs",
"kind": "collection"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993/child/shipments",
"name": "shipments",
"kind": "collection"
}
]
},
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993",
"name": "shipmentTransactionRequests",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993",
"name": "shipmentTransactionRequests",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993/child/errors",
"name": "errors",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/shipmentTransactionRequests/300100175337993/child/shipments",
"name": "shipments",
"kind": "collection"
}
]
}