Jump to Content
Guides
Recipes
API Reference
Log In
API Reference
Search
Log In
Guides
Recipes
API Reference
Creates a new void reason.
Search
All
Pages
Start typing to search…
JUMP TO
Consumer API's
StoreFinder
Retrieves stores based on supplied filters.
get
Retrieves store data based on branch code value.
get
Availability
/api/availability/store/{style}/{barcode}
get
Viare
ClickAndCollect
Gets the number of orders per status and store to be displayed on the tabs in intial page load and when the store selection is changed
get
Gets the list of order items when the user clicks 'View ordered items' in the store interface
get
Gets the the list of orders with specific status and assigned to a specific store or all stores
get
Changes the order status to be 27 (Received in store) when the user clicks the 'Order received in store' button on the store interface. This works for a single order or an order and its related orders.
put
Changes the order status to be 7 (Completed) when the user clicks the 'confirm collection' button on the store interface. This works for a single order or an order and its related orders.
put
Loads the previous order collection information data from the server to be displayed in the read only view of the order collection dialog for completed orders The ID of the object to get the det.
get
Gets the regex expression and error message from the iSAMS config if exist to validate Staff Pin.
get
DispatchDashboard
Get relevant permissions/configuration/website policies for the user/dispatch point.
get
Get the top level metrics for the dashboard, including priorities, pickstreams, graph data and pagination info.
get
Get the order items for a given order.
get
DispatchGroup
Gets all the dispatch points so they can be viewed/edited in the Admin
get
Updates the supplied Dispatch Group Mappping to Dispatch Point
put
Retrieves all the Dispatch Groups from the Data so they can be viewed/edited in the Admin.
get
Updates the supplied Web.Management.Dispatch.Group on the database.
put
Creates a new dispatch group on the database using the supplied dispatch group object.
post
Deletes a Dispatch Group from the database based on the supplied ID.
del
DispatchPoint
Retrieves a list of available Dispatch Point descriptions (names).
get
Grid
Get the grid of performance tiles for the selected date and website.
get
Get the list of websites in the Snapshot records.
get
Retrieve the throughput detail for the provided website name.
get
Retrieve the available Web.Management.Dispatch.Grid.Timeline from the Snaphots.
get
Retrieve the throughput for a specific Dispatch Point.
get
Retrieve the KPI indicators for the system.
get
Insights
Provides data retrieval methods for the generic Insights API data types.
get
Gets the detailed order volume metrics.
get
Leaderboard
Retrieves a list of Ranking objects within an for the desired leaderboard (identified by the route).
get
Retrieves a list of available Dispatch Point names within an for the desired selected website.
get
OrderHistory
Retrieves paginated order history.
get
Retrieves shipping details of the order with provided ID.
get
OrderNotes
Returns a list of Web.Management.Orders.Notes for the provided order.
get
Adds a new complex note to the order.
post
Adds a new simple (text-only) note to the order using default properties.
post
OrderPriority
Returns the list of Order Priorities defined in the system.
get
OrderRouting
Fetch a view of all Web.OrderRouting.Models.Orders in the Global Order Pool
get
Retrieve a list of Web.OrderRouting.Models.Orders that could be assigned to the specified Web.OrderRouting.Models.DispatchPoint
get
Fetch a view of all Web.OrderRouting.Models.Orders that cannot be assigned to any Web.OrderRouting.Models.DispatchPoint
get
Get the total orders, units, line items and max age metrics for the supplied dispatch point dpID
get
Get a breakdown of unit count by order priority and pickstream for the supplied dispatch point dpID
get
Fetch a list of all the order routing logs that we have
get
Fetch a specific order routing log for detailed inspection.
get
Fetch a list of all the order routing backorder logs that we have
get
Fetch a specific order routing backorder log for detailed inspection.
get
Get the Total Units (SUM of OrderItem.Quantity), Total Orders, Total Line Items (COUNT of Unique ProductItems in Orders), and The age of the oldest order for all the Dispatch Groups.
get
OrderRoutingConfiguration
Retrieves the configuration headers ( DispatchPoint.ID, DispatchPoint.Name) for all routing enabled dispatch points.
get
Retrieves dispatch group and headers ( DispatchPoint.ID, DispatchPoint.Name) for all routing enabled dispatch points.
get
Retrieves the configuration headers ( Template.ID, Template.Name) for all routing configuration templates.
get
Saves an individual Web.Management.OrderRouting.ConfigurationEntry back to the database based on changes made by users on the Order Routing Configuration page in iSAMS.
put
Creates a new template or one based on the supplied entry.
post
Gets all the Filters that can be used in Routing Configurations.
get
Gets all the Sorters that can be used in Routing Configurations.
get
Gets configurations for all Templates in Order Routing which are represented by a Web.Management.OrderRouting.ConfigurationEntry object.
get
Deletes the Template with the supplied ID.
del
Gets configurations for all DispatchPoints in Order Routing which are represented by a Web.Management.OrderRouting.ConfigurationEntry object.
get
Saves an individual Web.Management.OrderRouting.ConfigurationEntry back to the database based on changes made by users on the Order Routing Configuration page in iSAMS.
put
Applies a Template Configuration to all selected dispatch points replacing any existing configuration for that Dispatch Point.
put
Orders
Searches for orders.
get
Searches for return orders.
get
Retrieves an order by ID.
get
Updates an order.
put
Creates a new order.
post
Delete an order by ID.
put
Submits the order.
put
Emails order invoice to the customer. The e-mail address on the order will be updated to the specified address.
post
Method to retrieve an order receipt in ESC/POS format.
get
Retrieve an order item.
get
Deletes an order item.
del
Updates an order item.
put
Create a new order item for an order.
post
Retrieves return order information for the given order.
get
Retrieves a list of available return reasons.
get
Handles updating and inserting a return reason.
put
Handles updating and inserting a return reason.
post
Deletes a return reason.
del
Returns permissions configurations.
get
Submits a return the order.
post
Pick
Gets all the dispatch points so they can be viewed/edited in the Admin.
get
Either accepts or rejects a list of order based on the pick action defined in the OrderRequest object.
put
Gets a list of reasons for short picking an order. It is required to correctly render Pick tab.
get
Picklist
Saves Picklist through a PUT request.
put
Creates Picklist through a POST request.
post
Retrieves the Picklist details for the passed in Picklist ID.
get
Deletes the Picklist for the passed in input Picklist ID.
del
Provides a mechanism for storing settings against the current user.
put
Gets Departments for the "By Dispatch Point" mode where stock needs allocation.
get
Retrieves a preview of the items by supplier/DispatchPoint/Order awaiting allocation.
get
Sends the Picklist to the Supplier.If Transmit Type:10, it creates a picklist download. If Transmit Type is 2 or 3, it triggers the send email.
put
Sets the Picklist to the Web.Management.Picklist.PicklistStatus.InPick status in order to enable the user to start scanning the picklist.
put
Scans an item.
put
Logs a failed scan to an audit table.
post
Looks for any historic uses of a barcode, useful for mislabelled products or picklists created before a barcode change on a product.
get
Returns configurations.
get
Locks a picklists allocation so its orderitems can only be allocated to pigeon holes directly.
put
Unlock a picklists allocation so its orderitems can be allocated to pigeon holes indirectly by anyone scanning items in dispatch.
put
Retrieves the versions of the supplied picklist items.
get
Retrieves the version of the supplied picklist.
get
Creates a stock replenishment request for an item in a picklist.
post
Check if an order is in a state that would prevent it being used to create a picklist.
get
Create a picklist directly from a list of orders.
post
PicklistHistory
Gets picklist history items.
get
Get permitted dispatch points.
get
Get suppliers.
get
PicklistManager
Returns a list of Shortpick Reasons.
get
Retrieves a list of Picklist objects within an for the desired dispatch point.
get
Retrieves a list of Dispatch Points for the current user.
get
Apply all selected actions to the database.
post
Returns configurations.
get
Pigeonhole
Retrieves a list of Web.Management.Dispatch.Pigeonholes.Pigeonhole objects within an for the requested dispatch point.
get
Retrieves a list of Dispatch Points the current user has permission to view.
get
Retrieves a list of Available Location Group Names.
get
PreferredProducts
Get Preferred Product Options
get
Get a list of Web.Management.PreferredProducts.PreferredProductItem ready for client selection
get
Endpoint used to query the preferred product admin page index this includes a list of preferred products and counts
get
Endpoint used to create a Preferred Product
post
Endpoint used to update a Preferred Product
put
Endpoint used to delete a Preferred Product
del
Preorder
Returns a PreorderListing object which contains all preorders that match the given selection parameters.
get
Returns an enumberable of all preorder for the specified item id.
get
Updates the given preorder item
put
Releases all orders for the given preorder product Note this will apply any wsID restrictions on the orders released.
put
Releases all orders for the given item
put
Releases a single preorder
put
Voids all preorder orders for the given item.
put
Voids the given preorder order
put
Products
Create a new product.
post
Search for products.
get
Retrieve a product item by ID.
get
Rerouting
Retrieves the available routing options for the provided order.
get
Applies the requested routes for the list of items provided.
post
ScheduledReport
Returns a ScheduledReport object which contains all reports that match the given selection parameters.
get
Forces a report to run in next cycle.
post
Updated the report subscribers.
put
StoreLabels
Gets the status of the store labelling system.
get
"Flashes" (depending on labelling system) the relevant tags in the selected store.
post
Stores
Returns the list of stores the logged in user has access to.
get
Searches for Store(s).
get
Retrieves a single Store by ID.
get
Deletes a Store by ID.
del
Updates a Store by ID.
put
Add a new Store.
post
Triage
Lists all orders eligible for order triage.
get
Returns a filtered list of order eligible for Triage based on the specified criteria.
post
Applies a request list of Triage actions to the affected orders.
post
Retrieves the line-level details for an order within the Triage module.
get
VirtualWriteDown
Gets virtual write down items so they can be viewed/edited in the Admin.
get
Update Release Time for an item.
put
Get permitted dispatch points.
get
Get release permission.
get
Get server timezone information.
get
VoidReason
Gets void reasons so they can be viewed/edited in the Admin.
get
Creates a new void reason.
post
Updates a void reason.
put
Deletes a void reason.
del
Powered by
Creates a new void reason.
post
https://{client}.viare.io/manage/voidreasons
Language
Shell
Node
Ruby
PHP
Python
URL
Base URL
https://
client
.viare.io
/manage/voidreasons
Response
Click
Try It!
to start a request and see the response here!
