Run a wave plan

Plans a day's orders at a location into waves and forecasts the labor. Defaults to tomorrow in the site timezone. Nothing is built until the plan is committed.

Request body (optional)

locationIdstring (uuid)required

planDatestring

headcountOverridesobject

rateSourceenum

standardobserved

Responses

201The plan and its proposed waves

planobjectrequired

idstring (uuid)required

locationIdstring (uuid)required

planDatestringrequired

horizonStartstringrequired

horizonEndstringrequired

statusenumrequired

draftcommittedsuperseded

sourceenumrequired

manualscheduledapi

assumptionsobjectrequired

summaryobjectrequired

diagnosticsobjectrequired

accuracyobjectrequired

committedAtstringrequired

createdAtstringrequired

updatedAtstringrequired

wavesobject[]required

idstring (uuid)required

sequencenumberrequired

proposedNamestringrequired

zoneIdstring (uuid)required

groupKeystringrequired

orderIdsstring (uuid)[]required

orderCountnumberrequired

lineCountnumberrequired

unitCountnumberrequired

estimatedMinutesnumberrequired

scheduledStartstringrequired

scheduledEndstringrequired

laborByZoneobjectrequired

committedWaveIdstring (uuid)required

400Could not plan

errorstringrequired

Sending requests from a browser

Open https://v3.revolutionstreetwxs.io/api/v3/docs to send requests to this endpoint with your API key.

Request

curl -X POST 'https://v3.revolutionstreetwxs.io/api/v3/plans' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "locationId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
  "planDate": "plan date",
  "headcountOverrides": {},
  "rateSource": "standard"
}'

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/plans", {
  method: "POST",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "locationId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
    "planDate": "plan date",
    "headcountOverrides": {},
    "rateSource": "standard"
  }),
});
const data = await response.json();

import requests

response = requests.post(
    "https://v3.revolutionstreetwxs.io/api/v3/plans",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
    json={
      "locationId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "planDate": "plan date",
      "headcountOverrides": {},
      "rateSource": "standard"
    },
)
data = response.json()

Response 201

{
  "plan": {
    "id": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
    "locationId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
    "planDate": "plan date",
    "horizonStart": "horizon start",
    "horizonEnd": "horizon end",
    "status": "draft",
    "source": "manual",
    "assumptions": {},
    "summary": {},
    "diagnostics": {},
    "accuracy": {},
    "committedAt": "committed at",
    "createdAt": "created at",
    "updatedAt": "updated at"
  },
  "waves": [
    {
      "id": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "sequence": 1.5,
      "proposedName": "proposed name",
      "zoneId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "groupKey": "group key",
      "orderIds": [
        "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10"
      ],
      "orderCount": 1.5,
      "lineCount": 10,
      "unitCount": 1.5,
      "estimatedMinutes": 1.5,
      "scheduledStart": "scheduled start",
      "scheduledEnd": "scheduled end",
      "laborByZone": {},
      "committedWaveId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10"
    }
  ]
}