API reference
- Getting Started with Your API
- SDKs and Toolkits
- GETGet Configured Shipping States
- PUTUpdate States
- GETGet Order Handling Fee Rule
- PUTUpdate Order Handling Fee Rule
- DELDelete Order Handling Fee Rule
- GETGet Order Handling Fee Rules
- POSTCreate Order Handling Fee Rule
- GETGet Product Handling Fee Rule
- PUTUpdate Product Handling Fee Rule
- DELDelete Product Handling Fee Rule
- GETGet Product Handling Fee Rules
- POSTCreate Product Handling Fee Rule
- GETGet Shipping Inclusion Rule
- PUTUpdate Shipping Inclusion Rule
- DELDelete Shipping Inclusion Rule
- GETGet Shipping Inclusion Rules
- POSTCreate Shipping Inclusion Rule
- GETGet Shipping Profiles
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>"
]
}Update Shipping Inclusion Rule
Updates an existing shipping inclusion rule
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
JWT Authorization header using the Bearer scheme.
Query Parameters
limits which fields are returned in the response body
Body
An object to bind service types to shipping target rules and/or product target rules
Show child attributes
Show child attributes
The system generated id of this shipping inclusion rule
the product target rule codes associated with this rule leave empty or null to denote all products
The sequence in which this rule is preferred over others
the servicetypes associated with this rule leave empty or null to denote all carriers and subsequent service types
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
The system generated id of this shipping inclusion rule
the product target rule codes associated with this rule leave empty or null to denote all products
The sequence in which this rule is preferred over others
the servicetypes associated with this rule leave empty or null to denote all carriers and subsequent service types
Show child attributes
Show child attributes
The shipping target rule codes associated with this rule leave empty or null to denote all destinations