WebSphere Commerce Service - Order Capture
These services provide APIs related to orders in a B2B or B2C store. Use these classes to:
- Find information about order history and order details
- Find inventory details for products
- Get, add, update, or delete requisition lists (a list of items used to create orders at a later date)
- Get and manage a shopper's wishlists, or items in the wishlist
- etc... Schemes: https
Summary
Tag: Order
This class provides RESTful services to get order history and order details.
Operation Description GET /store/{storeId}/order/@history Get order history
GET /store/{storeId}/order/oms_order/{extOrderId} Get details by external order ID
GET /store/{storeId}/order/byORMOrder/{ORMOrder} Get orders by order reference number
POST /store/{storeId}/order/{orderId}/comment Add comments (CSR)
GET /store/{storeId}/order/{orderId}/comment Get order comments
POST /store/{storeId}/order/process_oms_order/{extOrderId} Process by external order ID
GET /store/{storeId}/order/byBuyerId/{buyerId} Get orders by buyer ID
GET /store/{storeId}/order/{orderId} Get order details by order ID
POST /store/{storeId}/order/copy_oms_order/{extOrderId} Copy by external order ID
GET /store/{storeId}/order Get order to work onbehalf of
GET /store/{storeId}/order/byStatus/{status} Get orders by status
Tag: Inventory Availability
This class provides RESTful services to get inventory availability details for products. It performs the service by delegating to the InventoryAvailability BOD service.
Operation Description GET /store/{storeId}/inventoryavailability/byPartNumber/{partNumbers} Get details by part number
GET /store/{storeId}/inventoryavailability/byOrderId/{orderId} Get details by order ID
GET /store/{storeId}/inventoryavailability/{productIds} Get details by product identifier
Tag: Wishlist
This class provides RESTful services to get and manage a shopper's wish lists.
Note: We must enable the multiple wish lists feature in the Management Center Store Management tool.
Operation Description GET /store/{storeId}/wishlist/@self Get all wish lists
GET /store/{storeId}/wishlist/@default Get default wish list
GET /store/{storeId}/wishlist/{externalId}/item Get with list items by external ID
PUT /store/{storeId}/wishlist/{externalId} Update wish list
POST /store/{storeId}/wishlist/{externalId} Process wish list
GET /store/{storeId}/wishlist/{externalId} Get wish list by external ID
DELETE /store/{storeId}/wishlist/{externalId} Delete wish list or wish list item
POST /store/{storeId}/wishlist Create wish list
Tag: Requisition List
A requisition list is a list of items used to create orders at a later date.
Operation Description PUT /store/{storeId}/requisition_list/{requisitionListId} Update requisition list
POST /store/{storeId}/requisition_list/{requisitionListId} Submit requisition list
GET /store/{storeId}/requisition_list/{requisitionListId} Get requisition list by ID
DELETE /store/{storeId}/requisition_list/{requisitionListId} Delete requisition list
POST /store/{storeId}/requisition_list Add dynamic kit to requisition list
GET /store/{storeId}/requisition_list Get requisition lists
Tag: order_download
Operation Description GET /store/{storeId}/order_download/byExportId/{exportId} Download an order export file by export ID.
Tag: order_export
Operation Description POST /store/{storeId}/order_export Exports orders for a store.
Tag: order_
Operation Description POST /store/{storeId}/merchant/validate Performs the merchant validation
GET /store/{storeId}/merchant Gets the merchant info
Paths
Get details by order IDGET /store/{storeId}/inventoryavailability/byOrderId/{orderId}
Tags: Inventory AvailabilityGets inventory details for the specified order by it's identifier (order Id).
storeId The store identifier.
path string orderId The order identifiers for example, /inventoryavailability/10001.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } onlineStoreId The online store identifier.
query string physicalStoreId The physical store identifiers. Multiple values are separated by commas for example, physicalStoreId=10001,10002.
query string
Get details by part number application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. inventoryavailability-inventoryavailability
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
If any of the specified order identifiers could not be found, or none of the specified online/physical stores exist.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/inventoryavailability/byPartNumber/{partNumbers}
Tags: Inventory AvailabilityGets inventory details for the specified product by its identifier (PartNumber). Multiple partNumbers can be passed to the URI separated by a comma (,).
storeId The store identifier.
path string partNumbers The product identifiers. Multiple values are separated by commas for example, /inventoryavailability/'AuroraWMDRS-1,'AuroraWMDRS-2.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } onlineStoreName The online store name.
query string physicalStoreName The physical store names. Separate multiple values with a comma for example, physicalStoreName=China mall,Sales mall.
query string forUser User name to act on behalf of.
query string forUserId User identifier to act on behalf of.
query string
Get details by product identifier application/atom+xml application/json application/xhtml+xml application/xml
- 200 OK
The requested completed successfully. inventoryavailability-inventoryavailability
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
If any of the specified product identifiers could not be found, or none of the specified online/physical stores exist.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/inventoryavailability/{productIds}
Tags: Inventory AvailabilityGets inventory details for the specified product by its catalog entry ID. Multiple product IDs can be passed to the URI separated by a comma (,).
storeId The store identifier.
path string productIds The product identifiers. Multiple values are separated by commas. Example: /inventoryavailability/10001,10002.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } onlineStoreId The online store identifier.
query string physicalStoreId The physical store identifiers. Multiple values are separated by commas. Example: physicalStoreId=10001,10002.
query string
application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"InventoryAvailability": [
{
"availableQuantity": "99.0",
"inventoryStatus": "Available",
"onlineStoreId": "10001",
"onlineStoreName": "Aurora",
"productId": "12837",
"unitOfMeasure": "C62"
},
{
"availabilityDateTime": "2015-02-22T20:25:45.474Z",
"availableQuantity": "0.0",
"inventoryStatus": "Backorderable",
"physicalStoreId": "10039",
"physicalStoreName": "Warden Plaza",
"productId": "12837",
"unitOfMeasure": "C62"
},
{
"availabilityDateTime": "2015-02-22T20:25:45.493Z",
"availableQuantity": "0.0",
"inventoryStatus": "Backorderable",
"physicalStoreId": "10003",
"physicalStoreName": "Markham Centre",
"productId": "12837",
"unitOfMeasure": "C62"
}
],
"resourceId": "http://localhost:80/wcs/resources/store/10001/inventoryavailability/12837?physicalStoreId=10039%2C10003&onlineStoreId=10001&responseFormat=json",
"resourceName": "inventoryavailability"
}inventoryavailability-inventoryavailability
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
If any of the specified product identifiers could not be found, or none of the specified online/physical stores exist.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
Gets the merchant info
GET /store/{storeId}/merchant
Tags: order_
storeId The store identifier.
path string , x ∈ { 0 , 10001 , 10051 , 10101 , 10151 , 10201 , 10202 } paymentSystem The payment system which is used for ApplePay
query string paymentConfigGroup The payment configuration group
query string responseFormat The response format. If the request has an input body, that body must also use the format specified in "responseFormat". Valid values include "json" and "xml" without the quotes. If the responseFormat isn't specified, the "accept" HTTP header shall be used to determine the format of the response. If the "accept" HTTP header isn't specified as well, the default response format shall be in json.
query string , x ∈ { xml , json }
Performs the merchant validation application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
No response was specified Empty
- 201 Created
The requested resource has been created.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
POST /store/{storeId}/merchant/validate
Tags: order_
The request object for merchant validation. com.ibm.commerce.rest.order.handler.MerchantHandler$MerchantValidationBodyDescription
storeId The store identifier.
path string , x ∈ { 0 , 10001 , 10051 , 10101 , 10151 , 10201 , 10202 } responseFormat The response format. If the request has an input body, that body must also use the format specified in "responseFormat". Valid values include "json" and "xml" without the quotes. If the responseFormat isn't specified, the "accept" HTTP header shall be used to determine the format of the response. If the "accept" HTTP header isn't specified as well, the default response format shall be in json.
query string , x ∈ { xml , json }
Get order to work onbehalf of application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
No response was specified Empty
- 201 Created
The requested resource has been created.
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/order
Tags: OrderAllows CSRs to find orders to work on behalf of a shopper.
storeId The store identifier.
path string profileName Profile name. Profiles determine the subset of data returned by a query. The default profile name = IBM_Summary.
query string , x ∈ { IBM_Summary } q The query name.
query string , x ∈ { ordersICanWorkonbehalf } orderByTableName The order by table name.
query string orderByFieldName The order by field name.
query string startIndex The starting index of the result.
query string retrievePendingGuestOrders The flag of retrieving pending guest orders or not. Default is false.
query string maxResults The maximum number of results to return.
query string
Get order history application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"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"
}
]
}
]
}com.ibm.commerce.tools.optools.order.beans.CSROrderSearchDataBean_IBM_Summary
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/order/@history
Tags: OrderGets the order history for the authenticated user.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int32) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int32) currency The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.
query string , x ∈ { JPY , CNY , BRL , EUR , RON , RUB , PLN , USD , KRW , TWD , CAD , GBP }
Get orders by buyer ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. order-orderSummary
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/order/byBuyerId/{buyerId}
Tags: OrderGets a list of orders by buyer ID.
storeId The store identifier.
path string buyerId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int32) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int32) currency The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.
query string , x ∈ { JPY , CNY , BRL , EUR , RON , RUB , PLN , USD , KRW , TWD , CAD , GBP }
Get orders by order reference number application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. order-orderDetail
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/order/byORMOrder/{ORMOrder}
Tags: OrderGets a list of orders by a merchant assigned order reference number (ORMOrder).
storeId The store identifier.
path string ORMOrder The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int32) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int32)
Get orders by status application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. order-orderDetail
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/order/byStatus/{status}
Tags: OrderGets a list of orders by order status.
storeId The store identifier.
path string status The order status.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int32) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int32) currency The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.
query string , x ∈ { JPY , CNY , BRL , EUR , RON , RUB , PLN , USD , KRW , TWD , CAD , GBP }
Copy by external order ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"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"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
POST /store/{storeId}/order/copy_oms_order/{extOrderId}
Tags: OrderCopies an order for a specified external order ID.
storeId The store identifier.
path string extOrderId The external order identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get details by external order ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.order.commands.SSFSOrderCopyCmd
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/order/oms_order/{extOrderId}
Tags: OrderGets order details for a specified external order ID.
storeId The store identifier.
path string extOrderId The external order identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Process by external order ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Empty
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
POST /store/{storeId}/order/process_oms_order/{extOrderId}
Tags: OrderProcesses an order for a specified external order ID.
storeId The store identifier.
path string extOrderId The external order identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get order details by order ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.order.external.commands.ProcessExternalOrderCmd
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/order/{orderId}
Tags: OrderGets the order details for a specific order ID.
orderId The order identifier.
path string storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int32) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int32) currency The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.
query string , x ∈ { JPY , CNY , BRL , EUR , RON , RUB , PLN , USD , KRW , TWD , CAD , GBP } profileName Profile name. Profiles determine the subset of data returned by a query.
query string , x ∈ { IBM_Summary , IBM_Details }
Get order comments application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"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": ""
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found The specified resource could not be found.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/order/{orderId}/comment
Tags: OrderFinds order comments for the specific order.
storeId The store identifier.
path string orderId The order identifier.
path string isAsc Returned order comments sorted in ascending order.
query boolean orderByField The order by field name.
query string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int32) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int32)
Add comments (CSR) application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.tools.optools.order.beans.OrderCommentRestDataBean_IBM_Summary
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
POST /store/{storeId}/order/{orderId}/comment
Tags: OrderAdds CSR comments to the order.
application/json application/xml
CSR comment body. com.ibm.commerce.rest.order.handler.OrderHandler$CSRCommentForm
storeId The store identifier.
path string orderId The order identifier.
path string mode CSR add comment mode.
query string , x ∈ { self , onbehalf } responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Download an order export file by export ID. application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. com.ibm.commerce.rest.order.handler.OrderHandler$CSRCommentResponseForm
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
GET /store/{storeId}/order_download/byExportId/{exportId}
Tags: order_download
storeId The store identifier.
path string , x ∈ { 0 , 10001 , 10051 , 10101 , 10151 , 10201 , 10202 } exportId The export ID from the order export REST API call.
path string
Exports orders for a store. application/json application/octet-stream
- 200 OK
The requested completed successfully. Empty
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
POST /store/{storeId}/order_export
Tags: order_export
Specify optional parameters in the body in JSON format. For example, we can specify the order status, and the number of days to set back for the time placed of the order. com.ibm.commerce.rest.order.handler.OrderExportHandler$OrderExportRequest
storeId The store identifier.
path string , x ∈ { 0 , 10001 , 10051 , 10101 , 10151 , 10201 , 10202 }
Get requisition lists application/json application/xml application/xhtml+xml application/octet-stream
- 200 OK
The requested completed successfully. com.ibm.commerce.rest.order.handler.OrderExportHandler$OrderExportResponse
- 400 Bad Request
Bad request. Some of the inputs provided to the request aren't valid.
- 401 Unauthorized
Not authenticated. The user session isn't valid.
- 403 Forbidden
The user isn't authorized to perform the specified request.
- 404 Not Found
The specified resource couldn't be found.
- 500 Internal Server Error
Internal server error. Additional details will be contained on the server logs.
GET /store/{storeId}/requisition_list
Tags: Requisition ListFinds requisition lists that can be used by the current user.
storeId The store identifier.
path string q The query name.
query string , x ∈ { usable } orderBy Order by.
query string pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int64) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int64)
Add dynamic kit to requisition list application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"recordSetCompleteIndicator": true,
"recordSetCount": 5,
"recordSetStartNumber": 0,
"recordSetTotal": 5,
"resultList": [
{
"comment": null,
"description": "reqList",
"lastUpdate": "2014-11-24T16:24:21.541000000Z",
"memberId": "-1004",
"orderId": "25163",
"organizationId": "7000000000000000801",
"status": "Y",
"storeId": "10801",
"userRegistration": {
"firstName": "",
"lastName": "buyerAadmin",
"middleName": ""
}
},
{
"comment": null,
"description": "reqListCopy1",
"lastUpdate": "2014-11-24T16:24:21.575000000Z",
"memberId": "-1004",
"orderId": "25164",
"organizationId": "7000000000000000801",
"status": "Y",
"storeId": "10801",
"userRegistration": {
"firstName": "",
"lastName": "buyerAadmin",
"middleName": ""
}
},
{
"comment": null,
"description": "reqListCopy2",
"lastUpdate": "2014-11-24T16:24:21.593000000Z",
"memberId": "-1004",
"orderId": "25165",
"organizationId": "7000000000000000801",
"status": "Z",
"storeId": "10801",
"userRegistration": {
"firstName": "",
"lastName": "buyerAadmin",
"middleName": ""
}
},
{
"comment": null,
"description": "reqListCopy3",
"lastUpdate": "2014-11-24T16:24:21.610000000Z",
"memberId": "-1004",
"orderId": "25166",
"organizationId": "7000000000000000801",
"status": "Y",
"storeId": "10801",
"userRegistration": {
"firstName": "",
"lastName": "buyerAadmin",
"middleName": ""
}
},
{
"comment": null,
"description": "reqListCopy4",
"lastUpdate": "2014-11-24T16:24:21.629000000Z",
"memberId": "-1004",
"orderId": "25167",
"organizationId": "7000000000000000801",
"status": "Z",
"storeId": "10801",
"userRegistration": {
"firstName": "",
"lastName": "buyerAadmin",
"middleName": ""
}
}
]
}com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
POST /store/{storeId}/requisition_list
Tags: Requisition ListAdds preconfigured dynamic kits or dynamic kit configurations to a requisition list.
The body data. com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListConfigurationAddRequest
storeId The store identifier.
path string action The action.
query string , x ∈ { addConfiguration }
Delete requisition list application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"requisitionListId": 25202,
"viewTaskName": "RedirectView"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
DELETE /store/{storeId}/requisition_list/{requisitionListId}
Tags: Requisition ListDeletes a requisition list.
The body data. com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListDeleteRequest
storeId The store identifier.
path string requisitionListId The requisition list ID.
path string
Get requisition list by ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"requisitionListId": "",
"viewTaskName": "RedirectView"
}com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListDeleteResponse
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/requisition_list/{requisitionListId}
Tags: Requisition ListFinds a requisition list by its ID.
storeId The store identifier.
path string requisitionListId The requisition list ID.
path string
Submit requisition list application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"resultList": [
{
"comment": null,
"description": "reqList",
"lastUpdate": "2014-11-24T16:24:31.526000000Z",
"memberId": "4025",
"orderId": "25203",
"organizationId": "7000000000000000801",
"status": "Y",
"storeId": "10801",
"userRegistration": {
"firstName": "John",
"lastName": "Smith",
"middleName": ""
}
}
]
}com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
404 Not Found The specified resource could not be found.
500 Internal Server Error Internal server error. For details, see the server log files.
POST /store/{storeId}/requisition_list/{requisitionListId}
Tags: Requisition ListSubmits a requisition list.
The body data. com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListSubmitRequest
storeId The store identifier.
path string requisitionListId The requisition list ID.
path string action The action.
query string , x ∈ { submit }
Update requisition list application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"orderId": [
"25203"
],
"orderItemId": [
"85197"
],
"requisitionListId": [
"25203"
],
"viewTaskName": "RedirectView"
}com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListSubmitResponse
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
PUT /store/{storeId}/requisition_list/{requisitionListId}
Tags: Requisition ListUpdates a requisition list.
The body data. com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListUpdateRequest
storeId The store identifier.
path string requisitionListId The requisition list ID.
path string
Create wish list application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"viewTaskName": "RedirectView"
}com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListUpdateResponse
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
POST /store/{storeId}/wishlist
Tags: WishlistCreates a wish list. The wish list can contain items, or be empty.
application/json application/xml
The request body for creating a wish list or wish list item. com.ibm.commerce.rest.wishlist.handler.WishlistHandler$CreateBodyParameterDescription
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get default wish list application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
No response was specified. Example for application/json
{
"descriptionName": "Wish List",
"storeId": "10001",
"uniqueID": "10502"
}com.ibm.commerce.rest.wishlist.handler.WishlistHandler$WishListResponse
201 Created The requested resource has been created.
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/wishlist/@default
Tags: WishlistGets the shopper's default wish list.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Get all wish lists application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"GiftList": [
{
"accessSpecifier": "Private",
"createdTime": "2014-11-20T14:33:45.944Z",
"description": "Wish List",
"descriptionName": "Wish List",
"event": "WishList",
"externalIdentifier": "10003",
"giftCardAccepted": "false",
"guestAccessKey": "-49e2f4d1:149cc3e97d1:-6cdb",
"lastUpdate": "2014-11-20T14:33:45.944Z",
"location": "online",
"optForEmail": "false",
"registry": "false",
"registryAccessKey": "-49e2f4d1:149cc3e97d1:-6cda",
"state": "Default",
"storeId": "10001",
"storeName": "Wish List",
"storeOwnerID": "10003",
"uniqueID": "10003"
}
],
"recordSetComplete": "true",
"recordSetCount": "1",
"recordSetStartNumber": "0",
"recordSetTotal": "1",
"resourceId": "https://localhost:443/wcs/resources/store/10001/wishlist/@default?responseFormat=json",
"resourceName": "wishlist"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/wishlist/@self
Tags: WishlistGets all of the shopper's wish lists.
storeId The store identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int64) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int64)
Delete wish list or wish list item application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. wishlist-wishlist
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
DELETE /store/{storeId}/wishlist/{externalId}
Tags: WishlistDeletes a wish list or delete an item from a wish list. Specify an itemId or a productId to delete only that item from the wish list; otherwise the entire wish list is deleted. When both itemId and productId are provided, itemId is used ONLY.
storeId The store identifier.
path string externalId Wish list external identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } itemId Specifies the ID of the wish list item to delete. If this parameter and productId are missing or blank, the entire wish list is deleted.
query string productId Specifies the id of the wish list product to delete. If this parameter and itemId are missing or blank, the entire wish list is deleted.
query string
Get wish list by external ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"item": [
{
"giftListItemID": "10002"
}
],
"uniqueID": "10003"
}com.ibm.commerce.rest.wishlist.handler.WishlistHandler$DeleteWishListResponse
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/wishlist/{externalId}
Tags: WishlistGets the shopper's wish list by ExternalId or by ExternalId and GuestAccesskey. If only ExternalId is specified, the user must be authenticated.
externalId Wish list external identifier.
path string storeId The store identifier.
path string guestAccessKey Wish list guest access key.
query string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json }
Process wish list application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. wishlist-wishlist
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 404 Not Found
The specified resource could not be found.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
POST /store/{storeId}/wishlist/{externalId}
Tags: WishlistProcesses a wish list.
application/json application/xml
The request body for the e-mail announcements made about the gift list by the registrants to friends and family. com.ibm.commerce.rest.wishlist.handler.WishlistHandler$ProcessBodyParameterDescription
storeId The store identifier.
path string externalId Wish list external identifier.
path string action The action of the rest service.
query string , x ∈ { announce }
Update wish list application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
No response was specified. com.ibm.commerce.rest.wishlist.handler.WishlistHandler$WishListResponse
- 201 Created
The requested resource has been created.
- 400 Bad Request
Bad request. The request could not be understood by the server due to malformed syntax.
- 401 Unauthorized
Not authenticated. The user session is not valid.
- 403 Forbidden
The user is not authorized to perform the specified request.
- 500 Internal Server Error
Internal server error. For details, see the server log files.
PUT /store/{storeId}/wishlist/{externalId}
Tags: WishlistUpdates the wish list to change the description or to add or update an item.
application/json application/xml
The request body for updating a wish list description or wish list item. com.ibm.commerce.rest.wishlist.handler.WishlistHandler$UpdateBodyParameterDescription
storeId The store identifier.
path string externalId Wish list external identifier.
path string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } addItem When set to true, a new item in a request is added to the wish list. When false or missing, the wish list description and/or item is updated with the information in the request. Default is false.
query string , x ∈ { true , false }
Get with list items by external ID application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"item": [
{
"giftListItemID": "10501"
}
],
"uniqueID": "10502"
}com.ibm.commerce.rest.wishlist.handler.WishlistHandler$WishListUpdateResponse
400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
GET /store/{storeId}/wishlist/{externalId}/item
Tags: WishlistGets the shopper's wish list items by wish list ExternalId or by ExternalId and GuestAccesskey. If only ExternalId is specified, the user must be authenticated.
externalId Wish list external identifier.
path string storeId The store identifier.
path string guestAccessKey Wish list guest access key.
query string responseFormat The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.
query string , x ∈ { xml , json } pageNumber Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.
query integer (int64) pageSize Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.
query integer (int64)
application/json application/xml application/xhtml+xml application/atom+xml
- 200 OK
The requested completed successfully. Example for application/json
{
"GiftList": [
{
"accessSpecifier": "Private",
"description": "Wish List",
"descriptionName": "Wish List",
"event": "0",
"externalIdentifier": "10003",
"giftCardAccepted": "false",
"item": [
{
"giftListItemID": "10002",
"itemCreatedTime": "2014-11-20T14:33:46.090Z",
"itemLastUpdate": "2014-11-20T14:33:46.090Z",
"location": "online",
"partNumber": "HFU032_320101",
"productId": "12837",
"productOwnerID": "7000000000000000002",
"quantityBought": "0.0",
"quantityRequested": "1.0"
}
],
"optForEmail": "false",
"registry": "true",
"state": "Default",
"storeId": "10001",
"storeName": "Wish List",
"storeOwnerID": "10003",
"uniqueID": "10003"
}
],
"recordSetComplete": "true",
"recordSetCount": "1",
"recordSetStartNumber": "0",
"recordSetTotal": "1",
"resourceId": "https://localhost:443/wcs/resources/store/10001/wishlist/10003/item?pageSize=12&pageNumber=1&responseFormat=json",
"resourceName": "wishlist"
}400 Bad Request Bad request. The request could not be understood by the server due to malformed syntax.
401 Unauthorized Not authenticated. The user session is not valid.
403 Forbidden The user is not authorized to perform the specified request.
500 Internal Server Error Internal server error. For details, see the server log files.
Schema definitions
com.ibm.commerce.foundation.common.datatypes.ContactInfoType: object
- userData: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.userData
- organizationName: string
- fax1: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax1
- language: string
- geographicalTaxCode: string
- mobilePhone1: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.mobilePhone1
- geographicalShippingCode: string
- bestCallingTime: string
- contactInfoIdentifier: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactInfoIdentifier
- fax2: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax2
- contactName: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactName
- emailAddress2: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress2
- address: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.address
- emailAddress1: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress1
- attributes: object[]
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.attributes - telephone1: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone1
- organizationUnitName: string
- telephone2: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone2
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.address: object
- city: string
- addressLine: string[]
string - userData: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.address.userData
- country: string
- primary: boolean
- stateOrProvinceName: string
- type: string
- postalCode: string
- internalOfficeAddress: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.address.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.address.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.address.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.attributes: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactInfoIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactInfoIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactInfoIdentifier.externalIdentifier: object
- organizationIdentifier: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactInfoIdentifier.externalIdentifier.organizationIdentifier
- personIdentifier: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactInfoIdentifier.externalIdentifier.personIdentifier
- contactInfoNickName: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactInfoIdentifier.externalIdentifier.organizationIdentifier: object
- distinguishedName: string
- uniqueID: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactInfoIdentifier.externalIdentifier.personIdentifier: object
- distinguishedName: string
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactInfoIdentifier.externalIdentifier.personIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactInfoIdentifier.externalIdentifier.personIdentifier.externalIdentifier: object
- identifier: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.contactName: object
- middleName: string
- businessTitle: string
- personTitle: string
- firstName: string
- lastName: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress1: object
- userData: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress1.userData
- value: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress1.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress1.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress1.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress2: object
- userData: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress2.userData
- value: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress2.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress2.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.emailAddress2.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax1: object
- userData: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax1.userData
- value: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax1.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax1.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax1.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax2: object
- userData: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax2.userData
- value: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax2.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax2.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.fax2.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.mobilePhone1: object
- country: string
- value: string
- userData: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.mobilePhone1.userData
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.mobilePhone1.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.mobilePhone1.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.mobilePhone1.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone1: object
- userData: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone1.userData
- type: string
- value: string
- publish: boolean
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone1.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone1.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone1.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone2: object
- userData: com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone2.userData
- type: string
- value: string
- publish: boolean
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone2.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone2.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.telephone2.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.userData: object
- userDataField: object[]
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.userData.userDataField
com.ibm.commerce.foundation.common.datatypes.ContactInfoType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.foundation.common.datatypes.DescriptionType: object
- value: string
- language: string
com.ibm.commerce.foundation.common.datatypes.GenericTotalType: object
- name: string
com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType: object
- currency: string
- value: number (double)
com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType: object
- distinguishedName: string
- uniqueID: string
com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType: object
- ownerID: string
- partNumber: string
- storeIdentifier: com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType.storeIdentifier
com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType.storeIdentifier.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType: object
- distinguishedName: string
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier: object
- identifier: string
com.ibm.commerce.foundation.common.datatypes.QuoteIdentifierType: object
- externalQuoteID: string
- uniqueID: string
com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType.externalIdentifier
com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.foundation.common.datatypes.TaxByTaxCategoryType: object
- taxCategoryCode: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType: object
- status: string
- lastUpdate: string
- purchaserAddress: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.userData
- purchasedItemDetails: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails
- purchaseDate: string
- giftListItemID: string
- purchaseRecordIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaseRecordIdentifier
- messageForRegistrant: string
- dateCreated: string
- location: string
- registrantMemo: string
- noteSent: boolean
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails: object
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.userData
- itemShippedToRegistrant: boolean
- itemBought: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.itemBought
- orderItemIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.orderItemIdentifier
- transactionID: string
- quantity: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.quantity
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.itemBought: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.itemBought.externalIdentifier
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.itemBought.externalIdentifier: object
- ownerID: string
- partNumber: string
- storeIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.itemBought.externalIdentifier.storeIdentifier
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.itemBought.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.itemBought.externalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.itemBought.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.orderItemIdentifier: object
- uniqueID: string
- externalOrderItemID: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.quantity: object
- value: number (double)
- uom: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchasedItemDetails.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress: object
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.userData
- organizationName: string
- fax1: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax1
- language: string
- geographicalTaxCode: string
- mobilePhone1: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.mobilePhone1
- geographicalShippingCode: string
- bestCallingTime: string
- contactInfoIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactInfoIdentifier
- fax2: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax2
- contactName: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactName
- emailAddress2: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress2
- address: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.address
- emailAddress1: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress1
- attributes: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.attributes - telephone1: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone1
- organizationUnitName: string
- telephone2: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone2
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.address: object
- city: string
- addressLine: string[]
string - userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.address.userData
- country: string
- primary: boolean
- stateOrProvinceName: string
- type: string
- postalCode: string
- internalOfficeAddress: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.address.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.address.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.address.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.attributes: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactInfoIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactInfoIdentifier.externalIdentifier
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactInfoIdentifier.externalIdentifier: object
- organizationIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactInfoIdentifier.externalIdentifier.organizationIdentifier
- personIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactInfoIdentifier.externalIdentifier.personIdentifier
- contactInfoNickName: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactInfoIdentifier.externalIdentifier.organizationIdentifier: object
- distinguishedName: string
- uniqueID: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactInfoIdentifier.externalIdentifier.personIdentifier: object
- distinguishedName: string
- uniqueID: string
- externalIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactInfoIdentifier.externalIdentifier.personIdentifier.externalIdentifier
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactInfoIdentifier.externalIdentifier.personIdentifier.externalIdentifier: object
- identifier: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.contactName: object
- middleName: string
- businessTitle: string
- personTitle: string
- firstName: string
- lastName: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress1: object
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress1.userData
- value: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress1.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress1.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress1.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress2: object
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress2.userData
- value: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress2.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress2.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.emailAddress2.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax1: object
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax1.userData
- value: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax1.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax1.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax1.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax2: object
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax2.userData
- value: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax2.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax2.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.fax2.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.mobilePhone1: object
- country: string
- value: string
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.mobilePhone1.userData
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.mobilePhone1.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.mobilePhone1.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.mobilePhone1.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone1: object
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone1.userData
- type: string
- value: string
- publish: boolean
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone1.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone1.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone1.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone2: object
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone2.userData
- type: string
- value: string
- publish: boolean
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone2.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone2.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.telephone2.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaserAddress.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.purchaseRecordIdentifier: object
- uniqueID: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType: object
- registrantAddress: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress
- relation: string
- personIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.personIdentifier
- registrantID: string
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.userData
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.personIdentifier: object
- distinguishedName: string
- uniqueID: string
- externalIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.personIdentifier.externalIdentifier
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.personIdentifier.externalIdentifier: object
- identifier: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress: object
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.userData
- organizationName: string
- fax1: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax1
- language: string
- geographicalTaxCode: string
- mobilePhone1: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.mobilePhone1
- geographicalShippingCode: string
- bestCallingTime: string
- contactInfoIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactInfoIdentifier
- fax2: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax2
- contactName: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactName
- emailAddress2: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress2
- address: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.address
- emailAddress1: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress1
- attributes: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.attributes - telephone1: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone1
- organizationUnitName: string
- telephone2: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone2
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.address: object
- city: string
- addressLine: string[]
string - userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.address.userData
- country: string
- primary: boolean
- stateOrProvinceName: string
- type: string
- postalCode: string
- internalOfficeAddress: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.address.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.address.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.address.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.attributes: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactInfoIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactInfoIdentifier.externalIdentifier
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactInfoIdentifier.externalIdentifier: object
- organizationIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactInfoIdentifier.externalIdentifier.organizationIdentifier
- personIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactInfoIdentifier.externalIdentifier.personIdentifier
- contactInfoNickName: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactInfoIdentifier.externalIdentifier.organizationIdentifier: object
- distinguishedName: string
- uniqueID: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactInfoIdentifier.externalIdentifier.personIdentifier: object
- distinguishedName: string
- uniqueID: string
- externalIdentifier: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactInfoIdentifier.externalIdentifier.personIdentifier.externalIdentifier
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactInfoIdentifier.externalIdentifier.personIdentifier.externalIdentifier: object
- identifier: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.contactName: object
- middleName: string
- businessTitle: string
- personTitle: string
- firstName: string
- lastName: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress1: object
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress1.userData
- value: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress1.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress1.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress1.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress2: object
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress2.userData
- value: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress2.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress2.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.emailAddress2.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax1: object
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax1.userData
- value: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax1.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax1.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax1.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax2: object
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax2.userData
- value: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax2.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax2.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.fax2.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.mobilePhone1: object
- country: string
- value: string
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.mobilePhone1.userData
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.mobilePhone1.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.mobilePhone1.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.mobilePhone1.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone1: object
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone1.userData
- type: string
- value: string
- publish: boolean
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone1.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone1.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone1.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone2: object
- userData: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone2.userData
- type: string
- value: string
- publish: boolean
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone2.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone2.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.telephone2.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.registrantAddress.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.userData: object
- userDataField: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.userData.userDataField
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary: object
- recordSetCount: integer (int32)
- recordSetCompleteIndicator: boolean
- recordSetStartNumber: integer (int32)
- resultList: object[]
com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary.resultList - recordSetTotal: integer (int32)
com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary.resultList: object
- comment: string
- lastUpdate: string (date)
- description: string
- organizationId: string
- userRegistration: com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary.resultList.userRegistration
- storeId: string
- memberId: string
- orderId: string
- status: string
com.ibm.commerce.order.beans.RequisitionListDataBean_IBM_Store_Summary.resultList.userRegistration: object
- middleName: string
- lastName: string
- firstName: string
com.ibm.commerce.order.commands.SSFSOrderCopyCmd: object
com.ibm.commerce.order.external.commands.ProcessExternalOrderCmd: object
com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType: object
- adjustmentUsage: string
- userData: com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.userData
- adjustmentValue: string
- comments: com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.comments
- adjustmentCategory: string
com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.comments: object
- value: string
- language: string
com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.userData.userDataField
com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.order.facade.datatypes.ChannelType: object
- userData: com.ibm.commerce.order.facade.datatypes.ChannelType.userData
- channelIdentifer: com.ibm.commerce.order.facade.datatypes.ChannelType.channelIdentifer
- description: com.ibm.commerce.order.facade.datatypes.ChannelType.description
com.ibm.commerce.order.facade.datatypes.ChannelType.channelIdentifer: object
- channelName: string
- uniqueID: string
com.ibm.commerce.order.facade.datatypes.ChannelType.description: object
- value: string
- language: string
com.ibm.commerce.order.facade.datatypes.ChannelType.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.ChannelType.userData.userDataField
com.ibm.commerce.order.facade.datatypes.ChannelType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.order.facade.datatypes.CouponCodeType: object
- status: string
- userData: com.ibm.commerce.order.facade.datatypes.CouponCodeType.userData
- code: string
- couponId: string
- expirationDateTime: string
- description: object[]
com.ibm.commerce.order.facade.datatypes.CouponCodeType.description - effectiveDateTime: string
- promotionIdentifier: com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier
com.ibm.commerce.order.facade.datatypes.CouponCodeType.description: object
- userData: com.ibm.commerce.order.facade.datatypes.CouponCodeType.description.userData
- shortDescription: string
- language: string
- longDescription: string
com.ibm.commerce.order.facade.datatypes.CouponCodeType.description.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.CouponCodeType.description.userData.userDataField
com.ibm.commerce.order.facade.datatypes.CouponCodeType.description.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier: object
- calculationCodeIdentifier: com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier
- uniqueID: string
- externalIdentifier: com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier
com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier: object
- calculationCodeExternalIdentifier: com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier
- uniqueID: string
com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier: object
- calculationUsageID: string
- code: string
- storeIdentifier: com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier
com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier: object
- storeIdentifier: com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier.storeIdentifier
- version: integer (int64)
- name: string
- revision: integer (int64)
com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.order.facade.datatypes.CouponCodeType.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.CouponCodeType.userData.userDataField
com.ibm.commerce.order.facade.datatypes.CouponCodeType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.order.facade.datatypes.CSRCommentsType: object
- cSRIdentifier: com.ibm.commerce.order.facade.datatypes.CSRCommentsType.cSRIdentifier
- comment: string
- userData: com.ibm.commerce.order.facade.datatypes.CSRCommentsType.userData
- changeReasonCode: com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode
- orderVersion: string
- creationDate: string
com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode: object
- reasonCode: string
- description: com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode.description
- userData: com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode.userData
com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode.description: object
- value: string
- language: string
com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode.userData.userDataField
com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.order.facade.datatypes.CSRCommentsType.cSRIdentifier: object
- distinguishedName: string
- uniqueID: string
- externalIdentifier: com.ibm.commerce.order.facade.datatypes.CSRCommentsType.cSRIdentifier.externalIdentifier
com.ibm.commerce.order.facade.datatypes.CSRCommentsType.cSRIdentifier.externalIdentifier: object
- identifier: string
com.ibm.commerce.order.facade.datatypes.CSRCommentsType.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.CSRCommentsType.userData.userDataField
com.ibm.commerce.order.facade.datatypes.CSRCommentsType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.order.facade.datatypes.FinancialTransactionType: object
- status: string
- lastUpdate: string
- requestAmount: com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.requestAmount
- requestTime: string
- trackingID: string
- paymentProtocolData: object[]
com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.paymentProtocolData - referenceNumber: string
- transactionExtensionData: object[]
com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.transactionExtensionData - paymentInstructionID: string
- merchantOrderNumber: string
- responseCode: string
- financialTransactionIdentifier: com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.financialTransactionIdentifier
- reasonCode: string
- userData: com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.userData
- avsCode: string
- expirationTime: string
- transactionType: string
com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.financialTransactionIdentifier: object
- uniqueID: string
- externalIdentifier: string
com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.paymentProtocolData: object
- name: string
- value: string
com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.requestAmount: object
- currency: string
- value: number (double)
com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.transactionExtensionData: object
- name: string
- value: string
com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.userData.userDataField
com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType: object
- orderBlock: object[]
com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock - userData: com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.userData
com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock: object
- resovled: boolean
- userData: com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.userData
- blockReason: com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason
- timeBlocked: string
- comments: string
com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason: object
- reasonCode: string
- userData: com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason.userData
- description: com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason.description
- reansonType: string
com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason.description: object
- value: string
- language: string
com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason.userData.userDataField
com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.userData.userDataField
com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.userData.userDataField
com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType: object
- catalogEntryIdentifier: com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier
- userData: com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.userData
- orderItemComponentIdentifier: com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.orderItemComponentIdentifier
- configurationID: string
- required: boolean
- unitPrice: com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice
- quantity: com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.quantity
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier: object
- ownerID: string
- partNumber: string
- storeIdentifier: com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier.storeIdentifier
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.orderItemComponentIdentifier: object
- uniqueID: string
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.quantity: object
- value: number (double)
- uom: string
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice: object
- price: com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice.price
- quantity: com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice.quantity
- alternativeCurrencyPrice: object[]
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice.alternativeCurrencyPrice
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice.alternativeCurrencyPrice: object
- currency: string
- value: number (double)
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice.price: object
- currency: string
- value: number (double)
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice.quantity: object
- value: number (double)
- uom: string
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.userData.userDataField
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.order.facade.datatypes.ParentInfoType: object
- userData: com.ibm.commerce.order.facade.datatypes.ParentInfoType.userData
- relationTypeCode: string
- parentOrderIdentifier: com.ibm.commerce.order.facade.datatypes.ParentInfoType.parentOrderIdentifier
- parentOrderItemIdentifier: com.ibm.commerce.order.facade.datatypes.ParentInfoType.parentOrderItemIdentifier
com.ibm.commerce.order.facade.datatypes.ParentInfoType.parentOrderIdentifier: object
- customerOrderNumber: string
- externalOrderID: string
- uniqueID: string
com.ibm.commerce.order.facade.datatypes.ParentInfoType.parentOrderItemIdentifier: object
- uniqueID: string
- externalOrderItemID: string
com.ibm.commerce.order.facade.datatypes.ParentInfoType.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.ParentInfoType.userData.userDataField
com.ibm.commerce.order.facade.datatypes.ParentInfoType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.order.facade.datatypes.PromotionCodeType: object
- userData: com.ibm.commerce.order.facade.datatypes.PromotionCodeType.userData
- associatedPromotion: object[]
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion - code: string
- reason: com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion: object
- description: com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.description
- promotionIdentifier: com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.description: object
- value: string
- language: string
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier: object
- calculationCodeIdentifier: com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier
- uniqueID: string
- externalIdentifier: com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier: object
- calculationCodeExternalIdentifier: com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier
- uniqueID: string
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier: object
- calculationUsageID: string
- code: string
- storeIdentifier: com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier: object
- storeIdentifier: com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier.storeIdentifier
- version: integer (int64)
- name: string
- revision: integer (int64)
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason: object
- reasonCode: string
- valid: boolean
- description: com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.description
- userData: com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.userData
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.description: object
- value: string
- language: string
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.userData.userDataField
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.userData: object
- userDataField: object[]
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.userData.userDataField
com.ibm.commerce.order.facade.datatypes.PromotionCodeType.userData.userDataField: object
- value: string
- key: string
com.ibm.commerce.rest.order.handler.MerchantHandler$MerchantValidationBodyDescription: object
Description of the merchant validation input body.
- paymentConfigGroup: string
Payment configuraiton group.
- paymentSystem: string
Payment system .
- validationURL: string
Validation url.
com.ibm.commerce.rest.order.handler.OrderExportHandler$OrderExportRequest: object
- status: string
A list of order status to be included in the export. This is the status of the order, not the status of the individual order item within the order. The default is null which does not consider the order status.
- timePlacedInDays: string
The number of days to set back for the time placed of the order. 0 means exporting all the orders for today, 1 means exporting all the orders starting from yesterday, 2 means 2 days ago until now.
com.ibm.commerce.rest.order.handler.OrderExportHandler$OrderExportResponse: object
- exportId: string
Export ID returned from the order export. It can be used in the order download REST API.
com.ibm.commerce.rest.order.handler.OrderHandler$CSRCommentForm: object
Information required to add CSR comment.
- commentField: string
The comment field.
- emailAddress: string
The email address.
- sendEmail: boolean
The flag to indicate to send email or not.
com.ibm.commerce.rest.order.handler.OrderHandler$CSRCommentResponseForm: object
Add CSR comment response.
- submitFinishMessage: string
The submit finish message.
- orCommentId: string
The order comment id.
com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListConfigurationAddRequest: object
- status: string
The status of the requisition list.
- name: string
The name of the requisition list.
- catEntryId: string
The catalog entry id of the dynamic kit or predefined dynamic kit.
- requisitionListId: string
The ID of the requisition list.
- configurationXML: string
Tthe BOM XML to describe the configuration of the dynamic kit or predefined dynamic kit.
- partNumber: string
The part number of the dynamic kit or predefined dynamic kit.
- type: string
The type of the requisition list.
- quantity: string
The quantity of the dynamic kit or predefined dynamic kit.
com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListConfigurationAddResponse: object
com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListDeleteRequest: object
com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListDeleteResponse: object
com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListSubmitRequest: object
- offerId: string[]
A list of IDs of the offers associated with the order. This parameter can be repeated.
string - contractId: string[]
A list of IDs of contracts associated with the order. This parameter can be repeated.
string
com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListSubmitResponse: object
- orderId: string
The ID of the order.
com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListUpdateRequest: object
- status: string
Distinguishes between a private requisition list and a shared requisition list. The default is Y for a private requisition list. Z indicates a shared requisition list.
- billtoAddressId: string
The billing address identification.
- name: string
The name of the requisition list.
com.ibm.commerce.rest.requisitionlist.handler.RequisitionListHandler$RequisitionListUpdateResponse: object
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$CreateBodyParameterDescription: object
Description of the post input body to create a wish list or item.
- item: object[]
Wish list items to add.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$CreateBodyParameterDescription$WishlistItemBodyDescription - giftCardAccepted: string
Wish list gift card accepted.
- descriptionName: string
Wish list description name.
- accessSpecifier: string
Wish list access specifier.
- description: string
Wish list description.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$CreateBodyParameterDescription$WishlistItemBodyDescription: object
Wish list item body.
- quantityRequested: string
Wish list item quantity requested.
- partNumber: string
Wish list item product partNumber.
- location: string
Wish list item location.
- productId: string
Wish list item product ID.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$DeleteWishListResponse: object
Wish list delete response.
- uniqueID: string
Wish list unique identifier.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$ProcessBodyParameterDescription: object
Description of the post input body to process the wish list.
- announcement: object[]
The email announcements made about the gift list by the registrants to friends and family.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$ProcessBodyParameterDescription$AnnouncementBodyDescription
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$ProcessBodyParameterDescription$AnnouncementBodyDescription: object
Announcement body.
- senderEmailAddress: string
The e-mail address of the sender.
- message: string
The custom message sent by the sender in the e-mail.
- emailRecipient: object[]
The recipients of the e-mail.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$ProcessBodyParameterDescription$AnnouncementBodyDescription$EmailRecipient - senderName: string
The name of the sender.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$ProcessBodyParameterDescription$AnnouncementBodyDescription$EmailRecipient: object
The recipients of the e-mail.
- recipientEmail: string
E-mail address of the recipient.
- addressingMethod: string
The method in which the recipient is addressed in the e-mail, for example, they are directly addressed (TO), they are copied on the mail (CC), and so on.
- recipientName: string
The name of the sender.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$UpdateBodyParameterDescription: object
Description of the post input body to update the wishlist or item.
- item: object[]
Wish list item to add or updated.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$UpdateBodyParameterDescription$WishlistItemBodyDescription - descriptionName: string
Wish list description name.
- description: string
Wish list description.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$UpdateBodyParameterDescription$WishlistItemBodyDescription: object
Wish list item body.
- quantityRequested: string
Wish list item quantity requested.
- giftListItemID: string
Wish list item ID.
- partNumber: string
Wish list item product partNumber.
- productId: string
Wish list item product ID.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$WishListResponse: object
Wish list change response.
- item: object[]
Wish list item to add or update.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$WishListResponse$Item - storeId: string
The store identifier.
- uniqueID: string
Wish list unique identifier.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$WishListResponse$Item: object
wish list item body.
- giftListItemID: string
wish list item ID.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$WishListUpdateResponse: object
Wish list change response.
- item: object[]
Wish list item to add or update.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$WishListUpdateResponse$Item - uniqueID: string
Wish list unique identifier.
com.ibm.commerce.rest.wishlist.handler.WishlistHandler$WishListUpdateResponse$Item: object
Wish list item body.
- giftListItemID: string
Wish list item ID.
com.ibm.commerce.tools.optools.order.beans.CSROrderSearchDataBean_IBM_Summary: object
- recordSetCompleteIndicator: boolean
- pageSize: string
- recordSetCount: integer (int32)
- resultList: object[]
com.ibm.commerce.tools.optools.order.beans.CSROrderSearchDataBean_IBM_Summary.resultList - pageNumber: integer (int32)
- recordSetTotal: integer (int32)
com.ibm.commerce.tools.optools.order.beans.CSROrderSearchDataBean_IBM_Summary.resultList: object
- orderId: string
- status: string
- orderTime: string
- formattedDataBean: com.ibm.commerce.tools.optools.order.beans.CSROrderSearchDataBean_IBM_Summary.resultList.formattedDataBean
- checkLock: boolean
- uniqueShippingAddresses: object[]
com.ibm.commerce.tools.optools.order.beans.CSROrderSearchDataBean_IBM_Summary.resultList.uniqueShippingAddresses - lockedLogonId: string
- memberId: string
- currency: string
- isLocked: boolean
- editorId: integer (int64)
- blocked: boolean
com.ibm.commerce.tools.optools.order.beans.CSROrderSearchDataBean_IBM_Summary.resultList.formattedDataBean: object
- grandTotal: number (double)
com.ibm.commerce.tools.optools.order.beans.CSROrderSearchDataBean_IBM_Summary.resultList.uniqueShippingAddresses: object
- addressType: string
- addressId: string
- personTitle: string
- primary: string
- email2: string
- phone1Type: string
- city: string
- countryDisplayName: string
- middleName: string
- state: string
- fax1: string
- email1: string
- nickName: string
- status: string
- phone1: string
- phone2Type: string
- publishPhone1: string
- publishPhone2: string
- phone2: string
- address1: string
- address2: string
- address3: string
- zipCode: string
- mobilePhone1: string
- isSelfAddress: boolean
- firstName: string
- lastName: string
- country: string
- stateProvDisplayName: string
com.ibm.commerce.tools.optools.order.beans.OrderCommentRestDataBean_IBM_Summary: object
- recordSetCompleteIndicator: boolean
- pageSize: integer (int32)
- recordSetCount: integer (int32)
- orderComments: object[]
com.ibm.commerce.tools.optools.order.beans.OrderCommentRestDataBean_IBM_Summary.orderComments - pageNumber: integer (int32)
- recordSetTotal: integer (int32)
com.ibm.commerce.tools.optools.order.beans.OrderCommentRestDataBean_IBM_Summary.orderComments: object
- commentDetails: com.ibm.commerce.tools.optools.order.beans.OrderCommentRestDataBean_IBM_Summary.orderComments.commentDetails
- serviceRepDetails: com.ibm.commerce.tools.optools.order.beans.OrderCommentRestDataBean_IBM_Summary.orderComments.serviceRepDetails
com.ibm.commerce.tools.optools.order.beans.OrderCommentRestDataBean_IBM_Summary.orderComments.commentDetails: object
- comment: string
- lastupdate: string
- orcommentId: string
- serviceRepresentativeId: string
com.ibm.commerce.tools.optools.order.beans.OrderCommentRestDataBean_IBM_Summary.orderComments.serviceRepDetails: object
- logonId: string
- address: com.ibm.commerce.tools.optools.order.beans.OrderCommentRestDataBean_IBM_Summary.orderComments.serviceRepDetails.address
com.ibm.commerce.tools.optools.order.beans.OrderCommentRestDataBean_IBM_Summary.orderComments.serviceRepDetails.address: object
- middleName: string
- lastName: string
- memberId: string
- firstName: string
Empty: object
Empty model. Used as default value when no model is specified.
inventoryavailability-inventoryavailability: object
- InventoryAvailability: object[]
inventoryavailability-inventoryavailability_item
inventoryavailability-inventoryavailability_item: object
- physicalStoreName: string
- onlineStoreName: string
- availabilityDateTime: string
- onlineStoreId: string
- unitOfMeasure: string
- availableQuantity: string (double)
- inventoryStatus: string
- userDataField: object[]
inventoryavailability-inventoryavailability_item.userDataField - physicalStoreId: string
- productId: string
inventoryavailability-inventoryavailability_item.userDataField: object
- value: string
- key: string
java.util.Map$Entry: object
- value: string
- key: string
order-orderDetail: object
- recordSetStartNumber: string (int64)
- grandTotal: string (double)
- requestedShipDate: string
- orderItem: object[]
order-orderDetail.orderItem - addressId: string
- pysicalStoreId: string
- cSRComments: object[]
com.ibm.commerce.order.facade.datatypes.CSRCommentsType - parentInfo: com.ibm.commerce.order.facade.datatypes.ParentInfoType
- adjustmentRequirement: object[]
com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType - totalAdjustment: string (double)
- orderStatus: string
- totalShippingChargeCurrency: string
- quoteID: string
- bLockInfo: com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType
- genericTotal: object[]
com.ibm.commerce.foundation.common.datatypes.GenericTotalType - blocked: string
- recordSetComplete: string
- adjustment: object[]
order-orderDetail.adjustment - paymentInstruction: object[]
order-orderDetail.paymentInstruction - orderDescription: string
- totalShippingTax: string (double)
- prepareIndicator: string
- totalShippingTaxCurrency: string
- comments: string
- grandTotalCurrency: string
- shipModeId: string
- totalSalesTaxCurrency: string
- storeUniqueID: string
- buyerId: string
- userDataField: object[]
order-orderDetail.userDataField - orgDistinguishedName: string
- promotionCode: object[]
com.ibm.commerce.order.facade.datatypes.PromotionCodeType - channel: com.ibm.commerce.order.facade.datatypes.ChannelType
- orderId: string
- shipAsComplete: string
- xstat_: object[]
java.util.Map$Entry - rewardOption: object[]
order-orderDetail.rewardOption - recordSetCount: string (int64)
- buyerApprovalStatus: string
- orderTypeCode: string
- externalOrderID: string
- editable: string
- totalSalesTax: string (double)
- quoteIdentifier: com.ibm.commerce.foundation.common.datatypes.QuoteIdentifierType
- buyerPONumber: string
- totalProductPriceCurrency: string
- placedDate: string
- customerOrderNumber: string
- totalAdjustmentCurrency: string
- totalShippingCharge: string (double)
- orderVersion: string
- totalProductPrice: string (double)
- locked: string
- couponCode: object[]
com.ibm.commerce.order.facade.datatypes.CouponCodeType - totalTaxByTaxCategory: object[]
order-orderDetail.totalTaxByTaxCategory - paymentStatus: string
- orgUniqueID: string
- orderExtendAttribute: object[]
order-orderDetail.orderExtendAttribute - storeNameIdentifier: string
- lastUpdateDate: string
- buyerDistinguishedName: string
- financialTransaction: object[]
com.ibm.commerce.order.facade.datatypes.FinancialTransactionType - orderEditor: com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType
- storeOwnerID: string
- recordSetTotal: string (int64)
order-orderDetail.adjustment: object
- code: string
- description: string
- displayLevel: string
- currency: string
- amount: string (double)
- usage: string
- userDataField: object[]
order-orderDetail.adjustment.userDataField - descriptionLanguage: string
order-orderDetail.adjustment.userDataField: object
- value: string
- key: string
order-orderDetail.orderExtendAttribute: object
- attributeName: string
- attributeType: string
- attributeValue: string
order-orderDetail.orderItem: object
- addressLine: string[]
string - externalOrderItemID: string
- orderItemInventoryStatus: string
- alternativeCurrencyPrice: object[]
com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType - adjustment: object[]
order-orderDetail.orderItem.adjustment - email2: string
- shippingChargeCurrency: string
- email1: string
- fulfillmentCenterName: string
- middleName: string
- geographicalTaxCode: string
- createDate: string
- salesTax: string (double)
- physicalStoreExternalId: string
- zipCode: string
- mobilePhone1: string
- itemAttributes: object[]
order-orderDetail.orderItem.itemAttributes - shipCarrAccntNum: string
- unitPrice: string (double)
- contractId: string
- unitQuantity: string (double)
- organizationName: string
- geographicalShippingCode: string
- stateOrProvinceName: string
- lastUpdateDate: string
- shipModeDescription: string
- addressId: string
- shippingCharge: string (double)
- shipModeLanguage: string
- totalAdjustment: com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType
- orderItemExtendAttribute: object[]
order-orderDetail.orderItem.orderItemExtendAttribute - UOM: string
- genericTotal: object[]
com.ibm.commerce.foundation.common.datatypes.GenericTotalType - shippingChargeType: string
- comments: string
- state: string
- fulfillmentCenterId: string
- shipModeId: string
- userDataField: object[]
order-orderDetail.orderItem.userDataField - phone1Type: string
- internalOfficeAddress: string
- shippingTaxCurrency: string
- phone2Type: string
- phone2: string
- businessTitle: string
- storeId: string
- shippingChargePolicyID: string
- phone1: string
- orderItemPrice: string (double)
- language: string
- country: string
- carrier: string
- shippingCarrierAccountNumber: string
- attributes: object[]
order-orderDetail.orderItem.attributes - partNumber: string
- timeReleased: string
- primary: string
- unitUom: string
- requestedShipDate: string
- fulfillmentCenterOwnerId: string
- priceOverride: string
- city: string
- availableDate: string
- shipModeCode: string
- fax2: string
- fax1: string
- taxByTaxCategory: object[]
com.ibm.commerce.foundation.common.datatypes.TaxByTaxCategoryType - organizationIdentifier: com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType
- nickName: string
- isExpedited: string
- expectedShipDate: string
- shipInstruction: string
- mobilePhone1Country: string
- orderItemStatus: string
- firstName: string
- freeGift: string
- organizationUnitName: string
- storeIdentifier: com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType
- phone1Publish: string
- addressType: string
- orderItemFulfillmentStatus: string
- personTitle: string
- adjustmentRequirement: object[]
com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType - currency: string
- fulfillmentCenterDescription: com.ibm.commerce.foundation.common.datatypes.DescriptionType
- salesTaxCurrency: string
- usableShippingChargePolicy: object[]
order-orderDetail.orderItem.usableShippingChargePolicy - timeShipped: string
- offerID: string
- shipTieCode: string
- postalCode: string
- personIdentifier: com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType
- shippingTax: string (double)
- physicalStoreId: string
- productId: string
- lastName: string
- trackingURL: string
- bestCallingTime: string
- phone2Publish: string
- correlationGroup: string
- orderItemId: string
- configurationID: string
- orderItemComponent: object[]
com.ibm.commerce.order.facade.datatypes.OrderItemComponentType - ownerID: string
- quantity: string (double)
order-orderDetail.orderItem.adjustment: object
- code: string
- description: string
- language: string
- currency: string
- amount: string (double)
- usage: string
- userDataField: object[]
order-orderDetail.orderItem.adjustment.userDataField
order-orderDetail.orderItem.adjustment.userDataField: object
- value: string
- key: string
order-orderDetail.orderItem.attributes: object
- attrKey: string
- attrValue: string
order-orderDetail.orderItem.itemAttributes: object
- attrName: string
- attrValue: string
order-orderDetail.orderItem.orderItemExtendAttribute: object
- attributeName: string
- attributeType: string
- attributeValue: string
order-orderDetail.orderItem.usableShippingChargePolicy: object
- storeId: com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType
- type: string
- name: string
- uniqueID: string
order-orderDetail.orderItem.userDataField: object
- value: string
- key: string
order-orderDetail.paymentInstruction: object
- addressType: string
- addressLine: string[]
string - piId: string
- refundAllowed: string
- personTitle: string
- minAmount: com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType
- primary: string
- payMethodId: string
- paymentRule: string
- piDescription: string
- email2: string
- piAmount: string (double)
- maxAmount: com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType
- city: string
- piCurrency: string
- sequenceNumber: string (int64)
- piStatus: string
- middleName: string
- geographicalTaxCode: string
- priority: string (int64)
- protocolData: object[]
order-orderDetail.paymentInstruction.protocolData - state: string
- fax2: string
- fax1: string
- postalCode: string
- organizationIdentifier: com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType
- email1: string
- internalOfficeAddress: string
- billing_address_id: string
- paymentTermConditionId: string
- phone2Type: string
- nickName: string
- phone2: string
- businessTitle: string
- phone1: string
- zipCode: string
- bestCallingTime: string
- mobilePhone1Country: string
- piLanguage: string
- phone2Publish: string
- mobilePhone1: string
- phone1Type: string
- personIdentifier: com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType
- organizationUnitName: string
- organizationName: string
- language: string
- firstName: string
- lastName: string
- geographicalShippingCode: string
- stateOrProvinceName: string
- phone1Publish: string
- attributes: object[]
order-orderDetail.paymentInstruction.attributes - country: string
- userDataField: object[]
order-orderDetail.paymentInstruction.userDataField
order-orderDetail.paymentInstruction.attributes: object
- attrKey: string
- attrValue: string
order-orderDetail.paymentInstruction.protocolData: object
- name: string
- value: string
order-orderDetail.paymentInstruction.userDataField: object
- value: string
- key: string
order-orderDetail.rewardOption: object
- code: string
- adjustmentLanguage: string
- adjustmentAmount: string (double)
- calculationCodeID: order-orderDetail.rewardOption.calculationCodeID
- adjustment: order-orderDetail.rewardOption.adjustment
- giftSet: order-orderDetail.rewardOption.giftSet
- rewardSpecGiftItem: object[]
order-orderDetail.rewardOption.rewardSpecGiftItem - adjustmentCode: string
- adjustmentDescription: string
- adjustmentUsage: string
- rewardChoice: order-orderDetail.rewardOption.rewardChoice
- adjustmentCurrency: string
- usage: string
- userData: order-orderDetail.rewardOption.userData
- description: order-orderDetail.rewardOption.description
- rewardOptionIdentifier: order-orderDetail.rewardOption.rewardOptionIdentifier
- rewardOptionExternalId: string
- promotionType: string
- isPromotionCodeRequired: boolean
- giftSetSpecification: order-orderDetail.rewardOption.giftSetSpecification
- adjustmentDisplayLevel: string
- displayLevel: string
- amount: order-orderDetail.rewardOption.amount
- rewardSpecification: order-orderDetail.rewardOption.rewardSpecification
- rewardChoiceGiftItem: object[]
order-orderDetail.rewardOption.rewardChoiceGiftItem - rewardSpecMaxQuantity: string (double)
- rewardOptionId: string
- rewardSpecMaxQuantityUom: string
order-orderDetail.rewardOption.adjustment: object
- userData: order-orderDetail.rewardOption.adjustment.userData
- code: string
- description: order-orderDetail.rewardOption.adjustment.description
- displayLevel: string
- calculationCodeID: order-orderDetail.rewardOption.adjustment.calculationCodeID
- amount: order-orderDetail.rewardOption.adjustment.amount
- promotionType: string
- usage: string
- isPromotionCodeRequired: boolean
order-orderDetail.rewardOption.adjustment.amount: object
- currency: string
- value: number (double)
order-orderDetail.rewardOption.adjustment.calculationCodeID: object
- calculationCodeExternalIdentifier: order-orderDetail.rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier
- uniqueID: string
order-orderDetail.rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier: object
- calculationUsageID: string
- code: string
- storeIdentifier: order-orderDetail.rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier
order-orderDetail.rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: order-orderDetail.rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier
order-orderDetail.rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
order-orderDetail.rewardOption.adjustment.description: object
- value: string
- language: string
order-orderDetail.rewardOption.adjustment.userData: object
- userDataField: object[]
order-orderDetail.rewardOption.adjustment.userData.userDataField
order-orderDetail.rewardOption.adjustment.userData.userDataField: object
- value: string
- key: string
order-orderDetail.rewardOption.amount: object
- currency: string
- value: number (double)
order-orderDetail.rewardOption.calculationCodeID: object
- calculationCodeExternalIdentifier: order-orderDetail.rewardOption.calculationCodeID.calculationCodeExternalIdentifier
- uniqueID: string
order-orderDetail.rewardOption.calculationCodeID.calculationCodeExternalIdentifier: object
- calculationUsageID: string
- code: string
- storeIdentifier: order-orderDetail.rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier
order-orderDetail.rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: order-orderDetail.rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier
order-orderDetail.rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
order-orderDetail.rewardOption.description: object
- value: string
- language: string
order-orderDetail.rewardOption.giftSet: object
- giftItem: object[]
order-orderDetail.rewardOption.giftSet.giftItem
order-orderDetail.rewardOption.giftSet.giftItem: object
- catalogEntryIdentifier: order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier
- quantity: order-orderDetail.rewardOption.giftSet.giftItem.quantity
order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier: object
- uniqueID: string
- externalIdentifier: order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier
order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier: object
- ownerID: string
- partNumber: string
- storeIdentifier: order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier
order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
order-orderDetail.rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
order-orderDetail.rewardOption.giftSet.giftItem.quantity: object
- value: number (double)
- uom: string
order-orderDetail.rewardOption.giftSetSpecification: object
- maximumQuantity: order-orderDetail.rewardOption.giftSetSpecification.maximumQuantity
- giftItem: object[]
order-orderDetail.rewardOption.giftSetSpecification.giftItem
order-orderDetail.rewardOption.giftSetSpecification.giftItem: object
- catalogEntryIdentifier: order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier
- quantity: order-orderDetail.rewardOption.giftSetSpecification.giftItem.quantity
order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier: object
- uniqueID: string
- externalIdentifier: order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier
order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier: object
- ownerID: string
- partNumber: string
- storeIdentifier: order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier
order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
order-orderDetail.rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
order-orderDetail.rewardOption.giftSetSpecification.giftItem.quantity: object
- value: number (double)
- uom: string
order-orderDetail.rewardOption.giftSetSpecification.maximumQuantity: object
- value: number (double)
- uom: string
order-orderDetail.rewardOption.rewardChoice: object
- userData: order-orderDetail.rewardOption.rewardChoice.userData
- giftSet: order-orderDetail.rewardOption.rewardChoice.giftSet
order-orderDetail.rewardOption.rewardChoice.giftSet: object
- giftItem: object[]
order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem
order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem: object
- catalogEntryIdentifier: order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier
- quantity: order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.quantity
order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier: object
- uniqueID: string
- externalIdentifier: order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier
order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier: object
- ownerID: string
- partNumber: string
- storeIdentifier: order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier
order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
order-orderDetail.rewardOption.rewardChoice.giftSet.giftItem.quantity: object
- value: number (double)
- uom: string
order-orderDetail.rewardOption.rewardChoice.userData: object
- userDataField: object[]
order-orderDetail.rewardOption.rewardChoice.userData.userDataField
order-orderDetail.rewardOption.rewardChoice.userData.userDataField: object
- value: string
- key: string
order-orderDetail.rewardOption.rewardChoiceGiftItem: object
- quantity: string (double)
- uom: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType
- productId: string
order-orderDetail.rewardOption.rewardOptionIdentifier: object
- uniqueID: string
- externalIdentifier: string
order-orderDetail.rewardOption.rewardSpecGiftItem: object
- value: string (double)
- uom: string
- externalIdentifier: com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType
- productId: string
order-orderDetail.rewardOption.rewardSpecification: object
- giftSetSpecification: order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification
- userData: order-orderDetail.rewardOption.rewardSpecification.userData
order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification: object
- maximumQuantity: order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.maximumQuantity
- giftItem: object[]
order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem
order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem: object
- catalogEntryIdentifier: order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier
- quantity: order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.quantity
order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier: object
- uniqueID: string
- externalIdentifier: order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier
order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier: object
- ownerID: string
- partNumber: string
- storeIdentifier: order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier
order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier: object
- uniqueID: string
- externalIdentifier: order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier
order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object
- ownerID: string
- nameIdentifier: string
order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.giftItem.quantity: object
- value: number (double)
- uom: string
order-orderDetail.rewardOption.rewardSpecification.giftSetSpecification.maximumQuantity: object
- value: number (double)
- uom: string
order-orderDetail.rewardOption.rewardSpecification.userData: object
- userDataField: object[]
order-orderDetail.rewardOption.rewardSpecification.userData.userDataField
order-orderDetail.rewardOption.rewardSpecification.userData.userDataField: object
- value: string
- key: string
order-orderDetail.rewardOption.userData: object
- userDataField: object[]
order-orderDetail.rewardOption.userData.userDataField
order-orderDetail.rewardOption.userData.userDataField: object
- value: string
- key: string
order-orderDetail.totalTaxByTaxCategory: object
- currency: string
- value: string (double)
- taxCategoryCode: string
order-orderDetail.userDataField: object
- value: string
- key: string
order-orderSummary: object
- recordSetCount: string (int64)
- recordSetComplete: string
- recordSetStartNumber: string (int64)
- Order: object[]
order-orderSummary_item - recordSetTotal: string (int64)
order-orderSummary_item: object
- grandTotal: string (double)
- quoteID: string
- cSRComments: object[]
com.ibm.commerce.order.facade.datatypes.CSRCommentsType - parentInfo: com.ibm.commerce.order.facade.datatypes.ParentInfoType
- adjustmentRequirement: object[]
com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType - orderVersion: string
- totalAdjustment: string (double)
- orderStatus: string
- totalShippingChargeCurrency: string
- bLockInfo: com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType
- genericTotal: object[]
com.ibm.commerce.foundation.common.datatypes.GenericTotalType - blocked: string
- adjustment: object[]
order-orderSummary_item.adjustment - orderDescription: string
- totalShippingTax: string (double)
- prepareIndicator: string
- totalShippingTaxCurrency: string
- comments: string
- grandTotalCurrency: string
- totalSalesTaxCurrency: string
- storeUniqueID: string
- buyerId: string
- userDataField: object[]
order-orderSummary_item.userDataField - orgDistinguishedName: string
- promotionCode: object[]
com.ibm.commerce.order.facade.datatypes.PromotionCodeType - channel: com.ibm.commerce.order.facade.datatypes.ChannelType
- orderId: string
- shipAsComplete: string
- xstat_: object[]
java.util.Map$Entry - buyerApprovalStatus: string
- orderTypeCode: string
- externalOrderID: string
- editable: string
- quoteIdentifier: com.ibm.commerce.foundation.common.datatypes.QuoteIdentifierType
- buyerPONumber: string
- totalProductPriceCurrency: string
- placedDate: string
- customerOrderNumber: string
- totalAdjustmentCurrency: string
- totalShippingCharge: string (double)
- orderEditor: com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType
- totalProductPrice: string (double)
- locked: string
- totalTaxByTaxCategory: object[]
order-orderSummary_item.totalTaxByTaxCategory - couponCode: object[]
com.ibm.commerce.order.facade.datatypes.CouponCodeType - orderExtendAttribute: object[]
order-orderSummary_item.orderExtendAttribute - orgUniqueID: string
- storeNameIdentifier: string
- lastUpdateDate: string
- buyerDistinguishedName: string
- totalSalesTax: string (double)
- storeOwnerID: string
order-orderSummary_item.adjustment: object
- code: string
- description: string
- displayLevel: string
- currency: string
- amount: string (double)
- usage: string
- userDataField: object[]
order-orderSummary_item.adjustment.userDataField - descriptionLanguage: string
order-orderSummary_item.adjustment.userDataField: object
- value: string
- key: string
order-orderSummary_item.orderExtendAttribute: object
- attributeName: string
- attributeType: string
- attributeValue: string
order-orderSummary_item.totalTaxByTaxCategory: object
- currency: string
- value: string (double)
- taxCategoryCode: string
order-orderSummary_item.userDataField: object
- value: string
- key: string
wishlist-wishlist: object
- recordSetCount: string (int64)
- recordSetComplete: string
- recordSetStartNumber: string (int64)
- GiftList: object[]
wishlist-wishlist_item - recordSetTotal: string (int64)
wishlist-wishlist_item: object
- externalIdentifier: string
- storeName: string
- manageAccessPassword: string
- coRegistrant: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType - uniqueID: string
- registrant: com.ibm.commerce.giftcenter.facade.datatypes.GiftListRegistrantType
- announcement: object[]
wishlist-wishlist_item.announcement - postEventAddress: com.ibm.commerce.foundation.common.datatypes.ContactInfoType
- event: string
- state: string
- location: string
- userDataField: object[]
wishlist-wishlist_item.userDataField - registryAccessKey: string
- lastUpdate: string
- description: string
- storeId: string
- purchaseRecord: object[]
com.ibm.commerce.giftcenter.facade.datatypes.GiftListPurchaseRecordType - guestMessage: string
- accessSpecifier: string
- optForEmail: string
- giftCardAccepted: string
- preEventAddress: com.ibm.commerce.foundation.common.datatypes.ContactInfoType
- guestAccessKey: string
- item: object[]
wishlist-wishlist_item.item - descriptionName: string
- createdTime: string
- storeOwnerID: string
- registry: string
wishlist-wishlist_item.announcement: object
- userData: wishlist-wishlist_item.announcement.userData
- emailRecipient: object[]
wishlist-wishlist_item.announcement.emailRecipient - senderEmailAddress: string
- giftListAnnouncementID: string
- sentDate: string
- message: string
- senderName: string
wishlist-wishlist_item.announcement.emailRecipient: object
- recipientEmail: string
- addressingMethod: string
- recipientName: string
wishlist-wishlist_item.announcement.userData: object
- userDataField: object[]
wishlist-wishlist_item.announcement.userData.userDataField
wishlist-wishlist_item.announcement.userData.userDataField: object
- value: string
- key: string
wishlist-wishlist_item.item: object
- quantityRequested: string (double)
- itemLastUpdate: string
- attribute: object[]
wishlist-wishlist_item.item.attribute - giftListItemID: string
- quantityRequestedUom: string
- itemCreatedTime: string
- storeIdentifier: com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType
- productOwnerID: string
- location: string
- quantityBoughtUom: string
- quantityBought: string (double)
- partNumber: string
- userDataField: object[]
wishlist-wishlist_item.item.userDataField - productId: string
wishlist-wishlist_item.item.attribute: object
- name: string
- value: string
wishlist-wishlist_item.item.userDataField: object
- value: string
- key: string
wishlist-wishlist_item.userDataField: object
- value: string
- key: string