Create one serial
post
/fscmRestApi/resources/11.13.18.05/shipmentTransactionRequests/{TransactionId}/child/shipments/{DeliveryInterfaceId}/child/outerPackingUnits/{LPNInterfaceId}/child/innerPackingUnits/{LPNInterfaceId3}/child/packedLines/{DeliveryDetailInterfaceId}/child/serials
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.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
errors: array
Errors for Serials
Title:
Errors for SerialsThe Errors for Serials resource manages errors that occur when processing serial numbers. -
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
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. -
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 : 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-serials-attributeDFF-item-post-request
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 -
TransactionInterfaceId: integer
(int64)
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-serials-errors-item-post-request
Type:
Show Source
object-
MessageName: string
Maximum Length:
30Name of the error message. -
MessageText: string
Maximum Length:
4000Text of the error message.
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-packedLines-serials-standardDFF-item-post-request
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 -
TransactionInterfaceId: integer
(int64)
Nested Schema : schema
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. -
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.
Response
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-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-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-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-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-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 - serialsUniqID4:
$request.path.serialsUniqID4
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 - serialsUniqID4:
$request.path.serialsUniqID4
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 - serialsUniqID4:
$request.path.serialsUniqID4
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 - serialsUniqID4:
$request.path.serialsUniqID4
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: