Get future shipment rebalancing rule by code

Gets a future shipment rebalancing rule details by code.

GET /commerce/rules/futureshipmentrebalancing/{code}

Error

A valid request URL is required to generate request examples

200

{
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "code": "<string>",
  "customerRules": [
    "<string>"
  ],
  "description": "<string>",
  "enabled": true,
  "metaData": null,
  "name": "<string>",
  "productRules": [
    {
      "code": "<string>",
      "masterCatalogId": 123
    }
  ],
  "rank": 123,
  "shipmentRules": [
    {
      "code": "<string>"
    }
  ],
  "sortAttribute": "<string>"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

code · string · required

The unique rule code.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Rule found.

Contract DTO for a FutureShipmentRebalancing rule. Rules determine priority ordering for shipments in the Future Shipments Queue when supply changes trigger rebalancing.

auditInfo · object

Show child attributes

code · string | null

customerRules · string[] | null

description · string | null

enabled · boolean | null

metaData · unknown

name · string | null

productRules · object[] | null

Show child attributes

rank · integer<int32> | null

shipmentRules · object[] | null

Show child attributes

sortAttribute · string | null