Report a container arriving at an induct point

Called by middleware/PLC integration when a box is detected at an induct. The induct code is configured per induct point in the 3D overview editor. The container is upserted by barcode and placed at the induct's position on the conveyor, which makes it appear live in the 3D view.

Parameters

codepathrequiredstring

Request body (optional)

barcodestringrequired

typeenum

totepalletcartonbinshelf

notesstring

Responses

200Arrival recorded

containerobjectrequired

idstring (uuid)required

barcodestringrequired

typeenumrequired

totepalletcartonbinshelf

statusenumrequired

availablein_usein_transitmaintenanceretired

currentConveyorIdstring (uuid)required

currentPathIdstringrequired

currentDistancenumberrequired

lastSeenAtstringrequired

inductobjectrequired

idstringrequired

codestring

conveyorIdstring (uuid)required

404Induct code 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/inducts/INDUCT-01/arrivals' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "barcode": "TOTE-000123",
  "type": "tote",
  "notes": "Example note"
}'

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/inducts/INDUCT-01/arrivals", {
  method: "POST",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "barcode": "TOTE-000123",
    "type": "tote",
    "notes": "Example note"
  }),
});
const data = await response.json();

import requests

response = requests.post(
    "https://v3.revolutionstreetwxs.io/api/v3/inducts/INDUCT-01/arrivals",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
    json={
      "barcode": "TOTE-000123",
      "type": "tote",
      "notes": "Example note"
    },
)
data = response.json()

Response 200

{
  "container": {
    "id": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
    "barcode": "0123456789012",
    "type": "tote",
    "status": "available",
    "currentConveyorId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
    "currentPathId": "current path id",
    "currentDistance": 1.5,
    "lastSeenAt": "last seen at"
  },
  "induct": {
    "id": "id",
    "code": "A-01-02",
    "conveyorId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10"
  }
}