Get shipment rule by code

Retrieves the details of a single shipment rule.

GET /commerce/rules/shipment/{code}

Error

A valid request URL is required to generate request examples

200

{
  "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>"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

code · string · required

The code of the rule.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

ruleType · string · required

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

Minimum string length: 1

auditInfo · object

Show child attributes

code · string | null

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

description · string | null

ShipmentRule description

expression · object

Category

Show child attributes

metaData · any | null

Additional metadata.

name · string | null

ShipmentRule name