Brokered Order Items Feed
Discover the Brokered Order Items feed, a JSON-formatted feed generated from HotWax Commerce OMS for streamlined order management.
Introduction
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.
Use case
Communication with the External Order fulfillment system
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.
Customization
The Brokered Order Items feed has certain out-of-the-box customizations that allow users to generate the feed as per the requirements.
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.
Attributes
The following attributes have been prepared in the feed:
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
2024-02-23T03:43:23+09:00
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
This object contains the following attributes, each of which has internal nesting:
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
billTo
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
jhon deo
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
billTo.phone
contactMechId
The contact mechanism ID
18228
countryCode
The country code
1
areaCode
The area code
null
contactNumber
The contact number
0593785656
orderIdentifications
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
null
customerPartyIdentifications
partyIdentificationTypeId
The party identification type ID
SHOPIFY_CUST_ID
idValue
The ID value
7053008306365
partyId
The party ID
10290
payments
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
Ext Other Gateways
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
orderAdjustments
orderAdjustmentTypeId
The order adjustment type ID
SHIPPING_SALES_TAX
amount
The amount
50
orderAdjustmentId
The order adjustment ID
null
orderId
The order ID
12082
orderAttributes
orderId
The order ID
12082
attrDescription
The attribute description
null
attrName
The attribute name
COD_FEE_ADJ_CREATED
attrValue
The attribute value
true
orderItems
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
2024-02-23T03:43:23+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
orderItems.shipTo
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
jhon deo
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
orderItems.phone.shipTo
contactMechId
The contact mechanism ID
18228
countryCode
The country code
1
areaCode
The area code
null
contactNumber
The contact number
0593785656
orderItem.goodIdentification
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
SHOPIFY_PROD_ID
thruDate
The identification expiration date
null
orderItems.orderItemAdjustments:
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.
0001
orderItemAttributes
orderId
The order ID
12082
attrDescription
The attribute description
null
attrName
The attribute name
COD_FEE_ADJ_CREATED
attrValue
The attribute value
true
orderItemSeqId
the Order item sequence id.
00001
facilityGroupMembers
facilityId
The facility ID
WH0615
facilityGroupId
The facility group ID
22
thruDate
The thru date
null
fromDate
The from date
2024-02-23T03:50:12+09:00
sequenceNum
The sequence number for the member.
1
fromOrderItemAssocs:
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.
00001
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
toOrderItemAssocs:
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.
00001
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
productFeatures:
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.
Red, L
productId
the Product ID.
10000
productFeaturTypeId
the feature type like
COLOR
Last updated
Was this helpful?