order

This class provides RESTful services to get order history and order details.

Handler Class:

com.ibm.commerce.rest.order.handler.OrderHandler

Method Summary

HTTP MethodPathDescription
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=findByParentOrderIdFind order by the parent order ID.
GET/store/{storeId}/order?q=findByStatusExtFind order status by external order ID.
GET/store/{storeId}/order?q=findChildOrderByOrderItemIdFind child order by order item ID
GET/store/{storeId}/order?q=findConfigurationByOrderItemIdGet an order item configuration by an order item ID.
GET/store/{storeId}/order?q=orderProfileFind 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/@historyGets the order history for the authenticated user.
GET/store/{storeId}/order/byStatus/{status}Gets a list of orders by order status.

Method Details

GET /store/{storeId}/order?q={q}

Finds orders by a query. See each query for details on input and output.

Handler Method:

findByQuery

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
qThe query name.querystringtruefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
500Internal server error. Additional details will be contained on the server logs.

GET /store/{storeId}/order?q=findByParentOrderId

Find order by the parent order ID.

Handler Method:

findByParentOrderId

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
qThe query name.querystringtruefalse
orderIdThe order identifier.querystringtruefalse
pageNumberPage number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.querystringfalsefalse
pageSizePage 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.querystringfalsefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

order-orderSummary

GET /store/{storeId}/order?q=findByStatusExt

Find order status by external order ID.

Handler Method:

findByStatusExt

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
qThe query name.querystringtruefalse
extOrderIdThe external order identifier.querystringfalsefalse
pageNumberPage number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.querystringfalsefalse
pageSizePage 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.querystringfalsefalse
recordSetTotalThe total number of records in set.querystringtruefalse
statusThe order status.querystringtruefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

order-orderSummary

GET /store/{storeId}/order?q=findChildOrderByOrderItemId

Find child order by order item ID

Handler Method:

findChildOrderByOrderItemId

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
qThe query name.querystringtruefalse
orderItemIdThe order item identifier.querystringtruefalse
pageNumberPage number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.querystringfalsefalse
pageSizePage 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.querystringfalsefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

order-orderSummary

GET /store/{storeId}/order?q=findConfigurationByOrderItemId

Get an order item configuration by an order item ID.

Handler Method:

findConfigurationByOrderItemId

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
qThe query name.querystringtruefalse
orderItemIdThe order item identifier.querystringtruefalse
pageNumberPage number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.querystringfalsefalse
pageSizePage 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.querystringfalsefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

order-orderItemConfiguration

GET /store/{storeId}/order?q=orderProfile

Find the profile order and its default payment and billing information.

Handler Method:

orderProfile

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
retrievalOrderStatusThe order status to use for the retrieval of orders.querystringfalsefalse
profileNameProfile name. Profiles determine the subset of data to be returned by a query.querystringfalsefalse
qThe query name.querystringtruefalse
userIdqueryintegerfalsefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary


Example

Request:
GET /wcs/resources/store/10001/order?q=orderProfile&userId=11051&retrievalOrderStatus=Q&responseFormat=json
HTTP Status Code:

200

Response:
{
	"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"
				}
			]
		}
	]
}

GET /store/{storeId}/order/{orderId}

Gets the order details for a specific order ID.

Handler Method:

findByOrderId

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
orderIdThe order identifier.pathstringtrueN/A
storeIdThe store identifier.pathstringtrueN/A
pageNumberPage number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.queryintegerfalsefalse
pageSizePage 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.queryintegerfalsefalse
profileNameProfile name. Profiles determine the subset of data to be returned by a query.querystringfalsefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
404The specified resource couldn't be found.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

order-orderDetail


Example

Request:
GET /wcs/resources/store/10001/order/25206?pageSize=20&accessProfile=IBM_Details&pageNumber=1&responseFormat=json
HTTP Status Code:

200

Response:
{
	"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": ""
}

GET /store/{storeId}/order/@history

Gets the order history for the authenticated user.

Handler Method:

findOrderHistory

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
pageNumberPage number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.queryintegerfalsefalse
pageSizePage 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.queryintegerfalsefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

order-orderSummary

GET /store/{storeId}/order/byStatus/{status}

Gets a list of orders by order status.

Handler Method:

findByStatus

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
statusThe order status.pathstringtrueN/A
pageNumberPage number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work.queryintegerfalsefalse
pageSizePage 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.queryintegerfalsefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

order-orderSummary


Example

Request:
GET /wcs/resources/store/10001/order/byStatus/N,M,A,B,C,R,S,D,F,G,L?pageSize=3&pageNumber=1&responseFormat=json
HTTP Status Code:

200

Response:
{
	"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"
}

Data Type Details

com.ibm.commerce.foundation.common.datatypes.DescriptionType

Properties:
NameData TypeRequired
valuestringfalse
languagestringfalse

com.ibm.commerce.foundation.common.datatypes.GenericTotalType

Properties:
NameData TypeRequired
namestringfalse

com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType

Properties:
NameData TypeRequired
valuestringfalse
currencystringfalse

com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType

Properties:
NameData TypeRequired
uniqueIDstringfalse
distinguishedNamestringfalse

com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType

Properties:
NameData TypeRequired
storeIdentifiercom.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType.storeIdentifierfalse
partNumberstringtrue
ownerIDstringfalse

com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType.storeIdentifier

Properties:
NameData TypeRequired
externalIdentifiercom.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType.storeIdentifier.externalIdentifierfalse
uniqueIDstringfalse

