Jump to

• Request
• Response
• Examples

Create one transit time

post

/fscmRestApi/resources/11.13.18.05/transitTimes

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DestinationExternalLocationCustomerName: string
  The name of the selected customer when the destination type is a ship-to address. The default value is null.
• DestinationExternalLocationId: integer (int64)
  The value that uniquely identifies the selected address from the trading community architecture when Destination Type is External Location. It is the value of the LOCATION_ID column in the HZ_LOCATIONS table. The default value is null.
• DestinationExternalLocationName: string
  The selected address from the trading community architecture when Destination Type is External Location. It is the value of the ADDRESS1 column in the HZ_LOCATIONS table. The default value is null.
• DestinationExternalLocationShipToCustomerId: integer
  The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the destination is a ship-to address, the value represents a party identifier for the selected customer. The default value is null.
• DestinationExternalLocationSourceId: integer
  The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When Destination is a supplier address, the value represents a party site identifier. When Destination is a ship-to address, the value represents a party site identifier for the customer address. The default value is null.
• DestinationExternalLocationSourceName: string
  The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When Destination is a supplier address, the value represents a party site name. When Destination is a ship-to address, the value represents a party site name for the customer address. The default value is null.
• DestinationExternalLocationSourceType: string
  Maximum Length: 2

  The value that uniquely identifies the selected kind of trading community architecture location. Valid values are SA for Supplier Address, ST for Ship-to Address, and null.
• DestinationExternalLocationSupplierId: integer
  The value that uniquely identifies the selected supplier when the Destination Type is a supplier address.
• DestinationExternalLocationSupplierName: string
  The name of the selected supplier when Destination Type is a supplier address.
• DestinationGeographyDescription: string
  The comma delimited concatenation of the geography hierarchy when Destination Type is Geography. The default value is null.
• DestinationGeographyId: integer (int64)
  The value that uniquely identifies the selected geography when Destination Type is Geography. The default value is null.
• DestinationGeographyName: string
  The name of the selected geography when Destination Type is Geography. The default value is null.
• DestinationInternalLocationCode: string
  The short name that identifies the selected warehouse location when Destination Type is Internal Location. Location Codes are only unique within a Location Set. The default value is null.
• DestinationInternalLocationId: integer (int64)
  The value that uniquely identifies the selected warehouse location when Destination Type is Internal Location. The default value is null.
• DestinationInternalLocationSetName: string
  The name of the set that the selected warehouse location was chosen from when Destination Type is Internal Location. The default value is null.
• DestinationTypeCode(required): string
  Title: Destination Type

  Maximum Length: 2

  The abbreviation that identifies the type of location for the destination of the shipping lane. This attribute is required. Valid values include LI for Internal Location, G for Geography, Z for Zone, and LE for External Location. A list of accepted values is defined in the lookup type WSH_ORG_DEST_TYPE. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
• DestinationZoneId: integer (int64)
  The value that uniquely identifies the selected zone when Destination Type is Zone. The default value is null.
• DestinationZoneName: string
  The name of the selected zone when Destination Type is Zone. The default value is null.
• OriginExternalLocationCustomerName: string
  The name of the selected customer when the origin type is a ship-to address. The default value is null.
• OriginExternalLocationId: integer (int64)
  The value that uniquely identifies the selected address from the trading community architecture when Origin Type is External Location. It is the value of the LOCATION_ID column in the HZ_LOCATIONS table. The default value is null.
• OriginExternalLocationName: string
  The selected address from the trading community architecture when Origin Type is External Location. It is the value of the ADDRESS1 column in the HZ_LOCATIONS table. The default value is null.
• OriginExternalLocationShipToCustomerId: integer
  The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the origin is a ship-to address, the value represents a party identifier for the selected customer. The default value is null.
• OriginExternalLocationSourceId: integer
  The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the origin is a supplier address, the value represents a party site identifier. When the origin is a ship-to address, the value represents a party site identifier for the customer address. The default value is null.
• OriginExternalLocationSourceName: string
  The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the origin is a supplier address, the value represents a party site name. When the origin is a ship-to address, the value represents a party site name for the customer address. The default value is null.
• OriginExternalLocationSourceType: string
  Maximum Length: 2

  The value that uniquely identifies the specific kind of trading community architecture location has is selected. Valid values are SA for Supplier Address, ST for Ship-to Address, and null.
• OriginExternalLocationSupplierId: integer
  The value that uniquely identifies the selected supplier when the origin type is a supplier address.
• OriginExternalLocationSupplierName: string
  The name of the selected supplier when the origin type is a supplier address.
• OriginGeographyDescription: string
  The comma delimited concatenation of the geography hierarchy when Origin Type is Geography. The default value is null.
• OriginGeographyId: integer (int64)
  The value that uniquely identifies the selected geography when Origin Type is Geography. The default value is null.
• OriginGeographyName: string
  The name of the selected geography when Origin Type is Geography. The default value is null.
• OriginInternalLocationCode: string
  The abbreviation that identifies the selected warehouse location when Origin Type is Internal Location. Location codes are only unique within a location set. The default value is null.
• OriginInternalLocationId: integer (int64)
  The value that uniquely identifies the selected warehouse location when Origin Type is Internal Location. The default value is null.
• OriginInternalLocationSetName: string
  The name of the set that the selected warehouse location was chosen from when Origin Type is Internal Location. The default value is null.
