Jump to

• Request
• Response
• Examples

Create one carrier

post

/fscmRestApi/resources/11.13.18.05/carriers

Request

Header Parameters

• Metadata-Context: string
  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: string
  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.
• Upsert-Mode: string
  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

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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 isn't active. The default value is true.
• CarrierName: string
  Maximum Length: 360

  The name of the carrier. It's a unique value. This attribute is required.
• contacts: array Contacts
  Title: Contacts

  The Contacts resource manages the contact information for a carrier.
• DFF: array DFF
• 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.
• 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 don't 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.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the carrier is active. If false, then the carrier isn't active. The default value is true.",
            "nullable":true
        },
        "CarrierName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the carrier. It's a unique value. This attribute is required.",
            "nullable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/carriers-DFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "ManifestingEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then use a manifest with this carrier. If false, then don't use a manifest with this carrier. The default value is false.",
            "nullable":true
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"The Contacts resource manages the contact information for a carrier.",
            "items":{
                "$ref":"#/components/schemas/carriers-contacts-item-post-request"
            }
        },
        "inboundTrackingRules":{
            "title":"Inbound Tracking Rules",
            "type":"array",
            "description":"The Inbound Tracking Rules resource manages the web service which allows a shipment to be tracked when the carrier is used.",
            "items":{
                "$ref":"#/components/schemas/carriers-inboundTrackingRules-item-post-request"
            }
        },
        "shippingMethods":{
            "title":"Shipping Methods",
            "type":"array",
            "description":"The Shipping Methods resource manages the service level and method of transport that form a shipping method for a carrier.",
            "items":{
                "$ref":"#/components/schemas/carriers-shippingMethods-item-post-request"
            }
        }
    }
}

Nested Schema : Contacts

Type: array

Title: Contacts

The Contacts resource manages the contact information for a carrier.

Show Source

• Array of: object carriers-contacts-item-post-request

{
    "title":"Contacts",
    "type":"array",
    "description":"The Contacts resource manages the contact information for a carrier.",
    "items":{
        "$ref":"#/components/schemas/carriers-contacts-item-post-request"
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/carriers-DFF-item-post-request"
    },
    "x-cardinality":"1"
}

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

• Array of: object carriers-inboundTrackingRules-item-post-request

{
    "title":"Inbound Tracking Rules",
    "type":"array",
    "description":"The Inbound Tracking Rules resource manages the web service which allows a shipment to be tracked when the carrier is used.",
    "items":{
        "$ref":"#/components/schemas/carriers-inboundTrackingRules-item-post-request"
    }
}

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

• Array of: object carriers-shippingMethods-item-post-request

{
    "title":"Shipping Methods",
    "type":"array",
    "description":"The Shipping Methods resource manages the service level and method of transport that form a shipping method for a carrier.",
    "items":{
        "$ref":"#/components/schemas/carriers-shippingMethods-item-post-request"
    }
}

Nested Schema : carriers-contacts-item-post-request

Type: object

Show Source

• EmailAddress: string
  Title: E-Mail

  Maximum Length: 320

  The email address of the person who's a contact at the carrier.
• FirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of the person who's a contact at the carrier.
• JobTitle: string
  Title: Job Title

  Maximum Length: 100

  The job title of the person who's a contact at the carrier.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of the person who's a contact at the carrier. This attribute is required.
• PhoneNumber: string
  Title: Phone

  Maximum Length: 40

  The phone number of the person who's a contact at the carrier.

