GET action not supported
get
/fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds shipment line change requests according to the primary key criteria.
Finder Variables:- TransactionId; integer; Value that uniquely identifies the shipment line change request.
- PrimaryKey: Finds shipment line change requests according to the primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CreatedBy; string; User who created the shipment line change request.
- CreationDate; string; Date when the shipment line change request was created.
- LastUpdateDate; string; Date when the shipment line change request was last updated.
- LastUpdatedBy; string; User who most recently updated the shipment line change request.
- TransactionId; integer; Value that uniquely identifies the shipment line change request.
- TransactionStatus; string; Value that indicates the status of the transaction. A list of accepted values is defined in the lookup type WSH_TXN_STATUS.
- TransactionStatusCode; string; Abbreviation that identifies the status of the transaction. A list of accepted values is defined in the lookup type WSH_TXN_STATUS.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : shipmentLineChangeRequests
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLineChangeRequests-item-response
Type:
Show Source
object
-
ActionCode: string
Value that uniquely identifies the action to be run for this transaction request. Valid value is UpdateAttributes.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the shipment line change request. -
CreationDate: string
(date-time)
Read Only:
true
Date when the shipment line change request was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the shipment line change request was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the shipment line change request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
shipmentLines: array
Shipment Lines
Title:
Shipment Lines
The Shipment Lines resource manages details about the shipment lines. -
TransactionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the shipment line change request. -
TransactionStatus: string
Read Only:
true
Value 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:
true
Maximum Length:2
Default Value:AP
Abbreviation that identifies the status of the transaction. A list of accepted values is defined in the lookup type WSH_TXN_STATUS.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Shipment Lines
Type:
array
Title:
Shipment Lines
The Shipment Lines resource manages details about the shipment lines.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : shipmentLineChangeRequests-shipmentLines-item-response
Type:
Show Source
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:
Attachments
The Attachments resource manages details about shipment line attachments. -
BackorderedQuantity: number
Quantity that the application withholds from processing until inventory becomes available.
-
DFF: array
Flexfields for Shipment Lines
Title:
Flexfields for Shipment Lines
The Flexfields for Shipment Lines resource manages flexfield details about shipment lines. -
DocumentFiscalClassification: string
Maximum Length:
240
Value that indicates the document fiscal classification. -
FirstPartyTaxRegistrationNumber: string
Maximum Length:
30
Number 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:
30
Name of the intended use classification. -
ItemRevision: string
Maximum Length:
3
Revision of the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoadingSequence: number
Sequence to use when loading the shipment line.
-
LocationOfFinalDischargeCode: string
Maximum Length:
60
Abbreviation that identifies the final discharge location. -
Locator: string
Maximum Length:
2000
Locator to use for shipping material to fulfill the line. -
Lot: string
Maximum Length:
80
Number that identifies the lot for the item. The application uses this attribute when the warehouse places the item under lot control. -
NetWeight: number
Net weight of the shipment line.
-
notes: array
Notes
Title:
Notes
The Notes resource manages details about shipment line notes. -
ProductCategory: string
Maximum Length:
240
Product category of the transaction line. -
ProductFiscalClassification: string
Maximum Length:
250
Product fiscal classification of the transaction line. -
ProductTypeCode: string
Maximum Length:
240
Abbreviation that identifies the product type of the inventory item. -
SealNumber: string
Maximum Length:
30
Number that identifies the seal on a packing unit, locker, or truck to prove that the container remained closed during transport. -
SecondaryBackorderedQuantity: number
Quantity in the secondary unit of measure for the item that the application withheld from processing until inventory becomes available.
-
SecondaryShippedQuantity: number
Shipped quantity, in the secondary unit of measure.
-
serials: array
Serials
Title:
Serials
The Serials resource manages details about serial numbers for items in shipment lines. -
ShipmentLine: integer
(int64)
Value that uniquely identifies the shipment line.
-
ShippedQuantity: number
Shipped quantity in the requested unit of measure.
-
SrcAttribute1: string
Maximum Length:
150
Value that identifies the category for the source application descriptive flexfields. -
SrcAttribute10: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the first user descriptive flexfield. -
SrcAttribute11: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the second user descriptive flexfield. -
SrcAttribute12: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the third user descriptive flexfield. -
SrcAttribute13: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield. -
SrcAttribute14: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield. -
SrcAttribute15: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the sixth user descriptive flexfield. -
SrcAttribute16: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the seventh user descriptive flexfield. -
SrcAttribute17: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the eighth user descriptive flexfield. -
SrcAttribute18: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the ninth user descriptive flexfield. -
SrcAttribute19: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the tenth user descriptive flexfield. -
SrcAttribute2: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the eleventh user descriptive flexfield. -
SrcAttribute20: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the twelfth user descriptive flexfield. -
SrcAttribute3: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the thirteenth user descriptive flexfield. -
SrcAttribute4: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the fourteenth user descriptive flexfield. -
SrcAttribute5: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the fifteenth user descriptive flexfield. -
SrcAttribute6: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the sixteenth user descriptive flexfield. -
SrcAttribute7: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the seventeenth user descriptive flexfield. -
SrcAttribute8: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the eighteenth user descriptive flexfield. -
SrcAttribute9: string
Maximum Length:
150
Value that indicates the source application descriptive flexfield segment of the nineteenth user descriptive flexfield. -
SrcAttributeCategory: string
Maximum Length:
30
Value that indicates the source application descriptive flexfield segment of the twentieth user descriptive flexfield. -
SrcAttributeDate1: string
(date)
Number that indicates the source application descriptive flexfield segment of the first user descriptive flexfield.
-
SrcAttributeDate2: string
(date)
Number that indicates the source application descriptive flexfield segment of the second user descriptive flexfield.
-
SrcAttributeDate3: string
(date)
Number that indicates the source application descriptive flexfield segment of the third user descriptive flexfield.
-
SrcAttributeDate4: string
(date)
Number that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield.
-
SrcAttributeDate5: string
(date)
Number that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield.
-
SrcAttributeNumber1: number
Number that indicates the source application descriptive flexfield segment of the sixth user descriptive flexfield.
-
SrcAttributeNumber10: number
Number that indicates the source application descriptive flexfield segment of the seventh user descriptive flexfield.
-
SrcAttributeNumber2: number
Number that indicates the source application descriptive flexfield segment of the eighth user descriptive flexfield.
-
SrcAttributeNumber3: number
Number that indicates the source application descriptive flexfield segment of the ninth user descriptive flexfield.
-
SrcAttributeNumber4: number
Number that indicates the source application descriptive flexfield segment of the tenth user descriptive flexfield.
-
SrcAttributeNumber5: number
Date that indicates the source application descriptive flexfield segment of the first user descriptive flexfield.
-
SrcAttributeNumber6: number
Date that indicates the source application descriptive flexfield segment of the second user descriptive flexfield.
-
SrcAttributeNumber7: number
Date that indicates the source application descriptive flexfield segment of the third user descriptive flexfield.
-
SrcAttributeNumber8: number
Date that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield.
-
SrcAttributeNumber9: number
Date that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield.
-
SrcAttributeTimestamp1: string
(date-time)
Date and time that indicates the source application descriptive flexfield segment of the first user descriptive flexfield.
-
SrcAttributeTimestamp2: string
(date-time)
Date and time that indicates the source application descriptive flexfield segment of the second user descriptive flexfield.
-
SrcAttributeTimestamp3: string
(date-time)
Date and time that indicates the source application descriptive flexfield segment of the third user descriptive flexfield.
-
SrcAttributeTimestamp4: string
(date-time)
Date and time that indicates the source application descriptive flexfield segment of the fourth user descriptive flexfield.
-
SrcAttributeTimestamp5: string
(date-time)
Date and time that indicates the source application descriptive flexfield segment of the fifth user descriptive flexfield.
-
Subinventory: string
Maximum Length:
10
Subinventory to use for shipping material to fulfill the line. -
TaxationCountry: string
Maximum Length:
80
Country where the transaction occurs. The tax authority uses this attribute for taxation purposes. -
TaxClassificationCode: string
Maximum Length:
50
Abbreviation that identifies a group of taxes for reporting and processing. The tax authority uses this attribute for taxation purposes. -
TaxExemptionCertificateNumber: string
Maximum Length:
80
Number that identifies the certificate for tax exemption. The tax authority uses this attribute for taxation purposes. -
TaxExemptionReasonCode: string
Maximum Length:
30
Abbreviation 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:
150
Number of the tax invoice that you use to meet tax reporting that different countries require. -
ThirdPartyTaxRegistrationNumber: string
Maximum Length:
30
Number that identifies tax registration for the third party of the transaction. The tax authority uses this attribute for taxation purposes. -
TrackingNumber: string
Maximum Length:
30
Number that uniquely identifies the tracking for the shipment during transportation. The carrier provides this number. -
TransactionBusinessCategory: string
Maximum Length:
240
Name 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:
30
Abbreviation that identifies the classification for each tax requirement that you cannot define using the fiscal classification types that already exist. -
Volume: number
Volume of the material for the shipment line.
-
wshInvStripingDFF: array
Flexfields for Inventory Striping Attributes
Title:
Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages the details of the inventory striping attributes for shipment lines. The inventory striping attributes are a set of named attributes (project, task, and country of origin). This resource is associated with a feature that requires opt in.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource manages details about shipment line attachments.
Show Source
Nested Schema : Flexfields for Shipment Lines
Type:
array
Title:
Flexfields for Shipment Lines
The Flexfields for Shipment Lines resource manages flexfield details about shipment lines.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The Notes resource manages details about shipment line notes.
Show Source
Nested Schema : Serials
Type:
array
Title:
Serials
The Serials resource manages details about serial numbers for items in shipment lines.
Show Source
Nested Schema : Flexfields for Inventory Striping Attributes
Type:
array
Title:
Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages the details of the inventory striping attributes for shipment lines. The inventory striping attributes are a set of named attributes (project, task, and country of origin). This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentLineChangeRequests-shipmentLines-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the document. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON formatted string containing information required to retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents in the attachment expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) that locates the attachment. This attribute contains a value only if the attachment type is a URL. This is the reference to the file uploaded in the Oracle WebCenter Content server. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the user most recently updated the attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application that is identified by the MODULE_ID. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. This attribute contains a value only if the attachment type is a URL. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLineChangeRequests-shipmentLines-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for shipment lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for shipment lines. -
DeliveryDetailInterfaceId: integer
(int64)
Value that uniquely identifies the interface entry for the shipment line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLineChangeRequests-shipmentLines-notes-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
Value that uniquely identifies the relationship. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
Abbreviation that identifies the corporate currency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the note. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the note. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Value that uniquely identifies the person who created the note. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
Type of currency conversion rate. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Abbreviation that identifies the currency. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Contains one of the following values: true or false. If true, then the user can delete the note. If false, then the user cannot delete the note. The default value is false. -
EmailAddress: string
Read Only:
true
Maximum Length:320
Email address of the user who created the note. -
FormattedAddress: string
Read Only:
true
Address of the user who created the note. -
FormattedPhoneNumber: string
Read Only:
true
Phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the user most recently updated the note. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the note. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Login that the user used when updating the note. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
Value that uniquely identifies the note. -
NoteNumber: string
Maximum Length:
30
Number that identifies the note. This value is application generated or can come from an external application (user key). -
NoteTitle: string
Title:
Title
Maximum Length:500
Title of the note provided by the user. -
NoteTxt: string
(byte)
Title:
Note
Text of the actual note. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
Abbreviation that identifies the category of the note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
Value that uniquely identifies the parent of the note. -
PartyId: integer
(int64)
Read Only:
true
Value that uniquely identifies the party for the note. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
Name of the user who created the record. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
Abbreviation that identifies the object that the OBJECTS metadata defines for the note. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
Value that uniquely identifies the object that the OBJECTS metadata defines for the note. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Contains one of the following values: true or false. If true, then the user can update the note. If false, then the user cannot update the note. The default value is false. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
Abbreviation that identifies the visibility level of the note.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLineChangeRequests-shipmentLines-serials-item-response
Type:
Show Source
object
-
attributeDFF: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages details about serial attributes for the serial numbers. -
FromSerialNumber: string
Maximum Length:
80
Starting serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
standardDFF: array
Flexfields for Serials
Title:
Flexfields for Serials
The Flexfields for Serials resource manages details about serial numbers. -
ToSerialNumber: string
Maximum Length:
80
Ending serial number in a range of serial numbers. The application uses this attribute when the warehouse places the item under serial control.
Nested Schema : Flexfields for Serial Attributes
Type:
array
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages details about serial attributes for the serial numbers.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Serials
Type:
array
Title:
Flexfields for Serials
The Flexfields for Serials resource manages details about serial numbers.
Show Source
Nested Schema : shipmentLineChangeRequests-shipmentLines-serials-attributeDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serial attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield number of segments for serial attributes. -
FromSerialNumber: string
Maximum Length:
80
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLineChangeRequests-shipmentLines-serials-standardDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serial standards. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield number of segments for serial standards. -
FromSerialNumber: string
Maximum Length:
80
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shipmentLineChangeRequests-shipmentLines-wshInvStripingDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:40
Descriptive flexfield context name of the inventory striping attributes for shipment lines. This attribute is associated with a feature that requires opt in. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value of the inventory striping attributes for shipment lines. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode: string
Title:
Country of Origin
Maximum Length:2
Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name of the country of origin. This attribute is associated with a feature that requires opt in. -
DeliveryDetailInterfaceId: integer
(int64)
Value that uniquely identifies the shipment line. This attribute is associated with a feature that requires opt in.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the inventory attribute project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
Project
Number that identifies the inventory attribute project. This attribute is associated with a feature that requires opt in. -
taskId: integer
(int64)
Title:
Task
Value that uniquely identifies the inventory attribute task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
Task
Number that identifies the inventory attribute task. This attribute is associated with a feature that requires opt in.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- assign
-
Adds the shipment lines or packing units in a shipment. Optionally, a shipment line or packing unit assigned to another shipment can be added by unassigning it from the current shipment and adding it to the specified shipment.
- autoCreate
-
Creates shipments for the shipment lines or packing units.
- autoPack
-
Packs the shipment lines and packing unit based on the default packing configuration.
- backorderLine
-
Backorders a shipment line according to the shipment line number. The input parameters can include the quantity to be backordered.
- checkTradeCompliance
-
Operation: /fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/action/checkTradeComplianceSends the shipment lines or packing units to the trade management system for trade compliance screening.
- confirm
-
Ship confirms the quick-ship eligible shipment lines for an organization that's enabled for quick ship.
- cycleCount
-
Transfers the shipment line to cycle counting.
- generateShipmentRequest
-
Operation: /fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/action/generateShipmentRequestSelects and sends shipment lines to external applications such as a warehouse management system and also indicates the lines as interfaced. The shipment lines are selected using input parameters, assigned to a picking batch, and their integration status is set to interfaced. The input parameters can be an existing picking batch name, an organization code, or a pick wave release rule.
- pack
-
Packs the shipment lines or packing units into a packing unit.
- pickRelease
-
Pick releases the shipment lines or packing units by submitting Release Pick Wave scheduled process.
- resetIntegrationStatus
-
Operation: /fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/action/resetIntegrationStatusReset the integration status of the shipment lines that are interfaced with the external execution system.
- resetQuickshipStatus
-
Operation: /fscmRestApi/resources/11.13.18.05/shipmentLineChangeRequests/action/resetQuickshipStatusClears the quick ship status for the selected shipment lines.
- resetWeightVolume
-
Resets the weight and volume to default value on the shipment lines and packing units.
- split
-
Splits a shipment line. When splitting a shipment line, a new line is created for the specified quantity by copying the existing line, and the quantity in the original line is reduced.
- stage
-
Stages the quick-ship eligible shipment lines for an organization that's enabled for quick ship.
- unassign
-
Unassigns the shipment lines or packing units from a shipment. Optionally, you can reassign the shipment lines or packing numbers from a shipment to a different shipment in a single step.
- unpack
-
Unpacks shipment lines or packing units from their parent unit.