Jump to

• Request
• Response

Get one inbound tracking rule

get

/fscmRestApi/resources/11.13.18.05/carriers/{CarrierId}/child/inboundTrackingRules/{TrackingRuleName}

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.
• TrackingRuleName(required): string
  The name of the tracking rule. This attribute is required.

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 : carriers-inboundTrackingRules-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestMethodCode":{
            "title":"Request Method",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "organizationAssociations":{
            "title":"Inbound Tracking Rule Organization Associations",
            "type":"array",
            "description":"The Inbound Tracking Rule Organization Associations resource manages the inventory organizations that may use the inbound tracking rule.",
            "items":{
                "$ref":"#/components/schemas/carriers-inboundTrackingRules-organizationAssociations-item-response"
            }
        },
        "RequestMethod":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TrackingRuleId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TrackingRuleName":{
            "title":"Name",
            "maxLength":200,
            "type":"string",
            "description":"The name of the tracking rule. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "BaseURL":{
            "title":"Base URL",
            "maxLength":200,
            "type":"string",
            "description":"The URL (Uniform Resource Locator) that the carrier publishes to allow the tracking of shipments being delivered by the carrier. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "parameters":{
            "title":"Inbound Tracking Rule Parameters",
            "type":"array",
            "description":"The Inbound Tracking Rule Parameters resource manages the unique parameter information required by the web service to track a shipment.",
            "items":{
                "$ref":"#/components/schemas/carriers-inboundTrackingRules-parameters-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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"
    }
}

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

• Array of: object carriers-inboundTrackingRules-organizationAssociations-item-response

{
    "title":"Inbound Tracking Rule Organization Associations",
    "type":"array",
    "description":"The Inbound Tracking Rule Organization Associations resource manages the inventory organizations that may use the inbound tracking rule.",
    "items":{
        "$ref":"#/components/schemas/carriers-inboundTrackingRules-organizationAssociations-item-response"
    }
}

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

• Array of: object carriers-inboundTrackingRules-parameters-item-response

{
    "title":"Inbound Tracking Rule Parameters",
    "type":"array",
    "description":"The Inbound Tracking Rule Parameters resource manages the unique parameter information required by the web service to track a shipment.",
    "items":{
        "$ref":"#/components/schemas/carriers-inboundTrackingRules-parameters-item-response"
    }
}

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 : carriers-inboundTrackingRules-organizationAssociations-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"The name of the inventory organization.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCarrierTrackingId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"The value that uniquely identifies the inventory organization as an abbreviation. Either this attribute or OrganizationId is required.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "OrganizationName"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The value that uniquely identifies the inventory organization assigned to a carrier shipping method. Either this attribute or OrganizationCode is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "OrganizationCode",
                    "OrganizationName"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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"
    }
}

Nested Schema : carriers-inboundTrackingRules-parameters-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupParameterCode":{
            "title":"Lookup Parameter",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "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"
            }
        },
        "LookupParameter":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParameterName":{
            "title":"Parameter Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the tracking rule parameter. Each parameter may have either a constant value or a value supplied from the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The value that uniquely identifies the order of precedence for each parameter for the tracking rule for a carrier. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConstantValue":{
            "title":"Constant Value",
            "maxLength":50,
            "type":"string",
            "description":"The value of the tracking rule parameter when the parameter has a constant value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParameterId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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

organizationAssociations

Operation: /fscmRestApi/resources/11.13.18.05/carriers/{CarrierId}/child/inboundTrackingRules/{TrackingRuleName}/child/organizationAssociations

Parameters:

• CarrierId: $request.path.CarrierId
• TrackingRuleName: $request.path.TrackingRuleName

The Inbound Tracking Rule Organization Associations resource manages the inventory organizations that may use the inbound tracking rule.

parameters

Operation: /fscmRestApi/resources/11.13.18.05/carriers/{CarrierId}/child/inboundTrackingRules/{TrackingRuleName}/child/parameters

Parameters:

• CarrierId: $request.path.CarrierId
• TrackingRuleName: $request.path.TrackingRuleName

The Inbound Tracking Rule Parameters resource manages the unique parameter information required by the web service to track a shipment.

Back to Top