Commit a plan's waves to the board

Turns proposed waves into real waves (Build, orders attached, then Queued). Orders that changed since planning are dropped and reported. Pass waveIds to commit a subset.

Parameters

idpathrequiredstring

Request body (optional)

waveIdsstring (uuid)[]

Responses

200Per-wave outcome

planIdstring (uuid)required

outcomesobject[]required

planWaveIdstring (uuid)required

proposedNamestringrequired

waveIdstring (uuid)required

waveNamestringrequired

committedOrdersnumberrequired

droppedOrdersobject[]required

orderIdstringrequired

reasonstringrequired

400Could not commit

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/3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10/commit' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "waveIds": [
    "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10"
  ]
}'

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

import requests

response = requests.post(
    "https://v3.revolutionstreetwxs.io/api/v3/plans/3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10/commit",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
    json={
      "waveIds": [
        "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10"
      ]
    },
)
data = response.json()

Response 200

{
  "planId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
  "outcomes": [
    {
      "planWaveId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "proposedName": "proposed name",
      "waveId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "waveName": "wave name",
      "committedOrders": 1.5,
      "droppedOrders": [
        {
          "orderId": "order id",
          "reason": "reason"
        }
      ]
    }
  ]
}