1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Shipping Charge Lists

Get all shipping charge lists

get

/fscmRestApi/resources/11.13.18.05/shippingChargeLists

Request

Query Parameters
  • 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
  • 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 the shipping charge list based on the primary key.
      Finder Variables
      • ShippingChargeListId; integer; Unique identifier of the shipping charge list.
    • filterEffectiveShippingChargeLists Finds shipping charge lists based on business unit, currency code, and current date.
      Finder Variables
      • bindBuId; integer; Unique identifier of the business unit.
      • bindCurrencyCode; string; Currency code that identifies a shipping charge list.
      • bindCurrentDate; string; Current date to identify a shipping charge list.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BusinessUnit; string; Business unit associated with the shipping charge list.
    • BusinessUnitId; integer; Unique identifier of the business unit.
    • CreatedBy; string; User who created the shipping charge list.
    • CreationDate; string; Date when the shipping charge list was created.
    • Currency; string; Currency of the shipping charge list.
    • CurrencyCode; string; Currency code of the shipping charge list.
    • EndDate; string; End date of the shipping charge list.
    • LastUpdateDate; string; Date when the shipping charge list was last updated.
    • LastUpdatedBy; string; User who last updated the shipping charge list.
    • ShippingChargeListDescription; string; Description of the shipping charge list.
    • ShippingChargeListId; integer; Unique identifier of the shipping charge list.
    • ShippingChargeListName; string; Name of the shipping charge list.
    • StartDate; string; Start date of the shipping charge list.
    • Status; string; Status of the shipping charge list.
    • StatusCode; string; Status code of the shipping charge list.
  • 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
  • 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 : shippingChargeLists
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : shippingChargeLists-item-response
Type: object
Show Source
Nested Schema : Access Sets
Type: array
Title: Access Sets
Information about an access set for a shipping charge list.
Show Source
Nested Schema : Details
Type: array
Title: Details
Information about the details of the shipping charge list, which stores the items and shipping methods.
Show Source
Nested Schema : headerDFF
Type: array
Show Source
Nested Schema : Referenced Entities
Type: array
Title: Referenced Entities
A collection of entities that cost lists are referenced in. For example, a cost list is referenced in two entities: customer pricing and pricing strategy.
Show Source
Nested Schema : shippingChargeLists-accessSets-item-response
Type: object
Show Source
Nested Schema : shippingChargeLists-details-item-response
Type: object
Show Source
Nested Schema : Charges
Type: array
Title: Charges
Information about charges of the shipping charge list.
Show Source
Nested Schema : shippingChargeLists-details-charges-item-response
Type: object
Show Source
Nested Schema : chargesDFF
Type: array
Show Source
Nested Schema : Pricing Matrixes
Type: array
Title: Pricing Matrixes
A pricing matrix represents a way to manage price adjustments, discounts, rate tables, and other matrix features.
Show Source
Nested Schema : shippingChargeLists-details-charges-chargesDFF-item-response
Type: object
Show Source
Nested Schema : shippingChargeLists-details-charges-pricingMatrixes-item-response
Type: object
Show Source
Nested Schema : Matrix Dimensions
Type: array
Title: Matrix Dimensions
A matrix dimension is a condition with which you can drive price adjustments, discounts, and rate tables.
Show Source
Nested Schema : Matrix Rules
Type: array
Title: Matrix Rules
A matrix rule represents a condition based price adjustment, discount, rate table, and other features.
Show Source
Nested Schema : shippingChargeLists-details-charges-pricingMatrixes-dimensions-item-response
Type: object
Show Source
Nested Schema : shippingChargeLists-details-charges-pricingMatrixes-rules-item-response
Type: object
Show Source
Nested Schema : shippingChargeLists-headerDFF-item-response
Type: object
Show Source
Nested Schema : shippingChargeLists-referencedEntities-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all shipping charge lists.

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/shippingChargeLists/"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "details": [
        {
            "ShippingChargeListName": "BVTDiscName-1449140490211",
            "ShippingChargeListId": 300100073355000,
            "ShippingChargeListDescription": "BVTDiscName-1449140490211",
            "PriceType": "One time",
            "PriceTypeCode": "ONE_TIME",
            "PricePeriodicity": null,
            "PricePeriodicityCode": null,
            "ChargeType": "Sale",
            "ChargeTypeCode": "ORA_SALE",
            "ChargeSubtype": "Price",
            "ChargeSubtypeCode": "ORA_PRICE",
            "LineType": "Buy",
            "LineTypeCode": "ORA_BUY",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "Currency": "US Dollar",
            "CurrencyCode": "USD",
            "Status": "Approved",
            "StatusCode": "APPROVED",
            "StartDate": "2015-12-03T03:01:00+00:00",
            "EndDate": "2015-12-03T03:01:00+00:00",
            "CreationDate": "2015-12-03T11:01:40+00:00",
            "CreatedBy": "PRICING_MGR_OPERATIONS",
            "LastUpdateDate": "2015-12-03T11:07:46.691+00:00",
            "LastUpdatedBy": "PRICING_MGR_OPERATIONS"
        },
        {
            "ShippingChargeListName": "BVT-DiscList_1450105552823",
            "ShippingChargeListId": 300100088688636,
            "ShippingChargeListDescription": "BVT-DiscList_1450105552823",
            "PriceType": "One time",
            "PriceTypeCode": "ONE_TIME",
            "PricePeriodicity": null,
            "PricePeriodicityCode": null,
            "ChargeType": "Service",
            "ChargeTypeCode": "ORA_SERVICE",
            "ChargeSubtype": "Price",
            "ChargeSubtypeCode": "ORA_PRICE",
            "LineType": "Buy",
            "LineTypeCode": "ORA_BUY",
            "BusinessUnit": "Vision Operations",
            "BusinessUnitId": 204,
            "Currency": "US Dollar",
            "CurrencyCode": "USD",
            "Status": "Approved",
            "StatusCode": "APPROVED",
            "StartDate": "2015-12-14T07:07:00+00:00",
            "EndDate": "2015-12-14T07:07:00+00:00",
            "CreationDate": "2015-12-14T15:07:11+00:00",
            "CreatedBy": "PRICING_MGR_OPERATIONS",
            "LastUpdateDate": "2015-12-14T15:17:07.722+00:00",
            "LastUpdatedBy": "PRICING_MGR_OPERATIONS"
        }
 ]
}
Back to Top