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": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

The ScheduleAdjustment object allows you to customize the schedule by modifying orders before they are created. Schedule adjustments can be used to skip orders, change dates, update shipping, and more.

Actions

Define what modification to apply (skip, reschedule, update shipping, etc.)

Matchers

Define which orders to target (by cycle, date, or both)

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

action

object

required

Show child attributes

actor

object

required

Show child attributes

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

Documentation Index

Actions

Matchers

​Reference

Reference