1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. SCM Common
  4. Carriers

Get all carriers

get

/fscmRestApi/resources/11.13.18.05/carriers

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:

    • CarrierFinder: Find carriers according to the bind variables that you provide.
      Finder Variables:
      • ActiveFlag; string; Contains one of the following values: true or false. If true, then the carrier is active. If false, then the carrier is not active.
      • CarrierId; integer; Number that identifies the carrier. This attribute is required.
      • CarrierName; string; Name of the carrier. This attribute is required.
      • ManifestingEnabledFlag; string; Contains one of the following values: true or false. If true, then use a manifest with this carrier. If false, then do not use a manifest with this carrier.
    • PrimaryKey: Find carrier according to the carrier identifier as the primary key.
      Finder Variables:
      • CarrierId; integer; Value that uniquely identifies the carrier. This attribute is required.
  • 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:
    • ActiveFlag; boolean; Contains one of the following values: true or false. If true, then the carrier is active. If false, then the carrier is not active. The default value is true.
    • CarrierId; integer; The value that uniquely identifies the carrier. It is a primary key that the application generates when it creates a carrier.
    • CarrierName; string; The name of the carrier. It is a unique value. This attribute is required.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the user created the record.
    • LastUpdateDate; string; Date and time when the user most recently updated the record.
    • LastUpdatedBy; string; User who most recently updated the record.
    • ManifestingEnabledFlag; boolean; Contains one of the following values: true or false. If true, then use a manifest with this carrier. If false, then do not use a manifest with this carrier. The default value is false.
  • 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 : carriers
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : carriers-item-response
Type: object
Show Source
Nested Schema : Contacts
Type: array
Title: Contacts
The Contacts resource manages the contact information for a carrier.
Show Source
Nested Schema : Flexfields for Carriers
Type: array
Title: Flexfields for Carriers
The Flexfields for Carriers resource manages the descriptive flexfields for the carrier.
Show Source
Nested Schema : Inbound Tracking Rules
Type: array
Title: Inbound Tracking Rules
The Inbound Tracking Rules resource manages the web service which allows a shipment to be tracked when the carrier is used.
Show Source
Nested Schema : Shipping Methods
Type: array
Title: Shipping Methods
The Shipping Methods resource manages the service level and method of transport that form a shipping method for a carrier.
Show Source
Nested Schema : carriers-contacts-item-response
Type: object
Show Source
Nested Schema : carriers-DFF-item-response
Type: object
Show Source
Nested Schema : carriers-inboundTrackingRules-item-response
Type: object
Show Source
  • Title: Active
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the tracking rule is active. If false, then the tracking rule is not active. The default value is true.
  • Title: Base URL
    Maximum Length: 200
    The URL (Uniform Resource Locator) that the carrier publishes to allow the tracking of shipments being delivered by the carrier. This attribute is required.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the user created the record.
  • Read Only: true
    Date and time when the user most recently updated the record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Inbound Tracking Rule Organization Associations
    Title: Inbound Tracking Rule Organization Associations
    The Inbound Tracking Rule Organization Associations resource manages the inventory organizations that may use the inbound tracking rule.
  • Inbound Tracking Rule Parameters
    Title: Inbound Tracking Rule Parameters
    The Inbound Tracking Rule Parameters resource manages the unique parameter information required by the web service to track a shipment.
  • Read Only: true
    Maximum Length: 80
    The meaning of the request method that the URL (Uniform Resource Locator) requires when a request for tracking details is sent to it. For example, G for Get and P for Post. A list of accepted values is defined in the lookup type WSH_TRACKING_METHODS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
  • Title: Request Method
    Maximum Length: 1
    The request method that the URL (Uniform Resource Locator) requires when a request for tracking details is sent to it. For example, G for Get, and P for Post. This attribute is required. A list of accepted values is defined in the lookup type WSH_TRACKING_METHODS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
  • Read Only: true
    The value that uniquely identifies the tracking rule for a carrier. It is a value that the application generates when it creates a tracking rule.
  • Title: Name
    Maximum Length: 200
    The name of the tracking rule. This attribute is required.
Nested Schema : Inbound Tracking Rule Organization Associations
Type: array
Title: Inbound Tracking Rule Organization Associations
The Inbound Tracking Rule Organization Associations resource manages the inventory organizations that may use the inbound tracking rule.
Show Source
Nested Schema : Inbound Tracking Rule Parameters
Type: array
Title: Inbound Tracking Rule Parameters
The Inbound Tracking Rule Parameters resource manages the unique parameter information required by the web service to track a shipment.
Show Source
Nested Schema : carriers-inboundTrackingRules-organizationAssociations-item-response
Type: object
Show Source
Nested Schema : carriers-inboundTrackingRules-parameters-item-response
Type: object
Show Source
  • Title: Constant Value
    Maximum Length: 50
    The value of the tracking rule parameter when the parameter has a constant value.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the user created the record.
  • Read Only: true
    Date and time when the user most recently updated the record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Read Only: true
    Maximum Length: 80
    The name of the attribute in the transaction that the URL (Uniform Resource Locator) requires when the parameter value is supplied by the transaction. For example, Tracking number. A list of accepted values is defined in the lookup type WSH_TRACKING_PARAMS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
  • Title: Lookup Parameter
    Maximum Length: 30
    The attribute in the transaction that the URL (Uniform Resource Locator) requires when the parameter value is supplied by the transaction. For example, Tracking number. A list of accepted values is defined in the lookup type WSH_TRACKING_PARAMS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
  • Read Only: true
    The value that uniquely identifies the parameter for the tracking rule for a carrier. It is a value that the application generates when it creates a tracking rule.
  • Title: Parameter Name
    Maximum Length: 30
    The name of the tracking rule parameter. Each parameter may have either a constant value or a value supplied from the transaction.
  • Title: Sequence
    The value that uniquely identifies the order of precedence for each parameter for the tracking rule for a carrier. This attribute is required.
Nested Schema : carriers-shippingMethods-item-response
Type: object
Show Source
  • 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 is not active. The default value is true.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the user created the record.
  • Flexfields for Shipping Methods
    Title: Flexfields for Shipping Methods
    The Flexfields for Shipping Methods resource manages the descriptive flexfields for the shipping method.
  • Read Only: true
    Date and time when the user most recently updated the record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Read Only: true
    Maximum Length: 80
    The value that describes the means used to deliver shipments to the customer. Valid values include Rail, Air, or Road. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
  • Maximum Length: 30
    The value that indicates the means used to deliver shipments to the customer. Valid values include Rail, Air, or Road. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
  • Shipping Method Organization Associations
    Title: Shipping Method Organization Associations
    The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.
  • Read Only: true
    The value that uniquely identifies the carrier shipping method. It is a value that the application generates when it creates a shipping method for a carrier.
  • Read Only: true
    Maximum Length: 80
    The value that indicates the priority of transportation that affects how quickly goods are transported. Valid values include Next day, Overnight, Express, or Door to Door. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
  • Maximum Length: 30
    The value that indicates the priority of transportation that affects how quickly goods are transported. Valid values include Next day, Overnight, Express, or Door to Door. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
  • Read Only: true
    Maximum Length: 30
    Default Value:
    The value that uniquely identifies the carrier shipping method, as a concatenation of carrier name, service level and mode of transport.
Nested Schema : Flexfields for Shipping Methods
Type: array
Title: Flexfields for Shipping Methods
The Flexfields for Shipping Methods resource manages the descriptive flexfields for the shipping method.
Show Source
Nested Schema : Shipping Method Organization Associations
Type: array
Title: Shipping Method Organization Associations
The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.
Show Source
Nested Schema : carriers-shippingMethods-DFF-item-response
Type: object
Show Source
Nested Schema : carriers-shippingMethods-organizationAssociations-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all carriers.

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

Example Response Body

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

{
  "items" : [ {
    "CarrierId" : 300100091459813,
    "CarrierName" : "1 day shipping",
    "ManifestingEnabledFlag" : null,
    "ActiveFlag" : true,
...
  }, {
...
  } ],
...
}
Back to Top