com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType.storeIdentifier.externalIdentifier

Properties:
NameData TypeRequired
nameIdentifierstringfalse
ownerIDstringfalse

com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType

Properties:
NameData TypeRequired
externalIdentifiercom.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifierfalse
uniqueIDstringfalse
distinguishedNamestringfalse

com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier

Properties:
NameData TypeRequired
identifierstringfalse

com.ibm.commerce.foundation.common.datatypes.QuoteIdentifierType

Properties:
NameData TypeRequired
uniqueIDstringfalse
externalQuoteIDstringfalse

com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType

Properties:
NameData TypeRequired
externalIdentifiercom.ibm.commerce.foundation.common.datatypes.StoreIdentifierType.externalIdentifierfalse
uniqueIDstringfalse

com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType.externalIdentifier

Properties:
NameData TypeRequired
nameIdentifierstringfalse
ownerIDstringfalse

com.ibm.commerce.foundation.common.datatypes.TaxByTaxCategoryType

Properties:
NameData TypeRequired
taxCategoryCodestringfalse

com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary

Properties:
NameData TypeRequired
resultListcom.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList arrayfalse

com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList.allowableShippingAddress

Properties:
NameData TypeRequired
addressIdstringfalse

com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList.billingAddressDataBean

Properties:
NameData TypeRequired
addressIdstringfalse

com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList.currentAddressDataBean

Properties:
NameData TypeRequired
middleNamestringfalse
lastNamestringfalse
primarystringfalse
organizationUnitNamestringfalse
phone1stringfalse
personTitlestringfalse
phone2stringfalse
mobilePhone1stringfalse
billingCodestringfalse
addressField1stringfalse
storeDirectorystringfalse
addressField2stringfalse
packageSuppressionstringfalse
addressField3stringfalse
nickNamestringfalse
addressTypestringfalse
createdTimestampstringfalse
statestringfalse
mobilePhone1Countrystringfalse
memberIdstringfalse
createdTimestringfalse
email1stringfalse
countrystringfalse
email2stringfalse
officeAddressstringfalse
firstNamestringfalse
phone1Typestringfalse
phone2Typestringfalse
organizationNamestringfalse
billingCodeTypestringfalse
dataBeanKeyAddressIdstringfalse
citystringfalse
bestCallingTimestringfalse
zipCodestringfalse
addressIdstringfalse
statusstringfalse
publishPhone1stringfalse
lastCreatestringfalse
stateProvDisplayNamestringfalse
publishPhone2stringfalse
fax1stringfalse
fax2stringfalse
countryDisplayNamestringfalse
businessTitlestringfalse
address1stringfalse
address2stringfalse
isSelfAddressstringfalse
address3stringfalse

com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList.orderItemDataBeans

Properties:
NameData TypeRequired
shippingModecom.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList.orderItemDataBeans.shippingModefalse
shippingModeIdstringfalse

com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList.orderItemDataBeans.shippingMode

Properties:
NameData TypeRequired
carrierstringfalse
shippingModeIdstringfalse
codestringfalse
storeEntityIdstringfalse

com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList.paymentInfo

com.ibm.commerce.order.beans.OrderListDataBean_IBM_Summary.resultList.uniqueShippingAddresses

Properties:
NameData TypeRequired
middleNamestringfalse
lastNamestringfalse
primarystringfalse
organizationUnitNamestringfalse
phone1stringfalse
personTitlestringfalse
phone2stringfalse
mobilePhone1stringfalse
billingCodestringfalse
addressField1stringfalse
storeDirectorystringfalse
addressField2stringfalse
packageSuppressionstringfalse
addressField3stringfalse
nickNamestringfalse
addressTypestringfalse
createdTimestampstringfalse
statestringfalse
mobilePhone1Countrystringfalse
memberIdstringfalse
createdTimestringfalse
email1stringfalse
countrystringfalse
email2stringfalse
officeAddressstringfalse
firstNamestringfalse
phone1Typestringfalse
phone2Typestringfalse
organizationNamestringfalse
billingCodeTypestringfalse
dataBeanKeyAddressIdstringfalse
citystringfalse
bestCallingTimestringfalse
zipCodestringfalse
addressIdstringfalse
statusstringfalse
publishPhone1stringfalse
lastCreatestringfalse
stateProvDisplayNamestringfalse
publishPhone2stringfalse
fax1stringfalse
fax2stringfalse
countryDisplayNamestringfalse
businessTitlestringfalse
address1stringfalse
address2stringfalse
isSelfAddressstringfalse
address3stringfalse

com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType

Properties:
NameData TypeRequired
adjustmentUsagestringtrue
adjustmentValuestringfalse
commentscom.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.commentsfalse
userDatacom.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.userDatafalse
adjustmentCategorystringtrue

com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.comments

Properties:
NameData TypeRequired
valuestringfalse
languagestringfalse

com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.userData

Properties:
NameData TypeRequired
userDataFieldcom.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.userData.userDataField arrayfalse

com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

com.ibm.commerce.order.facade.datatypes.ChannelType

com.ibm.commerce.order.facade.datatypes.ChannelType.channelIdentifer

Properties:
NameData TypeRequired
uniqueIDstringfalse
channelNamestringfalse

com.ibm.commerce.order.facade.datatypes.ChannelType.description

Properties:
NameData TypeRequired
valuestringfalse
languagestringfalse

com.ibm.commerce.order.facade.datatypes.ChannelType.userData

