Get all costs
get
/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)
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.
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds costs according to the primary key criteria.
Finder Variables:- FreightCostInterfaceId; integer; Value that uniquely identifies the candidate shipping cost.
- PrimaryKey: Finds costs according to the primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-costs
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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:
30
Abbreviation that identifies the type of currency conversion. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the candidate shipping cost. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the candidate shipping cost. -
Currency: string
Maximum Length:
15
Abbreviation that identifies the currency of the shipping cost. -
DFF: array
Flexfields for Costs
Title:
Flexfields for Costs
The Flexfields for Costs resource manages details about shipping costs. -
errors: array
Errors for Costs
Title:
Errors for Costs
The Errors for Costs resource manages errors that occur when processing a shipping cost. -
FreightCostInterfaceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the candidate shipping cost. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the candidate shipping cost. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the candidate shipping cost. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Maximum Length:
2000
Concatenated name of the inventory locator that provides the source for material that ships. -
ShippingCostType: string
Maximum Length:
60
Type of cost that is predefined in the application. -
Subinventory: string
Maximum Length:
10
Subinventory to use when fulfilling the item to be shipped. -
wshFreightCostsInvDFF: array
Flexfields for Inventory Striping Attributes
Title:
Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages details about inventory striping attributes for shipping costs. This resource is associated with a feature that requires opt in.
Nested Schema : Flexfields for Costs
Type:
array
Title:
Flexfields for Costs
The Flexfields for Costs resource manages details about shipping costs.
Show Source
Nested Schema : Errors for Costs
Type:
array
Title:
Errors for Costs
The Errors for Costs resource manages errors that occur when processing a shipping cost.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Inventory Striping Attributes
Type:
array
Title:
Flexfields for Inventory Striping Attributes
The Flexfields for Inventory Striping Attributes resource manages details about inventory striping attributes for shipping costs. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-costs-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value. -
FreightCostInterfaceId: integer
(int64)
Value that uniquely identifies the candidate shipping cost.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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 : shipmentTransactionRequests-shipments-outerPackingUnits-innerPackingUnits-costs-errors-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who received the error. -
CreationDate: string
(date-time)
Read Only:
true
Date when the error was generated. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the error was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the error. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageName: string
Maximum Length:
30
Name of the error message. -
MessageText: string
Maximum Length:
4000
Text of the error message.
Nested Schema : Links
Type:
array
Title:
Links
The 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 Segment
Maximum Length:40
Descriptive 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 Segment
Descriptive 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 Origin
Maximum Length:2
Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name of the country of origin. This attribute is associated with a feature that requires opt in. -
FreightCostInterfaceId: integer
(int64)
Value that uniquely identifies the candidate shipping cost. This attribute is associated with a feature that requires opt in.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the inventory attribute project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
Project
Number that identifies the inventory attribute project. This attribute is associated with a feature that requires opt in. -
taskId: integer
(int64)
Title:
Task
Value that uniquely identifies the inventory attribute task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
Task
Number that identifies the inventory attribute task. This attribute is associated with a feature that requires opt in.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source