Route a package to a single lane

Runs the lane-selection algorithm for one package on the named sorter and returns the destination lane. Mirrors the wxs-2.0 get-lanes endpoint.

Parameters

sorterqueryrequiredstring

codequerystring

Responses

200Selected lane

lanesnumber[]required

laneNamestringrequired

matchedCriteriaNamestringrequired

reasonstringrequired

metaobjectrequired

requestIdstringrequired

endpointstringrequired

sorterstringrequired

codestring

modestringrequired

durationMsnumberrequired

pathobject[]

400Invalid code, or no lanes configured on the sorter

lanesnumber[]required

laneNamestringrequired

matchedCriteriaNamestringrequired

reasonstringrequired

metaobjectrequired

requestIdstringrequired

endpointstringrequired

sorterstringrequired

codestring

modestringrequired

durationMsnumberrequired

pathobject[]

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

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

Response 200

{
  "lanes": [
    1.5
  ],
  "laneName": "lane name",
  "matchedCriteriaName": "matched criteria name",
  "reason": "reason",
  "meta": {
    "requestId": "request id",
    "endpoint": "https://example.com/hook",
    "sorter": "sorter",
    "code": "A-01-02",
    "mode": "mode",
    "durationMs": 1.5,
    "path": [
      {}
    ]
  }
}