Find Order
Explore how the Find Order API call offers details about orders present in the system.
Retrieve details a list of orders imported from external systems in your OMS. To find the order, send a GET request to the /solr-query
endpoint with appropriate query parameters.
Request
End Point https://<instance.name>.hotwax.io/api/solr-query
Example: https://demo-oms.hotwax.io/api/solr-query
Request Format
Parameter Table
Parameter Name | Description |
---|---|
| The Type of the document |
| Basic solr query |
| Format of data returned by api (json/csv) |
| No of documents returned |
| Field name and sort order (asc/desc) to sort response |
| Additional query parameters |
| List of fields returned in response document |
Order Details Table
Order Details Table
Field Name | Description |
---|---|
| Unique identifier for the order |
| Name or reference given to the order |
| Sequential ID for the order item |
| Type of order item (e.g., product, service) |
| Unique identifier for the product |
| Name of the parent product (if applicable) |
| Name of the product |
| Type of product |
| Internal name or code for the product |
| Description of the product type |
| Indicates if the item is part of a promotion |
| Supplier's unique identifier for the product |
| Quantity ordered |
| Unit price of the product |
| List price of the product |
| Status of the order item |
| Description of the order item status |
| Subtotal for the order item |
| Type of association between order items |
| List of supplier party IDs involved in the order |
| Name of the sales representative |
| ID of the sales channel |
| Description of the sales channel |
| Type of order (e.g., sales, purchase) |
| ID of the product store |
| Name of the product store |
| Status of the order |
| Description of the order status |
| Sequential ID for the order status |
| Roles associated with the order |
| ID of the customer party |
| Customer's email address |
| Name of the customer party |
| Country where the order will be shipped |
| State where the order will be shipped |
| City where the order will be shipped |
| Shipping method used for the order |
| ID of the supplier party |
| Name of the supplier party |
| Date the order was placed |
| Notes or comments associated with the order |
| Date string representation of the order date |
| Estimated delivery date |
| Date when the order will be automatically canceled |
| ID of the corresponding purchase order (if applicable) |
| Title or reference given to the order |
| ID of the facility involved in the order |
| Name of the facility |
| Total amount of the order |
| Size of the order |
| Last recorded inventory count |
| Hierarchical structure of product categories |
| ID of the related work effort |
| Type of work effort |
| Current status of the work effort |
| Purpose of the work effort |
| ID of the parent work effort (if applicable) |
| Priority of the work effort |
| Name of the work effort |
| Description of the work effort |
| Estimated start date of the work effort |
| Estimated completion date of the work effort |
| Actual start date of the work effort |
| Actual completion date of the work effort |
| Quantity of backordered items |
| Time taken from order placement to release |
| Time taken from release to picking |
| Time taken from picking to shipping |
| IDs of the party classification groups |
| ID of the currency unit of measurement |
| Name of the party placing the order |
| ID of the party placing the order |
| Primary category name facet |
| Type of pricing (e.g., retail, wholesale) |
| IDs of applied promo codes |
| List of order identification codes |
| Promised date and time for delivery |
| ID of the shipment method type |
Response
Body
Response Parameters Table
Parameter | Description |
---|---|
| Total number of documents found matching the search criteria |
| Starting index of the returned documents |
| Indicates whether the |
Last updated