• OriginTypeCode(required): string
  Title: Origin Type

  Maximum Length: 2

  The abbreviation that identifies the type of location for the origin of the shipping lane. This attribute is required. Valid values include LI for Internal Location, R for Geography, Z for Zone, and LE for External Location. A list of accepted values is defined in the lookup type WSH_ORG_DEST_TYPE. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
• OriginZoneId: integer (int64)
  The value that uniquely identifies the selected zone when Origin Type is Zone. The default value is null.
• OriginZoneName: string
  The name of the selected zone when Origin Type is Zone. The default value is null.
• shippingMethods: array Shipping Methods
  Title: Shipping Methods

  The Shipping Methods resource gets the shipping method associated between the origin and destination locations.

{
    "required":[
        "DestinationTypeCode",
        "OriginTypeCode"
    ],
    "type":"object",
    "properties":{
        "DestinationExternalLocationSourceType":{
            "maxLength":"2",
            "type":"string",
            "description":"The value that uniquely identifies the selected kind of trading community architecture location. Valid values are SA for Supplier Address, ST for Ship-to Address, and null.",
            "nullable":true
        },
        "OriginExternalLocationShipToCustomerId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the origin is a ship-to address, the value represents a party identifier for the selected customer. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginExternalLocationSupplierId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected supplier when the origin type is a supplier address.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginExternalLocationName":{
            "type":"string",
            "description":"The selected address from the trading community architecture when Origin Type is External Location. It is the value of the ADDRESS1 column in the HZ_LOCATIONS table. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationGeographyDescription":{
            "type":"string",
            "description":"The comma delimited concatenation of the geography hierarchy when Destination Type is Geography. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginExternalLocationSourceName":{
            "type":"string",
            "description":"The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the origin is a supplier address, the value represents a party site name. When the origin is a ship-to address, the value represents a party site name for the customer address. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationInternalLocationSetName":{
            "type":"string",
            "description":"The name of the set that the selected warehouse location was chosen from when Destination Type is Internal Location. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginGeographyId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected geography when Origin Type is Geography. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DestinationGeographyId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected geography when Destination Type is Geography. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DestinationExternalLocationSupplierId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected supplier when the Destination Type is a supplier address.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginInternalLocationId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected warehouse location when Origin Type is Internal Location. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DestinationExternalLocationSourceName":{
            "type":"string",
            "description":"The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When Destination is a supplier address, the value represents a party site name. When Destination is a ship-to address, the value represents a party site name for the customer address. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginInternalLocationCode":{
            "type":"string",
            "description":"The abbreviation that identifies the selected warehouse location when Origin Type is Internal Location. Location codes are only unique within a location set. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationExternalLocationSourceId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When Destination is a supplier address, the value represents a party site identifier. When Destination is a ship-to address, the value represents a party site identifier for the customer address. The default value is null.",
            "nullable":true
        },
        "DestinationExternalLocationCustomerName":{
            "type":"string",
            "description":"The name of the selected customer when the destination type is a ship-to address. The default value is null.",
            "nullable":true
        },
        "OriginTypeCode":{
            "title":"Origin Type",
            "maxLength":"2",
            "type":"string",
            "description":"The abbreviation that identifies the type of location for the origin of the shipping lane. This attribute is required. Valid values include LI for Internal Location, R for Geography, Z for Zone, and LE for External Location. A list of accepted values is defined in the lookup type WSH_ORG_DEST_TYPE. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.",
            "nullable":false
        },
        "shippingMethods":{
            "title":"Shipping Methods",
            "type":"array",
            "description":"The Shipping Methods resource gets the shipping method associated between the origin and destination locations.",
            "items":{
                "$ref":"#/components/schemas/transitTimes-shippingMethods-item-post-request"
            }
        },
        "OriginGeographyName":{
            "type":"string",
            "description":"The name of the selected geography when Origin Type is Geography. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationTypeCode":{
            "title":"Destination Type",
            "maxLength":"2",
            "type":"string",
            "description":"The abbreviation that identifies the type of location for the destination of the shipping lane. This attribute is required. Valid values include LI for Internal Location, G for Geography, Z for Zone, and LE for External Location. A list of accepted values is defined in the lookup type WSH_ORG_DEST_TYPE. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.",
            "nullable":false
        },
        "OriginGeographyDescription":{
            "type":"string",
            "description":"The comma delimited concatenation of the geography hierarchy when Origin Type is Geography. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginZoneName":{
            "type":"string",
            "description":"The name of the selected zone when Origin Type is Zone. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationExternalLocationId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected address from the trading community architecture when Destination Type is External Location. It is the value of the LOCATION_ID column in the HZ_LOCATIONS table. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DestinationExternalLocationSupplierName":{
            "type":"string",
            "description":"The name of the selected supplier when Destination Type is a supplier address.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginInternalLocationSetName":{
            "type":"string",
            "description":"The name of the set that the selected warehouse location was chosen from when Origin Type is Internal Location. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginExternalLocationSupplierName":{
            "type":"string",
            "description":"The name of the selected supplier when the origin type is a supplier address.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationExternalLocationShipToCustomerId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the destination is a ship-to address, the value represents a party identifier for the selected customer. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationExternalLocationName":{
            "type":"string",
            "description":"The selected address from the trading community architecture when Destination Type is External Location. It is the value of the ADDRESS1 column in the HZ_LOCATIONS table. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginExternalLocationCustomerName":{
            "type":"string",
            "description":"The name of the selected customer when the origin type is a ship-to address. The default value is null.",
            "nullable":true
        },
        "OriginExternalLocationSourceType":{
            "maxLength":"2",
            "type":"string",
            "description":"The value that uniquely identifies the specific kind of trading community architecture location has is selected. Valid values are SA for Supplier Address, ST for Ship-to Address, and null.",
            "nullable":true
        },
        "OriginZoneId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected zone when Origin Type is Zone. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DestinationZoneId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected zone when Destination Type is Zone. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OriginExternalLocationSourceId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the origin is a supplier address, the value represents a party site identifier. When the origin is a ship-to address, the value represents a party site identifier for the customer address. The default value is null.",
            "nullable":true
        },
        "DestinationGeographyName":{
            "type":"string",
            "description":"The name of the selected geography when Destination Type is Geography. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginExternalLocationId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected address from the trading community architecture when Origin Type is External Location. It is the value of the LOCATION_ID column in the HZ_LOCATIONS table. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DestinationInternalLocationId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected warehouse location when Destination Type is Internal Location. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DestinationZoneName":{
            "type":"string",
            "description":"The name of the selected zone when Destination Type is Zone. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationInternalLocationCode":{
            "type":"string",
            "description":"The short name that identifies the selected warehouse location when Destination Type is Internal Location. Location Codes are only unique within a Location Set. The default value is null.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Shipping Methods

Type: array

Title: Shipping Methods

The Shipping Methods resource gets the shipping method associated between the origin and destination locations.

Show Source

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

{
    "title":"Shipping Methods",
    "type":"array",
    "description":"The Shipping Methods resource gets the shipping method associated between the origin and destination locations.",
    "items":{
        "$ref":"#/components/schemas/transitTimes-shippingMethods-item-post-request"
    }
}

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

Type: object

Show Source

• CostPerUnit: number
  Title: Cost per Unit

  The value that indicates the cost of moving one unit of an item between this origin and destination.
• CostPerUnitCurrencyCode: string
  Maximum Length: 15

  The abbreviation that identifies the currency of the cost per unit.
• DailyVolumeCapacity: number
  Title: Daily Volume Capacity

  The value that indicates if moving a shipment from the origin to the destination is subject to a per day capacity limit for volume, and the quantity of that limit.
• DailyVolumeCapacityUnitOfMeasureCode: string
  Maximum Length: 3

  The abbreviation that identifies the unit of measure of the volume capacity.
• DailyVolumeCapacityUnitOfMeasureName: string
  The name of the unit of measure of the volume capacity.
• DailyWeightCapacity: number
  Title: Daily Weight Capacity

  The value that indicates if moving a shipment from the origin to the destination is subject to a per day capacity limit for weight, and the quantity of that limit.
• DailyWeightCapacityUnitOfMeasureCode: string
  Maximum Length: 3

  The abbreviation that identifies the unit of measure of the weight capacity.
• DailyWeightCapacityUnitOfMeasureName: string
  The name of the unit of measure of the weight capacity.
• DefaultShippingMethodFlag: boolean
  Title: Default shipping method

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the shipping method is the default choice among all defined between this origin and destination pairing. If false, then the shipping method is not the default. The default value is false.
• DFF: array Flexfields for Shipping Methods
  Title: Flexfields for Shipping Methods

  The Flexfields for Shipping Methods resource manages the descriptive flexfields for the shipping method.
• ShippingMethod: string
  The user-visible value that uniquely identifies the carrier shipping method, as a concatenation of carrier name, service level, and mode of transport.
• ShippingMethodCode(required): string
  Maximum Length: 30

  The internal value that uniquely identifies the carrier shipping method, as a concatenation of carrier name, service level, and mode of transport.
• TransitTimeInDays(required): number
  Title: Transit Time in Days

  The value that uniquely identifies the transit time use of a shipping method. It is a value that the application generates when it assigns a shipping method to a transit time.
• TransitTimeValueId: integer (int64)
  The value that uniquely identifies the carrier shipping method. It is a value that the application generates when it creates a shipping method for a carrier. This maps to the same parameter in the parent Shipping Methods resource.

{
    "required":[
        "ShippingMethodCode",
        "TransitTimeInDays"
    ],
    "type":"object",
    "properties":{
        "ShippingMethod":{
            "type":"string",
            "description":"The user-visible value that uniquely identifies the carrier shipping method, as a concatenation of carrier name, service level, and mode of transport.",
            "nullable":true,
            "x-queryable":false
        },
        "DailyWeightCapacityUnitOfMeasureCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The abbreviation that identifies the unit of measure of the weight capacity.",
            "nullable":true
        },
        "DFF":{
            "title":"Flexfields for Shipping Methods",
            "type":"array",
            "description":"The Flexfields for Shipping Methods resource manages the descriptive flexfields for the shipping method.",
            "items":{
                "$ref":"#/components/schemas/transitTimes-shippingMethods-DFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "DailyWeightCapacity":{
            "title":"Daily Weight Capacity",
            "type":"number",
            "description":"The value that indicates if moving a shipment from the origin to the destination is subject to a per day capacity limit for weight, and the quantity of that limit.",
            "nullable":true
        },
        "TransitTimeInDays":{
            "title":"Transit Time in Days",
            "type":"number",
            "description":"The value that uniquely identifies the transit time use of a shipping method. It is a value that the application generates when it assigns a shipping method to a transit time.",
            "nullable":false
        },
        "CostPerUnit":{
            "title":"Cost per Unit",
            "type":"number",
            "description":"The value that indicates the cost of moving one unit of an item between this origin and destination.",
            "nullable":true
        },
        "DefaultShippingMethodFlag":{
            "title":"Default shipping method",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the shipping method is the default choice among all defined between this origin and destination pairing. If false, then the shipping method is not the default. The default value is false.",
            "nullable":true
        },
        "DailyWeightCapacityUnitOfMeasureName":{
            "type":"string",
            "description":"The name of the unit of measure of the weight capacity.",
            "nullable":true,
            "x-queryable":false
        },
        "ShippingMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The internal value that uniquely identifies the carrier shipping method, as a concatenation of carrier name, service level, and mode of transport.",
            "nullable":false
        },
        "DailyVolumeCapacityUnitOfMeasureCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The abbreviation that identifies the unit of measure of the volume capacity.",
            "nullable":true
        },
        "TransitTimeValueId":{
            "type":"integer",
            "description":"The value that uniquely identifies the carrier shipping method. It is a value that the application generates when it creates a shipping method for a carrier. This maps to the same parameter in the parent Shipping Methods resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DailyVolumeCapacityUnitOfMeasureName":{
            "type":"string",
            "description":"The name of the unit of measure of the volume capacity.",
            "nullable":true,
            "x-queryable":false
        },
        "CostPerUnitCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The abbreviation that identifies the currency of the cost per unit.",
            "nullable":true
        },
        "DailyVolumeCapacity":{
            "title":"Daily Volume Capacity",
            "type":"number",
            "description":"The value that indicates if moving a shipment from the origin to the destination is subject to a per day capacity limit for volume, and the quantity of that limit.",
            "nullable":true
        }
    }
}

Nested Schema : Flexfields for Shipping Methods

Type: array

Title: Flexfields for Shipping Methods

The Flexfields for Shipping Methods resource manages the descriptive flexfields for the shipping method.

Show Source

• Array of: object schema

{
    "title":"Flexfields for Shipping Methods",
    "type":"array",
    "description":"The Flexfields for Shipping Methods resource manages the descriptive flexfields for the shipping method.",
    "items":{
        "$ref":"#/components/schemas/transitTimes-shippingMethods-DFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for shipping methods.
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• TransitTimeValueId: integer (int64)
  The value that uniquely identifies the transit time use of a shipping method. It is a value that the application generates when it assigns a shipping method to a transit time. This maps to the same parameter in the parent Shipping Methods resource.

{
    "type":"object",
    "properties":{
        "TransitTimeValueId":{
            "type":"integer",
            "description":"The value that uniquely identifies the transit time use of a shipping method. It is a value that the application generates when it assigns a shipping method to a transit time. This maps to the same parameter in the parent Shipping Methods resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "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"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for shipping methods.",
            "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"
                }
            }
        }
    }
}

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 : transitTimes-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.
• Destination: string
  Read Only: true

  The user supplied name of the selected destination location.
• DestinationDescription: string
  Read Only: true

  The comma delimited concatenation of the primary attributes of the destination location such as street address, city, state, and postal code.
• DestinationExternalLocationCustomerName: string
  The name of the selected customer when the destination type is a ship-to address. The default value is null.
• DestinationExternalLocationId: integer (int64)
  The value that uniquely identifies the selected address from the trading community architecture when Destination Type is External Location. It is the value of the LOCATION_ID column in the HZ_LOCATIONS table. The default value is null.
• DestinationExternalLocationName: string
  The selected address from the trading community architecture when Destination Type is External Location. It is the value of the ADDRESS1 column in the HZ_LOCATIONS table. The default value is null.
• DestinationExternalLocationShipToCustomerId: integer
  The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the destination is a ship-to address, the value represents a party identifier for the selected customer. The default value is null.
• DestinationExternalLocationSourceId: integer
  The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When Destination is a supplier address, the value represents a party site identifier. When Destination is a ship-to address, the value represents a party site identifier for the customer address. The default value is null.
• DestinationExternalLocationSourceName: string
  The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When Destination is a supplier address, the value represents a party site name. When Destination is a ship-to address, the value represents a party site name for the customer address. The default value is null.
• DestinationExternalLocationSourceType: string
  Maximum Length: 2

  The value that uniquely identifies the selected kind of trading community architecture location. Valid values are SA for Supplier Address, ST for Ship-to Address, and null.
• DestinationExternalLocationSupplierId: integer
  The value that uniquely identifies the selected supplier when the Destination Type is a supplier address.
• DestinationExternalLocationSupplierName: string
  The name of the selected supplier when Destination Type is a supplier address.
• DestinationGeographyDescription: string
  The comma delimited concatenation of the geography hierarchy when Destination Type is Geography. The default value is null.
• DestinationGeographyId: integer (int64)
  The value that uniquely identifies the selected geography when Destination Type is Geography. The default value is null.
• DestinationGeographyName: string
  The name of the selected geography when Destination Type is Geography. The default value is null.
• DestinationInternalLocationCode: string
  The short name that identifies the selected warehouse location when Destination Type is Internal Location. Location Codes are only unique within a Location Set. The default value is null.
• DestinationInternalLocationId: integer (int64)
  The value that uniquely identifies the selected warehouse location when Destination Type is Internal Location. The default value is null.
• DestinationInternalLocationSetName: string
  The name of the set that the selected warehouse location was chosen from when Destination Type is Internal Location. The default value is null.
• DestinationTypeCode: string
  Title: Destination Type

  Maximum Length: 2

  The abbreviation that identifies the type of location for the destination of the shipping lane. This attribute is required. Valid values include LI for Internal Location, G for Geography, Z for Zone, and LE for External Location. A list of accepted values is defined in the lookup type WSH_ORG_DEST_TYPE. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
• DestinationZoneId: integer (int64)
  The value that uniquely identifies the selected zone when Destination Type is Zone. The default value is null.
• DestinationZoneName: string
  The name of the selected zone when Destination Type is Zone. The default value is null.
• 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.
• Origin: string
  Read Only: true

  The user supplied name of the selected origin location.
• OriginDescription: string
  Read Only: true

  The comma delimited concatenation of the primary attributes of the origin location such as street address, city, state and postal code.
• OriginExternalLocationCustomerName: string
  The name of the selected customer when the origin type is a ship-to address. The default value is null.
• OriginExternalLocationId: integer (int64)
  The value that uniquely identifies the selected address from the trading community architecture when Origin Type is External Location. It is the value of the LOCATION_ID column in the HZ_LOCATIONS table. The default value is null.
• OriginExternalLocationName: string
  The selected address from the trading community architecture when Origin Type is External Location. It is the value of the ADDRESS1 column in the HZ_LOCATIONS table. The default value is null.
• OriginExternalLocationShipToCustomerId: integer
  The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the origin is a ship-to address, the value represents a party identifier for the selected customer. The default value is null.
• OriginExternalLocationSourceId: integer
  The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the origin is a supplier address, the value represents a party site identifier. When the origin is a ship-to address, the value represents a party site identifier for the customer address. The default value is null.
• OriginExternalLocationSourceName: string
  The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the origin is a supplier address, the value represents a party site name. When the origin is a ship-to address, the value represents a party site name for the customer address. The default value is null.
• OriginExternalLocationSourceType: string
  Maximum Length: 2

  The value that uniquely identifies the specific kind of trading community architecture location has is selected. Valid values are SA for Supplier Address, ST for Ship-to Address, and null.
• OriginExternalLocationSupplierId: integer
  The value that uniquely identifies the selected supplier when the origin type is a supplier address.
• OriginExternalLocationSupplierName: string
  The name of the selected supplier when the origin type is a supplier address.
• OriginGeographyDescription: string
  The comma delimited concatenation of the geography hierarchy when Origin Type is Geography. The default value is null.
• OriginGeographyId: integer (int64)
  The value that uniquely identifies the selected geography when Origin Type is Geography. The default value is null.
• OriginGeographyName: string
  The name of the selected geography when Origin Type is Geography. The default value is null.
• OriginInternalLocationCode: string
  The abbreviation that identifies the selected warehouse location when Origin Type is Internal Location. Location codes are only unique within a location set. The default value is null.
• OriginInternalLocationId: integer (int64)
  The value that uniquely identifies the selected warehouse location when Origin Type is Internal Location. The default value is null.
• OriginInternalLocationSetName: string
  The name of the set that the selected warehouse location was chosen from when Origin Type is Internal Location. The default value is null.
• OriginTypeCode: string
  Title: Origin Type

  Maximum Length: 2

  The abbreviation that identifies the type of location for the origin of the shipping lane. This attribute is required. Valid values include LI for Internal Location, R for Geography, Z for Zone, and LE for External Location. A list of accepted values is defined in the lookup type WSH_ORG_DEST_TYPE. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.
• OriginZoneId: integer (int64)
  The value that uniquely identifies the selected zone when Origin Type is Zone. The default value is null.
• OriginZoneName: string
  The name of the selected zone when Origin Type is Zone. The default value is null.
• shippingMethods: array Shipping Methods
  Title: Shipping Methods

  The Shipping Methods resource gets the shipping method associated between the origin and destination locations.
• TransitTimeId: integer (int64)
  Read Only: true

  The value that uniquely identifies the transit time. It is a value that the application generates when it creates a transit time.

{
    "type":"object",
    "properties":{
        "Origin":{
            "type":"string",
            "description":"The user supplied name of the selected origin location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DestinationExternalLocationSourceType":{
            "maxLength":"2",
            "type":"string",
            "description":"The value that uniquely identifies the selected kind of trading community architecture location. Valid values are SA for Supplier Address, ST for Ship-to Address, and null.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginExternalLocationShipToCustomerId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the origin is a ship-to address, the value represents a party identifier for the selected customer. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "Destination":{
            "type":"string",
            "description":"The user supplied name of the selected destination location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginExternalLocationSupplierId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected supplier when the origin type is a supplier address.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginExternalLocationName":{
            "type":"string",
            "description":"The selected address from the trading community architecture when Origin Type is External Location. It is the value of the ADDRESS1 column in the HZ_LOCATIONS table. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationGeographyDescription":{
            "type":"string",
            "description":"The comma delimited concatenation of the geography hierarchy when Destination Type is Geography. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginExternalLocationSourceName":{
            "type":"string",
            "description":"The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the origin is a supplier address, the value represents a party site name. When the origin is a ship-to address, the value represents a party site name for the customer address. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationInternalLocationSetName":{
            "type":"string",
            "description":"The name of the set that the selected warehouse location was chosen from when Destination Type is Internal Location. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginGeographyId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected geography when Origin Type is Geography. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DestinationGeographyId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected geography when Destination Type is Geography. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DestinationExternalLocationSupplierId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected supplier when the Destination Type is a supplier address.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginInternalLocationId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected warehouse location when Origin Type is Internal Location. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DestinationExternalLocationSourceName":{
            "type":"string",
            "description":"The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When Destination is a supplier address, the value represents a party site name. When Destination is a ship-to address, the value represents a party site name for the customer address. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "TransitTimeId":{
            "type":"integer",
            "description":"The value that uniquely identifies the transit time. It is a value that the application generates when it creates a transit time.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OriginInternalLocationCode":{
            "type":"string",
            "description":"The abbreviation that identifies the selected warehouse location when Origin Type is Internal Location. Location codes are only unique within a location set. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationExternalLocationSourceId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When Destination is a supplier address, the value represents a party site identifier. When Destination is a ship-to address, the value represents a party site identifier for the customer address. The default value is null.",
            "nullable":true,
            "x-queryable":true
        },
        "DestinationExternalLocationCustomerName":{
            "type":"string",
            "description":"The name of the selected customer when the destination type is a ship-to address. The default value is null.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginTypeCode":{
            "title":"Origin Type",
            "maxLength":"2",
            "type":"string",
            "description":"The abbreviation that identifies the type of location for the origin of the shipping lane. This attribute is required. Valid values include LI for Internal Location, R for Geography, Z for Zone, and LE for External Location. A list of accepted values is defined in the lookup type WSH_ORG_DEST_TYPE. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OriginDescription":{
            "type":"string",
            "description":"The comma delimited concatenation of the primary attributes of the origin location such as street address, city, state and postal code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "shippingMethods":{
            "title":"Shipping Methods",
            "type":"array",
            "description":"The Shipping Methods resource gets the shipping method associated between the origin and destination locations.",
            "items":{
                "$ref":"#/components/schemas/transitTimes-shippingMethods-item-response"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginGeographyName":{
            "type":"string",
            "description":"The name of the selected geography when Origin Type is Geography. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationTypeCode":{
            "title":"Destination Type",
            "maxLength":"2",
            "type":"string",
            "description":"The abbreviation that identifies the type of location for the destination of the shipping lane. This attribute is required. Valid values include LI for Internal Location, G for Geography, Z for Zone, and LE for External Location. A list of accepted values is defined in the lookup type WSH_ORG_DEST_TYPE. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginGeographyDescription":{
            "type":"string",
            "description":"The comma delimited concatenation of the geography hierarchy when Origin Type is Geography. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginZoneName":{
            "type":"string",
            "description":"The name of the selected zone when Origin Type is Zone. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationDescription":{
            "type":"string",
            "description":"The comma delimited concatenation of the primary attributes of the destination location such as street address, city, state, and postal code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DestinationExternalLocationId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected address from the trading community architecture when Destination Type is External Location. It is the value of the LOCATION_ID column in the HZ_LOCATIONS table. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DestinationExternalLocationSupplierName":{
            "type":"string",
            "description":"The name of the selected supplier when Destination Type is a supplier address.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginInternalLocationSetName":{
            "type":"string",
            "description":"The name of the set that the selected warehouse location was chosen from when Origin Type is Internal Location. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginExternalLocationSupplierName":{
            "type":"string",
            "description":"The name of the selected supplier when the origin type is a supplier address.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationExternalLocationShipToCustomerId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the destination is a ship-to address, the value represents a party identifier for the selected customer. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationExternalLocationName":{
            "type":"string",
            "description":"The selected address from the trading community architecture when Destination Type is External Location. It is the value of the ADDRESS1 column in the HZ_LOCATIONS table. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginExternalLocationCustomerName":{
            "type":"string",
            "description":"The name of the selected customer when the origin type is a ship-to address. The default value is null.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginExternalLocationSourceType":{
            "maxLength":"2",
            "type":"string",
            "description":"The value that uniquely identifies the specific kind of trading community architecture location has is selected. Valid values are SA for Supplier Address, ST for Ship-to Address, and null.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginZoneId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected zone when Origin Type is Zone. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DestinationZoneId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected zone when Destination Type is Zone. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OriginExternalLocationSourceId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected trading community architecture record based upon the type of source used. When the origin is a supplier address, the value represents a party site identifier. When the origin is a ship-to address, the value represents a party site identifier for the customer address. The default value is null.",
            "nullable":true,
            "x-queryable":true
        },
        "DestinationGeographyName":{
            "type":"string",
            "description":"The name of the selected geography when Destination Type is Geography. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginExternalLocationId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected address from the trading community architecture when Origin Type is External Location. It is the value of the LOCATION_ID column in the HZ_LOCATIONS table. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DestinationInternalLocationId":{
            "type":"integer",
            "description":"The value that uniquely identifies the selected warehouse location when Destination Type is Internal Location. The default value is null.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationZoneName":{
            "type":"string",
            "description":"The name of the selected zone when Destination Type is Zone. The default value is null.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationInternalLocationCode":{
            "type":"string",
            "description":"The short name that identifies the selected warehouse location when Destination Type is Internal Location. Location Codes are only unique within a Location Set. The default value is null.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 gets the shipping method associated between the origin and destination locations.

Show Source

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

{
    "title":"Shipping Methods",
    "type":"array",
    "description":"The Shipping Methods resource gets the shipping method associated between the origin and destination locations.",
    "items":{
        "$ref":"#/components/schemas/transitTimes-shippingMethods-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : transitTimes-shippingMethods-item-response

Type: object

Show Source

• CostPerUnit: number
  Title: Cost per Unit

  The value that indicates the cost of moving one unit of an item between this origin and destination.
• CostPerUnitCurrencyCode: string
  Maximum Length: 15

  The abbreviation that identifies the currency of the cost per unit.
• 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.
• DailyVolumeCapacity: number
  Title: Daily Volume Capacity

  The value that indicates if moving a shipment from the origin to the destination is subject to a per day capacity limit for volume, and the quantity of that limit.
• DailyVolumeCapacityUnitOfMeasureCode: string
  Maximum Length: 3

  The abbreviation that identifies the unit of measure of the volume capacity.
• DailyVolumeCapacityUnitOfMeasureName: string
  The name of the unit of measure of the volume capacity.
• DailyWeightCapacity: number
  Title: Daily Weight Capacity

  The value that indicates if moving a shipment from the origin to the destination is subject to a per day capacity limit for weight, and the quantity of that limit.
• DailyWeightCapacityUnitOfMeasureCode: string
  Maximum Length: 3

  The abbreviation that identifies the unit of measure of the weight capacity.
• DailyWeightCapacityUnitOfMeasureName: string
  The name of the unit of measure of the weight capacity.
• DefaultShippingMethodFlag: boolean
  Title: Default shipping method

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the shipping method is the default choice among all defined between this origin and destination pairing. If false, then the shipping method is not the default. The default value is false.
• DFF: array Flexfields for Shipping Methods
  Title: Flexfields for Shipping Methods

  The Flexfields for Shipping Methods resource manages the descriptive flexfields for the shipping method.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ShippingMethod: string
  The user-visible value that uniquely identifies the carrier shipping method, as a concatenation of carrier name, service level, and mode of transport.
• ShippingMethodCode: string
  Maximum Length: 30

  The internal value that uniquely identifies the carrier shipping method, as a concatenation of carrier name, service level, and mode of transport.
• TransitTimeInDays: number
  Title: Transit Time in Days

  The value that uniquely identifies the transit time use of a shipping method. It is a value that the application generates when it assigns a shipping method to a transit time.
• TransitTimeValueId: integer (int64)
  The value that uniquely identifies the carrier shipping method. It is a value that the application generates when it creates a shipping method for a carrier. This maps to the same parameter in the parent Shipping Methods resource.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShippingMethod":{
            "type":"string",
            "description":"The user-visible value that uniquely identifies the carrier shipping method, as a concatenation of carrier name, service level, and mode of transport.",
            "nullable":true,
            "x-queryable":false
        },
        "DailyWeightCapacityUnitOfMeasureCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The abbreviation that identifies the unit of measure of the weight capacity.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DFF":{
            "title":"Flexfields for Shipping Methods",
            "type":"array",
            "description":"The Flexfields for Shipping Methods resource manages the descriptive flexfields for the shipping method.",
            "items":{
                "$ref":"#/components/schemas/transitTimes-shippingMethods-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DailyWeightCapacity":{
            "title":"Daily Weight Capacity",
            "type":"number",
            "description":"The value that indicates if moving a shipment from the origin to the destination is subject to a per day capacity limit for weight, and the quantity of that limit.",
            "nullable":true,
            "x-queryable":true
        },
        "TransitTimeInDays":{
            "title":"Transit Time in Days",
            "type":"number",
            "description":"The value that uniquely identifies the transit time use of a shipping method. It is a value that the application generates when it assigns a shipping method to a transit time.",
            "nullable":false,
            "x-queryable":true
        },
        "CostPerUnit":{
            "title":"Cost per Unit",
            "type":"number",
            "description":"The value that indicates the cost of moving one unit of an item between this origin and destination.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultShippingMethodFlag":{
            "title":"Default shipping method",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the shipping method is the default choice among all defined between this origin and destination pairing. If false, then the shipping method is not the default. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "DailyWeightCapacityUnitOfMeasureName":{
            "type":"string",
            "description":"The name of the unit of measure of the weight capacity.",
            "nullable":true,
            "x-queryable":false
        },
        "ShippingMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The internal value that uniquely identifies the carrier shipping method, as a concatenation of carrier name, service level, and mode of transport.",
            "nullable":false,
            "x-queryable":true
        },
        "DailyVolumeCapacityUnitOfMeasureCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The abbreviation that identifies the unit of measure of the volume capacity.",
            "nullable":true,
            "x-queryable":true
        },
        "TransitTimeValueId":{
            "type":"integer",
            "description":"The value that uniquely identifies the carrier shipping method. It is a value that the application generates when it creates a shipping method for a carrier. This maps to the same parameter in the parent Shipping Methods resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DailyVolumeCapacityUnitOfMeasureName":{
            "type":"string",
            "description":"The name of the unit of measure of the volume capacity.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CostPerUnitCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The abbreviation that identifies the currency of the cost per unit.",
            "nullable":true,
            "x-queryable":true
        },
        "DailyVolumeCapacity":{
            "title":"Daily Volume Capacity",
            "type":"number",
            "description":"The value that indicates if moving a shipment from the origin to the destination is subject to a per day capacity limit for volume, and the quantity of that limit.",
            "nullable":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
        }
    }
}

Nested Schema : Flexfields for Shipping Methods

Type: array

Title: Flexfields for Shipping Methods

The Flexfields for Shipping Methods resource manages the descriptive flexfields for the shipping method.

Show Source

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

{
    "title":"Flexfields for Shipping Methods",
    "type":"array",
    "description":"The Flexfields for Shipping Methods resource manages the descriptive flexfields for the shipping method.",
    "items":{
        "$ref":"#/components/schemas/transitTimes-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 : transitTimes-shippingMethods-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield context name for shipping methods.
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TransitTimeValueId: integer (int64)
  The value that uniquely identifies the transit time use of a shipping method. It is a value that the application generates when it assigns a shipping method to a transit time. This maps to the same parameter in the parent Shipping Methods resource.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransitTimeValueId":{
            "type":"integer",
            "description":"The value that uniquely identifies the transit time use of a shipping method. It is a value that the application generates when it assigns a shipping method to a transit time. This maps to the same parameter in the parent Shipping Methods resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "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
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for shipping methods.",
            "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
        }
    }
}

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

shippingMethods

Operation: /fscmRestApi/resources/11.13.18.05/transitTimes/{TransitTimeId}/child/shippingMethods

Parameters:

• TransitTimeId: $request.path.TransitTimeId

The Shipping Methods resource gets the shipping method associated between the origin and destination locations.

Back to Top

Examples

This example describes how to create one transit time.

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

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.

{
	"OriginTypeCode" : "Z", 
	"OriginZoneName" : "ZONE_RCS2", 
	"DestinationTypeCode" : "Z", 
	"DestinationZoneId" : 300100001867168, 
	"shippingMethods" : [ { 
		"TransitTimeInDays" : 3, 
		"ShippingMethod" : "UNITED PARCEL SERVICE, INC-Air-3 days select", 
		"DefaultShippingMethodFlag" : true, 
		"DailyWeightCapacity" : 24, 
		"DailyWeightCapacityUnitOfMeasureCode" : "EA", 
		"CostPerUnit" : 10, 
		"CostPerUnitCurrencyCode" : "USD", 
		"DailyVolumeCapacity" : 24, 
		"DailyVolumeCapacityUnitOfMeasureCode" : "CFT" 
	} ] 
}

Example Response Body

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

{
	"items" : [ {
		"TransitTimeId": 300100171426595, 
		"Origin": "ZONE_RCS2", 
		"OriginDescription": "ZONE_RCS2", 
		"OriginTypeCode": "Z", 
		"OriginGeographyId": null, 
		"OriginGeographyName": null, 
		"OriginGeographyDescription": null, 
		"OriginZoneId": 300100074237791, 
		"OriginZoneName": "ZONE_RCS2", 
		"OriginInternalLocationId": null, 
		"OriginInternalLocationCode": null, 
		"OriginInternalLocationSetName": null, 
		"OriginExternalLocationId": null, 
		"OriginExternalLocationName": null, 
		"OriginExternalLocationSourceType": null, 
		"OriginExternalLocationSourceId": null, 
		"OriginExternalLocationSourceName": null, 
		"OriginExternalLocationSupplierId": null, 
		"OriginExternalLocationSupplierName": null, 
		"DestinationTypeCode": "Z", 
		"Destination": "OP-Zone-CT", 
		"DestinationDescription": "OP-Zone-CT", 
		"DestinationGeographyId": null, 
		"DestinationGeographyName": null, 
		"DestinationGeographyDescription": null, 
		"DestinationZoneId": 300100001867168, 
		"DestinationZoneName": "OP-Zone-CT", 
		"DestinationInternalLocationId": null, 
		"DestinationInternalLocationCode": null, 
		"DestinationInternalLocationSetName": null, 
		"DestinationExternalLocationId": null, 
		"DestinationExternalLocationName": null, 
		"DestinationExternalLocationSourceType": null, 
		"DestinationExternalLocationSourceId": null, 
		"DestinationExternalLocationSourceName": null, 
		"DestinationExternalLocationSupplierId": null, 
		"DestinationExternalLocationSupplierName": null, 
		"shippingMethods": [ 
		{ 
			"TransitTimeValueId": 300100171426596, 
			"ShippingMethodCode": "000001_United Par_A_3DS", 
			"ShippingMethod": "UNITED PARCEL SERVICE, INC-Air-3 days select", 
			"TransitTimeInDays": 3, 
			"DefaultShippingMethodFlag": true, 
			"DailyWeightCapacity": 24, 
			"DailyWeightCapacityUnitOfMeasureCode": "EA", 
			"DailyWeightCapacityUnitOfMeasureName": "EA", 
			"CostPerUnit": 10, 
			"CostPerUnitCurrencyCode": "USD", 
			"DailyVolumeCapacity": 24, 
			"DailyVolumeCapacityUnitOfMeasureCode": "CFT", 
			"DailyVolumeCapacityUnitOfMeasureName": "CFT", 
			...
		} ],
		...
	}, {
		...
	} ],
	...
}

Back to Top