Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Read HotWax Commerce's technical documentation for insights on integrating with ERP, WMS, and POS systems.
HotWax Commerce Technical Documentation is designed to provide a comprehensive understanding of the platform's integration capabilities with systems such as ERP, WMS, and POS, and how to leverage them effectively. This documentation will help navigate through the various aspects of HotWax Commerce OMS, including Journeys, APIs Data Feeds and detailed information on each API, including how to authenticate, make requests, and handle responses.
APIs allow other systems to interact with different aspects of OMS such as Orders and Inventory. The APIs provide the flexibility to perform operations such as managing inventory and fulfilling orders. The documentation provides detailed information on each API, including how to authenticate, make requests, and handle responses.
Out-of-the-box data feeds enable integration between systems such as ERP, WMS, POS, and OMS. Whether looking to synchronize inventory, update product, or import/export data, data feeds make it easy to connect HotWax Commerce with other systems. The documentation provides step-by-step instructions on how to use data feeds such as CSVs and Jsons to meet integration requirements.
Journeys represent the interactions of multiple APIs and feeds to deliver specific user experiences. The documentation will guide through the various out-of-the-box Journeys available, helping understand how to configure and customize them to meet specific business and integration needs.
Deprecated (since maarg 4.4.0): Use admin/login
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.
Deprecated (since maarg 4.4.0): Use admin/status
Deprecated (since maarg 4.4.0): Use admin/user
decisionRules
picklists
Deprecated (since maarg 4.4.0): Use admin/facilities
Deprecated (since maarg 4.4.0): Use admin/enums
Deprecated (since maarg 4.4.0): Use admin/facilities
rejectInProgressOrders
orderShipmentAndRouteSegments
dataManagerMappings
rejectOutstandingOrders
updateShipmentCarrierAndMethod
shipmentPicklists
shippingRate
transferOrders
Deprecated (since maarg 4.4.0): Use admin/login
Label.pdf
Deprecated (since maarg 4.4.0): Use admin/oms/healthCheck
transferShipments
shipmentPackageRouteSegDetails
Explore API and data feeds within the 'Inventory' documentation.
Explore API and data feeds within the 'Inbound Shipment' documentation
externalInventoryResets
groups
Deprecated (since maarg 4.4.0): Use admin/productStores
rejectOrderItems
Deprecated (since maarg 4.4.0): Use admin/oms/healthCheck
Deprecated (since maarg 4.4.0): Use admin/user
solrFacets
Intended to provide generation of authentication tokens.
Deprecated (since maarg 4.4.0): Use admin/enums
updateShipmentTracking
Deprecated (since maarg 4.4.0): Use admin/enums
Deprecated (since maarg 4.4.0): Use admin/facilities
orders
routings
Deprecated (since maarg 4.4.0): Use admin/status
getInventoryAvailableByFacility
shipmentFacets
rules
generateManifest
Deprecated (since maarg 4.4.0): Use admin/enums
Discover how returns can be created in HotWax and how HotWax posts these returns to external systems.
HotWax's Create Return API provides the ability to create a return in HotWax for returns which have been processed and completed in the integrated E-commerce system.
The returns financial feed, then, generates necessary data to be communicated with external systems in a JSON format. A sample of the feed can be found on the Returns Financial Feed section.
Explore API and data feeds within the 'Facility' documentation.
Learn how to sync inventory from an external reference source to HotWax Commerce with the 'Reset Inventory' feature.
Syncs inventory from an external reference source to HotWax. After receiving the inventory file in CSV format, HotWax Commerce calculates the difference in inventory and matches its inventory levels exactly with CSV. CSV files can be imported in HotWax by two methods: using the EXIM menu in HotWax or saving the file at a designated SFTP location for HotWax to automatically download and process.
Sample path for SFTP method: /home/<host_name>-sftp/staging/incoming
Here's an example of the CSV file format:
The Reset Inventory API accepts the following parameters:
Note: sku upca and shopifyProductId are commonly used product Identifiers.
Learn about authentication requirements for secure transactions on HotWax's platform. Ensure safe API requests effortlessly.
To ensure secure transactions on HotWax's platform, all applications connecting with the HotWax API require authentication when making API requests. The primary method of authentication employed is Bearer token authentication.
Bearer token authentication utilizes security tokens. After a successful login request, the server generates a secret string known as a bearer token. When making requests for protected resources, the user must include the token in the authorization header.
Hotwax Commerce relies on robust security features provided by JWT (JSON Web Token) to ensure a safe and trustworthy API communication environment. This mechanism guarantees user authenticity, authorizes their actions, and maintains data integrity through digital signatures. To create JWT, follow these steps:
Create a unique user from by using integration template or assign the integration permissions.
Make sure that Reset Password on Login is unchecked.
Navigate to the Hamburger menu in OMS: https://{instanceName}.hotwax.io/
Access the Settings option and choose Create JWT Token
Sample endpoint: https://<host_name>.hotwax.io/<api_name>/login
The following HotWax APIs require an authentication token:
updateInventory
For more information about Bearer token authentication, refer to this .
shipmentRequests
Deprecated (since maarg 4.4.0): Use admin/facilityGroups
Deprecated (since maarg 4.4.0): Use admin/shopifyShops
cycleCounts
Input the user ID.It will display only the users having integration permissions.
Token Configuration:**
Define the validation period.
Specify the purpose of the token.
Click Create, and the resulting JWT token will be displayed in the dedicated section.
Copy Token and use it to build connection
Explore API and data feeds within the 'Brokering' documentation.
availableQty
The available quantity of the product in the external reference source. This number will overwrite the current ATP level of the product in HotWax Commerce.
Yes
externalFacilityId
The Id of the facility in an external reference source.
No
productId
The internal Id of a product in HotWax Commerce.
No
comments
Optional field to store additional information.
No
DEMO_HC_STORE_1
TLTLTLLL01
sku
WH09-XL-Green
20
facilityId
HotWax Commerce internal facility Id. Generally the same as the facility Id in Shopify.
Yes
locationSeqId
The Id of the designated location in a facility in HotWax Commerce.
Yes
idType
The type of the unique product identifier in the external reference source. Default is shopifyProductId
No
idValue
The value of the product idType in the external reference source.
Yes
Discover how to retrieve stock details for products at specific locations with the 'Check Inventory' subcategory.
Get the stock details of the product on the specific locations. To get the stock details, you will need to call the /checkInventory endpoint with the POST method.
https://<host>/api/checkInventory
Example: https://demo-oms.hotwax.io/api/checkInventory
Content-Type: application/json
In case of checking a product's inventory at multiple facility.
In case of checking multiple product's inventory at single facility.
Sample
HTTP/1.1 200 OK
Content-Type: application/json
Discover how to retrieve online ATP for products at specific locations with the 'getProductOnlineAtp' API
Store Associates need to access the online Available to Promise (ATP) inventory of products on their POS systems for sendsales orders. The getProductOnlineAtp API facilitates retrieving the online ATP of a product from all locations except the one it's being ordered from. The API does not count the Online ATP of a facility in the following scenarios:
Inventory for the store placing the order.
Inventory from stores with sell online turned off.
Inventory for an SKU where the inventory is turned off in specific locations.
To fetch the online ATP details, make a POST request to the /getProductOnlineAtp endpoint.
https://<host>/api/service/getProductOnlineAtp
Example https://demo-oms.hotwax.io/api/service/getProductOnlineAtp
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json
facilityId_op
The operator to be used for the facility Id
N
sku_op
The operator to be used for the sku field
N
Note: It is required to pass either sku or productId.
sku
The SKU of the product
N
sku_op
The operator to be used for the sku field
N
productId
HotWax Commerce internal product Id
N
facilityId
The HotWax Commerce facility Id where product inventory is located
count
Results count
docs
The array of results found
facilityId
The Id of the facility in HotWax
atp
The available to promise inventory of the product
N
idType
Specifies the type of identifier being used (e.g., "SKU")
idValue
The specific value of the SKU being referenced
productStoreId
Identifies the store or location within the system where the product is available
conditionMap
Contains conditions for filtering or specifying attributes related to the request
externalFacilityId_value
The value of the external facility ID
externalFacilityId_op
The operation or condition applied to the external facility ID (e.g., "notEqual")
onlineAtp
The online available to promise inventory of the product
{
"filters": {
"sku": "<sku>",
"facilityId": ["<facilityId1>", "<facilityId2>", "<facilityId3>"],
"facilityId_op": "in"
}
}{
"filters": {
"sku": ["<sku1>", "<sku2>", "<sku3>"],
"sku_op": "in",
"facilityId": "<facilityId>"
}
}{
"filters": {
"sku": "MSH02-32-Black",
"facilityId": "STORE_7"
}
}{
"count": "1",
"docs": [
{
"facilityId": "STORE_7",
"atp": 1.000000
}
]
}{
"idType": "<SKU>",
"idValue": "<SKU>",
"productStoreId": "<STORE_ID>",
"facilityGroupId": "<FacilityGroupID>",
"conditionMap": {
"externalFacilityId_value": "<External Facility ID>",
"externalFacilityId_op": "<operator>"
}
}{
"idType": "SKU",
"idValue": "MSH02-32-Black",
"productStoreId": "DEMO_STORE",
"facilityGroupId": "FAC_GRP",
"conditionMap": {
"externalFacilityId_value": "101",
"externalFacilityId_op": "notEqual"
}
}{
"onlineAtp": "<Value>"
}{
"onlineAtp": 100
}product-sku
Product SKU (internal name)
26897
quantity
Quantity of the product being transferred
11
origin-facility-id
ID of the originating facility
116
destination-facility-id
ID of the destination facility
281
item-external-id
External identifier for the item
1
tracking-number
Tracking number associated with the shipment
788944217767
shipment-attribute
Additional attributes (e.g., EXTERNAL_ORDER_ID)
EXTERNAL_ORDER_ID:TO0005374
shipment-type
Type of the shipment (e.g., IN_TRANSFER)
IN_TRANSFER
DROP_SHIPMENT
Drop Shipment
TRANSFER
Transfer
INCOMING_SHIPMENT
Inbound Shipment
OUTGOING_SHIPMENT
Sample Shipment file
external-shipment-id
Unique identifier for the external shipment
12009298
The Shipping Check Inventory API allows to retrieve the inventory details for the products at specific locations. By calling the /checkShippingInventory endpoint of our next generation OMS with the POST/GET method, you can check the availability of the inventory available for shipping.
URL: https://<host>/rest/s1/ofbiz-oms-usl/checkShippingInventory
This API uses our next generation OMS instance. All traditional instances have access to this next generation OMS by replacing "oms" with "maarg" in the host name.
Production
Current Name: demo-oms
Maarg Name: demo-maarg
Example: https://demo-maarg.hotwax.io/rest/s1/ofbiz-oms-usl/checkShippingInventory
UAT
Current Name: demo-uat
Maarg Name: demo-maarg-uat
GET: When passing params in the URL
POST: When passing JSON body in the request
Content-Type: application/json
Using POST Method
Using GET Method
Using POST Method
Using GET Method
Notes
Either productIds and internalNames value is required, If both values are passed, then the value of productIds will be honored.
This API does not necessarily require the inventoryGroupId and facilityIds, If both values are not provided API will return an inventory of products at all the locations.
Select Products
Products can be queried in the inventory API by both their HotWax ID or their internalName. The internal name refers to the UPC or SKU, whichever one is selected as a primary identifier during product configuration. While both fields are optional, one is required to obtain a result.
productStoreId
Product Store represents a brand in HotWax Commerce. To obtain possible values, log into HotWax Commerce and view the product store list page for possible values.
inventoryGroupId
are used to segregate inventory for different channels of sales. Obtain the inventory group ID by logging into HotWax Commerce Facilities App and browsing inventory groups.
HTTP/1.1 200 OK
Content-Type: application/json
decisionReason explanationEach Decision Reason also comes with a detailed log of why the given check failed.
ProductStore - The facility ${facilityId} is not associated with Product Store ${productStoreId}.
Product Facility - The inventory for product ${productId} at facility ${facilityId} is not available.
Inventory Group - The facility ${facilityId} where the product ${productId} is located does not cater its inventory to that channel.
Inventory Group allowBrokering - Brokering of the product ${productId} for the inventory group ${inventoryGroupId} is not allowed globally.
Learn how to update product inventory in HotWax by logging variances of inputted amounts.
Updates the inventory of products in HotWax by logging a variance of the inputted amount. To update inventory you will need to call the endpoint with the POST method.
Example:
https://<host>/api/service/updateInventoryByIdentification
Example:
Content-Type: application/json
To access this endpoint, you need to include the authorization token in the request header.
Authorization: Bearer <access_token>
To learn more about Bearer token authentication, read this
Sample:
Table of valid variance reasons and their IDs:
HTTP/1.1 200 OK
Content-Type: application/json
Sample:
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
giftCardFulfillments
Inventory in HotWax: 10
Variance: -2
Updated inventory in HotWax: 8Outbound Shipment
PURCHASE_SHIPMENT
INCOMING_SHIPMENT
Purchase Shipment
SALES_RETURN
INCOMING_SHIPMENT
Sales Return Shipment
IN_TRANSFER
INCOMING_SHIPMENT
Inbound Transfer Shipment
SALES_SHIPMENT
OUTGOING_SHIPMENT
Sales Shipment
OUT_TRANSFER
OUTGOING_SHIPMENT
Outbound Transfer Shipment
PURCHASE_RETURN
OUTGOING_SHIPMENT
Purchase Return Shipment
inventoryGroupId
HotWax Commerce inventory group ID
"SHOPIFY_FAC_GRP"
Product Facility allowBrokering - The facility ${facilityId} where the product ${productId} inventory is located is disabled to cater to shipping orders.
productStoreId
The ID of the product store
"STORE"
productIds
HotWax Commerce internal product ID
"11855"
internalNames
The well-known ID of a product, usually UPC or SKU based on configuration
"XS-BLACK"
facilityIds
The HotWax Commerce facility ID where product inventory is located
ProductStore
The facility is not associated with the product store.
ProductFacility
The facility does not have PickUp enabled. Add it to the PickUp facility group to enable pickup.
InventoryGroup
The facility where the product is located does not cater its inventory to that channel.
AllowBrokeringInventoryGroup
Brokering is not allowed globally for the given inventory group.
AllowBrokeringFacility
The facility where the product inventory is located is disabled for brokering.
"114"
locationSeqId
The location ID in the facility where inventory item needs to be updated
Y
varianceReasonId
The ID of the reason that caused variance in inventory
Y
VAR_LOST
SKU inventory is lost
VAR_FOUND
Lost SKU inventory is found
WORN_DISPLAY
SKU inventory is worn and unusable from being on display
VAR_MANUAL
SKU inventory adjustment is done manually
idType
The type of product identifier. Currently supported ID types are SKU, UPCA,Shopify_Prod_ID
Y
idValue
The value of product identifier
Y
availableDelta
The variance in inventory quantity(delta)
Y
facilityId
The external facility ID where inventory item needs to be updated
MISMATCH
Inventory does not match the available SKU
NOT_IN_STOCK
SKU is not available
NO_VARIANCE_LOG
Use to pass null variance where variance field is required but not used
REJ_RSN_DAMAGED
Ordered SKU is rejected due to inventory damage
POS_SALE
Inventory consumed by sales made on an external point of sale system in the store
VAR_DAMAGED
Reduce damaged inventory from available quantity
Y
{
"productStoreId": "STORE",
"productIds": "11855",
"internalNames": "XS-BLACK",
"facilityIds": "114",
"inventoryGroupId": "SHOPIFY_FAC_GRP"
}https://<host>/rest/s1/ofbiz-oms-usl/checkShippingInventory?productStoreId=STORE&productIds=11855&internalNames=XS-BLACK&facilityIds=114&inventoryGroupId=SHOPIFY_FAC_GRP{
"productStoreId": "STORE",
"productIds": ["11855", "11856", "118557"],
"internalNames": ["XS-BLACK", "S-BLACK", "M-BLACK"],
"facilityIds": ["114", "115", "116"],
"inventoryGroupId": "SHOPIFY_FAC_GRP"
}https://<host>/rest/s1/ofbiz-oms-usl/checkShippingInventory?productStoreId=STORE&productIds=11855,11856,118557&internalNames=XS-BLACK,S-BLACK,M-BLACK&facilityIds=114,115,116&inventoryGroupId=SHOPIFY_FAC_GRP{
"resultList": [
{
"productId": "10560",
"totalAtp": 13,
"totalComputedAtp": 13,
"totalSafetyStock": 0.0,
"facilities": [
{
"facilityId": "100",
"safetyStock": 0.0,
"computedAtp": 6,
"atp": 6
},
{
"facilityId": "57",
"safetyStock": 0.0,
"computedAtp": 7,
"atp": 7
}
]
}
]
}{
"resultList": [
{
"productId": "10560",
"totalAtp": 0.0,
"totalComputedAtp": 0.0,
"totalSafetyStock": 0.0,
"facilities": [
{
"decisionReasonDesc": "The inventory for product 10560 at facility RETAIL_WAREHOUSE is not available",
"facilityId": "RETAIL_WAREHOUSE",
"safetyStock": 0.0,
"computedAtp": 0.0,
"atp": 0.0,
"decisionReason": "ProductFacility"
}
]
}
]
}{
"resultList": [
{
"productId": "10560",
"inventoryGroupId": "FAC_GRP",
"decisionReason": "AllowBrokeringInventoryGroup",
"decisionReasonDesc": "Brokering of the product 10560 for the inventory group FAC_GRP is not allowed globally."
}
]
}{
"facilityId": ,
"availableDelta": ,
"idType": ,
"idValue": ,
"locationSeqId": ,
"varianceReasonId":
}
{
"facilityId": "WH",
"availableDelta": 4,
"idType": "UPCA",
"idValue": "30065245099",
"locationSeqId": "TLTLTLLL01",
"varianceReasonId": "POS_SALE"
}
{
{
"facilityId": ,
"availableDelta": ,
"idType": ,
"idValue": ,
"locationSeqId": ,
"varianceReasonId": ,
},
"webSiteId": ""
}{
{
"facilityId": "WH",
"availableDelta": 4,
"idType": "UPCA",
"idValue": "30065245099",
"locationSeqId": "TLTLTLLL01",
"varianceReasonId": "POS_SALE"
},
"webSiteId": "API"
}{
"orders": [
{
"id": "#test02",
"channel_type": "web",
"external_id": 3409,
"currency": "USD",
"subtotal": 45.00,
"tax_total": 5.85,
"placed_at": "2023-07-08T12:08:34.000Z",
"shipping_tax_code": "AVATAX",
"shipping_service_level": "STANDARD_UPS",
"shipping_total": 0.00,
"discounts": [],
"discount_total": 30,
"channel": "BDC",
"customer_id": 5320856,
"customer_email":"[email protected]",
"payment_account": {
"payment_method": "credit_card",
"payment_provider": "shopify",
"amount":"45.00"
},
"billing_address": {
"name": "Appurva Jain",
"address_line_1": "175 S Main St Suite",
"address_line_2": "",
"city": "Salt Lake City",
"state": "UT",
"country": "US",
"zip_code": "84111",
"phone": "18006984637"
},
"shipping_address": {
"name": "Appurva Jain",
"address_line_1": "175 S Main St Suite 1310123",
"address_line_2": "",
"city": "Salt Lake City",
"state": "UT",
"country": "US",
"zip_code": "84111",
"phone": "18006984637"
},
"items": [
{
"id": 101,
"external_id": "",
"product_id": "1110352-010-L",
"pricebook_price": 45.00,
"quantity": 1,
"tax": 5.85,
"tax_code": "AVATAX",
"tag": "",
"closed": "",
"discounts": [],
"shipping_service_level": "STANDARD_UPS",
"item_discounts":0.0,
"order_discounts":0.0,
"status":"opened",
"extended_attributes": [
{
"name":"requires_shipping",
"value":"True"
}
]
}
]
}
]
}Deprecated (since maarg 4.4.0): Use admin/user
Discover how the Store Lookup API facilitates finding stores accepting BOPIS orders near the customer's location using the POST method.
The API allows to look up the stores accepting BOPIS orders near the customer’s location using the POST method.
https://< host >/rest/s1/api/stores
Method: POST
Example: Host: https://demo-maarg.hotwax.io/rest/s1/api/store
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Filter is a parameter that allows you to narrow down the results of a query or search to only include items that meet specific criteria. For storeLookup API, users can filter results for each parameter given in the response:
RETAIL
WAREHOUSE
RETAIL_STORE
OUTLET_WAREHOUSE
Discover how the Post Code Lookup API fetches information related to postal codes, aiding developers in various applications.
The Post Code Lookup API provides developers with the ability to fetch information related to postal codes. This API offers three main functionalities:
Fetching postal codes for a given latitude and longitude within a specified range
Fetching latitude and longitude for a given postal code
Fetching latitude and longitude for a partial postal code
Fetches the postal code for a specific location based on its latitude and longitude. The API can also return postal codes for locations within a specified distance range from the provided latitude and longitude. To get the postal code, you will need to call /geocode endpoint with the POST method.
https://<host>/rest/s1/api/geocode
Content-Type: application/json
Note:
pt and d parameters are required to get the post codes
d = 0 will fetch exact post code value for passed latitude and longitude
d > 0 will fetch post codes within the given distance
HTTP/1.1 200 OK
Content-Type: application/json
Fetches the latitude longitude for a specific postal code. To look up the latitude longitude you will need to call the endpoint with the POST method.
https://<host>/rest/s1/api/geocode
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Fetches the latitude longitude for a partial postal code. This API fetches all the latitude and longitude matching the partial postal code. To look up the latitude longitude for a partial postal code you will need to call the endpoint with the POST method.
https://<host>/rest/s1/api/geocode
Content-Type: application/json
HTTP/1.1 200 OK
Content-Type: application/json
OFBiz services that are exposed via REST interface with export attribute set to true
location
The latitude and longitude points of the postal code
q
The query parameter
N
fq
Applies a filter to the query search results
N
pt
The latitude and longitude of the location
N
d
The distance from which postal code needs to be fetched
numfound
The number of results found
postcode
The postal code for the provided latitude and longitude
latitude
The latitude of the postal code
longitude
The longitude of the postal code
country
The country of the provided postal code
country-code-ID
The country code ID of the provided country
postcode
The postal code
Y
postcode
The postal code for the provided latitude and longitude
latitude
The latitude of the postal code
longitude
The longitude of the postal code
country
The country of the provided postal code
country-code-id
The country code ID of the provided country
location
The latitude and longitude points of the postal code
postcodelike
The partial postal code
Y
fields
The data fields or attributes that are included in the response body of the API call
Y
latitude
The latitude of the postal code
longitude
The longitude of the postal code
N
{
"json": {
"params": {
"q": "*:*",
"fq": "{!geofilt sfield=location}",
"pt": "18.180555,-66.749961",
"d": "10"
}
}
}{
"responseHeader": {
"status": 0,
"QTime": 2,
"params": {
"json": "{\"params\":{\"q\":\"*:*\",\"fq\":\"{!geofilt-sfield=location}\",\"pt\":\"18.180555,-66.749961\",\"d\":\"10\"}}"
}
},
"response": {
"numFound": 1,
"start": 0,
"numFoundExact": true,
"docs": [
{
"postcode": "601",
"latitude": "18.180555",
"longitude": "-66.749961",
"country": "USA",
"country-code-id": "601-USA",
"location": "18.180555,-66.749961",
"_version_": 1752733513051799552
}
]
}
}{
"json": {
"query": "postcode:10001"
}
}{
"response": {
"numFound": 1,
"start": 0,
"numFoundExact": true,
"docs": [
{
"postcode": "10001",
"latitude": "40.750636",
"longitude": "-73.997177",
"country": "USA",
"countryCodeAlpha3": "USA",
"countryCodeAlpha2": "US",
"country-code-id": "10001-US",
"location": "40.750636,-73.997177",
"_version_": 1790686106947158016
}
]
}
}{
"json": {
"query": "postcodelike:6011",
"fields": ["latitude", "longitude"]
}
}"response": {
"numFound": 2,
"start": 0,
"numFoundExact": true,
"docs": [
{
"latitude": "40.130099",
"longitude": "-85.760763"
},
{
"latitude": "32.754272",
"longitude": "-97.083196"
}
]
}distance
The distance from the passed latitude-longitude
N
sortBy
Sort data based on the attribute, for example: "storeDistance asc" sorts results by distance
N
keyword
Keyword search (only on storeName, storeCode, and externalId)
N
fieldsToSelect
The list of fields to select, all the fields can be filtered in response
N
storeType
The type of the store
storeName
Store Name
externalId
The Id of the store in the external reference source
primaryFacilityGroupId
The Id of the primary facility group
primaryFacilityGroupName
primaryShopifyShopId
The Id of the primary Shopify Shop
address1
The address of the store
city
City
postalCode
Postal Code
country
Country
countryCode
Country Code
stateCode
State Code
latLon
The latitude and longitude of the facility
<day_of_week>_open
The opening time of the store on the day of a week
<day_of_week>_close
The closing time of the store on the day of a week
primaryShopifyShopId
The Id of the primary Shopify Shop
city
City
postalCode
Postal Code
countryCode
Country Code
stateCode
State Code
latlon
The latitude and longitude of the facility
DISTRIBUTION_CENTER
viewSize
The total number of results to be fetched in the API response
N
viewIndex
Index of the view in pagination.
N
filter
Filter records based on the passed parameters
N
point
The latitude-longitude of a specific location to find nearby stores
numFound
The number of results found
docs
The array of results found
docType
Reference index
storeCode
The ID of the facility (store) in HotWax
identifier
DocType-Identifier
country
Country
country
Country
storeType
The type of the store
storeName
Store Name
externalId
The Id of the store in the external reference source
primaryFacilityGroupId
The Id of the primary facility group
primaryFacilityGroupName
The name of the primary facility group
N
{
"viewSize": 40,
"filters": ["storeType: RETAIL_STORE"],
"point": “lat,lon”,
"distance": 50,
"sortBy": "storeName asc",
"keyword": "value",
"fieldsToSelect": <values>
}"response":
{
"numFound": 1,
"start": 0,
"numFoundExact": true,
"docs": [
{
"docType": "STORE",
"storeCode": "524",
"Identifier": "524",
"docType-Identifier": "STORE-524-STORE-524",
"storeType": "RETAIL_STORE",
"storeName": "Orlando",
"externalId": "524",
"primaryFacilityGroupId": "10862657599",
"primaryFacilityGroupName": "Not naked",
"primaryShopifyShopId": "10862657599",
"10862657599_pref": "true",
"fac_grp_pref": "true",
"address1": "8200 Vineland Ave.,",
"city": "Orlando",
"postalCode": "32821",
"country": "United States",
"countryCode": "USA",
"state": "FlorIda",
"stateCode": "FL",
"latlon": "28.3873236,-81.4924445",
"monday_open": "10:00:00",
"monday_close": "21:00:00",
"tuesday_open": "10:00:00",
"tuesday_close": "21:00:00",
"wednesday_open": "10:00:00",
"thursday_open": "10:00:00",
"thursday_close": "21:00:00",
"frIday_open": "10:00:00",
"frIday_close": "21:00:00",
"saturday_open": "10:00:00",
"saturday_close": "21:00:00",
"sunday_open": "11:00:00",
"sunday_close": "19:00:00",
"updatedDatetime": "2023-01-31T05:52:08.794Z",
"_version_": 1756516139717885953,
"_root_": "STORE-524-STORE-524"
}
]
}To create a return for a customer's order that has already been fulfilled and completed, you will need to call the /createReturn endpoint with the POST method.
POST: https://{host}/api/createReturn
Content-Type: application/json
In the request body, include the information necessary for creating a return, including all the parameters listed below:
Types of Return Adjustments:
Return adjustments are used to categorize different return-level charges. By storing all adjustments as types of adjustments that can be applied to the return, instead of including them in the return header, they can be extended based on the needs of custom implementations and integrations.
The two return channels are as follows:
Content-Type: application/json
The response will include all the parameters provided in the request body, along with any error messages and login information.
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
Unique HotWax Commerce Order Identification
items
List of Order Items
orderName
Shopify Order Name
orderItemSeqId
Order Item Sequence
status
Current status of the return
grandTotal
Sum total of return items
returnIdentificationTypeId
Global Identification for the return (“SHOPIFY_RTN_ID”)
IdValue (in returnIdentification)
Unique Value for return identification
idType
Global Identification Type (SKU, INVOICE_EXPORT, ISBN, UPCA, UPCE)
idValue
Unique Id value for the global identification
shipFrom
Customer's address
shipTo
Destination address for returned order
sku
SKU for returned item
id (in item list)
Product id for that item
price
Price of the individual item
quantity
Product Quantity
orderItemExternalId (in item list)
Order Item id for external system (Shopify or Netsuite)
itemAdjustments
Record of adjustments (taxes or discounts) applied on the particular item
type
Type of return adjustments
returnAdjustments
Record of adjustments applied on the return
RET_MAN_ADJ
Return Manual Adjustment
RET_MISC_ADJ
Return Miscellaneous Charges
RET_MKTG_PKG_ADJ
Return Marketing Package Adjustment
RET_PROMOTION_ADJ
Return Promotion
RET_REPLACE_ADJ
Return Replacement
RET_RMA_ADJ
RMA Fee Adjustment
RET_SALES_TAX_ADJ
Return Sales Tax
RET_SHIPPING_ADJ
Return S&H
RET_SURCHARGE_ADJ
Return Surcharge
RET_VAT_PC_ADJ
Return VAT Price Correction
RET_VAT_TAX_ADJ
Return VAT Tax
RET_WARRANTY_ADJ
Return Warranty
Parameter Name
Description
externalId
Order identification in the external system (e.g. Shopify or Netsuite)
customerId
Customer’s Identification in HotWax Commerce (partyId)
companyId
Identification for the Company owning the brand
currencyCode
Currency unit of measurement (USD, INR, YEN, etc.)
facilityId
Facility where order is returned
idType
Identification Type
RET_ADD_FEATURE_ADJ
Return Additional Feature
RET_DEPOSIT_ADJ
Return Deposit Adjustment
RET_DISCOUNT_ADJ
Return Discount
RET_DUTY_ADJ
RMA Duty
RET_EXT_PRM_ADJ
Return External Promotion Adjustment
RET_FEE_ADJ
Return Fee
ECOM_RTN_CHANNEL
RETURN_CHANNEL
Ecom Return Channel
01
POS_RTN_CHANNEL
RETURN_CHANNEL
POS Return Channel
02
orderId
{
"payLoad": {
"externalId": "",
"type": "",
"returnDate": "",
"customerId": "",
"externalCustomerId": "",
"companyId": "",
"companyExternalId": "",
"status": "",
"currencyCode": "",
"grandTotal": ,
"tags": [ ],
"note": "",
"returnIdentifications": [
{
"returnIdentificationTypeId": "",
"returnIdentificationDesc": "",
"idValue": ""
}
],
"shipFrom": {
"postalAddress": {
"id": "",
"externalId": ""
}
},
"shipTo": {
"facilityId": ""
},
"items": [
{
"id": "",
"sku": "",
"idType": "",
"idValue": "",
"itemExternalId": "",
"itemSeqId": "",
"itemTypeId": "",
"status": "",
"orderId": "",
"orderExternalId": "",
"orderName": "",
"orderItemSeqId": "",
"orderItemExternalId": "",
"quantity": ,
"reason": "",
"returnType": "",
"restockType": "",
"price": ,
"itemAdjustments": [
{
"returnAdjustmentTypeId": "",
"amount":
},
{
"type": "",
"comments": "",
"description": "",
"amount": "",
"sourcePercentage": ""
}
]
}
],
"returnAdjustment": [
{
"orderId": "",
"orderExternalId": "",
"id": "",
"type": "",
"comments": "",
"description": "",
"amount": "",
"sourcePercentage": ""
}
]
}
}
{
"payLoad": {
"externalId": "5758438048028",
"type": "CUSTOMER_RETURN",
"customerId": "10317",
"externalCustomerId": "",
"companyId": "COMPANY",
"companyExternalId": "",
"status": "RETURN_RECEIVED",
"currencyCode": "CAD",
"grandTotal": 150.01,
"returnIdentifications": [
{
"returnIdentificationTypeId": "SHOPIFY_RTN_ID",
"returnIdentificationDesc": "MarketPlace Return",
"idValue": "5758438048028"
}
],
"shipFrom": {
"postalAddress": {
"id": "",
"externalId": ""
}
},
"shipTo": {
"facilityId": "KITST"
},
"items": [
{
"id": "10243",
"sku": "",
"idType": "UPCA",
"idValue": "1110352-7AY-M",
"itemExternalId": "",
"itemSeqId": "",
"itemTypeId": "PRODUCT_ORDER_ITEM",
"status": "RETURN_RECEIVED",
"orderId": "FAO11428",
"orderExternalId": "5758438048028",
"orderName": "101010236",
"orderItemSeqId": "00101",
"orderItemExternalId": "",
"quantity": 1,
"price": 89.5
}
]
}
}
_LOGIN_PASSED_": "T{
"_ERROR_MESSAGE_": "",
"payLoad": {
"externalId": "5758438048028",
"type": "CUSTOMER_RETURN",
"customerId": "10317",
"externalCustomerId": "",
"companyId": "COMPANY",
"companyExternalId": "",
"status": "RETURN_RECEIVED",
"currencyCode": "CAD",
"grandTotal": 150.01,
"returnIdentifications": [
{
"returnIdentificationTypeId": "SHOPIFY_RTN_ID",
"returnIdentificationDesc": "MarketPlace Return",
"idValue": "5758438048028"
}
],
"shipFrom": {
"postalAddress": {
"id": "",
"externalId": ""
}
},
"shipTo": {
"facilityId": "KITST"
},
"items": [
{
"id": "10243",
"sku": "",
"idType": "UPCA",
"idValue": "1110352-7AY-M",
"itemExternalId": "",
"itemSeqId": "",
"itemTypeId": "PRODUCT_ORDER_ITEM",
"status": "RETURN_RECEIVED",
"orderId": "FAO11428",
"orderExternalId": "5758438048028",
"orderName": "101010236",
"orderItemSeqId": "00101",
"orderItemExternalId": "",
"quantity": 1,
"price": 89.5
}
]
},
"USERNAME": "hotwax.user",
"RUE"
}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
Manifest.pdf
Deprecated (since maarg 4.4.0): Use admin/login
Deprecated (since maarg 4.4.0): Use admin/serviceJobs
URL: https://<host>/rest/s1/ofbiz-oms-usl/checkBopisInventory
This API uses our next generation OMS instance. All traditional instances have access to this next generation OMS by replacing "oms" with "maarg" in the host name.
Production
Current Name: demo-oms
Maarg Name: demo-maarg
UAT
Current Name: demo-uat
Maarg Name: demo-maarg-uat
Example: https://demo-maarg.hotwax.io/rest/s1/ofbiz-oms-usl/checkBopisInventory
GET (Recommended if your library supports sending a body in a GET request) POST
Content-Type: application/json
Single product and facility
Multiple products and facilities
productStoreId
The ID of the product store
"STORE"
productIds
HotWax Commerce internal product ID
"11855"
internalNames
The well known ID of a product, usually UPC or SKU based on configuration
"XS-BLACK"
facilityIds
The HotWax Commerce facility ID where product inventory is located
If both productIds and internalNames are passed, the value of productIds will be honored.
Select Products
Products can be queried in the inventory API by both their HotWax ID or their internalName. The internal name refers to the UPC or SKU, whichever one is selected as a primary identifier during product configuration. While both fields are optional, one is required to obtain a result.
productStoreId
Product Store represents a brand in HotWax Commerce. To obtain possible values, log into HotWax Commerce and view the product store list page for possible values.
inventoryGroupId Inventory groups are used to segregate inventory for different channels of sales. Obtain the inventory group ID by logging into HotWax Commerce Facilities App and browsing inventory groups.
HTTP/1.1 200 OK
Content-Type: application/json
ATP zeroed out due to the inventory checks
ProductStore
The facility is not associated with the product store.
PickUpFacility
The facility does not have PickUp enabled. Add it to the PickUp facility group to enable pickup.
InventoryGroup
The facility where the product is located does not cater its inventory to that channel.
AllowPickupInventoryGroup
Pickup is not allowed globally for the inventory group.
AllowPickupFacility
The facility where the product inventory is located is disabled for catering to BOPIS orders.
Each Decision Reason also comes with a detailed log of why the given check failed.
ProductStore - Facility ${facilityId} is not associated with Product Store ${productStoreId}.
PickUp Facility - Facility ${facilityId} is not a member of a PICKUP Facility Group.
Inventory Group - Facility ${facilityId} is not a member of ${inventoryGroupId} channel.
Product Inventory Group allowPickup - Pickup is not allowed for product ${productId} ${inventoryGroupId} inventory group.
Product Facility allowPickup - Pickup is not allowed for product ${productId} at facility ${facilityId}.
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
createOrderFulfillmentWave
Deprecated (since maarg 4.4.0): Use admin/productStores
Picklist.csv
Deprecated (since maarg 4.4.0): Use admin/productStores
{
"productStoreId": "STORE",
"productIds": "11855",
"internalNames": "XS-BLACK",
"facilityIds": "114",
"inventoryGroupId": "SHOPIFY_FAC_GRP"
}{
"productStoreId": "STORE",
"productIds": ["11855","11856","118557"],
"internalNames": ["XS-BLACK","S-BLACK","M-BLACK"],
"facilityIds": ["114","115","116"],
"inventoryGroupId": "SHOPIFY_FAC_GRP"
}{
"atp": 0.0,
"computedAtp": 0.0,
"decisionReason": "AllowPickupFacility"
"decisionReasonDesc": "Pickup is not allowed for product 11855 at facility 115."
}{
"atp": 50.0,
"safetyStock": 5.0,
"computedAtp": 45.0,
}{
"json": {
"params": {
"q": "docType:SHOPIFY_ORDER"
}
},
"coreName": "logInsights"
}{
"responseHeader": {
"zkConnected": true,
"status": 0,
"QTime": 0,
"params": {
"json": "{\"params\":{\"q\":\"docType:SHOPIFY_ORDER\"}}",
"_forwardedCount": "1"
}
},
"response": {
"numFound": 1,
"start": 0,
"numFoundExact": true,
"docs": [
{
"site": "",
"shopifyOrderName": "",
"orderCreatedDate": "",
"firstAttemptedImport": "",
"docType": "",
"ttl": "",
"errorMessage": "",
"timestamp": "",
"expire_at": "",
"document-id": "",
"version": ""
}
]
}
}{
"responseHeader": {
"zkConnected": true,
"status": 0,
"QTime": 0,
"params": {
"json": "{\"params\":{\"q\":\"docType:SHOPIFY_ORDER\"}}",
"_forwardedCount": "1"
}
},
"response": {
"numFound": 1,
"start": 0,
"numFoundExact": true,
"docs": [
{
"site": "https://hc-demo.myshopify.com/83950764316/orders/e218e7d5c7705560408de87178d8fa6b/authenticate?key=",
"shopifyOrderName": "#10101011010",
"orderCreatedDate": "1704335862000",
"firstAttemptedImport": "January 3, 2024 10:15:12 PM",
"docType": "SHOPIFY_ORDER",
"ttl": "+60DAYS",
"errorMessage": "Service [createShopifyOrder] target threw an unexpected exception (null)",
"timestamp": "2024-01-10T11:29:31.127Z",
"expire_at": "2024-03-10T11:29:31.127Z",
"document-id": "0a420d2e-1d21-12b3-a0b1-ae12d1c0a420",
"version": 17234167832143
}
]
}
}"114"
inventoryGroupId
HotWax Commerce inventory group ID
"SHOPIFY_FAC_GRP"
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
ruleGroups
orders
PackingSlipAndLabel.pdf
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
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
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).
viewIndex
Index of the view in pagination.
viewSize
Number of records to fetch per page.
filters
Filters to apply for querying specific orders.
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.
Authorization: Bearer <your_token>
Accept: application/json{
"viewIndex": "",
"viewSize": "1",
"filters": {
"partyId": "",
"partyId_op": "",
"partyId_ic": ""
}
}{
"filters": {
"externalId": "10025",
"externalId_op": "equals",
"externalId_ic": "Y"
}
}{
"count": "2",
"docs": [
{
"id": "",
"externalId": "",
"orderName": "",
"channel": "",
"channelDesc": "",
"customerId": "",
"customerExternalId": "",
"customerName": "",
"priority": "",
"orderDate": "",
"entryDate": "",
"expireDate": "",
"statusId": "",
"statusDesc": "",
"productStoreId": "",
"productStoreName": "",
"webSiteId": "",
"webSiteName": "",
"currencyCode": "",
"currencyCodeDesc": "",
"remainingSubTotal": null,
"grandTotal": null,
"tags": "",
"note": "",
"orderContacts": {
"email": {
"id": "",
"externalId": ""
}
},
"orderIdentifications": [
{
"orderIdentificationTypeId": "",
"orderIdentificationDesc": "",
"idValue": ""
}
],
"shipGroup": [
{
"facilityId": "",
"externalId": "",
"facilityName": "",
"maySplit": "",
"shipBy": "",
"shipAfter": "",
"carrierPartyId": "",
"shipmentMethodTypeId": "",
"carrierPartyName": "",
"trackingNumber": "",
"shipFrom": {
"postalAddress": {
"id": "",
"externalId": "",
"address1": "",
"address2": "",
"city": "",
"stateCode": "",
"postalCode": "",
"country": ""
},
"email": {
"id": "",
"externalId": "",
"email": ""
},
"phoneNumber": {
"id": "",
"externalId": "",
"areaCode": "",
"contactNumber": ""
}
},
"shipTo": {
"postalAddress": {
"id": "",
"externalId": "",
"toName": "",
"address1": "",
"address2": "",
"city": "",
"stateCode": "",
"postalCode": "",
"country": ""
},
"email": {
"id": "",
"externalId": "",
"email": ""
},
"phoneNumber": {
"id": "",
"externalId": "",
"areaCode": "",
"contactNumber": ""
}
},
"items": [
{
"itemSeqId": "",
"itemExternalId": "",
"productId": "",
"sku": "",
"name": "",
"status": "",
"quantity": null,
"unitPrice": null,
"unitListPrice": null,
"itemAdjustments": [
{
"id": "",
"type": "",
"comments": "",
"amount": null,
"sourcePercentage": null
}
]
}
]
}
],
"orderAdjustments": [
{
"id": "",
"type": "",
"typeDesc": "",
"comments": "",
"amount": null,
"sourcePercentage": null
}
],
"orderPaymentPref": [
{
"id": "",
"paymentMethodTypeId": "",
"paymentMethodTypeDesc": "",
"paymentMode": "",
"cardName": "",
"code": "",
"maxAmount": null,
"statusId": "",
"statusDesc": ""
}
],
"billTo": {
"postalAddress": {
"id": "",
"externalId": "",
"toName": "",
"address1": "",
"address2": "",
"city": "",
"stateCode": "",
"postalCode": "",
"country": ""
},
"email": {
"id": "",
"externalId": "",
"email": ""
},
"phoneNumber": {
"id": "",
"externalId": "",
"areaCode": "",
"contactNumber": ""
}
},
"billFrom": {
"id": "",
"externalId": "",
"name": "",
"postalAddress": {
"id": "",
"externalId": "",
"address1": "",
"address2": "",
"city": "",
"stateCode": "",
"postalCode": "",
"country": ""
},
"email": {
"id": "",
"externalId": "",
"email": ""
},
"phoneNumber": {
"id": "",
"externalId": "",
"areaCode": "",
"contactNumber": ""
}
}
}
]
}Learn about the Returns Financial Feed, a JSON-formatted return-wise feed generated from HotWax Commerce (HC) OMS.
The Returns Financial Feed, generated by HotWax, is a JSON-formatted feed containing details about returns created against orders, originating from both online and in-store channels. The feed is used to post the return details to ERP systems for finanacial reconciliation. The feed is transformed - by HotWax's intermediary systems - in a way that allow integrated third-party systems, such as the ERP systems, to ingest the generated data.
The Returns Financial Feed has certain out-of-the-box parameters that allow users to generate the feed as per their requirements.
Header Level Attributes
Nested Fields Within Header Level Attributes:
Nested Fields within returnAdjustments:
Nested Fields within customerPartyIdentifications:
Nested Fields within payments:
Nested Attributes / Fields within returnItems:
Item Level Attributes:
Nested Fields within shipTo:
Nested Fields within billTo:
Nested Fields within productIdentifications:
Nested Fields within returnItemAdjustments:
This document provides instructions for retrieving comprehensive details of a specific orde
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>
HTTP/1.1 200 OK
Content-Type: application/json
Filter returns made from different channels such as e-commerce returns or in-store returns.
customParametersMap
Filter returns using custom conditions, allowing flexibility in specifying new conditions. For example, {"returnReasonId_op": "empty", "returnReasonId_not": "Y"}.
optimize
Optimize the query or process for better performance.
productStoreId
Identifier for the product store.
productStoreExternalId
External ID for the product store.
customerPartyId
Identifier for the customer party.
isShippingChargesSent
Flag indicating if shipping charges were sent.
returnAdjustments
Array of adjustments related to the return.
customerPartyIdentifications
Array of identifications for the customer party.
tenderAmount
Amount tendered for the return.
payments
Array of payments related to the return.
returnItems
Array of items being returned.
returnItemAdjustments
List of maps for the adjustments against the return item
Parameter
Description
orderId
Filter return details for a specific HC order ID.
returnId
Filter return details for a specific HC return ID.
sinceReturnDate
Filter returns created in Shopify after a specific date.
sinceReturnCompletedDate
Filter returns completed in HotWax Commerce after a specific date. Corresponds to the completion date for return items in HotWax Commerce.
sinceEntryDate
Filter returns created after a specific date in HotWax Commerce. Corresponds to the entry date in HotWax Commerce.
productStoreIds
Filter returns for for particular product store IDs to generate brand-specific feeds. For example, "WSC_STORE".
returnId
Identifier for the return.
shopId
The Shopify Shop Id of the return
entryDate
Entry date for the return in HotWax Commerce.
returnDate
Creation date of the return in the E-commerce system.
returnChannelEnumId
Enum ID for the return channel.
completedDatetime
Date and time when the return was completed in Howax.
customerReferenceId
Identifier for customer reference.
amount
Amount of the adjustment.
description
Description of the adjustment.
...
More fields for the return adjustments.
partyId
Identifier for the party.
idValue
Value of the identification.
...
More fields for the customer party identifications.
paymentMethodTypeId
Type of payment method.
paymentMethodDescription
Description of the payment method.
statusId
Identifier for the status.
...
More fields for the payments.
returnId
Identifier for the return.
returnItemSeqId
Sequence ID for the return item.
orderId
Identifier for the order.
...
More fields for the return items.
billTo
Map of billing address details
productIdentification
List of maps for the product details of the return item
houseNumberExt
Extension for the house number.
contactMechId
Identifier for the contact mechanism.
postalCode
Postal code of the address.
...
More fields for the shipping address.
houseNumberExt
Extension for the house number.
address2
Additional address information.
postalCode
Postal code of the address.
...
More fields for the billing address.
productId
Identifier for the product.
goodIdentificationTypeId
Type of good identification.
idValue
Value of the identification.
...
More fields for the product identifications.
customerReferenceId
Identifier for customer reference.
amount
Amount of the adjustment.
description
Description of the adjustment.
...
More fields for the return item adjustments.
[
{
"returnId": "10821",
"returnItemSeqId": null,
"returnReasonId": null,
"returnReasonNote": null,
"shopId": "DEMO_STORE",
"orderItemRequestedShipMethTypeId": null,
"entryDate": "2024-09-23T14:01:16-05:00",
"returnDate": "2024-09-20T12:17:33-05:00",
"returnChannelEnumId": "ECOM_RTN_CHANNEL",
"orderId": null,
"orderItemSeqId": null,
"returnItemAmountTotal": null,
"statusId": null,
"completedDatetime": "2024-09-23T13:41:36-05:00",
"productStoreId": "WSC_STORE",
"orderName": null,
"productStoreExternalId": "7",
"customerPartyId": "10371",
"returnStatusId": "RETURN_COMPLETED",
"returnTypeId": null,
"isShippingChargesSent": "Y",
"returnAdjustments": [],
"customerPartyIdentifications": [
{
"partyIdentificationTypeId": "NETSUITE_CUSTOMER_ID",
"lastUpdatedStamp": "2024-02-17T05:20:19-05:00",
"partyId": "10371",
"idValue": "8862402"
},
{
"partyIdentificationTypeId": "SHOPIFY_CUST_ID",
"idValue": "7856592781596",
"partyId": "10371",
"lastUpdatedStamp": "2024-02-17T04:50:07-05:00"
}
],
"tenderAmount": 179.68,
"payments": [
{
"paymentMethodCode": null,
"paymentMode": null,
"amount": 179.68,
"manualAuthCode": null,
"orderId": "DEV12410",
"applicationIdentifier": null,
"manualRefNum": "7444160020764",
"statusId": "PAYMENT_REFUNDED",
"requestId": null,
"paymentMethodTypeId": "EXT_SHOP_MANUAL",
"createdDate": "2024-11-18T06:01:16-05:00",
"paymentMethodDescription": "Manual",
"returnId": "10821"
}
],
"returnItems": [
{
"returnId": "10821",
"returnItemSeqId": "00101",
"orderId": "DEV12410",
"orderItemSeqId": "00102",
"returnItemPrice": 79.5,
"returnQuantity": 1,
"returnReasonId": "STYLE",
"productId": "10003",
"returnReasonNote": null,
"returnItemStatusId": "RETURN_COMPLETED",
"orderItemRequestedShipMethTypeId": "STANDARD",
"taxCode": "PC040100",
"orderItemExternalId": "15300755063068",
"orderName": "#HCDEV4364",
"facilityExternalId": "94",
"facilityId": "BROADWAY",
"facilityTypeId": "RETAIL_STORE",
"parentFacilityTypeId": "PHYSICAL_STORE",
"productStoreExternalId": "7",
"currencyUom": "USD",
"customerPartyId": "10371",
"shipToContactMechId": null,
"returnDate": "2024-09-23T13:41:36-04:00",
"returnExternalId": "5816353052",
"returnTypeId": "RTN_REFUND",
"receivedQuantity": null,
"completedDatetime": "2024-11-18T06:01:16-05:00",
"shipTo": null,
"billTo": {
"longitude": -79.38066,
"houseNumberExt": null,
"postalCodeGeoId": null,
"stateProvinceGeoCode": "ON",
"houseNumber": null,
"postalCodeExt": null,
"attnName": null,
"countyGeoId": null,
"cityGeoId": null,
"postalCode": "L3V 1P5",
"latitude": 44.606503,
"stateProvinceGeoId": "ON",
"contactMechId": "20656",
"address2": null,
"toName": "John Doe",
"encodedAddressKey": null,
"stateProvinceGeoName": "Ontario",
"address1": "746 Atherley Road",
"countryGeoCode": "CA",
"countryGeoId": "CAN",
"directions": null,
"city": "Orillia",
"municipalityGeoId": null,
"countryGeoName": "Canada",
"geoPointId": null
},
"productIdentifications": [
{
"fromDate": "2024-02-26T04:12:21-05:00",
"lastUpdatedStamp": "2024-02-26T04:12:21-05:00",
"idValue": "6104.42.00.10",
"goodIdentificationTypeId": "HS_CODE",
"productId": "10003",
"thruDate": null
},
{
"fromDate": "2024-01-08T11:20:16-05:00",
"goodIdentificationTypeId": "NETSUITE_PRODUCT_ID",
"idValue": "44509",
"productId": "10003",
"lastUpdatedStamp": "2024-08-13T01:37:02-04:00",
"thruDate": null
},
{
"lastUpdatedStamp": "2024-02-09T06:34:09-05:00",
"goodIdentificationTypeId": "SHOPIFY_PROD_ID",
"fromDate": "2024-01-08T06:53:02-05:00",
"productId": "10003",
"idValue": "47264706134300",
"thruDate": null
},
{
"lastUpdatedStamp": "2024-02-09T06:34:09-05:00",
"idValue": "2120096-1DD-M",
"fromDate": "2024-01-08T06:53:02-05:00",
"productId": "10003",
"goodIdentificationTypeId": "SHOPIFY_PROD_SKU",
"thruDate": null
},
{
"idValue": "2120096-1DD-M",
"goodIdentificationTypeId": "SKU",
"fromDate": "2024-01-08T06:53:02-05:00",
"lastUpdatedStamp": "2024-02-09T06:34:09-05:00",
"productId": "10003",
"thruDate": null
},
{
"lastUpdatedStamp": "2024-01-08T06:53:02-05:00",
"idValue": "2120096-1DD-M",
"fromDate": "2024-01-08T06:53:02-05:00",
"goodIdentificationTypeId": "UPCA",
"productId": "10003",
"thruDate": null
}
],
"returnItemAdjustments": [
{
"customerReferenceId": null,
"shipGroupSeqId": "_NA_",
"correspondingProductId": null,
"createdDate": "2024-09-23T08:41:26-04:00",
"comments": "CANADA GST/TPS",
"includeInShipping": null,
"lastUpdatedStamp": "2024-11-18T06:01:16-05:00",
"orderId": "DEV12410",
"exemptAmount": null,
"productPromoId": null,
"taxAuthPartyId": null,
"lastModifiedByUserLogin": null,
"returnAdjustmentTypeId": "RET_SALES_TAX_ADJ",
"description": "Return Sales Tax",
"primaryGeoId": null,
"taxAuthGeoId": null,
"secondaryGeoId": null,
"orderAdjustmentId": "15832",
"returnId": "10821",
"sourcePercentage": 0.05,
"returnAdjustmentId": "10702",
"returnItemSeqId": "00101",
"createdByUserLogin": "hotwax.user",
"lastModifiedDate": null,
"sourceReferenceId": null,
"productPromoRuleId": null,
"productFeatureId": null,
"taxAuthorityRateSeqId": null,
"overrideGlAccountId": null,
"includeInTax": null,
"productPromoActionSeqId": null,
"amount": 3.98,
"returnTypeId": "RTN_REFUND"
},
{
"customerReferenceId": null,
"shipGroupSeqId": "_NA_",
"correspondingProductId": null,
"createdDate": "2024-09-23T08:41:26-04:00",
"includeInShipping": null,
"orderId": "DEV12410",
"exemptAmount": null,
"comments": "ONTARIO HST",
"productPromoId": null,
"taxAuthPartyId": null,
"lastModifiedByUserLogin": null,
"returnAdjustmentTypeId": "RET_SALES_TAX_ADJ",
"description": "Return Sales Tax",
"primaryGeoId": null,
"taxAuthGeoId": null,
"secondaryGeoId": null,
"orderAdjustmentId": "15833",
"returnId": "10821",
"returnItemSeqId": "00101",
"returnAdjustmentId": "10703",
"sourcePercentage": 0.08,
"amount": 6.36,
"createdByUserLogin": "hotwax.user",
"lastModifiedDate": null,
"sourceReferenceId": null,
"productPromoRuleId": null,
"productFeatureId": null,
"taxAuthorityRateSeqId": null,
"overrideGlAccountId": null,
"includeInTax": null,
"productPromoActionSeqId": null,
"lastUpdatedStamp": "2024-11-18T06:01:16-05:00",
"returnTypeId": "RTN_REFUND"
}
],
"facilityGroupMembers": [
{
"facilityGroupId": "AUTO_SHIPPING_LABEL",
"fromDate": "2024-10-05T07:58:20-04:00",
"sequenceNum": null,
"lastUpdatedStamp": "2024-10-05T07:58:24-04:00",
"facilityId": "BROADWAY",
"thruDate": null
},
{
"lastUpdatedStamp": "2024-10-15T11:08:42-04:00",
"fromDate": "2024-10-15T11:08:42-04:00",
"sequenceNum": null,
"facilityId": "BROADWAY",
"facilityGroupId": "FAC_GRP",
"thruDate": null
},
{
"fromDate": "2024-08-26T03:30:47-04:00",
"facilityGroupId": "ONLINE_FAC_GRP",
"sequenceNum": null,
"facilityId": "BROADWAY",
"lastUpdatedStamp": "2024-08-26T03:30:47-04:00",
"thruDate": null
},
{
"facilityGroupId": "OMS_FULFILLMENT",
"sequenceNum": null,
"fromDate": "2024-01-08T04:11:40-05:00",
"lastUpdatedStamp": "2024-01-08T04:11:40-05:00",
"facilityId": "BROADWAY",
"thruDate": null
},
{
"facilityGroupId": "PICKUP",
"sequenceNum": null,
"lastUpdatedStamp": "2024-11-13T08:50:58-05:00",
"facilityId": "BROADWAY",
"fromDate": "2024-11-13T08:50:58-05:00",
"thruDate": null
},
{
"fromDate": "2024-06-27T10:42:13-04:00",
"sequenceNum": null,
"facilityGroupId": "PICKUP",
"lastUpdatedStamp": "2024-06-27T10:42:13-04:00",
"facilityId": "BROADWAY",
"thruDate": null
},
{
"facilityGroupId": "STORES_FAC_GRP",
"lastUpdatedStamp": "2025-01-16T14:51:05-05:00",
"sequenceNum": 5,
"facilityId": "BROADWAY",
"fromDate": "2025-01-16T14:51:05-05:00",
"thruDate": null
},
{
"sequenceNum": null,
"lastUpdatedStamp": "2024-07-25T05:20:32-04:00",
"facilityGroupId": "US_INVENTORY",
"fromDate": "2024-07-25T05:20:32-04:00",
"facilityId": "BROADWAY",
"thruDate": null
},
{
"lastUpdatedStamp": "2024-03-20T06:13:09-04:00",
"sequenceNum": null,
"fromDate": "2024-03-20T06:13:09-04:00",
"facilityId": "BROADWAY",
"facilityGroupId": "_NA_",
"thruDate": null
}
]
},
{
"returnId": "10821",
"returnItemSeqId": "00102",
"orderId": "DEV12410",
"orderItemSeqId": "00101",
"returnItemPrice": 79.5,
"returnQuantity": 1,
"returnReasonId": "UNWANTED",
"productId": "10004",
"returnReasonNote": null,
"returnItemStatusId": "RETURN_COMPLETED",
"orderItemRequestedShipMethTypeId": "STANDARD",
"taxCode": "PC040100",
"orderItemExternalId": "15300755095836",
"orderName": "#HCDEV4364",
"facilityExternalId": "94",
"facilityId": "BROADWAY",
"facilityTypeId": "RETAIL_STORE",
"parentFacilityTypeId": "PHYSICAL_STORE",
"productStoreExternalId": "7",
"currencyUom": "USD",
"customerPartyId": "10371",
"shipToContactMechId": null,
"returnDate": "2024-09-23T13:41:36-04:00",
"returnExternalId": "5816353052",
"returnTypeId": "RTN_REFUND",
"receivedQuantity": null,
"completedDatetime": "2024-11-18T06:01:16-05:00",
"shipTo": null,
"billTo": {
"longitude": -79.38066,
"houseNumberExt": null,
"postalCodeGeoId": null,
"stateProvinceGeoCode": "ON",
"houseNumber": null,
"postalCodeExt": null,
"attnName": null,
"countyGeoId": null,
"cityGeoId": null,
"postalCode": "L3V 1P5",
"latitude": 44.606503,
"stateProvinceGeoId": "ON",
"contactMechId": "20656",
"address2": null,
"toName": "John Doe",
"encodedAddressKey": null,
"stateProvinceGeoName": "Ontario",
"address1": "746 Atherley Road",
"countryGeoCode": "CA",
"countryGeoId": "CAN",
"directions": null,
"city": "Orillia",
"municipalityGeoId": null,
"countryGeoName": "Canada",
"geoPointId": null
},
"productIdentifications": [
{
"idValue": "6104.42.00.10",
"goodIdentificationTypeId": "HS_CODE",
"lastUpdatedStamp": "2024-02-26T04:12:21-05:00",
"productId": "10004",
"fromDate": "2024-02-26T04:12:21-05:00",
"thruDate": null
},
{
"idValue": "44508",
"goodIdentificationTypeId": "NETSUITE_PRODUCT_ID",
"lastUpdatedStamp": "2024-08-13T01:37:02-04:00",
"productId": "10004",
"fromDate": "2024-01-08T11:20:16-05:00",
"thruDate": null
},
{
"lastUpdatedStamp": "2024-02-12T01:54:01-05:00",
"goodIdentificationTypeId": "SHOPIFY_PROD_ID",
"productId": "10004",
"idValue": "47264706101532",
"fromDate": "2024-01-08T06:53:02-05:00",
"thruDate": null
},
{
"idValue": "2120096-1DD-L",
"productId": "10004",
"lastUpdatedStamp": "2024-02-12T01:54:01-05:00",
"fromDate": "2024-01-08T06:53:02-05:00",
"goodIdentificationTypeId": "SHOPIFY_PROD_SKU",
"thruDate": null
},
{
"idValue": "2120096-1DD-L",
"goodIdentificationTypeId": "SKU",
"productId": "10004",
"lastUpdatedStamp": "2025-01-28T05:14:13-05:00",
"fromDate": "2024-01-08T06:53:02-05:00",
"thruDate": null
},
{
"idValue": "2120096-1DD-L",
"goodIdentificationTypeId": "SKU",
"productId": "10004",
"fromDate": "2024-01-08T06:53:02-05:00",
"lastUpdatedStamp": "2024-02-12T01:54:01-05:00",
"thruDate": null
},
{
"idValue": "2120096-1DD-L",
"productId": "10004",
"goodIdentificationTypeId": "UPCA",
"lastUpdatedStamp": "2025-01-28T05:14:13-05:00",
"fromDate": "2024-01-08T06:53:02-05:00",
"thruDate": null
},
{
"idValue": "2120096-1DD-L",
"lastUpdatedStamp": "2024-01-08T06:53:02-05:00",
"productId": "10004",
"goodIdentificationTypeId": "UPCA",
"fromDate": "2024-01-08T06:53:02-05:00",
"thruDate": null
}
],
"returnItemAdjustments": [
{
"customerReferenceId": null,
"shipGroupSeqId": "_NA_",
"correspondingProductId": null,
"createdDate": "2024-09-23T08:41:26-04:00",
"comments": "CANADA GST/TPS",
"includeInShipping": null,
"orderId": "DEV12410",
"exemptAmount": null,
"productPromoId": null,
"taxAuthPartyId": null,
"lastModifiedByUserLogin": null,
"returnAdjustmentTypeId": "RET_SALES_TAX_ADJ",
"description": "Return Sales Tax",
"orderAdjustmentId": "15830",
"primaryGeoId": null,
"taxAuthGeoId": null,
"secondaryGeoId": null,
"returnId": "10821",
"sourcePercentage": 0.05,
"returnItemSeqId": "00102",
"createdByUserLogin": "hotwax.user",
"lastModifiedDate": null,
"returnAdjustmentId": "10704",
"sourceReferenceId": null,
"productPromoRuleId": null,
"productFeatureId": null,
"taxAuthorityRateSeqId": null,
"overrideGlAccountId": null,
"lastUpdatedStamp": "2024-11-18T06:01:16-05:00",
"includeInTax": null,
"productPromoActionSeqId": null,
"amount": 3.98,
"returnTypeId": "RTN_REFUND"
},
{
"customerReferenceId": null,
"shipGroupSeqId": "_NA_",
"correspondingProductId": null,
"createdDate": "2024-09-23T08:41:26-04:00",
"includeInShipping": null,
"orderId": "DEV12410",
"exemptAmount": null,
"comments": "ONTARIO HST",
"productPromoId": null,
"taxAuthPartyId": null,
"lastModifiedByUserLogin": null,
"returnAdjustmentTypeId": "RET_SALES_TAX_ADJ",
"description": "Return Sales Tax",
"primaryGeoId": null,
"taxAuthGeoId": null,
"orderAdjustmentId": "15831",
"secondaryGeoId": null,
"returnId": "10821",
"sourcePercentage": 0.08,
"returnItemSeqId": "00102",
"amount": 6.36,
"createdByUserLogin": "hotwax.user",
"lastUpdatedStamp": "2024-11-18T06:01:16-05:00",
"lastModifiedDate": null,
"sourceReferenceId": null,
"returnAdjustmentId": "10705",
"productPromoRuleId": null,
"productFeatureId": null,
"taxAuthorityRateSeqId": null,
"overrideGlAccountId": null,
"includeInTax": null,
"productPromoActionSeqId": null,
"returnTypeId": "RTN_REFUND"
}
],
"facilityGroupMembers": [
{
"facilityGroupId": "AUTO_SHIPPING_LABEL",
"fromDate": "2024-10-05T07:58:20-04:00",
"sequenceNum": null,
"lastUpdatedStamp": "2024-10-05T07:58:24-04:00",
"facilityId": "BROADWAY",
"thruDate": null
},
{
"lastUpdatedStamp": "2024-10-15T11:08:42-04:00",
"fromDate": "2024-10-15T11:08:42-04:00",
"sequenceNum": null,
"facilityId": "BROADWAY",
"facilityGroupId": "FAC_GRP",
"thruDate": null
},
{
"fromDate": "2024-08-26T03:30:47-04:00",
"facilityGroupId": "ONLINE_FAC_GRP",
"sequenceNum": null,
"facilityId": "BROADWAY",
"lastUpdatedStamp": "2024-08-26T03:30:47-04:00",
"thruDate": null
},
{
"facilityGroupId": "OMS_FULFILLMENT",
"sequenceNum": null,
"fromDate": "2024-01-08T04:11:40-05:00",
"lastUpdatedStamp": "2024-01-08T04:11:40-05:00",
"facilityId": "BROADWAY",
"thruDate": null
},
{
"facilityGroupId": "PICKUP",
"sequenceNum": null,
"lastUpdatedStamp": "2024-11-13T08:50:58-05:00",
"facilityId": "BROADWAY",
"fromDate": "2024-11-13T08:50:58-05:00",
"thruDate": null
},
{
"fromDate": "2024-06-27T10:42:13-04:00",
"sequenceNum": null,
"facilityGroupId": "PICKUP",
"lastUpdatedStamp": "2024-06-27T10:42:13-04:00",
"facilityId": "BROADWAY",
"thruDate": null
},
{
"facilityGroupId": "STORES_FAC_GRP",
"lastUpdatedStamp": "2025-01-16T14:51:05-05:00",
"sequenceNum": 5,
"facilityId": "BROADWAY",
"fromDate": "2025-01-16T14:51:05-05:00",
"thruDate": null
},
{
"sequenceNum": null,
"lastUpdatedStamp": "2024-07-25T05:20:32-04:00",
"facilityGroupId": "US_INVENTORY",
"fromDate": "2024-07-25T05:20:32-04:00",
"facilityId": "BROADWAY",
"thruDate": null
},
{
"lastUpdatedStamp": "2024-03-20T06:13:09-04:00",
"sequenceNum": null,
"fromDate": "2024-03-20T06:13:09-04:00",
"facilityId": "BROADWAY",
"facilityGroupId": "_NA_",
"thruDate": null
}
]
}
]
}
]returnChannelEnumId
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
No content
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
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.
<order_id>
The unique identifier of the order to retrieve.
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.
GET /rest/s1/available-to-promise/checkOmsConnection HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/available-to-promise/solrFacets HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"response": "text"
}Content-Type: application/json
Authorization: Bearer <your_token>
Accept: application/json{
"id": "",
"externalId": "",
"orderName": "",
"channel": "",
"channelDesc": "",
"customerId": "",
"customerExternalId": "",
"customerName": "",
"priority": "",
"orderDate": "",
"entryDate": "",
"expireDate": "",
"statusId": "",
"statusDesc": "",
"productStoreId": "",
"productStoreName": "",
"webSiteId": "",
"webSiteName": "",
"currencyCode": "",
"currencyCodeDesc": "",
"remainingSubTotal": null,
"grandTotal": null,
"tags": "",
"note": "",
"orderContacts": {
"email": {
"id": "",
"externalId": ""
}
},
"orderIdentifications": [
{
"orderIdentificationTypeId": "",
"orderIdentificationDesc": "",
"idValue": ""
}
],
"shipGroup": [
{
"facilityId": "",
"externalId": "",
"facilityName": "",
"maySplit": "",
"shipBy": "",
"shipAfter": "",
"carrierPartyId": "",
"shipmentMethodTypeId": "",
"carrierPartyName": "",
"trackingNumber": "",
"shipFrom": {
"postalAddress": {
"id": "",
"externalId": "",
"address1": "",
"address2": "",
"city": "",
"stateCode": "",
"postalCode": "",
"country": ""
},
"email": {
"id": "",
"externalId": "",
"email": ""
},
"phoneNumber": {
"id": "",
"externalId": "",
"areaCode": "",
"contactNumber": ""
}
},
"shipTo": {
"postalAddress": {
"id": "",
"externalId": "",
"toName": "",
"address1": "",
"address2": "",
"city": "",
"stateCode": "",
"postalCode": "",
"country": ""
},
"email": {
"id": "",
"externalId": "",
"email": ""
},
"phoneNumber": {
"id": "",
"externalId": "",
"areaCode": "",
"contactNumber": ""
}
},
"items": [
{
"itemSeqId": "",
"itemExternalId": "",
"productId": "",
"sku": "",
"name": "",
"status": "",
"quantity": null,
"unitPrice": null,
"unitListPrice": null,
"itemAdjustments": [
{
"id": "",
"type": "",
"comments": "",
"amount": null,
"sourcePercentage": null
}
]
}
]
}
],
"orderAdjustments": [
{
"id": "",
"type": "",
"typeDesc": "",
"comments": "",
"amount": null,
"sourcePercentage": null
}
],
"orderPaymentPref": [
{
"id": "",
"paymentMethodTypeId": "",
"paymentMethodTypeDesc": "",
"paymentMode": "",
"cardName": "",
"code": "",
"maxAmount": null,
"statusId": "",
"statusDesc": ""
}
],
"billTo": {
"postalAddress": {
"id": "",
"externalId": "",
"toName": "",
"address1": "",
"address2": "",
"city": "",
"stateCode": "",
"postalCode": "",
"country": ""
},
"email": {
"id": "",
"externalId": "",
"email": ""
},
"phoneNumber": {
"id": "",
"externalId": "",
"areaCode": "",
"contactNumber": ""
}
},
"billFrom": {
"id": "",
"externalId": "",
"name": "",
"postalAddress": {
"id": "",
"externalId": "",
"address1": "",
"address2": "",
"city": "",
"stateCode": "",
"postalCode": "",
"country": ""
},
"email": {
"id": "",
"externalId": "",
"email": ""
},
"phoneNumber": {
"id": "",
"externalId": "",
"areaCode": "",
"contactNumber": ""
}
}
}Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Note that this corresponds with the organizationPartyId that GL transactions will be posted to.
If immediately fulfilled (for physical stores, etc): don't send email notices, don't reserve inventory, and IFF inventory info isn't found on the server then don't issue inventory right away
If set to Y, when a new sales order is created with backordered items, then reservations on the facility/product are reassigned according to the priority given by the shipBeforeDate field.
Specify the type (Billing Account or Financial Account) of Store Credit Account used for refund return. Default to Financial Account. This field is override by ReturnHeader.billingAccountId or ReturnHeader.finAccountId, whichever is specified but if only finAccountId is specified explicitly then system will first try to locate any billing account with -ve amount. If found, then amount is credit to this billing account else the amount will be credit to the financial account of the user.
Default Y. Invoice digital items when order is placed rather than waiting for completing order items (though shipment/fulfillment).
Default Y. Require Shipping Address for Digital Items? Note this only has an effect if there are ONLY digital goods in the cart.
default Y; if set to N do not show isExempt checkbox for PartyTaxAuthInfo, always force to N
The auto-suggestion list is a special ShoppingList that the addSuggestionsToShoppingList service will maintain for cross-sells of ordered items.
default Y; if set to Y an additional constraint will of isVariant!=Y will be added to all product searches for the store
For auto-orders try other Credit Card expiration dates (if date is wrong or general failure where type not known)?
For auto-orders try other Credit Cards for the customer?
For auto-orders if Credit Cards fails for NSF (Not Sufficient Funds) try again later?
For auto-orders if Credit Cards fails for NSF try again how many times?
How many days that store credit is valid for. Null value implies no expiration.
If Y or empty, sales invoices created from orders will be marked ready.
If N, orders will not be automatically approved when payment is authorized.
If N, the captureOrderPayments will cause a service error if credit card capture fails.
If Y or empty, set the inventory item owner upon issuance.
Default N. This is the default value for the ReturnHeader.needsInventoryReceive field. If set to Y return will automatically go to the Received status when Accepted instead of waiting for actual receipt of the return.
Default N. If Y then on add to cart remove all products in cart with a ProductAssoc record related to or from the product and with the PRODUCT_INCOMPATABLE type.
Default N. If Y then on add to cart remove all products in cart with a ProductAssoc record related from the product and with the PRODUCT_UPGRADE type.
Default N. If Y then before the order is stored the OrderPaymentPreference record will be split, one for each OrderItemShipGroup.
If Y, the preparator can choose the InventoryItem by this lotId when he makes the picklist.
Default Y. If N then out of stock products will not be displayed on site
use to indicate if decimal quantity can be ordered for this producStore. Default value is Y
Allow comments for order line items per store
Catalog Url mount point to be used
Restocking fee percentage
Flag to identify if order payments have to be captured when order is added to CSV with value Y or N
Order for products of store will be placed with defined term type.
Mainly used to control nearest facility work flow
Flag to identify if the external promotions are enabled for the store.
Indicates number of days till order can be returned
Indicates Fee charged for Restocking.
Flag to identify if the return will be accepted automatically.
Product identifier to identify unique product
Flag to enable/disable auto preorder releasing on particular store/brand.
Flag to enable/disable brokering on particular store/brand.
Image path for display brand specific logo
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the rule.
Unique identifier for the rule group.
Name of the rule.
Status of the rule.
Sequence number for ordering.
Date and time when the rule was created.
User login ID of the creator.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
ruleSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Unique identifier for the rule.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Unique identifier for the rule.
ruleSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Unique identifier for the rule.
ruleCondition.PKAuthentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
No content
Unique identifier for the rule.
ruleAction.PKAuthentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
No content
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
In the absence of a product specific days to ship in ProductFacility, this will be used
This field store the unit of measurement of dimension (length, width and height)
This field stores facility ID of the external system
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.product.facility.FacilitySuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.product.facility.FacilitySuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Usage depends on enum type such as an ID format/mask
Indicator flag with meaning depending on enum type
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.product.facility.FacilityGroupSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.product.facility.FacilityGroupSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
In the absence of a product specific days to ship in ProductFacility, this will be used
This field store the unit of measurement of dimension (length, width and height)
This field stores facility ID of the external system
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.product.facility.FacilityGroupMemberSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Deprecated filed
Secrets are used to validate the integrity of webhooks
Old Secrets are used to validate the integrity of webhooks
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
co.hotwax.facility.ProductStoreFacilityGroupSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Note that this corresponds with the organizationPartyId that GL transactions will be posted to.
If immediately fulfilled (for physical stores, etc): don't send email notices, don't reserve inventory, and IFF inventory info isn't found on the server then don't issue inventory right away
If set to Y, when a new sales order is created with backordered items, then reservations on the facility/product are reassigned according to the priority given by the shipBeforeDate field.
Specify the type (Billing Account or Financial Account) of Store Credit Account used for refund return. Default to Financial Account. This field is override by ReturnHeader.billingAccountId or ReturnHeader.finAccountId, whichever is specified but if only finAccountId is specified explicitly then system will first try to locate any billing account with -ve amount. If found, then amount is credit to this billing account else the amount will be credit to the financial account of the user.
Default Y. Invoice digital items when order is placed rather than waiting for completing order items (though shipment/fulfillment).
Default Y. Require Shipping Address for Digital Items? Note this only has an effect if there are ONLY digital goods in the cart.
default Y; if set to N do not show isExempt checkbox for PartyTaxAuthInfo, always force to N
The auto-suggestion list is a special ShoppingList that the addSuggestionsToShoppingList service will maintain for cross-sells of ordered items.
default Y; if set to Y an additional constraint will of isVariant!=Y will be added to all product searches for the store
For auto-orders try other Credit Card expiration dates (if date is wrong or general failure where type not known)?
For auto-orders try other Credit Cards for the customer?
For auto-orders if Credit Cards fails for NSF (Not Sufficient Funds) try again later?
For auto-orders if Credit Cards fails for NSF try again how many times?
How many days that store credit is valid for. Null value implies no expiration.
If Y or empty, sales invoices created from orders will be marked ready.
If N, orders will not be automatically approved when payment is authorized.
If N, the captureOrderPayments will cause a service error if credit card capture fails.
If Y or empty, set the inventory item owner upon issuance.
Default N. This is the default value for the ReturnHeader.needsInventoryReceive field. If set to Y return will automatically go to the Received status when Accepted instead of waiting for actual receipt of the return.
Default N. If Y then on add to cart remove all products in cart with a ProductAssoc record related to or from the product and with the PRODUCT_INCOMPATABLE type.
Default N. If Y then on add to cart remove all products in cart with a ProductAssoc record related from the product and with the PRODUCT_UPGRADE type.
Default N. If Y then before the order is stored the OrderPaymentPreference record will be split, one for each OrderItemShipGroup.
If Y, the preparator can choose the InventoryItem by this lotId when he makes the picklist.
Default Y. If N then out of stock products will not be displayed on site
use to indicate if decimal quantity can be ordered for this producStore. Default value is Y
Allow comments for order line items per store
Catalog Url mount point to be used
Restocking fee percentage
Flag to identify if order payments have to be captured when order is added to CSV with value Y or N
Order for products of store will be placed with defined term type.
Mainly used to control nearest facility work flow
Flag to identify if the external promotions are enabled for the store.
Indicates number of days till order can be returned
Indicates Fee charged for Restocking.
Flag to identify if the return will be accepted automatically.
Product identifier to identify unique product
Flag to enable/disable auto preorder releasing on particular store/brand.
Flag to enable/disable brokering on particular store/brand.
Image path for display brand specific logo
In the absence of a product specific days to ship in ProductFacility, this will be used
This field store the unit of measurement of dimension (length, width and height)
This field stores facility ID of the external system
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.product.store.ProductStoreFacilitySuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the group
Unique identifier for the product store
Name of the group.
Type of the group.
Status identifier for the rule group.
Sequence number for ordering.
moqui.service.job.Service reference
Description or additional information about the group.
User login ID of the creator
Date and time when the group was created
Date and time when the group was updated
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
ruleGroupSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Unique identifier for the group
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Unique identifier for the group
ruleGroupSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Unique identifier for the rule group.
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the rule.
Name of the rule.
Status of the rule.
Sequence number for ordering.
Date and time when the rule was created.
User login ID of the creator.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Unique identifier for the rule group.
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the rule group run.
Unique identifier for the product store.
User login ID of the creator.
Indicator for the presence of errors.
Start date of the rule group run.
End date of the rule group run.
Result or outcome of the rule group run.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
This field stores picklist ID of the external system
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.shipment.picklist.PicklistSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.shipment.picklist.PicklistSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
falseINACTIVE_STOREStore Rejected InventoryAuthentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
falseINACTIVE_STOREStore Rejected InventoryAuthentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
This field stores product category ID of the external system
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Service to get the all the shipping rates for the shipmentId.
The ShipmentId to get the shipping rates.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
View to get ShipmentReceipt records for Transfer Order Items. This view is being used in the Receiving App to show the history of receipts for an item per datetimeReceived.
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Service to receive Transfer Order Items.
The ID of the Transfer Order in OMS.
The ID of the Transfer Order in OMS.
The ID of the facility in OMS where Transfer Order is being received.
The date time at which the Transfer Order is being received in OMS.
{ec.user.nowTimestamp}Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Service to reject the Transfer Order. The Transfer Order will be moved to REJECTED_ITM_PARKING facility and the reservations will be cancelled. The Inventory Variance will be logged as per handling in reject#OrderItem oms service.
The ID of the rejected facility of the Transfer Order in OMS.
REJECTED_ITM_PARKINGAuthentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Service to close Transfer Order Item Fulfillment. This will set the OrderItem.cancelQuantity for the remaining quantity to be fulfilled if any, cancel the remaining reservations and set the item status to the next eligible Item Status based on the statusFlowId associated with the Transfer Order i.e. either ITEM_COMPLETED or ITEM_PENDING_RECEIPT for TO_Fulfill_Only and TO_Fulfill_And_Receive orders respectively. If the item is not yet shipped i.e. 0 quantity fulfilled, the item will be Cancelled in that scenario. The Order Status will be updated according to the item status change.
The ID of the Transfer Order in OMS.
The ID of the Transfer Order in OMS.
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Service to get Transfer Order Shipments and its details. This is being used to fetch all details for the Completed tab of transfer-order-details page and transfer-shipment-review page in Fulfillment app.
The ID of the Transfer Order in OMS.
The ID of the Shipment for Transfer Order in OMS.
The ID of the Shipment Status in OMS for Transfer Order.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Creates Shipment of type OUT_TRANSFER for the Transfer Order Items to be fulfilled.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Ship a Transfer Order Shipment. The service will update the trackingIdNumber, create Item Issuance, Inventory Item Detail and update the Shipment as SHIPMENT_SHIPPED.
The ID of the Transfer Order Shipment in OMS.
The ID of the Transfer Order Shipment in OMS.
The tracking number for the Shipment.
The ID of the Shipment Route Segment in OMS.
The ID of carrier party in OMS.
The Shipment Method Type in OMS.
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
The ID of the Transfer Order in OMS.
The ID of the origin facility of the Transfer Order in OMS.
The ID of the destination facility of the Transfer Order in OMS.
The order name of Transfer Order.
The ID of the Shipment Status in OMS. By default it returns Shipment in SHIPMENT_SHIPPED status.
The shipment shipped date of Transfer Order.
Page number to return, starting with zero.
Number of records per page (default 20).
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Service to get Transfer Order Shipment Packages. This is being used to fetch the package level details for the Shipped TOs be able to search by tracking number and order name in the Receiving app.
The ID of the Transfer Order in OMS.
The ID of the Transfer Order in OMS.
The ID of the Shipment for Transfer Order in OMS.
The ID of the origin facility of the Transfer Order Shipment in OMS.
The ID of the destination facility of the Transfer Order Shipment in OMS.
The ID of the Shipment Status in OMS for Transfer Order. By default it returns Shipment Packages for Shipments in SHIPMENT_SHIPPED status.
The tracking number of the Shipment Package for Transfer Order.
The created date of Shipment Package for Transfer Order.
Page number to return, starting with zero.
Number of records per page (default 20).
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.product.inventory.ExternalInventoryResetSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.product.inventory.ExternalInventoryResetSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
The rejectOrderItems service processes a rejection request for one or more items in an order. The rejection logic is driven by two key flags: maySplit and cascadeRejectByProduct, which determine the scope of the rejection. Rejection Logic: - maySplit = Y, cascadeRejectByProduct = N - Reject only the specific item included in the request. - maySplit = N, cascadeRejectByProduct = N - Reject all items in the same ship group as the specified item. - maySplit = Y, cascadeRejectByProduct = Y - Reject items with the same productId in the same facility and match the rejection criteria (e.g., shipment not yet packed or shipped). - maySplit = N, cascadeRejectByProduct = Y - Reject entire ship groups across all orders that contain the specified productId in the same facility, provided the shipment is not yet packed or shipped.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Service to get Carriers and shipment methods facets from shipments.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Generate manifest for carrier from Third Party Shipping Services
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.accounting.payment.GiftCardFulfillmentSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Party Id of pickers, list of maps
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
shipments
POST /rest/s1/available-to-promise/login HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 52
{
"username": "text",
"password": "text",
"token": "text"
}GET /rest/s1/available-to-promise/status HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/available-to-promise/user/profile HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"userId": "text",
"username": "text",
"userFullName": "text",
"timeZone": "text",
"locale": "text",
"emailAddress": "text",
"preferences": {
"userId": "text",
"preferenceKey": "text",
"preferenceValue": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"partyId": "text"
}GET /rest/s1/available-to-promise/user/getAvailableTimeZones HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"timeZones": [
{
"id": "text",
"label": "text",
"offset": "text"
}
]
}GET /rest/s1/available-to-promise/decisionRules HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/available-to-promise/decisionRules HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"_entity": "rule",
"ruleId": "text",
"ruleGroupId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/available-to-promise/decisionRules/{ruleId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "rule",
"ruleId": "text",
"ruleGroupId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"ruleConditions": [
{
"_entity": "ruleCondition",
"ruleId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"ruleConditionType": {
"_entity": "enums",
"enumId": "text",
"enumTypeId": "text",
"parentEnumId": "text",
"enumCode": "text",
"sequenceNum": 1,
"description": "text",
"optionValue": "text",
"optionIndicator": "text",
"relatedEnumId": "text",
"relatedEnumTypeId": "text",
"statusFlowId": "text",
"enumName": "text",
"primaryEnumerationGroupId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}
],
"ruleActions": [
{
"_entity": "ruleAction",
"ruleId": "text",
"actionSeqId": "text",
"actionTypeEnumId": "text",
"fieldName": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"ruleActionType": {
"_entity": "enums",
"enumId": "text",
"enumTypeId": "text",
"parentEnumId": "text",
"enumCode": "text",
"sequenceNum": 1,
"description": "text",
"optionValue": "text",
"optionIndicator": "text",
"relatedEnumId": "text",
"relatedEnumTypeId": "text",
"statusFlowId": "text",
"enumName": "text",
"primaryEnumerationGroupId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}
]
}POST /rest/s1/available-to-promise/decisionRules/{ruleId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 1476
{
"_entity": "rule",
"ruleId": "text",
"ruleGroupId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"ruleConditions": [
{
"_entity": "ruleCondition",
"ruleId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"ruleConditionType": {
"_entity": "enums",
"enumId": "text",
"enumTypeId": "text",
"parentEnumId": "text",
"enumCode": "text",
"sequenceNum": 1,
"description": "text",
"optionValue": "text",
"optionIndicator": "text",
"relatedEnumId": "text",
"relatedEnumTypeId": "text",
"statusFlowId": "text",
"enumName": "text",
"primaryEnumerationGroupId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}
],
"ruleActions": [
{
"_entity": "ruleAction",
"ruleId": "text",
"actionSeqId": "text",
"actionTypeEnumId": "text",
"fieldName": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"ruleActionType": {
"_entity": "enums",
"enumId": "text",
"enumTypeId": "text",
"parentEnumId": "text",
"enumCode": "text",
"sequenceNum": 1,
"description": "text",
"optionValue": "text",
"optionIndicator": "text",
"relatedEnumId": "text",
"relatedEnumTypeId": "text",
"statusFlowId": "text",
"enumName": "text",
"primaryEnumerationGroupId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}
]
}DELETE /rest/s1/available-to-promise/decisionRules/{ruleId}/conditions HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"_entity": "ruleCondition.PK",
"ruleId": "text",
"conditionSeqId": "text"
}DELETE /rest/s1/available-to-promise/decisionRules/{ruleId}/actions HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"_entity": "ruleAction.PK",
"ruleId": "text",
"actionSeqId": "text"
}POST /rest/s1/available-to-promise/facilities HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 700
{
"_entity": "org.apache.ofbiz.product.facility.Facility",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-12-09T15:21:30.070Z",
"closedDate": "2025-12-09T15:21:30.070Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/available-to-promise/facilities/{facilityId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "co.hotwax.facility.FacilityAndType",
"typeDescription": "text",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-12-09T15:21:30.070Z",
"closedDate": "2025-12-09T15:21:30.070Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"parentTypeId": "text",
"hasTable": "text"
}PUT /rest/s1/available-to-promise/facilities/{facilityId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 700
{
"_entity": "org.apache.ofbiz.product.facility.Facility",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-12-09T15:21:30.070Z",
"closedDate": "2025-12-09T15:21:30.070Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/available-to-promise/facilities/orderCount HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/available-to-promise/enums HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/available-to-promise/enums/{enumId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "moqui.basic.EnumerationAndType",
"typeDescription": "text",
"enumId": "text",
"enumTypeId": "text",
"parentEnumId": "text",
"enumCode": "text",
"sequenceNum": 1,
"description": "text",
"optionValue": "text",
"optionIndicator": "text",
"relatedEnumId": "text",
"relatedEnumTypeId": "text",
"statusFlowId": "text",
"enumName": "text",
"primaryEnumerationGroupId": "text"
}GET /rest/s1/available-to-promise/facilityGroups HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/available-to-promise/facilityGroups HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 239
{
"_entity": "org.apache.ofbiz.product.facility.FacilityGroup",
"facilityGroupId": "text",
"facilityGroupTypeId": "text",
"primaryParentGroupId": "text",
"facilityGroupName": "text",
"description": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/available-to-promise/facilityGroups/{facilityGroupId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "org.apache.ofbiz.product.facility.FacilityGroup",
"facilityGroupId": "text",
"facilityGroupTypeId": "text",
"primaryParentGroupId": "text",
"facilityGroupName": "text",
"description": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}PUT /rest/s1/available-to-promise/facilityGroups/{facilityGroupId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 239
{
"_entity": "org.apache.ofbiz.product.facility.FacilityGroup",
"facilityGroupId": "text",
"facilityGroupTypeId": "text",
"primaryParentGroupId": "text",
"facilityGroupName": "text",
"description": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}POST /rest/s1/available-to-promise/facilityGroups/{facilityGroupId}/facilities/{facilityId}/association HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 250
{
"_entity": "org.apache.ofbiz.product.facility.FacilityGroupMember",
"facilityId": "text",
"facilityGroupId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"sequenceNum": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/available-to-promise/productStores/{productStoreId}/facilityGroups HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/available-to-promise/productStores/{productStoreId}/facilityGroups/{facilityGroupId}/association HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 248
{
"_entity": "co.hotwax.facility.ProductStoreFacilityGroup",
"productStoreId": "text",
"facilityGroupId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"sequenceNumber": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}POST /rest/s1/available-to-promise/productStores/{productStoreId}/facilities/{facilityId}/association HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 247
{
"_entity": "org.apache.ofbiz.product.store.ProductStoreFacility",
"productStoreId": "text",
"facilityId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"sequenceNum": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}POST /rest/s1/available-to-promise/ruleGroups HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 340
{
"_entity": "ruleGroup",
"ruleGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"groupTypeEnumId": "text",
"statusId": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUser": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/available-to-promise/ruleGroups/{ruleGroupId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "ruleGroup",
"ruleGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"groupTypeEnumId": "text",
"statusId": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUser": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"decisionRules": [
{
"_entity": "rule",
"ruleId": "text",
"ruleGroupId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}POST /rest/s1/available-to-promise/ruleGroups/{ruleGroupId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 576
{
"_entity": "ruleGroup",
"ruleGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"groupTypeEnumId": "text",
"statusId": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUser": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"decisionRules": [
{
"_entity": "rule",
"ruleId": "text",
"ruleGroupId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}GET /rest/s1/available-to-promise/ruleGroups/{ruleGroupId}/rules HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/available-to-promise/ruleGroups/{ruleGroupId}/runNow HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"jobRunId": "text"
}GET /rest/s1/available-to-promise/ruleGroups/{ruleGroupId}/schedule HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"schedule": {
"jobName": "text",
"description": "text",
"serviceName": "text",
"transactionTimeout": 1,
"topic": "text",
"localOnly": "text",
"cronExpression": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"repeatCount": 1,
"paused": "text",
"expireLockTime": 1,
"minRetryTime": 1,
"priority": 1,
"parentJobName": "text",
"jobTypeEnumId": "text",
"permissionGroupId": "text",
"instanceOfProductId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}POST /rest/s1/available-to-promise/ruleGroups/{ruleGroupId}/schedule HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 439
{
"ruleGroupId": "text",
"systemMessageRemoteId": "text",
"transactionTimeout": 1,
"topic": "text",
"localOnly": "text",
"cronExpression": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"repeatCount": 1,
"paused": "text",
"expireLockTime": 1,
"minRetryTime": 1,
"priority": 1,
"parentJobName": "text",
"jobTypeEnumId": "text",
"permissionGroupId": "text",
"instanceOfProductId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}No content
No content
No content
No content
No content
No content
No content
No content
No content
POST /rest/s1/poorti/rejectOrderItems HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 268
{
"orderId": "text",
"rejectToFacilityId": "text",
"items": [
{
"orderItemSeqId": "text",
"quantity": "1",
"updateQOH": "text",
"maySplit": "N",
"cascadeRejectByProduct": "N",
"comments": "text",
"excludeOrderFacilityDuration": "text",
"rejectionReasonId": "text",
"kitComponents": [
"text"
]
}
]
}{
"cancelledReservations": [
"text"
]
}{
"token": "text",
"expirationTime": "text",
"api_key": "text"
}[
{
"_entity": "co.hotwax.common.status.StatusItemAndType",
"typeDescription": "text",
"statusId": "text",
"statusTypeId": "text",
"statusCode": "text",
"sequenceNum": 1,
"description": "text",
"statusAge": 1,
"parentTypeId": "text"
}
]GET /rest/s1/available-to-promise/user/productStore HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "org.apache.ofbiz.product.store.ProductStore",
"productStoreId": "text",
"primaryStoreGroupId": "text",
"storeName": "text",
"companyName": "text",
"title": "text",
"subtitle": "text",
"payToPartyId": "text",
"daysToCancelNonPay": 1,
"manualAuthIsCapture": "text",
"prorateShipping": "text",
"prorateTaxes": "text",
"viewCartOnAdd": "text",
"autoSaveCart": "text",
"autoApproveReviews": "text",
"isDemoStore": "text",
"isImmediatelyFulfilled": "text",
"inventoryFacilityId": "text",
"oneInventoryFacility": "text",
"checkInventory": "text",
"reserveInventory": "text",
"reserveOrderEnumId": "text",
"requireInventory": "text",
"balanceResOnOrderCreation": "text",
"requirementMethodEnumId": "text",
"orderNumberPrefix": "text",
"defaultLocaleString": "text",
"defaultCurrencyUomId": "text",
"defaultTimeZoneString": "text",
"defaultSalesChannelEnumId": "text",
"allowPassword": "text",
"defaultPassword": "text",
"explodeOrderItems": "text",
"checkGcBalance": "text",
"retryFailedAuths": "text",
"headerApprovedStatus": "text",
"itemApprovedStatus": "text",
"digitalItemApprovedStatus": "text",
"headerDeclinedStatus": "text",
"itemDeclinedStatus": "text",
"headerCancelStatus": "text",
"itemCancelStatus": "text",
"authDeclinedMessage": "text",
"authFraudMessage": "text",
"authErrorMessage": "text",
"visualThemeId": "text",
"storeCreditAccountEnumId": "text",
"usePrimaryEmailUsername": "text",
"requireCustomerRole": "text",
"autoInvoiceDigitalItems": "text",
"reqShipAddrForDigItems": "text",
"showCheckoutGiftOptions": "text",
"selectPaymentTypePerItem": "text",
"showPricesWithVatTax": "text",
"showTaxIsExempt": "text",
"vatTaxAuthGeoId": "text",
"vatTaxAuthPartyId": "text",
"enableAutoSuggestionList": "text",
"enableDigProdUpload": "text",
"prodSearchExcludeVariants": "text",
"digProdUploadCategoryId": "text",
"autoOrderCcTryExp": "text",
"autoOrderCcTryOtherCards": "text",
"autoOrderCcTryLaterNsf": "text",
"autoOrderCcTryLaterMax": 1,
"storeCreditValidDays": 1,
"autoApproveInvoice": "text",
"autoApproveOrder": "text",
"shipIfCaptureFails": "text",
"setOwnerUponIssuance": "text",
"reqReturnInventoryReceive": "text",
"addToCartRemoveIncompat": "text",
"addToCartReplaceUpsell": "text",
"splitPayPrefPerShpGrp": "text",
"managedByLot": "text",
"showOutOfStockProducts": "text",
"orderDecimalQuantity": "text",
"allowComment": "text",
"oldStyleSheet": "text",
"oldHeaderLogo": "text",
"oldHeaderMiddleBackground": "text",
"oldHeaderRightBackground": "text",
"catalogUrlMountPoint": "text",
"restockingFeePercentage": 1,
"capturePmntsOnOrdApproval": "text",
"termTypeId": "text",
"autoSetFacility": "text",
"enableExternalPromotion": "text",
"daysToReturn": 1,
"restockingFeeFixed": 1,
"autoAcceptReturn": "text",
"externalId": "text",
"allowSplit": "text",
"storeDomain": "text",
"productIdentifierEnumId": "text",
"enablePreOrderAutoReleasing": "text",
"enableBrokering": "text",
"storeLogoImageUrl": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
][
{
"_entity": "rule",
"ruleId": "text",
"ruleGroupId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"ruleConditions": [
{
"_entity": "ruleCondition",
"ruleId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"ruleConditionType": {
"_entity": "enums",
"enumId": "text",
"enumTypeId": "text",
"parentEnumId": "text",
"enumCode": "text",
"sequenceNum": 1,
"description": "text",
"optionValue": "text",
"optionIndicator": "text",
"relatedEnumId": "text",
"relatedEnumTypeId": "text",
"statusFlowId": "text",
"enumName": "text",
"primaryEnumerationGroupId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}
],
"ruleActions": [
{
"_entity": "ruleAction",
"ruleId": "text",
"actionSeqId": "text",
"actionTypeEnumId": "text",
"fieldName": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"ruleActionType": {
"_entity": "enums",
"enumId": "text",
"enumTypeId": "text",
"parentEnumId": "text",
"enumCode": "text",
"sequenceNum": 1,
"description": "text",
"optionValue": "text",
"optionIndicator": "text",
"relatedEnumId": "text",
"relatedEnumTypeId": "text",
"statusFlowId": "text",
"enumName": "text",
"primaryEnumerationGroupId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}
]
}
]{
"_entity": "rule.PK",
"ruleId": "text"
}{
"_entity": "rule.PK",
"ruleId": "text"
}GET /rest/s1/available-to-promise/facilities HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "co.hotwax.facility.FacilityAndType",
"typeDescription": "text",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-12-09T15:21:30.070Z",
"closedDate": "2025-12-09T15:21:30.070Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"parentTypeId": "text",
"hasTable": "text"
}
]{
"_entity": "org.apache.ofbiz.product.facility.Facility.PK",
"facilityId": "text"
}{
"_entity": "org.apache.ofbiz.product.facility.Facility.PK",
"facilityId": "text"
}[
{
"_entity": "co.hotwax.facility.FacilityOrderCount",
"facilityId": "text",
"lastOrderCount": 1,
"entryDate": "2025-12-09",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
][
{
"_entity": "moqui.basic.EnumerationAndType",
"typeDescription": "text",
"enumId": "text",
"enumTypeId": "text",
"parentEnumId": "text",
"enumCode": "text",
"sequenceNum": 1,
"description": "text",
"optionValue": "text",
"optionIndicator": "text",
"relatedEnumId": "text",
"relatedEnumTypeId": "text",
"statusFlowId": "text",
"enumName": "text",
"primaryEnumerationGroupId": "text"
}
][
{
"_entity": "org.apache.ofbiz.product.facility.FacilityGroup",
"facilityGroupId": "text",
"facilityGroupTypeId": "text",
"primaryParentGroupId": "text",
"facilityGroupName": "text",
"description": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]{
"_entity": "org.apache.ofbiz.product.facility.FacilityGroup.PK",
"facilityGroupId": "text"
}{
"_entity": "org.apache.ofbiz.product.facility.FacilityGroup.PK",
"facilityGroupId": "text"
}GET /rest/s1/available-to-promise/facilityGroups/{facilityGroupId}/facilities HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "co.hotwax.facility.FacilityGroupAndMember",
"parentFacilityTypeId": "text",
"facilityGroupId": "text",
"facilityGroupTypeId": "text",
"primaryParentGroupId": "text",
"facilityGroupName": "text",
"description": "text",
"facilityId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"sequenceNum": 1,
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-12-09T15:21:30.070Z",
"closedDate": "2025-12-09T15:21:30.070Z",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text"
}
]{
"_entity": "org.apache.ofbiz.product.facility.FacilityGroupMember.PK",
"facilityId": "text",
"facilityGroupId": "text",
"fromDate": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/available-to-promise/shopifyShops HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "co.hotwax.shopify.ShopifyShopAndConfig",
"shopId": "text",
"shopifyShopId": "text",
"productStoreId": "text",
"name": "text",
"email": "text",
"phone": "text",
"shopOwner": "text",
"timezone": "text",
"planName": "text",
"domain": "text",
"myshopifyDomain": "text",
"primaryLocationId": "text",
"weightUnit": "text",
"currency": "text",
"countryCode": "text",
"isEnabled": "text",
"shopifyConfigId": "text",
"shopifyConfigName": "text",
"accessScopeEnumId": "text",
"apiVersion": "text",
"webSiteId": "text",
"facilityIdenTypeId": "text",
"apiUrl": "text",
"username": "text",
"currentPassword": "text",
"accessToken": "text",
"clientId": "text",
"sharedSecret": "text",
"oldSharedSecret": "text",
"processRefund": "text"
}
][
{
"_entity": "co.hotwax.facility.ProductStoreAndFacilityGroup",
"productStoreId": "text",
"facilityGroupId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"sequenceNumber": 1,
"facilityGroupTypeId": "text",
"primaryParentGroupId": "text",
"facilityGroupName": "text",
"description": "text"
}
]{
"_entity": "co.hotwax.facility.ProductStoreFacilityGroup.PK",
"productStoreId": "text",
"facilityGroupId": "text",
"fromDate": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/available-to-promise/productStores/{productStoreId}/facilities HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "co.hotwax.product.store.ProductStoreFacilityDetail",
"storeExternalId": "text",
"parentFacilityTypeId": "text",
"productStoreId": "text",
"facilityId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"sequenceNum": 1,
"primaryStoreGroupId": "text",
"storeName": "text",
"companyName": "text",
"title": "text",
"subtitle": "text",
"payToPartyId": "text",
"daysToCancelNonPay": 1,
"manualAuthIsCapture": "text",
"prorateShipping": "text",
"prorateTaxes": "text",
"viewCartOnAdd": "text",
"autoSaveCart": "text",
"autoApproveReviews": "text",
"isDemoStore": "text",
"isImmediatelyFulfilled": "text",
"inventoryFacilityId": "text",
"oneInventoryFacility": "text",
"checkInventory": "text",
"reserveInventory": "text",
"reserveOrderEnumId": "text",
"requireInventory": "text",
"balanceResOnOrderCreation": "text",
"requirementMethodEnumId": "text",
"orderNumberPrefix": "text",
"defaultLocaleString": "text",
"defaultCurrencyUomId": "text",
"defaultTimeZoneString": "text",
"defaultSalesChannelEnumId": "text",
"allowPassword": "text",
"defaultPassword": "text",
"explodeOrderItems": "text",
"checkGcBalance": "text",
"retryFailedAuths": "text",
"headerApprovedStatus": "text",
"itemApprovedStatus": "text",
"digitalItemApprovedStatus": "text",
"headerDeclinedStatus": "text",
"itemDeclinedStatus": "text",
"headerCancelStatus": "text",
"itemCancelStatus": "text",
"authDeclinedMessage": "text",
"authFraudMessage": "text",
"authErrorMessage": "text",
"visualThemeId": "text",
"storeCreditAccountEnumId": "text",
"usePrimaryEmailUsername": "text",
"requireCustomerRole": "text",
"autoInvoiceDigitalItems": "text",
"reqShipAddrForDigItems": "text",
"showCheckoutGiftOptions": "text",
"selectPaymentTypePerItem": "text",
"showPricesWithVatTax": "text",
"showTaxIsExempt": "text",
"vatTaxAuthGeoId": "text",
"vatTaxAuthPartyId": "text",
"enableAutoSuggestionList": "text",
"enableDigProdUpload": "text",
"prodSearchExcludeVariants": "text",
"digProdUploadCategoryId": "text",
"autoOrderCcTryExp": "text",
"autoOrderCcTryOtherCards": "text",
"autoOrderCcTryLaterNsf": "text",
"autoOrderCcTryLaterMax": 1,
"storeCreditValidDays": 1,
"autoApproveInvoice": "text",
"autoApproveOrder": "text",
"shipIfCaptureFails": "text",
"setOwnerUponIssuance": "text",
"reqReturnInventoryReceive": "text",
"addToCartRemoveIncompat": "text",
"addToCartReplaceUpsell": "text",
"splitPayPrefPerShpGrp": "text",
"managedByLot": "text",
"showOutOfStockProducts": "text",
"orderDecimalQuantity": "text",
"allowComment": "text",
"oldStyleSheet": "text",
"oldHeaderLogo": "text",
"oldHeaderMiddleBackground": "text",
"oldHeaderRightBackground": "text",
"catalogUrlMountPoint": "text",
"restockingFeePercentage": 1,
"capturePmntsOnOrdApproval": "text",
"termTypeId": "text",
"autoSetFacility": "text",
"enableExternalPromotion": "text",
"daysToReturn": 1,
"restockingFeeFixed": 1,
"autoAcceptReturn": "text",
"allowSplit": "text",
"storeDomain": "text",
"productIdentifierEnumId": "text",
"enablePreOrderAutoReleasing": "text",
"enableBrokering": "text",
"storeLogoImageUrl": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-12-09T15:21:30.070Z",
"closedDate": "2025-12-09T15:21:30.070Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text"
}
]{
"_entity": "org.apache.ofbiz.product.store.ProductStoreFacility.PK",
"productStoreId": "text",
"facilityId": "text",
"fromDate": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/available-to-promise/ruleGroups HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "ruleGroup",
"ruleGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"groupTypeEnumId": "text",
"statusId": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUser": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"decisionRules": [
{
"_entity": "rule",
"ruleId": "text",
"ruleGroupId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}
]{
"_entity": "ruleGroup.PK",
"ruleGroupId": "text"
}{
"_entity": "ruleGroup.PK",
"ruleGroupId": "text"
}[
{
"_entity": "rule",
"ruleId": "text",
"ruleGroupId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]{
"jobName": "text"
}GET /rest/s1/available-to-promise/ruleGroups/{ruleGroupId}/ruleGroupRuns HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "ruleGroupRuns",
"ruleGroupRunId": "text",
"ruleGroupId": "text",
"productStoreId": "text",
"createdByUser": "text",
"hasError": "text",
"startDate": "2025-12-09T15:21:30.070Z",
"endDate": "2025-12-09T15:21:30.070Z",
"ruleGroupRunResult": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
][
{
"_entity": "org.apache.ofbiz.shipment.picklist.Picklist",
"picklistId": "text",
"externalId": "text",
"description": "text",
"facilityId": "text",
"shipmentMethodTypeId": "text",
"statusId": "text",
"picklistDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedByUserLogin": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"roles": [
{
"_entity": "org.apache.ofbiz.shipment.picklist.PicklistRole",
"picklistId": "text",
"partyId": "text",
"roleTypeId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedByUserLogin": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"person": {
"_entity": "org.apache.ofbiz.party.party.Person",
"partyId": "text",
"salutation": "text",
"firstName": "text",
"middleName": "text",
"lastName": "text",
"personalTitle": "text",
"suffix": "text",
"nickname": "text",
"firstNameLocal": "text",
"middleNameLocal": "text",
"lastNameLocal": "text",
"otherLocal": "text",
"memberId": "text",
"gender": "text",
"birthDate": "2025-12-09",
"deceasedDate": "2025-12-09",
"height": 1,
"weight": 1,
"mothersMaidenName": "text",
"maritalStatus": "text",
"socialSecurityNumber": "text",
"passportNumber": "text",
"passportExpireDate": "2025-12-09",
"totalYearsWorkExperience": 1,
"comments": "text",
"employmentStatusEnumId": "text",
"residenceStatusEnumId": "text",
"occupation": "text",
"yearsWithEmployer": 1,
"monthsWithEmployer": 1,
"existingCustomer": "text",
"cardId": "text",
"anniversaryDate": "2025-12-09",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"partyGroup": {
"_entity": "org.apache.ofbiz.party.party.PartyGroup",
"partyId": "text",
"groupName": "text",
"groupNameLocal": "text",
"officeSiteName": "text",
"annualRevenue": 1,
"numEmployees": 1,
"tickerSymbol": "text",
"comments": "text",
"logoImageUrl": "text",
"pdfLogoImageUrl": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}
]
}
]{
"_entity": "org.apache.ofbiz.shipment.picklist.Picklist.PK",
"picklistId": "text"
}{
"_entity": "org.apache.ofbiz.shipment.picklist.Picklist.PK",
"picklistId": "text"
}GET /rest/s1/poorti/picklists HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/poorti/picklists HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 1809
{
"_entity": "org.apache.ofbiz.shipment.picklist.Picklist",
"picklistId": "text",
"externalId": "text",
"description": "text",
"facilityId": "text",
"shipmentMethodTypeId": "text",
"statusId": "text",
"picklistDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedByUserLogin": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"roles": [
{
"_entity": "org.apache.ofbiz.shipment.picklist.PicklistRole",
"picklistId": "text",
"partyId": "text",
"roleTypeId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedByUserLogin": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"person": {
"_entity": "org.apache.ofbiz.party.party.Person",
"partyId": "text",
"salutation": "text",
"firstName": "text",
"middleName": "text",
"lastName": "text",
"personalTitle": "text",
"suffix": "text",
"nickname": "text",
"firstNameLocal": "text",
"middleNameLocal": "text",
"lastNameLocal": "text",
"otherLocal": "text",
"memberId": "text",
"gender": "text",
"birthDate": "2025-12-09",
"deceasedDate": "2025-12-09",
"height": 1,
"weight": 1,
"mothersMaidenName": "text",
"maritalStatus": "text",
"socialSecurityNumber": "text",
"passportNumber": "text",
"passportExpireDate": "2025-12-09",
"totalYearsWorkExperience": 1,
"comments": "text",
"employmentStatusEnumId": "text",
"residenceStatusEnumId": "text",
"occupation": "text",
"yearsWithEmployer": 1,
"monthsWithEmployer": 1,
"existingCustomer": "text",
"cardId": "text",
"anniversaryDate": "2025-12-09",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"partyGroup": {
"_entity": "org.apache.ofbiz.party.party.PartyGroup",
"partyId": "text",
"groupName": "text",
"groupNameLocal": "text",
"officeSiteName": "text",
"annualRevenue": 1,
"numEmployees": 1,
"tickerSymbol": "text",
"comments": "text",
"logoImageUrl": "text",
"pdfLogoImageUrl": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}
]
}GET /rest/s1/poorti/picklists/{picklistId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "org.apache.ofbiz.shipment.picklist.Picklist",
"picklistId": "text",
"externalId": "text",
"description": "text",
"facilityId": "text",
"shipmentMethodTypeId": "text",
"statusId": "text",
"picklistDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedByUserLogin": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"roles": [
{
"_entity": "org.apache.ofbiz.shipment.picklist.PicklistRole",
"picklistId": "text",
"partyId": "text",
"roleTypeId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedByUserLogin": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"person": {
"_entity": "org.apache.ofbiz.party.party.Person",
"partyId": "text",
"salutation": "text",
"firstName": "text",
"middleName": "text",
"lastName": "text",
"personalTitle": "text",
"suffix": "text",
"nickname": "text",
"firstNameLocal": "text",
"middleNameLocal": "text",
"lastNameLocal": "text",
"otherLocal": "text",
"memberId": "text",
"gender": "text",
"birthDate": "2025-12-09",
"deceasedDate": "2025-12-09",
"height": 1,
"weight": 1,
"mothersMaidenName": "text",
"maritalStatus": "text",
"socialSecurityNumber": "text",
"passportNumber": "text",
"passportExpireDate": "2025-12-09",
"totalYearsWorkExperience": 1,
"comments": "text",
"employmentStatusEnumId": "text",
"residenceStatusEnumId": "text",
"occupation": "text",
"yearsWithEmployer": 1,
"monthsWithEmployer": 1,
"existingCustomer": "text",
"cardId": "text",
"anniversaryDate": "2025-12-09",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"partyGroup": {
"_entity": "org.apache.ofbiz.party.party.PartyGroup",
"partyId": "text",
"groupName": "text",
"groupNameLocal": "text",
"officeSiteName": "text",
"annualRevenue": 1,
"numEmployees": 1,
"tickerSymbol": "text",
"comments": "text",
"logoImageUrl": "text",
"pdfLogoImageUrl": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}
]
}PUT /rest/s1/poorti/picklists/{picklistId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 1809
{
"_entity": "org.apache.ofbiz.shipment.picklist.Picklist",
"picklistId": "text",
"externalId": "text",
"description": "text",
"facilityId": "text",
"shipmentMethodTypeId": "text",
"statusId": "text",
"picklistDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedByUserLogin": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"roles": [
{
"_entity": "org.apache.ofbiz.shipment.picklist.PicklistRole",
"picklistId": "text",
"partyId": "text",
"roleTypeId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedByUserLogin": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"person": {
"_entity": "org.apache.ofbiz.party.party.Person",
"partyId": "text",
"salutation": "text",
"firstName": "text",
"middleName": "text",
"lastName": "text",
"personalTitle": "text",
"suffix": "text",
"nickname": "text",
"firstNameLocal": "text",
"middleNameLocal": "text",
"lastNameLocal": "text",
"otherLocal": "text",
"memberId": "text",
"gender": "text",
"birthDate": "2025-12-09",
"deceasedDate": "2025-12-09",
"height": 1,
"weight": 1,
"mothersMaidenName": "text",
"maritalStatus": "text",
"socialSecurityNumber": "text",
"passportNumber": "text",
"passportExpireDate": "2025-12-09",
"totalYearsWorkExperience": 1,
"comments": "text",
"employmentStatusEnumId": "text",
"residenceStatusEnumId": "text",
"occupation": "text",
"yearsWithEmployer": 1,
"monthsWithEmployer": 1,
"existingCustomer": "text",
"cardId": "text",
"anniversaryDate": "2025-12-09",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"partyGroup": {
"_entity": "org.apache.ofbiz.party.party.PartyGroup",
"partyId": "text",
"groupName": "text",
"groupNameLocal": "text",
"officeSiteName": "text",
"annualRevenue": 1,
"numEmployees": 1,
"tickerSymbol": "text",
"comments": "text",
"logoImageUrl": "text",
"pdfLogoImageUrl": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}
]
}POST /rest/s1/poorti/rejectInProgressOrders HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 122
{
"facilityId": "text",
"updateQOH": "false",
"rejectionReasonId": "INACTIVE_STORE",
"rejectComments": "Store Rejected Inventory"
}[
{
"_entity": "co.hotwax.customerservice.order.OrderShipmentAndRouteSegment",
"orderId": "text",
"orderDate": "2025-12-09T15:21:30.070Z",
"orderTypeId": "text",
"webSiteId": "text",
"externalId": "text",
"orderName": "text",
"statusId": "text",
"originFacilityId": "text",
"currencyUom": "text",
"shipGroupSeqId": "text",
"orderFacilityId": "text",
"facilityId": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"shipmentId": "text",
"shipmentTypeId": "text",
"shipmentStatusId": "text",
"shipmentCreatedDate": "2025-12-09T15:21:30.070Z",
"shipmentShippedDate": "2025-12-09T15:21:30.070Z",
"shippingEstimateAmount": 1,
"trackingIdNumber": "text",
"shipmentRouteSegmentId": "text",
"routeSegShipmentMethodDescription": "text",
"statusDate": "2025-12-09T15:21:30.070Z"
}
]GET /rest/s1/poorti/orderShipmentAndRouteSegments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/poorti/rejectOutstandingOrders HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 122
{
"facilityId": "text",
"updateQOH": "false",
"rejectionReasonId": "INACTIVE_STORE",
"rejectComments": "Store Rejected Inventory"
}PUT /rest/s1/poorti/updateShipmentCarrierAndMethod HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 1676
{
"shipmentId": "text",
"shipmentRouteSegmentId": "text",
"deliveryId": "text",
"originFacilityId": "text",
"destFacilityId": "text",
"originContactMechId": "text",
"originTelecomNumberId": "text",
"destContactMechId": "text",
"destTelecomNumberId": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"carrierServiceStatusId": "text",
"carrierDeliveryZone": "text",
"carrierRestrictionCodes": "text",
"carrierRestrictionDesc": "text",
"billingWeight": 1,
"billingWeightUomId": "text",
"actualTransportCost": 1,
"actualServiceCost": 1,
"actualOtherCost": 1,
"actualCost": 1,
"currencyUomId": "text",
"actualStartDate": "2025-12-09T15:21:30.070Z",
"actualArrivalDate": "2025-12-09T15:21:30.070Z",
"estimatedStartDate": "2025-12-09T15:21:30.070Z",
"estimatedArrivalDate": "2025-12-09T15:21:30.070Z",
"trackingIdNumber": "text",
"trackingDigest": "text",
"updatedByUserLoginId": "text",
"lastUpdatedDate": "2025-12-09T15:21:30.070Z",
"homeDeliveryType": "text",
"homeDeliveryDate": "2025-12-09T15:21:30.070Z",
"thirdPartyAccountNumber": "text",
"thirdPartyPostalCode": "text",
"thirdPartyCountryGeoCode": "text",
"upsHighValueReport": "text",
"trackingUrl": "text",
"codReturnLabelImage": "text",
"codReturnLabelHtml": "text",
"codCollectionAmount": 1,
"carrierAccountNumber": "text",
"carrierService": "text",
"isGenerateThirdPartyLabel": "text",
"isTrackingRequired": "text",
"referenceNumber": "text",
"actualCarrierCode": "text",
"labelImage": "text",
"labelImageUrl": "text",
"labelHtml": "text",
"requestedDeliveryDate": "2025-12-09",
"requestedDeliveryTime": "text",
"requestedShipMethTypeId": "text",
"deliveryWindow": 1,
"gatewayRateId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"orderId": "text",
"shipGroupSeqId": "text",
"shippingEstimateAmount": "text"
}GET /rest/s1/poorti/shippingRate HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"shippingRates": []
}[
{
"_entity": "co.hotwax.shipment.TransferOrderItemReceipt",
"orderId": "text",
"orderItemSeqId": "text",
"datetimeReceived": "2025-12-09T15:21:30.070Z",
"quantityAccepted": 1,
"quantityRejected": 1,
"receivedByUserLoginId": "text",
"productStoreId": "text",
"productId": "text",
"quantity": 1
}
]GET /rest/s1/poorti/transferOrders/{orderId}/printPicklist HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/poorti/transferOrders/{orderId}/receipts HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/poorti/transferOrders/{orderId}/receipts HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 219
{
"orderId": "text",
"facilityId": "text",
"receivedDateTime": "{ec.user.nowTimestamp}",
"items": [
{
"orderItemSeqId": "text",
"productId": "text",
"quantityAccepted": 1,
"quantityRejected": 1,
"reasonEnumId": "text",
"statusId": "text"
}
]
}POST /rest/s1/poorti/transferOrders/{orderId}/reject HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 125
{
"orderId": "text",
"rejectToFacilityId": "REJECTED_ITM_PARKING",
"items": [
{
"orderItemSeqId": "text",
"rejectionReasonId": "text"
}
]
}POST /rest/s1/poorti/transferOrders/{orderId}/closeFulfillment HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 54
{
"orderId": "text",
"items": [
{
"orderItemSeqId": "text"
}
]
}GET /rest/s1/poorti/Label.pdf HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/poorti/shipmentPackageRouteSegDetails HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"shipmentPackageRouteSegDetails": "text"
}[
{
"_entity": "org.apache.ofbiz.product.inventory.ExternalInventoryReset",
"resetItemId": "text",
"resetDateResourceId": "text",
"facilityId": "text",
"productId": "text",
"externalFacilityId": "text",
"productIdentType": "text",
"productIdentValue": "text",
"inventoryItemId": "text",
"inventoryItemATP": 1,
"inventoryItemQOH": 1,
"externalATP": 1,
"externalQOH": 1,
"unitCost": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]{
"_entity": "org.apache.ofbiz.product.inventory.ExternalInventoryReset.PK",
"resetItemId": "text"
}{
"_entity": "org.apache.ofbiz.product.inventory.ExternalInventoryReset.PK",
"resetItemId": "text"
}GET /rest/s1/poorti/externalInventoryResets HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/poorti/externalInventoryResets HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 399
{
"_entity": "org.apache.ofbiz.product.inventory.ExternalInventoryReset",
"resetItemId": "text",
"resetDateResourceId": "text",
"facilityId": "text",
"productId": "text",
"externalFacilityId": "text",
"productIdentType": "text",
"productIdentValue": "text",
"inventoryItemId": "text",
"inventoryItemATP": 1,
"inventoryItemQOH": 1,
"externalATP": 1,
"externalQOH": 1,
"unitCost": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/poorti/externalInventoryResets/{resetItemId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "org.apache.ofbiz.product.inventory.ExternalInventoryReset",
"resetItemId": "text",
"resetDateResourceId": "text",
"facilityId": "text",
"productId": "text",
"externalFacilityId": "text",
"productIdentType": "text",
"productIdentValue": "text",
"inventoryItemId": "text",
"inventoryItemATP": 1,
"inventoryItemQOH": 1,
"externalATP": 1,
"externalQOH": 1,
"unitCost": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}PUT /rest/s1/poorti/externalInventoryResets/{resetItemId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 399
{
"_entity": "org.apache.ofbiz.product.inventory.ExternalInventoryReset",
"resetItemId": "text",
"resetDateResourceId": "text",
"facilityId": "text",
"productId": "text",
"externalFacilityId": "text",
"productIdentType": "text",
"productIdentValue": "text",
"inventoryItemId": "text",
"inventoryItemATP": 1,
"inventoryItemQOH": 1,
"externalATP": 1,
"externalQOH": 1,
"unitCost": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}DELETE /rest/s1/poorti/externalInventoryResets/{resetItemId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
PUT /rest/s1/poorti/updateShipmentTracking HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"shipmentId": "text",
"trackingIdNumber": "text",
"shipmentRouteSegmentId": "text",
"shipmentPackageSeqId": "text"
}GET /rest/s1/poorti/getInventoryAvailableByFacility HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"atp": "text",
"qoh": "text",
"minimumStock": "text",
"computedAtp": "text"
}GET /rest/s1/poorti/shipmentFacets HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"carrierPartyIds": [],
"shipmentMethodTypeIds": []
}POST /rest/s1/poorti/generateManifest HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 82
{
"facilityId": "text",
"carrierPartyId": "text",
"manifestGenerateServiceName": "text"
}[
{
"_entity": "org.apache.ofbiz.accounting.payment.GiftCardFulfillment",
"fulfillmentId": "text",
"typeEnumId": "text",
"merchantId": "text",
"partyId": "text",
"orderId": "text",
"orderItemSeqId": "text",
"surveyResponseId": "text",
"cardNumber": "text",
"pinNumber": "text",
"amount": 1,
"responseCode": "text",
"referenceNum": "text",
"authCode": "text",
"fulfillmentDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]{
"_entity": "org.apache.ofbiz.accounting.payment.GiftCardFulfillment.PK",
"fulfillmentId": "text"
}GET /rest/s1/poorti/giftCardFulfillments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/poorti/giftCardFulfillments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 419
{
"_entity": "org.apache.ofbiz.accounting.payment.GiftCardFulfillment",
"fulfillmentId": "text",
"typeEnumId": "text",
"merchantId": "text",
"partyId": "text",
"orderId": "text",
"orderItemSeqId": "text",
"surveyResponseId": "text",
"cardNumber": "text",
"pinNumber": "text",
"amount": 1,
"responseCode": "text",
"referenceNum": "text",
"authCode": "text",
"fulfillmentDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/poorti/Manifest.pdf HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"shipmentIds": [],
"picklistId": "text"
}POST /rest/s1/poorti/createOrderFulfillmentWave HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 119
{
"facilityId": "text",
"shipmentMethodTypeId": "text",
"statusId": "text",
"pickers": [],
"orderItems": [],
"packageName": "text"
}GET /rest/s1/poorti/Picklist.csv HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/poorti/orders/{orderId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "org.apache.ofbiz.order.order.OrderHeader",
"orderId": "text",
"orderTypeId": "text",
"orderName": "text",
"externalId": "text",
"salesChannelEnumId": "text",
"orderDate": "2025-12-09T15:21:30.070Z",
"priority": "text",
"entryDate": "2025-12-09T15:21:30.070Z",
"pickSheetPrintedDate": "2025-12-09T15:21:30.070Z",
"visitId": "text",
"statusId": "text",
"createdBy": "text",
"firstAttemptOrderId": "text",
"currencyUom": "text",
"syncStatusId": "text",
"billingAccountId": "text",
"originFacilityId": "text",
"webSiteId": "text",
"productStoreId": "text",
"terminalId": "text",
"transactionId": "text",
"autoOrderShoppingListId": "text",
"needsInventoryIssuance": "text",
"isRushOrder": "text",
"internalCode": "text",
"remainingSubTotal": 1,
"grandTotal": 1,
"isViewed": "text",
"invoicePerShipment": "text",
"expireDate": "2025-12-09T15:21:30.070Z",
"localeString": "text",
"customerClassificationId": "text",
"presentmentCurrencyUom": "text",
"autoApprove": "text",
"statusFlowId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"roles": [
{
"_entity": "org.apache.ofbiz.order.order.OrderRole",
"orderId": "text",
"partyId": "text",
"roleTypeId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
],
"contactMechs": [
{
"_entity": "org.apache.ofbiz.order.order.OrderContactMech",
"orderId": "text",
"contactMechPurposeTypeId": "text",
"contactMechId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"contactMech": {
"_entity": "org.apache.ofbiz.party.contact.ContactMech",
"contactMechId": "text",
"externalId": "text",
"contactMechTypeId": "text",
"infoString": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"postalAddress": {
"_entity": "org.apache.ofbiz.party.contact.PostalAddress",
"contactMechId": "text",
"toName": "text",
"attnName": "text",
"address1": "text",
"address2": "text",
"houseNumber": 1,
"houseNumberExt": "text",
"directions": "text",
"city": "text",
"cityGeoId": "text",
"postalCode": "text",
"postalCodeExt": "text",
"countryGeoId": "text",
"stateProvinceGeoId": "text",
"countyGeoId": "text",
"municipalityGeoId": "text",
"postalCodeGeoId": "text",
"geoPointId": "text",
"encodedAddressKey": "text",
"latitude": 1,
"longitude": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"telecomNumber": {
"_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
"contactMechId": "text",
"countryCode": "text",
"areaCode": "text",
"contactNumber": "text",
"askForName": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}
],
"paymentPreferences": [
{
"_entity": "org.apache.ofbiz.order.order.OrderPaymentPreference",
"orderPaymentPreferenceId": "text",
"orderId": "text",
"orderItemSeqId": "text",
"shipGroupSeqId": "text",
"productPricePurposeId": "text",
"paymentMethodTypeId": "text",
"paymentMethodId": "text",
"finAccountId": "text",
"securityCode": "text",
"track2": "text",
"presentFlag": "text",
"swipedFlag": "text",
"overflowFlag": "text",
"maxAmount": 1,
"processAttempt": 1,
"billingPostalCode": "text",
"manualAuthCode": "text",
"manualRefNum": "text",
"statusId": "text",
"needsNsfRetry": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastModifiedByUserLogin": "text",
"paymentMode": "text",
"cardName": "text",
"presentmentAmount": 1,
"presentmentCurrencyUom": "text",
"exchangeRate": 1,
"requestId": "text",
"parentRefNum": "text",
"applicationIdentifier": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"moqui.basic.StatusItem": {
"_entity": "statuses",
"statusId": "text",
"statusTypeId": "text",
"statusCode": "text",
"sequenceNum": 1,
"description": "text",
"statusAge": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"org.apache.ofbiz.accounting.payment.PaymentMethodType": {
"_entity": "org.apache.ofbiz.accounting.payment.PaymentMethodType",
"paymentMethodTypeId": "text",
"description": "text",
"defaultGlAccountId": "text",
"paymentMethodCode": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}
],
"adjustments": [
{
"_entity": "org.apache.ofbiz.order.order.OrderAdjustment",
"orderAdjustmentId": "text",
"orderAdjustmentTypeId": "text",
"orderId": "text",
"orderItemSeqId": "text",
"shipGroupSeqId": "text",
"comments": "text",
"description": "text",
"amount": 1,
"recurringAmount": 1,
"amountAlreadyIncluded": 1,
"productPromoId": "text",
"productPromoRuleId": "text",
"productPromoActionSeqId": "text",
"productFeatureId": "text",
"correspondingProductId": "text",
"taxAuthorityRateSeqId": "text",
"sourceReferenceId": "text",
"sourcePercentage": 1,
"customerReferenceId": "text",
"primaryGeoId": "text",
"secondaryGeoId": "text",
"exemptAmount": 1,
"taxAuthGeoId": "text",
"taxAuthPartyId": "text",
"overrideGlAccountId": "text",
"includeInTax": "text",
"includeInShipping": "text",
"isManual": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastModifiedByUserLogin": "text",
"originalAdjustmentId": "text",
"oldAmountPerQuantity": 1,
"oldPercentage": 1,
"billingShipmentId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"attributes": [
{
"_entity": "org.apache.ofbiz.order.order.OrderAdjustmentAttribute",
"orderAdjustmentId": "text",
"attrName": "text",
"attrValue": "text",
"attrDescription": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}
],
"attributes": [
{
"_entity": "org.apache.ofbiz.order.order.OrderAttribute",
"orderId": "text",
"attrName": "text",
"attrValue": "text",
"attrDescription": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
],
"notes": [
{
"_entity": "org.apache.ofbiz.order.order.OrderHeaderNote",
"orderId": "text",
"noteId": "text",
"internalNote": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
],
"shipGroups": [
{
"_entity": "org.apache.ofbiz.order.order.OrderItemShipGroup",
"orderId": "text",
"shipGroupSeqId": "text",
"shipmentMethodTypeId": "text",
"supplierPartyId": "text",
"vendorPartyId": "text",
"carrierPartyId": "text",
"carrierRoleTypeId": "text",
"facilityId": "text",
"contactMechId": "text",
"telecomContactMechId": "text",
"trackingNumber": "text",
"shippingInstructions": "text",
"maySplit": "text",
"giftMessage": "text",
"isGift": "text",
"shipAfterDate": "2025-12-09T15:21:30.070Z",
"shipByDate": "2025-12-09T15:21:30.070Z",
"estimatedShipDate": "2025-12-09T15:21:30.070Z",
"estimatedDeliveryDate": "2025-12-09T15:21:30.070Z",
"carrierAccountNumber": "text",
"carrierService": "text",
"orderFacilityId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"items": [
{
"_entity": "org.apache.ofbiz.order.order.OrderItem",
"orderId": "text",
"orderItemSeqId": "text",
"externalId": "text",
"orderItemTypeId": "text",
"orderItemGroupSeqId": "text",
"isItemGroupPrimary": "text",
"fromInventoryItemId": "text",
"budgetId": "text",
"budgetItemSeqId": "text",
"productId": "text",
"supplierProductId": "text",
"productFeatureId": "text",
"prodCatalogId": "text",
"productCategoryId": "text",
"isPromo": "text",
"quoteId": "text",
"quoteItemSeqId": "text",
"shoppingListId": "text",
"shoppingListItemSeqId": "text",
"subscriptionId": "text",
"deploymentId": "text",
"quantity": 1,
"cancelQuantity": 1,
"selectedAmount": 1,
"unitPrice": 1,
"unitListPrice": 1,
"unitAverageCost": 1,
"unitRecurringPrice": 1,
"isModifiedPrice": "text",
"recurringFreqUomId": "text",
"itemDescription": "text",
"comments": "text",
"correspondingPoId": "text",
"statusId": "text",
"syncStatusId": "text",
"estimatedShipDate": "2025-12-09T15:21:30.070Z",
"estimatedDeliveryDate": "2025-12-09T15:21:30.070Z",
"autoCancelDate": "2025-12-09T15:21:30.070Z",
"dontCancelSetDate": "2025-12-09T15:21:30.070Z",
"dontCancelSetUserLogin": "text",
"shipBeforeDate": "2025-12-09T15:21:30.070Z",
"shipAfterDate": "2025-12-09T15:21:30.070Z",
"cancelBackOrderDate": "2025-12-09T15:21:30.070Z",
"overrideGlAccountId": "text",
"salesOpportunityId": "text",
"changeByUserLoginId": "text",
"shipGroupSeqId": "text",
"returnTillDate": "2025-12-09T15:21:30.070Z",
"promisedDatetime": "2025-12-09T15:21:30.070Z",
"shipmentId": "text",
"isNewProduct": "text",
"availableToPromise": 1,
"requestedDeliveryDate": "2025-12-09",
"requestedDeliveryTime": "text",
"requestedShipMethTypeId": "text",
"deliveryWindow": 1,
"taxCode": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"adjustments": [
{
"_entity": "org.apache.ofbiz.order.order.OrderAdjustment",
"orderAdjustmentId": "text",
"orderAdjustmentTypeId": "text",
"orderId": "text",
"orderItemSeqId": "text",
"shipGroupSeqId": "text",
"comments": "text",
"description": "text",
"amount": 1,
"recurringAmount": 1,
"amountAlreadyIncluded": 1,
"productPromoId": "text",
"productPromoRuleId": "text",
"productPromoActionSeqId": "text",
"productFeatureId": "text",
"correspondingProductId": "text",
"taxAuthorityRateSeqId": "text",
"sourceReferenceId": "text",
"sourcePercentage": 1,
"customerReferenceId": "text",
"primaryGeoId": "text",
"secondaryGeoId": "text",
"exemptAmount": 1,
"taxAuthGeoId": "text",
"taxAuthPartyId": "text",
"overrideGlAccountId": "text",
"includeInTax": "text",
"includeInShipping": "text",
"isManual": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastModifiedByUserLogin": "text",
"originalAdjustmentId": "text",
"oldAmountPerQuantity": 1,
"oldPercentage": 1,
"billingShipmentId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"attributes": [
{
"_entity": "org.apache.ofbiz.order.order.OrderAdjustmentAttribute",
"orderAdjustmentId": "text",
"attrName": "text",
"attrValue": "text",
"attrDescription": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}
],
"attributes": [
{
"_entity": "org.apache.ofbiz.order.order.OrderItemAttribute",
"orderId": "text",
"orderItemSeqId": "text",
"attrName": "text",
"attrValue": "text",
"attrDescription": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
],
"statuses": [
{
"_entity": "org.apache.ofbiz.order.order.OrderStatus",
"orderStatusId": "text",
"statusId": "text",
"orderId": "text",
"orderItemSeqId": "text",
"orderPaymentPreferenceId": "text",
"statusDatetime": "2025-12-09T15:21:30.070Z",
"statusUserLogin": "text",
"changeReason": "text",
"changeReasonEnumId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}
]
}
],
"statuses": [
{
"_entity": "org.apache.ofbiz.order.order.OrderStatus",
"orderStatusId": "text",
"statusId": "text",
"orderId": "text",
"orderItemSeqId": "text",
"orderPaymentPreferenceId": "text",
"statusDatetime": "2025-12-09T15:21:30.070Z",
"statusUserLogin": "text",
"changeReason": "text",
"changeReasonEnumId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
],
"identifications": [
{
"_entity": "co.hotwax.order.OrderIdentification",
"orderIdentificationTypeId": "text",
"orderId": "text",
"idValue": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
],
"itemAssocs": [
{
"_entity": "org.apache.ofbiz.order.order.OrderItemAssoc",
"orderId": "text",
"orderItemSeqId": "text",
"shipGroupSeqId": "text",
"toOrderId": "text",
"toOrderItemSeqId": "text",
"toShipGroupSeqId": "text",
"orderItemAssocTypeId": "text",
"quantity": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}GET /rest/s1/poorti/PackingSlipAndLabel.pdf HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "org.apache.ofbiz.shipment.shipment.Shipment",
"shipmentId": "text",
"externalId": "text",
"shipmentTypeId": "text",
"statusId": "text",
"primaryOrderId": "text",
"primaryReturnId": "text",
"primaryShipGroupSeqId": "text",
"picklistBinId": "text",
"estimatedReadyDate": "2025-12-09T15:21:30.070Z",
"estimatedShipDate": "2025-12-09T15:21:30.070Z",
"estimatedShipWorkEffId": "text",
"estimatedArrivalDate": "2025-12-09T15:21:30.070Z",
"estimatedArrivalWorkEffId": "text",
"latestCancelDate": "2025-12-09T15:21:30.070Z",
"estimatedShipCost": 1,
"currencyUomId": "text",
"handlingInstructions": "text",
"originFacilityId": "text",
"destinationFacilityId": "text",
"originContactMechId": "text",
"originTelecomNumberId": "text",
"destinationContactMechId": "text",
"destinationTelecomNumberId": "text",
"partyIdTo": "text",
"partyIdFrom": "text",
"additionalShippingCharge": 1,
"addtlShippingChargeDesc": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastModifiedByUserLogin": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"picklistShipment": [
{
"_entity": "org.apache.ofbiz.shipment.picklist.PicklistShipment",
"picklistId": "text",
"shipmentId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"picklist": {
"_entity": "org.apache.ofbiz.shipment.picklist.Picklist",
"picklistId": "text",
"externalId": "text",
"description": "text",
"facilityId": "text",
"shipmentMethodTypeId": "text",
"statusId": "text",
"picklistDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedByUserLogin": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"roles": [
{
"_entity": "org.apache.ofbiz.shipment.picklist.PicklistRole",
"picklistId": "text",
"partyId": "text",
"roleTypeId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedByUserLogin": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"person": {
"_entity": "org.apache.ofbiz.party.party.Person",
"partyId": "text",
"salutation": "text",
"firstName": "text",
"middleName": "text",
"lastName": "text",
"personalTitle": "text",
"suffix": "text",
"nickname": "text",
"firstNameLocal": "text",
"middleNameLocal": "text",
"lastNameLocal": "text",
"otherLocal": "text",
"memberId": "text",
"gender": "text",
"birthDate": "2025-12-09",
"deceasedDate": "2025-12-09",
"height": 1,
"weight": 1,
"mothersMaidenName": "text",
"maritalStatus": "text",
"socialSecurityNumber": "text",
"passportNumber": "text",
"passportExpireDate": "2025-12-09",
"totalYearsWorkExperience": 1,
"comments": "text",
"employmentStatusEnumId": "text",
"residenceStatusEnumId": "text",
"occupation": "text",
"yearsWithEmployer": 1,
"monthsWithEmployer": 1,
"existingCustomer": "text",
"cardId": "text",
"anniversaryDate": "2025-12-09",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"partyGroup": {
"_entity": "org.apache.ofbiz.party.party.PartyGroup",
"partyId": "text",
"groupName": "text",
"groupNameLocal": "text",
"officeSiteName": "text",
"annualRevenue": 1,
"numEmployees": 1,
"tickerSymbol": "text",
"comments": "text",
"logoImageUrl": "text",
"pdfLogoImageUrl": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}
]
}
}
],
"order": {
"_entity": "org.apache.ofbiz.order.order.OrderHeader",
"orderId": "text",
"orderTypeId": "text",
"orderName": "text",
"externalId": "text",
"salesChannelEnumId": "text",
"orderDate": "2025-12-09T15:21:30.070Z",
"priority": "text",
"entryDate": "2025-12-09T15:21:30.070Z",
"pickSheetPrintedDate": "2025-12-09T15:21:30.070Z",
"visitId": "text",
"statusId": "text",
"createdBy": "text",
"firstAttemptOrderId": "text",
"currencyUom": "text",
"syncStatusId": "text",
"billingAccountId": "text",
"originFacilityId": "text",
"webSiteId": "text",
"productStoreId": "text",
"terminalId": "text",
"transactionId": "text",
"autoOrderShoppingListId": "text",
"needsInventoryIssuance": "text",
"isRushOrder": "text",
"internalCode": "text",
"remainingSubTotal": 1,
"grandTotal": 1,
"isViewed": "text",
"invoicePerShipment": "text",
"expireDate": "2025-12-09T15:21:30.070Z",
"localeString": "text",
"customerClassificationId": "text",
"presentmentCurrencyUom": "text",
"autoApprove": "text",
"statusFlowId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}
]GET /rest/s1/poorti/shipmentPicklists HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"shipments": [
{
"orderId": "text",
"orderDate": "2025-12-09T15:21:30.070Z",
"orderTypeId": "text",
"webSiteId": "text",
"externalId": "text",
"orderName": "text",
"statusId": "text",
"originFacilityId": "text",
"currencyUom": "text",
"shipGroupSeqId": "text",
"orderFacilityId": "text",
"facilityId": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"shipmentId": "text",
"shipmentTypeId": "text",
"shipmentStatusId": "text",
"shipmentCreatedDate": "2025-12-09T15:21:30.070Z",
"shipmentShippedDate": "2025-12-09T15:21:30.070Z",
"shippingEstimateAmount": 1,
"trackingIdNumber": "text",
"shipmentRouteSegmentId": "text",
"routeSegShipmentMethodDescription": "text",
"statusDate": "2025-12-09T15:21:30.070Z",
"packages": [
{
"shipmentPackageSeqId": "text",
"trackingCode": "text",
"labelImageUrl": "text",
"items": [
{
"orderItemSeqId": "text",
"productId": "text",
"unitPrice": "text",
"quantity": "text",
"orderId": "text",
"orderItemStatusId": "text",
"orderedQuantity": "text",
"shipmentItemSeqId": "text",
"totalIssuedQuantity": "text",
"shipmentPackageSeqId": "text",
"shipmentStatusId": "text"
}
]
}
]
}
]
}{
"shipmentId": "text"
}{
"orders": [
{
"orderId": "text",
"externalId": "text",
"orderName": "text",
"shipmentShippedDate": "text",
"statusId": "text"
}
],
"ordersCount": 1
}{
"shipmentPackagesCount": 1,
"shipmentPackages": [
{
"orderId": "text",
"orderName": "text",
"orderExternalId": "text",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentPackageCreatedDate": "text",
"trackingCode": "text"
}
]
}GET /rest/s1/poorti/transferShipments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/poorti/transferShipments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 214
{
"payload": {
"orderId": "text",
"externalId": "text",
"shipmentStatusId": "SHIPMENT_PACKED",
"packages": [
{
"trackingNumber": "text",
"items": [
{
"orderItemSeqId": "text",
"externalId": "text",
"productId": "text",
"quantity": 1
}
]
}
]
}
}POST /rest/s1/poorti/transferShipments/{shipmentId}/ship HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"shipmentId": "text",
"trackingIdNumber": "text",
"shipmentRouteSegmentId": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text"
}GET /rest/s1/poorti/transferShipments/orders HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/poorti/transferShipments/packages HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/poorti/shipmentRequests HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "co.hotwax.warehouse.packing.ShipmentRequest",
"carrierPartyId": "text",
"requestType": "text",
"shipmentMethodTypeId": "text",
"serviceName": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]PackingSlip.pdf
Picklist.pdf
The current page index to get the shipments.
The maximum number of shipments to display.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.shipment.shipment.ShipmentSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.shipment.shipment.ShipmentSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
No content
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
No content
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
This field store the length of package; if a shipmentBoxTypeId is specified then this overrides the dimension specified there; this field is meant to be used when there is no applicable ShipmentBoxType
This field store the height of package; if a shipmentBoxTypeId is specified then this overrides the dimension specified there; this field is meant to be used when there is no applicable ShipmentBoxType
This field store the width of package; if a shipmentBoxTypeId is specified then this overrides the dimension specified there; this field is meant to be used when there is no applicable ShipmentBoxType
This field store the unit of measurement of dimension (length, width and height)
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.shipment.shipment.ShipmentPackageSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
No content
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
No content
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.shipment.shipment.ShipmentPackageContentSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.shipment.shipment.ShipmentPackageRouteSegSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.shipment.shipment.ShipmentRouteSegmentSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
No content
NNAuthentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
No content
Deprecated (since maarg 4.4.0): Use admin/serviceJobs
GET /rest/s1/poorti/shipments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/poorti/shipments/{shipmentId}/pack HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"shipmentId": "text",
"facilityId": "text",
"orderId": "text",
"shipmentPackageContents": [],
"rejectedOrderItems": [],
"trackingCode": "text"
}POST /rest/s1/poorti/shipments/{shipmentId}/unpack HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/poorti/shipments/{shipmentId}/ship HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/poorti/shipments/{shipmentId}/shipmentPackages HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 259
{
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentBoxTypeId": "text",
"boxLength": 1,
"boxHeight": 1,
"boxWidth": 1,
"dimensionUomId": "text",
"weight": 1,
"weightUomId": "text",
"insuredValue": 1,
"packageName": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/poorti/shipments/{shipmentId}/shipmentPackages/{shipmentPackageSeqId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackage",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentBoxTypeId": "text",
"dateCreated": "2025-12-09T15:21:30.070Z",
"boxLength": 1,
"boxHeight": 1,
"boxWidth": 1,
"dimensionUomId": "text",
"weight": 1,
"weightUomId": "text",
"insuredValue": 1,
"packageName": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}PUT /rest/s1/poorti/shipments/{shipmentId}/shipmentPackages/{shipmentPackageSeqId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 363
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackage",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentBoxTypeId": "text",
"dateCreated": "2025-12-09T15:21:30.070Z",
"boxLength": 1,
"boxHeight": 1,
"boxWidth": 1,
"dimensionUomId": "text",
"weight": 1,
"weightUomId": "text",
"insuredValue": 1,
"packageName": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/poorti/shipments/{shipmentId}/shippingLabels HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/poorti/shipments/{shipmentId}/shippingLabels/void HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/poorti/shipments/{shipmentId}/shipmentPackageContents HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/poorti/shipments/{shipmentId}/shipmentPackageContents HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 252
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackageContent",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentItemSeqId": "text",
"quantity": 1,
"subProductId": "text",
"subProductQuantity": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}POST /rest/s1/poorti/shipments/{shipmentId}/shipmentPackageRouteSegments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 660
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackageRouteSeg",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentRouteSegmentId": "text",
"trackingCode": "text",
"boxNumber": "text",
"labelImage": "text",
"labelIntlSignImage": "text",
"labelHtml": "text",
"labelPrinted": "text",
"internationalInvoice": "text",
"packageTransportCost": 1,
"packageServiceCost": 1,
"packageOtherCost": 1,
"codAmount": 1,
"insuredAmount": 1,
"currencyUomId": "text",
"labelImageUrl": "text",
"internationalInvoiceUrl": "text",
"packagePickupPrn": "text",
"packagePickupDate": "2025-12-09T15:21:30.070Z",
"gatewayMessage": "text",
"gatewayStatus": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}PUT /rest/s1/poorti/shipments/{shipmentId}/shipmentRouteSegment HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 1671
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentRouteSegment",
"shipmentId": "text",
"shipmentRouteSegmentId": "text",
"deliveryId": "text",
"originFacilityId": "text",
"destFacilityId": "text",
"originContactMechId": "text",
"originTelecomNumberId": "text",
"destContactMechId": "text",
"destTelecomNumberId": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"carrierServiceStatusId": "text",
"carrierDeliveryZone": "text",
"carrierRestrictionCodes": "text",
"carrierRestrictionDesc": "text",
"billingWeight": 1,
"billingWeightUomId": "text",
"actualTransportCost": 1,
"actualServiceCost": 1,
"actualOtherCost": 1,
"actualCost": 1,
"currencyUomId": "text",
"actualStartDate": "2025-12-09T15:21:30.070Z",
"actualArrivalDate": "2025-12-09T15:21:30.070Z",
"estimatedStartDate": "2025-12-09T15:21:30.070Z",
"estimatedArrivalDate": "2025-12-09T15:21:30.070Z",
"trackingIdNumber": "text",
"trackingDigest": "text",
"updatedByUserLoginId": "text",
"lastUpdatedDate": "2025-12-09T15:21:30.070Z",
"homeDeliveryType": "text",
"homeDeliveryDate": "2025-12-09T15:21:30.070Z",
"thirdPartyAccountNumber": "text",
"thirdPartyPostalCode": "text",
"thirdPartyCountryGeoCode": "text",
"upsHighValueReport": "text",
"trackingUrl": "text",
"codReturnLabelImage": "text",
"codReturnLabelHtml": "text",
"codCollectionAmount": 1,
"carrierAccountNumber": "text",
"carrierService": "text",
"isGenerateThirdPartyLabel": "text",
"isTrackingRequired": "text",
"referenceNumber": "text",
"actualCarrierCode": "text",
"labelImage": "text",
"labelImageUrl": "text",
"labelHtml": "text",
"requestedDeliveryDate": "2025-12-09",
"requestedDeliveryTime": "text",
"requestedShipMethTypeId": "text",
"deliveryWindow": 1,
"gatewayRateId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}POST /rest/s1/poorti/shipments/bulkPack HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"shipments": []
}POST /rest/s1/poorti/shipments/bulkShip HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"shipmentIds": []
}POST /rest/s1/poorti/shipments/retryShippingLabel HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"forceRateShop": "N",
"generateLabel": "N",
"shipmentIds": []
}Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
No content
GET /rest/s1/poorti/Picklist.pdf HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"shipments": [],
"shipmentCount": "text"
}POST /rest/s1/poorti/shipments HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 11032
{
"_entity": "org.apache.ofbiz.shipment.shipment.Shipment",
"shipmentId": "text",
"externalId": "text",
"shipmentTypeId": "text",
"statusId": "text",
"primaryOrderId": "text",
"primaryReturnId": "text",
"primaryShipGroupSeqId": "text",
"picklistBinId": "text",
"estimatedReadyDate": "2025-12-09T15:21:30.070Z",
"estimatedShipDate": "2025-12-09T15:21:30.070Z",
"estimatedShipWorkEffId": "text",
"estimatedArrivalDate": "2025-12-09T15:21:30.070Z",
"estimatedArrivalWorkEffId": "text",
"latestCancelDate": "2025-12-09T15:21:30.070Z",
"estimatedShipCost": 1,
"currencyUomId": "text",
"handlingInstructions": "text",
"originFacilityId": "text",
"destinationFacilityId": "text",
"originContactMechId": "text",
"originTelecomNumberId": "text",
"destinationContactMechId": "text",
"destinationTelecomNumberId": "text",
"partyIdTo": "text",
"partyIdFrom": "text",
"additionalShippingCharge": 1,
"addtlShippingChargeDesc": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastModifiedByUserLogin": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"type": {
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentType",
"shipmentTypeId": "text",
"parentTypeId": "text",
"hasTable": "text",
"description": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"statusItem": {
"_entity": "statuses",
"statusId": "text",
"statusTypeId": "text",
"statusCode": "text",
"sequenceNum": 1,
"description": "text",
"statusAge": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"currencyUom": {
"_entity": "uoms",
"uomId": "text",
"uomTypeEnumId": "UT_AREA_MEASURE",
"abbreviation": "text",
"description": "text",
"fractionDigits": 1,
"symbol": "text",
"numericCode": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"originFacility": {
"_entity": "org.apache.ofbiz.product.facility.Facility",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-12-09T15:21:30.070Z",
"closedDate": "2025-12-09T15:21:30.070Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"destinationFacility": {
"_entity": "org.apache.ofbiz.product.facility.Facility",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-12-09T15:21:30.070Z",
"closedDate": "2025-12-09T15:21:30.070Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"originContactMech": {
"_entity": "org.apache.ofbiz.party.contact.ContactMech",
"contactMechId": "text",
"externalId": "text",
"contactMechTypeId": "text",
"infoString": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"destinationContactMech": {
"_entity": "org.apache.ofbiz.party.contact.ContactMech",
"contactMechId": "text",
"externalId": "text",
"contactMechTypeId": "text",
"infoString": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"originPostalAddress": {
"_entity": "org.apache.ofbiz.party.contact.PostalAddress",
"contactMechId": "text",
"toName": "text",
"attnName": "text",
"address1": "text",
"address2": "text",
"houseNumber": 1,
"houseNumberExt": "text",
"directions": "text",
"city": "text",
"cityGeoId": "text",
"postalCode": "text",
"postalCodeExt": "text",
"countryGeoId": "text",
"stateProvinceGeoId": "text",
"countyGeoId": "text",
"municipalityGeoId": "text",
"postalCodeGeoId": "text",
"geoPointId": "text",
"encodedAddressKey": "text",
"latitude": 1,
"longitude": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"originTelecomNumber": {
"_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
"contactMechId": "text",
"countryCode": "text",
"areaCode": "text",
"contactNumber": "text",
"askForName": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"destinationPostalAddress": {
"_entity": "org.apache.ofbiz.party.contact.PostalAddress",
"contactMechId": "text",
"toName": "text",
"attnName": "text",
"address1": "text",
"address2": "text",
"houseNumber": 1,
"houseNumberExt": "text",
"directions": "text",
"city": "text",
"cityGeoId": "text",
"postalCode": "text",
"postalCodeExt": "text",
"countryGeoId": "text",
"stateProvinceGeoId": "text",
"countyGeoId": "text",
"municipalityGeoId": "text",
"postalCodeGeoId": "text",
"geoPointId": "text",
"encodedAddressKey": "text",
"latitude": 1,
"longitude": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"destinationTelecomNumber": {
"_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
"contactMechId": "text",
"countryCode": "text",
"areaCode": "text",
"contactNumber": "text",
"askForName": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"order": {
"_entity": "org.apache.ofbiz.order.order.OrderHeader",
"orderId": "text",
"orderTypeId": "text",
"orderName": "text",
"externalId": "text",
"salesChannelEnumId": "text",
"orderDate": "2025-12-09T15:21:30.070Z",
"priority": "text",
"entryDate": "2025-12-09T15:21:30.070Z",
"pickSheetPrintedDate": "2025-12-09T15:21:30.070Z",
"visitId": "text",
"statusId": "text",
"createdBy": "text",
"firstAttemptOrderId": "text",
"currencyUom": "text",
"syncStatusId": "text",
"billingAccountId": "text",
"originFacilityId": "text",
"webSiteId": "text",
"productStoreId": "text",
"terminalId": "text",
"transactionId": "text",
"autoOrderShoppingListId": "text",
"needsInventoryIssuance": "text",
"isRushOrder": "text",
"internalCode": "text",
"remainingSubTotal": 1,
"grandTotal": 1,
"isViewed": "text",
"invoicePerShipment": "text",
"expireDate": "2025-12-09T15:21:30.070Z",
"localeString": "text",
"customerClassificationId": "text",
"presentmentCurrencyUom": "text",
"autoApprove": "text",
"statusFlowId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"return": {
"_entity": "org.apache.ofbiz.order.return.ReturnHeader",
"returnId": "text",
"externalId": "text",
"returnHeaderTypeId": "text",
"statusId": "text",
"createdBy": "text",
"fromPartyId": "text",
"toPartyId": "text",
"paymentMethodId": "text",
"finAccountId": "text",
"billingAccountId": "text",
"entryDate": "2025-12-09T15:21:30.070Z",
"originContactMechId": "text",
"destinationFacilityId": "text",
"needsInventoryReceive": "text",
"currencyUomId": "text",
"supplierRmaId": "text",
"returnChannelEnumId": "text",
"transactionId": "text",
"returnDate": "2025-12-09T15:21:30.070Z",
"employeeId": "text",
"terminalId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"orderItemShipGroup": {
"_entity": "org.apache.ofbiz.order.order.OrderItemShipGroup",
"orderId": "text",
"shipGroupSeqId": "text",
"shipmentMethodTypeId": "text",
"supplierPartyId": "text",
"vendorPartyId": "text",
"carrierPartyId": "text",
"carrierRoleTypeId": "text",
"facilityId": "text",
"contactMechId": "text",
"telecomContactMechId": "text",
"trackingNumber": "text",
"shippingInstructions": "text",
"maySplit": "text",
"giftMessage": "text",
"isGift": "text",
"shipAfterDate": "2025-12-09T15:21:30.070Z",
"shipByDate": "2025-12-09T15:21:30.070Z",
"estimatedShipDate": "2025-12-09T15:21:30.070Z",
"estimatedDeliveryDate": "2025-12-09T15:21:30.070Z",
"carrierAccountNumber": "text",
"carrierService": "text",
"orderFacilityId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"items": [
{
"_entity": "org.apache.ofbiz.order.order.OrderItem",
"orderId": "text",
"orderItemSeqId": "text",
"externalId": "text",
"orderItemTypeId": "text",
"orderItemGroupSeqId": "text",
"isItemGroupPrimary": "text",
"fromInventoryItemId": "text",
"budgetId": "text",
"budgetItemSeqId": "text",
"productId": "text",
"supplierProductId": "text",
"productFeatureId": "text",
"prodCatalogId": "text",
"productCategoryId": "text",
"isPromo": "text",
"quoteId": "text",
"quoteItemSeqId": "text",
"shoppingListId": "text",
"shoppingListItemSeqId": "text",
"subscriptionId": "text",
"deploymentId": "text",
"quantity": 1,
"cancelQuantity": 1,
"selectedAmount": 1,
"unitPrice": 1,
"unitListPrice": 1,
"unitAverageCost": 1,
"unitRecurringPrice": 1,
"isModifiedPrice": "text",
"recurringFreqUomId": "text",
"itemDescription": "text",
"comments": "text",
"correspondingPoId": "text",
"statusId": "text",
"syncStatusId": "text",
"estimatedShipDate": "2025-12-09T15:21:30.070Z",
"estimatedDeliveryDate": "2025-12-09T15:21:30.070Z",
"autoCancelDate": "2025-12-09T15:21:30.070Z",
"dontCancelSetDate": "2025-12-09T15:21:30.070Z",
"dontCancelSetUserLogin": "text",
"shipBeforeDate": "2025-12-09T15:21:30.070Z",
"shipAfterDate": "2025-12-09T15:21:30.070Z",
"cancelBackOrderDate": "2025-12-09T15:21:30.070Z",
"overrideGlAccountId": "text",
"salesOpportunityId": "text",
"changeByUserLoginId": "text",
"shipGroupSeqId": "text",
"returnTillDate": "2025-12-09T15:21:30.070Z",
"promisedDatetime": "2025-12-09T15:21:30.070Z",
"shipmentId": "text",
"isNewProduct": "text",
"availableToPromise": 1,
"requestedDeliveryDate": "2025-12-09",
"requestedDeliveryTime": "text",
"requestedShipMethTypeId": "text",
"deliveryWindow": 1,
"taxCode": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"adjustments": [
{
"_entity": "org.apache.ofbiz.order.order.OrderAdjustment",
"orderAdjustmentId": "text",
"orderAdjustmentTypeId": "text",
"orderId": "text",
"orderItemSeqId": "text",
"shipGroupSeqId": "text",
"comments": "text",
"description": "text",
"amount": 1,
"recurringAmount": 1,
"amountAlreadyIncluded": 1,
"productPromoId": "text",
"productPromoRuleId": "text",
"productPromoActionSeqId": "text",
"productFeatureId": "text",
"correspondingProductId": "text",
"taxAuthorityRateSeqId": "text",
"sourceReferenceId": "text",
"sourcePercentage": 1,
"customerReferenceId": "text",
"primaryGeoId": "text",
"secondaryGeoId": "text",
"exemptAmount": 1,
"taxAuthGeoId": "text",
"taxAuthPartyId": "text",
"overrideGlAccountId": "text",
"includeInTax": "text",
"includeInShipping": "text",
"isManual": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastModifiedByUserLogin": "text",
"originalAdjustmentId": "text",
"oldAmountPerQuantity": 1,
"oldPercentage": 1,
"billingShipmentId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"attributes": [
{
"_entity": "org.apache.ofbiz.order.order.OrderAdjustmentAttribute",
"orderAdjustmentId": "text",
"attrName": "text",
"attrValue": "text",
"attrDescription": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}
],
"attributes": [
{
"_entity": "org.apache.ofbiz.order.order.OrderItemAttribute",
"orderId": "text",
"orderItemSeqId": "text",
"attrName": "text",
"attrValue": "text",
"attrDescription": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
],
"statuses": [
{
"_entity": "org.apache.ofbiz.order.order.OrderStatus",
"orderStatusId": "text",
"statusId": "text",
"orderId": "text",
"orderItemSeqId": "text",
"orderPaymentPreferenceId": "text",
"statusDatetime": "2025-12-09T15:21:30.070Z",
"statusUserLogin": "text",
"changeReason": "text",
"changeReasonEnumId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}
]
}
}{
"_entity": "org.apache.ofbiz.shipment.shipment.Shipment.PK",
"shipmentId": "text"
}PUT /rest/s1/poorti/shipments/{shipmentId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 11032
{
"_entity": "org.apache.ofbiz.shipment.shipment.Shipment",
"shipmentId": "text",
"externalId": "text",
"shipmentTypeId": "text",
"statusId": "text",
"primaryOrderId": "text",
"primaryReturnId": "text",
"primaryShipGroupSeqId": "text",
"picklistBinId": "text",
"estimatedReadyDate": "2025-12-09T15:21:30.070Z",
"estimatedShipDate": "2025-12-09T15:21:30.070Z",
"estimatedShipWorkEffId": "text",
"estimatedArrivalDate": "2025-12-09T15:21:30.070Z",
"estimatedArrivalWorkEffId": "text",
"latestCancelDate": "2025-12-09T15:21:30.070Z",
"estimatedShipCost": 1,
"currencyUomId": "text",
"handlingInstructions": "text",
"originFacilityId": "text",
"destinationFacilityId": "text",
"originContactMechId": "text",
"originTelecomNumberId": "text",
"destinationContactMechId": "text",
"destinationTelecomNumberId": "text",
"partyIdTo": "text",
"partyIdFrom": "text",
"additionalShippingCharge": 1,
"addtlShippingChargeDesc": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastModifiedByUserLogin": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"type": {
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentType",
"shipmentTypeId": "text",
"parentTypeId": "text",
"hasTable": "text",
"description": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"statusItem": {
"_entity": "statuses",
"statusId": "text",
"statusTypeId": "text",
"statusCode": "text",
"sequenceNum": 1,
"description": "text",
"statusAge": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"currencyUom": {
"_entity": "uoms",
"uomId": "text",
"uomTypeEnumId": "UT_AREA_MEASURE",
"abbreviation": "text",
"description": "text",
"fractionDigits": 1,
"symbol": "text",
"numericCode": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"originFacility": {
"_entity": "org.apache.ofbiz.product.facility.Facility",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-12-09T15:21:30.070Z",
"closedDate": "2025-12-09T15:21:30.070Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"destinationFacility": {
"_entity": "org.apache.ofbiz.product.facility.Facility",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-12-09T15:21:30.070Z",
"closedDate": "2025-12-09T15:21:30.070Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"originContactMech": {
"_entity": "org.apache.ofbiz.party.contact.ContactMech",
"contactMechId": "text",
"externalId": "text",
"contactMechTypeId": "text",
"infoString": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"destinationContactMech": {
"_entity": "org.apache.ofbiz.party.contact.ContactMech",
"contactMechId": "text",
"externalId": "text",
"contactMechTypeId": "text",
"infoString": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"originPostalAddress": {
"_entity": "org.apache.ofbiz.party.contact.PostalAddress",
"contactMechId": "text",
"toName": "text",
"attnName": "text",
"address1": "text",
"address2": "text",
"houseNumber": 1,
"houseNumberExt": "text",
"directions": "text",
"city": "text",
"cityGeoId": "text",
"postalCode": "text",
"postalCodeExt": "text",
"countryGeoId": "text",
"stateProvinceGeoId": "text",
"countyGeoId": "text",
"municipalityGeoId": "text",
"postalCodeGeoId": "text",
"geoPointId": "text",
"encodedAddressKey": "text",
"latitude": 1,
"longitude": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"originTelecomNumber": {
"_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
"contactMechId": "text",
"countryCode": "text",
"areaCode": "text",
"contactNumber": "text",
"askForName": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"destinationPostalAddress": {
"_entity": "org.apache.ofbiz.party.contact.PostalAddress",
"contactMechId": "text",
"toName": "text",
"attnName": "text",
"address1": "text",
"address2": "text",
"houseNumber": 1,
"houseNumberExt": "text",
"directions": "text",
"city": "text",
"cityGeoId": "text",
"postalCode": "text",
"postalCodeExt": "text",
"countryGeoId": "text",
"stateProvinceGeoId": "text",
"countyGeoId": "text",
"municipalityGeoId": "text",
"postalCodeGeoId": "text",
"geoPointId": "text",
"encodedAddressKey": "text",
"latitude": 1,
"longitude": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"destinationTelecomNumber": {
"_entity": "org.apache.ofbiz.party.contact.TelecomNumber",
"contactMechId": "text",
"countryCode": "text",
"areaCode": "text",
"contactNumber": "text",
"askForName": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"order": {
"_entity": "org.apache.ofbiz.order.order.OrderHeader",
"orderId": "text",
"orderTypeId": "text",
"orderName": "text",
"externalId": "text",
"salesChannelEnumId": "text",
"orderDate": "2025-12-09T15:21:30.070Z",
"priority": "text",
"entryDate": "2025-12-09T15:21:30.070Z",
"pickSheetPrintedDate": "2025-12-09T15:21:30.070Z",
"visitId": "text",
"statusId": "text",
"createdBy": "text",
"firstAttemptOrderId": "text",
"currencyUom": "text",
"syncStatusId": "text",
"billingAccountId": "text",
"originFacilityId": "text",
"webSiteId": "text",
"productStoreId": "text",
"terminalId": "text",
"transactionId": "text",
"autoOrderShoppingListId": "text",
"needsInventoryIssuance": "text",
"isRushOrder": "text",
"internalCode": "text",
"remainingSubTotal": 1,
"grandTotal": 1,
"isViewed": "text",
"invoicePerShipment": "text",
"expireDate": "2025-12-09T15:21:30.070Z",
"localeString": "text",
"customerClassificationId": "text",
"presentmentCurrencyUom": "text",
"autoApprove": "text",
"statusFlowId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"return": {
"_entity": "org.apache.ofbiz.order.return.ReturnHeader",
"returnId": "text",
"externalId": "text",
"returnHeaderTypeId": "text",
"statusId": "text",
"createdBy": "text",
"fromPartyId": "text",
"toPartyId": "text",
"paymentMethodId": "text",
"finAccountId": "text",
"billingAccountId": "text",
"entryDate": "2025-12-09T15:21:30.070Z",
"originContactMechId": "text",
"destinationFacilityId": "text",
"needsInventoryReceive": "text",
"currencyUomId": "text",
"supplierRmaId": "text",
"returnChannelEnumId": "text",
"transactionId": "text",
"returnDate": "2025-12-09T15:21:30.070Z",
"employeeId": "text",
"terminalId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"orderItemShipGroup": {
"_entity": "org.apache.ofbiz.order.order.OrderItemShipGroup",
"orderId": "text",
"shipGroupSeqId": "text",
"shipmentMethodTypeId": "text",
"supplierPartyId": "text",
"vendorPartyId": "text",
"carrierPartyId": "text",
"carrierRoleTypeId": "text",
"facilityId": "text",
"contactMechId": "text",
"telecomContactMechId": "text",
"trackingNumber": "text",
"shippingInstructions": "text",
"maySplit": "text",
"giftMessage": "text",
"isGift": "text",
"shipAfterDate": "2025-12-09T15:21:30.070Z",
"shipByDate": "2025-12-09T15:21:30.070Z",
"estimatedShipDate": "2025-12-09T15:21:30.070Z",
"estimatedDeliveryDate": "2025-12-09T15:21:30.070Z",
"carrierAccountNumber": "text",
"carrierService": "text",
"orderFacilityId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"items": [
{
"_entity": "org.apache.ofbiz.order.order.OrderItem",
"orderId": "text",
"orderItemSeqId": "text",
"externalId": "text",
"orderItemTypeId": "text",
"orderItemGroupSeqId": "text",
"isItemGroupPrimary": "text",
"fromInventoryItemId": "text",
"budgetId": "text",
"budgetItemSeqId": "text",
"productId": "text",
"supplierProductId": "text",
"productFeatureId": "text",
"prodCatalogId": "text",
"productCategoryId": "text",
"isPromo": "text",
"quoteId": "text",
"quoteItemSeqId": "text",
"shoppingListId": "text",
"shoppingListItemSeqId": "text",
"subscriptionId": "text",
"deploymentId": "text",
"quantity": 1,
"cancelQuantity": 1,
"selectedAmount": 1,
"unitPrice": 1,
"unitListPrice": 1,
"unitAverageCost": 1,
"unitRecurringPrice": 1,
"isModifiedPrice": "text",
"recurringFreqUomId": "text",
"itemDescription": "text",
"comments": "text",
"correspondingPoId": "text",
"statusId": "text",
"syncStatusId": "text",
"estimatedShipDate": "2025-12-09T15:21:30.070Z",
"estimatedDeliveryDate": "2025-12-09T15:21:30.070Z",
"autoCancelDate": "2025-12-09T15:21:30.070Z",
"dontCancelSetDate": "2025-12-09T15:21:30.070Z",
"dontCancelSetUserLogin": "text",
"shipBeforeDate": "2025-12-09T15:21:30.070Z",
"shipAfterDate": "2025-12-09T15:21:30.070Z",
"cancelBackOrderDate": "2025-12-09T15:21:30.070Z",
"overrideGlAccountId": "text",
"salesOpportunityId": "text",
"changeByUserLoginId": "text",
"shipGroupSeqId": "text",
"returnTillDate": "2025-12-09T15:21:30.070Z",
"promisedDatetime": "2025-12-09T15:21:30.070Z",
"shipmentId": "text",
"isNewProduct": "text",
"availableToPromise": 1,
"requestedDeliveryDate": "2025-12-09",
"requestedDeliveryTime": "text",
"requestedShipMethTypeId": "text",
"deliveryWindow": 1,
"taxCode": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"adjustments": [
{
"_entity": "org.apache.ofbiz.order.order.OrderAdjustment",
"orderAdjustmentId": "text",
"orderAdjustmentTypeId": "text",
"orderId": "text",
"orderItemSeqId": "text",
"shipGroupSeqId": "text",
"comments": "text",
"description": "text",
"amount": 1,
"recurringAmount": 1,
"amountAlreadyIncluded": 1,
"productPromoId": "text",
"productPromoRuleId": "text",
"productPromoActionSeqId": "text",
"productFeatureId": "text",
"correspondingProductId": "text",
"taxAuthorityRateSeqId": "text",
"sourceReferenceId": "text",
"sourcePercentage": 1,
"customerReferenceId": "text",
"primaryGeoId": "text",
"secondaryGeoId": "text",
"exemptAmount": 1,
"taxAuthGeoId": "text",
"taxAuthPartyId": "text",
"overrideGlAccountId": "text",
"includeInTax": "text",
"includeInShipping": "text",
"isManual": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastModifiedByUserLogin": "text",
"originalAdjustmentId": "text",
"oldAmountPerQuantity": 1,
"oldPercentage": 1,
"billingShipmentId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"attributes": [
{
"_entity": "org.apache.ofbiz.order.order.OrderAdjustmentAttribute",
"orderAdjustmentId": "text",
"attrName": "text",
"attrValue": "text",
"attrDescription": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}
],
"attributes": [
{
"_entity": "org.apache.ofbiz.order.order.OrderItemAttribute",
"orderId": "text",
"orderItemSeqId": "text",
"attrName": "text",
"attrValue": "text",
"attrDescription": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
],
"statuses": [
{
"_entity": "org.apache.ofbiz.order.order.OrderStatus",
"orderStatusId": "text",
"statusId": "text",
"orderId": "text",
"orderItemSeqId": "text",
"orderPaymentPreferenceId": "text",
"statusDatetime": "2025-12-09T15:21:30.070Z",
"statusUserLogin": "text",
"changeReason": "text",
"changeReasonEnumId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}
]
}
}{
"_entity": "org.apache.ofbiz.shipment.shipment.Shipment.PK",
"shipmentId": "text"
}{
"packedShipmentId": "text"
}GET /rest/s1/poorti/shipments/{shipmentId}/shipmentPackages HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackage",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentBoxTypeId": "text",
"dateCreated": "2025-12-09T15:21:30.070Z",
"boxLength": 1,
"boxHeight": 1,
"boxWidth": 1,
"dimensionUomId": {
"_entity": "uoms",
"uomId": "text",
"uomTypeEnumId": "UT_AREA_MEASURE",
"abbreviation": "text",
"description": "text",
"fractionDigits": 1,
"symbol": "text",
"numericCode": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"weight": 1,
"weightUomId": {
"_entity": "uoms",
"uomId": "text",
"uomTypeEnumId": "UT_AREA_MEASURE",
"abbreviation": "text",
"description": "text",
"fractionDigits": 1,
"symbol": "text",
"numericCode": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"insuredValue": 1,
"packageName": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"shipment": {
"_entity": "org.apache.ofbiz.shipment.shipment.Shipment",
"shipmentId": "text",
"externalId": "text",
"shipmentTypeId": "text",
"statusId": "text",
"primaryOrderId": "text",
"primaryReturnId": "text",
"primaryShipGroupSeqId": "text",
"picklistBinId": "text",
"estimatedReadyDate": "2025-12-09T15:21:30.070Z",
"estimatedShipDate": "2025-12-09T15:21:30.070Z",
"estimatedShipWorkEffId": "text",
"estimatedArrivalDate": "2025-12-09T15:21:30.070Z",
"estimatedArrivalWorkEffId": "text",
"latestCancelDate": "2025-12-09T15:21:30.070Z",
"estimatedShipCost": 1,
"currencyUomId": "text",
"handlingInstructions": "text",
"originFacilityId": "text",
"destinationFacilityId": "text",
"originContactMechId": "text",
"originTelecomNumberId": "text",
"destinationContactMechId": "text",
"destinationTelecomNumberId": "text",
"partyIdTo": "text",
"partyIdFrom": "text",
"additionalShippingCharge": 1,
"addtlShippingChargeDesc": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUserLogin": "text",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastModifiedByUserLogin": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"boxType": {
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentBoxType",
"shipmentBoxTypeId": "text",
"description": "text",
"dimensionUomId": "text",
"boxLength": 1,
"boxWidth": 1,
"boxHeight": 1,
"weightUomId": "text",
"boxWeight": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"carrierBoxType": [
{
"_entity": "org.apache.ofbiz.shipment.shipment.CarrierShipmentBoxType",
"shipmentBoxTypeId": "text",
"partyId": "text",
"packagingTypeCode": "text",
"oversizeCode": "text",
"pickupContainerCode": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}
]{
"shipmentId": "text",
"shipmentPackageSeqId": "text"
}{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackage.PK",
"shipmentId": "text",
"shipmentPackageSeqId": "text"
}[
{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackageContent",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentItemSeqId": "text",
"quantity": 1,
"subProductId": "text",
"subProductQuantity": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackageContent.PK",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentItemSeqId": "text"
}{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentPackageRouteSeg.PK",
"shipmentId": "text",
"shipmentPackageSeqId": "text",
"shipmentRouteSegmentId": "text"
}{
"_entity": "org.apache.ofbiz.shipment.shipment.ShipmentRouteSegment.PK",
"shipmentId": "text",
"shipmentRouteSegmentId": "text"
}{
"packedShipmentIds": []
}GET /rest/s1/poorti/PackingSlip.pdf HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
In the absence of a product specific days to ship in ProductFacility, this will be used
This field store the unit of measurement of dimension (length, width and height)
This field stores facility ID of the external system
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Note that this corresponds with the organizationPartyId that GL transactions will be posted to.
If immediately fulfilled (for physical stores, etc): don't send email notices, don't reserve inventory, and IFF inventory info isn't found on the server then don't issue inventory right away
If set to Y, when a new sales order is created with backordered items, then reservations on the facility/product are reassigned according to the priority given by the shipBeforeDate field.
Specify the type (Billing Account or Financial Account) of Store Credit Account used for refund return. Default to Financial Account. This field is override by ReturnHeader.billingAccountId or ReturnHeader.finAccountId, whichever is specified but if only finAccountId is specified explicitly then system will first try to locate any billing account with -ve amount. If found, then amount is credit to this billing account else the amount will be credit to the financial account of the user.
Default Y. Invoice digital items when order is placed rather than waiting for completing order items (though shipment/fulfillment).
Default Y. Require Shipping Address for Digital Items? Note this only has an effect if there are ONLY digital goods in the cart.
default Y; if set to N do not show isExempt checkbox for PartyTaxAuthInfo, always force to N
The auto-suggestion list is a special ShoppingList that the addSuggestionsToShoppingList service will maintain for cross-sells of ordered items.
default Y; if set to Y an additional constraint will of isVariant!=Y will be added to all product searches for the store
For auto-orders try other Credit Card expiration dates (if date is wrong or general failure where type not known)?
For auto-orders try other Credit Cards for the customer?
For auto-orders if Credit Cards fails for NSF (Not Sufficient Funds) try again later?
For auto-orders if Credit Cards fails for NSF try again how many times?
How many days that store credit is valid for. Null value implies no expiration.
If Y or empty, sales invoices created from orders will be marked ready.
If N, orders will not be automatically approved when payment is authorized.
If N, the captureOrderPayments will cause a service error if credit card capture fails.
If Y or empty, set the inventory item owner upon issuance.
Default N. This is the default value for the ReturnHeader.needsInventoryReceive field. If set to Y return will automatically go to the Received status when Accepted instead of waiting for actual receipt of the return.
Default N. If Y then on add to cart remove all products in cart with a ProductAssoc record related to or from the product and with the PRODUCT_INCOMPATABLE type.
Default N. If Y then on add to cart remove all products in cart with a ProductAssoc record related from the product and with the PRODUCT_UPGRADE type.
Default N. If Y then before the order is stored the OrderPaymentPreference record will be split, one for each OrderItemShipGroup.
If Y, the preparator can choose the InventoryItem by this lotId when he makes the picklist.
Default Y. If N then out of stock products will not be displayed on site
use to indicate if decimal quantity can be ordered for this producStore. Default value is Y
Allow comments for order line items per store
Catalog Url mount point to be used
Restocking fee percentage
Flag to identify if order payments have to be captured when order is added to CSV with value Y or N
Order for products of store will be placed with defined term type.
Mainly used to control nearest facility work flow
Flag to identify if the external promotions are enabled for the store.
Indicates number of days till order can be returned
Indicates Fee charged for Restocking.
Flag to identify if the return will be accepted automatically.
Product identifier to identify unique product
Flag to enable/disable auto preorder releasing on particular store/brand.
Flag to enable/disable brokering on particular store/brand.
Image path for display brand specific logo
In the absence of a product specific days to ship in ProductFacility, this will be used
This field store the unit of measurement of dimension (length, width and height)
This field stores facility ID of the external system
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
co.hotwax.datamanager.DataManagerMappingSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
co.hotwax.datamanager.DataManagerMappingSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
No content
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
org.apache.ofbiz.product.store.ProductStoreSettingSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Usage depends on enum type such as an ID format/mask
Indicator flag with meaning depending on enum type
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
co.hotwax.warehouse.InventoryCountImportSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
co.hotwax.warehouse.InventoryCountImportSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
The current page index to get the inventory count import items.
The maximum number of inventory count import items to display.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
co.hotwax.warehouse.InventoryCountImportItemSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
No content
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
No content
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
No content
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
No content
co.hotwax.warehouse.InventoryCountImportItemSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
No content
The current page index to get the inventory count import items.
The maximum number of inventory count import items to display.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
co.hotwax.warehouse.InventoryCountImportViewSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
No content
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Reference to the SystemMessageRemote record for the remote system this message came from for incoming messages or should be sent to for outgoing messages.
For incoming the received date, for outgoing the produced date
For incoming the consumed date, for outgoing the sent date
If a received message is split this is the original message
The message received or sent to acknowledge this message
For messages to/from another Moqui system, the systemMessageId on the remote system; may also be used for other system level message IDs (as opposed to messageId which is for the ID in the envelope of the message)
ID of the sender (for OAGIS may be broken down into logicalId, component, task, referenceId; for EDI X12 this is ISA06)
ID of the receiver (for OAGIS may also be broken down; for EDI X12 this is ISA08)
ID of the message; this may be globally unique (like the OAGIS BODID, a GUID) or only unique relative to the senderId and the receiverId (like EDI X12 ISA13 in the context of ISA06, ISA08), and may only be unique within a certain time period (ID may be reused since in EDI X12 limited to 9 digits)
Date/time from message (for EDI X12 this is GS04 (date) and GS05 (time))
For OAGIS the BSR Noun; For X12 GS01 (functional ID code)
For OAGIS the BSR Verb; For X12 ST01 (tx set ID code)
Control number of the message when applicable (such as GS06 in EDI X12 messages)
Sub-Control number of the message when applicable (such as ST02 in EDI X12 messages)
The document version (for OAGIS BSR Revision, for X12 GS08 (version/revision))
Active visit when SystemMessage triggered (mainly produced) to track the user who did so; independent of the message transport which could have separate remote system and other Visit-like data.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
systemMessagesSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
The user that initiated the job run
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Runtime data for a scheduled ServiceJob (with a cronExpression), managed automatically by the service job runner.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
GET /rest/s1/inventory-cycle-count/dataManagerMappings HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/inventory-cycle-count/dataManagerMappings HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 281
{
"_entity": "co.hotwax.datamanager.DataManagerMapping",
"mappingPrefId": "text",
"mappingPrefName": "text",
"mappingPrefTypeEnumId": "text",
"mappingPrefValue": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/inventory-cycle-count/dataManagerMappings/{mappingPrefId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "co.hotwax.datamanager.DataManagerMapping",
"mappingPrefId": "text",
"mappingPrefName": "text",
"mappingPrefTypeEnumId": "text",
"mappingPrefValue": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}POST /rest/s1/inventory-cycle-count/dataManagerMappings/{mappingPrefId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 281
{
"_entity": "co.hotwax.datamanager.DataManagerMapping",
"mappingPrefId": "text",
"mappingPrefName": "text",
"mappingPrefTypeEnumId": "text",
"mappingPrefValue": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}DELETE /rest/s1/inventory-cycle-count/dataManagerMappings/{mappingPrefId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/inventory-cycle-count/login HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 52
{
"username": "text",
"password": "text",
"token": "text"
}GET /rest/s1/inventory-cycle-count/productStores/{productStoreId}/settings HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/inventory-cycle-count/productStores/{productStoreId}/settings HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 183
{
"_entity": "org.apache.ofbiz.product.store.ProductStoreSetting",
"productStoreId": "text",
"settingTypeEnumId": "text",
"settingValue": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/inventory-cycle-count/enums HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/inventory-cycle-count/cycleCounts HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/inventory-cycle-count/cycleCounts HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 350
{
"_entity": "co.hotwax.warehouse.InventoryCountImport",
"inventoryCountImportId": "text",
"countImportName": "text",
"countTypeEnumId": "text",
"uploadedByUserLogin": "text",
"facilityId": "text",
"parentCountId": "text",
"statusId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"dueDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "co.hotwax.warehouse.InventoryCountImportView",
"statusDescription": "text",
"facilityName": "text",
"closedDate": "2025-12-09T15:21:30.070Z",
"inventoryCountImportId": "text",
"countImportName": "text",
"countTypeEnumId": "text",
"uploadedByUserLogin": "text",
"facilityId": "text",
"parentCountId": "text",
"statusId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"dueDate": "2025-12-09T15:21:30.070Z"
}PUT /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 350
{
"_entity": "co.hotwax.warehouse.InventoryCountImport",
"inventoryCountImportId": "text",
"countImportName": "text",
"countTypeEnumId": "text",
"uploadedByUserLogin": "text",
"facilityId": "text",
"parentCountId": "text",
"statusId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"dueDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/{importItemSeqId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "co.hotwax.warehouse.InventoryCountImportItem",
"inventoryCountImportId": "text",
"importItemSeqId": "text",
"locationSeqId": "text",
"statusId": "text",
"productId": "text",
"productIdentifier": "text",
"quantity": 1,
"countedByUserLoginId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUserLoginId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}PUT /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/{importItemSeqId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 362
{
"_entity": "co.hotwax.warehouse.InventoryCountImportItem",
"inventoryCountImportId": "text",
"importItemSeqId": "text",
"locationSeqId": "text",
"statusId": "text",
"productId": "text",
"productIdentifier": "text",
"quantity": 1,
"countedByUserLoginId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUserLoginId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}DELETE /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/{importItemSeqId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/{importItemSeqId}/accept HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 150
{
"inventoryCountImportId": "text",
"importItemSeqId": "text",
"quantity": "text",
"systemQOH": "text",
"varianceQty": "text",
"reason": "text",
"comments": "text"
}GET /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/summary HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/add HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"inventoryCountImportId": "text",
"itemList": []
}POST /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/update HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"inventoryCountImportId": "text",
"itemList": []
}POST /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/recount HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 55
{
"inventoryCountImportId": "text",
"importItemSeqIds": []
}GET /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/items/count HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 362
{
"_entity": "co.hotwax.warehouse.InventoryCountImportItem",
"inventoryCountImportId": "text",
"importItemSeqId": "text",
"locationSeqId": "text",
"statusId": "text",
"productId": "text",
"productIdentifier": "text",
"quantity": 1,
"countedByUserLoginId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUserLoginId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/inventory-cycle-count/cycleCounts/{inventoryCountImportId}/stats HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"statusDescription": "text",
"facilityName": "text",
"closedDate": "2025-12-09T15:21:30.070Z",
"inventoryCountImportId": "text",
"countImportName": "text",
"countTypeEnumId": "text",
"uploadedByUserLogin": "text",
"facilityId": "text",
"parentCountId": "text",
"statusId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"dueDate": "2025-12-09T15:21:30.070Z",
"totalItems": "text",
"itemCounted": "text",
"rejectedCount": "text",
"totalVariance": "text",
"statusHistory": "text"
}POST /rest/s1/inventory-cycle-count/cycleCounts/rejectedItems HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"productId": "text",
"facilityId": "text"
}POST /rest/s1/inventory-cycle-count/cycleCounts/bulk HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"inventoryCountImports": []
}GET /rest/s1/inventory-cycle-count/cycleCounts/items HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/inventory-cycle-count/cycleCounts/count HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 397
{
"_entity": "co.hotwax.warehouse.InventoryCountImportView",
"statusDescription": "text",
"facilityName": "text",
"closedDate": "2025-12-09T15:21:30.070Z",
"inventoryCountImportId": "text",
"countImportName": "text",
"countTypeEnumId": "text",
"uploadedByUserLogin": "text",
"facilityId": "text",
"parentCountId": "text",
"statusId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"dueDate": "2025-12-09T15:21:30.070Z"
}POST /rest/s1/inventory-cycle-count/cycleCounts/stats HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"inventoryCountImportIds": []
}POST /rest/s1/inventory-cycle-count/cycleCounts/upload HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"uploadedFile": "text"
}POST /rest/s1/inventory-cycle-count/cycleCounts/systemMessages/{systemMessageId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 739
{
"_entity": "systemMessages",
"systemMessageId": "text",
"systemMessageTypeId": "text",
"systemMessageRemoteId": "text",
"statusId": "SmsgProduced",
"isOutgoing": "text",
"initDate": "2025-12-09T15:21:30.070Z",
"processedDate": "2025-12-09T15:21:30.070Z",
"lastAttemptDate": "2025-12-09T15:21:30.070Z",
"failCount": 1,
"parentMessageId": "text",
"ackMessageId": "text",
"remoteMessageId": "text",
"messageText": "text",
"senderId": "text",
"receiverId": "text",
"messageId": "text",
"messageDate": "2025-12-09T15:21:30.070Z",
"docType": "text",
"docSubType": "text",
"docControl": "text",
"docSubControl": "text",
"docVersion": "text",
"triggerVisitId": "text",
"productStoreId": "text",
"shopId": "text",
"orderId": "text",
"consumeSmrId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/inventory-cycle-count/cycleCounts/systemMessages/{systemMessageId}/downloadFile HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"csvData": "text"
}GET /rest/s1/inventory-cycle-count/cycleCounts/systemMessages/{systemMessageId}/errors HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/inventory-cycle-count/user/{partyId}/facilities HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/inventory-cycle-count/user/profile HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"userId": "text",
"username": "text",
"userFullName": "text",
"timeZone": "text",
"locale": "text",
"emailAddress": "text",
"preferences": {
"userId": "text",
"preferenceKey": "text",
"preferenceValue": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"partyId": "text"
}GET /rest/s1/inventory-cycle-count/facilities HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "co.hotwax.facility.FacilityAndType",
"typeDescription": "text",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-12-09T15:21:30.070Z",
"closedDate": "2025-12-09T15:21:30.070Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"parentTypeId": "text",
"hasTable": "text"
}
]GET /rest/s1/inventory-cycle-count/facilities/productStores HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "co.hotwax.product.store.ProductStoreFacilityDetail",
"storeExternalId": "text",
"parentFacilityTypeId": "text",
"productStoreId": "text",
"facilityId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"sequenceNum": 1,
"primaryStoreGroupId": "text",
"storeName": "text",
"companyName": "text",
"title": "text",
"subtitle": "text",
"payToPartyId": "text",
"daysToCancelNonPay": 1,
"manualAuthIsCapture": "text",
"prorateShipping": "text",
"prorateTaxes": "text",
"viewCartOnAdd": "text",
"autoSaveCart": "text",
"autoApproveReviews": "text",
"isDemoStore": "text",
"isImmediatelyFulfilled": "text",
"inventoryFacilityId": "text",
"oneInventoryFacility": "text",
"checkInventory": "text",
"reserveInventory": "text",
"reserveOrderEnumId": "text",
"requireInventory": "text",
"balanceResOnOrderCreation": "text",
"requirementMethodEnumId": "text",
"orderNumberPrefix": "text",
"defaultLocaleString": "text",
"defaultCurrencyUomId": "text",
"defaultTimeZoneString": "text",
"defaultSalesChannelEnumId": "text",
"allowPassword": "text",
"defaultPassword": "text",
"explodeOrderItems": "text",
"checkGcBalance": "text",
"retryFailedAuths": "text",
"headerApprovedStatus": "text",
"itemApprovedStatus": "text",
"digitalItemApprovedStatus": "text",
"headerDeclinedStatus": "text",
"itemDeclinedStatus": "text",
"headerCancelStatus": "text",
"itemCancelStatus": "text",
"authDeclinedMessage": "text",
"authFraudMessage": "text",
"authErrorMessage": "text",
"visualThemeId": "text",
"storeCreditAccountEnumId": "text",
"usePrimaryEmailUsername": "text",
"requireCustomerRole": "text",
"autoInvoiceDigitalItems": "text",
"reqShipAddrForDigItems": "text",
"showCheckoutGiftOptions": "text",
"selectPaymentTypePerItem": "text",
"showPricesWithVatTax": "text",
"showTaxIsExempt": "text",
"vatTaxAuthGeoId": "text",
"vatTaxAuthPartyId": "text",
"enableAutoSuggestionList": "text",
"enableDigProdUpload": "text",
"prodSearchExcludeVariants": "text",
"digProdUploadCategoryId": "text",
"autoOrderCcTryExp": "text",
"autoOrderCcTryOtherCards": "text",
"autoOrderCcTryLaterNsf": "text",
"autoOrderCcTryLaterMax": 1,
"storeCreditValidDays": 1,
"autoApproveInvoice": "text",
"autoApproveOrder": "text",
"shipIfCaptureFails": "text",
"setOwnerUponIssuance": "text",
"reqReturnInventoryReceive": "text",
"addToCartRemoveIncompat": "text",
"addToCartReplaceUpsell": "text",
"splitPayPrefPerShpGrp": "text",
"managedByLot": "text",
"showOutOfStockProducts": "text",
"orderDecimalQuantity": "text",
"allowComment": "text",
"oldStyleSheet": "text",
"oldHeaderLogo": "text",
"oldHeaderMiddleBackground": "text",
"oldHeaderRightBackground": "text",
"catalogUrlMountPoint": "text",
"restockingFeePercentage": 1,
"capturePmntsOnOrdApproval": "text",
"termTypeId": "text",
"autoSetFacility": "text",
"enableExternalPromotion": "text",
"daysToReturn": 1,
"restockingFeeFixed": 1,
"autoAcceptReturn": "text",
"allowSplit": "text",
"storeDomain": "text",
"productIdentifierEnumId": "text",
"enablePreOrderAutoReleasing": "text",
"enableBrokering": "text",
"storeLogoImageUrl": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-12-09T15:21:30.070Z",
"closedDate": "2025-12-09T15:21:30.070Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text"
}
][
{
"_entity": "co.hotwax.datamanager.DataManagerMapping",
"mappingPrefId": "text",
"mappingPrefName": "text",
"mappingPrefTypeEnumId": "text",
"mappingPrefValue": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]{
"_entity": "co.hotwax.datamanager.DataManagerMapping.PK",
"mappingPrefId": "text"
}{
"_entity": "co.hotwax.datamanager.DataManagerMapping.PK",
"mappingPrefId": "text"
}{
"token": "text",
"expirationTime": "text",
"api_key": "text"
}[
{
"_entity": "org.apache.ofbiz.product.store.ProductStoreSetting",
"productStoreId": "text",
"settingTypeEnumId": "text",
"settingValue": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]{
"_entity": "org.apache.ofbiz.product.store.ProductStoreSetting.PK",
"productStoreId": "text",
"settingTypeEnumId": "text"
}[
{
"_entity": "co.hotwax.common.enum.EnumerationAndType",
"typeDescription": "text",
"enumId": "text",
"enumTypeId": "text",
"parentEnumId": "text",
"enumCode": "text",
"sequenceNum": 1,
"description": "text",
"optionValue": "text",
"optionIndicator": "text",
"relatedEnumId": "text",
"relatedEnumTypeId": "text",
"statusFlowId": "text",
"enumName": "text",
"primaryEnumerationGroupId": "text",
"parentTypeId": "text"
}
][
{
"_entity": "co.hotwax.warehouse.InventoryCountImportView",
"statusDescription": "text",
"facilityName": "text",
"closedDate": "2025-12-09T15:21:30.070Z",
"inventoryCountImportId": "text",
"countImportName": "text",
"countTypeEnumId": "text",
"uploadedByUserLogin": "text",
"facilityId": "text",
"parentCountId": "text",
"statusId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"dueDate": "2025-12-09T15:21:30.070Z"
}
]{
"_entity": "co.hotwax.warehouse.InventoryCountImport.PK",
"inventoryCountImportId": "text"
}{
"_entity": "co.hotwax.warehouse.InventoryCountImport.PK",
"inventoryCountImportId": "text"
}{
"itemList": []
}{
"_entity": "co.hotwax.warehouse.InventoryCountImportItem.PK",
"inventoryCountImportId": "text",
"importItemSeqId": "text"
}[
{
"_entity": "co.hotwax.warehouse.InventoryCountImportItem",
"inventoryCountImportId": "text",
"importItemSeqId": "text",
"locationSeqId": "text",
"statusId": "text",
"productId": "text",
"productIdentifier": "text",
"quantity": 1,
"countedByUserLoginId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUserLoginId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]{
"itemList": []
}{
"count": 1
}{
"inventoryCountImportItem": {}
}{
"itemList": []
}{
"count": 1
}{
"importStats": []
}GET /rest/s1/inventory-cycle-count/cycleCounts/systemMessages HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "systemMessages",
"systemMessageId": "text",
"systemMessageTypeId": "text",
"systemMessageRemoteId": "text",
"statusId": "SmsgProduced",
"isOutgoing": "text",
"initDate": "2025-12-09T15:21:30.070Z",
"processedDate": "2025-12-09T15:21:30.070Z",
"lastAttemptDate": "2025-12-09T15:21:30.070Z",
"failCount": 1,
"parentMessageId": "text",
"ackMessageId": "text",
"remoteMessageId": "text",
"messageText": "text",
"senderId": "text",
"receiverId": "text",
"messageId": "text",
"messageDate": "2025-12-09T15:21:30.070Z",
"docType": "text",
"docSubType": "text",
"docControl": "text",
"docSubControl": "text",
"docVersion": "text",
"triggerVisitId": "text",
"productStoreId": "text",
"shopId": "text",
"orderId": "text",
"consumeSmrId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]{
"_entity": "systemMessages.PK",
"systemMessageId": "text"
}[
{
"_entity": "moqui.service.message.SystemMessageError",
"systemMessageId": "text",
"errorDate": "2025-12-09T15:21:30.070Z",
"attemptedStatusId": "text",
"errorText": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
][
{
"_entity": "org.apache.ofbiz.product.facility.FacilityParty",
"facilityId": "text",
"partyId": "text",
"roleTypeId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
][
{
"_entity": "moqui.service.job.ServiceJobRun",
"jobRunId": "text",
"jobName": "text",
"userId": "text",
"parameters": "text",
"results": "text",
"messages": "text",
"hasError": "text",
"errors": "text",
"hostAddress": "text",
"hostName": "text",
"runThread": "text",
"startTime": "2025-12-09T15:21:30.070Z",
"endTime": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]GET /rest/s1/available-to-promise/serviceJobRuns/{jobName} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/available-to-promise/serviceJobRuns/{jobName}/{jobRunId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "moqui.service.job.ServiceJobRun",
"jobRunId": "text",
"jobName": "text",
"userId": "text",
"parameters": "text",
"results": "text",
"messages": "text",
"hasError": "text",
"errors": "text",
"hostAddress": "text",
"hostName": "text",
"runThread": "text",
"startTime": "2025-12-09T15:21:30.070Z",
"endTime": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/available-to-promise/serviceJobRuns/{jobName}/activeJobRun HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "moqui.service.job.ServiceJobRunLock",
"jobName": "text",
"jobRunId": "text",
"lastRunTime": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}Represents a group or category used for organizing and managing order routing configurations.
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the routing group
Unique identifier for the product store
Name of the routing group.
Sequence number for ordering.
moqui.service.job.Service reference
Description or additional information about the routing group.
User login ID of the creator
Date and time when the routing group was created
Date and time when the routing group was updated
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Represents a group or category used for organizing and managing order routing configurations.
orderRoutingGroupSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Represents a group or category used for organizing and managing order routing configurations.
Unique identifier for the routing group
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Represents a group or category used for organizing and managing order routing configurations.
Unique identifier for the routing group
orderRoutingGroupSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
This service schedules the routing process for an Order Routing Group. If the routing group schedule is not configured, the service will first create a schedule with a "pause" status (i.e., pause = "Y"), then service will trigger the framework to schedule the order routing group for immediate processing. The service utilizes the ScheduleJob functionality to initiate the process. Parameters for this execution are retrieved from the ServiceJobParameter. It's important to note that this service is designed to handle Order Routing Groups and not intended for scheduling individual orders.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
The action initiates the processing or execution sequence for an Order Routing within the system. This procedure is crucial for managing and directing orders through the appropriate fulfillment pathways based on predefined criteria and rules set within the Order Routing Group. This service is designed to retrieve active order routings for a specified OrderRoutingGroup based on their sequence number. It aims to prioritize and organize order processing efficiently, ensuring that orders are routed and fulfilled according to pre-established sequences that optimize logistics, delivery times, and resource allocation.
For test drive mode, if the productStore has brokering disabled (enableBrokering is set to "N") and a valid testDriveSessionId is provided, the brokering group will be executed.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Order routing group sequence. By default, it will be added as the last one.
Parameter to check if the Order routing needs to be cloned.
trueParameter to check if the Order routing rule needs to be cloned, works only if copyOrderRoutings set to true.
trueSuccess
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Represents configurations for routing orders, including rules and conditions for order fulfillment.
Unique identifier for the routing group
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the order routing.
Status identifier for the order routing.
Name or identifier for the order routing.
Sequence number for ordering.
Description or additional information about the order routing.
User login ID of the creator.
Date and time when the order routing was created.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Represents the execution and results of order routing runs, including information about errors and outcomes.
Unique identifier for the order routing group.
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the routing run.
Unique identifier for the order routing.
Distinguishes between different routing runs initiated as part of batch processing.
Unique identifier for the product store.
User login ID of the creator.
Indicator for the presence of errors.
Start date of the routing run.
End date of the routing run.
Result or outcome of the routing run.
Store the attempted order item count.
Store the brokered order item count.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Represents a group or category used for organizing and managing order routing configurations.
Unique identifier for the routing group
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Note that this corresponds with the organizationPartyId that GL transactions will be posted to.
If immediately fulfilled (for physical stores, etc): don't send email notices, don't reserve inventory, and IFF inventory info isn't found on the server then don't issue inventory right away
If set to Y, when a new sales order is created with backordered items, then reservations on the facility/product are reassigned according to the priority given by the shipBeforeDate field.
Specify the type (Billing Account or Financial Account) of Store Credit Account used for refund return. Default to Financial Account. This field is override by ReturnHeader.billingAccountId or ReturnHeader.finAccountId, whichever is specified but if only finAccountId is specified explicitly then system will first try to locate any billing account with -ve amount. If found, then amount is credit to this billing account else the amount will be credit to the financial account of the user.
Default Y. Invoice digital items when order is placed rather than waiting for completing order items (though shipment/fulfillment).
Default Y. Require Shipping Address for Digital Items? Note this only has an effect if there are ONLY digital goods in the cart.
default Y; if set to N do not show isExempt checkbox for PartyTaxAuthInfo, always force to N
The auto-suggestion list is a special ShoppingList that the addSuggestionsToShoppingList service will maintain for cross-sells of ordered items.
default Y; if set to Y an additional constraint will of isVariant!=Y will be added to all product searches for the store
For auto-orders try other Credit Card expiration dates (if date is wrong or general failure where type not known)?
For auto-orders try other Credit Cards for the customer?
For auto-orders if Credit Cards fails for NSF (Not Sufficient Funds) try again later?
For auto-orders if Credit Cards fails for NSF try again how many times?
How many days that store credit is valid for. Null value implies no expiration.
If Y or empty, sales invoices created from orders will be marked ready.
If N, orders will not be automatically approved when payment is authorized.
If N, the captureOrderPayments will cause a service error if credit card capture fails.
If Y or empty, set the inventory item owner upon issuance.
Default N. This is the default value for the ReturnHeader.needsInventoryReceive field. If set to Y return will automatically go to the Received status when Accepted instead of waiting for actual receipt of the return.
Default N. If Y then on add to cart remove all products in cart with a ProductAssoc record related to or from the product and with the PRODUCT_INCOMPATABLE type.
Default N. If Y then on add to cart remove all products in cart with a ProductAssoc record related from the product and with the PRODUCT_UPGRADE type.
Default N. If Y then before the order is stored the OrderPaymentPreference record will be split, one for each OrderItemShipGroup.
If Y, the preparator can choose the InventoryItem by this lotId when he makes the picklist.
Default Y. If N then out of stock products will not be displayed on site
use to indicate if decimal quantity can be ordered for this producStore. Default value is Y
Allow comments for order line items per store
Catalog Url mount point to be used
Restocking fee percentage
Flag to identify if order payments have to be captured when order is added to CSV with value Y or N
Order for products of store will be placed with defined term type.
Mainly used to control nearest facility work flow
Flag to identify if the external promotions are enabled for the store.
Indicates number of days till order can be returned
Indicates Fee charged for Restocking.
Flag to identify if the return will be accepted automatically.
Product identifier to identify unique product
Flag to enable/disable auto preorder releasing on particular store/brand.
Flag to enable/disable brokering on particular store/brand.
Image path for display brand specific logo
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
The UserSession entity represents the users session for specific type. This entity is designed to manage user sessions so that system know how may users have their sessions active and using what functionality.
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the user session.
Unique identifier for user.
Type of the session
Unique identifier for the product store
Start date of the user session.
End date of the user session.
Additional information for the user session.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
The UserSession entity represents the users session for specific type. This entity is designed to manage user sessions so that system know how may users have their sessions active and using what functionality.
userSessionsSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
The UserSession entity represents the users session for specific type. This entity is designed to manage user sessions so that system know how may users have their sessions active and using what functionality.
Unique identifier for the user session.
userSessionsSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Usage depends on enum type such as an ID format/mask
Indicator flag with meaning depending on enum type
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
In the absence of a product specific days to ship in ProductFacility, this will be used
This field store the unit of measurement of dimension (length, width and height)
This field stores facility ID of the external system
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
If set to true, an email notification will be sent on rejection, provided it is configured.
falseSuccess
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Represents configurations for routing orders, including rules and conditions for order fulfillment.
orderRoutingSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Represents configurations for routing orders, including rules and conditions for order fulfillment.
Unique identifier for the order routing.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Represents configurations for routing orders, including rules and conditions for order fulfillment.
Unique identifier for the order routing.
orderRoutingSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Represents a rule used in order routing, defining conditions, actions, and assignment logic for order fulfillment.
Unique identifier for the order routing.
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the routing rule.
Name of the routing rule.
Status of the routing rule.
Sequence number for ordering.
Type of assignment for the routing rule (single/multi).
Date and time when the routing rule was created.
User login ID of the creator.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Defines conditions used in order routing rules to filter and route orders based on specified criteria.
Unique identifier for the order routing.
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the condition.
Type of condition (Filter/ Order by)
Input parameter for the condition.
Operator used in the condition.
Value of the condition.
Sequence number for ordering.
Date and time when the condition was created.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Defines conditions used in order routing rules to filter and route orders based on specified criteria.
Unique identifier for the order routing.
routingOrderFilterSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Defines conditions used in order routing rules to filter and route orders based on specified criteria.
Unique identifier for the order routing.
routingOrderFilter.PKAuthentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Represents the execution and results of order routing runs, including information about errors and outcomes.
Unique identifier for the order routing.
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the routing run.
Unique identifier for the order routing group.
Distinguishes between different routing runs initiated as part of batch processing.
Unique identifier for the product store.
User login ID of the creator.
Indicator for the presence of errors.
Start date of the routing run.
End date of the routing run.
Result or outcome of the routing run.
Store the attempted order item count.
Store the brokered order item count.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Parameter to check if the Order routing rule needs to be cloned.
trueOrder routing group sequence. By default, it will be added as the last one.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
This service will return the eligible orders sql for order routing
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Return the eligible order item count for the Order Routing
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Represents a rule used in order routing, defining conditions, actions, and assignment logic for order fulfillment.
orderRoutingRuleSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Represents a rule used in order routing, defining conditions, actions, and assignment logic for order fulfillment.
Unique identifier for the routing rule.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Represents a rule used in order routing, defining conditions, actions, and assignment logic for order fulfillment.
Unique identifier for the routing rule.
orderRoutingRuleSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Defines inventory-related conditions used in routing rules to determine order fulfillment based on inventory status.
Unique identifier for the routing rule.
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the routing rule inventory condition.
Type of condition (Filter/ Order by)
Input parameter for the condition.
Operator used in the condition.
Value of the condition.
Sequence number for ordering.
Date and time when the condition was created.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Defines inventory-related conditions used in routing rules to determine order fulfillment based on inventory status.
Unique identifier for the routing rule.
routingRuleInvConditionSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Defines inventory-related conditions used in routing rules to determine order fulfillment based on inventory status.
Unique identifier for the routing rule.
routingRuleInvCondition.PKAuthentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Specifies actions to be performed when a routing rule is triggered during order processing.
Unique identifier for the routing rule.
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the action.
Type of action to be performed.
Value or details of the action.
Date and time when the action was created.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Specifies actions to be performed when a routing rule is triggered during order processing.
Unique identifier for the routing rule.
routingRuleActionSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Specifies actions to be performed when a routing rule is triggered during order processing.
Unique identifier for the routing rule.
routingRuleAction.PKAuthentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Order routing group sequence. By default, it will be added as the last one.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
The Routing Rule ID SQL Query Service is designed to generate SQL queries that fetch inventory allocation based on specific routing rule IDs. This service helps in retrieving accurate inventory data by applying predefined routing rules.
Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Usage depends on enum type such as an ID format/mask
Indicator flag with meaning depending on enum type
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
The user that initiated the job run
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Runtime data for a scheduled ServiceJob (with a cronExpression), managed automatically by the service job runner.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
No content
No content
No content
GET /rest/s1/order-routing/checkOmsConnection HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "moqui.basic.EnumerationAndType",
"typeDescription": "text",
"enumId": "text",
"enumTypeId": "text",
"parentEnumId": "text",
"enumCode": "text",
"sequenceNum": 1,
"description": "text",
"optionValue": "text",
"optionIndicator": "text",
"relatedEnumId": "text",
"relatedEnumTypeId": "text",
"statusFlowId": "text",
"enumName": "text",
"primaryEnumerationGroupId": "text"
}
]GET /rest/s1/order-routing/enums HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/order-routing/enums/{enumId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "moqui.basic.EnumerationAndType",
"typeDescription": "text",
"enumId": "text",
"enumTypeId": "text",
"parentEnumId": "text",
"enumCode": "text",
"sequenceNum": 1,
"description": "text",
"optionValue": "text",
"optionIndicator": "text",
"relatedEnumId": "text",
"relatedEnumTypeId": "text",
"statusFlowId": "text",
"enumName": "text",
"primaryEnumerationGroupId": "text"
}{
"rejectedItemsList": [
{
"orderId": "text",
"orderItemSeqId": "text",
"shipGroupSeqId": "text",
"shipmentMethodTypeId": "text",
"quantity": "text"
}
]
}POST /rest/s1/order-routing/orders/{orderId}/reject HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 204
{
"orderId": "text",
"notify": "false",
"items": [
{
"facilityId": "text",
"shipmentMethodTypeId": "text",
"quantity": "1",
"orderItemSeqId": "text",
"toFacilityId": "text",
"recordVariance": "text",
"rejectReason": "text"
}
]
}GET /rest/s1/order-routing/orders/{orderId}/routing-history/recent HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"routingHistoryList": [
"text"
]
}[
{
"_entity": "co.hotwax.common.status.StatusItemAndType",
"typeDescription": "text",
"statusId": "text",
"statusTypeId": "text",
"statusCode": "text",
"sequenceNum": 1,
"description": "text",
"statusAge": 1,
"parentTypeId": "text"
}
]GET /rest/s1/order-routing/status HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "co.hotwax.common.enum.EnumerationAndType",
"typeDescription": "text",
"enumId": "text",
"enumTypeId": "text",
"parentEnumId": "text",
"enumCode": "text",
"sequenceNum": 1,
"description": "text",
"optionValue": "text",
"optionIndicator": "text",
"relatedEnumId": "text",
"relatedEnumTypeId": "text",
"statusFlowId": "text",
"enumName": "text",
"primaryEnumerationGroupId": "text",
"parentTypeId": "text"
}
]GET /rest/s1/order-routing/omsenums HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/order-routing/omsenums/{enumId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "co.hotwax.common.enum.EnumerationAndType",
"typeDescription": "text",
"enumId": "text",
"enumTypeId": "text",
"parentEnumId": "text",
"enumCode": "text",
"sequenceNum": 1,
"description": "text",
"optionValue": "text",
"optionIndicator": "text",
"relatedEnumId": "text",
"relatedEnumTypeId": "text",
"statusFlowId": "text",
"enumName": "text",
"primaryEnumerationGroupId": "text",
"parentTypeId": "text"
}[
{
"_entity": "moqui.service.job.ServiceJobRun",
"jobRunId": "text",
"jobName": "text",
"userId": "text",
"parameters": "text",
"results": "text",
"messages": "text",
"hasError": "text",
"errors": "text",
"hostAddress": "text",
"hostName": "text",
"runThread": "text",
"startTime": "2025-12-09T15:21:30.070Z",
"endTime": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]GET /rest/s1/order-routing/serviceJobRuns/{jobName} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/order-routing/serviceJobRuns/{jobName}/{jobRunId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "moqui.service.job.ServiceJobRun",
"jobRunId": "text",
"jobName": "text",
"userId": "text",
"parameters": "text",
"results": "text",
"messages": "text",
"hasError": "text",
"errors": "text",
"hostAddress": "text",
"hostName": "text",
"runThread": "text",
"startTime": "2025-12-09T15:21:30.070Z",
"endTime": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/order-routing/serviceJobRuns/{jobName}/activeJobRun HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "moqui.service.job.ServiceJobRunLock",
"jobName": "text",
"jobRunId": "text",
"lastRunTime": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}[
{
"_entity": "orderRoutingGroup",
"routingGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUserId": "text",
"createdByUser": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]{
"_entity": "orderRoutingGroup.PK",
"routingGroupId": "text"
}{
"_entity": "orderRoutingGroup.PK",
"routingGroupId": "text"
}{
"jobRunId": "text"
}{
"attemptedItemCount": 1,
"brokeredItemCount": 1
}{
"jobName": "text"
}{
"newRoutingGroupId": "text"
}[
{
"_entity": "orderRouting",
"orderRoutingId": "text",
"routingGroupId": "text",
"statusId": "text",
"routingName": "text",
"sequenceNum": 1,
"description": "text",
"createdByUser": "text",
"createdByUserId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
][
{
"_entity": "routingRuns",
"routingRunId": "text",
"orderRoutingId": "text",
"routingGroupId": "text",
"routingBatchId": "text",
"productStoreId": "text",
"createdByUser": "text",
"createdByUserId": "text",
"hasError": "text",
"startDate": "2025-12-09T15:21:30.070Z",
"endDate": "2025-12-09T15:21:30.070Z",
"routingResult": "text",
"orderItemCount": 1,
"brokeredItemCount": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]POST /rest/s1/order-routing/groups HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 333
{
"_entity": "orderRoutingGroup",
"routingGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUserId": "text",
"createdByUser": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/order-routing/groups/{routingGroupId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "orderRoutingGroup",
"routingGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUserId": "text",
"createdByUser": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"routings": [
{
"_entity": "orderRouting",
"orderRoutingId": "text",
"routingGroupId": "text",
"statusId": "text",
"routingName": "text",
"sequenceNum": 1,
"description": "text",
"createdByUser": "text",
"createdByUserId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}POST /rest/s1/order-routing/groups/{routingGroupId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 632
{
"_entity": "orderRoutingGroup",
"routingGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUserId": "text",
"createdByUser": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"routings": [
{
"_entity": "orderRouting",
"orderRoutingId": "text",
"routingGroupId": "text",
"statusId": "text",
"routingName": "text",
"sequenceNum": 1,
"description": "text",
"createdByUser": "text",
"createdByUserId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}DELETE /rest/s1/order-routing/groups/{routingGroupId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/order-routing/groups/{routingGroupId}/runNow HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/order-routing/groups/{routingGroupId}/run HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 193
{
"routingGroupId": "text",
"orderRoutingId": "text",
"routingRuleId": "text",
"productStoreId": "text",
"orderId": "text",
"shipGroupSeqId": "text",
"changeReasonEnumId": "text",
"testDriveSessionId": "text"
}GET /rest/s1/order-routing/groups/{routingGroupId}/schedule HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"schedule": {
"jobName": "text",
"description": "text",
"serviceName": "text",
"transactionTimeout": 1,
"topic": "text",
"localOnly": "text",
"cronExpression": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"repeatCount": 1,
"paused": "text",
"expireLockTime": 1,
"minRetryTime": 1,
"priority": 1,
"parentJobName": "text",
"jobTypeEnumId": "text",
"permissionGroupId": "text",
"instanceOfProductId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}POST /rest/s1/order-routing/groups/{routingGroupId}/schedule HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 411
{
"routingGroupId": "text",
"transactionTimeout": 1,
"topic": "text",
"localOnly": "text",
"cronExpression": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"repeatCount": 1,
"paused": "text",
"expireLockTime": 1,
"minRetryTime": 1,
"priority": 1,
"parentJobName": "text",
"jobTypeEnumId": "text",
"permissionGroupId": "text",
"instanceOfProductId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}POST /rest/s1/order-routing/groups/{routingGroupId}/clone HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 126
{
"routingGroupId": "text",
"newGroupName": "text",
"sequenceNum": "text",
"copyOrderRoutings": "true",
"copyOrderRoutingRules": "true"
}GET /rest/s1/order-routing/groups/{routingGroupId}/raw HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "orderRoutingGroup",
"routingGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUserId": "text",
"createdByUser": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastModifiedDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"routings": [
{
"_entity": "orderRouting",
"orderRoutingId": "text",
"routingGroupId": "text",
"statusId": "text",
"routingName": "text",
"sequenceNum": 1,
"description": "text",
"createdByUser": "text",
"createdByUserId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
],
"schedule": {
"_entity": "moqui.service.job.ServiceJob",
"jobName": "text",
"description": "text",
"serviceName": "text",
"transactionTimeout": 1,
"topic": "text",
"localOnly": "text",
"cronExpression": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"repeatCount": 1,
"paused": "text",
"expireLockTime": 1,
"minRetryTime": 1,
"priority": 1,
"parentJobName": "text",
"jobTypeEnumId": "text",
"permissionGroupId": "text",
"instanceOfProductId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}GET /rest/s1/order-routing/groups HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/order-routing/groups/{routingGroupId}/routings HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/order-routing/groups/{routingGroupId}/routingRuns HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "org.apache.ofbiz.product.store.ProductStore",
"productStoreId": "text",
"primaryStoreGroupId": "text",
"storeName": "text",
"companyName": "text",
"title": "text",
"subtitle": "text",
"payToPartyId": "text",
"daysToCancelNonPay": 1,
"manualAuthIsCapture": "text",
"prorateShipping": "text",
"prorateTaxes": "text",
"viewCartOnAdd": "text",
"autoSaveCart": "text",
"autoApproveReviews": "text",
"isDemoStore": "text",
"isImmediatelyFulfilled": "text",
"inventoryFacilityId": "text",
"oneInventoryFacility": "text",
"checkInventory": "text",
"reserveInventory": "text",
"reserveOrderEnumId": "text",
"requireInventory": "text",
"balanceResOnOrderCreation": "text",
"requirementMethodEnumId": "text",
"orderNumberPrefix": "text",
"defaultLocaleString": "text",
"defaultCurrencyUomId": "text",
"defaultTimeZoneString": "text",
"defaultSalesChannelEnumId": "text",
"allowPassword": "text",
"defaultPassword": "text",
"explodeOrderItems": "text",
"checkGcBalance": "text",
"retryFailedAuths": "text",
"headerApprovedStatus": "text",
"itemApprovedStatus": "text",
"digitalItemApprovedStatus": "text",
"headerDeclinedStatus": "text",
"itemDeclinedStatus": "text",
"headerCancelStatus": "text",
"itemCancelStatus": "text",
"authDeclinedMessage": "text",
"authFraudMessage": "text",
"authErrorMessage": "text",
"visualThemeId": "text",
"storeCreditAccountEnumId": "text",
"usePrimaryEmailUsername": "text",
"requireCustomerRole": "text",
"autoInvoiceDigitalItems": "text",
"reqShipAddrForDigItems": "text",
"showCheckoutGiftOptions": "text",
"selectPaymentTypePerItem": "text",
"showPricesWithVatTax": "text",
"showTaxIsExempt": "text",
"vatTaxAuthGeoId": "text",
"vatTaxAuthPartyId": "text",
"enableAutoSuggestionList": "text",
"enableDigProdUpload": "text",
"prodSearchExcludeVariants": "text",
"digProdUploadCategoryId": "text",
"autoOrderCcTryExp": "text",
"autoOrderCcTryOtherCards": "text",
"autoOrderCcTryLaterNsf": "text",
"autoOrderCcTryLaterMax": 1,
"storeCreditValidDays": 1,
"autoApproveInvoice": "text",
"autoApproveOrder": "text",
"shipIfCaptureFails": "text",
"setOwnerUponIssuance": "text",
"reqReturnInventoryReceive": "text",
"addToCartRemoveIncompat": "text",
"addToCartReplaceUpsell": "text",
"splitPayPrefPerShpGrp": "text",
"managedByLot": "text",
"showOutOfStockProducts": "text",
"orderDecimalQuantity": "text",
"allowComment": "text",
"oldStyleSheet": "text",
"oldHeaderLogo": "text",
"oldHeaderMiddleBackground": "text",
"oldHeaderRightBackground": "text",
"catalogUrlMountPoint": "text",
"restockingFeePercentage": 1,
"capturePmntsOnOrdApproval": "text",
"termTypeId": "text",
"autoSetFacility": "text",
"enableExternalPromotion": "text",
"daysToReturn": 1,
"restockingFeeFixed": 1,
"autoAcceptReturn": "text",
"externalId": "text",
"allowSplit": "text",
"storeDomain": "text",
"productIdentifierEnumId": "text",
"enablePreOrderAutoReleasing": "text",
"enableBrokering": "text",
"storeLogoImageUrl": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
][
{
"_entity": "userSessions",
"userSessionId": "text",
"userId": "text",
"sessionTypeEnumId": "text",
"productStoreId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"comments": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]{
"_entity": "userSessions.PK",
"userSessionId": "text"
}{
"_entity": "userSessions.PK",
"userSessionId": "text"
}GET /rest/s1/order-routing/user/profile HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"userId": "text",
"username": "text",
"userFullName": "text",
"timeZone": "text",
"locale": "text",
"emailAddress": "text",
"preferences": {
"userId": "text",
"preferenceKey": "text",
"preferenceValue": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
},
"partyId": "text"
}GET /rest/s1/order-routing/user/getAvailableTimeZones HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"timeZones": [
{
"id": "text",
"label": "text",
"offset": "text"
}
]
}POST /rest/s1/order-routing/user/sessions HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 256
{
"_entity": "userSessions",
"userSessionId": "text",
"userId": "text",
"sessionTypeEnumId": "text",
"productStoreId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"comments": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}PUT /rest/s1/order-routing/user/sessions/{userSessionId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 256
{
"_entity": "userSessions",
"userSessionId": "text",
"userId": "text",
"sessionTypeEnumId": "text",
"productStoreId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"comments": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/order-routing/user/productStore HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/order-routing/user/sessions HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "co.hotwax.facility.FacilityAndType",
"typeDescription": "text",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-12-09T15:21:30.070Z",
"closedDate": "2025-12-09T15:21:30.070Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"parentTypeId": "text",
"hasTable": "text"
}
]GET /rest/s1/order-routing/facilities/{facilityId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "co.hotwax.facility.FacilityAndType",
"typeDescription": "text",
"facilityId": "text",
"facilityTypeId": "text",
"parentFacilityId": "text",
"ownerPartyId": "text",
"defaultInventoryItemTypeId": "text",
"facilityName": "text",
"primaryFacilityGroupId": "text",
"oldSquareFootage": 1,
"facilitySize": 1,
"facilitySizeUomId": "text",
"productStoreId": "text",
"defaultDaysToShip": 1,
"openedDate": "2025-12-09T15:21:30.070Z",
"closedDate": "2025-12-09T15:21:30.070Z",
"description": "text",
"defaultDimensionUomId": "text",
"defaultWeightUomId": "text",
"geoPointId": "text",
"externalId": "text",
"openTime": "text",
"closeTime": "text",
"facilityTimeZone": "text",
"maximumOrderLimit": 1,
"postalCode": "text",
"parentTypeId": "text",
"hasTable": "text"
}GET /rest/s1/order-routing/facilities HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "orderRouting.PK",
"orderRoutingId": "text"
}{
"_entity": "orderRouting.PK",
"orderRoutingId": "text"
}[
{
"_entity": "orderRoutingRule",
"routingRuleId": "text",
"orderRoutingId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"assignmentEnumId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUser": "text",
"createdByUserId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
][
{
"_entity": "routingOrderFilter",
"orderRoutingId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]{
"_entity": "routingOrderFilter.PK",
"orderRoutingId": "text",
"conditionSeqId": "text"
}[
{
"_entity": "routingRuns",
"routingRunId": "text",
"orderRoutingId": "text",
"routingGroupId": "text",
"routingBatchId": "text",
"productStoreId": "text",
"createdByUser": "text",
"createdByUserId": "text",
"hasError": "text",
"startDate": "2025-12-09T15:21:30.070Z",
"endDate": "2025-12-09T15:21:30.070Z",
"routingResult": "text",
"orderItemCount": 1,
"brokeredItemCount": 1,
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]{
"newOrderRoutingId": "text"
}POST /rest/s1/order-routing/routings HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 285
{
"_entity": "orderRouting",
"orderRoutingId": "text",
"routingGroupId": "text",
"statusId": "text",
"routingName": "text",
"sequenceNum": 1,
"description": "text",
"createdByUser": "text",
"createdByUserId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/order-routing/routings/{orderRoutingId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "orderRouting",
"orderRoutingId": "text",
"routingGroupId": "text",
"statusId": "text",
"routingName": "text",
"sequenceNum": 1,
"description": "text",
"createdByUser": "text",
"createdByUserId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"orderFilters": [
{
"_entity": "routingOrderFilter",
"orderRoutingId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
],
"rules": [
{
"_entity": "orderRoutingRule",
"routingRuleId": "text",
"orderRoutingId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"assignmentEnumId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUser": "text",
"createdByUserId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}POST /rest/s1/order-routing/routings/{orderRoutingId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 873
{
"_entity": "orderRouting",
"orderRoutingId": "text",
"routingGroupId": "text",
"statusId": "text",
"routingName": "text",
"sequenceNum": 1,
"description": "text",
"createdByUser": "text",
"createdByUserId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"orderFilters": [
{
"_entity": "routingOrderFilter",
"orderRoutingId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
],
"rules": [
{
"_entity": "orderRoutingRule",
"routingRuleId": "text",
"orderRoutingId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"assignmentEnumId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUser": "text",
"createdByUserId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]
}POST /rest/s1/order-routing/routings/{orderRoutingId}/orderFilters HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 269
{
"_entity": "routingOrderFilter",
"orderRoutingId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}DELETE /rest/s1/order-routing/routings/{orderRoutingId}/orderFilters HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"_entity": "routingOrderFilter.PK",
"orderRoutingId": "text",
"conditionSeqId": "text"
}POST /rest/s1/order-routing/routings/{orderRoutingId}/clone HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 128
{
"orderRoutingId": "text",
"newRoutingGroupId": "text",
"copyOrderRoutingRules": "true",
"newRoutingName": "text",
"sequenceNum": "text"
}GET /rest/s1/order-routing/routings/{orderRoutingId}/sql HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"statusId": "text",
"sql": "text"
}GET /rest/s1/order-routing/routings/{orderRoutingId}/orderCount HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"orderItemCount": 1
}GET /rest/s1/order-routing/routings/{orderRoutingId}/rules HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/order-routing/routings/{orderRoutingId}/orderFilters HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/order-routing/routings/{orderRoutingId}/routingRuns HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "orderRoutingRule.PK",
"routingRuleId": "text"
}{
"_entity": "orderRoutingRule.PK",
"routingRuleId": "text"
}[
{
"_entity": "routingRuleInvCondition",
"routingRuleId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]{
"_entity": "routingRuleInvCondition.PK",
"routingRuleId": "text",
"conditionSeqId": "text"
}[
{
"_entity": "routingRuleAction",
"routingRuleId": "text",
"actionSeqId": "text",
"actionTypeEnumId": "text",
"actionValue": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
]{
"_entity": "routingRuleAction.PK",
"routingRuleId": "text",
"actionSeqId": "text"
}{
"newRoutingRuleId": "text"
}POST /rest/s1/order-routing/rules HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 290
{
"_entity": "orderRoutingRule",
"routingRuleId": "text",
"orderRoutingId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"assignmentEnumId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUser": "text",
"createdByUserId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}GET /rest/s1/order-routing/rules/{routingRuleId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "orderRoutingRule",
"routingRuleId": "text",
"orderRoutingId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"assignmentEnumId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUser": "text",
"createdByUserId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"inventoryFilters": [
{
"_entity": "routingRuleInvCondition",
"routingRuleId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
],
"actions": [
{
"_entity": "routingRuleAction",
"routingRuleId": "text",
"actionSeqId": "text",
"actionTypeEnumId": "text",
"actionValue": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
],
"assignment": {
"_entity": "enums",
"enumId": "text",
"enumTypeId": "text",
"parentEnumId": "text",
"enumCode": "text",
"sequenceNum": 1,
"description": "text",
"optionValue": "text",
"optionIndicator": "text",
"relatedEnumId": "text",
"relatedEnumTypeId": "text",
"statusFlowId": "text",
"enumName": "text",
"primaryEnumerationGroupId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}POST /rest/s1/order-routing/rules/{routingRuleId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 1170
{
"_entity": "orderRoutingRule",
"routingRuleId": "text",
"orderRoutingId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"assignmentEnumId": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"createdByUser": "text",
"createdByUserId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z",
"inventoryFilters": [
{
"_entity": "routingRuleInvCondition",
"routingRuleId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
],
"actions": [
{
"_entity": "routingRuleAction",
"routingRuleId": "text",
"actionSeqId": "text",
"actionTypeEnumId": "text",
"actionValue": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
],
"assignment": {
"_entity": "enums",
"enumId": "text",
"enumTypeId": "text",
"parentEnumId": "text",
"enumCode": "text",
"sequenceNum": 1,
"description": "text",
"optionValue": "text",
"optionIndicator": "text",
"relatedEnumId": "text",
"relatedEnumTypeId": "text",
"statusFlowId": "text",
"enumName": "text",
"primaryEnumerationGroupId": "text",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}
}POST /rest/s1/order-routing/rules/{routingRuleId}/inventoryFilters HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 273
{
"_entity": "routingRuleInvCondition",
"routingRuleId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}DELETE /rest/s1/order-routing/rules/{routingRuleId}/inventoryFilters HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"_entity": "routingRuleInvCondition.PK",
"routingRuleId": "text",
"conditionSeqId": "text"
}GET /rest/s1/order-routing/rules/{routingRuleId}/actions HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/order-routing/rules/{routingRuleId}/actions HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 209
{
"_entity": "routingRuleAction",
"routingRuleId": "text",
"actionSeqId": "text",
"actionTypeEnumId": "text",
"actionValue": "text",
"createdDate": "2025-12-09T15:21:30.070Z",
"lastUpdatedStamp": "2025-12-09T15:21:30.070Z"
}DELETE /rest/s1/order-routing/rules/{routingRuleId}/actions HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 78
{
"_entity": "routingRuleAction.PK",
"routingRuleId": "text",
"actionSeqId": "text"
}POST /rest/s1/order-routing/rules/{routingRuleId}/clone HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 93
{
"routingRuleId": "text",
"newOrderRoutingId": "text",
"newRuleName": "text",
"sequenceNum": "text"
}GET /rest/s1/order-routing/rules/{routingRuleId}/sql HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"statusId": "text",
"sql": "text"
}GET /rest/s1/order-routing/rules/{routingRuleId}/inventoryFilters HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
POST /rest/s1/order-routing/login HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 52
{
"username": "text",
"password": "text",
"token": "text"
}{
"token": "text",
"expirationTime": "text",
"api_key": "text"
}[
{
"_entity": "co.hotwax.product.store.ProductStoreShipmentMethView",
"productStoreShipMethId": "text",
"productStoreId": "text",
"shipmentMethodTypeId": "text",
"partyId": "text",
"roleTypeId": "text",
"companyPartyId": "text",
"minWeight": 1,
"maxWeight": 1,
"minSize": 1,
"maxSize": 1,
"minTotal": 1,
"maxTotal": 1,
"allowUspsAddr": "text",
"requireUspsAddr": "text",
"allowCompanyAddr": "text",
"requireCompanyAddr": "text",
"includeNoChargeItems": "text",
"includeFeatureGroup": "text",
"excludeFeatureGroup": "text",
"includeGeoId": "text",
"excludeGeoId": "text",
"serviceName": "text",
"configProps": "text",
"shipmentCustomMethodId": "text",
"shipmentGatewayConfigId": "text",
"sequenceNumber": 1,
"allowancePercent": 1,
"minimumPrice": 1,
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"isShippingWeightRequired": "text",
"isTrackingRequired": "text",
"description": "text",
"parentTypeId": "text"
}
][
{
"_entity": "co.hotwax.facility.ProductStoreAndFacilityGroup",
"productStoreId": "text",
"facilityGroupId": "text",
"fromDate": "2025-12-09T15:21:30.070Z",
"thruDate": "2025-12-09T15:21:30.070Z",
"sequenceNumber": 1,
"facilityGroupTypeId": "text",
"primaryParentGroupId": "text",
"facilityGroupName": "text",
"description": "text"
}
]GET /rest/s1/order-routing/productStores/{productStoreId}/facilityGroups HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
GET /rest/s1/order-routing/productStores/{productStoreId}/shippingMethods HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
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
Order Details Table
fields
List of fields returned in response document
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
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
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)
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
{
"json": {
"params": {
"q":"*:*",
"wt":"json",
"rows":"1"
},
"filter":["docType:ORDER","orderTypeId : SALES_ORDER"],
"sort":"orderDate desc",
"fields":"orderId,orderName,orderItemSeqId,orderItemTypeId,productId,parentProductName,productName,productTypeId,internalName,productTypeDesc,isPromo,supplierProductId,quantity,unitPrice,unitListPrice,orderItemStatusId,orderItemStatusDesc,orderItemSubTotal,orderItemAssocTypeId,supplierPartyIds,salesRepName,salesChannelEnumId,salesChannelDesc,orderTypeId,productStoreId,productStoreName,orderStatusId,orderStatusDesc,statusSeqId,orderRoles,customerPartyId,customerEmailId,customerPartyName,shipToCountry,shipToState,shipToCity,shippingMethod,supplierPartyId,supplierPartyName,orderDate,orderNotes,orderDateString,estimatedDeliveryDate,autoCancelDate,correspondingPoId,title,facilityId,facilityName,orderGrandTotal,orderSize,lastInventoryCount,categoryHierarchy,workEffortId,workEffortTypeId,currentStatus,workEffortPurposeTypeId,workEffortParentId,priority,workEffortName,description,estimatedStartDate,estimatedCompletionDate,actualStartDate,actualCompletionDate,backOrderedQuantity,orderToReleaseTime,releaseToPickTime,pickToShipTime,partyClassificationGroupIds,currencyUomId,placingPartyName,placingPartyId,primaryProductCategoryNameFacet,priceType,promoCodeIds,orderIdentifications,promisedDatetime,shipmentMethodTypeId"
}
}{
"responseHeader": {
"zkConnected": true,
"status": 0,
"QTime": 0,
"params": {
"json": "{\"filter\":[\"docType:ORDER\",\"orderTypeId : SALES_ORDER\"],\"sort\":\"orderDate desc\",\"params\":{\"q\":\"*:*\",\"wt\":\"json\",\"rows\":\"1\"},\"fields\":\"orderId,orderName,orderItemSeqId,orderItemTypeId,productId,parentProductName,productName,productTypeId,internalName,productTypeDesc,isPromo,supplierProductId,quantity,unitPrice,unitListPrice,orderItemStatusId,orderItemStatusDesc,orderItemSubTotal,orderItemAssocTypeId,supplierPartyIds,salesRepName,salesChannelEnumId,salesChannelDesc,orderTypeId,productStoreId,productStoreName,orderStatusId,orderStatusDesc,statusSeqId,orderRoles,customerPartyId,customerEmailId,customerPartyName,shipToCountry,shipToState,shipToCity,shippingMethod,supplierPartyId,supplierPartyName,orderDate,orderNotes,orderDateString,estimatedDeliveryDate,autoCancelDate,correspondingPoId,title,facilityId,facilityName,orderGrandTotal,orderSize,lastInventoryCount,categoryHierarchy,workEffortId,workEffortTypeId,currentStatus,workEffortPurposeTypeId,workEffortParentId,priority,workEffortName,description,estimatedStartDate,estimatedCompletionDate,actualStartDate,actualCompletionDate,backOrderedQuantity,orderToReleaseTime,releaseToPickTime,pickToShipTime,partyClassificationGroupIds,currencyUomId,placingPartyName,placingPartyId,primaryProductCategoryNameFacet,priceType,promoCodeIds,orderIdentifications,promisedDatetime,shipmentMethodTypeId\"}",
"_forwardedCount": "1"
}
},
"response": {
"numFound": 4189,
"start": 0,
"numFoundExact": true,
"docs": [
{
"orderId": "10280",
"orderItemSeqId": "00101",
"productId": "10071",
"parentProductName": "Ajax Full-Zip Sweatshirt",
"internalName": "MH12-XS-Blue",
"productName": "XS / Blue",
"orderItemStatusId": "ITEM_APPROVED",
"orderItemStatusDesc": "Approved",
"quantity": 1.0,
"orderName": "HCDEV#2511",
"orderTypeId": "SALES_ORDER",
"productStoreId": "STORE",
"productStoreName": "Dev Store",
"shippingMethod": [
"Default Standard"
],
"shipmentMethodTypeId": "STANDARD",
"facilityId": "GARDEN_CITY",
"facilityName": "Garden City",
"orderStatusId": "ORDER_APPROVED",
"orderStatusDesc": "Approved",
"orderDate": "2024-06-20T14:42:33Z",
"orderNotes": [
"HC_PRE_SELECTED_FAC"
],
"customerEmailId": "[email protected]",
"customerPartyId": "10021",
"customerPartyName": "Rohan Sharma",
"salesChannelEnumId": "WEB_SALES_CHANNEL",
"salesChannelDesc": "Web Channel",
"placingPartyName": "Rohan Sharma",
"orderIdentifications": [
"SHOPIFY_ORD_ID/6178678210724",
"SHOPIFY_ORD_NAME/HCDEV#2511",
"SHOPIFY_ORD_NO/2511"
]
}
]
}
}Discover the Brokered Order Items feed, a JSON-formatted feed generated from HotWax Commerce OMS for streamlined order management.
The Brokered Order Items feed is an order-wise JSON-formatted feed generated from HotWax Commerce OMS. This feed contains details about brokered order items, which can be brokered to either Warehouse or Store Type facilities. The feed can be used for integration with other external systems.
The Brokered Order Items feed is useful for retailers who would like to do fulfillment outside OMS through an external system such as a Warehouse Management System (WMS). This feed provides the out-of-the-box data available from OMS, and retailers can use it as is or after transformation to ingest into external systems through file-based integration.
The Brokered Order Items feed has certain out-of-the-box customizations that allow users to generate the feed as per the requirements.
The following attributes have been prepared in the feed:
This object contains the following attributes, each of which has internal nesting:
billTo
billTo.phone
orderIdentifications
customerPartyIdentifications
payments
orderAdjustments
orderAttributes
orderItems
orderItems.shipTo
orderItems.phone.shipTo
orderItem.goodIdentification
orderItems.orderItemAdjustments:
orderItemAttributes
facilityGroupMembers
fromOrderItemAssocs:
toOrderItemAssocs:
productFeatures:
orderStatusId
Order status
ORDER_APPROVED
entryDate
The date and time the order was imported in HotWax Commerce OMS
2024-02-23T03:50:12+09:00
orderExternalId
The external ID of the order
5384320450749
currency
The payment currency used for the order
JPY
grandTotal
The total sum of all costs associated with an order
1870
customerFirstName
The first name of the customer
jhon
customerLastName
The last name of the customer
deo
salesChannel
The sales channel
WEB_CHANNEL
customerPartyId
The customer party ID
10290
isShippingChargesSent
Indicates if shipping charges are sent
Y
billTo
The billing information
See below
orderIdentifications
The order identifications
See below
customerPartyIdentifications
The customer party identifications
See below
payments
The payments
See below
orderAdjustments
The order adjustments
See below
orderAttributes
The order attributes
See below
orderItems
The order items
See below
orderAdjustments
The order adjustments
See below
orderAttributes
The order attributes
See below
orderItems
The order items
See below
address1
The first line of the address
足立
address2
The second line of the address
null
city
The city
足立区
postalCode
The postal code
120-0015
countryGeoId
The country geo ID
JPN
stateProvinceGeoId
The state province geo ID
null
isResidentialAddress
Indicates if the address is residential
Y
phone
The phone information
See below
orderId
The order ID
12082
statusId
The status ID
PAYMENT_AUTHORIZED
returnId
The return ID
null
createdDate
The date and time of creation
2024-02-23T03:50:12+09:00
orderStatusId
The status of the order
ORDER_APPROVED
entryDate
The date and time the order was entered
2024-02-23T03:50:12+09:00
orderExternalId
The external ID of the order
5384320450749
currency
The currency used for the order
JPY
grandTotal
The total amount of the order
1870
orderItemSeqId
The sequence ID of the order item
00101
itemStatusId
The status of the item
ITEM_APPROVED
orderItemQuantity
The quantity of the order item
1
reservedItemQuantity
The quantity of reserved items
1
unitPrice
The unit price of the item
1200
orderItemExternalId
The external ID of the order item
12915436126397
itemDescription
The description of the item
ソックス クルー 3ペア ホワイト
shipGroupSeqId
The sequence ID of the ship group
00001
shipmentMethodTypeId
The shipment method type ID
STANDARD
postalContactMechId
The postal contact mechanism ID
18224
telecomContactMechId
The telecom contact mechanism ID
18225
carrierPartyId
The carrier party ID
NA
externalFulfillmentOrderItemId
The external fulfillment order item ID
null
fulfillmentStatus
The fulfillment status
null
customerFirstName
The first name of the customer
jhon
customerLastName
The last name of the customer
deo
facilityId
The facility ID
WH0615
facilityExternalId
The external ID of the facility
22
facilityTypeId
This attribute contains the facility Type Id.
WAREHOUSE
parentFacilityTypeId
This attribute contains ID of the parent facility for facilityId.
DISTRIBUTION_CENTER
statusDatetime
The date and time of the status
2024-02-23T04:05:15+09:00
productId
The product's unique identifier in HotWax Commerce
60757
productTypeId
The type of product identification
FINISHED_GOOD
internalName
String
-
salesChannel
The sales channel
WEB_CHANNEL
customerPartyId
The customer's unique identification in HotWax Commerce
10290
shipTo
The shipping information
See below
goodIdentifications
The product/good identifications
See below
orderItemAdjustments
The order item adjustments
See below
orderItemAttributes
The order item attributes
See below
facilityGroupMembers
The facility group members
See below
fromOrderItemAssocs
The from order item associations
See below
toOrderItemAssocs
The to order item associations
See below
productFeatures
The product features
See below
address1
The first line of the address
足立
address2
The second line of the address
null
city
The city
足立区
postalCode
The postal code
120-0015
countryGeoId
The country geo ID
JPN
stateProvinceGeoId
The state province geo ID
null
countyGeoId
The county geo ID
null
isResidentialAddress
Indicates if the address is residential
Y
phone
The phone information
See below
thruDate
The identification expiration date
null
orderItemSeqId
the Order item sequence id.
00001
sequenceNum
The sequence number for the member.
1
shipGroupSeqId
The ship group seq ID of the kit product.
00002
toShipGroupSeqId
The ship group seq ID of the component product.
00003
orderItemAssocTypeId
The order item assoc type ID.
KIT_COMPONENT
shipGroupSeqId
The ship group seq ID of the kit product.
00002
toShipGroupSeqId
The ship group seq ID of the component product.
00003
orderItemAssocTypeId
The order item assoc type ID like.
KIT_COMPONENT
productId
the Product ID.
10000
productFeaturTypeId
the feature type like
COLOR
Parameter
Description
orderId
Allows to generate the feed for a specific order ID.
orderItemSeqId
Allows to generate the feed for a specific order item sequence ID within an order.
parentFacilityTypeIds
Specifies the type of facility from which the brokered order items are being fetched.
productStoreIds
Allows you to set the product store IDs to generate brand-specific feeds.
systemMessageTypeId
The SFTP path where the feed will be stored.
systemMessageRemoteId
The SFTP credentials required to access the SFTP location.
productStoreId
The ID of the product store
STORE
orderId
The HotWax Commerce unique identifier for the order
12082
orderName
The eCommerce order identifier
9000004032
orderDate
The date and time the order was placed on eCommerce
billTo
The billing information
See below
orderIdentifications
The order identifications
See below
customerPartyIdentifications
The customer party identifications
See below
payments
The payments
countryGeoCode
The country geo code
JP
stateProvinceGeoCode
The state province geo code
null
contactMechId
The contact mechanism ID
18227
toName
The name of the recipient
contactMechId
The contact mechanism ID
18228
countryCode
The country code
1
areaCode
The area code
null
contactNumber
The contact number
idValue
The ID value
5384320450749
orderId
The order ID
12082
fromDate
The from date
2024-02-23T03:50:12+09:00
thruDate
The thru date
partyIdentificationTypeId
The party identification type ID
SHOPIFY_CUST_ID
idValue
The ID value
7053008306365
partyId
The party ID
10290
paymentMethodCode
The payment method code
null
amount
The amount
1870
paymentMethodTypeId
The payment method type ID
EXT_SHOP_OTHR_GTWAY
paymentMethodDescription
The payment method description
orderAdjustmentTypeId
The order adjustment type ID
SHIPPING_SALES_TAX
amount
The amount
50
orderAdjustmentId
The order adjustment ID
null
orderId
The order ID
orderId
The order ID
12082
attrDescription
The attribute description
null
attrName
The attribute name
COD_FEE_ADJ_CREATED
attrValue
The attribute value
productStoreId
The ID of the product store
STORE
orderId
The unique identifier for the order
12082
orderName
The name of the order
9000004032
orderDate
The date and time the order was placed
countryGeoCode
The country geo code
JP
stateProvinceGeoCode
The state province geo code
null
contactMechId
The contact mechanism ID
18224
toName
The name of the recipient
contactMechId
The contact mechanism ID
18228
countryCode
The country code
1
areaCode
The area code
null
contactNumber
The contact number
idValue
The good identifications ID value
37639003275453
fromDate
The identification creation date
2023-12-25T03:48:21+09:00
productId
The HotWax Commerce's product ID
60757
goodIdentificationTypeId
The type of good identification
amount
The amount of order adjustment
120
orderAdjustmentTypeId
The order adjustment type ID
SALES_TAX
orderId
The order ID
12082
orderItemSeqId
The Order Item Seq ID.
orderId
The order ID
12082
attrDescription
The attribute description
null
attrName
The attribute name
COD_FEE_ADJ_CREATED
attrValue
The attribute value
facilityId
The facility ID
WH0615
facilityGroupId
The facility group ID
22
thruDate
The thru date
null
fromDate
The from date
orderId
The order ID of kit product
12082
orderItemSeqId
The order items seq ID of the kit product.
00101
toOrderId
The order ID of the component product.
null
toOrderItemSeqId
The order items seq ID of the component product.
orderId
The order ID of kit product
12082
orderItemSeqId
The order items seq ID of the kit product.
00101
toOrderId
The order ID of the component product.
null
toOrderItemSeqId
The order items seq ID of the component product.
productFeatureApplTypeId
the feature Appl type like
STANDARD_FEATURE
productFeatureId
the unique feature ID.
10000
productFeatureCategoryId
the product feature category ID.
10015
description
the description of the feature.
[ {
"productStoreId" : "SG_STORE",
"orderId" : "SGSM10007",
"orderName" : "#1068",
"orderDate" : "2020-01-15T11:26:03-08:00",
"orderStatusId" : "ORDER_APPROVED",
"entryDate" : "2020-01-17T12:31:57-08:00",
"orderExternalId" : null,
"currency" : "USD",
"grandTotal" : 104,
"orderItemSeqId" : null,
"itemStatusId" : null,
"orderItemQuantity" : null,
"reservedItemQuantity" : null,
"reservedDatetime" : null,
"unitPrice" : null,
"orderItemExternalId" : null,
"itemDescription" : null,
"requestedDeliveryDate" : null,
"requestedDeliveryTime" : null,
"deliveryWindow" : null,
"shipGroupSeqId" : null,
"shipmentMethodTypeId" : null,
"postalContactMechId" : null,
"telecomContactMechId" : null,
"orderFacilityId" : null,
"carrierPartyId" : null,
"externalFulfillmentOrderItemId" : null,
"fulfillmentStatus" : null,
"customerFirstName" : "Demo",
"customerLastName" : "User",
"facilityId" : null,
"facilityExternalId" : null,
"facilityTypeId" : null,
"parentFacilityTypeId" : null,
"statusDatetime" : null,
"productId" : null,
"productTypeId" : null,
"internalName" : null,
"salesChannel" : "WEB_CHANNEL",
"customerPartyId" : "10004",
"isShippingChargesSent" : "Y",
"billTo" : {
"countryGeoCode" : "US",
"stateProvinceGeoCode" : "TN",
"contactMechId" : "10802",
"toName" : "demo user",
"attnName" : null,
"address1" : "11 U.S. 11",
"address2" : null,
"houseNumber" : null,
"houseNumberExt" : null,
"directions" : null,
"city" : "Knoxville",
"cityGeoId" : null,
"postalCode" : "37010",
"postalCodeExt" : null,
"countryGeoId" : "USA",
"stateProvinceGeoId" : "TN",
"countyGeoId" : null,
"municipalityGeoId" : null,
"postalCodeGeoId" : null,
"geoPointId" : null,
"encodedAddressKey" : null,
"latitude" : null,
"longitude" : null,
"isResidentialAddress" : "Y",
"phone" : null
},
"orderIdentifications" : [ {
"orderId" : "SGSM10007",
"idValue" : "2035556286557",
"fromDate" : "2020-01-17T12:31:58-08:00",
"lastUpdatedStamp" : "2020-01-17T12:31:58-08:00",
"orderIdentificationTypeId" : "SHOPIFY_ORD_ID",
"thruDate" : null
}, {
"orderId" : "SGSM10007",
"fromDate" : "2020-01-17T12:31:58-08:00",
"orderIdentificationTypeId" : "SHOPIFY_ORD_NAME",
"lastUpdatedStamp" : "2020-01-17T12:31:58-08:00",
"idValue" : "#1068",
"thruDate" : null
}, {
"orderId" : "SGSM10007",
"fromDate" : "2020-01-17T12:31:58-08:00",
"idValue" : "68",
"orderIdentificationTypeId" : "SHOPIFY_ORD_NO",
"lastUpdatedStamp" : "2020-01-17T12:31:58-08:00",
"thruDate" : null
} ],
"customerPartyIdentifications" : [ ],
"payments" : [ {
"orderId" : "SGSM10007",
"paymentMethodCode" : null,
"paymentMethodDescription" : "Shopify Payment",
"createdDate" : "2020-01-17T12:31:57-08:00",
"statusId" : "PAYMENT_SETTLED",
"returnId" : null,
"amount" : 104,
"paymentMethodTypeId" : "EXT_SHOPIFY"
} ],
"orderAdjustments" : [ {
"customerReferenceId" : null,
"correspondingProductId" : null,
"orderItemSeqId" : "_NA_",
"includeInShipping" : null,
"description" : null,
"exemptAmount" : null,
"productPromoId" : null,
"orderId" : "SGSM10007",
"taxAuthPartyId" : null,
"lastModifiedByUserLogin" : null,
"amount" : 15,
"oldPercentage" : null,
"primaryGeoId" : null,
"taxAuthGeoId" : null,
"originalAdjustmentId" : null,
"secondaryGeoId" : null,
"createdByUserLogin" : null,
"orderAdjustmentId" : null,
"amountAlreadyIncluded" : null,
"lastUpdatedStamp" : null,
"comments" : null,
"recurringAmount" : null,
"lastModifiedDate" : null,
"sourceReferenceId" : null,
"productPromoRuleId" : null,
"isManual" : null,
"productFeatureId" : null,
"taxAuthorityRateSeqId" : null,
"overrideGlAccountId" : null,
"oldAmountPerQuantity" : null,
"shipGroupSeqId" : null,
"includeInTax" : null,
"createdDate" : null,
"productPromoActionSeqId" : null,
"sourcePercentage" : null,
"orderAdjustmentTypeId" : "SHIPPING_CHARGES"
} ],
"orderAttributes" : [ ],
"orderItems" : [ {
"productStoreId" : "SG_STORE",
"orderId" : "SGSM10007",
"orderName" : "#1068",
"orderDate" : "2020-01-15T11:26:03-08:00",
"orderStatusId" : "ORDER_APPROVED",
"entryDate" : "2020-01-17T12:31:57-08:00",
"orderExternalId" : null,
"currency" : "USD",
"grandTotal" : 104,
"orderItemSeqId" : "00001",
"itemStatusId" : "ITEM_APPROVED",
"orderItemQuantity" : 1,
"reservedItemQuantity" : null,
"reservedDatetime" : null,
"unitPrice" : 89,
"orderItemExternalId" : "4458969923677",
"itemDescription" : "BLACK LEATHER / 37 / 17",
"requestedDeliveryDate" : null,
"requestedDeliveryTime" : null,
"deliveryWindow" : null,
"shipGroupSeqId" : "00001",
"shipmentMethodTypeId" : "SECOND_DAY",
"postalContactMechId" : "10800",
"telecomContactMechId" : null,
"orderFacilityId" : null,
"carrierPartyId" : "_NA_",
"externalFulfillmentOrderItemId" : null,
"fulfillmentStatus" : null,
"customerFirstName" : "Demo",
"customerLastName" : "User",
"facilityId" : "1",
"facilityExternalId" : "1",
"facilityTypeId" : "RETAIL_STORE",
"parentFacilityTypeId" : "PHYSICAL_STORE",
"statusDatetime" : "2020-03-19T11:50:29-07:00",
"productId" : "10609",
"productTypeId" : "FINISHED_GOOD",
"internalName" : "14312158756979",
"salesChannel" : "WEB_CHANNEL",
"customerPartyId" : "10004",
"shipTo" : {
"countryGeoCode" : "US",
"stateProvinceGeoCode" : "TN",
"contactMechId" : "10800",
"toName" : "demo user",
"attnName" : null,
"address1" : "11 U.S. 11",
"address2" : null,
"houseNumber" : null,
"houseNumberExt" : null,
"directions" : null,
"city" : "Knoxville",
"cityGeoId" : null,
"postalCode" : "37010",
"postalCodeExt" : null,
"countryGeoId" : "USA",
"stateProvinceGeoId" : "TN",
"countyGeoId" : null,
"municipalityGeoId" : null,
"postalCodeGeoId" : null,
"geoPointId" : null,
"encodedAddressKey" : null,
"latitude" : null,
"longitude" : null,
"isResidentialAddress" : "Y",
"phone" : null
},
"goodIdentifications" : [ {
"idValue" : "S00CG30",
"productId" : "10609",
"lastUpdatedStamp" : "2022-02-04T07:09:25-08:00",
"fromDate" : "2020-06-01T12:02:00-07:00",
"goodIdentificationTypeId" : "SHOPIFY_PROD_SKU",
"thruDate" : null
}, {
"idValue" : "661812039147",
"fromDate" : "2020-01-17T10:21:16-08:00",
"goodIdentificationTypeId" : "UPCA",
"lastUpdatedStamp" : "2022-02-04T07:09:25-08:00",
"productId" : "10609",
"thruDate" : null
} ],
"orderItemAdjustments" : [ ],
"orderItemAttributes" : [ ],
"facilityGroupMembers" : [ {
"facilityId" : "1",
"facilityGroupId" : "AUTO_SHIPPING_LABEL",
"lastUpdatedStamp" : "2021-09-29T01:16:19-07:00",
"sequenceNum" : 5,
"fromDate" : "2020-06-25T12:41:21-07:00",
"thruDate" : null
}, {
"facilityId" : "1",
"facilityGroupId" : "DO_PICKING",
"lastUpdatedStamp" : "2021-09-29T01:16:19-07:00",
"fromDate" : "2020-06-25T12:41:21-07:00",
"sequenceNum" : 5,
"thruDate" : null
}, {
"facilityId" : "1",
"fromDate" : "2020-06-25T12:41:21-07:00",
"sequenceNum" : 5,
"facilityGroupId" : "DO_RATE_SHOP",
"lastUpdatedStamp" : "2021-09-29T01:16:19-07:00",
"thruDate" : null
}, {
"facilityGroupId" : "OMS_FULFILLMENT",
"facilityId" : "1",
"sequenceNum" : 5,
"fromDate" : "2020-06-25T12:41:21-07:00",
"thruDate" : null,
"lastUpdatedStamp" : "2021-09-29T01:16:19-07:00"
}, {
"facilityId" : "1",
"sequenceNum" : null,
"facilityGroupId" : "SMUS_BROKERING_GROUP",
"fromDate" : "2023-10-19T08:18:04-07:00",
"lastUpdatedStamp" : "2023-10-19T08:18:04-07:00",
"thruDate" : null
}, {
"facilityId" : "1",
"lastUpdatedStamp" : "2023-10-19T08:24:38-07:00",
"sequenceNum" : null,
"fromDate" : "2023-10-19T08:24:38-07:00",
"facilityGroupId" : "SMUS_ST_BRK_GRP",
"thruDate" : null
}, {
"facilityId" : "1",
"sequenceNum" : null,
"lastUpdatedStamp" : "2023-11-10T01:18:38-08:00",
"fromDate" : "2023-11-10T01:18:33-08:00",
"facilityGroupId" : "SUPERGA_FAC_GRP",
"thruDate" : null
}, {
"facilityGroupId" : "WH_FAC_GROUP",
"facilityId" : "1",
"sequenceNum" : null,
"fromDate" : "2024-01-01T00:00:00-08:00",
"lastUpdatedStamp" : "2024-01-04T06:50:21-08:00",
"thruDate" : null
} ],
"fromOrderItemAssocs" : [ ],
"toOrderItemAssocs" : [ ],
"productFeatures" : [ {
"amount" : null,
"productFeatureApplTypeId" : "STANDARD_FEATURE",
"productFeatureId" : "10015",
"sequenceNum" : null,
"recurringAmount" : null,
"fromDate" : "2020-01-17T10:21:16-08:00",
"idCode" : null,
"productFeatureCategoryId" : "10015",
"contentId" : null,
"numberSpecified" : null,
"uomId" : null,
"thruDate" : null,
"defaultSequenceNum" : null,
"description" : "37",
"defaultAmount" : null,
"imageUrl" : null,
"abbrev" : null,
"productId" : "10609",
"productFeatureTypeId" : "SIZE"
}, {
"amount" : null,
"productFeatureApplTypeId" : "STANDARD_FEATURE",
"sequenceNum" : null,
"recurringAmount" : null,
"productFeatureId" : "10101",
"fromDate" : "2020-01-17T10:21:16-08:00",
"idCode" : null,
"productFeatureCategoryId" : "10015",
"contentId" : null,
"numberSpecified" : null,
"uomId" : null,
"description" : "BLACK LEATHER",
"productFeatureTypeId" : "COLOR",
"thruDate" : null,
"defaultSequenceNum" : null,
"defaultAmount" : null,
"imageUrl" : null,
"abbrev" : null,
"productId" : "10609"
}, {
"amount" : null,
"productFeatureApplTypeId" : "STANDARD_FEATURE",
"sequenceNum" : null,
"recurringAmount" : null,
"productFeatureId" : "10102",
"fromDate" : "2020-01-17T10:21:16-08:00",
"idCode" : null,
"productFeatureCategoryId" : "10015",
"contentId" : null,
"numberSpecified" : null,
"uomId" : null,
"thruDate" : null,
"defaultSequenceNum" : null,
"productFeatureTypeId" : "CODE",
"defaultAmount" : null,
"description" : "17",
"imageUrl" : null,
"abbrev" : null,
"productId" : "10609"
} ]
} ]
},{
"productStoreId" : "STORE",
"orderId" : "KRWE10188",
"orderName" : "#KREWE37484",
"orderDate" : "2023-12-07T01:47:49-08:00",
"orderStatusId" : "ORDER_APPROVED",
"entryDate" : "2023-12-07T02:09:35-08:00",
"orderExternalId" : "5499245625544",
"currency" : "USD",
"grandTotal" : 390,
"orderItemSeqId" : null,
"itemStatusId" : null,
"orderItemQuantity" : null,
"reservedItemQuantity" : null,
"reservedDatetime" : null,
"unitPrice" : null,
"orderItemExternalId" : null,
"itemDescription" : null,
"requestedDeliveryDate" : null,
"requestedDeliveryTime" : null,
"deliveryWindow" : null,
"shipGroupSeqId" : null,
"shipmentMethodTypeId" : null,
"postalContactMechId" : null,
"telecomContactMechId" : null,
"orderFacilityId" : null,
"carrierPartyId" : null,
"externalFulfillmentOrderItemId" : null,
"fulfillmentStatus" : null,
"customerFirstName" : "Dhiraj",
"customerLastName" : "Nagar",
"facilityId" : null,
"facilityExternalId" : null,
"facilityTypeId" : null,
"parentFacilityTypeId" : null,
"statusDatetime" : null,
"productId" : null,
"productTypeId" : null,
"internalName" : null,
"salesChannel" : "1",
"customerPartyId" : "10005",
"isShippingChargesSent" : "N",
"billTo" : {
"countryGeoCode" : "US",
"stateProvinceGeoCode" : "FL",
"contactMechId" : "10948",
"toName" : "Dhiraj Nagar",
"attnName" : null,
"address1" : "Main St Square",
"address2" : "Main St Square",
"houseNumber" : null,
"houseNumberExt" : null,
"directions" : null,
"city" : "Miami",
"cityGeoId" : null,
"postalCode" : "33172",
"postalCodeExt" : null,
"countryGeoId" : "USA",
"stateProvinceGeoId" : "FL",
"countyGeoId" : null,
"municipalityGeoId" : null,
"postalCodeGeoId" : null,
"geoPointId" : null,
"encodedAddressKey" : null,
"latitude" : null,
"longitude" : null,
"isResidentialAddress" : "Y",
"phone" : {
"contactMechId" : "10949",
"countryCode" : null,
"areaCode" : null,
"contactNumber" : "08973575538",
"askForName" : null,
"lastUpdatedStamp" : "2023-12-07T02:09:35-08:00"
}
},
"orderIdentifications" : [ {
"lastUpdatedStamp" : "2023-12-07T02:09:35-08:00",
"fromDate" : "2023-12-07T02:09:35-08:00",
"orderId" : "KRWE10188",
"idValue" : "5499245625544",
"orderIdentificationTypeId" : "SHOPIFY_ORD_ID",
"thruDate" : null
}, {
"fromDate" : "2023-12-07T02:09:35-08:00",
"orderIdentificationTypeId" : "SHOPIFY_ORD_NAME",
"orderId" : "KRWE10188",
"idValue" : "#KREWE37484",
"thruDate" : null,
"lastUpdatedStamp" : "2023-12-07T02:09:35-08:00"
}, {
"orderIdentificationTypeId" : "SHOPIFY_ORD_NO",
"fromDate" : "2023-12-07T02:09:35-08:00",
"idValue" : "36484",
"orderId" : "KRWE10188",
"lastUpdatedStamp" : "2023-12-07T02:09:35-08:00",
"thruDate" : null
} ],
"customerPartyIdentifications" : [ {
"partyId" : "10005",
"idValue" : "5320857",
"partyIdentificationTypeId" : "NETSUITE_CUSTOMER_ID",
"lastUpdatedStamp" : "2023-11-22T10:58:34-08:00"
}, {
"partyId" : "10005",
"lastUpdatedStamp" : "2023-11-22T06:11:12-08:00",
"partyIdentificationTypeId" : "SHOPIFY_CUST_ID",
"idValue" : "6838392979656"
} ],
"payments" : [ {
"paymentMethodCode" : null,
"createdDate" : "2023-12-07T02:09:35-08:00",
"statusId" : "PAYMENT_SETTLED",
"paymentMethodTypeId" : "EXT_SHOP_MANUAL",
"amount" : 390,
"returnId" : null,
"orderId" : "KRWE10188",
"paymentMethodDescription" : "Ext manual"
} ],
"orderAdjustments" : [ {
"customerReferenceId" : null,
"correspondingProductId" : null,
"orderItemSeqId" : "_NA_",
"includeInShipping" : null,
"description" : null,
"exemptAmount" : null,
"productPromoId" : null,
"taxAuthPartyId" : null,
"lastModifiedByUserLogin" : null,
"oldPercentage" : null,
"primaryGeoId" : null,
"orderId" : "KRWE10188",
"taxAuthGeoId" : null,
"originalAdjustmentId" : null,
"secondaryGeoId" : null,
"createdByUserLogin" : null,
"orderAdjustmentId" : null,
"amountAlreadyIncluded" : null,
"lastUpdatedStamp" : null,
"comments" : null,
"recurringAmount" : null,
"lastModifiedDate" : null,
"sourceReferenceId" : null,
"productPromoRuleId" : null,
"isManual" : null,
"productFeatureId" : null,
"taxAuthorityRateSeqId" : null,
"overrideGlAccountId" : null,
"oldAmountPerQuantity" : null,
"shipGroupSeqId" : null,
"amount" : 35,
"includeInTax" : null,
"createdDate" : null,
"productPromoActionSeqId" : null,
"sourcePercentage" : null,
"orderAdjustmentTypeId" : "SHIPPING_CHARGES"
} ],
"orderAttributes" : [ {
"attrDescription" : "Shopify User Id",
"orderId" : "KRWE10188",
"attrName" : "shopify_user_id",
"lastUpdatedStamp" : "2023-12-07T02:09:35-08:00",
"attrValue" : "82607702216"
} ],
"orderItems" : [ {
"productStoreId" : "STORE",
"orderId" : "KRWE10188",
"orderName" : "#KREWE37484",
"orderDate" : "2023-12-07T01:47:49-08:00",
"orderStatusId" : "ORDER_APPROVED",
"entryDate" : "2023-12-07T02:09:35-08:00",
"orderExternalId" : "5499245625544",
"currency" : "USD",
"grandTotal" : 390,
"orderItemSeqId" : "00101",
"itemStatusId" : "ITEM_APPROVED",
"orderItemQuantity" : 1,
"reservedItemQuantity" : null,
"reservedDatetime" : null,
"unitPrice" : 355,
"orderItemExternalId" : "12980256866504",
"itemDescription" : "COLEMAN | 18K + Matte Indigo Fade + Gravity + Custom Vanity Tint (KIT PRODUCT)",
"requestedDeliveryDate" : null,
"requestedDeliveryTime" : null,
"deliveryWindow" : null,
"shipGroupSeqId" : "00001",
"shipmentMethodTypeId" : "OVR_SHP",
"postalContactMechId" : "10945",
"telecomContactMechId" : "10946",
"orderFacilityId" : null,
"carrierPartyId" : "FEDEX",
"externalFulfillmentOrderItemId" : "100217",
"fulfillmentStatus" : "Sent",
"customerFirstName" : "Dhiraj",
"customerLastName" : "Nagar",
"facilityId" : "114",
"facilityExternalId" : "114",
"facilityTypeId" : "WAREHOUSE",
"parentFacilityTypeId" : "DISTRIBUTION_CENTER",
"statusDatetime" : "2023-12-07T02:09:50-08:00",
"productId" : "10344",
"productTypeId" : "MARKETING_PKG_PICK",
"internalName" : "VANITYKIT-01",
"salesChannel" : "1",
"customerPartyId" : "10005",
"shipTo" : {
"countryGeoCode" : "US",
"stateProvinceGeoCode" : "FL",
"contactMechId" : "10945",
"toName" : "Dhiraj Nagar",
"attnName" : null,
"address1" : "Main St Square",
"address2" : "Main St Square",
"houseNumber" : null,
"houseNumberExt" : null,
"directions" : null,
"city" : "Miami",
"cityGeoId" : null,
"postalCode" : "33172",
"postalCodeExt" : null,
"countryGeoId" : "USA",
"stateProvinceGeoId" : "FL",
"countyGeoId" : null,
"municipalityGeoId" : null,
"postalCodeGeoId" : null,
"geoPointId" : null,
"encodedAddressKey" : null,
"latitude" : null,
"longitude" : null,
"isResidentialAddress" : "Y",
"phone" : {
"contactMechId" : "10946",
"countryCode" : null,
"areaCode" : null,
"contactNumber" : "08973575538",
"askForName" : null,
"lastUpdatedStamp" : "2023-12-07T02:09:35-08:00"
}
},
"goodIdentifications" : [ {
"idValue" : "40675",
"fromDate" : "2023-11-22T11:05:40-08:00",
"goodIdentificationTypeId" : "NETSUITE_PRODUCT_ID",
"productId" : "10344",
"lastUpdatedStamp" : "2024-03-27T01:36:21-07:00",
"thruDate" : null
}, {
"idValue" : "42870659088584",
"lastUpdatedStamp" : "2023-11-22T06:05:00-08:00",
"goodIdentificationTypeId" : "SHOPIFY_PROD_ID",
"productId" : "10344",
"fromDate" : "2023-11-22T06:05:00-08:00",
"thruDate" : null
}, {
"lastUpdatedStamp" : "2023-11-22T06:05:00-08:00",
"productId" : "10344",
"idValue" : "VANITYKIT-01",
"fromDate" : "2023-11-22T06:05:00-08:00",
"goodIdentificationTypeId" : "SHOPIFY_PROD_SKU",
"thruDate" : null
}, {
"goodIdentificationTypeId" : "SKU",
"lastUpdatedStamp" : "2023-11-22T06:05:00-08:00",
"productId" : "10344",
"idValue" : "VANITYKIT-01",
"fromDate" : "2023-11-22T06:05:00-08:00",
"thruDate" : null
} ],
"orderItemAdjustments" : [ ],
"orderItemAttributes" : [ ],
"facilityGroupMembers" : [ {
"sequenceNum" : null,
"lastUpdatedStamp" : "2023-11-23T13:36:59-08:00",
"fromDate" : "2023-11-23T13:36:55-08:00",
"facilityGroupId" : "NETSUITE_FULFILLMENT",
"facilityId" : "114",
"thruDate" : null
}, {
"facilityGroupId" : "OMS_FULFILLMENT",
"sequenceNum" : null,
"fromDate" : "2023-12-07T01:58:42-08:00",
"lastUpdatedStamp" : "2023-12-07T01:58:42-08:00",
"facilityId" : "114",
"thruDate" : null
} ],
"fromOrderItemAssocs" : [ ],
"toOrderItemAssocs" : [ {
"toOrderItemSeqId" : "00102",
"quantity" : null,
"toShipGroupSeqId" : "00001",
"toOrderId" : "KRWE10188",
"orderId" : "KRWE10188",
"orderItemAssocTypeId" : "KIT_COMPONENT",
"lastUpdatedStamp" : "2023-12-07T02:09:35-08:00",
"shipGroupSeqId" : "00001",
"orderItemSeqId" : "00101"
}, {
"lastUpdatedStamp" : "2023-12-07T02:09:35-08:00",
"quantity" : null,
"toShipGroupSeqId" : "00001",
"toOrderId" : "KRWE10188",
"orderId" : "KRWE10188",
"orderItemAssocTypeId" : "KIT_COMPONENT",
"shipGroupSeqId" : "00001",
"orderItemSeqId" : "00101",
"toOrderItemSeqId" : "00103"
} ],
"productFeatures" : [ {
"productFeatureId" : "10000",
"amount" : null,
"productFeatureApplTypeId" : "STANDARD_FEATURE",
"recurringAmount" : null,
"description" : "Default Title",
"idCode" : null,
"sequenceNum" : 1,
"contentId" : null,
"productFeatureTypeId" : "10000",
"numberSpecified" : null,
"productId" : "10344",
"productFeatureCategoryId" : null,
"uomId" : null,
"thruDate" : null,
"defaultSequenceNum" : null,
"defaultAmount" : null,
"imageUrl" : null,
"abbrev" : null,
"fromDate" : "2023-11-22T06:05:00-08:00"
} ]
}, {
"productStoreId" : "STORE",
"orderId" : "KRWE10188",
"orderName" : "#KREWE37484",
"orderDate" : "2023-12-07T01:47:49-08:00",
"orderStatusId" : "ORDER_APPROVED",
"entryDate" : "2023-12-07T02:09:35-08:00",
"orderExternalId" : "5499245625544",
"currency" : "USD",
"grandTotal" : 390,
"orderItemSeqId" : "00102",
"itemStatusId" : "ITEM_APPROVED",
"orderItemQuantity" : 1,
"reservedItemQuantity" : 1,
"reservedDatetime" : "2023-12-14T00:15:52-08:00",
"unitPrice" : 0,
"orderItemExternalId" : null,
"itemDescription" : "Default Title (COMPONENT PRODUCT)",
"requestedDeliveryDate" : null,
"requestedDeliveryTime" : null,
"deliveryWindow" : null,
"shipGroupSeqId" : "00001",
"shipmentMethodTypeId" : "OVR_SHP",
"postalContactMechId" : "10945",
"telecomContactMechId" : "10946",
"orderFacilityId" : null,
"carrierPartyId" : "FEDEX",
"externalFulfillmentOrderItemId" : "100218",
"fulfillmentStatus" : "Sent",
"customerFirstName" : "Dhiraj",
"customerLastName" : "Nagar",
"facilityId" : "114",
"facilityExternalId" : "114",
"facilityTypeId" : "WAREHOUSE",
"parentFacilityTypeId" : "DISTRIBUTION_CENTER",
"statusDatetime" : "2023-12-07T02:09:50-08:00",
"productId" : "10342",
"productTypeId" : "FINISHED_GOOD",
"internalName" : "SCJ1-228G-21CS-222",
"salesChannel" : "1",
"customerPartyId" : "10005",
"shipTo" : {
"countryGeoCode" : "US",
"stateProvinceGeoCode" : "FL",
"contactMechId" : "10945",
"toName" : "Dhiraj Nagar",
"attnName" : null,
"address1" : "Main St Square",
"address2" : "Main St Square",
"houseNumber" : null,
"houseNumberExt" : null,
"directions" : null,
"city" : "Miami",
"cityGeoId" : null,
"postalCode" : "33172",
"postalCodeExt" : null,
"countryGeoId" : "USA",
"stateProvinceGeoId" : "FL",
"countyGeoId" : null,
"municipalityGeoId" : null,
"postalCodeGeoId" : null,
"geoPointId" : null,
"encodedAddressKey" : null,
"latitude" : null,
"longitude" : null,
"isResidentialAddress" : "Y",
"phone" : {
"contactMechId" : "10946",
"countryCode" : null,
"areaCode" : null,
"contactNumber" : "08973575538",
"askForName" : null,
"lastUpdatedStamp" : "2023-12-07T02:09:35-08:00"
}
},
"goodIdentifications" : [ {
"idValue" : "31083",
"fromDate" : "2023-11-22T11:05:38-08:00",
"lastUpdatedStamp" : "2024-03-27T01:36:20-07:00",
"goodIdentificationTypeId" : "NETSUITE_PRODUCT_ID",
"productId" : "10342",
"thruDate" : null
}, {
"fromDate" : "2023-11-22T06:04:59-08:00",
"goodIdentificationTypeId" : "SHOPIFY_PROD_ID",
"idValue" : "42389625733320",
"productId" : "10342",
"thruDate" : null,
"lastUpdatedStamp" : "2023-11-22T06:04:59-08:00"
}, {
"idValue" : "SCJ1-228G-21CS-222",
"fromDate" : "2023-11-22T06:04:59-08:00",
"productId" : "10342",
"lastUpdatedStamp" : "2023-11-22T06:04:59-08:00",
"goodIdentificationTypeId" : "SHOPIFY_PROD_SKU",
"thruDate" : null
}, {
"idValue" : "SCJ1-228G-21CS-222",
"fromDate" : "2023-11-22T06:04:59-08:00",
"goodIdentificationTypeId" : "SKU",
"lastUpdatedStamp" : "2023-11-22T06:04:59-08:00",
"productId" : "10342",
"thruDate" : null
}, {
"fromDate" : "2023-11-22T06:04:59-08:00",
"idValue" : "810062125869",
"goodIdentificationTypeId" : "UPCA",
"productId" : "10342",
"lastUpdatedStamp" : "2023-11-22T06:04:59-08:00",
"thruDate" : null
} ],
"orderItemAdjustments" : [ ],
"orderItemAttributes" : [ ],
"facilityGroupMembers" : [ {
"sequenceNum" : null,
"lastUpdatedStamp" : "2023-11-23T13:36:59-08:00",
"fromDate" : "2023-11-23T13:36:55-08:00",
"facilityGroupId" : "NETSUITE_FULFILLMENT",
"facilityId" : "114",
"thruDate" : null
}, {
"facilityGroupId" : "OMS_FULFILLMENT",
"sequenceNum" : null,
"fromDate" : "2023-12-07T01:58:42-08:00",
"lastUpdatedStamp" : "2023-12-07T01:58:42-08:00",
"facilityId" : "114",
"thruDate" : null
} ],
"fromOrderItemAssocs" : [ {
"toOrderItemSeqId" : "00102",
"quantity" : null,
"toShipGroupSeqId" : "00001",
"toOrderId" : "KRWE10188",
"orderId" : "KRWE10188",
"orderItemAssocTypeId" : "KIT_COMPONENT",
"lastUpdatedStamp" : "2023-12-07T02:09:35-08:00",
"shipGroupSeqId" : "00001",
"orderItemSeqId" : "00101"
} ],
"toOrderItemAssocs" : [ ],
"productFeatures" : [ {
"productFeatureId" : "10000",
"amount" : null,
"productFeatureApplTypeId" : "STANDARD_FEATURE",
"recurringAmount" : null,
"description" : "Default Title",
"idCode" : null,
"sequenceNum" : 1,
"contentId" : null,
"productFeatureTypeId" : "10000",
"numberSpecified" : null,
"productFeatureCategoryId" : null,
"uomId" : null,
"productId" : "10342",
"thruDate" : null,
"fromDate" : "2023-11-22T06:04:59-08:00",
"defaultSequenceNum" : null,
"defaultAmount" : null,
"imageUrl" : null,
"abbrev" : null
} ]
}, {
"productStoreId" : "STORE",
"orderId" : "KRWE10188",
"orderName" : "#KREWE37484",
"orderDate" : "2023-12-07T01:47:49-08:00",
"orderStatusId" : "ORDER_APPROVED",
"entryDate" : "2023-12-07T02:09:35-08:00",
"orderExternalId" : "5499245625544",
"currency" : "USD",
"grandTotal" : 390,
"orderItemSeqId" : "00103",
"itemStatusId" : "ITEM_APPROVED",
"orderItemQuantity" : 1,
"reservedItemQuantity" : 1,
"reservedDatetime" : "2023-12-14T00:15:53-08:00",
"unitPrice" : 0,
"orderItemExternalId" : null,
"itemDescription" : "Dark Blue Gradient / 4B (COMPONENT PRODUCT)",
"requestedDeliveryDate" : null,
"requestedDeliveryTime" : null,
"deliveryWindow" : null,
"shipGroupSeqId" : "00001",
"shipmentMethodTypeId" : "OVR_SHP",
"postalContactMechId" : "10945",
"telecomContactMechId" : "10946",
"orderFacilityId" : null,
"carrierPartyId" : "FEDEX",
"externalFulfillmentOrderItemId" : "100219",
"fulfillmentStatus" : "Sent",
"customerFirstName" : "Dhiraj",
"customerLastName" : "Nagar",
"facilityId" : "114",
"facilityExternalId" : "114",
"facilityTypeId" : "WAREHOUSE",
"parentFacilityTypeId" : "DISTRIBUTION_CENTER",
"statusDatetime" : "2023-12-07T02:09:50-08:00",
"productId" : "11741",
"productTypeId" : "FINISHED_GOOD",
"internalName" : "VANITYLENS-06",
"salesChannel" : "1",
"customerPartyId" : "10005",
"shipTo" : {
"countryGeoCode" : "US",
"stateProvinceGeoCode" : "FL",
"contactMechId" : "10945",
"toName" : "Dhiraj Nagar",
"attnName" : null,
"address1" : "Main St Square",
"address2" : "Main St Square",
"houseNumber" : null,
"houseNumberExt" : null,
"directions" : null,
"city" : "Miami",
"cityGeoId" : null,
"postalCode" : "33172",
"postalCodeExt" : null,
"countryGeoId" : "USA",
"stateProvinceGeoId" : "FL",
"countyGeoId" : null,
"municipalityGeoId" : null,
"postalCodeGeoId" : null,
"geoPointId" : null,
"encodedAddressKey" : null,
"latitude" : null,
"longitude" : null,
"isResidentialAddress" : "Y",
"phone" : {
"contactMechId" : "10946",
"countryCode" : null,
"areaCode" : null,
"contactNumber" : "08973575538",
"askForName" : null,
"lastUpdatedStamp" : "2023-12-07T02:09:35-08:00"
}
},
"goodIdentifications" : [ {
"fromDate" : "2023-11-22T11:05:40-08:00",
"goodIdentificationTypeId" : "NETSUITE_PRODUCT_ID",
"idValue" : "38040",
"productId" : "11741",
"lastUpdatedStamp" : "2024-03-27T01:36:21-07:00",
"thruDate" : null
}, {
"goodIdentificationTypeId" : "SHOPIFY_PROD_ID",
"productId" : "11741",
"lastUpdatedStamp" : "2023-11-22T06:07:31-08:00",
"fromDate" : "2023-11-22T06:07:30-08:00",
"idValue" : "42870661480648",
"thruDate" : null
}, {
"lastUpdatedStamp" : "2023-11-22T06:07:30-08:00",
"idValue" : "VANITYLENS-06",
"productId" : "11741",
"fromDate" : "2023-11-22T06:07:30-08:00",
"goodIdentificationTypeId" : "SHOPIFY_PROD_SKU",
"thruDate" : null
}, {
"idValue" : "VANITYLENS-06",
"lastUpdatedStamp" : "2023-11-22T06:07:31-08:00",
"goodIdentificationTypeId" : "SKU",
"productId" : "11741",
"fromDate" : "2023-11-22T06:07:30-08:00",
"thruDate" : null
} ],
"orderItemAdjustments" : [ ],
"orderItemAttributes" : [ ],
"facilityGroupMembers" : [ {
"sequenceNum" : null,
"lastUpdatedStamp" : "2023-11-23T13:36:59-08:00",
"fromDate" : "2023-11-23T13:36:55-08:00",
"facilityGroupId" : "NETSUITE_FULFILLMENT",
"facilityId" : "114",
"thruDate" : null
}, {
"facilityGroupId" : "OMS_FULFILLMENT",
"sequenceNum" : null,
"fromDate" : "2023-12-07T01:58:42-08:00",
"lastUpdatedStamp" : "2023-12-07T01:58:42-08:00",
"facilityId" : "114",
"thruDate" : null
} ],
"fromOrderItemAssocs" : [ {
"lastUpdatedStamp" : "2023-12-07T02:09:35-08:00",
"quantity" : null,
"toShipGroupSeqId" : "00001",
"toOrderId" : "KRWE10188",
"orderId" : "KRWE10188",
"orderItemAssocTypeId" : "KIT_COMPONENT",
"shipGroupSeqId" : "00001",
"orderItemSeqId" : "00101",
"toOrderItemSeqId" : "00103"
} ],
"toOrderItemAssocs" : [ ],
"productFeatures" : [ {
"amount" : null,
"productFeatureApplTypeId" : "STANDARD_FEATURE",
"productFeatureId" : "10169",
"recurringAmount" : null,
"sequenceNum" : 2,
"idCode" : null,
"contentId" : null,
"numberSpecified" : null,
"productId" : "11741",
"productFeatureTypeId" : "10010",
"productFeatureCategoryId" : null,
"uomId" : null,
"fromDate" : "2023-11-22T06:07:30-08:00",
"thruDate" : null,
"defaultSequenceNum" : null,
"defaultAmount" : null,
"imageUrl" : null,
"abbrev" : null,
"description" : "4B"
}, {
"amount" : null,
"productFeatureId" : "10173",
"productFeatureApplTypeId" : "STANDARD_FEATURE",
"recurringAmount" : null,
"idCode" : null,
"sequenceNum" : 1,
"description" : "Dark Blue Gradient",
"contentId" : null,
"numberSpecified" : null,
"productId" : "11741",
"productFeatureCategoryId" : null,
"uomId" : null,
"fromDate" : "2023-11-22T06:07:30-08:00",
"productFeatureTypeId" : "COLOR",
"thruDate" : null,
"defaultSequenceNum" : null,
"defaultAmount" : null,
"imageUrl" : null,
"abbrev" : null
} ]
} ]
}
]2024-02-23T03:43:23+09:00
See below
jhon deo
0593785656
null
Ext Other Gateways
12082
true
2024-02-23T03:43:23+09:00
jhon deo
0593785656
SHOPIFY_PROD_ID
0001
true
2024-02-23T03:50:12+09:00
00001
00001
Red, L
Generates JWT token for subsequent API calles.
Authorization header using Basic Authentication
Authorization: Basic YWRtaW46b2ZiaXo=default response
default response
No content
Wrapper Service For Adding Category Products
application/jsonIn Schema for service: addCategoryProducts request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Service for indexing data to Solr
application/jsonIn Schema for service: addDataToSearchIndex request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Bulk Add Facility To FacilityGroup
application/jsonIn Schema for service: addFacilitiesToGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Add Facility To FacilityGroup
application/jsonIn Schema for service: addFacilityToGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a FacilityParty record
application/jsonIn Schema for service: addPartyToFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
application/jsonIn Schema for service: addPartyUserPermission request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
application/jsonIn Schema for service: addProductToFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
application/jsonIn Schema for service: addSecurityGroupToUserLogin request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Add a SecurityPermission to a SecurityGroup
application/jsonIn Schema for service: addSecurityPermissionToSecurityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create Shipment, ShipmentRouteSegment, ShipmentPackageRouteSeg and ShipmentPackage without items
application/jsonIn Schema for service: addShipmentPackage request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Add a UserLogin to a SecurityGroup
application/jsonIn Schema for service: addUserLoginToSecurityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
application/jsonIn Schema for service: allocateOrderItemToFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Append an item to an existing order
application/jsonIn Schema for service: appendOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Change status of sales order to approved after validating certain checks which must be performed before approving order
application/jsonIn Schema for service: approveSalesOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Adjust Shopify inventory level.
application/jsonIn Schema for service: bulkAdjustInventoryLevelOnShopify request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Mark transfer order as Approved in bulk
application/jsonIn Schema for service: bulkApproveTransferOrders request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Mark all orders items as picked in bulk
application/jsonIn Schema for service: bulkPackStoreFulfillmentOrders request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Route all in progress orders to rebrokering
application/jsonIn Schema for service: bulkRejectStoreInProgressOrders request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Route all outstanding orders to rebrokering
application/jsonIn Schema for service: bulkRejectStoreOutstandingOrders request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Mark shipments as Shipped in bulk
application/jsonIn Schema for service: bulkShipOrders request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a calendar and save calendar week details
application/jsonIn Schema for service: calendarDataSetup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Cancel an Order Item Quantity
application/jsonIn Schema for service: cancelOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Cancel Order Item Quantity for order
application/jsonIn Schema for service: cancelOrderItems request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
checking whether fulfillment started for the order, if its not then order would be cancelled
application/jsonIn Schema for service: cancelSalesOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Cancels a schedule job
application/jsonIn Schema for service: cancelScheduledJob request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Change the status of an existing order item. If no orderItemSeqId is specified, the status of all order items will be changed.
application/jsonIn Schema for service: changeOrderItemStatus request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Change the status of an existing order
application/jsonIn Schema for service: changeOrderStatus request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Check if fulfillment started for item and then reject it
application/jsonIn Schema for service: checkAndRejectOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
This service will check the list of attributes on the passed order and approve it if all the passed attributes are present
application/jsonIn Schema for service: checkAttributesAndApproveOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Clears all values from all Entity Engine caches. By default does not distribute.
application/jsonIn Schema for service: clearAllEntityCaches request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Clear Cache Line with a condition; By default does not distribute.
application/jsonIn Schema for service: clearCacheLineByCondition request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Clear Cache Line with a dummyPK (GenericEntity); clears that all cache entry and depending on whether the dummyPK is a primaryKey or not this clears the by primary key cache or the specified entry in the by and cache. By default does not distribute.
application/jsonIn Schema for service: clearCacheLineByDummyPK request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Clear Cache Line with a primaryKey (GenericPK); clears the all and by primary key caches. By default does not distribute.
application/jsonIn Schema for service: clearCacheLineByPrimaryKey request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Clear Cache Line with a value (GenericValue); this is the preferred method since the all, by primary key and by and caches will be cleared. By default does not distribute.
application/jsonIn Schema for service: clearCacheLineByValue request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a new Carrier Shipment Box Type Record
application/jsonIn Schema for service: createCarrierShipmentBoxType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Creates A CarrierShipmentMethod
application/jsonIn Schema for service: createCarrierShipmentMethod request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
application/jsonIn Schema for service: createCommercePartyRelationshipFrom request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a Communication Event with permission check
application/jsonIn Schema for service: createCommunicationEvent request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a Communication Event Order
application/jsonIn Schema for service: createCommunicationEventOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a DataManagerConfig
application/jsonIn Schema for service: createDataManagerConfig request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a DataManagerMapping
application/jsonIn Schema for service: createDataManagerMapping request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a Enumeration
application/jsonIn Schema for service: createEnumeration request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create enumeration group member
application/jsonIn Schema for service: createEnumerationGroupMember request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Service for create excluded order facility record for all order items
application/jsonIn Schema for service: createExcludedOrderFacilityForOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a Facility
application/jsonIn Schema for service: createFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a FacilityCalendar
application/jsonIn Schema for service: createFacilityCalendar request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a FacilityContactMech
application/jsonIn Schema for service: createFacilityContactMech request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create an Email Address
application/jsonIn Schema for service: createFacilityEmailAddress request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a Facility Group
application/jsonIn Schema for service: createFacilityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a FacilityIdentification
application/jsonIn Schema for service: createFacilityIdentification request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a Facility Location
application/jsonIn Schema for service: createFacilityLocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a Postal Address
application/jsonIn Schema for service: createFacilityPostalAddress request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a Telecommunications Number
application/jsonIn Schema for service: createFacilityTelecomNumber request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Creates the fulfillment log
application/jsonIn Schema for service: createGcFulFillmentRecord request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create Shopify Return in HC
application/jsonIn Schema for service: createIncomingShipment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Creates a New User Login and Set it's default Organization by creating User Preference entity record.
application/jsonIn Schema for service: createNewUserLoginAndSetUserPreference request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Service for creating the index for a single OISGIR.
application/jsonIn Schema for service: createOISGIRIndex request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Service to create order appeasement
application/jsonIn Schema for service: createOrderAppeasement request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create an OrderAttribute record
application/jsonIn Schema for service: createOrderAttribute request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create Order Indexes
application/jsonIn Schema for service: createOrderIndex request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create Order Item Attribute
application/jsonIn Schema for service: createOrderItemAttribute request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a PartyGroup
application/jsonIn Schema for service: createPartyGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a Postal Address
application/jsonIn Schema for service: createPostalAddress request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create an ProductFacilityLocation
application/jsonIn Schema for service: createProductFacilityLocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create Index for single product.
application/jsonIn Schema for service: createProductIndex request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a ProductStoreFacility
application/jsonIn Schema for service: createProductStoreFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a ProductStoreFacilityGroup
application/jsonIn Schema for service: createProductStoreFacilityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create ProductStoreRole
application/jsonIn Schema for service: createProductStoreRole request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a ProductStoreSetting
application/jsonIn Schema for service: createProductStoreSetting request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a Product Store Shipment Method
application/jsonIn Schema for service: createProductStoreShipMeth request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
application/jsonIn Schema for service: createPurchaseShipment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create Relationship record
application/jsonIn Schema for service: createRelationship request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create return/sales return based on API input parameters
application/jsonIn Schema for service: createReturn request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a new role type
application/jsonIn Schema for service: createRoleType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create Order Data based on API input parameters
application/jsonIn Schema for service: createSalesOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create Search Preference
application/jsonIn Schema for service: createSearchPreference request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create an SecurityGroup
application/jsonIn Schema for service: createSecurityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a SecurityPermission
application/jsonIn Schema for service: createSecurityPermission request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a ShipmentBoxType record
application/jsonIn Schema for service: createShipmentBoxType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create ShipmentItem
application/jsonIn Schema for service: createShipmentItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Creates A ShipmentMethodType
application/jsonIn Schema for service: createShipmentMethodType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Creates a ShipmentReceipt Record
application/jsonIn Schema for service: createShipmentReceipt request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Import Shopify Orders
application/jsonIn Schema for service: createShopifyOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Creates a ShopifyProdLocActivation record
application/jsonIn Schema for service: createShopifyProdLocActivation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create return/sales return based on API input parameters
application/jsonIn Schema for service: createShopifyReturn request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a ShopifyShopCarrierShipment record
application/jsonIn Schema for service: createShopifyShopCarrierShipment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create a ShopifyShopLocation record
application/jsonIn Schema for service: createShopifyShopLocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create system property
application/jsonIn Schema for service: createSystemProperty request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create/Update Order Adjustment
application/jsonIn Schema for service: createUpdateOrderAdjustment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create or update a OrderAttribute
application/jsonIn Schema for service: createUpdateOrderAttribute request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create and Update email address
application/jsonIn Schema for service: createUpdatePartyEmailAddress request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create and Update telecom number
application/jsonIn Schema for service: createUpdatePartyTelecomNumber request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Creates new shipping address and update existing address
application/jsonIn Schema for service: createUpdateShippingAddress request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Shop name eg. myshop is shop name for https://myshop.myshopify.com
application/jsonIn Schema for service: createUpdateShopifyShop request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create User Search Preference
application/jsonIn Schema for service: createUserSearchPreference request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete a CarrierGeoMapping record
application/jsonIn Schema for service: deleteCarrierGeoMapping request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete an existing Carrier Shipment Box Type Record
application/jsonIn Schema for service: deleteCarrierShipmentBoxType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Deletes A CarrierShipmentMethod
application/jsonIn Schema for service: deleteCarrierShipmentMethod request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete a DataManagerMapping
application/jsonIn Schema for service: deleteDataManagerMapping request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete a Enumeration
application/jsonIn Schema for service: deleteEnumeration request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete enumeration group member
application/jsonIn Schema for service: deleteEnumerationGroupMember request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete a ExternalFulfillmentOrderItem record
application/jsonIn Schema for service: deleteExternalFulfillmentOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete a Facility Group
application/jsonIn Schema for service: deleteFacilityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete a Facility Location
application/jsonIn Schema for service: deleteFacilityLocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete an OrderAttribute record
application/jsonIn Schema for service: deleteOrderAttribute request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete Order Item Attribute
application/jsonIn Schema for service: deleteOrderItemAttribute request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete a PartyContactMech
application/jsonIn Schema for service: deletePartyContactMech request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete a Party Role (remove a Role from a Party). The logged in user must have PARTYMGR_DELETE or have permission to change the role of this partyId
application/jsonIn Schema for service: deletePartyRole request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete a ProductStoreFacilityGroup
application/jsonIn Schema for service: deleteProductStoreFacilityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete ShipmentItem
application/jsonIn Schema for service: deleteShipmentItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Deletes A ShipmentMethodType
application/jsonIn Schema for service: deleteShipmentMethodType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete a ShopifyShopCarrierShipment record
application/jsonIn Schema for service: deleteShopifyShopCarrierShipment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Delete a ShopifyShopLocation record
application/jsonIn Schema for service: deleteShopifyShopLocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
application/jsonIn Schema for service: doRateShopping request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Ensure that the party is in the specified role.
application/jsonIn Schema for service: ensurePartyRole request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Send a post request to run a DAG in airflow
application/jsonIn Schema for service: executeServiceFromAirflow request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Expire a FacilityCalendar Record
application/jsonIn Schema for service: expireFacilityCalendar request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Finds productId(s) corresponding to a product reference, productId or a GoodIdentification idValue
Service In Parameters in JSON
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Set hasLoggedOut to Y.
application/jsonIn Schema for service: forceLogout request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Address Validation Request
application/jsonIn Schema for service: gatewayShipAddressValidationRequest request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Check for shopify order to approve
application/jsonIn Schema for service: generateCustomerOrderUpdateLink request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Service for generate manifest
application/jsonIn Schema for service: generateManifests request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Service In Parameters in JSON
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Send a post request to run a DAG in airflow
Service In Parameters in JSON
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Get facilityId by identification type ID
Service In Parameters in JSON
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Returns the geoPoint for country postal code
Service In Parameters in JSON
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Get Inventory Availability for a Product constrained by a facilityId
Service In Parameters in JSON
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Get Inventory Availability for a Product constrained by a facility and location
Service In Parameters in JSON
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Get orderId by order identification type ID
Service In Parameters in JSON
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Service In Parameters in JSON
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Get Inventory Availability for a Product
Service In Parameters in JSON
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Service In Parameters in JSON
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Main method to get shipping label from Third Party Shipping Services
Service In Parameters in JSON
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Get Shopify draft order.
Service In Parameters in JSON
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Get Shopify Webhooks created from API
Service In Parameters in JSON
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Gets a single user preference. If not found for the specific userLogin, find it for the NA userlogin. If the value is DEFAULT, find the value in general.properties file.
Service In Parameters in JSON
application/jsonSuccess response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
This enhancement aims to streamline the data manager configuration process, enabling the efficient creation of multiple data objects using a single JSON file. The introduction of the importJsonListData service ensures flexibility and ease of use. This service will take the list of json data.
application/jsonIn Schema for service: importJsonListData request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
application/jsonIn Schema for service: importProductFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Service for fetching indexing instance details to Solr
application/jsonIn Schema for service: indexDeploymentData request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Service for indexing instance details to Solr recieved from API call
application/jsonIn Schema for service: indexExternalDeploymentData request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Service for indexing webhook error details to Solr
application/jsonIn Schema for service: indexWebhookErrorMessage request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Inventory update service triggers on Shopify Inventory Level Update webhook
application/jsonIn Schema for service: inventoryLevelUpdateFromShopify request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
application/jsonIn Schema for service: moveItemToParkingFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Check if fulfillment started for item and then reject it
application/jsonIn Schema for service: oldCheckAndRejectOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Reject Order Item
application/jsonIn Schema for service: oldRejectOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Reject Order Line Item
application/jsonIn Schema for service: oldRejectOrderItems request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
To import order usign csv (Either posted by script or uploaded from browser)
application/jsonIn Schema for service: orderDataSetup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
The Facility Item Allocation Service is designed to efficiently manage and allocate items within an order to specific facilities. This service is crucial for ensuring that items are moved to the appropriate ship group and that reservations are accurately performed. Below are the key functionalities of this service:
application/jsonIn Schema for service: orderFulfillmentAllocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Mark picklist bin items as Picked
application/jsonIn Schema for service: packStoreFulfillmentOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Imports picklist And Picklist Item
application/jsonIn Schema for service: picklistDataSetup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Pull And Report Entity Sync Data
application/jsonIn Schema for service: pullAndReportEntitySyncData request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Service to reship completed order items
application/jsonIn Schema for service: reShipOrderItems request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Recieve Incoming Shipment and push Inventory on Shopify
application/jsonIn Schema for service: receiveAndUpdateInventoryToShopify request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
This service is used to record inventory variance
application/jsonIn Schema for service: recordInventoryCount request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
application/jsonIn Schema for service: recordProductVariance request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Reject in progress shipment item.
application/jsonIn Schema for service: rejectFulfillmentReadyOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Reject Order Item
application/jsonIn Schema for service: rejectOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Reject Order Line Item
application/jsonIn Schema for service: rejectOrderItems request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Cancel reservations and if fulfillent started cancel shipment also.
application/jsonIn Schema for service: rejectTransferOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Service to release Order Item from one facility to another
application/jsonIn Schema for service: releaseOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Wrapper Service For Removing Category Products
application/jsonIn Schema for service: removeCategoryProducts request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Remove firebase client registration token
application/jsonIn Schema for service: removeClientRegistrationToken request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Remove Facility From FacilityGroup
application/jsonIn Schema for service: removeFacilityFromGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Removing association of a Party from Facility
application/jsonIn Schema for service: removePartyFromFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
application/jsonIn Schema for service: removePartyUserPermission request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Remove existing webhook on Shopify
application/jsonIn Schema for service: removeShopifyWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Reset Password
application/jsonIn Schema for service: resetPassword request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Reset all pickers on picklist.
application/jsonIn Schema for service: resetPicker request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Send order Webhook message using Webhook Config.
application/jsonIn Schema for service: sendOrderWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Send a pickup scheduled notification for all type of shipment.
application/jsonIn Schema for service: sendPickupScheduledNotification request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Send a ready to pick up item notification for STOREPICKUP type
application/jsonIn Schema for service: sendReadyToPickupItemNotification request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
This service will create/update preferred store(default facility) of a customer
application/jsonIn Schema for service: setCustomerDefaultStore request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Set/update Reason Id on Return Item
application/jsonIn Schema for service: setReasonIdOnReturnItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Sets a single user preference.
application/jsonIn Schema for service: setUserPreference request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Shop name eg. myshop is shop name for https://myshop.myshopify.com
application/jsonIn Schema for service: setupShopifyShop request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create association of store with a calendar
application/jsonIn Schema for service: storeCalendarAssocDataSetup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Store firebase client registration token
application/jsonIn Schema for service: storeClientRegistrationToken request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Run Entity Sync
application/jsonIn Schema for service: storeEntitySyncData request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Subscribe order cancel webhook on Shopify
application/jsonIn Schema for service: subscribeCancelOrderShopifyWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Subscribe order create webhook on Shopify
application/jsonIn Schema for service: subscribeCreateOrderShopifyWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Subscribe file status update webhook on Shopify
application/jsonIn Schema for service: subscribeFileStatusUpdateWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Subscribe order paid webhook on Shopify
application/jsonIn Schema for service: subscribeOrderPaidWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Subscribe order return webhook on Shopify
application/jsonIn Schema for service: subscribeReturnOrderShopifyWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Subscribe webhook on Shopify
application/jsonIn Schema for service: subscribeShopifyWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Subscribe Topic
application/jsonIn Schema for service: subscribeTopic request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Test service
application/jsonIn Schema for service: testCommit request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
application/jsonIn Schema for service: testError request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Test service
application/jsonIn Schema for service: testRollback request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Test service
application/jsonIn Schema for service: testScv request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Send a post request to run a DAG in airflow
application/jsonIn Schema for service: triggerDag request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
This service unlinks return from the order, It won't delete the data from the entities.
application/jsonIn Schema for service: unlinkReturnFromOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Unlock order item in a bin
application/jsonIn Schema for service: unlockStoreFulfillmentOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
unsubscribe webhook on Shopify
application/jsonIn Schema for service: unsubscribeShopifyWebhook request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Unsubscribe Topic
application/jsonIn Schema for service: unsubscribeTopic request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Updating all the orderItems, if the orderItemSeqId not provided in context.
application/jsonIn Schema for service: updateAllOrderItems request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a CarrierGeoMapping record
application/jsonIn Schema for service: updateCarrierGeoMapping request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Updates A CarrierShipmentMethod
application/jsonIn Schema for service: updateCarrierShipmentMethod request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
update a DataManagerConfig
application/jsonIn Schema for service: updateDataManagerConfig request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a DataManagerMapping
application/jsonIn Schema for service: updateDataManagerMapping request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a Enumeration
application/jsonIn Schema for service: updateEnumeration request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update enumeration group member
application/jsonIn Schema for service: updateEnumerationGroupMember request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Bulk Update Facility -> Group Member
application/jsonIn Schema for service: updateFacilitiesToGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a Facility
application/jsonIn Schema for service: updateFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a FacilityContactMech
application/jsonIn Schema for service: updateFacilityContactMech request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update an Email Address
application/jsonIn Schema for service: updateFacilityEmailAddress request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a Facility Group
application/jsonIn Schema for service: updateFacilityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a FacilityIdentification
application/jsonIn Schema for service: updateFacilityIdentification request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a Facility Location
application/jsonIn Schema for service: updateFacilityLocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a Postal Address
application/jsonIn Schema for service: updateFacilityPostalAddress request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a Telecommunications Number
application/jsonIn Schema for service: updateFacilityTelecomNumber request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update Facility -> Group Member
application/jsonIn Schema for service: updateFacilityToGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Service to sync inventory from file provided by external systems
application/jsonIn Schema for service: updateInventoryByIdentification request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update JobSandbox record
application/jsonIn Schema for service: updateJobSandbox request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Atomic updates OISGIR Solr document for rejected item.
application/jsonIn Schema for service: updateOISGIRIFulfillmentStatus request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
This service will update the Shipping Address of the order based on city/state (Any field present in PostalAddress) with mapping from CarrierGeoMapping entity
application/jsonIn Schema for service: updateOrderAddressAndAppendAttributes request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update an OrderAttribute record
application/jsonIn Schema for service: updateOrderAttribute request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update Order Item
application/jsonIn Schema for service: updateOrderItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update Order Item Attribute
application/jsonIn Schema for service: updateOrderItemAttribute request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Sync Order Items (Shopify --> HC)
application/jsonIn Schema for service: updateOrderItemFromShopify request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Updates OrderItemShipGroup. The shipmentMethod field is of the format ${shipmentMethodTypeId}@${carrierPartyId}
application/jsonIn Schema for service: updateOrderItemShipGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update OrderPayemntPreference
application/jsonIn Schema for service: updateOrderPaymentPreferenceV2 request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a PartyGroup
application/jsonIn Schema for service: updatePartyGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a Relationship between two Parties; if partyIdFrom is not specified the partyId of the current userLogin will be used; if roleTypeIds are not specified they will default to "NA". If a partyIdFrom is passed in, it will be used if the userLogin has PARTYMGR_REL_UPDATE permission.
application/jsonIn Schema for service: updatePartyRelationship request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a Person
application/jsonIn Schema for service: updatePerson request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a PostalAddress.
application/jsonIn Schema for service: updatePostalAddressContactMech request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a Product Store
application/jsonIn Schema for service: updateProductStore request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a ProductStoreFacility
application/jsonIn Schema for service: updateProductStoreFacility request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a ProductStoreFacilityGroup
application/jsonIn Schema for service: updateProductStoreFacilityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a Product Store Role
application/jsonIn Schema for service: updateProductStoreRole request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a ProductStoreSetting
application/jsonIn Schema for service: updateProductStoreSetting request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a Product Store Shipment Method
application/jsonIn Schema for service: updateProductStoreShipMeth request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Create Order Data based on API input parameters
application/jsonIn Schema for service: updateSalesOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update Search Preference
application/jsonIn Schema for service: updateSearchPreference request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a SecurityGroup
application/jsonIn Schema for service: updateSecurityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a SecurityPermission from a SecurityGroup
application/jsonIn Schema for service: updateSecurityPermissionToSecurityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update Shipping Information on Order View
application/jsonIn Schema for service: updateShipGroupShipInfo request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update Shipment
application/jsonIn Schema for service: updateShipment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a ShipmentBoxType record
application/jsonIn Schema for service: updateShipmentBoxType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update ShipmentItem
application/jsonIn Schema for service: updateShipmentItem request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Updates A ShipmentMethodType
application/jsonIn Schema for service: updateShipmentMethodType request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update ShipmentPackageRouteSeg
application/jsonIn Schema for service: updateShipmentPackageRouteSeg request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update ShipmentRouteSegment
application/jsonIn Schema for service: updateShipmentRouteSegment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
This service create or update the party shipping address, updates shipping address of ShipGroup and its shipments and clears Online rates fetched for the shipment.
application/jsonIn Schema for service: updateShippingInformationOfShipGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update Shopify draft order.
application/jsonIn Schema for service: updateShopifyDraftOrder request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Creates a ShopifyProdLocActivation record
application/jsonIn Schema for service: updateShopifyProdLocActivation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a ShopifyShopCarrierShipment record
application/jsonIn Schema for service: updateShopifyShopCarrierShipment request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a ShopifyShopLocation record
application/jsonIn Schema for service: updateShopifyShopLocation request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update system property
application/jsonIn Schema for service: updateSystemProperty request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
First disable all userLogins, then enable the requested one.
application/jsonIn Schema for service: updateUserLoginStatus request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update a UserLogin to SecurityGroup Appl
application/jsonIn Schema for service: updateUserLoginToSecurityGroup request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Update Search Preference
application/jsonIn Schema for service: updateUserSearchPreference request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Upload And Import File
application/jsonIn Schema for service: uploadAndImportFile request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
application/jsonIn Schema for service: uploadPartyLogoImage request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
Main method to void shipping label from Third Party Shipping Services
application/jsonIn Schema for service: voidShipmentLabel request
Success response for the API call.
Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.
Unauthorized: Access is denied due to invalid or absent Authorization header.
Forbidden: Insufficient rights to perform this API call.
Method Not Allowed: Service called with HTTP method other than the declared one.
Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.
POST /rest/auth/token HTTP/1.1
Host: 10.106.39.100:443
Authorization: Basic username:password
Accept: */*
Success response for the API call.
Success response for the API call.
Success response for the API call.
Success response for the API call.
Success response for the API call.
Success response for the API call.
Success response for the API call.
- Item Allocation: Allocates items to a specified facility within an order.
- Add Auto Cancel Date: Set a specific date when an order item should be automatically canceled if not processed.
- Remove Auto Cancel Date: If an order item no longer requires an automatic cancellation, you can easily remove the set auto cancel date.
- Ship Group Management: Moves items to the appropriate ship group as per allocation.
- Item Reservation: Executes reservation of items as part of the allocation process.
- Error Handling: Throws an error if an item is found in a non-virtual facility or encounters any other error condition. Conversely, it returns a success response if an item is already allocated to the specified facility.
Input Parameters:
The service accepts the following input parameters for processing:
- orderId: The unique identifier of the order for which allocation is being performed.
- externalOrderId: An optional external ID associated with the order.
- facilityAllocation: A collection of objects detailing the allocation of items to specific facilities. Each object in this array includes:
- facilityId: Identifier of the facility to which items are being allocated.
- facilityExternalId: An optional external ID for the facility.
- items: A list of item objects, each comprising:
- orderItemSeqId: Sequence ID of the order item.
- autoCancelDate: An optional date when an order item should be automatically canceled if not processed.
- clearAutoCancelDate: Allows you to remove the auto cancel date set on an order item
- orderItemExternalId: An optional external ID for the order item.
- quantity: Number of units of the item to allocate.
Sample JSON Input:
json
```
{
"orderId": "105",
"externalOrderId": "",
"facilityAllocation": [
{
"facilityId": "1",
"items": [
{
"orderItemSeqId": "00101",
"quantity": 1
},
{
"orderItemSeqId": "00102",
"quantity": 1
}
]
},
{
"facilityId": "10",
"items": [
{
"orderItemSeqId": "00103",
"orderItemExternalId": "",
"quantity": 1
}
]
}
]
}
```
Service Operation:
Upon receiving the input parameters, the service will:
- Validate all input data for correctness and completeness.
- Check the current facility status of each item.
- Allocate items to the specified facilities as per the input.
- Perform necessary item reservations.
- Return a success response if an item is already allocated to the specified facility.
- In cases where an item is located in a virtual facility or if other error conditions arise, the service will throw an error.
This service ensures streamlined and error-free allocation of items to facilities, enhancing the efficiency of order processing and fulfillment.{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"productId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shipmentRouteSegmentId": "text",
"shipmentId": "text",
"shipmentPackageSeqId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"allocatedShipGroupSeqId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderItemSeqId": "text",
"orderId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"oldStatusId": "text",
"orderStatusId": "text",
"statusId": "text",
"orderId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shipmentIds": [
"text"
]
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"calendarId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"statusId": "text",
"cancelDateTime": "2025-12-09"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"oldStatusId": "text",
"orderStatusId": "text",
"grandTotal": 1,
"orderTypeId": "text",
"needsInventoryIssuance": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"partyId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"communicationEventId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"configId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"mappingPrefId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"enumId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"facilityId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"facilityGroupId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"locationSeqId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shipmentId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"currentCompany": {},
"userPrefValue": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"returnId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"partyId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"productStoreShipMethId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shipmentId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"partyId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"payLoad": {
"externalId": "text",
"note": "text",
"returnPaymentPref": [
{
"orderId": "text",
"orderExternalId": "text",
"paymentMethodTypeId": "text",
"statusId": "text",
"manualRefNum": "text",
"parentRefNum": "text",
"maxAmount": 1,
"presentmentAmount": 1,
"presentmentCurrency": "text"
}
],
"tags": [],
"type": "text",
"createdDate": "text",
"returnDate": "text",
"customerId": "text",
"customerExternalId": "text",
"customerIdentificationType": "text",
"customerIdentificationValue": "text",
"companyId": "text",
"companyExternalId": "text",
"status": "text",
"currencyCode": "text",
"grandTotal": 1,
"returnIdentifications": [
{
"returnIdentificationTypeId": "text",
"returnIdentificationDesc": "text",
"idValue": "text"
}
],
"shipFrom": {
"postalAddress": {
"id": "text",
"externalId": "text"
}
},
"shipTo": {
"facilityId": "text"
},
"items": [
{
"id": "text",
"sku": "text",
"itemExternalId": "text",
"itemSeqId": "text",
"itemTypeId": "text",
"status": "text",
"orderId": "text",
"orderExternalId": "text",
"orderItemSeqId": "text",
"quantity": 1,
"reason": "text",
"returnType": "text",
"restockType": "text",
"price": 1,
"includeAdjustments": "text",
"itemAdjustments": [
{
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
],
"returnAdjustment": [
{
"orderId": "text",
"orderExternalId": "text",
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"searchPrefId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shipmentBoxTypeId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shipmentItemSeqId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"receiptId": "text",
"affectAccounting": true
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"isFulfilled": "text",
"orderId": "text",
"autoApproveOrder": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shopifyLocationId": "text",
"shopId": "text",
"shopifyProductId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"payLoad": {
"externalId": "text",
"note": "text",
"returnPaymentPref": [
{
"orderId": "text",
"orderExternalId": "text",
"paymentMethodTypeId": "text",
"statusId": "text",
"manualRefNum": "text",
"parentRefNum": "text",
"maxAmount": 1,
"presentmentAmount": 1,
"presentmentCurrency": "text"
}
],
"tags": [],
"type": "text",
"createdDate": "text",
"returnDate": "text",
"customerId": "text",
"customerExternalId": "text",
"customerIdentificationType": "text",
"customerIdentificationValue": "text",
"companyId": "text",
"companyExternalId": "text",
"status": "text",
"currencyCode": "text",
"grandTotal": 1,
"returnIdentifications": [
{
"returnIdentificationTypeId": "text",
"returnIdentificationDesc": "text",
"idValue": "text"
}
],
"shipFrom": {
"postalAddress": {
"id": "text",
"externalId": "text"
}
},
"shipTo": {
"facilityId": "text"
},
"items": [
{
"id": "text",
"sku": "text",
"itemExternalId": "text",
"itemSeqId": "text",
"itemTypeId": "text",
"status": "text",
"orderId": "text",
"orderExternalId": "text",
"orderItemSeqId": "text",
"quantity": 1,
"reason": "text",
"returnType": "text",
"restockType": "text",
"price": 1,
"includeAdjustments": "text",
"itemAdjustments": [
{
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
],
"returnAdjustment": [
{
"orderId": "text",
"orderExternalId": "text",
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shopifyShippingMethod": "text",
"shopId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"facilityId": "text",
"shopId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"systemResourceId": "text",
"systemPropertyId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"emailAddress": "text",
"contactMechId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shopId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"url": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"userPrefMap": {}
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderItemSeqId": "text",
"orderId": "text",
"payload": {},
"rejectedItemsList": [
"text"
]
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderId": "text",
"payload": {},
"rejectedItemsList": [
"text"
]
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"picklistId": "text",
"picklistBinId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"valuesToStore": [
"text"
],
"keysToRemove": [
"text"
],
"valuesToCreate": [
"text"
],
"startDate": "2025-12-09"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"originalOrderId": "text",
"orderId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderItemSeqId": "text",
"orderId": "text",
"payload": {},
"rejectedItemsList": [
"text"
]
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderId": "text",
"payload": {},
"rejectedItemsList": [
"text"
]
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shipGroupSeqId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"userLoginId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"updatedUserLogin": {
"lastUpdatedStamp": "2025-12-09",
"isExternal": "text",
"passwordHint": "text",
"createdTxStamp": "2025-12-09",
"createdStamp": "2025-12-09",
"externalAuthId": "text",
"lastUpdatedTxStamp": "2025-12-09",
"lastTimeZone": "text",
"enabled": "text",
"lastLocale": "text",
"currentPassword": "text",
"userLoginId": "text",
"isSystem": "text",
"disabledDateTime": "2025-12-09",
"disabledBy": "text",
"hasLoggedOut": "text",
"userLdapDn": "text",
"requirePasswordChange": "text",
"lastCurrencyUom": "text",
"partyId": "text"
}
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shopifyConfigId": "text",
"shopId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"toStoreUpdated": 1,
"toCreateInserted": 1,
"toCreateUpdated": 1,
"toCreateNotUpdated": 1,
"toRemoveAlreadyDeleted": 1,
"toStoreNotUpdated": 1,
"toRemoveDeleted": 1,
"toStoreInserted": 1
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"webhook": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"webhook": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"webhook": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"webhook": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"configId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"contactMechId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"order": {
"id": "text",
"externalId": "text",
"channel": "text",
"customerId": "text",
"customerExternalId": "text",
"priority": "text",
"orderDate": "text",
"entryDate": "text",
"expireDate": "text",
"statusId": "text",
"productStoreId": "text",
"currencyCode": "text",
"remainingSubTotal": 1,
"grandTotal": 1,
"shipGroup": [
{
"facilityId": "text",
"externalId": "text",
"maySplit": "text",
"shipBy": "text",
"shipAfter": "text",
"carrierPartyId": "text",
"trackingNumber": "text",
"shipTo": {
"postalAddress": {
"id": "text",
"externalId": "text"
},
"email": {
"id": "text",
"externalId": "text"
},
"phoneNumber": {
"id": "text",
"externalId": "text"
}
},
"items": [
{
"itemSeqId": "text",
"productId": "text",
"sku": "text",
"status": "text",
"quantity": 1,
"unitListPrice": 1,
"unitPrice": 1,
"itemAdjustments": [
{
"id": "text",
"type": "text",
"comments": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
]
}
],
"orderAdjustments": [
{
"id": "text",
"type": "text",
"comments": "text",
"amount": 1,
"sourcePercentage": 1
}
],
"orderPaymentPref": [
{
"id": "text",
"paymentMethodTypeId": "text",
"paymentMode": "text",
"cardName": "text",
"code": "text",
"maxAmount": 1,
"statusId": "text"
}
],
"billTo": {
"postalAddress": {
"id": "text",
"externalId": "text"
},
"email": {
"id": "text",
"externalId": "text"
},
"phoneNumber": {
"id": "text",
"externalId": "text"
}
}
}
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"oldStatusId": "text",
"oldPrimaryOrderId": "text",
"oldOriginFacilityId": "text",
"shipmentId": "text",
"shipmentTypeId": "text",
"picklistBinId": "text",
"shipmentMethodTypeId": "text",
"oldPrimaryShipGroupSeqId": "text",
"oldDestinationFacilityId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"newContactMechId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"shopifyLocationId": "text",
"shopId": "text",
"shopifyProductId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"uploadFileContentId": "text",
"configId": "text",
"filePath": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"partyId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}POST /rest/services/addCategoryProducts HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97
{
"fromDate": "2025-12-09",
"productCategoryId": "text",
"productId": [
"text"
],
"thruDate": "2025-12-09"
}POST /rest/services/addDataToSearchIndex HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"updateHandler": "text",
"data": [
"text"
],
"coreName": "text"
}POST /rest/services/addFacilitiesToGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"payload": {}
}POST /rest/services/addFacilityToGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 110
{
"fromDate": "2025-12-09",
"facilityId": "text",
"sequenceNum": 1,
"facilityGroupId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/addPartyToFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"fromDate": "2025-12-09",
"roleTypeId": "text",
"facilityId": "text",
"partyId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/addPartyUserPermission HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"userLoginId": "text",
"groupIds": [
"text"
]
}POST /rest/services/addProductToFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 301
{
"allowPickup": "text",
"reorderPoint": 1,
"facilityId": "text",
"productId": "text",
"salesVelocity": 1,
"allowBrokering": "text",
"reorderQuantity": 1,
"inventoryItemId": "text",
"lastInventoryCount": 1,
"computedLastInventoryCount": 1,
"minimumStock": 1,
"requirementMethodEnumId": "text",
"maximumStock": 1,
"daysToShip": 1
}POST /rest/services/addSecurityGroupToUserLogin HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"securityGroupId": "text",
"partyIdTo": "text"
}POST /rest/services/addSecurityPermissionToSecurityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88
{
"fromDate": "2025-12-09",
"permissionId": "text",
"groupId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/addShipmentPackage HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 204
{
"carrierPartyId": "text",
"boxLength": "text",
"dimensionUomId": "text",
"boxNumber": "text",
"boxHeight": "text",
"boxWidth": "text",
"picklistBinId": "text",
"shipmentBoxTypeId": "text",
"shipmentMethodTypeId": "text"
}POST /rest/services/addUserLoginToSecurityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"fromDate": "2025-12-09",
"userLoginId": "text",
"groupId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/allocateOrderItemToFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 340
{
"orderItemSeqId": "text",
"clearAutoCancelDate": true,
"comments": "text",
"facilityId": "text",
"suggestedShipMethodTypeId": "text",
"orderId": "text",
"autoCancelDate": "2025-12-09",
"routingRuleId": "text",
"toShipGroupSeqId": "text",
"routingGroupId": "text",
"routingRule": "text",
"orderRoutingId": "text",
"changeReasonEnumId": "text",
"routingRunId": "text"
}POST /rest/services/appendOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 496
{
"amount": 1,
"itemAttributesMap": {},
"quantity": 1,
"productId": "text",
"orderId": "text",
"overridePrice": "text",
"autoCancelDate": "2025-12-09",
"offInvoicePrice": 1,
"disableResetGrandTotal": true,
"quantityUomId": "text",
"shipAmount": 1,
"shipGroupSeqId": "text",
"surveyResponses": [
"text"
],
"unitListPrice": 1,
"changeComments": "text",
"calcTax": true,
"discountMode": "text",
"itemDesiredDeliveryDate": "2025-12-09",
"reasonEnumId": "text",
"discountValue": 1,
"orderItemTypeId": "text",
"basePrice": 1,
"prodCatalogId": "text"
}POST /rest/services/approveSalesOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"orderId": "text",
"confirmApprove": "text"
}POST /rest/services/bulkAdjustInventoryLevelOnShopify HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"adjustInventoryList": [
"text"
],
"shopifyConfigId": "text",
"facilityId": "text"
}POST /rest/services/bulkApproveTransferOrders HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"bufferTime": 1,
"orderIds": [
"text"
]
}POST /rest/services/bulkPackStoreFulfillmentOrders HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"shipmentIds": [
"text"
]
}POST /rest/services/bulkRejectStoreInProgressOrders HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"facilityId": "text",
"reasonId": "text",
"productStoreId": "text"
}POST /rest/services/bulkRejectStoreOutstandingOrders HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"facilityId": "text",
"reasonId": "text",
"productStoreId": "text"
}POST /rest/services/bulkShipOrders HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"shipmentId": [
"text"
]
}POST /rest/services/calendarDataSetup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 401
{
"sundayCapacity": "text",
"thursdayCapacity": "text",
"wednesdayStartTime": "text",
"wednesdayCapacity": "text",
"tuesdayStartTime": "text",
"fridayStartTime": "text",
"description": "text",
"saturdayCapacity": "text",
"mondayCapacity": "text",
"mondayStartTime": "text",
"calendarId": "text",
"saturdayStartTime": "text",
"thursdayStartTime": "text",
"sundayStartTime": "text",
"fridayCapacity": "text",
"tuesdayCapacity": "text"
}POST /rest/services/cancelOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 140
{
"orderItemSeqId": "text",
"itemReasonMap": {},
"orderId": "text",
"itemCommentMap": {},
"itemQtyMap": {},
"shipGroupSeqId": "text",
"cancelQuantity": 1
}POST /rest/services/cancelOrderItems HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"itemReasonMap": {},
"orderId": "text",
"cancelableItemMap": {},
"shipGrpItemQtyMap": {}
}POST /rest/services/cancelSalesOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"changeReason": "text",
"orderId": "text"
}POST /rest/services/cancelScheduledJob HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"jobId": "text"
}POST /rest/services/changeOrderItemStatus HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 162
{
"orderItemSeqId": "text",
"changeReason": "text",
"statusId": "text",
"orderId": "text",
"statusDateTime": "2025-12-09",
"fromStatusId": "text",
"changeReasonEnumId": "text"
}POST /rest/services/changeOrderStatus HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"setItemStatus": "text",
"changeReason": "text",
"statusId": "text",
"orderId": "text",
"changeReasonEnumId": "text"
}POST /rest/services/checkAndRejectOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 146
{
"orderItemSeqId": "text",
"excludeOrderFacilityDuration": "text",
"orderId": "text",
"rejectionComments": "text",
"rejectionReason": "text",
"notify": true
}POST /rest/services/checkAttributesAndApproveOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"orderId": "text",
"attributes": {}
}POST /rest/services/clearAllEntityCaches HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"distribute": true
}POST /rest/services/clearCacheLineByCondition HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"entityName": "text",
"distribute": true
}POST /rest/services/clearCacheLineByDummyPK HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"distribute": true
}POST /rest/services/clearCacheLineByPrimaryKey HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"distribute": true,
"primaryKey": {}
}POST /rest/services/clearCacheLineByValue HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"distribute": true
}POST /rest/services/createCarrierShipmentBoxType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123
{
"packagingTypeCode": "text",
"oversizeCode": "text",
"partyId": "text",
"shipmentBoxTypeId": "text",
"pickupContainerCode": "text"
}POST /rest/services/createCarrierShipmentMethod HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132
{
"sequenceNumber": 1,
"roleTypeId": "text",
"deliveryDays": 1,
"partyId": "text",
"carrierServiceCode": "text",
"shipmentMethodTypeId": "text"
}POST /rest/services/createCommercePartyRelationshipFrom HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 138
{
"roleTypeIdTo": "text",
"partyRelationshipTypeId": "text",
"partyIdFrom": "text",
"statusId": "text",
"partyIdTo": "text",
"roleTypeIdFrom": "text"
}POST /rest/services/createCommunicationEvent HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 787
{
"workEffortId": "text",
"note": "text",
"partyIdFrom": "text",
"orderId": "text",
"ccString": "text",
"subject": "text",
"contactMechTypeId": "text",
"communicationEventTypeId": "text",
"content": "text",
"contentMimeTypeId": "text",
"datetimeStarted": "2025-12-09",
"returnId": "text",
"contactListId": "text",
"action": "text",
"custRequestId": "text",
"contactMechIdFrom": "text",
"reasonEnumId": "text",
"roleTypeIdTo": "text",
"productId": "text",
"entryDate": "2025-12-09",
"parentCommEventId": "text",
"systemMessageRemoteId": "text",
"datetimeEnded": "2025-12-09",
"externalId": "text",
"messageId": "text",
"origCommEventId": "text",
"roleTypeIdFrom": "text",
"contactMechIdTo": "text",
"headerString": "text",
"statusId": "text",
"communicationEventId": "text",
"bccString": "text",
"toString": "text",
"partyIdTo": "text",
"fromString": "text"
}POST /rest/services/createCommunicationEventOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"orderId": "text",
"communicationEventId": "text"
}POST /rest/services/createDataManagerConfig HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 381
{
"importPath": "text",
"exportServiceScreenLocation": "text",
"exportServiceScreenName": "text",
"importServiceName": "text",
"fileNamePattern": "text",
"multiThreading": "text",
"description": "text",
"priority": 1,
"exportPath": "text",
"exportContentId": "text",
"notifyOnFailure": "text",
"delimiter": "text",
"configId": "text",
"exportServiceName": "text",
"scriptTitle": "text",
"executionModeId": "text"
}POST /rest/services/createDataManagerMapping HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 154
{
"fromDate": "2025-12-09",
"mappingPrefName": "text",
"mappingPrefTypeEnumId": "text",
"mappingPrefId": "text",
"mappingPrefValue": "text",
"thruDate": "2025-12-09"
}POST /rest/services/createEnumeration HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 165
{
"enumTypeId": "text",
"enumId": "text",
"sequenceNum": 1,
"enumCode": "text",
"primaryEnumerationGroupId": "text",
"description": "text",
"enumName": "text",
"sequenceId": "text"
}POST /rest/services/createEnumerationGroupMember HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116
{
"fromDate": "2025-12-09",
"enumerationId": "text",
"sequenceNum": 1,
"enumerationGroupId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/createExcludedOrderFacilityForOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101
{
"externalOrderFacilityId": "text",
"orderId": "text",
"externalOrderId": "text",
"orderFacilityId": "text"
}POST /rest/services/createFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 571
{
"facilityId": "text",
"defaultInventoryItemTypeId": "text",
"parentFacilityId": "text",
"postalCode": "text",
"externalId": "text",
"description": "text",
"defaultWeightUomId": "text",
"primaryFacilityGroupId": "text",
"openedDate": "2025-12-09",
"ownerPartyId": "text",
"facilityTimeZone": "text",
"facilitySize": 1,
"closedDate": "2025-12-09",
"facilitySizeUomId": "text",
"maximumOrderLimit": 1,
"closeTime": "text",
"defaultDaysToShip": 1,
"facilityTypeId": "text",
"defaultDimensionUomId": "text",
"productStoreId": "text",
"facilityName": "text",
"openTime": "text",
"geoPointId": "text",
"oldSquareFootage": 1
}POST /rest/services/createFacilityCalendar HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121
{
"fromDate": "2025-12-09",
"facilityId": "text",
"calendarId": "text",
"facilityCalendarTypeId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/createFacilityContactMech HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 230
{
"fromDate": "2025-12-09",
"extension": "text",
"comments": "text",
"facilityId": "text",
"infoString": "text",
"contactMechPurposeTypeId": "text",
"externalId": "text",
"contactMechTypeId": "text",
"contactMechId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/createFacilityEmailAddress HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 252
{
"fromDate": "2025-12-09",
"emailAddress": "text",
"extension": "text",
"comments": "text",
"facilityId": "text",
"infoString": "text",
"contactMechPurposeTypeId": "text",
"externalId": "text",
"contactMechTypeId": "text",
"contactMechId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/createFacilityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"primaryParentGroupId": "text",
"facilityGroupTypeId": "text",
"facilityGroupId": "text",
"description": "text",
"facilityGroupName": "text"
}POST /rest/services/createFacilityIdentification HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114
{
"fromDate": "2025-12-09",
"facilityId": "text",
"idValue": "text",
"facilityIdenTypeId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/createFacilityLocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 222
{
"nextCountDate": "text",
"lastCountDate": "text",
"facilityId": "text",
"areaId": "text",
"positionId": "text",
"isLocked": "text",
"levelId": "text",
"sectionId": "text",
"geoPointId": "text",
"locationTypeEnumId": "text",
"aisleId": "text"
}POST /rest/services/createFacilityPostalAddress HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 601
{
"houseNumberExt": "text",
"extension": "text",
"city": "text",
"latitude": "text",
"postalCodeGeoId": "text",
"postalCode": "text",
"houseNumber": 1,
"postalCodeExt": "text",
"contactMechId": "text",
"attnName": "text",
"countyGeoId": "text",
"toName": "text",
"paymentMethodId": "text",
"cityGeoId": "text",
"longitude": "text",
"countryGeoId": "text",
"comments": "text",
"facilityId": "text",
"address2": "text",
"address1": "text",
"encodedAddressKey": "text",
"thruDate": "2025-12-09",
"fromDate": "2025-12-09",
"contactMechPurposeTypeId": "text",
"directions": "text",
"municipalityGeoId": "text",
"stateProvinceGeoId": "text",
"geoPointId": "text"
}POST /rest/services/createFacilityTelecomNumber HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 245
{
"fromDate": "2025-12-09",
"askForName": "text",
"areaCode": "text",
"extension": "text",
"comments": "text",
"facilityId": "text",
"contactMechPurposeTypeId": "text",
"countryCode": "text",
"contactNumber": "text",
"contactMechId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/createGcFulFillmentRecord HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 237
{
"referenceNum": "text",
"orderItemSeqId": "text",
"amount": 1,
"authCode": "text",
"orderId": "text",
"merchantId": "text",
"pinNumber": "text",
"typeEnumId": "text",
"surveyResponseId": "text",
"partyId": "text",
"cardNumber": "text",
"responseCode": "text"
}POST /rest/services/createIncomingShipment HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"payload": {}
}POST /rest/services/createNewUserLoginAndSetUserPreference HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 290
{
"userLoginId": "text",
"userPrefGroupTypeId": "text",
"passwordHint": "text",
"userPrefValue": "text",
"currentPasswordVerify": "text",
"externalAuthId": "text",
"requirePasswordChange": "text",
"userPrefTypeId": "text",
"partyId": "text",
"userPrefLoginId": "text",
"enabled": "text",
"currentPassword": "text"
}POST /rest/services/createOISGIRIndex HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129
{
"inventoryItemId": "text",
"orderItemSeqId": "text",
"orderId": "text",
"shipmentId": "text",
"tenantId": "text",
"shipGroupSeqId": "text"
}POST /rest/services/createOrderAppeasement HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"orderId": "text",
"appeasementAmount": 1,
"itemAmountMap": {}
}POST /rest/services/createOrderAttribute HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"orderId": "text",
"attrDescription": "text",
"attrValue": "text",
"attrName": "text"
}POST /rest/services/createOrderIndex HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60
{
"orderItemSeqId": "text",
"orderId": "text",
"tenantId": "text"
}POST /rest/services/createOrderItemAttribute HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104
{
"orderItemSeqId": "text",
"orderId": "text",
"attrDescription": "text",
"attrValue": "text",
"attrName": "text"
}POST /rest/services/createPartyGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 331
{
"pdfLogoImageUrl": "text",
"comments": "text",
"externalId": "text",
"description": "text",
"tickerSymbol": "text",
"logoImageUrl": "text",
"partyTypeId": "text",
"groupName": "text",
"groupNameLocal": "text",
"statusId": "text",
"numEmployees": 1,
"preferredCurrencyUomId": "text",
"ranking": 1,
"partyId": "text",
"annualRevenue": 1,
"officeSiteName": "text"
}POST /rest/services/createPostalAddress HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 427
{
"countryGeoId": "text",
"houseNumberExt": "text",
"city": "text",
"address2": "text",
"address1": "text",
"latitude": 1,
"postalCodeGeoId": "text",
"postalCode": "text",
"encodedAddressKey": "text",
"houseNumber": 1,
"postalCodeExt": "text",
"contactMechId": "text",
"attnName": "text",
"countyGeoId": "text",
"directions": "text",
"toName": "text",
"cityGeoId": "text",
"municipalityGeoId": "text",
"stateProvinceGeoId": "text",
"geoPointId": "text",
"longitude": 1
}POST /rest/services/createProductFacilityLocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114
{
"facilityId": "text",
"productId": "text",
"moveQuantity": 1,
"minimumStock": 1,
"maximumStock": 1,
"locationSeqId": "text"
}POST /rest/services/createProductIndex HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"productId": "text",
"indexVariants": true,
"tenantId": "text"
}POST /rest/services/createProductStoreFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"fromDate": "2025-12-09",
"facilityId": "text",
"sequenceNum": 1,
"productStoreId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/createProductStoreFacilityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 117
{
"fromDate": "2025-12-09",
"sequenceNumber": 1,
"facilityGroupId": "text",
"productStoreId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/createProductStoreRole HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126
{
"fromDate": "2025-12-09",
"roleTypeId": "text",
"sequenceNum": 1,
"productStoreId": "text",
"partyId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/createProductStoreSetting HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"settingValue": "text",
"productStoreId": "text",
"settingTypeEnumId": "text"
}POST /rest/services/createProductStoreShipMeth HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 734
{
"companyPartyId": "text",
"productStoreShipMethId": "text",
"allowancePercent": 1,
"shipmentCustomMethodId": "text",
"includeFeatureGroup": "text",
"minTotal": 1,
"minWeight": 1,
"requireCompanyAddr": "text",
"maxSize": 1,
"excludeGeoId": "text",
"isShippingWeightRequired": "text",
"shipmentGatewayConfigId": "text",
"minSize": 1,
"allowCompanyAddr": "text",
"productStoreId": "text",
"minimumPrice": 1,
"partyId": "text",
"shipmentMethodTypeId": "text",
"excludeFeatureGroup": "text",
"sequenceNumber": 1,
"roleTypeId": "text",
"allowUspsAddr": "text",
"maxWeight": 1,
"serviceName": "text",
"thruDate": "2025-12-09",
"fromDate": "2025-12-09",
"includeGeoId": "text",
"maxTotal": 1,
"requireUspsAddr": "text",
"configProps": "text",
"includeNoChargeItems": "text",
"isTrackingRequired": "text"
}POST /rest/services/createPurchaseShipment HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"facilityId": "text",
"orderId": "text",
"shipGroupSeqId": "text"
}POST /rest/services/createRelationship HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 426
{
"roleTypeIdTo": "text",
"partyIdFrom": "text",
"lastName": "text",
"extension": "text",
"phoneContactMechPurpose": "text",
"externalId": "text",
"roleTypeIdFrom": "text",
"thruDate": "2025-12-09",
"fromDate": "2025-12-09",
"partyRelationshipTypeId": "text",
"firstName": "text",
"partyTypeId": "text",
"emailAddress": "text",
"groupName": "text",
"statusId": "text",
"preferredCurrencyUomId": "text",
"emailContactMechPurpose": "text",
"contactNumber": "text"
}POST /rest/services/createReturn HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1310
{
"payLoad": {
"externalId": "text",
"note": "text",
"returnPaymentPref": [
{
"orderId": "text",
"orderExternalId": "text",
"paymentMethodTypeId": "text",
"statusId": "text",
"manualRefNum": "text",
"parentRefNum": "text",
"maxAmount": 1,
"presentmentAmount": 1,
"presentmentCurrency": "text"
}
],
"tags": [],
"type": "text",
"createdDate": "text",
"returnDate": "text",
"customerId": "text",
"customerExternalId": "text",
"customerIdentificationType": "text",
"customerIdentificationValue": "text",
"companyId": "text",
"companyExternalId": "text",
"status": "text",
"currencyCode": "text",
"grandTotal": 1,
"returnIdentifications": [
{
"returnIdentificationTypeId": "text",
"returnIdentificationDesc": "text",
"idValue": "text"
}
],
"shipFrom": {
"postalAddress": {
"id": "text",
"externalId": "text"
}
},
"shipTo": {
"facilityId": "text"
},
"items": [
{
"id": "text",
"sku": "text",
"itemExternalId": "text",
"itemSeqId": "text",
"itemTypeId": "text",
"status": "text",
"orderId": "text",
"orderExternalId": "text",
"orderItemSeqId": "text",
"quantity": 1,
"reason": "text",
"returnType": "text",
"restockType": "text",
"price": 1,
"includeAdjustments": "text",
"itemAdjustments": [
{
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
],
"returnAdjustment": [
{
"orderId": "text",
"orderExternalId": "text",
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
}POST /rest/services/createRoleType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"roleTypeId": "text",
"parentTypeId": "text",
"description": "text"
}POST /rest/services/createSalesOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2196
{
"order": {
"externalId": "text",
"orderName": "text",
"locale": "text",
"tags": [],
"note": [],
"channel": "text",
"webSiteId": "text",
"customerId": "text",
"customerIdentificationType": "text",
"customerIdentificationValue": "text",
"customerExternalId": "text",
"priority": "text",
"orderDate": "text",
"entryDate": "text",
"expireDate": "text",
"statusId": "text",
"productStoreId": "text",
"currencyCode": "text",
"remainingSubTotal": 1,
"grandTotal": 1,
"autoApprove": "text",
"orderContacts": {
"email": {
"id": "text",
"externalId": "text"
}
},
"orderIdentifications": [
{
"orderIdentificationTypeId": "text",
"orderIdentificationDesc": "text",
"idValue": "text"
}
],
"orderAttributes": [
{
"attrName": "text",
"attrValue": "text",
"attrDescription": "text"
}
],
"orderContents": [
{
"orderItemSeqId": "text",
"contentId": "text",
"orderContentTypeId": "text",
"fromDate": "text",
"thruDate": "text"
}
],
"shipGroup": [
{
"facilityId": "text",
"orderFacilityId": "text",
"externalId": "text",
"maySplit": "text",
"shipBy": "text",
"shipAfter": "text",
"carrierPartyId": "text",
"shipmentMethodTypeId": "text",
"trackingNumber": "text",
"shipTo": {
"postalAddress": {
"id": "text",
"externalId": "text",
"additionalPurpose": "text"
},
"email": {
"id": "text",
"externalId": "text"
},
"phoneNumber": {
"id": "text",
"externalId": "text"
}
},
"items": [
{
"itemSeqId": "text",
"productId": "text",
"itemExternalId": "text",
"sku": "text",
"status": "text",
"quantity": 1,
"unitListPrice": 1,
"unitPrice": 1,
"autoCancelDate": "text",
"itemAdjustments": [
{
"id": "text",
"type": "text",
"comments": "text",
"amount": 1,
"exemptAmount": 1,
"sourcePercentage": 1,
"setShipGroup": "text"
}
],
"orderItemAttributes": [
{
"attrName": "text",
"attrValue": "text",
"attrDescription": "text"
}
],
"orderItemAssociations": [
{
"toOrderId": "text",
"toOrderExternalId": "text",
"toOrderItemSeqId": "text",
"toShipGroupSeqId": "text",
"orderItemAssocTypeId": "text",
"quantity": 1
}
]
}
]
}
],
"orderAdjustments": [
{
"id": "text",
"type": "text",
"comments": "text",
"amount": 1,
"exemptAmount": 1,
"sourcePercentage": 1
}
],
"orderPaymentPref": [
{
"id": "text",
"paymentMethodTypeId": "text",
"paymentMode": "text",
"cardName": "text",
"code": "text",
"maxAmount": 1,
"statusId": "text"
}
],
"billTo": {
"postalAddress": {
"id": "text",
"externalId": "text"
},
"email": {
"id": "text",
"externalId": "text"
},
"phoneNumber": {
"id": "text",
"externalId": "text"
}
}
}
}POST /rest/services/createSearchPreference HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68
{
"searchPrefName": "text",
"isPublic": "text",
"searchPrefValue": "text"
}POST /rest/services/createSecurityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"groupName": "text",
"groupId": "text",
"description": "text",
"groupTypeEnumId": "text"
}POST /rest/services/createSecurityPermission HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"permissionId": "text",
"description": "text"
}POST /rest/services/createShipmentBoxType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 149
{
"boxLength": 1,
"boxWeight": 1,
"dimensionUomId": "text",
"weightUomId": "text",
"description": "text",
"boxHeight": 1,
"boxWidth": 1,
"shipmentBoxTypeId": "text"
}POST /rest/services/createShipmentItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 181
{
"availableToPromise": 1,
"serialNumber": "text",
"quantity": 1,
"productId": "text",
"shipmentContentDescription": "text",
"shipmentId": "text",
"externalId": "text",
"shipmentItemSeqId": "text"
}POST /rest/services/createShipmentMethodType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 90
{
"parentTypeId": "text",
"sequenceNum": 1,
"description": "text",
"shipmentMethodTypeId": "text"
}POST /rest/services/createShipmentReceipt HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 415
{
"orderItemSeqId": "text",
"productId": "text",
"orderId": "text",
"quantityAccepted": 1,
"shipmentPackageSeqId": "text",
"quantityRejected": 1,
"shipmentItemSeqId": "text",
"inventoryItemDetailSeqId": "text",
"affectAccounting": true,
"rejectionId": "text",
"inventoryItemId": "text",
"receivedByUserLoginId": "text",
"shipmentId": "text",
"returnId": "text",
"returnItemSeqId": "text",
"datetimeReceived": "2025-12-09",
"itemDescription": "text"
}POST /rest/services/createShopifyOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"shopifyConfigId": "text",
"payload": {}
}POST /rest/services/createShopifyProdLocActivation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 89
{
"shopifyLocationId": "text",
"shopId": "text",
"shopifyProductId": "text",
"activated": "text"
}POST /rest/services/createShopifyReturn HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1310
{
"payLoad": {
"externalId": "text",
"note": "text",
"returnPaymentPref": [
{
"orderId": "text",
"orderExternalId": "text",
"paymentMethodTypeId": "text",
"statusId": "text",
"manualRefNum": "text",
"parentRefNum": "text",
"maxAmount": 1,
"presentmentAmount": 1,
"presentmentCurrency": "text"
}
],
"tags": [],
"type": "text",
"createdDate": "text",
"returnDate": "text",
"customerId": "text",
"customerExternalId": "text",
"customerIdentificationType": "text",
"customerIdentificationValue": "text",
"companyId": "text",
"companyExternalId": "text",
"status": "text",
"currencyCode": "text",
"grandTotal": 1,
"returnIdentifications": [
{
"returnIdentificationTypeId": "text",
"returnIdentificationDesc": "text",
"idValue": "text"
}
],
"shipFrom": {
"postalAddress": {
"id": "text",
"externalId": "text"
}
},
"shipTo": {
"facilityId": "text"
},
"items": [
{
"id": "text",
"sku": "text",
"itemExternalId": "text",
"itemSeqId": "text",
"itemTypeId": "text",
"status": "text",
"orderId": "text",
"orderExternalId": "text",
"orderItemSeqId": "text",
"quantity": 1,
"reason": "text",
"returnType": "text",
"restockType": "text",
"price": 1,
"includeAdjustments": "text",
"itemAdjustments": [
{
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
],
"returnAdjustment": [
{
"orderId": "text",
"orderExternalId": "text",
"type": "text",
"comments": "text",
"description": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
}POST /rest/services/createShopifyShopCarrierShipment HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102
{
"carrierPartyId": "text",
"shopifyShippingMethod": "text",
"shopId": "text",
"shipmentMethodTypeId": "text"
}POST /rest/services/createShopifyShopLocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"facilityId": "text",
"shopifyLocationId": "text",
"shopId": "text"
}POST /rest/services/createSystemProperty HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 103
{
"systemPropertyValue": "text",
"systemResourceId": "text",
"description": "text",
"systemPropertyId": "text"
}POST /rest/services/createUpdateOrderAdjustment HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 896
{
"customerReferenceId": "text",
"correspondingProductId": "text",
"orderId": "text",
"includeInShipping": "text",
"description": "text",
"exemptAmount": 1,
"productPromoId": "text",
"taxAuthPartyId": "text",
"lastModifiedByUserLogin": "text",
"oldPercentage": 1,
"primaryGeoId": "text",
"taxAuthGeoId": "text",
"originalAdjustmentId": "text",
"secondaryGeoId": "text",
"createdByUserLogin": "text",
"amountAlreadyIncluded": 1,
"orderAdjustmentId": "text",
"orderItemSeqId": "text",
"amount": 1,
"comments": "text",
"recurringAmount": 1,
"lastModifiedDate": "2025-12-09",
"sourceReferenceId": "text",
"isManual": "text",
"productPromoRuleId": "text",
"orderAdjustmentTypeId": "text",
"taxAuthorityRateSeqId": "text",
"productFeatureId": "text",
"oldAmountPerQuantity": 1,
"overrideGlAccountId": "text",
"shipGroupSeqId": "text",
"includeInTax": "text",
"createdDate": "2025-12-09",
"productPromoActionSeqId": "text",
"billingShipmentId": "text",
"sourcePercentage": 1
}POST /rest/services/createUpdateOrderAttribute HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"orderId": "text",
"attrDescription": "text",
"attrValue": "text",
"attrName": "text"
}POST /rest/services/createUpdatePartyEmailAddress HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97
{
"emailAddress": "text",
"contactMechPurposeTypeId": "text",
"partyId": "text",
"contactMechId": "text"
}POST /rest/services/createUpdatePartyTelecomNumber HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 358
{
"askForName": "text",
"extension": "text",
"roleTypeId": "text",
"comments": "text",
"verified": "text",
"monthsWithContactMech": 1,
"contactMechId": "text",
"thruDate": "2025-12-09",
"fromDate": "2025-12-09",
"areaCode": "text",
"allowSolicitation": "text",
"yearsWithContactMech": 1,
"contactMechPurposeTypeId": "text",
"countryCode": "text",
"contactNumber": "text",
"partyId": "text"
}POST /rest/services/createUpdateShippingAddress HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 353
{
"setDefaultShipping": "text",
"shipToContactMechId": "text",
"shipToStateProvinceGeoId": "text",
"shipToCity": "text",
"keepAddressBook": "text",
"shipToPostalCode": "text",
"shipToAddress1": "text",
"billToContactMechId": "text",
"shipToAddress2": "text",
"shipToCountryGeoId": "text",
"shipToName": "text",
"productStoreId": "text",
"partyId": "text",
"shipToAttnName": "text"
}POST /rest/services/createUpdateShopifyShop HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 235
{
"shopifyConfigId": "text",
"clientId": "text",
"shop": "text",
"processRefund": "text",
"shopifyConfigName": "text",
"shopId": "text",
"productStoreId": "text",
"oldSharedSecret": "text",
"accessToken": "text",
"sharedSecret": "text",
"webSiteId": "text"
}POST /rest/services/createUserSearchPreference HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"fromDate": "2025-12-09",
"userSearchPrefTypeId": "text",
"searchPrefId": "text"
}POST /rest/services/deleteCarrierGeoMapping HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119
{
"geoName": "text",
"geoTypeId": "text",
"carrierPartyId": "text",
"geoMapId": "text",
"geoId": "text",
"carrierGeoValue": "text"
}POST /rest/services/deleteCarrierShipmentBoxType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"partyId": "text",
"shipmentBoxTypeId": "text"
}POST /rest/services/deleteCarrierShipmentMethod HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68
{
"roleTypeId": "text",
"partyId": "text",
"shipmentMethodTypeId": "text"
}POST /rest/services/deleteDataManagerMapping HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"mappingPrefId": "text"
}POST /rest/services/deleteEnumeration HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"enumId": "text"
}POST /rest/services/deleteEnumerationGroupMember HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76
{
"fromDate": "2025-12-09",
"enumerationId": "text",
"enumerationGroupId": "text"
}POST /rest/services/deleteExternalFulfillmentOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"externalFulfillmentOrderItemId": "text"
}POST /rest/services/deleteFacilityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"facilityGroupId": "text"
}POST /rest/services/deleteFacilityLocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"facilityId": "text",
"locationSeqId": "text"
}POST /rest/services/deleteOrderAttribute HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"orderId": "text",
"attrName": "text"
}POST /rest/services/deleteOrderItemAttribute HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60
{
"orderItemSeqId": "text",
"orderId": "text",
"attrName": "text"
}POST /rest/services/deletePartyContactMech HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"partyId": "text",
"contactMechId": "text"
}POST /rest/services/deletePartyRole HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"roleTypeId": "text",
"partyId": "text"
}POST /rest/services/deleteProductStoreFacilityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"fromDate": "2025-12-09",
"facilityGroupId": "text",
"productStoreId": "text"
}POST /rest/services/deleteShipmentItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"shipmentId": "text",
"shipmentItemSeqId": "text"
}POST /rest/services/deleteShipmentMethodType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31
{
"shipmentMethodTypeId": "text"
}POST /rest/services/deleteShopifyShopCarrierShipment HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102
{
"carrierPartyId": "text",
"shopifyShippingMethod": "text",
"shopId": "text",
"shipmentMethodTypeId": "text"
}POST /rest/services/deleteShopifyShopLocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"facilityId": "text",
"shopifyLocationId": "text",
"shopId": "text"
}POST /rest/services/doRateShopping HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"shipmentId": "text",
"forceRateShop": true,
"generateLabel": true
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"carrierPartyId": "text",
"shipmentRouteSegmentId": "text",
"billingWeight": 1,
"billingWeightUomId": "text",
"shipmentMethodTypeId": "text",
"actualCost": 1
}
}POST /rest/services/ensurePartyRole HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"roleTypeId": "text",
"partyId": "text"
}POST /rest/services/executeServiceFromAirflow HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"payload": {},
"dagId": "text",
"airflowPayload": {},
"serviceName": "text"
}POST /rest/services/expireFacilityCalendar HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121
{
"fromDate": "2025-12-09",
"facilityId": "text",
"calendarId": "text",
"facilityCalendarTypeId": "text",
"thruDate": "2025-12-09"
}GET /rest/services/findProductById HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"productsList": [
"text"
]
}
}POST /rest/services/forceLogout HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"userLoginId": "text"
}POST /rest/services/gatewayShipAddressValidationRequest HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 111
{
"carrierPartyId": "text",
"shipmentGatewayConfigId": "text",
"shipmentMethodTypeId": "text",
"contactMechId": "text"
}POST /rest/services/generateCustomerOrderUpdateLink HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"orderId": "text"
}POST /rest/services/generateManifests HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82
{
"carrierPartyId": "text",
"facilityId": "text",
"manifestGenerateServiceName": "text"
}GET /rest/services/getCODOrderRemainingTotal HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"total": 1
}
}GET /rest/services/getDAGRunStatus HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}GET /rest/services/getFacilityIdByType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"facilityId": "text"
}
}GET /rest/services/getGeoPointForPostalCode HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"cacheKey": "text",
"geoPoint": {}
}
}GET /rest/services/getInventoryAvailableByFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"quantityOnHandTotal": 1,
"accountingQuantityTotal": 1,
"availableToPromiseTotal": 1
}
}GET /rest/services/getInventoryAvailableByLocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"quantityOnHandTotal": 1,
"accountingQuantityTotal": 1,
"availableToPromiseTotal": 1
}
}GET /rest/services/getOrderIdByType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"orderId": "text"
}
}GET /rest/services/getProductFutureAtp HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"futureAtp": 1
}
}GET /rest/services/getProductInventoryAvailable HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"quantityOnHandTotal": 1,
"accountingQuantityTotal": 1,
"availableToPromiseTotal": 1
}
}GET /rest/services/getProductOnlineAtp HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"onlineAtp": 1
}
}GET /rest/services/getServerTimeZone HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"serverTimeZone": "text"
}
}GET /rest/services/getShippingLabel HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}GET /rest/services/getShopifyDraftOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"response": {}
}
}GET /rest/services/getShopifyWebhooks HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"webhooks": [
"text"
]
}
}GET /rest/services/getUserPreference HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text
POST /rest/services/importJsonListData HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"dataList": [
"text"
]
}POST /rest/services/importProductFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 271
{
"allowPickup": "text",
"productSku": "text",
"reorderPoint": "text",
"idType": "text",
"facilityId": "text",
"productId": "text",
"facilityExternalId": "text",
"salesVelocity": "text",
"allowBrokering": "text",
"reorderQuantity": "text",
"maximumStock": "text",
"facilityMinimumStock": "text"
}POST /rest/services/indexDeploymentData HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"updateHandler": "text",
"coreName": "text"
}POST /rest/services/indexExternalDeploymentData HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"updateHandler": "text",
"deploymentData": {},
"coreName": "text"
}POST /rest/services/indexWebhookErrorMessage HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 89
{
"payload": {},
"remoteUrl": "text",
"comment": "text",
"topicEnumId": "text",
"coreName": "text"
}POST /rest/services/inventoryLevelUpdateFromShopify HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 78
{
"shopifyConfigId": "text",
"inventory_item_id": 1,
"available": 1,
"location_id": 1
}POST /rest/services/moveItemToParkingFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 138
{
"fromShipGroupSeqId": "text",
"orderItemSeqId": "text",
"comments": "text",
"orderId": "text",
"changeReasonEnumId": "text",
"toFacilityId": "text"
}POST /rest/services/oldCheckAndRejectOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 146
{
"orderItemSeqId": "text",
"excludeOrderFacilityDuration": "text",
"orderId": "text",
"rejectionComments": "text",
"rejectionReason": "text",
"notify": true
}POST /rest/services/oldRejectOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"payload": {},
"rejectedComponents": [
"text"
]
}POST /rest/services/oldRejectOrderItems HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"payload": {}
}POST /rest/services/orderDataSetup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1031
{
"shippingCity": "text",
"lastName": "text",
"externalPlacingFacilityId": "text",
"orderId": "text",
"orderTypeId": "text",
"originExternalFacilityId": "text",
"shippingPostalCode": "text",
"shippingAddress2": "text",
"externalFacilityId": "text",
"shippingAddress1": "text",
"shippingTax": "text",
"externalProductStoreId": "text",
"unitListPrice": "text",
"shippingCountry": "text",
"itemStatus": "text",
"salesChannelEnumCode": "text",
"customerId": "text",
"productStoreId": "text",
"shipmentMethodTypeId": "text",
"orderItemTypeId": "text",
"orderName": "text",
"unitPrice": "text",
"quantity": "text",
"idType": "text",
"facilityId": "text",
"productId": "text",
"shippingCharges": "text",
"grandTotal": "text",
"customerExternalId": "text",
"externalId": "text",
"idValue": "text",
"shippingPhone": "text",
"placingFacilityId": "text",
"orderIdentification": "text",
"itemTotalDiscount": "text",
"originFacilityId": "text",
"carrierPartyId": "text",
"firstName": "text",
"itemExternalId": "text",
"paymentMethod": "text",
"shippingState": "text",
"itemTax": "text",
"orderDate": "text",
"shippingEmail": "text"
}POST /rest/services/packStoreFulfillmentOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"orderId": "text",
"picklistBinId": "text"
}POST /rest/services/picklistDataSetup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 280
{
"inventoryItemId": "text",
"orderItemSeqId": "text",
"picklistId": "text",
"quantity": "text",
"facilityId": "text",
"pickerIds": [
"text"
],
"picked": "text",
"orderId": "text",
"externalId": "text",
"shipGroupSeqId": "text",
"shipmentMethodTypeId": "text",
"itemStatusId": "text",
"binLocationNumber": 1
}POST /rest/services/pullAndReportEntitySyncData HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 243
{
"delegatorName": "text",
"entitySyncId": "text",
"toStoreUpdated": 1,
"toCreateInserted": 1,
"toCreateUpdated": 1,
"toCreateNotUpdated": 1,
"toRemoveAlreadyDeleted": 1,
"toStoreNotUpdated": 1,
"toRemoveDeleted": 1,
"toStoreInserted": 1,
"startDate": "2025-12-09"
}POST /rest/services/reShipOrderItems HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"orderItemSeqId": [
"text"
],
"orderId": "text"
}POST /rest/services/receiveAndUpdateInventoryToShopify HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"shipmentId": "text",
"limit": 1,
"shopId": "text"
}POST /rest/services/recordInventoryCount HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 148
{
"reason": "text",
"comments": "text",
"quantity": "text",
"facilityId": "text",
"idType": "text",
"productId": "text",
"idValue": "text",
"locationSeqId": "text"
}POST /rest/services/recordProductVariance HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 161
{
"orderItemSeqId": "text",
"varianceReasonId": "text",
"comments": "text",
"quantity": 1,
"facilityId": "text",
"productId": "text",
"orderId": "text",
"locationSeqId": "text"
}POST /rest/services/rejectFulfillmentReadyOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 175
{
"affectQOH": true,
"excludeOrderFacilityDuration": 1,
"facilityId": "text",
"rejectAllRelatedShipment": "text",
"rejectEntireShipment": "text",
"items": [
"text"
],
"defaultReason": "text"
}POST /rest/services/rejectOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"payload": {},
"rejectedComponents": [
"text"
]
}POST /rest/services/rejectOrderItems HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"payload": {}
}POST /rest/services/rejectTransferOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"orderItemSeqId": "text",
"orderId": "text"
}POST /rest/services/releaseOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141
{
"orderItemSeqId": "text",
"routerUserLogin": "text",
"fromFacilityId": "text",
"orderId": "text",
"changeReasonEnumId": "text",
"toFacilityId": "text"
}POST /rest/services/removeCategoryProducts HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71
{
"fromDate": "2025-12-09",
"productCategoryId": "text",
"productId": "text"
}POST /rest/services/removeClientRegistrationToken HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"applicationId": "text",
"deviceId": "text"
}POST /rest/services/removeFacilityFromGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"fromDate": "2025-12-09",
"facilityId": "text",
"facilityGroupId": "text"
}POST /rest/services/removePartyFromFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"fromDate": "2025-12-09",
"roleTypeId": "text",
"facilityId": "text",
"partyId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/removePartyUserPermission HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"userLoginId": "text",
"groupId": "text"
}POST /rest/services/removeShopifyWebhook HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"shopifyConfigId": "text",
"webhookId": 1
}POST /rest/services/resetPassword HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 148
{
"userLoginId": "text",
"newPasswordVerify": "text",
"passwordHint": "text",
"newPassword": "text",
"requirePasswordChange": "text",
"currentPassword": "text"
}POST /rest/services/resetPicker HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"picklistId": "text",
"pickerIds": [
"text"
]
}POST /rest/services/sendOrderWebhook HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"orderId": "text",
"topicEnumId": "text"
}POST /rest/services/sendPickupScheduledNotification HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"emailType": "text",
"shipmentId": "text"
}POST /rest/services/sendReadyToPickupItemNotification HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"emailType": "text",
"shipmentId": "text"
}POST /rest/services/setCustomerDefaultStore HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84
{
"facilityId": "text",
"customerId": "text",
"shopDomain": "text",
"shopifyShopId": "text"
}POST /rest/services/setReasonIdOnReturnItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122
{
"reason": "text",
"returnReasonId": "text",
"shopifyReturnId": "text",
"shopifyOrderLineItemId": "text",
"shopifyOrderId": "text"
}POST /rest/services/setUserPreference HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102
{
"userPrefGroupTypeId": "text",
"userPrefValue": "text",
"userPrefTypeId": "text",
"userPrefLoginId": "text"
}POST /rest/services/setupShopifyShop HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 262
{
"accessScopeEnumId": "text",
"shopifyConfigId": "text",
"clientId": "text",
"shop": "text",
"processRefund": "text",
"shopifyConfigName": "text",
"shopId": "text",
"productStoreId": "text",
"oldSharedSecret": "text",
"accessToken": "text",
"sharedSecret": "text",
"webSiteId": "text"
}POST /rest/services/storeCalendarAssocDataSetup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104
{
"calendarId": "text",
"thruDateStr": "text",
"fromDateStr": "text",
"storeId": "text",
"calendarTypeId": "text"
}POST /rest/services/storeClientRegistrationToken HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69
{
"registrationToken": "text",
"applicationId": "text",
"deviceId": "text"
}POST /rest/services/storeEntitySyncData HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121
{
"valuesToStore": [
"text"
],
"delegatorName": "text",
"entitySyncId": "text",
"keysToRemove": [
"text"
],
"valuesToCreate": [
"text"
]
}POST /rest/services/subscribeCancelOrderShopifyWebhook HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"endpoint": "text",
"shopifyConfigId": "text",
"topic": "text"
}POST /rest/services/subscribeCreateOrderShopifyWebhook HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"endpoint": "text",
"shopifyConfigId": "text",
"topic": "text"
}POST /rest/services/subscribeFileStatusUpdateWebhook HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"shopifyConfigId": "text"
}POST /rest/services/subscribeOrderPaidWebhook HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"shopifyConfigId": "text"
}POST /rest/services/subscribeReturnOrderShopifyWebhook HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"endpoint": "text",
"shopifyConfigId": "text",
"topic": "text"
}POST /rest/services/subscribeShopifyWebhook HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75
{
"endpoint": "text",
"shopifyConfigId": "text",
"format": "text",
"topic": "text"
}POST /rest/services/subscribeTopic HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"topicName": "text",
"applicationId": "text"
}POST /rest/services/testCommit HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"message": "text"
}POST /rest/services/testError HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}POST /rest/services/testRollback HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"message": "text"
}POST /rest/services/testScv HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"defaultValue": 1,
"message": "text"
}POST /rest/services/triggerDag HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"endpoint": "text"
}POST /rest/services/unlinkReturnFromOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"returnId": "text"
}POST /rest/services/unlockStoreFulfillmentOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"orderId": "text",
"picklistBinId": "text"
}POST /rest/services/unsubscribeShopifyWebhook HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"shopifyConfigId": "text",
"topic": "text"
}POST /rest/services/unsubscribeTopic HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"topicName": "text",
"applicationId": "text"
}POST /rest/services/updateAllOrderItems HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1413
{
"requestedDeliveryTime": "text",
"orderId": "text",
"isNewProduct": "text",
"returnTillDate": "2025-12-09",
"deploymentId": "text",
"cancelBackOrderDate": "2025-12-09",
"itemDescription": "text",
"selectedAmount": 1,
"unitPrice": 1,
"orderItemSeqId": "text",
"productId": "text",
"unitRecurringPrice": 1,
"autoCancelDate": "2025-12-09",
"isItemGroupPrimary": "text",
"productFeatureId": "text",
"overrideGlAccountId": "text",
"budgetId": "text",
"taxCode": "text",
"supplierProductId": "text",
"estimatedDeliveryDate": "2025-12-09",
"shipGroupSeqId": "text",
"quoteId": "text",
"requestedShipMethTypeId": "text",
"availableToPromise": 1,
"statusId": "text",
"syncStatusId": "text",
"requestedDeliveryDate": "text",
"estimatedShipDate": "2025-12-09",
"shoppingListItemSeqId": "text",
"subscriptionId": "text",
"salesOpportunityId": "text",
"dontCancelSetUserLogin": "text",
"promisedDatetime": "2025-12-09",
"isModifiedPrice": "text",
"isPromo": "text",
"shipBeforeDate": "2025-12-09",
"productCategoryId": "text",
"unitListPrice": 1,
"shoppingListId": "text",
"unitAverageCost": 1,
"orderItemTypeId": "text",
"dontCancelSetDate": "2025-12-09",
"comments": "text",
"quantity": 1,
"recurringFreqUomId": "text",
"orderItemGroupSeqId": "text",
"quoteItemSeqId": "text",
"fromInventoryItemId": "text",
"externalId": "text",
"budgetItemSeqId": "text",
"correspondingPoId": "text",
"cancelQuantity": 1,
"shipAfterDate": "2025-12-09",
"deliveryWindow": 1,
"shipmentId": "text",
"changeByUserLoginId": "text",
"prodCatalogId": "text"
}POST /rest/services/updateCarrierGeoMapping HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119
{
"geoName": "text",
"geoTypeId": "text",
"carrierPartyId": "text",
"geoMapId": "text",
"geoId": "text",
"carrierGeoValue": "text"
}POST /rest/services/updateCarrierShipmentMethod HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132
{
"sequenceNumber": 1,
"roleTypeId": "text",
"deliveryDays": 1,
"partyId": "text",
"carrierServiceCode": "text",
"shipmentMethodTypeId": "text"
}POST /rest/services/updateDataManagerConfig HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 381
{
"importPath": "text",
"exportServiceScreenLocation": "text",
"exportServiceScreenName": "text",
"importServiceName": "text",
"fileNamePattern": "text",
"multiThreading": "text",
"description": "text",
"priority": 1,
"exportPath": "text",
"exportContentId": "text",
"notifyOnFailure": "text",
"delimiter": "text",
"configId": "text",
"exportServiceName": "text",
"scriptTitle": "text",
"executionModeId": "text"
}POST /rest/services/updateDataManagerMapping HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 154
{
"fromDate": "2025-12-09",
"mappingPrefName": "text",
"mappingPrefTypeEnumId": "text",
"mappingPrefId": "text",
"mappingPrefValue": "text",
"thruDate": "2025-12-09"
}POST /rest/services/updateEnumeration HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 165
{
"enumTypeId": "text",
"enumId": "text",
"sequenceNum": 1,
"enumCode": "text",
"primaryEnumerationGroupId": "text",
"description": "text",
"enumName": "text",
"sequenceId": "text"
}POST /rest/services/updateEnumerationGroupMember HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116
{
"fromDate": "2025-12-09",
"enumerationId": "text",
"sequenceNum": 1,
"enumerationGroupId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/updateFacilitiesToGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"payload": {}
}POST /rest/services/updateFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 571
{
"facilityId": "text",
"defaultInventoryItemTypeId": "text",
"parentFacilityId": "text",
"postalCode": "text",
"externalId": "text",
"description": "text",
"defaultWeightUomId": "text",
"primaryFacilityGroupId": "text",
"openedDate": "2025-12-09",
"ownerPartyId": "text",
"facilityTimeZone": "text",
"facilitySize": 1,
"closedDate": "2025-12-09",
"facilitySizeUomId": "text",
"maximumOrderLimit": 1,
"closeTime": "text",
"defaultDaysToShip": 1,
"facilityTypeId": "text",
"defaultDimensionUomId": "text",
"productStoreId": "text",
"facilityName": "text",
"openTime": "text",
"geoPointId": "text",
"oldSquareFootage": 1
}POST /rest/services/updateFacilityContactMech HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 202
{
"fromDate": "2025-12-09",
"extension": "text",
"infoString": "text",
"comments": "text",
"facilityId": "text",
"newContactMechId": "text",
"contactMechTypeId": "text",
"contactMechId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/updateFacilityEmailAddress HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 151
{
"fromDate": "2025-12-09",
"emailAddress": "text",
"extension": "text",
"comments": "text",
"facilityId": "text",
"contactMechId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/updateFacilityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"primaryParentGroupId": "text",
"facilityGroupTypeId": "text",
"facilityGroupId": "text",
"description": "text",
"facilityGroupName": "text"
}POST /rest/services/updateFacilityIdentification HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114
{
"fromDate": "2025-12-09",
"facilityId": "text",
"idValue": "text",
"facilityIdenTypeId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/updateFacilityLocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 245
{
"nextCountDate": "text",
"lastCountDate": "text",
"areaId": "text",
"facilityId": "text",
"positionId": "text",
"isLocked": "text",
"levelId": "text",
"sectionId": "text",
"geoPointId": "text",
"locationTypeEnumId": "text",
"aisleId": "text",
"locationSeqId": "text"
}POST /rest/services/updateFacilityPostalAddress HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 542
{
"houseNumberExt": "text",
"extension": "text",
"city": "text",
"latitude": "text",
"postalCodeGeoId": "text",
"postalCode": "text",
"houseNumber": 1,
"postalCodeExt": "text",
"contactMechId": "text",
"attnName": "text",
"countyGeoId": "text",
"toName": "text",
"cityGeoId": "text",
"longitude": "text",
"countryGeoId": "text",
"comments": "text",
"facilityId": "text",
"address2": "text",
"address1": "text",
"encodedAddressKey": "text",
"thruDate": "2025-12-09",
"fromDate": "2025-12-09",
"directions": "text",
"municipalityGeoId": "text",
"stateProvinceGeoId": "text",
"geoPointId": "text"
}POST /rest/services/updateFacilityTelecomNumber HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 211
{
"fromDate": "2025-12-09",
"askForName": "text",
"areaCode": "text",
"extension": "text",
"comments": "text",
"facilityId": "text",
"countryCode": "text",
"contactNumber": "text",
"contactMechId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/updateFacilityToGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 110
{
"fromDate": "2025-12-09",
"facilityId": "text",
"sequenceNum": 1,
"facilityGroupId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/updateInventoryByIdentification HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173
{
"varianceReasonId": "text",
"comments": "text",
"idType": "text",
"facilityId": "text",
"idValue": "text",
"externalFacilityId": "text",
"locationSeqId": "text",
"availableDelta": "text"
}POST /rest/services/updateJobSandbox HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 765
{
"recurrenceInfoId": "text",
"cancelDateTime": "2025-12-09",
"tempExprId": "text",
"authUserLoginId": "text",
"currentRetryCount": 1,
"runTimeEpoch": 1,
"lastModifiedByUserLogin": "text",
"loaderName": "text",
"shopId": "text",
"productStoreId": "text",
"runTime": "2025-12-09",
"createdByUserLogin": "text",
"jobName": "text",
"runThread": "text",
"runByInstanceId": "text",
"maxRecurrenceCount": 1,
"currentRecurrenceCount": 1,
"serviceName": "text",
"priority": 1,
"runtimeDataId": "text",
"finishDateTime": "2025-12-09",
"runAsUser": "text",
"maxRetry": 1,
"jobId": "text",
"createdDate": "2025-12-09",
"startDateTime": "2025-12-09",
"statusId": "text",
"previousJobId": "text",
"parentJobId": "text",
"jobResult": "text",
"poolId": "text",
"systemJobEnumId": "text",
"recurrenceTimeZone": "text",
"instanceOfProductId": "text"
}POST /rest/services/updateOISGIRIFulfillmentStatus HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91
{
"inventoryItemId": "text",
"orderItemSeqId": "text",
"orderId": "text",
"shipGroupSeqId": "text"
}POST /rest/services/updateOrderAddressAndAppendAttributes HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 108
{
"lookupField": "text",
"geoTypeId": "text",
"orderId": "text",
"attributesToAppend": {},
"fieldsToUpdate": [
"text"
]
}POST /rest/services/updateOrderAttribute HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"orderId": "text",
"attrDescription": "text",
"attrValue": "text",
"attrName": "text"
}POST /rest/services/updateOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1413
{
"requestedDeliveryTime": "text",
"orderId": "text",
"isNewProduct": "text",
"returnTillDate": "2025-12-09",
"deploymentId": "text",
"cancelBackOrderDate": "2025-12-09",
"itemDescription": "text",
"selectedAmount": 1,
"unitPrice": 1,
"orderItemSeqId": "text",
"productId": "text",
"unitRecurringPrice": 1,
"autoCancelDate": "2025-12-09",
"isItemGroupPrimary": "text",
"productFeatureId": "text",
"overrideGlAccountId": "text",
"budgetId": "text",
"taxCode": "text",
"supplierProductId": "text",
"estimatedDeliveryDate": "2025-12-09",
"shipGroupSeqId": "text",
"quoteId": "text",
"requestedShipMethTypeId": "text",
"availableToPromise": 1,
"statusId": "text",
"syncStatusId": "text",
"requestedDeliveryDate": "text",
"estimatedShipDate": "2025-12-09",
"shoppingListItemSeqId": "text",
"subscriptionId": "text",
"salesOpportunityId": "text",
"dontCancelSetUserLogin": "text",
"promisedDatetime": "2025-12-09",
"isModifiedPrice": "text",
"isPromo": "text",
"shipBeforeDate": "2025-12-09",
"productCategoryId": "text",
"unitListPrice": 1,
"shoppingListId": "text",
"unitAverageCost": 1,
"orderItemTypeId": "text",
"dontCancelSetDate": "2025-12-09",
"comments": "text",
"quantity": 1,
"recurringFreqUomId": "text",
"orderItemGroupSeqId": "text",
"quoteItemSeqId": "text",
"fromInventoryItemId": "text",
"externalId": "text",
"budgetItemSeqId": "text",
"correspondingPoId": "text",
"cancelQuantity": 1,
"shipAfterDate": "2025-12-09",
"deliveryWindow": 1,
"shipmentId": "text",
"changeByUserLoginId": "text",
"prodCatalogId": "text"
}POST /rest/services/updateOrderItemAttribute HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104
{
"orderItemSeqId": "text",
"orderId": "text",
"attrDescription": "text",
"attrValue": "text",
"attrName": "text"
}POST /rest/services/updateOrderItemFromShopify HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"shopifyConfigId": "text",
"payload": {}
}POST /rest/services/updateOrderItemShipGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 641
{
"carrierService": "text",
"facilityId": "text",
"giftMessage": "text",
"orderId": "text",
"shippingInstructions": "text",
"shipByDate": "2025-12-09",
"maySplit": "text",
"estimatedDeliveryDate": "2025-12-09",
"shipGroupSeqId": "text",
"contactMechId": "text",
"vendorPartyId": "text",
"shipAfterDate": "2025-12-09",
"telecomContactMechId": "text",
"shipmentMethod": "text",
"carrierPartyId": "text",
"contactMechPurposeTypeId": "text",
"carrierRoleTypeId": "text",
"oldContactMechId": "text",
"estimatedShipDate": "2025-12-09",
"isGift": "text",
"supplierPartyId": "text",
"carrierAccountNumber": "text",
"trackingNumber": "text",
"shipmentMethodTypeId": "text",
"orderFacilityId": "text"
}POST /rest/services/updateOrderPaymentPreferenceV2 HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 757
{
"cardName": "text",
"orderId": "text",
"manualAuthCode": "text",
"presentmentAmount": 1,
"lastModifiedByUserLogin": "text",
"orderPaymentPreferenceId": "text",
"exchangeRate": 1,
"requestId": "text",
"presentmentCurrencyUom": "text",
"paymentMethodId": "text",
"overflowFlag": "text",
"maxAmount": 1,
"productPricePurposeId": "text",
"createdByUserLogin": "text",
"orderItemSeqId": "text",
"track2": "text",
"paymentMode": "text",
"lastModifiedDate": "2025-12-09",
"manualRefNum": "text",
"swipedFlag": "text",
"parentRefNum": "text",
"securityCode": "text",
"paymentMethodTypeId": "text",
"applicationIdentifier": "text",
"shipGroupSeqId": "text",
"processAttempt": 1,
"needsNsfRetry": "text",
"finAccountId": "text",
"createdDate": "2025-12-09",
"statusId": "text",
"billingPostalCode": "text",
"presentFlag": "text"
}POST /rest/services/updatePartyGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 331
{
"pdfLogoImageUrl": "text",
"comments": "text",
"externalId": "text",
"description": "text",
"tickerSymbol": "text",
"logoImageUrl": "text",
"partyTypeId": "text",
"groupName": "text",
"groupNameLocal": "text",
"statusId": "text",
"numEmployees": 1,
"preferredCurrencyUomId": "text",
"ranking": 1,
"partyId": "text",
"annualRevenue": 1,
"officeSiteName": "text"
}POST /rest/services/updatePartyRelationship HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 329
{
"roleTypeIdTo": "text",
"partyIdFrom": "text",
"comments": "text",
"positionTitle": "text",
"permissionsEnumId": "text",
"priorityTypeId": "text",
"roleTypeIdFrom": "text",
"thruDate": "2025-12-09",
"securityGroupId": "text",
"relationshipName": "text",
"fromDate": "2025-12-09",
"partyRelationshipTypeId": "text",
"statusId": "text",
"partyIdTo": "text"
}POST /rest/services/updatePerson HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 818
{
"yearsWithEmployer": 1,
"lastName": "text",
"occupation": "text",
"employmentStatusEnumId": "text",
"gender": "text",
"socialSecurityNumber": "text",
"description": "text",
"suffix": "text",
"mothersMaidenName": "text",
"existingCustomer": "text",
"middleNameLocal": "text",
"residenceStatusEnumId": "text",
"preferredCurrencyUomId": "text",
"nickname": "text",
"partyId": "text",
"height": 1,
"memberId": "text",
"passportNumber": "text",
"comments": "text",
"lastNameLocal": "text",
"monthsWithEmployer": 1,
"externalId": "text",
"weight": 1,
"birthDate": "text",
"otherLocal": "text",
"firstName": "text",
"anniversaryDate": "text",
"statusId": "text",
"cardId": "text",
"ranking": 1,
"passportExpireDate": "text",
"firstNameLocal": "text",
"middleName": "text",
"salutation": "text",
"personalTitle": "text",
"totalYearsWorkExperience": 1,
"deceasedDate": "text",
"maritalStatus": "text"
}POST /rest/services/updatePostalAddressContactMech HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 427
{
"countryGeoId": "text",
"houseNumberExt": "text",
"city": "text",
"address2": "text",
"address1": "text",
"latitude": 1,
"postalCodeGeoId": "text",
"postalCode": "text",
"encodedAddressKey": "text",
"houseNumber": 1,
"postalCodeExt": "text",
"contactMechId": "text",
"attnName": "text",
"countyGeoId": "text",
"directions": "text",
"toName": "text",
"cityGeoId": "text",
"municipalityGeoId": "text",
"stateProvinceGeoId": "text",
"geoPointId": "text",
"longitude": 1
}POST /rest/services/updateProductStore HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2684
{
"requireCustomerRole": "text",
"viewCartOnAdd": "text",
"companyName": "text",
"headerDeclinedStatus": "text",
"requireInventory": "text",
"allowSplit": "text",
"autoApproveInvoice": "text",
"checkInventory": "text",
"addToCartRemoveIncompat": "text",
"enableAutoSuggestionList": "text",
"defaultSalesChannelEnumId": "text",
"autoApproveOrder": "text",
"allowPassword": "text",
"oldHeaderLogo": "text",
"showTaxIsExempt": "text",
"enablePreOrderAutoReleasing": "text",
"autoSaveCart": "text",
"inventoryFacilityId": "text",
"oldHeaderMiddleBackground": "text",
"headerApprovedStatus": "text",
"defaultTimeZoneString": "text",
"oldStyleSheet": "text",
"showCheckoutGiftOptions": "text",
"prorateTaxes": "text",
"itemDeclinedStatus": "text",
"manualAuthIsCapture": "text",
"storeDomain": "text",
"showOutOfStockProducts": "text",
"storeCreditAccountEnumId": "text",
"itemApprovedStatus": "text",
"allowComment": "text",
"splitPayPrefPerShpGrp": "text",
"storeCreditValidDays": 1,
"managedByLot": "text",
"authFraudMessage": "text",
"reqShipAddrForDigItems": "text",
"enableBrokering": "text",
"oneInventoryFacility": "text",
"autoSetFacility": "text",
"autoInvoiceDigitalItems": "text",
"orderNumberPrefix": "text",
"subtitle": "text",
"reserveOrderEnumId": "text",
"productIdentifierEnumId": "text",
"isDemoStore": "text",
"retryFailedAuths": "text",
"selectPaymentTypePerItem": "text",
"enableExternalPromotion": "text",
"balanceResOnOrderCreation": "text",
"explodeOrderItems": "text",
"autoApproveReviews": "text",
"usePrimaryEmailUsername": "text",
"termTypeId": "text",
"restockingFeePercentage": 1,
"headerCancelStatus": "text",
"title": "text",
"primaryStoreGroupId": "text",
"oldHeaderRightBackground": "text",
"enableDigProdUpload": "text",
"autoOrderCcTryOtherCards": "text",
"autoOrderCcTryLaterMax": 1,
"restockingFeeFixed": 1,
"digitalItemApprovedStatus": "text",
"reserveInventory": "text",
"storeName": "text",
"ecomThemeId": "text",
"productStoreId": "text",
"storeLogoImageUrl": "text",
"isImmediatelyFulfilled": "text",
"defaultPassword": "text",
"autoOrderCcTryExp": "text",
"itemCancelStatus": "text",
"authDeclinedMessage": "text",
"prodSearchExcludeVariants": "text",
"shipIfCaptureFails": "text",
"daysToReturn": 1,
"catalogUrlMountPoint": "text",
"showPricesWithVatTax": "text",
"externalId": "text",
"orderDecimalQuantity": "text",
"defaultCurrencyUomId": "text",
"prorateShipping": "text",
"digProdUploadCategoryId": "text",
"reqReturnInventoryReceive": "text",
"authErrorMessage": "text",
"setOwnerUponIssuance": "text",
"checkGcBalance": "text",
"addToCartReplaceUpsell": "text",
"autoOrderCcTryLaterNsf": "text",
"vatTaxAuthGeoId": "text",
"capturePmntsOnOrdApproval": "text",
"vatTaxAuthPartyId": "text",
"daysToCancelNonPay": 1,
"requirementMethodEnumId": "text",
"defaultLocaleString": "text",
"payToPartyId": "text",
"autoAcceptReturn": "text"
}POST /rest/services/updateProductStoreFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"fromDate": "2025-12-09",
"facilityId": "text",
"sequenceNum": 1,
"productStoreId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/updateProductStoreFacilityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 117
{
"fromDate": "2025-12-09",
"sequenceNumber": 1,
"facilityGroupId": "text",
"productStoreId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/updateProductStoreRole HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126
{
"fromDate": "2025-12-09",
"roleTypeId": "text",
"sequenceNum": 1,
"productStoreId": "text",
"partyId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/updateProductStoreSetting HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"settingValue": "text",
"productStoreId": "text",
"settingTypeEnumId": "text"
}POST /rest/services/updateProductStoreShipMeth HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 734
{
"companyPartyId": "text",
"productStoreShipMethId": "text",
"allowancePercent": 1,
"shipmentCustomMethodId": "text",
"includeFeatureGroup": "text",
"minTotal": 1,
"minWeight": 1,
"requireCompanyAddr": "text",
"maxSize": 1,
"excludeGeoId": "text",
"isShippingWeightRequired": "text",
"shipmentGatewayConfigId": "text",
"minSize": 1,
"allowCompanyAddr": "text",
"productStoreId": "text",
"minimumPrice": 1,
"partyId": "text",
"shipmentMethodTypeId": "text",
"excludeFeatureGroup": "text",
"sequenceNumber": 1,
"roleTypeId": "text",
"allowUspsAddr": "text",
"maxWeight": 1,
"serviceName": "text",
"thruDate": "2025-12-09",
"fromDate": "2025-12-09",
"includeGeoId": "text",
"maxTotal": 1,
"requireUspsAddr": "text",
"configProps": "text",
"includeNoChargeItems": "text",
"isTrackingRequired": "text"
}POST /rest/services/updateSalesOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1214
{
"order": {
"id": "text",
"externalId": "text",
"channel": "text",
"customerId": "text",
"customerExternalId": "text",
"priority": "text",
"orderDate": "text",
"entryDate": "text",
"expireDate": "text",
"statusId": "text",
"productStoreId": "text",
"currencyCode": "text",
"remainingSubTotal": 1,
"grandTotal": 1,
"shipGroup": [
{
"facilityId": "text",
"externalId": "text",
"maySplit": "text",
"shipBy": "text",
"shipAfter": "text",
"carrierPartyId": "text",
"trackingNumber": "text",
"shipTo": {
"postalAddress": {
"id": "text",
"externalId": "text"
},
"email": {
"id": "text",
"externalId": "text"
},
"phoneNumber": {
"id": "text",
"externalId": "text"
}
},
"items": [
{
"itemSeqId": "text",
"productId": "text",
"sku": "text",
"status": "text",
"quantity": 1,
"unitListPrice": 1,
"unitPrice": 1,
"itemAdjustments": [
{
"id": "text",
"type": "text",
"comments": "text",
"amount": 1,
"sourcePercentage": 1
}
]
}
]
}
],
"orderAdjustments": [
{
"id": "text",
"type": "text",
"comments": "text",
"amount": 1,
"sourcePercentage": 1
}
],
"orderPaymentPref": [
{
"id": "text",
"paymentMethodTypeId": "text",
"paymentMode": "text",
"cardName": "text",
"code": "text",
"maxAmount": 1,
"statusId": "text"
}
],
"billTo": {
"postalAddress": {
"id": "text",
"externalId": "text"
},
"email": {
"id": "text",
"externalId": "text"
},
"phoneNumber": {
"id": "text",
"externalId": "text"
}
}
}
}POST /rest/services/updateSearchPreference HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 90
{
"searchPrefName": "text",
"isPublic": "text",
"searchPrefValue": "text",
"searchPrefId": "text"
}POST /rest/services/updateSecurityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"groupName": "text",
"groupId": "text",
"description": "text",
"groupTypeEnumId": "text"
}POST /rest/services/updateSecurityPermissionToSecurityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88
{
"fromDate": "2025-12-09",
"permissionId": "text",
"groupId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/updateShipGroupShipInfo HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 115
{
"shipmentMethod": "text",
"orderId": "text",
"oldContactMechId": "text",
"shipGroupSeqId": "text",
"contactMechId": "text"
}POST /rest/services/updateShipment HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 857
{
"statusDate": "2025-12-09",
"partyIdFrom": "text",
"latestCancelDate": "2025-12-09",
"estimatedReadyDate": "2025-12-09",
"additionalShippingCharge": 1,
"estimatedArrivalWorkEffId": "text",
"destinationTelecomNumberId": "text",
"estimatedShipCost": 1,
"shipmentMethodTypeId": "text",
"destinationFacilityId": "text",
"estimatedShipWorkEffId": "text",
"addtlShippingChargeDesc": "text",
"originContactMechId": "text",
"externalId": "text",
"primaryReturnId": "text",
"originFacilityId": "text",
"carrierPartyId": "text",
"currencyUomId": "text",
"destinationContactMechId": "text",
"statusId": "text",
"originTelecomNumberId": "text",
"shipmentId": "text",
"primaryOrderId": "text",
"estimatedShipDate": "2025-12-09",
"partyIdTo": "text",
"shipmentTypeId": "text",
"estimatedArrivalDate": "2025-12-09",
"picklistBinId": "text",
"primaryShipGroupSeqId": "text",
"handlingInstructions": "text",
"eventDate": "2025-12-09"
}POST /rest/services/updateShipmentBoxType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 149
{
"boxLength": 1,
"boxWeight": 1,
"dimensionUomId": "text",
"weightUomId": "text",
"description": "text",
"boxHeight": 1,
"boxWidth": 1,
"shipmentBoxTypeId": "text"
}POST /rest/services/updateShipmentItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 181
{
"availableToPromise": 1,
"serialNumber": "text",
"quantity": 1,
"productId": "text",
"shipmentContentDescription": "text",
"shipmentId": "text",
"externalId": "text",
"shipmentItemSeqId": "text"
}POST /rest/services/updateShipmentMethodType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 90
{
"parentTypeId": "text",
"sequenceNum": 1,
"description": "text",
"shipmentMethodTypeId": "text"
}POST /rest/services/updateShipmentPackageRouteSeg HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 451
{
"packagePickupPrn": "text",
"packageServiceCost": 1,
"boxNumber": "text",
"trackingCode": "text",
"shipmentPackageSeqId": "text",
"packageOtherCost": 1,
"labelImageUrl": "text",
"shipmentRouteSegmentId": "text",
"packagePickupDate": "2025-12-09",
"internationalInvoiceUrl": "text",
"currencyUomId": "text",
"labelPrinted": "text",
"packageTransportCost": 1,
"shipmentId": "text",
"codAmount": 1,
"insuredAmount": 1,
"gatewayMessage": "text",
"gatewayStatus": "text",
"labelHtml": "text"
}POST /rest/services/updateShipmentRouteSegment HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1190
{
"actualOtherCost": 1,
"carrierDeliveryZone": "text",
"thirdPartyPostalCode": "text",
"destTelecomNumberId": "text",
"carrierRestrictionCodes": "text",
"trackingIdNumber": "text",
"deliveryId": "text",
"actualCarrierCode": "text",
"referenceNumber": "text",
"codCollectionAmount": 1,
"actualStartDate": "2025-12-09",
"carrierServiceStatusId": "text",
"trackingDigest": "text",
"shipmentMethodTypeId": "text",
"actualCost": 1,
"actualArrivalDate": "2025-12-09",
"carrierService": "text",
"actualServiceCost": 1,
"estimatedStartDate": "2025-12-09",
"originContactMechId": "text",
"isGenerateThirdPartyLabel": "text",
"codReturnLabelHtml": "text",
"actualTransportCost": 1,
"carrierRestrictionDesc": "text",
"billingWeightUomId": "text",
"homeDeliveryDate": "2025-12-09",
"originFacilityId": "text",
"carrierPartyId": "text",
"destFacilityId": "text",
"shipmentRouteSegmentId": "text",
"lastUpdatedDate": "2025-12-09",
"currencyUomId": "text",
"billingWeight": 1,
"thirdPartyCountryGeoCode": "text",
"originTelecomNumberId": "text",
"shipmentId": "text",
"isTrackingRequired": "text",
"thirdPartyAccountNumber": "text",
"homeDeliveryType": "text",
"estimatedArrivalDate": "2025-12-09",
"destContactMechId": "text",
"carrierAccountNumber": "text",
"updatedByUserLoginId": "text"
}POST /rest/services/updateShippingInformationOfShipGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 635
{
"houseNumberExt": "text",
"orderId": "text",
"city": "text",
"latitude": "text",
"postalCodeGeoId": "text",
"postalCode": "text",
"houseNumber": 1,
"isEdited": "text",
"postalCodeExt": "text",
"contactMechId": "text",
"shipmentMethod": "text",
"attnName": "text",
"countyGeoId": "text",
"toName": "text",
"cityGeoId": "text",
"partyId": "text",
"longitude": "text",
"countryGeoId": "text",
"keepLatitudeAndLongitude": "text",
"address2": "text",
"address1": "text",
"encodedAddressKey": "text",
"shipGroupSeqId": "text",
"contactMechPurposeTypeId": "text",
"directions": "text",
"municipalityGeoId": "text",
"stateProvinceGeoId": "text",
"carrierAccountNumber": "text",
"geoPointId": "text"
}POST /rest/services/updateShopifyDraftOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"shopifyConfigId": "text",
"payload": {},
"draftOrderId": 1
}POST /rest/services/updateShopifyProdLocActivation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 89
{
"shopifyLocationId": "text",
"shopId": "text",
"shopifyProductId": "text",
"activated": "text"
}POST /rest/services/updateShopifyShopCarrierShipment HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102
{
"carrierPartyId": "text",
"shopifyShippingMethod": "text",
"shopId": "text",
"shipmentMethodTypeId": "text"
}POST /rest/services/updateShopifyShopLocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"facilityId": "text",
"shopifyLocationId": "text",
"shopId": "text"
}POST /rest/services/updateSystemProperty HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 103
{
"systemPropertyValue": "text",
"systemResourceId": "text",
"description": "text",
"systemPropertyId": "text"
}POST /rest/services/updateUserLoginStatus HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 190
{
"disabledDateTime": "2025-12-09",
"userLoginId": "text",
"successiveFailedLogins": 1,
"userLdapDn": "text",
"externalAuthId": "text",
"requirePasswordChange": "text",
"partyId": "text",
"enabled": "text"
}POST /rest/services/updateUserLoginToSecurityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"fromDate": "2025-12-09",
"userLoginId": "text",
"groupId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/updateUserSearchPreference HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122
{
"fromDate": "2025-12-09",
"userLoginId": "text",
"userSearchPrefTypeId": "text",
"searchPrefId": "text",
"thruDate": "2025-12-09"
}POST /rest/services/uploadAndImportFile HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 192
{
"scheduleNow": true,
"fileProcessingDelay": 1,
"_uploadedFile_contentType": "text",
"configId": "text",
"createdByJobId": "text",
"parameters": {},
"continueOnError": true,
"_uploadedFile_fileName": "text"
}POST /rest/services/uploadPartyLogoImage HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105
{
"contentUrl": "text",
"_uploadedFile_contentType": "text",
"partyId": "text",
"_uploadedFile_fileName": "text"
}POST /rest/services/voidShipmentLabel HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"shipmentId": "text"
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"userLoginId": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"resp": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"resp": "text"
}
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": {
"resp": "text"
}
}POST /rest/services/orderFulfillmentAllocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"orderId": "text",
"externalOrderId": "text",
"facilityAllocation": [
"text"
]
}{
"statusCode": 1,
"statusDescription": "text",
"successMessage": "text",
"data": null
}