Get one serial
get
/fscmRestApi/resources/11.13.18.05/shipments/{Shipment}/child/outerPackingUnits/{LPNId}/child/shipmentLines/{ShipmentLine2}/child/shipmentLineSerials/{shipmentLineSerialsUniqID}
Request
Path Parameters
-
LPNId(required): integer(int64)
Value that uniquely identifies the container that the shipper uses to pack the item.
-
Shipment(required): string
Name of the material shipment.
-
ShipmentLine(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=
-
shipmentLineSerialsUniqID(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:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-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. -
DeliveryDetailId: number
Read Only:
true
Value that uniquely identifies the shipment line. -
FromSerialNumber: string
Read Only:
true
Maximum Length:255
Starting serial number in a range of serial numbers. This attribute is used when the warehouse places the item under serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
serialNumbers: array
Serial Numbers
Title:
Serial Numbers
The Serial Numbers resource manages details about individual serial numbers for the shipment lines. -
standardDFF: array
Flexfields for Serials
Title:
Flexfields for Serials
The Flexfields for Serials resource manages details about serial numbers. -
SupplierSerialNumber: string
Read Only:
true
Maximum Length:80
Serial number assigned to the item by the supplier. -
ToSerialNumber: string
Read Only:
true
Maximum Length:80
Ending serial number in a range of serial numbers. This attribute is used when the warehouse places the item under serial control. -
TransactionTempId: number
Read Only:
true
Value that uniquely identifies a row in the transaction table for temporary inventory. -
UniqueLineNumber: integer
(int64)
Value that creates a relationship between the serial number and the shipment line. If the line has shipped, then this attribute identifies the shipment line. If the line has not shipped, then this attribute identifies the transaction for a row in a temporary transaction table that references the serial number.
Nested Schema : Flexfields for Serial Attributes
Type:
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 : Serial Numbers
Type:
array
Title:
Serial Numbers
The Serial Numbers resource manages details about individual serial numbers for the shipment lines.
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 : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-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 context display value for serial attributes. -
FmSerialNumber: string
Maximum Length:
80
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionTempId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-serialNumbers-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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial Number
Read Only:true
Maximum Length:80
Serial number for the item. The application uses this attribute when the warehouse places the item under serial control. -
standardDFF: array
Flexfields for Serials
Title:
Flexfields for Serials
The Flexfields for Serials resource manages details about serial numbers.
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 : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-serialNumbers-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 context display value for serial attributes. -
CurrentOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number for the item. The application uses this attribute when the warehouse places the item under serial control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-serialNumbers-standardDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for standard attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for serial standards. -
CurrentOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number for the item. This attribute is used when the warehouse places the item under serial control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shipments-outerPackingUnits-shipmentLines-shipmentLineSerials-standardDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for standard attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for serial standards. -
FmSerialNumber: string
Maximum Length:
80
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionTempId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- attributeDFF
-
Parameters:
- LPNId:
$request.path.LPNId
- Shipment:
$request.path.Shipment
- ShipmentLine2:
$request.path.ShipmentLine2
- shipmentLineSerialsUniqID2:
$request.path.shipmentLineSerialsUniqID2
The Flexfields for Serial Attributes resource manages details about serial attributes for the serial numbers. - LPNId:
- serialNumbers
-
Parameters:
- LPNId:
$request.path.LPNId
- Shipment:
$request.path.Shipment
- ShipmentLine2:
$request.path.ShipmentLine2
- shipmentLineSerialsUniqID2:
$request.path.shipmentLineSerialsUniqID2
The Serial Numbers resource manages details about individual serial numbers for the shipment lines. - LPNId:
- standardDFF
-
Parameters:
- LPNId:
$request.path.LPNId
- Shipment:
$request.path.Shipment
- ShipmentLine2:
$request.path.ShipmentLine2
- shipmentLineSerialsUniqID2:
$request.path.shipmentLineSerialsUniqID2
The Flexfields for Serials resource manages details about serial numbers. - LPNId: