Update a wave

Parameters

idpathrequiredstring

Request body (optional)

namestring

statusenum

buildqueuedreadyactiveclosed

originenum

systemuser

zoneIdstringnullable

orderCountnumber

totalItemsnumber

pickedItemsnumber

putItemsnumber

closedAtstringnullable

Responses

200Updated 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 PATCH 'https://v3.revolutionstreetwxs.io/api/v3/waves/3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example",
  "status": "build",
  "origin": "system",
  "zoneId": "zone id",
  "orderCount": 1.5,
  "totalItems": 10,
  "pickedItems": 1.5,
  "putItems": 1.5,
  "closedAt": "closed at"
}'

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/waves/3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Example",
    "status": "build",
    "origin": "system",
    "zoneId": "zone id",
    "orderCount": 1.5,
    "totalItems": 10,
    "pickedItems": 1.5,
    "putItems": 1.5,
    "closedAt": "closed at"
  }),
});
const data = await response.json();

import requests

response = requests.patch(
    "https://v3.revolutionstreetwxs.io/api/v3/waves/3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
    json={
      "name": "Example",
      "status": "build",
      "origin": "system",
      "zoneId": "zone id",
      "orderCount": 1.5,
      "totalItems": 10,
      "pickedItems": 1.5,
      "putItems": 1.5,
      "closedAt": "closed at"
    },
)
data = response.json()

Response 200

{
  "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"
}