{
    "type":"object",
    "properties":{
        "EmailAddress":{
            "title":"E-Mail",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the person who's a contact at the carrier.",
            "nullable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the person who's a contact at the carrier.",
            "nullable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the person who's a contact at the carrier.",
            "nullable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the person who's a contact at the carrier. This attribute is required.",
            "nullable":false
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the person who's a contact at the carrier.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• CarrierId: integer (int64)

{
    "type":"object",
    "properties":{
        "CarrierId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : carriers-inboundTrackingRules-item-post-request

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 isn't active. The default value is true.
• BaseURL(required): 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.
• organizationAssociations: array Inbound Tracking Rule Organization Associations
  Title: Inbound Tracking Rule Organization Associations

  The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.
• 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.
• RequestMethodCode(required): 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.
• TrackingRuleName(required): string
  Title: Name

  Maximum Length: 200

  The name of the tracking rule. This attribute is required.

{
    "required":[
        "BaseURL",
        "RequestMethodCode",
        "TrackingRuleName"
    ],
    "type":"object",
    "properties":{
        "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 isn't active. The default value is true.",
            "nullable":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
        },
        "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"
            }
        },
        "TrackingRuleName":{
            "title":"Name",
            "maxLength":200,
            "type":"string",
            "description":"The name of the tracking rule. This attribute is required.",
            "nullable":false
        },
        "organizationAssociations":{
            "title":"Inbound Tracking Rule Organization Associations",
            "type":"array",
            "description":"The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.",
            "items":{
                "$ref":"#/components/schemas/carriers-inboundTrackingRules-organizationAssociations-item-post-request"
            }
        },
        "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-post-request"
            }
        }
    }
}

Nested Schema : Inbound Tracking Rule Organization Associations

Type: array

Title: Inbound Tracking Rule Organization Associations

The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.

Show Source

• Array of: object carriers-inboundTrackingRules-organizationAssociations-item-post-request

{
    "title":"Inbound Tracking Rule Organization Associations",
    "type":"array",
    "description":"The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.",
    "items":{
        "$ref":"#/components/schemas/carriers-inboundTrackingRules-organizationAssociations-item-post-request"
    }
}

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-post-request

{
    "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-post-request"
    }
}

Nested Schema : carriers-inboundTrackingRules-organizationAssociations-item-post-request

Type: object

Show Source

• 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 inbound tracking rule. Either this attribute or OrganizationCode is required.
• OrganizationName: string
  Maximum Length: 240

  The name of the inventory organization.

{
    "type":"object",
    "properties":{
        "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"
                ]
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The value that uniquely identifies the inventory organization assigned to a carrier inbound tracking rule. Either this attribute or OrganizationCode is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "OrganizationCode",
                    "OrganizationName"
                ]
            }
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"The name of the inventory organization.",
            "nullable":true
        }
    }
}

Nested Schema : carriers-inboundTrackingRules-parameters-item-post-request

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.
• 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.
• 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":{
        "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
        },
        "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"
            }
        },
        "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
        },
        "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
            }
        }
    }
}

Nested Schema : carriers-shippingMethods-item-post-request

Type: object

Show Source

• 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 isn't active. The default value is true.
• DFF: array DFF
• ModeOfTransportCode(required): 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 Inbound Tracking Rule Organization Associations
  Title: Inbound Tracking Rule Organization Associations

  The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.
• ServiceLevelCode(required): 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.

{
    "required":[
        "ModeOfTransportCode",
        "ServiceLevelCode"
    ],
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the shipping method is active. If false, then the shipping method isn't active. The default value is true.",
            "nullable":true,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/carriers-shippingMethods-DFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "ModeOfTransportCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "ServiceLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "organizationAssociations":{
            "title":"Inbound Tracking Rule Organization Associations",
            "type":"array",
            "description":"The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.",
            "items":{
                "$ref":"#/components/schemas/carriers-shippingMethods-organizationAssociations-item-post-request"
            }
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object carriers-shippingMethods-DFF-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/carriers-shippingMethods-DFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Inbound Tracking Rule Organization Associations

Type: array

Title: Inbound Tracking Rule Organization Associations

The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.

Show Source

• Array of: object schema

{
    "title":"Inbound Tracking Rule Organization Associations",
    "type":"array",
    "description":"The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.",
    "items":{
        "$ref":"#/components/schemas/carriers-shippingMethods-organizationAssociations-item-post-request"
    }
}

Nested Schema : carriers-shippingMethods-DFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value

{
    "type":"object",
    "properties":{
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• 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":{
        "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-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OrganizationName"
                ]
            }
        },
        "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":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "OrganizationCode",
                    "OrganizationName"
                ]
            }
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"The name of the inventory organization.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : carriers-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 carrier is active. If false, then the carrier isn't active. The default value is true.
• CarrierId: integer (int64)
  Read Only: true

  The value that uniquely identifies the carrier. It's a primary key that the application generates when it creates a carrier.
