Read Miva orders, customers and products, and manage inventory, returns, shipments, product images and products through your store's JSON API.
Explore 13 workflow actions for Miva, including account permissions and operation limits.
3 read actions10 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Acknowledge orders
Write
Marks orders as received in an order workflow, so they leave the new-and-updated queue.
Permissions and limits
Account permissions
A Miva API token (Users > API Tokens) allowed to run this function, with HMAC signing turned off and NodeHub's addresses on its IP allowlist
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add product image
Write
Assigns an image to a product, from a file already on the store or from base64 image data saved at that path.
Permissions and limits
Account permissions
A Miva API token (Users > API Tokens) allowed to run this function, with HMAC signing turned off and NodeHub's addresses on its IP allowlist
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adjust inventory
Write
Adds to or subtracts from products' inventory counts (it does not set the total).
Permissions and limits
Account permissions
A Miva API token (Users > API Tokens) allowed to run this function, with HMAC signing turned off and NodeHub's addresses on its IP allowlist
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create product
Write
Creates a product; answers the saved product.
Permissions and limits
Account permissions
A Miva API token (Users > API Tokens) allowed to run this function, with HMAC signing turned off and NodeHub's addresses on its IP allowlist
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create return
Write
Creates an RMA (return) for order line items.
Permissions and limits
Account permissions
A Miva API token (Users > API Tokens) allowed to run this function, with HMAC signing turned off and NodeHub's addresses on its IP allowlist
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create shipment
Write
Creates a shipment from order line items (mark it shipped with Update shipments).
Permissions and limits
Account permissions
A Miva API token (Users > API Tokens) allowed to run this function, with HMAC signing turned off and NodeHub's addresses on its IP allowlist
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete product image
Write
Removes an image assignment from a product (the file stays on the server).
Permissions and limits
Account permissions
A Miva API token (Users > API Tokens) allowed to run this function, with HMAC signing turned off and NodeHub's addresses on its IP allowlist
A repeated request may repeat the external action. Review the previous result before retrying a write.
List customers
Read
Customers matching Miva filters.
Permissions and limits
Account permissions
A Miva API token (Users > API Tokens) allowed to run this function, with HMAC signing turned off and NodeHub's addresses on its IP allowlist
List orders
Read
Orders matching Miva filters (date, ID, status and more), with on-demand columns like items, customer and shipments.
Permissions and limits
Account permissions
A Miva API token (Users > API Tokens) allowed to run this function, with HMAC signing turned off and NodeHub's addresses on its IP allowlist
List products
Read
Products matching Miva filters, with on-demand columns like descriptions, categories, images and inventory.
Permissions and limits
Account permissions
A Miva API token (Users > API Tokens) allowed to run this function, with HMAC signing turned off and NodeHub's addresses on its IP allowlist
Mark returns received
Write
Marks returns as received, optionally putting the items back in stock.
Permissions and limits
Account permissions
A Miva API token (Users > API Tokens) allowed to run this function, with HMAC signing turned off and NodeHub's addresses on its IP allowlist
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update product
Write
Changes a product found by its current code or ID; only the fields given change.
Permissions and limits
Account permissions
A Miva API token (Users > API Tokens) allowed to run this function, with HMAC signing turned off and NodeHub's addresses on its IP allowlist
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update shipments
Write
Sets tracking, cost and weight on shipments and can mark them shipped (which may email the customer).
Permissions and limits
Account permissions
A Miva API token (Users > API Tokens) allowed to run this function, with HMAC signing turned off and NodeHub's addresses on its IP allowlist
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Miva. A saved workflow is not a completed provider action.