Properties:
NameData TypeRequired
userDataFieldcom.ibm.commerce.order.facade.datatypes.ChannelType.userData.userDataField arrayfalse

com.ibm.commerce.order.facade.datatypes.ChannelType.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

com.ibm.commerce.order.facade.datatypes.CouponCodeType

Properties:
NameData TypeRequired
couponIdstringfalse
effectiveDateTimestringfalse
statusstringfalse
userDatacom.ibm.commerce.order.facade.datatypes.CouponCodeType.userDatafalse
expirationDateTimestringfalse
promotionIdentifiercom.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifierfalse
descriptioncom.ibm.commerce.order.facade.datatypes.CouponCodeType.description arrayfalse
codestringfalse

com.ibm.commerce.order.facade.datatypes.CouponCodeType.description

Properties:
NameData TypeRequired
shortDescriptionstringfalse
longDescriptionstringfalse
userDatacom.ibm.commerce.order.facade.datatypes.CouponCodeType.description.userDatafalse
languagestringfalse

com.ibm.commerce.order.facade.datatypes.CouponCodeType.description.userData

Properties:
NameData TypeRequired
userDataFieldcom.ibm.commerce.order.facade.datatypes.CouponCodeType.description.userData.userDataField arrayfalse

com.ibm.commerce.order.facade.datatypes.CouponCodeType.description.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier

com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier

Properties:
NameData TypeRequired
calculationCodeExternalIdentifiercom.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifierfalse
uniqueIDstringfalse

com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier

Properties:
NameData TypeRequired
calculationUsageIDstringfalse
storeIdentifiercom.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifierfalse
codestringfalse

com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier

com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier

Properties:
NameData TypeRequired
nameIdentifierstringfalse
ownerIDstringfalse

com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier

Properties:
NameData TypeRequired
versionstringfalse
storeIdentifiercom.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier.storeIdentifierfalse
namestringtrue
revisionstringfalse

com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier.storeIdentifier

com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier.storeIdentifier.externalIdentifier

Properties:
NameData TypeRequired
nameIdentifierstringfalse
ownerIDstringfalse

com.ibm.commerce.order.facade.datatypes.CouponCodeType.userData

Properties:
NameData TypeRequired
userDataFieldcom.ibm.commerce.order.facade.datatypes.CouponCodeType.userData.userDataField arrayfalse

com.ibm.commerce.order.facade.datatypes.CouponCodeType.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

com.ibm.commerce.order.facade.datatypes.CSRCommentsType

Properties:
NameData TypeRequired
changeReasonCodecom.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCodefalse
userDatacom.ibm.commerce.order.facade.datatypes.CSRCommentsType.userDatafalse
orderVersionstringfalse
cSRIdentifiercom.ibm.commerce.order.facade.datatypes.CSRCommentsType.cSRIdentifierfalse
creationDatestringfalse
commentstringfalse

com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode

com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode.description

Properties:
NameData TypeRequired
valuestringfalse
languagestringfalse

com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode.userData

com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

com.ibm.commerce.order.facade.datatypes.CSRCommentsType.cSRIdentifier

Properties:
NameData TypeRequired
externalIdentifiercom.ibm.commerce.order.facade.datatypes.CSRCommentsType.cSRIdentifier.externalIdentifierfalse
uniqueIDstringfalse
distinguishedNamestringfalse

com.ibm.commerce.order.facade.datatypes.CSRCommentsType.cSRIdentifier.externalIdentifier

Properties:
NameData TypeRequired
identifierstringfalse

com.ibm.commerce.order.facade.datatypes.CSRCommentsType.userData

Properties:
NameData TypeRequired
userDataFieldcom.ibm.commerce.order.facade.datatypes.CSRCommentsType.userData.userDataField arrayfalse

com.ibm.commerce.order.facade.datatypes.CSRCommentsType.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

com.ibm.commerce.order.facade.datatypes.FinancialTransactionType

Properties:
NameData TypeRequired
paymentInstructionIDstringfalse
requestAmountcom.ibm.commerce.order.facade.datatypes.FinancialTransactionType.requestAmountfalse
paymentProtocolDatacom.ibm.commerce.order.facade.datatypes.FinancialTransactionType.paymentProtocolData arrayfalse
transactionExtensionDatacom.ibm.commerce.order.facade.datatypes.FinancialTransactionType.transactionExtensionData arrayfalse
avsCodestringfalse
responseCodestringfalse
merchantOrderNumberstringfalse
reasonCodestringfalse
trackingIDstringfalse
statusstringfalse
referenceNumberstringfalse
userDatacom.ibm.commerce.order.facade.datatypes.FinancialTransactionType.userDatafalse
transactionTypestringfalse
requestTimestringfalse
expirationTimestringfalse
financialTransactionIdentifiercom.ibm.commerce.order.facade.datatypes.FinancialTransactionType.financialTransactionIdentifierfalse
lastUpdatestringfalse

com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.financialTransactionIdentifier

Properties:
NameData TypeRequired
externalIdentifierstringfalse
uniqueIDstringfalse

com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.paymentProtocolData

Properties:
NameData TypeRequired
valuestringfalse
namestringtrue

com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.requestAmount

Properties:
NameData TypeRequired
valuestringfalse
currencystringfalse

com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.transactionExtensionData

Properties:
NameData TypeRequired
valuestringfalse
namestringtrue

com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.userData

