Skip to main content

Order Commands

Manage orders.

order list​

List orders with paging controls.

mage-remote-run order list --page 1 --size 20

Options​

  • -p, --page <number>: Page number (default: 1)
  • -s, --size <number>: Page size (default: 20)
  • -f, --format <type>: Output format (text, json, xml) (default: text)

order search <query>​

Search orders by increment ID (LIKE match).

mage-remote-run order search 1000

order show <identifier>​

Show an order by internal ID or increment ID.

mage-remote-run order show 42
mage-remote-run order show 100000123 --format json

Options:

  • -f, --format <type>: text, json, or xml

order latest​

List recent orders sorted by created_at descending. Use interactive selection to open details.

mage-remote-run order latest --page 1 --size 20
mage-remote-run order latest --select

Options:

  • -p, --page <number>: Page number
  • -z, --size <number>: Page size
  • -s, --select: Interactive selection mode

order edit <id>​

Add a status history comment (prompts for status and comment).

mage-remote-run order edit 42

order cancel <id>​

Cancel an order.

mage-remote-run order cancel 42

order hold <id>​

Put an order on hold.

mage-remote-run order hold 42

order unhold <id>​

Release an order from hold.

mage-remote-run order unhold 42