Create one inbound tracking rule

post

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

Request

Path Parameters
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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
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.
  • 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.
  • 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.
  • 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-post-request
Type: object
Show Source
  • Maximum Length: 18
    The value that uniquely identifies the inventory organization as an abbreviation. Either this attribute or OrganizationId is required.
  • The value that uniquely identifies the inventory organization assigned to a carrier shipping method. Either this attribute or OrganizationCode is required.
  • Maximum Length: 240
    The name of the inventory organization.
Nested Schema : carriers-inboundTrackingRules-parameters-item-post-request
Type: object
Show Source
  • Title: Constant Value
    Maximum Length: 50
    The value of the tracking rule parameter when the parameter has a constant value.
  • 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.
  • 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.
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-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.
Back to Top