Create one packing unit
post
/fscmRestApi/resources/11.13.18.05/shipmentTransactionRequests/{TransactionId}/child/shipments/{DeliveryInterfaceId}/child/outerPackingUnits/{LPNInterfaceId}/child/innerPackingUnits/{LPNInterfaceId3}/child/innerPackingUnits
Request
Path Parameters
-
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
-
FOBCode: string
Maximum Length:
30
Abbreviation 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:
25
Unit of measure of the gross weight of the packing unit. -
GrossWeightUOMCode: string
Maximum Length:
3
Code that identifies the unit of measure of the gross weight of the packing unit. -
MasterSerialNumber: string
Maximum Length:
80
Master serial number that identifies the packing unit. -
PackingUnit: string
Maximum Length:
30
Name of the packing unit. -
PackingUnitType: string
Maximum Length:
300
Item defining characteristics of a packing unit. -
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. -
TareWeight: number
Weight of the container that contains the packing unit.
-
TareWeightUOM: string
Maximum Length:
25
Unit of measure that the tare weight uses for the packing unit. -
TareWeightUOMCode: string
Maximum Length:
3
Code that identifies the unit of measure that the tare weight uses for the packing unit. -
TrackingNumber: string
Maximum Length:
30
Tracking number of the packing unit. -
Volume: number
Volume of material that the packing unit can hold.
-
VolumeUOM: string
Maximum Length:
25
Unit of measure that the container volume uses for the packing unit. -
VolumeUOMCode: string
Maximum Length:
3
Code that identifies the unit of measure that the container volume uses for the packing unit.
Response
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 : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-innerPackingUnits-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the candidate packing unit. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the candidate packing unit. -
FOBCode: string
Maximum Length:
30
Abbreviation 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:
25
Unit of measure of the gross weight of the packing unit. -
GrossWeightUOMCode: string
Maximum Length:
3
Code that identifies the unit of measure of the gross weight of the packing unit. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the candidate packing unit. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the candidate packing unit. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LPNInterfaceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the candidate packing unit. -
MasterSerialNumber: string
Maximum Length:
80
Master serial number that identifies the packing unit. -
PackingUnit: string
Maximum Length:
30
Name of the packing unit. -
PackingUnitType: string
Maximum Length:
300
Item defining characteristics of a packing unit. -
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. -
TareWeight: number
Weight of the container that contains the packing unit.
-
TareWeightUOM: string
Maximum Length:
25
Unit of measure that the tare weight uses for the packing unit. -
TareWeightUOMCode: string
Maximum Length:
3
Code that identifies the unit of measure that the tare weight uses for the packing unit. -
TrackingNumber: string
Maximum Length:
30
Tracking number of the packing unit. -
Volume: number
Volume of material that the packing unit can hold.
-
VolumeUOM: string
Maximum Length:
25
Unit of measure that the container volume uses for the packing unit. -
VolumeUOMCode: string
Maximum Length:
3
Code that identifies the unit of measure that the container volume uses for the packing unit.
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.