Properties:
NameData TypeRequired
userDataFieldcom.ibm.commerce.order.facade.datatypes.FinancialTransactionType.userData.userDataField arrayfalse

com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType

com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock

Properties:
NameData TypeRequired
blockReasoncom.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReasonfalse
commentsstringfalse
resovledstringfalse
userDatacom.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.userDatafalse
timeBlockedstringfalse

com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason

com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason.description

Properties:
NameData TypeRequired
valuestringfalse
languagestringfalse

com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason.userData

com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.userData

com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.userData

Properties:
NameData TypeRequired
userDataFieldcom.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.userData.userDataField arrayfalse

com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier

Properties:
NameData TypeRequired
externalIdentifiercom.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifierfalse
uniqueIDstringfalse

com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier

Properties:
NameData TypeRequired
storeIdentifiercom.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier.storeIdentifierfalse
partNumberstringtrue
ownerIDstringfalse

com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier.storeIdentifier

com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier

Properties:
NameData TypeRequired
nameIdentifierstringfalse
ownerIDstringfalse

com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.orderItemComponentIdentifier

Properties:
NameData TypeRequired
uniqueIDstringfalse

com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.quantity

Properties:
NameData TypeRequired
valuestringfalse
uomstringfalse

com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice.alternativeCurrencyPrice

Properties:
NameData TypeRequired
valuestringfalse
currencystringfalse

com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice.price

Properties:
NameData TypeRequired
valuestringfalse
currencystringfalse

com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice.quantity

Properties:
NameData TypeRequired
valuestringfalse
uomstringfalse

com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.userData

Properties:
NameData TypeRequired
userDataFieldcom.ibm.commerce.order.facade.datatypes.OrderItemComponentType.userData.userDataField arrayfalse

com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

com.ibm.commerce.order.facade.datatypes.ParentInfoType

com.ibm.commerce.order.facade.datatypes.ParentInfoType.parentOrderIdentifier

Properties:
NameData TypeRequired
customerOrderNumberstringfalse
uniqueIDstringfalse
externalOrderIDstringfalse

com.ibm.commerce.order.facade.datatypes.ParentInfoType.parentOrderItemIdentifier

Properties:
NameData TypeRequired
externalOrderItemIDstringfalse
uniqueIDstringfalse

com.ibm.commerce.order.facade.datatypes.ParentInfoType.userData

Properties:
NameData TypeRequired
userDataFieldcom.ibm.commerce.order.facade.datatypes.ParentInfoType.userData.userDataField arrayfalse

com.ibm.commerce.order.facade.datatypes.ParentInfoType.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

com.ibm.commerce.order.facade.datatypes.PromotionCodeType

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.description

Properties:
NameData TypeRequired
valuestringfalse
languagestringfalse

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier

Properties:
NameData TypeRequired
nameIdentifierstringfalse
ownerIDstringfalse

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier

Properties:
NameData TypeRequired
versionstringfalse
storeIdentifiercom.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier.storeIdentifierfalse
namestringtrue
revisionstringfalse

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier.storeIdentifier

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier.storeIdentifier.externalIdentifier

Properties:
NameData TypeRequired
nameIdentifierstringfalse
ownerIDstringfalse

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason

Properties:
NameData TypeRequired
reasonCodestringfalse
userDatacom.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.userDatafalse
validstringfalse
descriptioncom.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.descriptionfalse

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.description

Properties:
NameData TypeRequired
valuestringfalse
languagestringfalse

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.userData

Properties:
NameData TypeRequired
userDataFieldcom.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.userData.userDataField arrayfalse

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.userData

Properties:
NameData TypeRequired
userDataFieldcom.ibm.commerce.order.facade.datatypes.PromotionCodeType.userData.userDataField arrayfalse

com.ibm.commerce.order.facade.datatypes.PromotionCodeType.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

java.util.Map$Entry

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

order-orderDetail

Properties:
NameData TypeRequired
orderItemorder-orderDetail.orderItem arrayfalse
totalAdjustmentCurrencystringfalse
channelcom.ibm.commerce.order.facade.datatypes.ChannelTypefalse
rewardOptionorder-orderDetail.rewardOption arrayfalse
orderIdstringfalse
lockedstringfalse
placedDatestringfalse
pysicalStoreIdstringfalse
xstat_java.util.Map$Entry arrayfalse
totalSalesTaxCurrencystringfalse
financialTransactioncom.ibm.commerce.order.facade.datatypes.FinancialTransactionType arrayfalse
adjustmentRequirementcom.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType arrayfalse
cSRCommentscom.ibm.commerce.order.facade.datatypes.CSRCommentsType arrayfalse
totalShippingChargeCurrencystringfalse
quoteIDstringfalse
grandTotalstringfalse
requestedShipDatestringfalse
paymentStatusstringfalse
externalOrderIDstringfalse
paymentInstructionorder-orderDetail.paymentInstruction arrayfalse
buyerApprovalStatusstringfalse
orderVersionstringfalse
recordSetCompletestringfalse
genericTotalcom.ibm.commerce.foundation.common.datatypes.GenericTotalType arrayfalse
storeUniqueIDstringfalse
buyerIdstringfalse
totalProductPriceCurrencystringfalse
addressIdstringfalse
orgUniqueIDstringfalse
promotionCodecom.ibm.commerce.order.facade.datatypes.PromotionCodeType arrayfalse
couponCodecom.ibm.commerce.order.facade.datatypes.CouponCodeType arrayfalse
orderTypeCodestringfalse
totalShippingTaxstringfalse
recordSetStartNumberstringfalse
recordSetCountstringfalse
quoteIdentifiercom.ibm.commerce.foundation.common.datatypes.QuoteIdentifierTypefalse
prepareIndicatorstringfalse
grandTotalCurrencystringfalse
lastUpdateDatestringfalse
orderDescriptionstringfalse
totalAdjustmentstringfalse
storeNameIdentifierstringfalse
orderEditorcom.ibm.commerce.foundation.common.datatypes.PersonIdentifierTypefalse
buyerPONumberstringfalse
orderStatusstringfalse
totalSalesTaxstringfalse
editablestringfalse
userDataFieldorder-orderDetail.userDataField arrayfalse
totalShippingChargestringfalse
shipAsCompletestringfalse
totalShippingTaxCurrencystringfalse
totalTaxByTaxCategoryorder-orderDetail.totalTaxByTaxCategory arrayfalse
orgDistinguishedNamestringfalse
blockedstringfalse
storeOwnerIDstringfalse
adjustmentorder-orderDetail.adjustment arrayfalse
recordSetTotalstringfalse
commentsstringfalse
parentInfocom.ibm.commerce.order.facade.datatypes.ParentInfoTypefalse
customerOrderNumberstringfalse
shipModeIdstringfalse
bLockInfocom.ibm.commerce.order.facade.datatypes.OrderBLockInfoTypefalse
buyerDistinguishedNamestringfalse
totalProductPricestringfalse

