This class provides RESTful services to get order history and order details.
com.ibm.commerce.rest.order.handler.OrderHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/order?q={q} | Finds orders by a query. See each query for details on input and output. |
GET | /store/{storeId}/order?q=findByParentOrderId | Find order by the parent order ID. |
GET | /store/{storeId}/order?q=findByStatusExt | Find order status by external order ID. |
GET | /store/{storeId}/order?q=findChildOrderByOrderItemId | Find child order by order item ID |
GET | /store/{storeId}/order?q=findConfigurationByOrderItemId | Get an order item configuration by an order item ID. |
GET | /store/{storeId}/order?q=orderProfile | Find the profile order and its default payment and billing information. |
GET | /store/{storeId}/order/{orderId} | Gets the order details for a specific order ID. |
GET | /store/{storeId}/order/@history | Gets the order history for the authenticated user. |
GET | /store/{storeId}/order/byStatus/{status} | Gets a list of orders by order status. |
Finds orders by a query. See each query for details on input and output.
findByQuery
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
Find order by the parent order ID.
findByParentOrderId
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
orderId | The order identifier. | query | string | true | false |
pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | string | false | false |
pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
Find order status by external order ID.
findByStatusExt
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
extOrderId | The external order identifier. | query | string | false | false |
pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | string | false | false |
pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | string | false | false |
recordSetTotal | The total number of records in set. | query | string | true | false |
status | The order status. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
Find child order by order item ID
findChildOrderByOrderItemId
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
orderItemId | The order item identifier. | query | string | true | false |
pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | string | false | false |
pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
Get an order item configuration by an order item ID.
findConfigurationByOrderItemId
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
orderItemId | The order item identifier. | query | string | true | false |
pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | string | false | false |
pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
Find the profile order and its default payment and billing information.
orderProfile
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
retrievalOrderStatus | The order status to use for the retrieval of orders. | query | string | false | false |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
q | The query name. | query | string | true | false |
userId | query | integer | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary
GET /wcs/resources/store/10001/order?q=orderProfile&userId=11051&retrievalOrderStatus=Q&responseFormat=json
200
{ "resultList": [ { "allowableShippingAddress": [ ], "billingAddressDataBean": { "addressId": "15810" }, "currentAddressDataBean": { "address1": "123 Main St", "address2": "", "address3": "", "addressField1": "", "addressField2": "", "addressField3": "", "addressId": "15810", "addressType": "B", "bestCallingTime": "", "billingCode": "", "billingCodeType": "", "businessTitle": "", "city": "Toronto", "country": "CA", "countryDisplayName": "Canada", "createdTime": "2014-11-24 15:28:48.576", "createdTimestamp": "2014-11-24 15:28:48.576", "dataBeanKeyAddressId": "15810", "email1": "john@example.com", "email2": "", "fax1": "", "fax2": "", "firstName": "John", "isSelfAddress": false, "lastCreate": "", "lastName": "Smith", "memberId": "11051", "middleName": "", "mobilePhone1": "", "mobilePhone1Country": "", "nickName": "Default_Billing_10001", "officeAddress": "", "organizationName": "", "organizationUnitName": "", "packageSuppression": "", "personTitle": "", "phone1": "", "phone1Type": "", "phone2": "", "phone2Type": "", "primary": "0", "publishPhone1": "", "publishPhone2": "", "state": "ON", "stateProvDisplayName": "Ontario", "status": "P", "storeDirectory": null, "zipCode": "M1M1M1" }, "orderItemDataBeans": [ { "shippingMode": { "carrier": "International Carrier", "code": "International Priority", "shippingModeId": 10054, "storeEntityId": 10001 }, "shippingModeId": "10054" } ], "paymentInfo": { "account": "4111111111111111", "cc_brand": "VISA", "expire_month": "11", "expire_year": "2014", "payMethodId": "VISA", "payment_method": "VISA" }, "uniqueShippingAddresses": [ { "address1": "123 Main St", "address2": "", "address3": "", "addressField1": "", "addressField2": "", "addressField3": "", "addressId": "15811", "addressType": "S", "bestCallingTime": "", "billingCode": "", "billingCodeType": "", "businessTitle": "", "city": "Toronto", "country": "CA", "countryDisplayName": "Canada", "createdTime": "2014-11-24 15:28:48.585", "createdTimestamp": "2014-11-24 15:28:48.585", "dataBeanKeyAddressId": "15811", "email1": "john@example.com", "email2": "", "fax1": "", "fax2": "", "firstName": "John", "isSelfAddress": false, "lastCreate": "", "lastName": "Smith", "memberId": "11051", "middleName": "", "mobilePhone1": "", "mobilePhone1Country": "", "nickName": "Default_Shipping_10001", "officeAddress": "", "organizationName": "", "organizationUnitName": "", "packageSuppression": "", "personTitle": "", "phone1": "", "phone1Type": "", "phone2": "", "phone2Type": "", "primary": "0", "publishPhone1": "", "publishPhone2": "", "state": "ON", "stateProvDisplayName": "Ontario", "status": "P", "storeDirectory": null, "zipCode": "M1M1M1" } ] } ] }
Gets the order details for a specific order ID.
findByOrderId
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
orderId | The order identifier. | path | string | true | N/A |
storeId | The store identifier. | path | string | true | N/A |
pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | integer | false | false |
pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | integer | false | false |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10001/order/25206?pageSize=20&accessProfile=IBM_Details&pageNumber=1&responseFormat=json
200
{ "adjustment": [ { "amount": "-10.00000", "code": "Save 10% on all orders today", "currency": "USD", "description": "Save 10% on all orders", "descriptionLanguage": "-1", "displayLevel": "Order", "usage": "Discount" } ], "buyerId": "12051", "grandTotal": "90.00000", "grandTotalCurrency": "USD", "lastUpdateDate": "2014-11-24T20:02:27.056Z", "locked": "false", "orderId": "25206", "orderItem": [ { "UOM": "C62", "addressId": "15808", "addressLine": [ "123", "", "" ], "adjustment": [ { "amount": "-10.00000", "code": "Save 10% on all orders today", "currency": "USD", "description": "Save 10% on all orders", "language": "-1", "usage": "Discount" } ], "availableDate": "2014-11-24T20:02:22.385Z", "carrier": "XYZ Carrier", "city": "Toronto", "contractId": "10001", "correlationGroup": "85205", "country": "CA", "createDate": "2014-11-24T20:00:35.666Z", "currency": "USD", "email1": "john@example.com", "email2": "", "expectedShipDate": "2014-11-25T20:02:28.180Z", "fax1": "", "fax2": "", "firstName": "John", "freeGift": "false", "fulfillmentCenterId": "10001", "fulfillmentCenterName": "Aurora", "isExpedited": "false", "lastName": "Smith", "lastUpdateDate": "2014-11-24T20:02:27.056Z", "middleName": "", "nickName": "john", "offerID": "10040", "orderItemFulfillmentStatus": "Unreleased", "orderItemId": "85205", "orderItemInventoryStatus": "Allocated", "orderItemPrice": "100.00000", "orderItemStatus": "M", "partNumber": "AuroraWMDRS-001", "personTitle": "", "phone1": "", "phone1Publish": "true", "phone2": "", "phone2Publish": "true", "postalCode": "M1M1M1", "productId": "10040", "quantity": "1.0", "salesTax": "0.00000", "salesTaxCurrency": "USD", "shipModeCode": "US Regular Delivery", "shipModeDescription": "US - Regular Delivery", "shipModeId": "10051", "shipModeLanguage": "-1", "shippingCharge": "0.00000", "shippingChargeCurrency": "USD", "shippingTax": "0.00000", "shippingTaxCurrency": "USD", "state": "ON", "stateOrProvinceName": "ON", "totalAdjustment": { "currency": "USD", "value": "-10.00000" }, "unitPrice": "100.00000", "unitQuantity": "1.0", "unitUom": "C62", "usableShippingChargePolicy": [ { "name": "StandardShippingChargeBySeller", "type": "ShippingCharge", "uniqueID": "-7001" } ], "xitem_isPersonalAddressesAllowedForShipping": "true", "zipCode": "M1M1M1" } ], "orderStatus": "M", "orderTypeCode": "ORD", "paymentInstruction": [ { "addressLine": [ "123", "", "" ], "billing_address_id": "15808", "city": "Toronto", "country": "CA", "email1": "john@example.com", "email2": "", "fax1": "", "fax2": "", "firstName": "John", "lastName": "Smith", "middleName": "", "nickName": "john", "payMethodId": "VISA", "personTitle": "", "phone1": "", "phone1Publish": "true", "phone2": "", "phone2Publish": "true", "piAmount": "90.00000", "piCurrency": "USD", "piDescription": "VISA Credit Card", "piId": "14018", "piLanguage": "-1", "piStatus": "Pending", "postalCode": "M1M1M1", "protocolData": [ { "name": "expire_month", "value": "11" }, { "name": "billto_stateprovince", "value": "ON" }, { "name": "billto_city", "value": "Toronto" }, { "name": "cc_brand", "value": "VISA" }, { "name": "billing_address_id", "value": "15808" }, { "name": "account", "value": "***********11111" }, { "name": "billto_zipcode", "value": "M1M1M1" }, { "name": "cc_cvc", "value": "---" }, { "name": "billto_country", "value": "CA" }, { "name": "billto_address1", "value": "123" }, { "name": "payment_method", "value": "VISA" }, { "name": "expire_year", "value": "2014" }, { "name": "billto_lastname", "value": "Smith" }, { "name": "billto_firstname", "value": "John" } ], "state": "ON", "stateOrProvinceName": "ON", "xpaym_policyId": "10002", "zipCode": "M1M1M1" } ], "placedDate": "2014-11-24T20:02:27.056Z", "prepareIndicator": "true", "recordSetComplete": "true", "recordSetCount": "1", "recordSetStartNumber": "0", "recordSetTotal": "1", "resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/order\/25206?pageSize=20&accessProfile=IBM_Details&pageNumber=1&responseFormat=json", "resourceName": "order", "shipAsComplete": "true", "storeNameIdentifier": "Aurora", "storeUniqueID": "10001", "totalAdjustment": "-10.00000", "totalAdjustmentCurrency": "USD", "totalProductPrice": "100.00000", "totalProductPriceCurrency": "USD", "totalSalesTax": "0.00000", "totalSalesTaxCurrency": "USD", "totalShippingCharge": "0.00000", "totalShippingChargeCurrency": "USD", "totalShippingTax": "0.00000", "totalShippingTaxCurrency": "USD", "x_isPersonalAddressesAllowedForShipping": "true", "x_isPurchaseOrderNumberRequired": "false", "x_trackingIds": "" }
Gets the order history for the authenticated user.
findOrderHistory
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | integer | false | false |
pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | integer | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
Gets a list of orders by order status.
findByStatus
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
status | The order status. | path | string | true | N/A |
pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | integer | false | false |
pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | integer | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10001/order/byStatus/N,M,A,B,C,R,S,D,F,G,L?pageSize=3&pageNumber=1&responseFormat=json
200
{ "Order": [ { "adjustment": [ { "amount": "-10.00000", "code": "10% off order-10000202", "currency": "USD", "displayLevel": "Order", "usage": "Discount" } ], "buyerDistinguishedName": "uid=john,o=default organization,o=root organization", "buyerId": "11051", "grandTotal": "90.00000", "grandTotalCurrency": "USD", "lastUpdateDate": "2014-11-24T19:59:40.620Z", "locked": "false", "orderId": "24208", "orderStatus": "M", "orderTypeCode": "ORD", "placedDate": "2014-11-24T19:59:40.620Z", "prepareIndicator": "true", "promotionCode": [ { "associatedPromotion": [ { "description": { "language": "en", "value": "" }, "promotionIdentifier": { "calculationCodeIdentifier": null, "externalIdentifier": null, "uniqueID": "10000202" } } ], "code": "10%OFF", "reason": null, "userData": null } ], "resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/order\/24208", "shipAsComplete": "true", "storeNameIdentifier": "Aurora", "storeUniqueID": "10001", "totalAdjustment": "-10.00000", "totalAdjustmentCurrency": "USD", "totalProductPrice": "100.00000", "totalProductPriceCurrency": "USD", "totalSalesTax": "0.00000", "totalSalesTaxCurrency": "USD", "totalShippingCharge": "0.00000", "totalShippingChargeCurrency": "USD", "totalShippingTax": "0.00000", "totalShippingTaxCurrency": "USD", "x_isPersonalAddressesAllowedForShipping": "true", "x_isPurchaseOrderNumberRequired": "false", "x_trackingIds": "" }, { "adjustment": [ { "amount": "-465.00000", "code": "Furniture Category Discount", "currency": "USD", "description": "Save 20% on Furniture!", "descriptionLanguage": "-1", "displayLevel": "OrderItem", "usage": "Discount" }, { "amount": "-25.00000", "code": "Save $25 on all orders over $200 USD", "currency": "USD", "description": "Save $25 on all orders over $200 USD", "descriptionLanguage": "-1", "displayLevel": "Order", "usage": "Discount" } ], "buyerDistinguishedName": "uid=john,o=default organization,o=root organization", "buyerId": "11051", "grandTotal": "2080.45000", "grandTotalCurrency": "USD", "lastUpdateDate": "2014-11-20T14:31:21.258Z", "locked": "false", "orderId": "24207", "orderStatus": "M", "orderTypeCode": "ORD", "placedDate": "2014-11-20T14:31:21.258Z", "prepareIndicator": "true", "resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/order\/24207", "shipAsComplete": "true", "storeNameIdentifier": "Aurora", "storeUniqueID": "10001", "totalAdjustment": "-490.00000", "totalAdjustmentCurrency": "USD", "totalProductPrice": "2525.00000", "totalProductPriceCurrency": "USD", "totalSalesTax": "0.00000", "totalSalesTaxCurrency": "USD", "totalShippingCharge": "45.45000", "totalShippingChargeCurrency": "USD", "totalShippingTax": "0.00000", "totalShippingTaxCurrency": "USD", "x_isPersonalAddressesAllowedForShipping": "true", "x_isPurchaseOrderNumberRequired": "false", "x_trackingIds": "" } ], "recordSetComplete": "true", "recordSetCount": "2", "recordSetStartNumber": "0", "recordSetTotal": "2", "resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/order\/byStatus\/N,M,A,B,C,R,S,D,F,G,L?pageSize=3&pageNumber=1&responseFormat=json", "resourceName": "order" }
Name | Data Type | Required |
---|---|---|
value | string | false |
language | string | false |
Name | Data Type | Required |
---|---|---|
name | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
currency | string | false |
Name | Data Type | Required |
---|---|---|
uniqueID | string | false |
distinguishedName | string | false |
Name | Data Type | Required |
---|---|---|
storeIdentifier | com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType.storeIdentifier | false |
partNumber | string | true |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType.storeIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
nameIdentifier | string | false |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier | false |
uniqueID | string | false |
distinguishedName | string | false |
Name | Data Type | Required |
---|---|---|
identifier | string | false |
Name | Data Type | Required |
---|---|---|
uniqueID | string | false |
externalQuoteID | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
nameIdentifier | string | false |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
taxCategoryCode | string | false |
Name | Data Type | Required |
---|---|---|
resultList | com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList array | false |
Name | Data Type | Required |
---|---|---|
uniqueShippingAddresses | com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList.uniqueShippingAddresses array | false |
billingAddressDataBean | com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList.billingAddressDataBean | false |
allowableShippingAddress | com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList.allowableShippingAddress array | false |
paymentInfo | com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList.paymentInfo | false |
currentAddressDataBean | com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList.currentAddressDataBean | false |
orderItemDataBeans | com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList.orderItemDataBeans array | false |
Name | Data Type | Required |
---|---|---|
addressId | string | false |
Name | Data Type | Required |
---|---|---|
addressId | string | false |
Name | Data Type | Required |
---|---|---|
middleName | string | false |
lastName | string | false |
primary | string | false |
organizationUnitName | string | false |
phone1 | string | false |
personTitle | string | false |
phone2 | string | false |
mobilePhone1 | string | false |
billingCode | string | false |
addressField1 | string | false |
storeDirectory | string | false |
addressField2 | string | false |
packageSuppression | string | false |
addressField3 | string | false |
nickName | string | false |
addressType | string | false |
createdTimestamp | string | false |
state | string | false |
mobilePhone1Country | string | false |
memberId | string | false |
createdTime | string | false |
email1 | string | false |
country | string | false |
email2 | string | false |
officeAddress | string | false |
firstName | string | false |
phone1Type | string | false |
phone2Type | string | false |
organizationName | string | false |
billingCodeType | string | false |
dataBeanKeyAddressId | string | false |
city | string | false |
bestCallingTime | string | false |
zipCode | string | false |
addressId | string | false |
status | string | false |
publishPhone1 | string | false |
lastCreate | string | false |
stateProvDisplayName | string | false |
publishPhone2 | string | false |
fax1 | string | false |
fax2 | string | false |
countryDisplayName | string | false |
businessTitle | string | false |
address1 | string | false |
address2 | string | false |
isSelfAddress | string | false |
address3 | string | false |
Name | Data Type | Required |
---|---|---|
shippingMode | com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList.orderItemDataBeans.shippingMode | false |
shippingModeId | string | false |
Name | Data Type | Required |
---|---|---|
carrier | string | false |
shippingModeId | string | false |
code | string | false |
storeEntityId | string | false |
Name | Data Type | Required |
---|---|---|
middleName | string | false |
lastName | string | false |
primary | string | false |
organizationUnitName | string | false |
phone1 | string | false |
personTitle | string | false |
phone2 | string | false |
mobilePhone1 | string | false |
billingCode | string | false |
addressField1 | string | false |
storeDirectory | string | false |
addressField2 | string | false |
packageSuppression | string | false |
addressField3 | string | false |
nickName | string | false |
addressType | string | false |
createdTimestamp | string | false |
state | string | false |
mobilePhone1Country | string | false |
memberId | string | false |
createdTime | string | false |
email1 | string | false |
country | string | false |
email2 | string | false |
officeAddress | string | false |
firstName | string | false |
phone1Type | string | false |
phone2Type | string | false |
organizationName | string | false |
billingCodeType | string | false |
dataBeanKeyAddressId | string | false |
city | string | false |
bestCallingTime | string | false |
zipCode | string | false |
addressId | string | false |
status | string | false |
publishPhone1 | string | false |
lastCreate | string | false |
stateProvDisplayName | string | false |
publishPhone2 | string | false |
fax1 | string | false |
fax2 | string | false |
countryDisplayName | string | false |
businessTitle | string | false |
address1 | string | false |
address2 | string | false |
isSelfAddress | string | false |
address3 | string | false |
Name | Data Type | Required |
---|---|---|
adjustmentUsage | string | true |
adjustmentValue | string | false |
comments | com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.comments | false |
userData | com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.userData | false |
adjustmentCategory | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
language | string | false |
Name | Data Type | Required |
---|---|---|
userDataField | com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
userData | com.ibm.commerce.order.facade.datatypes.ChannelType.userData | false |
channelIdentifer | com.ibm.commerce.order.facade.datatypes.ChannelType.channelIdentifer | false |
description | com.ibm.commerce.order.facade.datatypes.ChannelType.description | false |
Name | Data Type | Required |
---|---|---|
uniqueID | string | false |
channelName | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
language | string | false |
Name | Data Type | Required |
---|---|---|
userDataField | com.ibm.commerce.order.facade.datatypes.ChannelType.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
couponId | string | false |
effectiveDateTime | string | false |
status | string | false |
userData | com.ibm.commerce.order.facade.datatypes.CouponCodeType.userData | false |
expirationDateTime | string | false |
promotionIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier | false |
description | com.ibm.commerce.order.facade.datatypes.CouponCodeType.description array | false |
code | string | false |
Name | Data Type | Required |
---|---|---|
shortDescription | string | false |
longDescription | string | false |
userData | com.ibm.commerce.order.facade.datatypes.CouponCodeType.description.userData | false |
language | string | false |
Name | Data Type | Required |
---|---|---|
userDataField | com.ibm.commerce.order.facade.datatypes.CouponCodeType.description.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
externalIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier | false |
uniqueID | string | false |
calculationCodeIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier | false |
Name | Data Type | Required |
---|---|---|
calculationCodeExternalIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
calculationUsageID | string | false |
storeIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier | false |
code | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
nameIdentifier | string | false |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
version | string | false |
storeIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier.storeIdentifier | false |
name | string | true |
revision | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
nameIdentifier | string | false |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
userDataField | com.ibm.commerce.order.facade.datatypes.CouponCodeType.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
changeReasonCode | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode | false |
userData | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.userData | false |
orderVersion | string | false |
cSRIdentifier | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.cSRIdentifier | false |
creationDate | string | false |
comment | string | false |
Name | Data Type | Required |
---|---|---|
reasonCode | string | false |
userData | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode.userData | false |
description | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode.description | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
language | string | false |
Name | Data Type | Required |
---|---|---|
userDataField | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
externalIdentifier | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.cSRIdentifier.externalIdentifier | false |
uniqueID | string | false |
distinguishedName | string | false |
Name | Data Type | Required |
---|---|---|
identifier | string | false |
Name | Data Type | Required |
---|---|---|
userDataField | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
paymentInstructionID | string | false |
requestAmount | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.requestAmount | false |
paymentProtocolData | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.paymentProtocolData array | false |
transactionExtensionData | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.transactionExtensionData array | false |
avsCode | string | false |
responseCode | string | false |
merchantOrderNumber | string | false |
reasonCode | string | false |
trackingID | string | false |
status | string | false |
referenceNumber | string | false |
userData | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.userData | false |
transactionType | string | false |
requestTime | string | false |
expirationTime | string | false |
financialTransactionIdentifier | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.financialTransactionIdentifier | false |
lastUpdate | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | string | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
name | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
currency | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
name | string | true |
Name | Data Type | Required |
---|---|---|
userDataField | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
userData | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.userData | false |
orderBlock | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock array | false |
Name | Data Type | Required |
---|---|---|
blockReason | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason | false |
comments | string | false |
resovled | string | false |
userData | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.userData | false |
timeBlocked | string | false |
Name | Data Type | Required |
---|---|---|
reasonCode | string | false |
userData | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason.userData | false |
reansonType | string | false |
description | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason.description | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
language | string | false |
Name | Data Type | Required |
---|---|---|
userDataField | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
userDataField | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
userDataField | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
configurationID | string | false |
catalogEntryIdentifier | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier | false |
orderItemComponentIdentifier | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.orderItemComponentIdentifier | false |
unitPrice | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice | false |
userData | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.userData | false |
quantity | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.quantity | false |
required | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
storeIdentifier | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier.storeIdentifier | false |
partNumber | string | true |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
nameIdentifier | string | false |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
uom | string | false |
Name | Data Type | Required |
---|---|---|
price | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice.price | false |
alternativeCurrencyPrice | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice.alternativeCurrencyPrice array | false |
quantity | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice.quantity | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
currency | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
currency | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
uom | string | false |
Name | Data Type | Required |
---|---|---|
userDataField | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
parentOrderItemIdentifier | com.ibm.commerce.order.facade.datatypes.ParentInfoType.parentOrderItemIdentifier | false |
relationTypeCode | string | false |
userData | com.ibm.commerce.order.facade.datatypes.ParentInfoType.userData | false |
parentOrderIdentifier | com.ibm.commerce.order.facade.datatypes.ParentInfoType.parentOrderIdentifier | false |
Name | Data Type | Required |
---|---|---|
customerOrderNumber | string | false |
uniqueID | string | false |
externalOrderID | string | false |
Name | Data Type | Required |
---|---|---|
externalOrderItemID | string | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
userDataField | com.ibm.commerce.order.facade.datatypes.ParentInfoType.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
reason | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason | false |
userData | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.userData | false |
code | string | false |
associatedPromotion | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion array | false |
Name | Data Type | Required |
---|---|---|
promotionIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier | false |
description | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.description | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
language | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier | false |
uniqueID | string | false |
calculationCodeIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier | false |
Name | Data Type | Required |
---|---|---|
calculationCodeExternalIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
calculationUsageID | string | false |
storeIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier | false |
code | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
nameIdentifier | string | false |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
version | string | false |
storeIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier.storeIdentifier | false |
name | string | true |
revision | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
nameIdentifier | string | false |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
reasonCode | string | false |
userData | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.userData | false |
valid | string | false |
description | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.description | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
language | string | false |
Name | Data Type | Required |
---|---|---|
userDataField | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
userDataField | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
orderItem | order-orderDetail.orderItem array | false |
totalAdjustmentCurrency | string | false |
channel | com.ibm.commerce.order.facade.datatypes.ChannelType | false |
rewardOption | order-orderDetail.rewardOption array | false |
orderId | string | false |
locked | string | false |
placedDate | string | false |
pysicalStoreId | string | false |
xstat_ | java.util.Map$Entry array | false |
totalSalesTaxCurrency | string | false |
financialTransaction | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType array | false |
adjustmentRequirement | com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType array | false |
cSRComments | com.ibm.commerce.order.facade.datatypes.CSRCommentsType array | false |
totalShippingChargeCurrency | string | false |
quoteID | string | false |
grandTotal | string | false |
requestedShipDate | string | false |
paymentStatus | string | false |
externalOrderID | string | false |
paymentInstruction | order-orderDetail.paymentInstruction array | false |
buyerApprovalStatus | string | false |
orderVersion | string | false |
recordSetComplete | string | false |
genericTotal | com.ibm.commerce.foundation.common.datatypes.GenericTotalType array | false |
storeUniqueID | string | false |
buyerId | string | false |
totalProductPriceCurrency | string | false |
addressId | string | false |
orgUniqueID | string | false |
promotionCode | com.ibm.commerce.order.facade.datatypes.PromotionCodeType array | false |
couponCode | com.ibm.commerce.order.facade.datatypes.CouponCodeType array | false |
orderTypeCode | string | false |
totalShippingTax | string | false |
recordSetStartNumber | string | false |
recordSetCount | string | false |
quoteIdentifier | com.ibm.commerce.foundation.common.datatypes.QuoteIdentifierType | false |
prepareIndicator | string | false |
grandTotalCurrency | string | false |
lastUpdateDate | string | false |
orderDescription | string | false |
totalAdjustment | string | false |
storeNameIdentifier | string | false |
orderEditor | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType | false |
buyerPONumber | string | false |
orderStatus | string | false |
totalSalesTax | string | false |
editable | string | false |
userDataField | order-orderDetail.userDataField array | false |
totalShippingCharge | string | false |
shipAsComplete | string | false |
totalShippingTaxCurrency | string | false |
totalTaxByTaxCategory | order-orderDetail.totalTaxByTaxCategory array | false |
orgDistinguishedName | string | false |
blocked | string | false |
storeOwnerID | string | false |
adjustment | order-orderDetail.adjustment array | false |
recordSetTotal | string | false |
comments | string | false |
parentInfo | com.ibm.commerce.order.facade.datatypes.ParentInfoType | false |
customerOrderNumber | string | false |
shipModeId | string | false |
bLockInfo | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType | false |
buyerDistinguishedName | string | false |
totalProductPrice | string | false |
Name | Data Type | Required |
---|---|---|
currency | string | false |
usage | string | false |
displayLevel | string | false |
descriptionLanguage | string | false |
userDataField | order-orderDetail.adjustment.userDataField array | false |
amount | string | false |
description | string | false |
code | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
primary | string | false |
shippingCharge | string | false |
personTitle | string | false |
physicalStoreId | string | false |
taxByTaxCategory | com.ibm.commerce.foundation.common.datatypes.TaxByTaxCategoryType array | false |
addressLine | string array | false |
alternativeCurrencyPrice | com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType array | false |
phone1Publish | string | false |
ownerID | string | false |
currency | string | false |
mobilePhone1Country | string | true |
email1 | string | true |
email2 | string | true |
availableDate | string | false |
partNumber | string | true |
correlationGroup | string | false |
shippingTax | string | false |
unitPrice | string | false |
fulfillmentCenterDescription | com.ibm.commerce.foundation.common.datatypes.DescriptionType | false |
timeReleased | string | false |
bestCallingTime | string | false |
unitQuantity | string | false |
addressId | string | false |
physicalStoreExternalId | string | false |
salesTaxCurrency | string | false |
shippingChargeCurrency | string | false |
priceOverride | string | false |
trackingURL | string | false |
organizationIdentifier | com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType | false |
lastName | string | false |
orderItemPrice | string | false |
lastUpdateDate | string | false |
addressType | string | false |
fulfillmentCenterId | string | false |
shippingTaxCurrency | string | false |
stateOrProvinceName | string | false |
attributes | order-orderDetail.orderItem.attributes array | false |
language | string | false |
postalCode | string | false |
firstName | string | false |
shippingChargeType | string | true |
phone1Type | string | false |
organizationName | string | false |
storeIdentifier | com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType | false |
productId | string | false |
city | string | false |
adjustment | order-orderDetail.orderItem.adjustment array | false |
offerID | string | false |
shipModeLanguage | string | false |
businessTitle | string | false |
shipModeId | string | false |
isExpedited | string | false |
orderItemId | string | false |
orderItemComponent | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType array | false |
shipModeDescription | string | false |
organizationUnitName | string | false |
phone1 | string | true |
phone2 | string | true |
quantity | string | false |
shipModeCode | string | false |
shippingCarrierAccountNumber | string | false |
nickName | string | true |
state | string | false |
externalOrderItemID | string | false |
configurationID | string | false |
country | string | false |
adjustmentRequirement | com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType array | false |
requestedShipDate | string | false |
shipCarrAccntNum | string | false |
orderItemInventoryStatus | string | false |
genericTotal | com.ibm.commerce.foundation.common.datatypes.GenericTotalType array | false |
zipCode | string | false |
shipInstruction | string | false |
fax1 | string | true |
fax2 | string | true |
freeGift | string | false |
geographicalShippingCode | string | false |
middleName | string | false |
shipTieCode | string | false |
mobilePhone1 | string | true |
timeShipped | string | false |
itemAttributes | order-orderDetail.orderItem.itemAttributes array | false |
createDate | string | false |
contractId | string | false |
totalAdjustment | com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType | false |
orderItemStatus | string | false |
internalOfficeAddress | string | false |
fulfillmentCenterOwnerId | string | false |
storeId | string | false |
personIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType | false |
phone2Type | string | false |
expectedShipDate | string | false |
userDataField | order-orderDetail.orderItem.userDataField array | false |
phone2Publish | string | false |
usableShippingChargePolicy | order-orderDetail.orderItem.usableShippingChargePolicy array | false |
orderItemFulfillmentStatus | string | false |
unitUom | string | false |
shippingChargePolicyID | string | false |
UOM | string | false |
comments | string | false |
geographicalTaxCode | string | false |
carrier | string | false |
fulfillmentCenterName | string | false |
salesTax | string | false |
Name | Data Type | Required |
---|---|---|
currency | string | false |
usage | string | false |
userDataField | order-orderDetail.orderItem.adjustment.userDataField array | false |
language | string | false |
amount | string | false |
description | string | false |
code | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
attrValue | string | false |
attrKey | string | true |
Name | Data Type | Required |
---|---|---|
attrValue | string | false |
attrName | string | true |
Name | Data Type | Required |
---|---|---|
type | string | true |
name | string | true |
uniqueID | string | false |
storeId | com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
primary | string | false |
organizationUnitName | string | false |
personTitle | string | false |
phone1 | string | true |
phone2 | string | true |
addressLine | string array | false |
billing_address_id | string | false |
phone1Publish | string | false |
nickName | string | true |
refundAllowed | string | false |
state | string | false |
mobilePhone1Country | string | true |
email1 | string | true |
email2 | string | true |
country | string | false |
paymentRule | string | false |
paymentTermConditionId | string | false |
payMethodId | string | false |
priority | string | false |
piCurrency | string | false |
bestCallingTime | string | false |
zipCode | string | false |
piAmount | string | false |
fax1 | string | true |
fax2 | string | true |
organizationIdentifier | com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType | false |
geographicalShippingCode | string | false |
middleName | string | false |
lastName | string | false |
piDescription | string | false |
mobilePhone1 | string | true |
minAmount | com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType | false |
piStatus | string | false |
addressType | string | false |
stateOrProvinceName | string | false |
attributes | order-orderDetail.paymentInstruction.attributes array | false |
language | string | false |
postalCode | string | false |
internalOfficeAddress | string | false |
firstName | string | false |
maxAmount | com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType | false |
phone1Type | string | false |
personIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType | false |
phone2Type | string | false |
organizationName | string | false |
protocolData | order-orderDetail.paymentInstruction.protocolData array | false |
userDataField | order-orderDetail.paymentInstruction.userDataField array | false |
sequenceNumber | string | false |
city | string | false |
phone2Publish | string | false |
piLanguage | string | false |
piId | string | false |
geographicalTaxCode | string | false |
businessTitle | string | false |
Name | Data Type | Required |
---|---|---|
attrValue | string | false |
attrKey | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
name | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
rewardSpecGiftItem | order-orderDetail.rewardOption.rewardSpecGiftItem array | false |
rewardOptionIdentifier | order-orderDetail.rewardOption.rewardOptionIdentifier | true |
adjustmentDescription | string | false |
giftSetSpecification | order-orderDetail.rewardOption.giftSetSpecification | false |
giftSet | order-orderDetail.rewardOption.giftSet | false |
rewardSpecification | order-orderDetail.rewardOption.rewardSpecification | false |
userData | order-orderDetail.rewardOption.userData | false |
amount | order-orderDetail.rewardOption.amount | false |
adjustmentCurrency | string | false |
usage | string | false |
displayLevel | string | false |
isPromotionCodeRequired | string | false |
adjustmentAmount | string | false |
rewardSpecMaxQuantity | string | false |
adjustmentLanguage | string | false |
rewardOptionExternalId | string | false |
adjustment | order-orderDetail.rewardOption.adjustment | false |
code | string | false |
rewardSpecMaxQuantityUom | string | false |
adjustmentDisplayLevel | string | false |
rewardChoice | order-orderDetail.rewardOption.rewardChoice | false |
calculationCodeID | order-orderDetail.rewardOption.calculationCodeID | false |
rewardChoiceGiftItem | order-orderDetail.rewardOption.rewardChoiceGiftItem array | false |
adjustmentUsage | string | false |
adjustmentCode | string | false |
description | order-orderDetail.rewardOption.description | false |
promotionType | string | false |
rewardOptionId | string | false |
Name | Data Type | Required |
---|---|---|
usage | string | false |
calculationCodeID | order-orderDetail.rewardOption.adjustment.calculationCodeID | false |
displayLevel | string | false |
isPromotionCodeRequired | string | false |
userData | order-orderDetail.rewardOption.adjustment.userData | false |
amount | order-orderDetail.rewardOption.adjustment.amount | false |
description | order-orderDetail.rewardOption.adjustment.description | false |
code | string | false |
promotionType | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
currency | string | false |
Name | Data Type | Required |
---|---|---|
calculationCodeExternalIdentifier | order-orderDetail.rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
calculationUsageID | string | false |
storeIdentifier | order-orderDetail.rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier | false |
code | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | order-orderDetail.rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
nameIdentifier | string | false |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
language | string | false |
Name | Data Type | Required |
---|---|---|
userDataField | order-orderDetail.rewardOption.adjustment.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
currency | string | false |
Name | Data Type | Required |
---|---|---|
calculationCodeExternalIdentifier | order-orderDetail.rewardOption.calculationCodeID.calculationCodeExternalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
calculationUsageID | string | false |
storeIdentifier | order-orderDetail.rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier | false |
code | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | order-orderDetail.rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
nameIdentifier | string | false |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
language | string | false |
Name | Data Type | Required |
---|---|---|
giftItem | order-orderDetail.rewardOption.giftSet.giftItem array | false |
Name | Data Type | Required |
---|---|---|
catalogEntryIdentifier | order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier | false |
quantity | order-orderDetail.rewardOption.giftSet.giftItem.quantity | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
storeIdentifier | order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier | false |
partNumber | string | true |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
nameIdentifier | string | false |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
uom | string | false |
Name | Data Type | Required |
---|---|---|
giftItem | order-orderDetail.rewardOption.giftSetSpecification.giftItem array | false |
maximumQuantity | order-orderDetail.rewardOption.giftSetSpecification.maximumQuantity | true |
Name | Data Type | Required |
---|---|---|
catalogEntryIdentifier | order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier | false |
quantity | order-orderDetail.rewardOption.giftSetSpecification.giftItem.quantity | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
storeIdentifier | order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier | false |
partNumber | string | true |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
nameIdentifier | string | false |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
uom | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
uom | string | false |
Name | Data Type | Required |
---|---|---|
giftSet | order-orderDetail.rewardOption.rewardChoice.giftSet | false |
userData | order-orderDetail.rewardOption.rewardChoice.userData | false |
Name | Data Type | Required |
---|---|---|
giftItem | order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem array | false |
Name | Data Type | Required |
---|---|---|
catalogEntryIdentifier | order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier | false |
quantity | order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.quantity | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
storeIdentifier | order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier | false |
partNumber | string | true |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
nameIdentifier | string | false |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
uom | string | false |
Name | Data Type | Required |
---|---|---|
userDataField | order-orderDetail.rewardOption.rewardChoice.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
uom | string | false |
externalIdentifier | com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType | false |
productId | string | false |
quantity | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | string | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
uom | string | false |
externalIdentifier | com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType | false |
productId | string | false |
Name | Data Type | Required |
---|---|---|
giftSetSpecification | order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification | false |
userData | order-orderDetail.rewardOption.rewardSpecification.userData | false |
Name | Data Type | Required |
---|---|---|
giftItem | order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem array | false |
maximumQuantity | order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.maximumQuantity | true |
Name | Data Type | Required |
---|---|---|
catalogEntryIdentifier | order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier | false |
quantity | order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.quantity | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
storeIdentifier | order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier | false |
partNumber | string | true |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
uniqueID | string | false |
Name | Data Type | Required |
---|---|---|
nameIdentifier | string | false |
ownerID | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
uom | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
uom | string | false |
Name | Data Type | Required |
---|---|---|
userDataField | order-orderDetail.rewardOption.rewardSpecification.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
userDataField | order-orderDetail.rewardOption.userData.userDataField array | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
currency | string | false |
taxCategoryCode | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
orderItem | order-orderItemConfiguration.orderItem array | false |
recordSetTotal | string | false |
recordSetStartNumber | string | false |
recordSetComplete | string | false |
recordSetCount | string | false |
Name | Data Type | Required |
---|---|---|
orderItemConfiguration | string | false |
orderItemId | string | false |
Name | Data Type | Required |
---|---|---|
recordSetTotal | string | false |
recordSetComplete | string | false |
recordSetStartNumber | string | false |
recordSetCount | string | false |
Order | order-orderSummary_item array | false |
Name | Data Type | Required |
---|---|---|
totalAdjustmentCurrency | string | false |
channel | com.ibm.commerce.order.facade.datatypes.ChannelType | false |
orderId | string | false |
locked | string | false |
placedDate | string | false |
xstat_ | java.util.Map$Entry array | false |
totalSalesTaxCurrency | string | false |
adjustmentRequirement | com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType array | false |
cSRComments | com.ibm.commerce.order.facade.datatypes.CSRCommentsType array | false |
quoteID | string | false |
totalShippingChargeCurrency | string | false |
grandTotal | string | false |
externalOrderID | string | false |
buyerApprovalStatus | string | false |
orderVersion | string | false |
genericTotal | com.ibm.commerce.foundation.common.datatypes.GenericTotalType array | false |
storeUniqueID | string | false |
buyerId | string | false |
totalProductPriceCurrency | string | false |
promotionCode | com.ibm.commerce.order.facade.datatypes.PromotionCodeType array | false |
orgUniqueID | string | false |
couponCode | com.ibm.commerce.order.facade.datatypes.CouponCodeType array | false |
orderTypeCode | string | false |
totalShippingTax | string | false |
quoteIdentifier | com.ibm.commerce.foundation.common.datatypes.QuoteIdentifierType | false |
prepareIndicator | string | false |
grandTotalCurrency | string | false |
lastUpdateDate | string | false |
orderDescription | string | false |
totalAdjustment | string | false |
storeNameIdentifier | string | false |
orderEditor | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType | false |
buyerPONumber | string | false |
orderStatus | string | false |
totalSalesTax | string | false |
editable | string | false |
userDataField | order-orderSummary_item.userDataField array | false |
totalShippingCharge | string | false |
shipAsComplete | string | false |
totalShippingTaxCurrency | string | false |
totalTaxByTaxCategory | order-orderSummary_item.totalTaxByTaxCategory array | false |
orgDistinguishedName | string | false |
blocked | string | false |
adjustment | order-orderSummary_item.adjustment array | false |
storeOwnerID | string | false |
comments | string | false |
parentInfo | com.ibm.commerce.order.facade.datatypes.ParentInfoType | false |
customerOrderNumber | string | false |
bLockInfo | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType | false |
buyerDistinguishedName | string | false |
totalProductPrice | string | false |
Name | Data Type | Required |
---|---|---|
currency | string | false |
usage | string | false |
displayLevel | string | false |
descriptionLanguage | string | false |
userDataField | order-orderSummary_item.adjustment.userDataField array | false |
amount | string | false |
description | string | false |
code | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
currency | string | false |
value | string | false |
taxCategoryCode | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |