Create one cost
post
/fscmRestApi/resources/11.13.18.05/shipmentTransactionRequests/{TransactionId}/child/shipments/{DeliveryInterfaceId}/child/outerPackingUnits/{LPNInterfaceId}/child/innerPackingUnits/{LPNInterfaceId3}/child/costs
Request
Path Parameters
-
DeliveryInterfaceId(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=
-
LPNInterfaceId(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=
-
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)
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=
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.
-
Upsert-Mode: string
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-
Amount: number
Amount for the shipping cost for each unit.
-
ConversionDate: string
(date)
Date when the currency conversion occurred.
-
ConversionRate: number
Rate of the currency conversion.
-
ConversionRateTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of currency conversion. -
Currency: string
Maximum Length:
15Abbreviation that identifies the currency of the shipping cost. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
Locator: string
Maximum Length:
2000Concatenated name of the inventory locator that provides the source for material that ships. -
ShippingCostType: string
Maximum Length:
60Type of cost that's predefined in the application. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshFreightCostsInvDFF: array
wshFreightCostsInvDFF
Nested Schema : Errors
Type:
arrayTitle:
ErrorsThe Errors resource manages errors that occur when processing a transaction request.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-costs-DFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FreightCostInterfaceId: integer
(int64)
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-costs-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-costs-wshFreightCostsInvDFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FreightCostInterfaceId: integer
(int64)
-
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
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-costs-item-response
Type:
Show Source
object-
Amount: number
Amount for the shipping cost for each unit.
-
ConversionDate: string
(date)
Date when the currency conversion occurred.
-
ConversionRate: number
Rate of the currency conversion.
-
ConversionRateTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of currency conversion. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the candidate shipping cost. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the candidate shipping cost. -
Currency: string
Maximum Length:
15Abbreviation that identifies the currency of the shipping cost. -
DFF: array
DFF
-
errors: array
Errors
Title:
ErrorsThe Errors resource manages errors that occur when processing a transaction request. -
FreightCostInterfaceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the candidate shipping cost. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the candidate shipping cost. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the candidate shipping cost. -
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. -
ShippingCostType: string
Maximum Length:
60Type of cost that's predefined in the application. -
Subinventory: string
Maximum Length:
10Subinventory to use when fulfilling the item to be shipped. -
wshFreightCostsInvDFF: array
wshFreightCostsInvDFF
Nested Schema : Errors
Type:
arrayTitle:
ErrorsThe Errors resource manages errors that occur when processing a transaction request.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-costs-DFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
FreightCostInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
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-costs-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-costs-wshFreightCostsInvDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
FreightCostInterfaceId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- DFF
-
Parameters:
- DeliveryInterfaceId:
$request.path.DeliveryInterfaceId - FreightCostInterfaceId7:
$request.path.FreightCostInterfaceId7 - LPNInterfaceId:
$request.path.LPNInterfaceId - LPNInterfaceId3:
$request.path.LPNInterfaceId3 - TransactionId:
$request.path.TransactionId
- DeliveryInterfaceId:
- errors
-
Parameters:
- DeliveryInterfaceId:
$request.path.DeliveryInterfaceId - FreightCostInterfaceId7:
$request.path.FreightCostInterfaceId7 - LPNInterfaceId:
$request.path.LPNInterfaceId - LPNInterfaceId3:
$request.path.LPNInterfaceId3 - TransactionId:
$request.path.TransactionId
The Errors resource manages errors that occur when processing a transaction request. - DeliveryInterfaceId:
- wshFreightCostsInvDFF
-
Parameters:
- DeliveryInterfaceId:
$request.path.DeliveryInterfaceId - FreightCostInterfaceId7:
$request.path.FreightCostInterfaceId7 - LPNInterfaceId:
$request.path.LPNInterfaceId - LPNInterfaceId3:
$request.path.LPNInterfaceId3 - TransactionId:
$request.path.TransactionId
- DeliveryInterfaceId: