Skip to main content
PUT
/
commerce
/
rules
/
shipment
/
{code}
Error
A valid request URL is required to generate request examples
{
  "ruleType": "<string>",
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "code": "<string>",
  "description": "<string>",
  "expression": {
    "text": "<string>",
    "tree": {
      "left": "<string>",
      "logicalOperator": "<string>",
      "nodes": "<array>",
      "operator": "<string>",
      "right": "<unknown>",
      "type": "<string>"
    }
  },
  "metaData": "<unknown>",
  "name": "<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

​
code
string
required

The code of the rule to update.

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Body

application/json

The updated shipment rule.

​
ruleType
string
required

Parent rule category this shipment rule belongs to. Required on create and update.

Minimum string length: 1
​
auditInfo
object
​
code
string | null

Unique identifier of the ShipmentRule. System-supplied and read-only.

​
description
string | null

ShipmentRule description

​
expression
object

Category

​
metaData
any | null

Additional metadata.

​
name
string | null

ShipmentRule name

Response

OK

​
ruleType
string
required

Parent rule category this shipment rule belongs to. Required on create and update.

Minimum string length: 1
​
auditInfo
object
​
code
string | null

Unique identifier of the ShipmentRule. System-supplied and read-only.

​
description
string | null

ShipmentRule description

​
expression
object

Category

​
metaData
any | null

Additional metadata.

​
name
string | null

ShipmentRule name