Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
This document provides instructions for getting the list of all orders
GET orders API allows retrieval of existing order documents from the OMS. Supports flexible filtering options to fetch orders based on specific criteria such as partyId or statusId.
Additionally, the API supports sorting functionality. By utilizing the sortBy and sortOrder parameters in the URL, data can be arranged based on fields like grandTotal in either ascending or descending order.
End Point https://<instance.name>.hotwax.io/api/<publish_point>/orders
Example: https://demo-oms.hotwax.io/api/<publish_point>/orders
viewIndex
Index of the view in pagination.
viewSize
Number of records to fetch per page.
filters
Filters to apply for querying specific orders.
Filters allow users to query orders based on various fields. The structure of the filter includes:
Field: The field to filter by (e.g., externalId, partyId, statusId). Field_op: Operator used for the filter condition (e.g., equals, like, etc.). Field_ic: Ignore case flag (Y for yes, N for no).
This example will fetch all the orders where externalId is 10025, with case-insensitive matching (ignore case set to Y).
HTTP/1.1 200 OK
Content-Type: application/json
id
Unique identifier of the order.
externalId
External identifier of the order.
orderName
Name or identifier of the order.
channel
Sales channel through which the order was placed.
channelDesc
Description of the sales channel.
customerId
ID of the customer associated with the order.
customerExternalId
External ID of the customer.
customerName
Name of the customer.
priority
Priority level of the order.
orderDate
Date and time when the order was created.
entryDate
Date and time when the order was entered into the system.
expireDate
Date and time when the order expires.
statusId
ID indicating the current status of the order.
statusDesc
Description of the current status of the order.
productStoreId
ID of the product store associated with the order.
productStoreName
Name of the product store.
webSiteId
ID of the website associated with the order.
webSiteName
Name of the website.
currencyCode
Currency code used for the order.
currencyCodeDesc
Description of the currency used.
remainingSubTotal
Remaining subtotal amount of the order.
grandTotal
Total amount of the order.
tags
Tags associated with the order.
note
Additional notes or comments related to the order.
orderContacts
Contact information associated with the order (e.g., email).
orderIdentifications
Array of identification details associated with the order (e.g., marketplaces, order IDs).
shipGroup
Array containing shipping group details for the order.
orderAdjustments
Adjustments made to the order (e.g., shipping charges).
orderPaymentPref
Payment preferences for the order (e.g., payment method, status).
billTo
Billing details for the order (e.g., postal address, email, phone).
billFrom
Originating entity details for the order (e.g., company name, address, email, phone).
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.
End Point https://<instance.name>.hotwax.io/api/solr-query
Example: https://demo-oms.hotwax.io/api/solr-query
docType
The Type of the document
q
Basic solr query
wt
Format of data returned by api (json/csv)
rows
No of documents returned
sort
Field name and sort order (asc/desc) to sort response
filter
Additional query parameters
fields
List of fields returned in response document
Order Details Table
orderId
Unique identifier for the order
orderName
Name or reference given to the order
orderItemSeqId
Sequential ID for the order item
orderItemTypeId
Type of order item (e.g., product, service)
productId
Unique identifier for the product
parentProductName
Name of the parent product (if applicable)
productName
Name of the product
productTypeId
Type of product
internalName
Internal name or code for the product
productTypeDesc
Description of the product type
isPromo
Indicates if the item is part of a promotion
supplierProductId
Supplier's unique identifier for the product
quantity
Quantity ordered
unitPrice
Unit price of the product
unitListPrice
List price of the product
orderItemStatusId
Status of the order item
orderItemStatusDesc
Description of the order item status
orderItemSubTotal
Subtotal for the order item
orderItemAssocTypeId
Type of association between order items
supplierPartyIds
List of supplier party IDs involved in the order
salesRepName
Name of the sales representative
salesChannelEnumId
ID of the sales channel
salesChannelDesc
Description of the sales channel
orderTypeId
Type of order (e.g., sales, purchase)
productStoreId
ID of the product store
productStoreName
Name of the product store
orderStatusId
Status of the order
orderStatusDesc
Description of the order status
statusSeqId
Sequential ID for the order status
orderRoles
Roles associated with the order
customerPartyId
ID of the customer party
customerEmailId
Customer's email address
customerPartyName
Name of the customer party
shipToCountry
Country where the order will be shipped
shipToState
State where the order will be shipped
shipToCity
City where the order will be shipped
shippingMethod
Shipping method used for the order
supplierPartyId
ID of the supplier party
supplierPartyName
Name of the supplier party
orderDate
Date the order was placed
orderNotes
Notes or comments associated with the order
orderDateString
Date string representation of the order date
estimatedDeliveryDate
Estimated delivery date
autoCancelDate
Date when the order will be automatically canceled
correspondingPoId
ID of the corresponding purchase order (if applicable)
title
Title or reference given to the order
facilityId
ID of the facility involved in the order
facilityName
Name of the facility
orderGrandTotal
Total amount of the order
orderSize
Size of the order
lastInventoryCount
Last recorded inventory count
categoryHierarchy
Hierarchical structure of product categories
workEffortId
ID of the related work effort
workEffortTypeId
Type of work effort
currentStatus
Current status of the work effort
workEffortPurposeTypeId
Purpose of the work effort
workEffortParentId
ID of the parent work effort (if applicable)
priority
Priority of the work effort
workEffortName
Name of the work effort
description
Description of the work effort
estimatedStartDate
Estimated start date of the work effort
estimatedCompletionDate
Estimated completion date of the work effort
actualStartDate
Actual start date of the work effort
actualCompletionDate
Actual completion date of the work effort
backOrderedQuantity
Quantity of backordered items
orderToReleaseTime
Time taken from order placement to release
releaseToPickTime
Time taken from release to picking
pickToShipTime
Time taken from picking to shipping
partyClassificationGroupIds
IDs of the party classification groups
currencyUomId
ID of the currency unit of measurement
placingPartyName
Name of the party placing the order
placingPartyId
ID of the party placing the order
primaryProductCategoryNameFacet
Primary category name facet
priceType
Type of pricing (e.g., retail, wholesale)
promoCodeIds
IDs of applied promo codes
orderIdentifications
List of order identification codes
promisedDatetime
Promised date and time for delivery
shipmentMethodTypeId
ID of the shipment method type
numFound
Total number of documents found matching the search criteria
start
Starting index of the returned documents
numFoundExact
Indicates whether the numFound value is exact or an estimate
Discover how the created order feed JSON assists external systems in tracking and consuming new orders entering the OMS.
The Created Orders feed is an order-wise JSON-formatted feed generated from HotWax Commerce OMS. This feed contains details about created order in OMS, which can be approved in OMS based on certain configurable checks. The feed can be used for integration with other external systems.
The Created Order Items feed is a valuable resource for retailers using NetSuite ERP. NetSuite's workflow requires order creation as a prerequisite for other order-related operations. By exporting created orders from the OMS and transforming them into the desired NetSuite format, retailers can integrate these orders into NetSuite for subsequent processing.
The Created Orders feed has certain out-of-the-box customizations that allow users to generate the feed as per the requirements.The created order feed JSON helps external systems track new orders that are entering the OMS and consume them for their linked actions.
Here is a sample feed of that the created order feed looks like
Learn how order adjustments categorize various order-level charges for streamlined management.
Order adjustments provide a flexible way to categorize various order-level charges. By storing adjustments as distinct types, rather than including them directly in the order header, they can be easily adapted to meet the specific requirements of custom implementations and integrations.
ADDITIONAL_FEATURE
-
Additional Feature
CGST
GST_TAX
Central Goods and Services Tax
DEPOSIT_ADJUSTMENT
-
Deposit
DEPOSIT_REFUND
-
Deposit Refund
DISCOUNT_ADJUSTMENT
-
Discount
DONATION_ADJUSTMENT
-
Donation
DUTY
-
Duty
EXT_PROMO_ADJUSTMENT
-
External promotion adjustment
EXT_SHIP_ADJUSTMENT
-
External shipping adjustment
FEE
-
Fee
GST_TAX
-
Goods and Services Tax
IGST
GST_TAX
Integrated Goods and Services Tax
MISCELLANEOUS_CHARGE
-
Miscellaneous Charge
MKTG_PKG_AUTO_ADJUST
-
Marketing Package Adjustment
OFF_INV_ADJUSTMENT
DISCOUNT_ADJUSTMENT
Off Invoice Adjustment
PROMOTION_ADJUSTMENT
-
Promotion
PYMNT_PROCESS_FEE
FEE
Payment Processing Fee
REPLACE_ADJUSTMENT
-
Replacement
SALES_TAX
-
Sales Tax
SGST
GST_TAX
State Goods and Services Tax
SHIPPING_CHARGES
-
S&H
SHIPPING_SALES_TAX
-
S&H Tax
SURCHARGE_ADJUSTMENT
-
Surcharge
UTGST
GST_TAX
Union Territories State Goods and Services Tax
VAT_PRICE_CORRECT
-
VAT Price Correction
VAT_TAX
-
VAT Tax
WARRANTY_ADJUSTMENT
-
Warranty
Explore API and data feeds within the 'Orders' documentation.
APIs and data feeds specifically designed for order related operations in OMS. These tools provide businesses with the flexibility to integrate their systems with HotWax and automate various order-related processes.
Explore how the Order Reconciliations API call offers insights into failed orders, aiding in Shopify to HotWax Commerce synchronization.
Provides log insights for failed orders that may not have been successfully downloaded from Shopify to HotWax Commerce. To retrieve the log details of these failed orders, make a GET request to the /solr-query endpoint.
End Point https://<instance.name>.hotwax.io/api/solr-query
Example: https://demo-oms.hotwax.io/api/solr-query
docType
The Type of the document
coreName
A single index or associated transaction log and configuration files
site
Shopify Store URL containing order details
shopifyOrderName
Unique identifier of the order in Shopify
orderCreatedDate
Date when the order was created on Shopify
firstAttemptedImport
Date when the order import from Shopify to HotWax Commerce was first attempted
docType
The type of the document
ttl
Time duration of the data, also called time to live
errorMessage
The error message for the job failure
timestamp
The timestamp for the API call
expire_at
Data expiry date
document-id
Unique identifier of the document
This document provides instructions for retrieving comprehensive details of a specific orde
Improved Sentence:
Retrieves of detailed information about specific order within OMS. This functionality is valuable for verifying order status, contents, and associated details based on their unique identifiers. To retrieve the order, send a GET request to the OMS endpoint with query parameters.
End Point https://<instance.name>.hotwax.io/api/<publish_point>/orders/<order_id>
Example: https://demo-oms.hotwax.io/api/<publish_point>/orders/<order_id>
<order_id>
The unique identifier of the order to retrieve.
HTTP/1.1 200 OK
Content-Type: application/json
id
The unique identifier for the order.
externalId
External system identifier for the order.
orderName
The name or reference number of the order.
channel
Sales channel through which the order was placed.
channelDesc
Description of the sales channel.
customerId
The unique identifier for the customer.
customerExternalId
External system identifier for the customer.
customerName
The name of the customer.
priority
Priority level of the order.
orderDate
The date when the order was placed.
entryDate
The date when the order was entered into the system.
expireDate
The expiration date of the order.
statusId
Current status of the order.
statusDesc
Description of the order status.
productStoreId
Identifier for the product store associated with the order.
productStoreName
Name of the product store.
webSiteId
Identifier for the website associated with the order.
webSiteName
Name of the website.
currencyCode
The currency code for the order.
currencyCodeDesc
Description of the currency code.
remainingSubTotal
The remaining subtotal for the order.
grandTotal
The grand total amount for the order.
tags
Tags associated with the order.
note
Notes associated with the order.
orderContacts
Contact information for the order.
orderIdentifications
Identifications related to the order.
shipGroup
Shipping group details for the order.
orderAdjustments
Adjustments applied to the order.
orderPaymentPref
Payment preferences for the order.
billTo
Billing information for the order.
billFrom
Billing information from the order origin.