Magento - Update Order

Description

This module allows performing actions on orders: add comments, cancel, hold, invoice, create shipments, and refunds.

Configuration

Field	Type	Required	Description
credentials_id	string	Yes	Credentials ID
order_id	string	Yes	Order ID (entity_id)
action	string	No	Action to perform
status	string	No	New status
comment	string	No	Order comment
notify_customer	boolean	No	Notify the customer
visible_on_front	boolean	No	Visible to customer
tracking_number	string	No	Tracking number
carrier_code	string	No	Carrier code
carrier_title	string	No	Carrier name
capture_payment	boolean	No	Capture payment when invoicing

Credentials

Field	Description
store_url	Magento store base URL (e.g.: https://mystore.com)
access_token	Integration access token with sales write permissions

Available Actions

Value	Description
(empty)	Only add comment
cancel	Cancel order
hold	Hold order
unhold	Release order
invoice	Create invoice
ship	Create shipment
refund	Create refund

Common Carrier Codes

Code	Name
ups	UPS
fedex	FedEx
dhl	DHL
usps	USPS
custom	Custom

Output

{
  "success": true,
  "order_id": "123",
  "order": {},
  "current_status": "processing",
  "actions_performed": ["comment_added", "invoice_created"],
  "invoice_id": 45,
  "message": "Order 100000001 updated: comment_added, invoice_created"
}

Usage Example

Create shipment with tracking

{
  "credentials_id": "magento_tienda",
  "order_id": "123",
  "action": "ship",
  "tracking_number": "1Z999AA10123456784",
  "carrier_code": "ups",
  "carrier_title": "UPS",
  "notify_customer": true
}

Cancel order

{
  "credentials_id": "magento_tienda",
  "order_id": "123",
  "action": "cancel",
  "comment": "Cancelled at customer request"
}

Create invoice

{
  "credentials_id": "magento_tienda",
  "order_id": "123",
  "action": "invoice",
  "capture_payment": true,
  "notify_customer": true
}

Notes

• Not all statuses allow all actions
• The invoice requires the order to be in processing
• Shipment requires the order to be invoiced
• Refund requires the order to be invoiced
• Comments are added to the order history

Related Nodes

• MagentoGetOrders - Get orders to update
• MagentoGetCustomers - Get order customer data
• MagentoGetProducts - Get order product data