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

Documentation Index

Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt

Use this file to discover all available pages before exploring further.

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 bind service types to shipping target rules and/or product target rules

​
auditInfo
object
​
id
string | null

The system generated id of this shipping inclusion rule

​
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

​
shippingTargetRuleCodes
string[] | null

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

Response

Success

An object to bind service types to shipping target rules and/or product target rules

​
auditInfo
object
​
id
string | null

The system generated id of this shipping inclusion rule

​
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

​
shippingTargetRuleCodes
string[] | null

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