Release planned orders

Moves planned orders to pending so they become eligible for waving. Pass ids, or due: true for every order whose releaseAt has passed, or shipDay (YYYY-MM-DD, site timezone) for every planned order shipping that day.

Request body (optional)

idsstring (uuid)[]required

Responses

200Released orders

releasednumberrequired

idsstring (uuid)[]required

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

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

import requests

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

Response 200

{
  "released": 1.5,
  "ids": [
    "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10"
  ]
}