Jump to

• Request
• Response

Update a shipping method

patch

/fscmRestApi/resources/11.13.18.05/transitTimes/{TransitTimeId}/child/shippingMethods/{TransitTimeValueId}

Request

Path Parameters

• TransitTimeId(required): integer(int64)
  The value that uniquely identifies the transit time. It is a value that the application generates when it creates a transit time.
• TransitTimeValueId(required): 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.

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

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

{
    "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-patch-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
        },
        "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-patch-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-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"
    }
}

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."
        }
    }
}

Links

DFF

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

Parameters:

• TransitTimeId: $request.path.TransitTimeId
• TransitTimeValueId: $request.path.TransitTimeValueId

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

Back to Top