Get one serial
get
/fscmRestApi/resources/11.13.18.05/shipmentTransactionRequests/{TransactionId}/child/shipments/{DeliveryInterfaceId}/child/outerPackingUnits/{LPNInterfaceId}/child/innerPackingUnits/{LPNInterfaceId3}/child/packedLines/{DeliveryDetailInterfaceId4}/child/lots/{lotsUniqID2}/child/serials/{serialsUniqID}
Request
Path Parameters
-
DeliveryDetailInterfaceId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
DeliveryInterfaceId(required): integer(int64)
Value that uniquely identifies the candidate shipment.
-
LPNInterfaceId(required): integer(int64)
Value that uniquely identifies the candidate packing unit.
-
LPNInterfaceId3(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
TransactionId(required): integer(int64)
Value that uniquely identifies the shipment transaction request.
-
lotsUniqID(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
serialsUniqID(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context: 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.
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 : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-lots-serials-item-response
Type:
Show Source
object-
attributeDFF: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial AttributesThe Flexfields for Serial Attributes resource manages details about serial attributes. -
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 for Serials
Title:
Errors for SerialsThe Errors for Serials resource manages errors that occur when processing serial numbers. -
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
Flexfields for Serials
Title:
Flexfields for SerialsThe Flexfields for Serials resource manages details about serial numbers. -
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
Flexfields for Inventory Striping Attributes
Title:
Flexfields for Inventory Striping AttributesThe Flexfields for Inventory Striping Attributes resource manages details about inventory striping attributes for serial controlled items. This resource is associated with a feature that requires opt in.
Nested Schema : Flexfields for Serial Attributes
Type:
arrayTitle:
Flexfields for Serial AttributesThe Flexfields for Serial Attributes resource manages details about serial attributes.
Show Source
Nested Schema : Errors for Serials
Type:
arrayTitle:
Errors for SerialsThe Errors for Serials resource manages errors that occur when processing serial numbers.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Serials
Type:
arrayTitle:
Flexfields for SerialsThe Flexfields for Serials resource manages details about serial numbers.
Show Source
Nested Schema : Flexfields for Inventory Striping Attributes
Type:
arrayTitle:
Flexfields for Inventory Striping AttributesThe Flexfields for Inventory Striping Attributes resource manages details about inventory striping attributes for serial controlled items. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-lots-serials-attributeDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for serial attributes. -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-lots-serials-errors-item-response
Type:
Show Source
object-
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.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-lots-serials-standardDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial standards. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for serial standards. -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-lots-serials-wshSerialInvDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Descriptive flexfield context name of the inventory striping attributes for shipment lines. This attribute is associated with a feature that requires opt in. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value of the inventory striping attributes for shipment lines. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of OriginName of the country of origin. This attribute is associated with a feature that requires opt in. -
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. This attribute is associated with a feature that requires opt in. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectValue that uniquely identifies the inventory attribute project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
ProjectNumber that identifies the inventory attribute project. This attribute is associated with a feature that requires opt in. -
taskId: integer
(int64)
Title:
TaskValue that uniquely identifies the inventory attribute task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
TaskNumber that identifies the inventory attribute task. This attribute is associated with a feature that requires opt in. -
TransactionInterfaceId: integer
(int64)
Value that uniquely identifies the interfaced shipment transaction. This attribute is associated with a feature that requires opt in.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- attributeDFF
-
Parameters:
- DeliveryDetailInterfaceId4:
$request.path.DeliveryDetailInterfaceId4 - DeliveryInterfaceId:
$request.path.DeliveryInterfaceId - LPNInterfaceId:
$request.path.LPNInterfaceId - LPNInterfaceId3:
$request.path.LPNInterfaceId3 - TransactionId:
$request.path.TransactionId - lotsUniqID2:
$request.path.lotsUniqID2 - serialsUniqID3:
$request.path.serialsUniqID3
The Flexfields for Serial Attributes resource manages details about serial attributes. - DeliveryDetailInterfaceId4:
- errors
-
Parameters:
- DeliveryDetailInterfaceId4:
$request.path.DeliveryDetailInterfaceId4 - DeliveryInterfaceId:
$request.path.DeliveryInterfaceId - LPNInterfaceId:
$request.path.LPNInterfaceId - LPNInterfaceId3:
$request.path.LPNInterfaceId3 - TransactionId:
$request.path.TransactionId - lotsUniqID2:
$request.path.lotsUniqID2 - serialsUniqID3:
$request.path.serialsUniqID3
The Errors for Serials resource manages errors that occur when processing serial numbers. - DeliveryDetailInterfaceId4:
- standardDFF
-
Parameters:
- DeliveryDetailInterfaceId4:
$request.path.DeliveryDetailInterfaceId4 - DeliveryInterfaceId:
$request.path.DeliveryInterfaceId - LPNInterfaceId:
$request.path.LPNInterfaceId - LPNInterfaceId3:
$request.path.LPNInterfaceId3 - TransactionId:
$request.path.TransactionId - lotsUniqID2:
$request.path.lotsUniqID2 - serialsUniqID3:
$request.path.serialsUniqID3
The Flexfields for Serials resource manages details about serial numbers. - DeliveryDetailInterfaceId4:
- wshSerialInvDFF
-
Parameters:
- DeliveryDetailInterfaceId4:
$request.path.DeliveryDetailInterfaceId4 - DeliveryInterfaceId:
$request.path.DeliveryInterfaceId - LPNInterfaceId:
$request.path.LPNInterfaceId - LPNInterfaceId3:
$request.path.LPNInterfaceId3 - TransactionId:
$request.path.TransactionId - lotsUniqID2:
$request.path.lotsUniqID2 - serialsUniqID3:
$request.path.serialsUniqID3
The Flexfields for Inventory Striping Attributes resource manages details about inventory striping attributes for serial controlled items. This resource is associated with a feature that requires opt in. - DeliveryDetailInterfaceId4: