Override a container's status by barcode

Hospital endpoint: set the container status and/or record a carton status. At least one of status / cartonStatus is required. cartonStatus is stored as the carton_status custom field.

Parameters

barcodepathrequiredstring

Request body (optional)

statusenum

availablein_usein_transitmaintenanceretired

cartonStatusstring

Responses

200Updated container

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.

400Invalid override

errorstringrequired

404Container not 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 POST 'https://v3.revolutionstreetwxs.io/api/v3/containers/by-barcode/0123456789012/status-override' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "available",
  "cartonStatus": "carton status"
}'

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/containers/by-barcode/0123456789012/status-override", {
  method: "POST",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "status": "available",
    "cartonStatus": "carton status"
  }),
});
const data = await response.json();

import requests

response = requests.post(
    "https://v3.revolutionstreetwxs.io/api/v3/containers/by-barcode/0123456789012/status-override",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
    json={
      "status": "available",
      "cartonStatus": "carton status"
    },
)
data = response.json()

Response 200

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