Create Product Handling Fee Rule

Creates a new product handling fee rule

POST /commerce/shipping/admin/profiles/{profilecode}/rules/producthandlingfees

Error

A valid request URL is required to generate request examples

200

{
  "appliesTo": "<string>",
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "fulfillmentMethod": "<string>",
  "id": "<string>",
  "locationCodes": [
    "<string>"
  ],
  "productTargetRuleCodes": [
    "<string>"
  ],
  "sequence": 123,
  "serviceTypes": [
    {
      "code": "<string>",
      "content": {
        "localeCode": "<string>",
        "name": "<string>"
      },
      "deliveryDuration": "<string>"
    }
  ],
  "shippingTargetRuleCodes": [
    "<string>"
  ],
  "value": 123,
  "valueType": "<string>"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

profilecode · 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

appliesTo · string | null

The level at which this fee applies shippingrateorder

auditInfo · object

Show child attributes

fulfillmentMethod · string | null

Fulfillment method this rule applies to. ShipPickupDelivery

id · string | null

The system generated id for this rule

locationCodes · string[] | null

Optional location codes for Pickup/Delivery rules. Must be null for Ship rules. When empty/null for Pickup/Delivery, the rule applies to all locations.

productTargetRuleCodes · string[] | null

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

sequence · integer<int32>

The sequence in which this rule is preferred over others

serviceTypes · object[] | null

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

Show child attributes

shippingTargetRuleCodes · string[] | null

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

value · number<double>

The value of this fee

valueType · string | null

The type of this handling fee percentageflatrate

Response

200

application/json

Success

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

appliesTo · string | null

The level at which this fee applies shippingrateorder

auditInfo · object

Show child attributes

fulfillmentMethod · string | null

Fulfillment method this rule applies to. ShipPickupDelivery

id · string | null

The system generated id for this rule

locationCodes · string[] | null

Optional location codes for Pickup/Delivery rules. Must be null for Ship rules. When empty/null for Pickup/Delivery, the rule applies to all locations.

productTargetRuleCodes · string[] | null

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

sequence · integer<int32>

The sequence in which this rule is preferred over others

serviceTypes · object[] | null

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

Show child attributes

shippingTargetRuleCodes · string[] | null

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

value · number<double>

The value of this fee

valueType · string | null

The type of this handling fee percentageflatrate