Refresh a sales order
Dispatch a background refresh for a single active sales order — the same pipeline
used by the admin order:refresh Artisan command. The job pulls shipping updates,
recalculates quantities, deletes unpushed fulfillment orders, and auto-generates
new ones.
The endpoint validates and queues the work, then returns immediately; the refresh
itself runs asynchronously on the order-refresh queue.
Only active sales orders (status > 0) can be refreshed. Requests targeting
completed, cancelled, or deleted orders return 404.
Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
Sales order ID
Body
When true, the order's skip_inventory flag is set to false before
the refresh runs, so fulfillment-order creation can take place.
When true, the refresh job deletes all existing shipments (including
pushed ones) before regenerating fulfillment orders. Use with care.
Response
Refresh job dispatched