Get future shipment rebalancing rules

Gets a collection of future shipment rebalancing rules according to any specified filter criteria and sort options.

GET /commerce/rules/futureshipmentrebalancing

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "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>"
    }
  ],
  "pageCount": 123,
  "pageSize": 123,
  "startIndex": 123,
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

startIndex · integer<int32> · default: 0

Zero-based start index for pagination.

pageSize · integer<int32> · default: 0

Number of items per page.

sortBy · string

Sort expression (e.g. 'rank asc').

filter · string

Filter expression (e.g. 'enabled eq true').

responseGroups · string

Response groups (currently unused).

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Rule collection returned successfully.

Paginated collection of Mozu.ProductAdmin.Contracts.FutureShipmentRebalancingRules.FutureShipmentRebalancingRule contract DTOs.

items · object[] | null

Show child attributes

pageCount · integer<int32>

pageSize · integer<int32>

startIndex · integer<int32>

totalCount · integer<int32>