- Getting Started
- API Endpoints
- Authentication & Permissions
- ID Address Whitelist
- HMAC Signature
- Authorization Header Examples
- Base64 Encoding
- Timestamp Verification
- Group & Function Permissions
- Client Side Requests
- Dates & Times
- Multiple Functions Calls
- Request Format
- Response & Error Handling
- Throttling & Timeouts
- Troubleshooting
- Pagination
- Requesting Orders
- Quick Start Guide
- List Load Query Overview
- Order Workflows
- Order Queues
- Managing Order Queues
- Workflows
- Wait Until True
- Triggers
- Conditions
- Actions
- Order Webhooks
- Functions
- Availability Groups
- AvailabilityGroupBusinessAccount_Update...
- AvailabilityGroupCustomer_Update...
- AvailabilityGroupList_Load_Query
- AvailabilityGroupPaymentMethod_Update...
- AvailabilityGroupProduct_Update...
- AvailabilityGroupShippingMethod_Update...
- Categories
- Category_Delete
- Category_Insert
- Category_Update
- CategoryList_Load_Parent
- CategoryList_Load_Query
- CategoryProductList_Load_Query
- CategoryProduct_Update_Assigned
- Coupons
- Coupon_Delete
- Coupon_Insert
- Coupon_Update
- CouponList_Delete
- CouponList_Load_Query
- CouponPriceGroupList_Load_Query
- CouponPriceGroup_Update_Assigned
- Customers
- Customer_Delete
- Customer_Insert
- Customer_Update
- CustomerList_Load_Query
- Notes
- Note_Delete
- Note_Insert
- Note_Update
- NoteList_Load_Query
- Order Queues
- Orders
- Order_Create
- OrderCustomFields_Update
- OrderCustomFieldList_Load
- OrderItem_Add
- OrderItem_Update
- OrderItemList_Cancel
- OrderItemList_Delete
- OrderItem_Update
- OrderList_Load_Query
- OrderPaymentList_Load
- OrderItemList_BackOrder
- OrderList_Load_Query
- Order_Create
- Order_Delete
- Order_Update_Customer_Information
- Shipments
- Payments
- OrderPaymentList_Load
- OrderPayment_Capture
- OrderPayment_Refund
- OrderPayment_VOID
- Price Groups
- PriceGroupCustomer_Update_Assigned
- PriceGroupList_Load_Query
- PriceGroupProductList_Load_Query
- PriceGroupProduct_Update_Assigned
- Products
- ProductImage_Add
- ProductImage_Delete
- Product_Delete
- Product_Insert
- Product_Update
- ProductList_Load_Query
- ProductList_Adjust_Inventory
- ProductList_Load_Query
- ProductVariantList_Load_Product
- Prodct_Update
- Provisioning
- Provision_Domain
- Provision_Store
OrderList_Acknowledge
This function is used in conjunction with an order workflow to manually mark an order as recieved. Because this is a module level function you'll need to use the following format to whitelist the funciton:
Module:orderworkflow:QueueOrderList_Load_Query
Request Body Parameters
| Store_Code | Store Code to run function against |
| Function | For Module level functions this will always have the value of: "Module" |
| Module_Code | Module Code. Always "orderworkflow" for this function |
| Module_Function | Function to execute |
| Order_Ids | Comma seperated list of order ids you wish to make as recieved/acknowledged. |
Response Parameters
| success | boolean value for if the request was successfull |
| processed | boolean value if function was processed |
Example Request
Example Response
Example Error Response
This means that the request was successfull, but not processed. Typically means Order_IDs parameter is missing or incorrect.
Error Responses
| error code invalid_function |
error message Invalid Function |
description Request syntax is inccorrect. This is a module level function, so "Module" needs to be passed in the Function Parameter. |
|
| error code invalid_module |
error message Invalid Module |
description Request syntax is incorrect. This is a module level function, so Module_Code parameter needs to be "orderworkflow". |
Copyright © 2016 Miva, Inc - All Rights Reserved Privacy Policy | Store Policy