Get an order by ID

Parameters

idpathrequiredstring

Responses

200Order details

idstring (uuid)required

orderNumberstringrequired

clientIdstring (uuid)required

locationIdstring (uuid)required

statusenumrequired

plannedpendingprocessingpickingpackingshippeddeliveredcancelled

priorityenumrequired

lownormalhighurgent

customerNamestringrequired

customerEmailstringrequired

totalItemsnumberrequired

pickedItemsnumberrequired

lineCountnumberrequired

waveIdstring (uuid)required

containerIdstring (uuid)required

orderDatestringrequired

shipBystringrequired

releaseAtstringrequired

carrierstringrequired

servicestringrequired

externalRefstringrequired

skipWavebooleanrequired

prioritySwapCountnumberrequired

notesstringrequired

createdAtstringrequired

updatedAtstringrequired

shippedAtstringrequired

404Not found

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 GET 'https://v3.revolutionstreetwxs.io/api/v3/orders/3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY"

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/orders/3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10", {
  method: "GET",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
  },
});
const data = await response.json();

import requests

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

Response 200

{
  "id": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
  "orderNumber": "ORD-10042",
  "clientId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
  "locationId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
  "status": "planned",
  "priority": "low",
  "customerName": "Acme Distribution",
  "customerEmail": "ops@example.com",
  "totalItems": 10,
  "pickedItems": 1.5,
  "lineCount": 10,
  "waveId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
  "containerId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
  "orderDate": "order date",
  "shipBy": "ship by",
  "releaseAt": "release at",
  "carrier": "UPS",
  "service": "Ground",
  "externalRef": "external ref",
  "skipWave": true,
  "prioritySwapCount": 1,
  "notes": "Example note",
  "createdAt": "created at",
  "updatedAt": "updated at",
  "shippedAt": "shipped at"
}