1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Shipping Methods List of Values

Get one shipping method

get

/fscmRestApi/resources/11.13.18.05/shippingShipMethodsLOV/{shippingShipMethodsLOVUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- CarrierId, ServiceLevelCode and ModeOfTransportCode ---for the Shipping Methods List of Values resource and used to uniquely identify an instance of Shipping Methods List of Values. The client should not generate the hash key value. Instead, the client should query on the Shipping Methods List of Values collection resource with a filter on the primary key values in order to navigate to a specific instance of Shipping Methods List of Values.

    For example: shippingShipMethodsLOV?q=CarrierId=<value1>;ServiceLevelCode=<value2>;ModeOfTransportCode=<value3>
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : shippingShipMethodsLOV-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 360
    Name of the party that transports the shipment.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the carrier is active. If false, then the carrier isn't active. The default value is true.
  • Read Only: true
    Value that uniquely identifies the carrier.
  • Links
  • Read Only: true
    Maximum Length: 80
    Mode of transportation that ships goods. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the mode of transport for the shipping method. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT.
  • Read Only: true
    Value that uniquely identifies the inventory organization.
  • Read Only: true
    Maximum Length: 80
    Transportation priority that determines how quickly to transport goods. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the service level for the shipping method. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS.
  • Read Only: true
    Maximum Length: 522
    Transportation method for the shipment.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the transportation method for the shipment.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the shipping method is active. If false, then the shipping method isn't active. The default value is true.
Back to Top

Examples

This example describes how to get one shipping method.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/shippingShipMethodsLOV?onlyData=true&q=CarrierId=value;ServiceLevelCode=value;ModeOfTransportCode=value"

For example, the following command gets the shipping method for a carrier, service level, and mode of transportation combination.

curl -u username:password "https://servername/fscmRestApi/resources/version/shippingShipMethodsLOV?onlyData=true&q=CarrierId=12521;ServiceLevelCode=2DA;ModeOfTransportCode=AIR"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items": [
        {
            "ShippingMethod": "DHL Air 2nd day air",
            "ShippingMethodCode": "000001_DHL_A_2DA",
            "Carrier": "DHL",
            "CarrierId": 12521,
            "ServiceLevel": "2nd day air",
            "ServiceLevelCode": "2DA",
            "ModeOfTransport": "Air",
            "ModeOfTransportCode": "AIR",
            "OrganizationId": 204,
            "ShippingMethodEnabledFlag": true,
            "CarrierEnabledFlag": true
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/shippingShipMethodsLOV",
            "name": "shippingShipMethodsLOV",
            "kind": "collection"
        }
    ]
}
Back to Top