Create Pick Wave Rule

Creates a new pick wave rule.

POST /commerce/rules/pickwave

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,
  "endDate": "2023-11-07T05:31:56Z",
  "isActive": true,
  "name": "<string>",
  "productRules": [
    {
      "code": "<string>",
      "masterCatalogId": 123
    }
  ],
  "shipmentRules": [
    {
      "code": "<string>"
    }
  ],
  "startDate": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Body

application/json

Represents a rule for pick wave in the product administration system.

auditInfo · object

Show child attributes

code · string | null

Gets or sets the unique identifier of the PickWaveRule. If not given provided on create one will be assigned. Read-only after creation.

customerRules · string[] | null

Gets or sets the list of Customer Rule where the PickWaveRule applies.

description · string | null

Gets or sets the description of the PickWaveRule.

enabled · boolean | null

Gets or sets whether the PickWaveRule is enabled.

endDate · string<date-time> | null

End of the rule's effective window. Null = never expires. Must be >= StartDate when both supplied.

isActive · boolean | null

Read-only. Computed server-side: true when the current UTC instant is inside the effective window (StartDate null/≤now AND EndDate null/≥now), false otherwise. A rule with no dates is always active. This reflects the effective window alone and does not incorporate the enabled flag.

name · string | null

Gets or sets the name of the PickWaveRule.

productRules · object[] | null

Gets or sets the list of product rules associated with the PickWaveRule.

Show child attributes

shipmentRules · object[] | null

Gets or sets the list of Shipment Rule where the PickWaveRule applies.

Show child attributes

startDate · string<date-time> | null

Start of the rule's effective window. Null = no lower bound (already active).

Response

200

application/json

OK

Represents a rule for pick wave in the product administration system.

auditInfo · object

Show child attributes

code · string | null

Gets or sets the unique identifier of the PickWaveRule. If not given provided on create one will be assigned. Read-only after creation.

customerRules · string[] | null

Gets or sets the list of Customer Rule where the PickWaveRule applies.

description · string | null

Gets or sets the description of the PickWaveRule.

enabled · boolean | null

Gets or sets whether the PickWaveRule is enabled.

endDate · string<date-time> | null

End of the rule's effective window. Null = never expires. Must be >= StartDate when both supplied.

isActive · boolean | null

Read-only. Computed server-side: true when the current UTC instant is inside the effective window (StartDate null/≤now AND EndDate null/≥now), false otherwise. A rule with no dates is always active. This reflects the effective window alone and does not incorporate the enabled flag.

name · string | null

Gets or sets the name of the PickWaveRule.

productRules · object[] | null

Gets or sets the list of product rules associated with the PickWaveRule.

Show child attributes

shipmentRules · object[] | null

Gets or sets the list of Shipment Rule where the PickWaveRule applies.

Show child attributes

startDate · string<date-time> | null

Start of the rule's effective window. Null = no lower bound (already active).