Ready To Ship Items
Explore our 'Ready To Ship Items' page for a comprehensive list of orders picked, packed, and ready to delight your customers.
Fetches a comprehensive list of all orders items which are picked, packed and ready to ship to customers. To get ready to ship orders, you will need to call the /solr-query endpoint with the POST method.
Request
Endpoint
https://<host>/api/solr-query
Example: https://demo-oms.hotwax.io/api/solr-query
Headers
Body
Parameter | Description | Required (Y/N) |
---|---|---|
| The number of groups. | No |
| Sort data based on attributes. | No |
| Filter to group orders. | Yes |
| The field to be grouped. | Yes |
| The maximum number of items allowed in the group. | Yes |
| The number of groups that have matched the query in the results. The default value is false. | No |
| Selects the query parser to be used to process the query. | No |
| Specifies the default operator for query expressions, overriding the default operator specified in the Schema. Possible values are "AND" or "OR". | No |
| The query fields. | No |
| Filters record based on parameters passed. | No |
| The filter to get orders based on their shipped date. | - |
| Reference index. | No |
| Index page number. | No |
| The ID of the order type in HotWax. | Yes |
| The status of the order if picked or not. Default value: N. | No |
| The ID of the shipment method type which needs to be neglected. | No |
| The name of the facet. | No |
| Removes specific tags from facet counts. | No |
| Specifies the minimum counts required for a facet field to be included in the response. | No |
| Controls how many constraints should be returned for each facet. | No |
| Controls how faceted results are sorted. | No |
| - | No |
| The arrangement of search results into categories based on indexed terms. | No |
| The count of orders. | No |
| The status of fulfilment which needs to be neglected. | No |
| The ID of the facility. | No |
Response
Body
Parameter | Description |
---|---|
| The results matching the query. |
| The number of unique groups in the result set. |
| The value of the grouped field. |
| The total number of results found. |
| The offset of the first result in the result set. |
| The ID of the order. |
| The ID of the order item sequence. |
| The ID of the ship group sequence. |
| The ID of the inventory item. |
| The date and time of reservation. |
| The quantity of order items. |
| The quantity of items not available. |
| The ID of the product. |
| The keyword used for search. |
| The name of the product. |
| The spellchecker used. |
| The SKU (Stock Keeping Unit) of the product. |
| The name of the virtual product. |
| The count of unique order items. |
| The status of picking. |
| The ID of the picklist bin. |
| The ID of the picklist. |
| The ID of the picklist item status. |
| The description of the picklist item status. |
| The status of fulfillment. |
| The date when the order was placed. |
| The ID of the order type. |
| The ID of the product store. |
| The ID of the order status. |
| The ID of the customer. |
| The name of the customer. |
| The filter for order splitting. |
| The ID of the shipment method type. |
| The description of the shipment method type. |
| The number of the shipment method type in the sequence. |
| The ID of the facility. |
| The name of the facility. |
| The ID of the facility type. |
| The ID of the company. |
| The ID of the shipment. |
| The ID of the shipment status. |
| The ID of the shipment carrier party. |
| The ID of the shipment method type. |
| The filter for document manifestation. |
| The ID of the manifest content. |
| The type of the document. |
| The identifier of the document. |
| The type and identifier of the document separated by a hyphen. |
Last updated