Update one shipping method
patch
/fscmRestApi/resources/11.13.18.05/carriers/{CarrierId}/child/shippingMethods/{ShipMethodCode}
Request
Path Parameters
-
CarrierId(required): integer(int64)
The value that uniquely identifies the carrier. It is a primary key that the application generates when it creates a carrier.
-
ShipMethodCode(required): string
The value that uniquely identifies the carrier shipping method, as a concatenation of carrier name, service level and mode of transport.
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
-
ActiveFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the shipping method is active. If false, then the shipping method is not active. The default value is true. -
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. -
organizationAssociations: array
Shipping Method Organization Associations
Title:
Shipping Method Organization Associations
The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.
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 : Shipping Method Organization Associations
Type:
array
Title:
Shipping Method Organization Associations
The Shipping Method Organization Associations resource manages the inventory organizations that may use 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
Nested Schema : carriers-shippingMethods-organizationAssociations-item-patch-request
Type:
Show Source
object
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.
Root Schema : carriers-shippingMethods-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the shipping method is active. If false, then the shipping method is not active. The default value is true. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
DFF: array
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. -
ModeOfTransport: string
Read Only:
true
Maximum Length:80
The value that describes the means used to deliver shipments to the customer. Valid values include Rail, Air, or Road. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task. -
ModeOfTransportCode: string
Maximum Length:
30
The value that indicates the means used to deliver shipments to the customer. Valid values include Rail, Air, or Road. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task. -
organizationAssociations: array
Shipping Method Organization Associations
Title:
Shipping Method Organization Associations
The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method. -
OrganizationCarrierServiceId: integer
(int64)
Read Only:
true
The value that uniquely identifies the carrier shipping method. It is a value that the application generates when it creates a shipping method for a carrier. -
ServiceLevel: string
Read Only:
true
Maximum Length:80
The value that indicates the priority of transportation that affects how quickly goods are transported. Valid values include Next day, Overnight, Express, or Door to Door. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task. -
ServiceLevelCode: string
Maximum Length:
30
The value that indicates the priority of transportation that affects how quickly goods are transported. Valid values include Next day, Overnight, Express, or Door to Door. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task. -
ShipMethodCode: string
Read Only:
true
Maximum Length:30
Default Value:The value that uniquely identifies the carrier shipping method, as a concatenation of carrier name, service level and mode of transport.
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 : Shipping Method Organization Associations
Type:
array
Title:
Shipping Method Organization Associations
The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.
Show Source
Nested Schema : carriers-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. -
OrgCarrierServiceId: integer
(int64)
Read Only:
true
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 attribute maps to the OrganizationCarrierServiceId parameter in the parent shippingMethods 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.
Nested Schema : carriers-shippingMethods-organizationAssociations-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCarrierServiceId: integer
(int64)
Read Only:
true
The value that uniquely identifies the carrier shipping method assigned to an organization. It is a value that the application generates when it assigns a shipping method for a carrier to an organization. -
OrganizationCode: string
Maximum Length:
18
The value that uniquely identifies the inventory organization as an abbreviation. Either this attribute or OrganizationId is required. -
OrganizationId: integer
(int64)
The value that uniquely identifies the inventory organization assigned to a carrier shipping method. Either this attribute or OrganizationCode is required.
-
OrganizationName: string
Maximum Length:
240
The name of the inventory organization.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- DFF
-
Parameters:
- CarrierId:
$request.path.CarrierId
- ShipMethodCode:
$request.path.ShipMethodCode
The Flexfields for Shipping Methods resource manages the descriptive flexfields for the shipping method. - CarrierId:
- organizationAssociations
-
Parameters:
- CarrierId:
$request.path.CarrierId
- ShipMethodCode:
$request.path.ShipMethodCode
The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method. - CarrierId: