Schedule adjustment resource - Developer documentation

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource": "schedule_adjustment",
  "customer": "<string>",
  "matcher": {
    "type": "<string>",
    "input": "<unknown>"
  },
  "action": {
    "type": "<string>",
    "input": "<unknown>"
  },
  "actor": {
    "type": "staff",
    "id": "<unknown>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

The ScheduleAdjustment object allows to customize the schedule by modifying orders before they are created. Currently, schedule adjustments can be used to skip orders for specific cycles or dates, giving you control over when deliveries occur.

Reference

string<uuid>

required

The adjustment identifier

resource

enum<string>

required

Available options:

schedule_adjustment

customer

string

required

The customer identifier

Minimum string length: 1

matcher

object

required

Show child attributes

matcher.type

string

required

Minimum string length: 1

matcher.input

any

required

action

object

required

Show child attributes

action.type

string

required

Minimum string length: 1

action.input

any

required

actor

object

required

Show child attributes

actor.type

enum<string>

required

Available options:

staff,

customer,

system,

bulk-action,

api

actor.id

null | string

required

The actor identifier, if applicable

createdAt

string<date-time>

required

Creation date of the adjustment

updatedAt

string<date-time>

required

Last update date of the adjustment

Get schedule List schedule adjustments

⌘I

Core Resources

​Reference

Reference