Create one shipping cost
post
/fscmRestApi/resources/11.13.18.05/shippingCosts
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
-
Amount: number
Amount for the shipping cost.
-
ConversionDate: string
(date)
Date when the currency was converted.
-
ConversionRate: number
Conversion rate to use for the currency conversion.
-
ConversionRateType: string
Maximum Length:
30
Type of currency conversion. -
ConversionRateTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of currency conversion. -
Currency: string
Maximum Length:
15
Abbreviation that identifies the currency for the amount of this shipping cost. -
CurrencyName: string
Maximum Length:
80
Name of the currency for the amount of this shipping cost. -
DFF: array
Flexfields
Title:
Flexfields
The Flexfields for Shipping Costs manages additional details about shipping costs. -
PackingUnit: string
Maximum Length:
30
Number that identifies the packing unit. -
PackingUnitId: integer
(int64)
Value that uniquely identifies the packing unit.
-
Shipment: string
Maximum Length:
30
Name of the material shipment. -
ShipmentId: integer
(int64)
Value that uniquely identifies the shipment.
-
ShipmentLine: integer
(int64)
Value that uniquely identifies the shipment line.
-
ShippingCostType: string
Maximum Length:
60
Name of the type of shipping cost. -
ShippingCostTypeId(required): integer
(int64)
Value that uniquely identifies the type of shipping cost.
Nested Schema : Flexfields
Type:
array
Title:
Flexfields
The Flexfields for Shipping Costs manages additional details about shipping costs.
Show Source
Nested Schema : shippingCosts-DFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for shipping costs. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for shipping costs. -
FreightCostId: integer
(int64)
Value that uniquely identifies the shipping cost.
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 : shippingCosts-item-response
Type:
Show Source
object
-
Amount: number
Amount for the shipping cost.
-
ConversionDate: string
(date)
Date when the currency was converted.
-
ConversionRate: number
Conversion rate to use for the currency conversion.
-
ConversionRateType: string
Maximum Length:
30
Type of 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 shipping cost. -
CreationDate: string
(date-time)
Read Only:
true
Date when the shipping cost was created. -
Currency: string
Maximum Length:
15
Abbreviation that identifies the currency for the amount of this shipping cost. -
CurrencyName: string
Maximum Length:
80
Name of the currency for the amount of this shipping cost. -
DFF: array
Flexfields
Title:
Flexfields
The Flexfields for Shipping Costs manages additional details about shipping costs. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the shipping cost was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the shipping cost. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the inventory organization. -
OrganizationId: integer
Read Only:
true
Value that uniquely identifies the inventory organization. -
OrganizationName: string
Read Only:
true
Maximum Length:240
Name of the inventory organization. -
PackingUnit: string
Maximum Length:
30
Number that identifies the packing unit. -
PackingUnitId: integer
(int64)
Value that uniquely identifies the packing unit.
-
Shipment: string
Maximum Length:
30
Name of the material shipment. -
ShipmentId: integer
(int64)
Value that uniquely identifies the shipment.
-
ShipmentLine: integer
(int64)
Value that uniquely identifies the shipment line.
-
ShippingCostId: integer
(int64)
Read Only:
true
Value that uniquely identifies the shipping cost. -
ShippingCostType: string
Maximum Length:
60
Name of the type of shipping cost. -
ShippingCostTypeCategory: string
Read Only:
true
Maximum Length:80
Category of the type of shipping cost that the application uses to group shipping costs according to similar characteristics. A list of accepted values is defined in the lookup type WSH_FREIGHT_COST_TYPE. -
ShippingCostTypeCategoryCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the category of the type of shipping cost. A list of accepted values is defined in the lookup type WSH_FREIGHT_COST_TYPE. -
ShippingCostTypeId: integer
(int64)
Value that uniquely identifies the type of shipping cost.
-
SourceOrder: string
Read Only:
true
Maximum Length:150
Number that identifies the source order header. -
SourceOrderFulfillmentLine: string
Read Only:
true
Maximum Length:150
Number that identifies the source order fulfillment line within the source order line. -
SourceOrderFulfillmentLineId: integer
Read Only:
true
Value that uniquely identifies the source order fulfillment line. -
SourceOrderLine: string
Read Only:
true
Maximum Length:150
Number that identifies the source order line within the source order header. -
SourceSystem: string
Read Only:
true
Maximum Length:80
Name of the source application. -
SourceSystemId: integer
Read Only:
true
Value that uniquely identifies the source application.
Nested Schema : Flexfields
Type:
array
Title:
Flexfields
The Flexfields for Shipping Costs manages additional details about shipping costs.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shippingCosts-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for shipping costs. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for shipping costs. -
FreightCostId: integer
(int64)
Value that uniquely identifies the 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.
Links
- DFF
-
Parameters:
- ShippingCostId:
$request.path.ShippingCostId
The Flexfields for Shipping Costs manages additional details about shipping costs. - ShippingCostId:
Examples
This example describes how to create one shipping cost.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/shippingCosts"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "ShippingCostTypeId": 96, "ConversionRateTypeCode": "Corporate", "Amount": 20.89, "Currency" : "USD", "ConversionRate": 3.3, "ConversionDate": "2018-07-13", "PackingUnitId": 6355, "DFF": [{ "_Global1": "zR13OTBI", "_Global2": "zR13OTBI2" }] }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ShippingCostId" : 300100169058692, "ShippingCostTypeId" : 96, "ShippingCostType" : "ASSISTED UNLOADING CHARGE", "ShippingCostTypeCategoryCode" : "FTECHARGE", "ShippingCostTypeCategory" : "Transportation charge", "Amount" : 20.89, "Currency" : "USD", "CurrencyName" : "US Dollar", "ConversionRateTypeCode" : "Corporate", "ConversionRateType" : "Corporate", "ConversionRate" : 3.3, "ConversionDate" : "2018-07-13", "CreatedBy" : "WHSE_MGR_M1", "CreationDate" : "2018-12-03T11:35:11+00:00", "LastUpdatedBy" : "WHSE_MGR_M1", "LastUpdateDate" : "2018-12-03T11:35:11.860+00:00", "ShipmentLine" : null, "ShipmentId" : null, "Shipment" : null, "PackingUnitId" : 6355, "PackingUnit" : "6316", "SourceSystemId" : null, "SourceSystem" : null, "SourceOrder" : null, "SourceOrderLine" : null, "SourceOrderFulfillmentLine" : null, "SourceOrderFulfillmentLineId" : null, "DFF" : [ { "FreightCostId" : 300100169058692, "_Global1" : "zR13OTBI", "_Global2" : "zR13OTBI2", "__FLEX_Context" : null, "__FLEX_Context_DisplayValue" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/shippingCosts/300100169058692/child/DFF/300100169058692", "name" : "DFF", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/shippingCosts/300100169058692/child/DFF/300100169058692", "name" : "DFF", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/shippingCosts/300100169058692", "name" : "shippingCosts", "kind" : "item" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/shippingCosts/300100169058692/child/DFF/300100169058692/lov/LVVO___FLEX_Context", "name" : "LVVO___FLEX_Context", "kind" : "collection" } ] } ], "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/shippingCosts/300100169058692", "name" : "shippingCosts", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/shippingCosts/300100169058692", "name" : "shippingCosts", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/shippingCosts/300100169058692/child/DFF", "name" : "DFF", "kind" : "collection" } ] }