Skip to main content
PUT
/
commerce
/
shipping
/
admin
/
profiles
/
{profilecode}
/
rules
/
orderhandlingfees
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "sequence": 123,
  "shippingTargetRuleCodes": [
    "<string>"
  ],
  "productTargetRuleCodes": [
    "<string>"
  ],
  "serviceTypes": [
    {
      "code": "<string>",
      "deliveryDuration": "<string>",
      "content": {
        "localeCode": "<string>",
        "name": "<string>"
      }
    }
  ],
  "valueType": "<string>",
  "appliesTo": "<string>",
  "value": 123,
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

profilecode
string
required
id
string
required

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

application/json

An object to group a handling fee with zones, rules, and servicetypes

id
string | null

The system generated id for this rule

sequence
integer<int32>

The sequence in which this rule is preferred over others

shippingTargetRuleCodes
string[] | null

The shipping target rule codes associated with this rule leave empty or null to denote all destinations

productTargetRuleCodes
string[] | null

the product target rule codes associated with this rule leave empty or null to denote all products

serviceTypes
object[] | null

the servicetypes associated with this rule leave empty or null to denote all carriers and subsequent service types

valueType
string | null

The type of this handling fee percentageflatrate

appliesTo
string | null

The level at which this fee applies shippingrateorder

value
number<double>

The value of this fee

auditInfo
object

Response

Success

An object to group a handling fee with zones, rules, and servicetypes

id
string | null

The system generated id for this rule

sequence
integer<int32>

The sequence in which this rule is preferred over others

shippingTargetRuleCodes
string[] | null

The shipping target rule codes associated with this rule leave empty or null to denote all destinations

productTargetRuleCodes
string[] | null

the product target rule codes associated with this rule leave empty or null to denote all products

serviceTypes
object[] | null

the servicetypes associated with this rule leave empty or null to denote all carriers and subsequent service types

valueType
string | null

The type of this handling fee percentageflatrate

appliesTo
string | null

The level at which this fee applies shippingrateorder

value
number<double>

The value of this fee

auditInfo
object