• CarrierName: string
  Maximum Length: 360

  The name of the carrier. It's 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 DFF
• 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 don't 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.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the carrier is active. If false, then the carrier isn't active. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "CarrierId":{
            "type":"integer",
            "description":"The value that uniquely identifies the carrier. It's a primary key that the application generates when it creates a carrier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CarrierName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the carrier. It's a unique value. This attribute is required.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created 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
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/carriers-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManifestingEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then use a manifest with this carrier. If false, then don't use a manifest with this carrier. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "contacts":{
            "title":"Contacts",
            "type":"array",
            "description":"The Contacts resource manages the contact information for a carrier.",
            "items":{
                "$ref":"#/components/schemas/carriers-contacts-item-response"
            }
        },
        "inboundTrackingRules":{
            "title":"Inbound Tracking Rules",
            "type":"array",
            "description":"The Inbound Tracking Rules resource manages the web service which allows a shipment to be tracked when the carrier is used.",
            "items":{
                "$ref":"#/components/schemas/carriers-inboundTrackingRules-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "shippingMethods":{
            "title":"Shipping Methods",
            "type":"array",
            "description":"The Shipping Methods resource manages the service level and method of transport that form a shipping method for a carrier.",
            "items":{
                "$ref":"#/components/schemas/carriers-shippingMethods-item-response"
            }
        }
    }
}

Nested Schema : Contacts

Type: array

Title: Contacts

The Contacts resource manages the contact information for a carrier.

Show Source

• Array of: object carriers-contacts-item-response

{
    "title":"Contacts",
    "type":"array",
    "description":"The Contacts resource manages the contact information for a carrier.",
    "items":{
        "$ref":"#/components/schemas/carriers-contacts-item-response"
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object carriers-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/carriers-DFF-item-response"
    },
    "x-cardinality":"1"
}

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

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

{
    "title":"Inbound Tracking Rules",
    "type":"array",
    "description":"The Inbound Tracking Rules resource manages the web service which allows a shipment to be tracked when the carrier is used.",
    "items":{
        "$ref":"#/components/schemas/carriers-inboundTrackingRules-item-response"
    }
}

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 : 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

• Array of: object carriers-shippingMethods-item-response

{
    "title":"Shipping Methods",
    "type":"array",
    "description":"The Shipping Methods resource manages the service level and method of transport that form a shipping method for a carrier.",
    "items":{
        "$ref":"#/components/schemas/carriers-shippingMethods-item-response"
    }
}

Nested Schema : carriers-contacts-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.
• EmailAddress: string
  Title: E-Mail

  Maximum Length: 320

  The email address of the person who's a contact at the carrier.
• FirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of the person who's a contact at the carrier.
• JobTitle: string
  Title: Job Title

  Maximum Length: 100

  The job title of the person who's a contact at the carrier.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of the person who's 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's a contact at the carrier.
• RelationshipRecordId: integer
  Read Only: true

  The value that uniquely identifies the contact for the carrier. It's a value that the application generates when it creates a contact.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created 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
        },
        "EmailAddress":{
            "title":"E-Mail",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the person who's a contact at the carrier.",
            "nullable":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the person who's a contact at the carrier.",
            "nullable":true,
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the person who's a contact at the carrier.",
            "nullable":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the person who's a contact at the carrier. This attribute is required.",
            "nullable":false,
            "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the person who's a contact at the carrier.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipRecordId":{
            "type":"integer",
            "description":"The value that uniquely identifies the contact for the carrier. It's a value that the application generates when it creates a contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : 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-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• CarrierId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CarrierId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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-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 isn't 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 Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.
• 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's 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":{
        "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 isn't active. The default value is true.",
            "nullable":true,
            "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created 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
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "TrackingRuleId":{
            "type":"integer",
            "description":"The value that uniquely identifies the tracking rule for a carrier. It's 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
        },
        "TrackingRuleName":{
            "title":"Name",
            "maxLength":200,
            "type":"string",
            "description":"The name of the tracking rule. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "organizationAssociations":{
            "title":"Inbound Tracking Rule Organization Associations",
            "type":"array",
            "description":"The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.",
            "items":{
                "$ref":"#/components/schemas/carriers-inboundTrackingRules-organizationAssociations-item-response"
            }
        },
        "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"
            }
        }
    }
}

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 Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.

