Skip to content

oms.outbound-order

Outbound orders and their charges. Export brokerage work attaches to these orders, and a charge is an intermediate record from before it becomes an invoice.

18 endpoints - system oms - module gate applies

What this module covers - Outbound orders, items and charges, transloads, companies.

Endpoints

Method Path What it does Evidence
GET /oms/export-brokerage/bookings/search Search the bookings eligible for export brokerage handler oms_export_brokerage_api_assert_workflow_enabled() · calls mk-export-brokerage.php
POST /oms/export-brokerage/documents/ai-extract Extract items from brokerage documents with AI handler oms_export_brokerage_api_assert_workflow_enabled() · calls api_catalog.php
POST /oms/export-brokerage/jobs/cancel Cancel an export brokerage job handler oms_export_brokerage_api_assert_workflow_enabled() · calls mk-export-brokerage.php
POST /oms/export-brokerage/jobs Create an export brokerage job handler oms_export_brokerage_api_assert_workflow_enabled() · calls mk-export-brokerage.php
GET /oms/outbound-orders List outbound orders handler omsOutboundOrderQueryHandle() · calls api_catalog.php, mk-order-schedule.php
GET /oms/outbound-orders/options Read the outbound order input options handler omsOutboundOrderQueryHandle() · calls mk-outbound-order-editor.js, scale-portal.js
POST /oms/outbound-orders Register an outbound order handler omsOutboundOrderPostHandle() · calls api_catalog.php, mk-order-schedule.php
GET /oms/outbound-orders/schedule Read the schedule of an outbound order handler omsOutboundOrderQueryHandle() · calls mk-order-schedule.php
POST /oms/outbound-orders/(?P<id>\d+)/atomic-save Save an outbound order and its items in one transaction handler apiAssertAdvancedPayloadDeletion()
GET /oms/outbound-orders/(?P<id>\d+)/costs List the charges on an outbound order handler omsOutboundOrderQueryHandle()
POST /oms/outbound-orders/(?P<id>\d+)/costs Add a charge to an outbound order handler omsOutboundCostPostRoute()
DELETE /oms/outbound-orders/(?P<id>\d+)/costs/(?P<transactionId>\d+) Delete a charge from an outbound order handler omsOutboundCostPostRoute()
DELETE /oms/outbound-orders/(?P<id>\d+) Delete an outbound order handler omsOutboundOrderPostHandle()
GET /oms/outbound-orders/(?P<id>\d+) Read an outbound order in detail handler omsOutboundOrderQueryHandle()
POST /oms/outbound-orders/(?P<id>\d+)/items Add an item to an outbound order handler omsOutboundOrderPostHandle()
DELETE /oms/outbound-orders/(?P<id>\d+)/items/(?P<itemId>\d+) Delete an item from an outbound order handler omsOutboundOrderPostHandle()
PATCH /oms/outbound-orders/(?P<id>\d+)/items/(?P<itemId>\d+) Edit an item on an outbound order handler omsOutboundOrderPostHandle()
PATCH /oms/outbound-orders/(?P<id>\d+) Edit an outbound order handler omsOutboundOrderPostHandle()

Topics this module shares with other modules

The description is a summary read off the route path, the handler, the tables it reaches and the screens that call it. Nothing is guessed without evidence: where the handler has to be read, it says so. The full evidence is on each endpoint page.