Jump to

• Request
• Response

Get one cost

get

/fscmRestApi/resources/11.13.18.05/shipments/{Shipment}/child/shippingCosts/{FreightCostId}

Request

Path Parameters

• FreightCostId(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=
• Shipment(required): string
  Name of the material shipment.

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

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.

Body ()

Root Schema : shipments-shippingCosts-item-response

Type: object

Show Source

• Amount: number
  Amount for the shipping cost for each unit.
• ConversionDate: string (date)
  Conversion date to use when converting the currency.
• ConversionRate: number
  Conversion rate to use when converting the currency.
• ConversionRateType: string
  Read Only: true

  Maximum Length: 30

  Type of currency conversion.
• ConversionRateTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of currency conversion.
• CreatedBy: string
  Maximum Length: 64

  User who created the shipping cost for the packing unit.
• CreationDate: string (date-time)
  Date when the shipping cost for the packing unit was created.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that identifies the currency that the packing unit cost uses.
• CurrencyName: string
  Read Only: true

  Maximum Length: 80

  Currency of the shipping cost.
• DeliveryDetailId: integer (int64)
  Value that uniquely identifies the shipment line.
• FreightCostId: integer (int64)
  Value that uniquely identifies the freight cost.
• LastUpdateDate: string (date-time)
  Date when the shipping cost for the packing unit was last updated.
• LastUpdatedBy: string
  Maximum Length: 64

  User who most recently updated the shipping cost for the packing unit.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LPNId: integer (int64)
  Value that uniquely identifies the container to use when packing the detail line.
• PackingUnit: string
  Read Only: true

  Maximum Length: 30

  Name of the container to use to pack the item.
• ShippingCost: string
  Read Only: true

  Maximum Length: 60

  Cost type that comes predefined in the application.
• shippingCostsDFF: array Flexfields for Shipping Costs
  Title: Flexfields for Shipping Costs

  The Flexfields for Shipping Costs resource manages details about the shipping costs.
• ShippingCostTypeCategory: string
  Read Only: true

  Maximum Length: 80

  Category of the 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 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 category of the shipping cost.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the shipping cost for the packing unit.",
            "nullable":false,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the shipping cost for the packing unit was created.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":false
        },
        "ShippingCostTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category of the shipping cost.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the shipping cost for the packing unit.",
            "nullable":false,
            "x-queryable":false
        },
        "shippingCostsDFF":{
            "title":"Flexfields for Shipping Costs",
            "type":"array",
            "description":"The Flexfields for Shipping Costs resource manages details about the shipping costs.",
            "items":{
                "$ref":"#/components/schemas/shipments-shippingCosts-shippingCostsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ShippingCostTypeCategory":{
            "maxLength":80,
            "type":"string",
            "description":"Category of the 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ShippingCostTypeCategoryCode"
                ]
            }
        },
        "DeliveryDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"Amount for the shipping cost for each unit.",
            "nullable":true,
            "x-queryable":true
        },
        "FreightCostId":{
            "type":"integer",
            "description":"Value that uniquely identifies the freight cost.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyName":{
            "maxLength":80,
            "type":"string",
            "description":"Currency of the shipping cost.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConversionRateType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of currency conversion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency that the packing unit cost uses.",
            "nullable":true,
            "x-queryable":true
        },
        "ConversionRateTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of currency conversion.",
            "nullable":true,
            "x-queryable":true
        },
        "LPNId":{
            "type":"integer",
            "description":"Value that uniquely identifies the container to use when packing the detail line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShippingCostTypeCategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the category of the shipping cost. A list of accepted values is defined in the lookup type WSH_FREIGHT_COST_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ConversionRate":{
            "type":"number",
            "description":"Conversion rate to use when converting the currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ShippingCost":{
            "maxLength":60,
            "type":"string",
            "description":"Cost type that comes predefined in the application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PackingUnit":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the container to use to pack the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConversionDate":{
            "type":"string",
            "description":"Conversion date to use when converting the currency.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the shipping cost for the packing unit was last updated.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Flexfields for Shipping Costs

Type: array

Title: Flexfields for Shipping Costs

The Flexfields for Shipping Costs resource manages details about the shipping costs.

Show Source

• Array of: object shipments-shippingCosts-shippingCostsDFF-item-response

{
    "title":"Flexfields for Shipping Costs",
    "type":"array",
    "description":"The Flexfields for Shipping Costs resource manages details about the shipping costs.",
    "items":{
        "$ref":"#/components/schemas/shipments-shippingCosts-shippingCostsDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : shipments-shippingCosts-shippingCostsDFF-item-response

Type: object

Show Source

• __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 freight cost.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FreightCostId":{
            "type":"integer",
            "description":"Value that uniquely identifies the freight cost.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Descriptive flexfield context display value for shipping costs.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for shipping costs.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

shippingCostsDFF

Operation: /fscmRestApi/resources/11.13.18.05/shipments/{Shipment}/child/shippingCosts/{FreightCostId}/child/shippingCostsDFF

Parameters:

• FreightCostId9: $request.path.FreightCostId9
• Shipment: $request.path.Shipment

The Flexfields for Shipping Costs resource manages details about the shipping costs.

Back to Top