Show Source

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

{
    "title":"Inbound Tracking Rule Organization Associations",
    "type":"array",
    "description":"The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.",
    "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 : 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's 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 inbound tracking rule. Either this attribute or OrganizationCode is required.
• OrganizationName: string
  Maximum Length: 240

  The name of the inventory organization.

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

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's 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":{
        "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created 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
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "ParameterId":{
            "type":"integer",
            "description":"The value that uniquely identifies the parameter for the tracking rule for a carrier. It's 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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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-shippingMethods-item-response

Type: object

Show Source

• 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 isn't 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 DFF
• 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 Inbound Tracking Rule Organization Associations
  Title: Inbound Tracking Rule 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's 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.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the shipping method is active. If false, then the shipping method isn't active. The default value is true.",
            "nullable":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created 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
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/carriers-shippingMethods-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ModeOfTransport":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ModeOfTransportCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationCarrierServiceId":{
            "type":"integer",
            "description":"The value that uniquely identifies the carrier shipping method. It's a value that the application generates when it creates a shipping method for a carrier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ServiceLevel":{
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ShipMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The value that uniquely identifies the carrier shipping method, as a concatenation of carrier name, service level and mode of transport.",
            "nullable":false,
            "readOnly":true,
            "default":" ",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "organizationAssociations":{
            "title":"Inbound Tracking Rule Organization Associations",
            "type":"array",
            "description":"The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.",
            "items":{
                "$ref":"#/components/schemas/carriers-shippingMethods-organizationAssociations-item-response"
            }
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object carriers-shippingMethods-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/carriers-shippingMethods-DFF-item-response"
    },
    "x-cardinality":"1"
}

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 Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.

Show Source

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

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

Nested Schema : carriers-shippingMethods-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrgCarrierServiceId: integer (int64)
  Read Only: true

{
    "type":"object",
    "properties":{
        "OrgCarrierServiceId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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-shippingMethods-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.
• OrganizationCarrierServiceId: integer (int64)
  Read Only: true

  The value that uniquely identifies the carrier shipping method assigned to an organization. It's 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created 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
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCarrierServiceId":{
            "type":"integer",
            "description":"The value that uniquely identifies the carrier shipping method assigned to an organization. It's a value that the application generates when it assigns a shipping method for a carrier to an organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OrganizationName"
                ]
            }
        },
        "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":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "OrganizationCode",
                    "OrganizationName"
                ]
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"The name of the inventory organization.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

DFF

Operation: /fscmRestApi/resources/11.13.18.05/carriers/{CarrierId}/child/DFF

Parameters:

• CarrierId: $request.path.CarrierId

contacts

Operation: /fscmRestApi/resources/11.13.18.05/carriers/{CarrierId}/child/contacts

Parameters:

• CarrierId: $request.path.CarrierId

The Contacts resource manages the contact information for a carrier.

inboundTrackingRules

Operation: /fscmRestApi/resources/11.13.18.05/carriers/{CarrierId}/child/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.

shippingMethods

Operation: /fscmRestApi/resources/11.13.18.05/carriers/{CarrierId}/child/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.

Back to Top

Examples

This example describes how to create one carrier.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/carriers"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{  
  "CarrierName" : "Carrier001" 
}

Example Response Body

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

{ 
  "CarrierId" : 300100137818379, 
  "CarrierName" : "Carrier001", 
  "ActiveFlag" : true, 
  "ManifestingEnabledFlag" : false, 
...
}

Back to Top