order-orderDetail.adjustment

Properties:
NameData TypeRequired
currencystringfalse
usagestringfalse
displayLevelstringfalse
descriptionLanguagestringfalse
userDataFieldorder-orderDetail.adjustment.userDataField arrayfalse
amountstringfalse
descriptionstringfalse
codestringfalse

order-orderDetail.adjustment.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

order-orderDetail.orderItem

Properties:
NameData TypeRequired
primarystringfalse
shippingChargestringfalse
personTitlestringfalse
physicalStoreIdstringfalse
taxByTaxCategorycom.ibm.commerce.foundation.common.datatypes.TaxByTaxCategoryType arrayfalse
addressLinestring arrayfalse
alternativeCurrencyPricecom.ibm.commerce.foundation.common.datatypes.MonetaryAmountType arrayfalse
phone1Publishstringfalse
ownerIDstringfalse
currencystringfalse
mobilePhone1Countrystringtrue
email1stringtrue
email2stringtrue
availableDatestringfalse
partNumberstringtrue
correlationGroupstringfalse
shippingTaxstringfalse
unitPricestringfalse
fulfillmentCenterDescriptioncom.ibm.commerce.foundation.common.datatypes.DescriptionTypefalse
timeReleasedstringfalse
bestCallingTimestringfalse
unitQuantitystringfalse
addressIdstringfalse
physicalStoreExternalIdstringfalse
salesTaxCurrencystringfalse
shippingChargeCurrencystringfalse
priceOverridestringfalse
trackingURLstringfalse
organizationIdentifiercom.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierTypefalse
lastNamestringfalse
orderItemPricestringfalse
lastUpdateDatestringfalse
addressTypestringfalse
fulfillmentCenterIdstringfalse
shippingTaxCurrencystringfalse
stateOrProvinceNamestringfalse
attributesorder-orderDetail.orderItem.attributes arrayfalse
languagestringfalse
postalCodestringfalse
firstNamestringfalse
shippingChargeTypestringtrue
phone1Typestringfalse
organizationNamestringfalse
storeIdentifiercom.ibm.commerce.foundation.common.datatypes.StoreIdentifierTypefalse
productIdstringfalse
citystringfalse
adjustmentorder-orderDetail.orderItem.adjustment arrayfalse
offerIDstringfalse
shipModeLanguagestringfalse
businessTitlestringfalse
shipModeIdstringfalse
isExpeditedstringfalse
orderItemIdstringfalse
orderItemComponentcom.ibm.commerce.order.facade.datatypes.OrderItemComponentType arrayfalse
shipModeDescriptionstringfalse
organizationUnitNamestringfalse
phone1stringtrue
phone2stringtrue
quantitystringfalse
shipModeCodestringfalse
shippingCarrierAccountNumberstringfalse
nickNamestringtrue
statestringfalse
externalOrderItemIDstringfalse
configurationIDstringfalse
countrystringfalse
adjustmentRequirementcom.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType arrayfalse
requestedShipDatestringfalse
shipCarrAccntNumstringfalse
orderItemInventoryStatusstringfalse
genericTotalcom.ibm.commerce.foundation.common.datatypes.GenericTotalType arrayfalse
zipCodestringfalse
shipInstructionstringfalse
fax1stringtrue
fax2stringtrue
freeGiftstringfalse
geographicalShippingCodestringfalse
middleNamestringfalse
shipTieCodestringfalse
mobilePhone1stringtrue
timeShippedstringfalse
itemAttributesorder-orderDetail.orderItem.itemAttributes arrayfalse
createDatestringfalse
contractIdstringfalse
totalAdjustmentcom.ibm.commerce.foundation.common.datatypes.MonetaryAmountTypefalse
orderItemStatusstringfalse
internalOfficeAddressstringfalse
fulfillmentCenterOwnerIdstringfalse
storeIdstringfalse
personIdentifiercom.ibm.commerce.foundation.common.datatypes.PersonIdentifierTypefalse
phone2Typestringfalse
expectedShipDatestringfalse
userDataFieldorder-orderDetail.orderItem.userDataField arrayfalse
phone2Publishstringfalse
usableShippingChargePolicyorder-orderDetail.orderItem.usableShippingChargePolicy arrayfalse
orderItemFulfillmentStatusstringfalse
unitUomstringfalse
shippingChargePolicyIDstringfalse
UOMstringfalse
commentsstringfalse
geographicalTaxCodestringfalse
carrierstringfalse
fulfillmentCenterNamestringfalse
salesTaxstringfalse

order-orderDetail.orderItem.adjustment

Properties:
NameData TypeRequired
currencystringfalse
usagestringfalse
userDataFieldorder-orderDetail.orderItem.adjustment.userDataField arrayfalse
languagestringfalse
amountstringfalse
descriptionstringfalse
codestringfalse

order-orderDetail.orderItem.adjustment.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

order-orderDetail.orderItem.attributes

Properties:
NameData TypeRequired
attrValuestringfalse
attrKeystringtrue

order-orderDetail.orderItem.itemAttributes

Properties:
NameData TypeRequired
attrValuestringfalse
attrNamestringtrue

order-orderDetail.orderItem.usableShippingChargePolicy

Properties:
NameData TypeRequired
typestringtrue
namestringtrue
uniqueIDstringfalse
storeIdcom.ibm.commerce.foundation.common.datatypes.StoreIdentifierTypefalse

order-orderDetail.orderItem.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

order-orderDetail.paymentInstruction

Properties:
NameData TypeRequired
primarystringfalse
organizationUnitNamestringfalse
personTitlestringfalse
phone1stringtrue
phone2stringtrue
addressLinestring arrayfalse
billing_address_idstringfalse
phone1Publishstringfalse
nickNamestringtrue
refundAllowedstringfalse
statestringfalse
mobilePhone1Countrystringtrue
email1stringtrue
email2stringtrue
countrystringfalse
paymentRulestringfalse
paymentTermConditionIdstringfalse
payMethodIdstringfalse
prioritystringfalse
piCurrencystringfalse
bestCallingTimestringfalse
zipCodestringfalse
piAmountstringfalse
fax1stringtrue
fax2stringtrue
organizationIdentifiercom.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierTypefalse
geographicalShippingCodestringfalse
middleNamestringfalse
lastNamestringfalse
piDescriptionstringfalse
mobilePhone1stringtrue
minAmountcom.ibm.commerce.foundation.common.datatypes.MonetaryAmountTypefalse
piStatusstringfalse
addressTypestringfalse
stateOrProvinceNamestringfalse
attributesorder-orderDetail.paymentInstruction.attributes arrayfalse
languagestringfalse
postalCodestringfalse
internalOfficeAddressstringfalse
firstNamestringfalse
maxAmountcom.ibm.commerce.foundation.common.datatypes.MonetaryAmountTypefalse
phone1Typestringfalse
personIdentifiercom.ibm.commerce.foundation.common.datatypes.PersonIdentifierTypefalse
phone2Typestringfalse
organizationNamestringfalse
protocolDataorder-orderDetail.paymentInstruction.protocolData arrayfalse
userDataFieldorder-orderDetail.paymentInstruction.userDataField arrayfalse
sequenceNumberstringfalse
citystringfalse
phone2Publishstringfalse
piLanguagestringfalse
piIdstringfalse
geographicalTaxCodestringfalse
businessTitlestringfalse

order-orderDetail.paymentInstruction.attributes

Properties:
NameData TypeRequired
attrValuestringfalse
attrKeystringtrue

order-orderDetail.paymentInstruction.protocolData

Properties:
NameData TypeRequired
valuestringfalse
namestringtrue

order-orderDetail.paymentInstruction.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

order-orderDetail.rewardOption

Properties:
NameData TypeRequired
rewardSpecGiftItemorder-orderDetail.rewardOption.rewardSpecGiftItem arrayfalse
rewardOptionIdentifierorder-orderDetail.rewardOption.rewardOptionIdentifiertrue
adjustmentDescriptionstringfalse
giftSetSpecificationorder-orderDetail.rewardOption.giftSetSpecificationfalse
giftSetorder-orderDetail.rewardOption.giftSetfalse
rewardSpecificationorder-orderDetail.rewardOption.rewardSpecificationfalse
userDataorder-orderDetail.rewardOption.userDatafalse
amountorder-orderDetail.rewardOption.amountfalse
adjustmentCurrencystringfalse
usagestringfalse
displayLevelstringfalse
isPromotionCodeRequiredstringfalse
adjustmentAmountstringfalse
rewardSpecMaxQuantitystringfalse
adjustmentLanguagestringfalse
rewardOptionExternalIdstringfalse
adjustmentorder-orderDetail.rewardOption.adjustmentfalse
codestringfalse
rewardSpecMaxQuantityUomstringfalse
adjustmentDisplayLevelstringfalse
rewardChoiceorder-orderDetail.rewardOption.rewardChoicefalse
calculationCodeIDorder-orderDetail.rewardOption.calculationCodeIDfalse
rewardChoiceGiftItemorder-orderDetail.rewardOption.rewardChoiceGiftItem arrayfalse
adjustmentUsagestringfalse
adjustmentCodestringfalse
descriptionorder-orderDetail.rewardOption.descriptionfalse
promotionTypestringfalse
rewardOptionIdstringfalse

order-orderDetail.rewardOption.adjustment

Properties:
NameData TypeRequired
usagestringfalse
calculationCodeIDorder-orderDetail.rewardOption.adjustment.calculationCodeIDfalse
displayLevelstringfalse
isPromotionCodeRequiredstringfalse
userDataorder-orderDetail.rewardOption.adjustment.userDatafalse
amountorder-orderDetail.rewardOption.adjustment.amountfalse
descriptionorder-orderDetail.rewardOption.adjustment.descriptionfalse
codestringfalse
promotionTypestringfalse

order-orderDetail.rewardOption.adjustment.amount

Properties:
NameData TypeRequired
valuestringfalse
currencystringfalse

order-orderDetail.rewardOption.adjustment.calculationCodeID

Properties:
NameData TypeRequired
calculationCodeExternalIdentifierorder-orderDetail.rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifierfalse
uniqueIDstringfalse

order-orderDetail.rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier

Properties:
NameData TypeRequired
calculationUsageIDstringfalse
storeIdentifierorder-orderDetail.rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifierfalse
codestringfalse

order-orderDetail.rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier

order-orderDetail.rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier

Properties:
NameData TypeRequired
nameIdentifierstringfalse
ownerIDstringfalse

order-orderDetail.rewardOption.adjustment.description

Properties:
NameData TypeRequired
valuestringfalse
languagestringfalse

order-orderDetail.rewardOption.adjustment.userData

Properties:
NameData TypeRequired
userDataFieldorder-orderDetail.rewardOption.adjustment.userData.userDataField arrayfalse

order-orderDetail.rewardOption.adjustment.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

order-orderDetail.rewardOption.amount

Properties:
NameData TypeRequired
valuestringfalse
currencystringfalse

order-orderDetail.rewardOption.calculationCodeID

Properties:
NameData TypeRequired
calculationCodeExternalIdentifierorder-orderDetail.rewardOption.calculationCodeID.calculationCodeExternalIdentifierfalse
uniqueIDstringfalse

order-orderDetail.rewardOption.calculationCodeID.calculationCodeExternalIdentifier

Properties:
NameData TypeRequired
calculationUsageIDstringfalse
storeIdentifierorder-orderDetail.rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifierfalse
codestringfalse

order-orderDetail.rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier

Properties:
NameData TypeRequired
externalIdentifierorder-orderDetail.rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifierfalse
uniqueIDstringfalse

order-orderDetail.rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier

Properties:
NameData TypeRequired
nameIdentifierstringfalse
ownerIDstringfalse

order-orderDetail.rewardOption.description

Properties:
NameData TypeRequired
valuestringfalse
languagestringfalse

order-orderDetail.rewardOption.giftSet

Properties:
NameData TypeRequired
giftItemorder-orderDetail.rewardOption.giftSet.giftItem arrayfalse

order-orderDetail.rewardOption.giftSet.giftItem

order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier

Properties:
NameData TypeRequired
externalIdentifierorder-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifierfalse
uniqueIDstringfalse

order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier

Properties:
NameData TypeRequired
storeIdentifierorder-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifierfalse
partNumberstringtrue
ownerIDstringfalse

order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier

order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier

Properties:
NameData TypeRequired
nameIdentifierstringfalse
ownerIDstringfalse

order-orderDetail.rewardOption.giftSet.giftItem.quantity

Properties:
NameData TypeRequired
valuestringfalse
uomstringfalse

order-orderDetail.rewardOption.giftSetSpecification

order-orderDetail.rewardOption.giftSetSpecification.giftItem

order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier

Properties:
NameData TypeRequired
externalIdentifierorder-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifierfalse
uniqueIDstringfalse

order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier

Properties:
NameData TypeRequired
storeIdentifierorder-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifierfalse
partNumberstringtrue
ownerIDstringfalse

order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier

order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier

Properties:
NameData TypeRequired
nameIdentifierstringfalse
ownerIDstringfalse

order-orderDetail.rewardOption.giftSetSpecification.giftItem.quantity

Properties:
NameData TypeRequired
valuestringfalse
uomstringfalse

order-orderDetail.rewardOption.giftSetSpecification.maximumQuantity

Properties:
NameData TypeRequired
valuestringfalse
uomstringfalse

order-orderDetail.rewardOption.rewardChoice

order-orderDetail.rewardOption.rewardChoice.giftSet

Properties:
NameData TypeRequired
giftItemorder-orderDetail.rewardOption.rewardChoice.giftSet.giftItem arrayfalse

order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem

order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier

Properties:
NameData TypeRequired
externalIdentifierorder-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifierfalse
uniqueIDstringfalse

order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier

Properties:
NameData TypeRequired
storeIdentifierorder-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifierfalse
partNumberstringtrue
ownerIDstringfalse

order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier

order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier

Properties:
NameData TypeRequired
nameIdentifierstringfalse
ownerIDstringfalse

order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.quantity

Properties:
NameData TypeRequired
valuestringfalse
uomstringfalse

order-orderDetail.rewardOption.rewardChoice.userData

Properties:
NameData TypeRequired
userDataFieldorder-orderDetail.rewardOption.rewardChoice.userData.userDataField arrayfalse

order-orderDetail.rewardOption.rewardChoice.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

order-orderDetail.rewardOption.rewardChoiceGiftItem

Properties:
NameData TypeRequired
uomstringfalse
externalIdentifiercom.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierTypefalse
productIdstringfalse
quantitystringfalse

