API reference

Endpoints for all six apps. Base URL https://api.bodegito.com/v1 — Beta: endpoints follow the OpenAPI snapshot.

Beta — this reference may lag the live OpenAPI snapshot (/api/openapi.json). In case of conflict, the snapshot wins.

Conventions

  • Pagination: ?page=&page_size= (default 20, max 200). Filtering: ?filter[field]=value. Sorting: ?sort=-created_at.
  • Envelope: every list returns {data, page, page_size, total}. Every write returns the created/updated resource.
  • Idempotency: POST endpoints accept Idempotency-Key header — safe to retry webhooks and order creation.

WMS

GET/wms/inventoryQuery on-hand inventory (by sku / warehouse / location)filter[sku], filter[warehouse_id]
POST/wms/inventory/adjustAdjust inventory (reason required, audit-logged)sku, warehouse_id, qty_delta, reason
GET/wms/receiptsList inbound receipts
POST/wms/receiptsCreate inbound receiptmerchant_id, warehouse_id, lines[]
POST/wms/receipts/{id}/receiveReceive lines (build pallets, print LPN labels)lines[{sku, qty_received, pallet_id}]
GET/wms/shipmentsList outbound shipments
POST/wms/shipmentsCreate outbound shipmentmerchant_id, warehouse_id, lines[]
POST/wms/shipments/{id}/shipShip (deduct inventory, print packing list)
POST/wms/shipments/{id}/deliverConfirm delivery (terminal state)delivered_at, signed_by
GET/wms/wavesList waves
POST/wms/waves/releaseRelease a wave (create pick tasks)wave_id
GET/wms/loadsList loads (LTL/TL)
POST/wms/loads/{id}/shipShip load (generate VICS BOL)

OMS

GET/oms/ordersList sales ordersfilter[status], filter[merchant_id]
POST/oms/ordersCreate sales ordermerchant_id, channel, lines[]
POST/oms/orders/{id}/releaseRelease order to WMS
GET/oms/inventoryQuery OMS inventory (standalone mode) or WMS-synced view
POST/oms/inventory/adjustAdjust OMS inventory (standalone mode only)
GET/oms/channels/connectionsList channel connections
POST/oms/channels/connectionsCreate channel connectionchannel, credentials, sync_scopes[]
POST/oms/channels/connections/{id}/testTest channel connectivity
GET/oms/product-mappingsList channel SKU mappings
POST/oms/product-mappingsCreate SKU mappingconnection_id, channel_sku, oms_product_id
POST/oms/sync/inventoryPush available-to-promise to channelsconnection_id
POST/oms/sync/productsPush product info to channelsconnection_id, product_ids[]

Purchase

GET/purchase/ordersList purchase ordersfilter[status], filter[merchant_id]
POST/purchase/ordersCreate purchase ordervendor_id, merchant_id, lines[]
POST/purchase/orders/{id}/releaseRelease PO to WMS (create inbound receipt)
GET/purchase/asnsList ASNs
POST/purchase/asnsCreate ASNpo_id, merchant_id, eta
GET/purchase/vendorsList vendors (shared across tenants)
POST/purchase/vendorsCreate vendorname, contact

YMS

GET/yms/appointmentsList appointmentsfilter[date], filter[type]
POST/yms/appointmentsCreate appointmentcarrier, plate, container_no, window_start, window_end
POST/yms/appointments/{id}/check-inCheck in at gate
POST/yms/gate-entriesRecord gate entry/exitplate, direction, appointment_id
GET/yms/movementsList yard move tasks
POST/yms/movementsCreate move tasktrailer_id, to_location
POST/yms/movements/{id}/completeComplete move task
GET/yms/yard-mapYard spot occupancy map

TMS

GET/tms/ordersList transport orders
POST/tms/ordersCreate transport order (usually from WMS load)load_id, origin, destination
POST/tms/orders/{id}/assignAssign carriercarrier_id, rate
GET/tms/orders/{id}/trackingTrack in-transit status
POST/tms/orders/{id}/podUpload proof of deliverypod_files[]
GET/tms/carriersList carriers
GET/tms/freight-billsFreight bills (with per-merchant split lines)

Drayage

GET/drayage/ordersList drayage ordersfilter[merchant_id]
POST/drayage/ordersCreate drayage ordermerchant_id, container_no, pickup, delivery
POST/drayage/orders/{id}/completeComplete (creates WMS inbound receipt)
GET/drayage/containersTrack containers
GET/drayage/containers/{no}/eventsContainer event timeline

Create an order

Request
POST /v1/oms/orders
{
  "merchant_id": "mch_acme",
  "channel": "shopify",
  "lines": [{ "sku": "ACME-WIDGET-01", "qty": 10 }]
}
Response
201 Created
{ "id": "so_9f31", "status": "draft",
  "merchant_id": "mch_acme", "lines": [...] }