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
Root Schema : schema
Type:
Show Source
object
-
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.
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
Nested Schema : schema
Type:
Show Source
object
-
__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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : transitTimes-shippingMethods-item-response
Type:
Show Source
object
-
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.
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : transitTimes-shippingMethods-DFF-item-response
Type:
Show Source
object
-
__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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- DFF
-
Parameters:
- TransitTimeId:
$request.path.TransitTimeId
- TransitTimeValueId:
$request.path.TransitTimeValueId
The Flexfields for Shipping Methods resource manages the descriptive flexfields for the shipping method. - TransitTimeId: