Create a wave

Request body (optional)

idstring

namestring

statusenum

buildqueuedreadyactiveclosed

originenum

systemuser

locationIdstringrequired

zoneIdstringnullable

orderCountnumber

totalItemsnumber

pickedItemsnumber

putItemsnumber

Responses

201Created wave

idstring (uuid)required

namestringrequired

statusenumrequired

buildqueuedreadyactiveclosed

originenumrequired

systemuser

orderCountnumberrequired

totalItemsnumberrequired

pickedItemsnumberrequired

putItemsnumberrequired

createdByIdstring (uuid)required

closedAtstringrequired

createdAtstringrequired

updatedAtstringrequired

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/waves' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "id",
  "name": "Example",
  "status": "build",
  "origin": "user",
  "locationId": "location id",
  "zoneId": "zone id",
  "orderCount": 0,
  "totalItems": 0,
  "pickedItems": 0,
  "putItems": 0
}'

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/waves", {
  method: "POST",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "id",
    "name": "Example",
    "status": "build",
    "origin": "user",
    "locationId": "location id",
    "zoneId": "zone id",
    "orderCount": 0,
    "totalItems": 0,
    "pickedItems": 0,
    "putItems": 0
  }),
});
const data = await response.json();

import requests

response = requests.post(
    "https://v3.revolutionstreetwxs.io/api/v3/waves",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
    json={
      "id": "id",
      "name": "Example",
      "status": "build",
      "origin": "user",
      "locationId": "location id",
      "zoneId": "zone id",
      "orderCount": 0,
      "totalItems": 0,
      "pickedItems": 0,
      "putItems": 0
    },
)
data = response.json()

Response 201

{
  "id": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
  "name": "Example",
  "status": "build",
  "origin": "system",
  "orderCount": 1.5,
  "totalItems": 10,
  "pickedItems": 1.5,
  "putItems": 1.5,
  "createdById": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
  "closedAt": "closed at",
  "createdAt": "created at",
  "updatedAt": "updated at"
}