Open Revolution St

REST API

REST API reference

Base URL https://v3.revolutionstreetwxs.io/api/v3. Requests are authenticated with an API key (see Authentication). This reference is generated from the API's OpenAPI document, which the server serves at https://v3.revolutionstreetwxs.io/api/v3/openapi.json. You can also download it here.

Auth

POST/auth/tokenExchange a workload identity token for an access token

Billing

GET/invoicesList invoices GET/invoices/{id}Get an invoice with its lines

Bins

GET/binsList all bins POST/binsUpsert a bin by code DELETE/bins/{code}Delete a bin by code

Clients

GET/clientsList all 3PL clients POST/clientsUpsert a client by code GET/clients/{id}Get a client by ID DELETE/clients/{id}Delete a client

Containers

GET/containersList all containers POST/containersUpsert a container by barcode GET/containers/{id}Get a container by ID PATCH/containers/{id}Update a container DELETE/containers/{id}Delete a container POST/containers/by-barcode/{barcode}/status-overrideOverride a container's status by barcode POST/containers/by-barcode/{barcode}/weight-overrideOverride a container's weight by barcode

Custom Field Values

GET/custom-field-valuesList custom field values for an entity POST/custom-field-valuesUpsert a single custom field value PUT/custom-field-valuesBulk set custom field values for an entity DELETE/custom-field-values/{id}Clear a custom field value

Events

GET/events/typesList ingestable event types POST/eventsIngest a single event POST/events/batchIngest a batch of events

Export

GET/export/datasetsList exportable datasets GET/export/datasets/{dataset}Describe a dataset GET/export/{dataset}Export a page of a dataset POST/export/{dataset}Export a page of a dataset (JSON body)GET/export/specExport the rows behind a chart POST/export/sqlExport the result of a read-only ClickHouse query

Inbound

GET/asnsList ASNs POST/asnsCreate an ASN with lines GET/asns/{id}Get an ASN with its lines PATCH/asns/{id}Update an ASN (header fields or status)DELETE/asns/{id}Cancel an ASN GET/purchase-ordersList purchase orders POST/purchase-ordersCreate a purchase order with lines GET/purchase-orders/{id}Get a purchase order with its lines PATCH/purchase-orders/{id}Update a purchase order DELETE/purchase-orders/{id}Cancel a purchase order

Inducts

POST/inducts/{code}/arrivalsReport a container arriving at an induct point

Inventory

GET/productsList all products POST/productsUpsert a product by SKU GET/products/{id}Get a product by ID DELETE/products/{id}Delete a product

Locations

GET/locationsList all locations POST/locationsCreate a location GET/locations/{id}Get a location by ID PATCH/locations/{id}Update a location DELETE/locations/{id}Delete a location

Orders

GET/ordersList orders POST/ordersCreate an order POST/orders/batchUpsert a batch of orders POST/orders/releaseRelease planned orders GET/orders/{id}Get an order by ID PATCH/orders/{id}Update an order GET/orders/{id}/linesList an order's lines

Plans

GET/plansList wave plans POST/plansRun a wave plan GET/plans/{id}Get a wave plan with its waves DELETE/plans/{id}Delete a draft plan POST/plans/{id}/commitCommit a plan's waves to the board

Print

POST/printSend a ZPL label to a printer or printer group

Rate Shopping

POST/rates/shopShop shipping rates across all enabled carrier accounts GET/rates/carriersList configured carrier accounts and their shoppable services

Sortation

GET/sortation/lanes/get-lanesRoute a package to a single lane GET/sortation/lanes/multi/get-lanesRoute a package, returning all eligible lanes GET/sortation/lanes/get-enabledList enabled lane numbers for a sorter GET/sortation/lanes/get-hospitalGet the hospital lane number for a sorter GET/sortation/lanes/get-statusGet per-lane enabled + PLC availability status GET/sortation/get-modeGet a sorter's mode GET/sortation/update-modeSet a sorter's mode GET/sortation/get-sorter-configGet a sorter's full configuration

Walls

GET/wallsList all walls POST/wallsCreate a wall GET/walls/{id}Get a wall by ID PATCH/walls/{id}Update a wall DELETE/walls/{id}Delete a wall

Waves

GET/wavesList all waves POST/wavesCreate a wave GET/waves/{id}Get a wave by ID PATCH/waves/{id}Update a wave DELETE/waves/{id}Delete a wave

Webhooks

GET/webhooksList all webhooks POST/webhooksCreate a webhook PATCH/webhooks/{id}Update a webhook DELETE/webhooks/{id}Delete a webhook POST/webhooks/{id}/testTest a webhook

Zones

GET/zonesList all zones POST/zonesCreate a zone GET/zones/{id}Get a zone by ID PATCH/zones/{id}Update a zone DELETE/zones/{id}Delete a zone