Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the shipping method is active. If false, then the shipping method 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.

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

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/carriers-shippingMethods-DFF-item-patch-request"
    },
    "x-cardinality":"1"
}

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

• Array of: object carriers-shippingMethods-organizationAssociations-item-patch-request

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

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

{
    "type":"object",
    "properties":{
        "__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"
                }
            }
        }
    }
}

Nested Schema : carriers-shippingMethods-organizationAssociations-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : carriers-shippingMethods-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the shipping method is active. If false, then the shipping method 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.

{
    "type":"object",
    "properties":{
        "ServiceLevel":{
            "maxLength":"80",
            "type":"string",
            "description":"The value that indicates the priority of transportation that affects how quickly goods are transported. Valid values include Next day, Overnight, Express, or Door to Door. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "ServiceLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The value that indicates the priority of transportation that affects how quickly goods are transported. Valid values include Next day, Overnight, Express, or Door to Door. A list of accepted values is defined in the lookup type WSH_SERVICE_LEVELS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "organizationAssociations":{
            "title":"Shipping Method Organization Associations",
            "type":"array",
            "description":"The Shipping Method Organization Associations resource manages the inventory organizations that may use the shipping method.",
            "items":{
                "$ref":"#/components/schemas/carriers-shippingMethods-organizationAssociations-item-response"
            }
        },
        "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/carriers-shippingMethods-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ShipMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The value that uniquely identifies the carrier shipping method, as a concatenation of carrier name, service level and mode of transport.",
            "nullable":false,
            "readOnly":true,
            "default":" ",
            "x-queryable":true
        },
        "ActiveFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the shipping method is active. If false, then the shipping method is not active. The default value is true.",
            "nullable":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "ModeOfTransportCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The value that indicates the means used to deliver shipments to the customer. Valid values include Rail, Air, or Road. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationCarrierServiceId":{
            "type":"integer",
            "description":"The value that uniquely identifies the carrier shipping method. It is a value that the application generates when it creates a shipping method for a carrier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ModeOfTransport":{
            "maxLength":"80",
            "type":"string",
            "description":"The value that describes the means used to deliver shipments to the customer. Valid values include Rail, Air, or Road. A list of accepted values is defined in the lookup type WSH_MODE_OF_TRANSPORT. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Carriers Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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 carriers-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/carriers-shippingMethods-DFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

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

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

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

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__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
        },
        "OrgCarrierServiceId":{
            "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 attribute maps to the OrganizationCarrierServiceId parameter in the parent shippingMethods resource.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"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."
        }
    }
}

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

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

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

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

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

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

DFF

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

Parameters:

• CarrierId: $request.path.CarrierId
• ShipMethodCode: $request.path.ShipMethodCode

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

organizationAssociations

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

Back to Top