Get one carrier
get
/fscmRestApi/resources/11.13.18.05/carriers/{CarrierId}
Request
Path Parameters
-
CarrierId(required): integer(int64)
The value that uniquely identifies the carrier. It is a primary key that the application generates when it creates a carrier.
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : carriers-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
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
(int64)
Read Only:
true
The value that uniquely identifies the carrier. It is a primary key that the application generates when it creates a carrier. -
CarrierName: string
Maximum Length:
360
The name of the carrier. It is a unique value. This attribute is required. -
contacts: array
Contacts
Title:
Contacts
The Contacts resource manages the contact information for a carrier. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
DFF: array
Flexfields for Carriers
Title:
Flexfields for Carriers
The Flexfields for Carriers resource manages the descriptive flexfields for the carrier. -
inboundTrackingRules: array
Inbound Tracking Rules
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. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManifestingEnabledFlag: boolean
Maximum Length:
1
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. -
shippingMethods: array
Shipping Methods
Title:
Shipping Methods
The Shipping Methods resource manages the service level and method of transport that form a shipping method for a carrier.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
EmailAddress: string
Title:
E-Mail
Maximum Length:320
The email address of the person who is a contact at the carrier. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of the person who is a contact at the carrier. -
JobTitle: string
Title:
Job Title
Maximum Length:100
The job title of the person who is a contact at the carrier. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of the person who is a contact at the carrier. This attribute is required. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
The phone number of the person who is a contact at the carrier. -
RelationshipRecordId: integer
Read Only:
true
The value that uniquely identifies the contact for the carrier. It is a value that the application generates when it creates a contact.
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.
Nested Schema : carriers-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for shipping methods. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
CarrierId: integer
(int64)
The value that uniquely identifies the carrier. It is a primary key that the application generates when it creates a carrier.
-
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 : carriers-inboundTrackingRules-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
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. -
BaseURL: string
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. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
organizationAssociations: array
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. -
parameters: array
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. -
RequestMethod: string
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. -
RequestMethodCode: string
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. -
TrackingRuleId: integer
(int64)
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. -
TrackingRuleName: string
Title:
Name
Maximum Length:200
The name of the tracking rule. This attribute is required.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCarrierTrackingId: integer
(int64)
Read Only:
true
The value that uniquely identifies the tracking rule assigned to an organization. It is a value that the application generates when it assigns a tracking rule for a carrier to an organization. -
OrganizationCode: string
Maximum Length:
18
The value that uniquely identifies the inventory organization as an abbreviation. Either this attribute or OrganizationId is required. -
OrganizationId: integer
(int64)
The value that uniquely identifies the inventory organization assigned to a carrier shipping method. Either this attribute or OrganizationCode is required.
-
OrganizationName: string
Maximum Length:
240
The name of the inventory organization.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : carriers-inboundTrackingRules-parameters-item-response
Type:
Show Source
object
-
ConstantValue: string
Title:
Constant Value
Maximum Length:50
The value of the tracking rule parameter when the parameter has a constant value. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupParameter: string
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. -
LookupParameterCode: string
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. -
ParameterId: integer
(int64)
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. -
ParameterName: string
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. -
Sequence: integer
(int64)
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : carriers-shippingMethods-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
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. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
DFF: array
Flexfields for Shipping Methods
Title:
Flexfields for Shipping Methods
The Flexfields for Shipping Methods resource manages the descriptive flexfields for the shipping method. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModeOfTransport: string
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. -
ModeOfTransportCode: string
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. -
organizationAssociations: array
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. -
OrganizationCarrierServiceId: integer
(int64)
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. -
ServiceLevel: string
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. -
ServiceLevelCode: string
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. -
ShipMethodCode: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for shipping methods. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrgCarrierServiceId: integer
(int64)
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. This attribute maps to the OrganizationCarrierServiceId parameter in the parent shippingMethods resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : carriers-shippingMethods-organizationAssociations-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCarrierServiceId: integer
(int64)
Read Only:
true
The value that uniquely identifies the carrier shipping method assigned to an organization. It is a value that the application generates when it assigns a shipping method for a carrier to an organization. -
OrganizationCode: string
Maximum Length:
18
The value that uniquely identifies the inventory organization as an abbreviation. Either this attribute or OrganizationId is required. -
OrganizationId: integer
(int64)
The value that uniquely identifies the inventory organization assigned to a carrier shipping method. Either this attribute or OrganizationCode is required.
-
OrganizationName: string
Maximum Length:
240
The name of the inventory organization.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- DFF
-
Parameters:
- CarrierId:
$request.path.CarrierId
The Flexfields for Carriers resource manages the descriptive flexfields for the carrier. - CarrierId:
- contacts
-
Parameters:
- CarrierId:
$request.path.CarrierId
The Contacts resource manages the contact information for a carrier. - CarrierId:
- inboundTrackingRules
-
Parameters:
- CarrierId:
$request.path.CarrierId
The Inbound Tracking Rules resource manages the web service which allows a shipment to be tracked when the carrier is used. - CarrierId:
- shippingMethods
-
Parameters:
- CarrierId:
$request.path.CarrierId
The Shipping Methods resource manages the service level and method of transport that form a shipping method for a carrier. - CarrierId:
Examples
This example describes how to get one carrier.
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?finder=PrimaryKey;CarrierId"
For example, the following command gets carrier 12516:
curl -u username:password "https://servername/fscmRestApi/resources/version/carriers?finder=PrimaryKey;12516"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "items" : [ { "CarrierId" : 12516, "CarrierName" : "ADL Trucking", "ManifestingEnabledFlag" : null, "ActiveFlag" : true, ... } ], ... }