List all containers

Responses

200List of containers

dataobject[]required

idstring (uuid)required

barcodestringrequired

typeenumrequired

totepalletcartonbinshelf

statusenumrequired

availablein_usein_transitmaintenanceretired

binIdstring (uuid)required

zoneIdstring (uuid)required

notesstringrequired

currentConveyorIdstring (uuid)required

currentPathIdstringrequired

currentDistancenumberrequired

lastScanPointIdstring (uuid)required

lastSeenAtstringrequired

simulationStatusstringrequired

createdAtstringrequired

updatedAtstringrequired

customFieldsobjectrequired

Custom field values keyed by field name. Every defined container field is present; null when unset.

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/containers' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY"

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/containers", {
  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/containers",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
)
data = response.json()

Response 200

{
  "data": [
    {
      "id": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "barcode": "0123456789012",
      "type": "tote",
      "status": "available",
      "binId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "zoneId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "notes": "Example note",
      "currentConveyorId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "currentPathId": "current path id",
      "currentDistance": 1.5,
      "lastScanPointId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "lastSeenAt": "last seen at",
      "simulationStatus": "simulation status",
      "createdAt": "created at",
      "updatedAt": "updated at",
      "customFields": {}
    }
  ]
}