order-orderDetail.rewardOption.rewardOptionIdentifier

Properties:
NameData TypeRequired
externalIdentifierstringfalse
uniqueIDstringfalse

order-orderDetail.rewardOption.rewardSpecGiftItem

Properties:
NameData TypeRequired
valuestringfalse
uomstringfalse
externalIdentifiercom.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierTypefalse
productIdstringfalse

order-orderDetail.rewardOption.rewardSpecification

order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification

order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem

order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier

order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier

Properties:
NameData TypeRequired
storeIdentifierorder-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifierfalse
partNumberstringtrue
ownerIDstringfalse

order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier

order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier

Properties:
NameData TypeRequired
nameIdentifierstringfalse
ownerIDstringfalse

order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.quantity

Properties:
NameData TypeRequired
valuestringfalse
uomstringfalse

order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.maximumQuantity

Properties:
NameData TypeRequired
valuestringfalse
uomstringfalse

order-orderDetail.rewardOption.rewardSpecification.userData

Properties:
NameData TypeRequired
userDataFieldorder-orderDetail.rewardOption.rewardSpecification.userData.userDataField arrayfalse

order-orderDetail.rewardOption.rewardSpecification.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

order-orderDetail.rewardOption.userData

Properties:
NameData TypeRequired
userDataFieldorder-orderDetail.rewardOption.userData.userDataField arrayfalse

order-orderDetail.rewardOption.userData.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

order-orderDetail.totalTaxByTaxCategory

Properties:
NameData TypeRequired
valuestringfalse
currencystringfalse
taxCategoryCodestringfalse

order-orderDetail.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

order-orderItemConfiguration

Properties:
NameData TypeRequired
orderItemorder-orderItemConfiguration.orderItem arrayfalse
recordSetTotalstringfalse
recordSetStartNumberstringfalse
recordSetCompletestringfalse
recordSetCountstringfalse

order-orderItemConfiguration.orderItem

Properties:
NameData TypeRequired
orderItemConfigurationstringfalse
orderItemIdstringfalse

order-orderSummary

Properties:
NameData TypeRequired
recordSetTotalstringfalse
recordSetCompletestringfalse
recordSetStartNumberstringfalse
recordSetCountstringfalse
Orderorder-orderSummary_item arrayfalse

order-orderSummary_item

Properties:
NameData TypeRequired
totalAdjustmentCurrencystringfalse
channelcom.ibm.commerce.order.facade.datatypes.ChannelTypefalse
orderIdstringfalse
lockedstringfalse
placedDatestringfalse
xstat_java.util.Map$Entry arrayfalse
totalSalesTaxCurrencystringfalse
adjustmentRequirementcom.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType arrayfalse
cSRCommentscom.ibm.commerce.order.facade.datatypes.CSRCommentsType arrayfalse
quoteIDstringfalse
totalShippingChargeCurrencystringfalse
grandTotalstringfalse
externalOrderIDstringfalse
buyerApprovalStatusstringfalse
orderVersionstringfalse
genericTotalcom.ibm.commerce.foundation.common.datatypes.GenericTotalType arrayfalse
storeUniqueIDstringfalse
buyerIdstringfalse
totalProductPriceCurrencystringfalse
promotionCodecom.ibm.commerce.order.facade.datatypes.PromotionCodeType arrayfalse
orgUniqueIDstringfalse
couponCodecom.ibm.commerce.order.facade.datatypes.CouponCodeType arrayfalse
orderTypeCodestringfalse
totalShippingTaxstringfalse
quoteIdentifiercom.ibm.commerce.foundation.common.datatypes.QuoteIdentifierTypefalse
prepareIndicatorstringfalse
grandTotalCurrencystringfalse
lastUpdateDatestringfalse
orderDescriptionstringfalse
totalAdjustmentstringfalse
storeNameIdentifierstringfalse
orderEditorcom.ibm.commerce.foundation.common.datatypes.PersonIdentifierTypefalse
buyerPONumberstringfalse
orderStatusstringfalse
totalSalesTaxstringfalse
editablestringfalse
userDataFieldorder-orderSummary_item.userDataField arrayfalse
totalShippingChargestringfalse
shipAsCompletestringfalse
totalShippingTaxCurrencystringfalse
totalTaxByTaxCategoryorder-orderSummary_item.totalTaxByTaxCategory arrayfalse
orgDistinguishedNamestringfalse
blockedstringfalse
adjustmentorder-orderSummary_item.adjustment arrayfalse
storeOwnerIDstringfalse
commentsstringfalse
parentInfocom.ibm.commerce.order.facade.datatypes.ParentInfoTypefalse
customerOrderNumberstringfalse
bLockInfocom.ibm.commerce.order.facade.datatypes.OrderBLockInfoTypefalse
buyerDistinguishedNamestringfalse
totalProductPricestringfalse

order-orderSummary_item.adjustment

Properties:
NameData TypeRequired
currencystringfalse
usagestringfalse
displayLevelstringfalse
descriptionLanguagestringfalse
userDataFieldorder-orderSummary_item.adjustment.userDataField arrayfalse
amountstringfalse
descriptionstringfalse
codestringfalse

order-orderSummary_item.adjustment.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue

order-orderSummary_item.totalTaxByTaxCategory

Properties:
NameData TypeRequired
currencystringfalse
valuestringfalse
taxCategoryCodestringfalse

order-orderSummary_item.userDataField

Properties:
NameData TypeRequired
valuestringfalse
keystringtrue