This class provides RESTful services to add, update, delete, and get items in the shopping cart and checkout.It also provides services to get usable shipping and payment information by delegating to the Order BOD service.
com.ibm.commerce.rest.order.handler.CartHandler
| HTTP Method | Path | Description |
|---|---|---|
| GET | /store/{storeId}/cart/{orderId}/usable_ship_charges_by_ship_mode | Gets usable ship charge information for order id. |
| GET | /store/{storeId}/cart/@self | Gets order details for the shopping cart. |
| GET | /store/{storeId}/cart/@self/buyer_purchase_order/{buyerPurchaseOrderId} | Gets buyer purchase order information for buyer purchase order ID. |
| GET | /store/{storeId}/cart/@self/pattribute/{initKey_referenceNumber} | Gets payment attribute order information for terms & conditions Id. |
| GET | /store/{storeId}/cart/@self/payment_policy_list | Gets payment policy list information for store. |
| GET | /store/{storeId}/cart/@self/usable_billing_address/{orderId} | Gets usable billing address information for order id. |
| GET | /store/{storeId}/cart/@self/usable_payment_info | Gets usable payment information for the shopping cart. |
| GET | /store/{storeId}/cart/@self/usable_shipping_info | Gets usable shipping information for the shopping cart. |
| GET | /store/{storeId}/cart/shipping_modes | Gets allowable shipping information for the store. Deprecated. Use the method that adds support for the locale parameter. |
| GET | /store/{storeId}/cart/shipping_modes | Gets allowable shipping information for the store. |
| POST | /store/{storeId}/cart | Adds one or more order items to the shopping cart. |
| POST | /store/{storeId}/cart/{cartId}/lock | Locks the shopping cart by a CSR. |
| POST | /store/{storeId}/cart/{cartId}/lockOnBehalf | Locks the shopping cart when the buyer administrator/CSR has established a session to act on behalf of a user. |
| POST | /store/{storeId}/cart/{cartId}/unlock | Unlocks the shopping cart by a CSR. |
| POST | /store/{storeId}/cart/{cartId}/unlockOnBehalf | Unlocks the shopping cart when the buyer administrator/CSR has established a session to act on behalf of a user. |
| POST | /store/{storeId}/cart/{orderId}/calculate | Calculate the cost of the order. |
| POST | /store/{storeId}/cart/{orderId}/schedule_order | Creates a scheduled order which is related to a scheduled job. |
| POST | /store/{storeId}/cart/{orderId}/set_pending_order | Set the specified order as the current pending order. |
| POST | /store/{storeId}/cart/@self/add_configuration_to_cart | Adds a dynamic kit configuration to cart. |
| POST | /store/{storeId}/cart/@self/add_preconfiguration_to_cart | Adds a dynamic kit pre-configuration to cart. |
| POST | /store/{storeId}/cart/@self/checkout | Checks out the shopping cart. |
| POST | /store/{storeId}/cart/calculate | Calculate the cost of the order. |
| POST | /store/{storeId}/cart/copy_order | Copies a specified order. |
| POST | /store/{storeId}/cart/create_order | create an order with the description specified |
| PUT | /store/{storeId}/cart/@self | Updates one or more order items in the shopping cart. This method is deprecated, use updateOrderItem. |
| PUT | /store/{storeId}/cart/@self/applyCheckoutProfile | Applies the quick checkout profile to the current shopping cart. |
| PUT | /store/{storeId}/cart/@self/delete_order_item | Deletes the specified order item from the order. |
| PUT | /store/{storeId}/cart/@self/precheckout | Prepares the shopping cart for checkout. This method must be called before the checkout service. |
| PUT | /store/{storeId}/cart/@self/update_configuration_in_cart | Update a dynamic kit configuration in the cart. |
| PUT | /store/{storeId}/cart/@self/update_order_item | Updates one or more order items in the shopping cart. |
| PUT | /store/{storeId}/cart/@self/update_reward_option | Updates the reward option. |
| PUT | /store/{storeId}/cart/move_order_item | Moves order items from one order to another. |
| DELETE | /store/{storeId}/cart/{orderId}/cancel_order | Cancel the specified order. |
| DELETE | /store/{storeId}/cart/@self | Deletes all items in the shopping cart. |
Gets usable ship charge information for order id.
getUsableShipChargesByShipMode
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| orderId | The order ID. | path | string | true | N/A |
| profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 404 | The specified resource couldn't be found. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10801/cart/25205/usable_ship_charges_by_ship_mode?responseFormat=json
200
{
"resultList": [
{
"isShipChargesExist": true,
"numberOfShipModes": 1,
"shipChargesByShipMode": [
{
"carrierAccountNumber": null,
"numberOfShipChargeTypes": 1,
"shipModeDesc": "US - Regular Delivery",
"shipModeId": "11051",
"shippingChargeTypes": [
{
"carrAccntNumber": null,
"internalPolicyId": "-7001",
"policyDescription": "Shipping charged by seller",
"policyId": "StandardShippingChargeBySeller",
"policyName": "StandardShippingChargeBySeller",
"selected": true
}
]
}
]
}
]
}
Gets order details for the shopping cart.
getCart
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | integer | false | false |
| pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | integer | false | false |
| sortOrderItemBy | The order the results are sorted by ie:orderItemID | query | string | false | false |
| profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 404 | The specified resource couldn't be found. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10001/cart/@self?pageSize=50&pageNumber=1&responseFormat=json
200
{
"buyerDistinguishedName": "uid=wcsadmin,o=root organization",
"buyerId": "-1000",
"grandTotal": "600.00000",
"grandTotalCurrency": "USD",
"lastUpdateDate": "2014-11-24T20:35:42.165Z",
"locked": "false",
"orderId": "14029",
"orderItem": [
{
"UOM": "C62",
"addressId": "-1000",
"addressLine": [
"",
"",
""
],
"carrier": "XYZ Carrier",
"city": "",
"contractId": "10001",
"correlationGroup": "30021",
"country": "",
"createDate": "2014-11-06T19:54:28.619Z",
"currency": "USD",
"description": "US - Regular Delivery",
"email1": "",
"email2": "",
"expectedShipDate": "2014-11-24T20:35:44.084Z",
"fax1": "",
"fax2": "",
"firstName": "",
"freeGift": "false",
"fulfillmentCenterId": "10001",
"fulfillmentCenterName": "Aurora",
"isExpedited": "false",
"language": "-1",
"lastName": "wcsadmin",
"lastUpdateDate": "2014-11-24T20:35:41.847Z",
"middleName": "",
"nickName": "wcsadmin",
"offerID": "13011",
"orderItemFulfillmentStatus": "Unreleased",
"orderItemId": "30021",
"orderItemInventoryStatus": "Available",
"orderItemPrice": "60.00000",
"orderItemStatus": "P",
"partNumber": "HTA029_292001",
"personTitle": "",
"phone1": "",
"phone1Publish": "true",
"phone2": "",
"phone2Publish": "true",
"postalCode": "",
"productId": "13011",
"quantity": "3.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": "",
"stateOrProvinceName": "",
"totalAdjustment": {
"currency": "USD",
"value": "0.00000"
},
"unitPrice": "20.00000",
"unitQuantity": "1.0",
"unitUom": "C62",
"usableShippingChargePolicy": [
{
"name": "StandardShippingChargeBySeller",
"type": "ShippingCharge",
"uniqueID": "-7001"
}
],
"xitem_field1": "1",
"xitem_field2": "2.0",
"xitem_isPersonalAddressesAllowedForShipping": "true",
"zipCode": ""
},
{
"UOM": "C62",
"addressId": "-1000",
"addressLine": [
"",
"",
""
],
"carrier": "XYZ Carrier",
"city": "",
"contractId": "10001",
"correlationGroup": "35016",
"country": "",
"createDate": "2014-11-06T20:13:42.317Z",
"currency": "USD",
"description": "US - Regular Delivery",
"email1": "",
"email2": "",
"expectedShipDate": "2014-11-24T20:35:44.098Z",
"fax1": "",
"fax2": "",
"firstName": "",
"freeGift": "false",
"fulfillmentCenterId": "10001",
"fulfillmentCenterName": "Aurora",
"isExpedited": "false",
"language": "-1",
"lastName": "wcsadmin",
"lastUpdateDate": "2014-11-24T20:35:41.847Z",
"middleName": "",
"nickName": "wcsadmin",
"offerID": "13011",
"orderItemFulfillmentStatus": "Unreleased",
"orderItemId": "35016",
"orderItemInventoryStatus": "Available",
"orderItemPrice": "60.00000",
"orderItemStatus": "P",
"partNumber": "HTA029_292001",
"personTitle": "",
"phone1": "",
"phone1Publish": "true",
"phone2": "",
"phone2Publish": "true",
"postalCode": "",
"productId": "13011",
"quantity": "3.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": "",
"stateOrProvinceName": "",
"totalAdjustment": {
"currency": "USD",
"value": "0.00000"
},
"unitPrice": "20.00000",
"unitQuantity": "1.0",
"unitUom": "C62",
"usableShippingChargePolicy": [
{
"name": "StandardShippingChargeBySeller",
"type": "ShippingCharge",
"uniqueID": "-7001"
}
],
"xitem_field1": "1",
"xitem_field2": "2.0",
"xitem_isPersonalAddressesAllowedForShipping": "true",
"zipCode": ""
},
{
"UOM": "C62",
"addressId": "-1000",
"addressLine": [
"",
"",
""
],
"carrier": "XYZ Carrier",
"city": "",
"contractId": "10001",
"correlationGroup": "35195",
"country": "",
"createDate": "2014-11-06T20:27:26.112Z",
"currency": "USD",
"description": "US - Regular Delivery",
"email1": "",
"email2": "",
"expectedShipDate": "2014-11-24T20:35:44.100Z",
"fax1": "",
"fax2": "",
"firstName": "",
"freeGift": "false",
"fulfillmentCenterId": "10001",
"fulfillmentCenterName": "Aurora",
"isExpedited": "false",
"language": "-1",
"lastName": "wcsadmin",
"lastUpdateDate": "2014-11-24T20:35:41.847Z",
"middleName": "",
"nickName": "wcsadmin",
"offerID": "13011",
"orderItemFulfillmentStatus": "Unreleased",
"orderItemId": "35195",
"orderItemInventoryStatus": "Available",
"orderItemPrice": "60.00000",
"orderItemStatus": "P",
"partNumber": "HTA029_292001",
"personTitle": "",
"phone1": "",
"phone1Publish": "true",
"phone2": "",
"phone2Publish": "true",
"postalCode": "",
"productId": "13011",
"quantity": "3.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": "",
"stateOrProvinceName": "",
"totalAdjustment": {
"currency": "USD",
"value": "0.00000"
},
"unitPrice": "20.00000",
"unitQuantity": "1.0",
"unitUom": "C62",
"usableShippingChargePolicy": [
{
"name": "StandardShippingChargeBySeller",
"type": "ShippingCharge",
"uniqueID": "-7001"
}
],
"xitem_field1": "1",
"xitem_field2": "2.0",
"xitem_isPersonalAddressesAllowedForShipping": "true",
"zipCode": ""
},
{
"UOM": "C62",
"addressId": "-1000",
"addressLine": [
"",
"",
""
],
"carrier": "XYZ Carrier",
"city": "",
"contractId": "10001",
"correlationGroup": "35374",
"country": "",
"createDate": "2014-11-10T16:35:48.600Z",
"currency": "USD",
"description": "US - Regular Delivery",
"email1": "",
"email2": "",
"expectedShipDate": "2014-11-24T20:35:44.101Z",
"fax1": "",
"fax2": "",
"firstName": "",
"freeGift": "false",
"fulfillmentCenterId": "10001",
"fulfillmentCenterName": "Aurora",
"isExpedited": "false",
"language": "-1",
"lastName": "wcsadmin",
"lastUpdateDate": "2014-11-24T20:35:41.847Z",
"middleName": "",
"nickName": "wcsadmin",
"offerID": "13011",
"orderItemFulfillmentStatus": "Unreleased",
"orderItemId": "35374",
"orderItemInventoryStatus": "Available",
"orderItemPrice": "60.00000",
"orderItemStatus": "P",
"partNumber": "HTA029_292001",
"personTitle": "",
"phone1": "",
"phone1Publish": "true",
"phone2": "",
"phone2Publish": "true",
"postalCode": "",
"productId": "13011",
"quantity": "3.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": "",
"stateOrProvinceName": "",
"totalAdjustment": {
"currency": "USD",
"value": "0.00000"
},
"unitPrice": "20.00000",
"unitQuantity": "1.0",
"unitUom": "C62",
"usableShippingChargePolicy": [
{
"name": "StandardShippingChargeBySeller",
"type": "ShippingCharge",
"uniqueID": "-7001"
}
],
"xitem_field1": "1",
"xitem_field2": "2.0",
"xitem_isPersonalAddressesAllowedForShipping": "true",
"zipCode": ""
},
{
"UOM": "C62",
"addressId": "-1000",
"addressLine": [
"",
"",
""
],
"carrier": "XYZ Carrier",
"city": "",
"contractId": "10001",
"correlationGroup": "40016",
"country": "",
"createDate": "2014-11-11T00:32:42.188Z",
"currency": "USD",
"description": "US - Regular Delivery",
"email1": "",
"email2": "",
"expectedShipDate": "2014-11-24T20:35:44.102Z",
"fax1": "",
"fax2": "",
"firstName": "",
"freeGift": "false",
"fulfillmentCenterId": "10001",
"fulfillmentCenterName": "Aurora",
"isExpedited": "false",
"language": "-1",
"lastName": "wcsadmin",
"lastUpdateDate": "2014-11-24T20:35:41.848Z",
"middleName": "",
"nickName": "wcsadmin",
"offerID": "13011",
"orderItemFulfillmentStatus": "Unreleased",
"orderItemId": "40016",
"orderItemInventoryStatus": "Available",
"orderItemPrice": "60.00000",
"orderItemStatus": "P",
"partNumber": "HTA029_292001",
"personTitle": "",
"phone1": "",
"phone1Publish": "true",
"phone2": "",
"phone2Publish": "true",
"postalCode": "",
"productId": "13011",
"quantity": "3.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": "",
"stateOrProvinceName": "",
"totalAdjustment": {
"currency": "USD",
"value": "0.00000"
},
"unitPrice": "20.00000",
"unitQuantity": "1.0",
"unitUom": "C62",
"usableShippingChargePolicy": [
{
"name": "StandardShippingChargeBySeller",
"type": "ShippingCharge",
"uniqueID": "-7001"
}
],
"xitem_field1": "1",
"xitem_field2": "2.0",
"xitem_isPersonalAddressesAllowedForShipping": "true",
"zipCode": ""
},
{
"UOM": "C62",
"addressId": "-1000",
"addressLine": [
"",
"",
""
],
"availableDate": "2014-11-24T20:35:42.069Z",
"carrier": "XYZ Carrier",
"city": "",
"contractId": "10001",
"correlationGroup": "45016",
"country": "",
"createDate": "2014-11-17T20:10:06.441Z",
"currency": "USD",
"description": "US - Regular Delivery",
"email1": "",
"email2": "",
"expectedShipDate": "2014-11-25T20:35:44.104Z",
"fax1": "",
"fax2": "",
"firstName": "",
"freeGift": "false",
"fulfillmentCenterId": "10001",
"fulfillmentCenterName": "Aurora",
"isExpedited": "false",
"language": "-1",
"lastName": "wcsadmin",
"lastUpdateDate": "2014-11-24T20:35:42.075Z",
"middleName": "",
"nickName": "wcsadmin",
"offerID": "13011",
"orderItemFulfillmentStatus": "Unreleased",
"orderItemId": "45016",
"orderItemInventoryStatus": "Allocated",
"orderItemPrice": "60.00000",
"orderItemStatus": "P",
"partNumber": "HTA029_292001",
"personTitle": "",
"phone1": "",
"phone1Publish": "true",
"phone2": "",
"phone2Publish": "true",
"postalCode": "",
"productId": "13011",
"quantity": "3.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": "",
"stateOrProvinceName": "",
"totalAdjustment": {
"currency": "USD",
"value": "0.00000"
},
"unitPrice": "20.00000",
"unitQuantity": "1.0",
"unitUom": "C62",
"usableShippingChargePolicy": [
{
"name": "StandardShippingChargeBySeller",
"type": "ShippingCharge",
"uniqueID": "-7001"
}
],
"xitem_field1": "1",
"xitem_field2": "2.0",
"xitem_isPersonalAddressesAllowedForShipping": "true",
"zipCode": ""
},
{
"UOM": "C62",
"addressId": "-1000",
"addressLine": [
"",
"",
""
],
"availableDate": "2014-11-24T20:35:42.101Z",
"carrier": "XYZ Carrier",
"city": "",
"contractId": "10001",
"correlationGroup": "50016",
"country": "",
"createDate": "2014-11-19T20:46:25.449Z",
"currency": "USD",
"description": "US - Regular Delivery",
"email1": "",
"email2": "",
"expectedShipDate": "2014-11-25T20:35:44.106Z",
"fax1": "",
"fax2": "",
"firstName": "",
"freeGift": "false",
"fulfillmentCenterId": "10001",
"fulfillmentCenterName": "Aurora",
"isExpedited": "false",
"language": "-1",
"lastName": "wcsadmin",
"lastUpdateDate": "2014-11-24T20:35:42.102Z",
"middleName": "",
"nickName": "wcsadmin",
"offerID": "13011",
"orderItemFulfillmentStatus": "Unreleased",
"orderItemId": "50016",
"orderItemInventoryStatus": "Allocated",
"orderItemPrice": "60.00000",
"orderItemStatus": "P",
"partNumber": "HTA029_292001",
"personTitle": "",
"phone1": "",
"phone1Publish": "true",
"phone2": "",
"phone2Publish": "true",
"postalCode": "",
"productId": "13011",
"quantity": "3.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": "",
"stateOrProvinceName": "",
"totalAdjustment": {
"currency": "USD",
"value": "0.00000"
},
"unitPrice": "20.00000",
"unitQuantity": "1.0",
"unitUom": "C62",
"usableShippingChargePolicy": [
{
"name": "StandardShippingChargeBySeller",
"type": "ShippingCharge",
"uniqueID": "-7001"
}
],
"xitem_field1": "1",
"xitem_field2": "2.0",
"xitem_isPersonalAddressesAllowedForShipping": "true",
"zipCode": ""
},
{
"UOM": "C62",
"addressId": "-1000",
"addressLine": [
"",
"",
""
],
"availableDate": "2014-11-24T20:35:42.120Z",
"carrier": "XYZ Carrier",
"city": "",
"contractId": "10001",
"correlationGroup": "75193",
"country": "",
"createDate": "2014-11-20T06:16:21.229Z",
"currency": "USD",
"description": "US - Regular Delivery",
"email1": "",
"email2": "",
"expectedShipDate": "2014-11-25T20:35:44.109Z",
"fax1": "",
"fax2": "",
"firstName": "",
"freeGift": "false",
"fulfillmentCenterId": "10001",
"fulfillmentCenterName": "Aurora",
"isExpedited": "false",
"language": "-1",
"lastName": "wcsadmin",
"lastUpdateDate": "2014-11-24T20:35:42.121Z",
"middleName": "",
"nickName": "wcsadmin",
"offerID": "13011",
"orderItemFulfillmentStatus": "Unreleased",
"orderItemId": "75193",
"orderItemInventoryStatus": "Allocated",
"orderItemPrice": "60.00000",
"orderItemStatus": "P",
"partNumber": "HTA029_292001",
"personTitle": "",
"phone1": "",
"phone1Publish": "true",
"phone2": "",
"phone2Publish": "true",
"postalCode": "",
"productId": "13011",
"quantity": "3.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": "",
"stateOrProvinceName": "",
"totalAdjustment": {
"currency": "USD",
"value": "0.00000"
},
"unitPrice": "20.00000",
"unitQuantity": "1.0",
"unitUom": "C62",
"usableShippingChargePolicy": [
{
"name": "StandardShippingChargeBySeller",
"type": "ShippingCharge",
"uniqueID": "-7001"
}
],
"xitem_field1": "1",
"xitem_field2": "2.0",
"xitem_isPersonalAddressesAllowedForShipping": "true",
"zipCode": ""
},
{
"UOM": "C62",
"addressId": "-1000",
"addressLine": [
"",
"",
""
],
"availableDate": "2014-11-24T20:35:42.141Z",
"carrier": "XYZ Carrier",
"city": "",
"contractId": "10001",
"correlationGroup": "80053",
"country": "",
"createDate": "2014-11-20T08:22:50.535Z",
"currency": "USD",
"description": "US - Regular Delivery",
"email1": "",
"email2": "",
"expectedShipDate": "2014-11-25T20:35:44.115Z",
"fax1": "",
"fax2": "",
"firstName": "",
"freeGift": "false",
"fulfillmentCenterId": "10001",
"fulfillmentCenterName": "Aurora",
"isExpedited": "false",
"language": "-1",
"lastName": "wcsadmin",
"lastUpdateDate": "2014-11-24T20:35:42.141Z",
"middleName": "",
"nickName": "wcsadmin",
"offerID": "13011",
"orderItemFulfillmentStatus": "Unreleased",
"orderItemId": "80053",
"orderItemInventoryStatus": "Allocated",
"orderItemPrice": "60.00000",
"orderItemStatus": "P",
"partNumber": "HTA029_292001",
"personTitle": "",
"phone1": "",
"phone1Publish": "true",
"phone2": "",
"phone2Publish": "true",
"postalCode": "",
"productId": "13011",
"quantity": "3.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": "",
"stateOrProvinceName": "",
"totalAdjustment": {
"currency": "USD",
"value": "0.00000"
},
"unitPrice": "20.00000",
"unitQuantity": "1.0",
"unitUom": "C62",
"usableShippingChargePolicy": [
{
"name": "StandardShippingChargeBySeller",
"type": "ShippingCharge",
"uniqueID": "-7001"
}
],
"xitem_field1": "1",
"xitem_field2": "2.0",
"xitem_isPersonalAddressesAllowedForShipping": "true",
"zipCode": ""
},
{
"UOM": "C62",
"addressId": "-1000",
"addressLine": [
"",
"",
""
],
"availableDate": "2014-11-24T20:35:42.164Z",
"carrier": "XYZ Carrier",
"city": "",
"contractId": "10001",
"correlationGroup": "85053",
"country": "",
"createDate": "2014-11-24T16:22:46.067Z",
"currency": "USD",
"description": "US - Regular Delivery",
"email1": "",
"email2": "",
"expectedShipDate": "2014-11-25T20:35:44.117Z",
"fax1": "",
"fax2": "",
"firstName": "",
"freeGift": "false",
"fulfillmentCenterId": "10001",
"fulfillmentCenterName": "Aurora",
"isExpedited": "false",
"language": "-1",
"lastName": "wcsadmin",
"lastUpdateDate": "2014-11-24T20:35:42.164Z",
"middleName": "",
"nickName": "wcsadmin",
"offerID": "13011",
"orderItemFulfillmentStatus": "Unreleased",
"orderItemId": "85053",
"orderItemInventoryStatus": "Allocated",
"orderItemPrice": "60.00000",
"orderItemStatus": "P",
"partNumber": "HTA029_292001",
"personTitle": "",
"phone1": "",
"phone1Publish": "true",
"phone2": "",
"phone2Publish": "true",
"postalCode": "",
"productId": "13011",
"quantity": "3.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": "",
"stateOrProvinceName": "",
"totalAdjustment": {
"currency": "USD",
"value": "0.00000"
},
"unitPrice": "20.00000",
"unitQuantity": "1.0",
"unitUom": "C62",
"usableShippingChargePolicy": [
{
"name": "StandardShippingChargeBySeller",
"type": "ShippingCharge",
"uniqueID": "-7001"
}
],
"xitem_field1": "1",
"xitem_field2": "2.0",
"xitem_isPersonalAddressesAllowedForShipping": "true",
"zipCode": ""
}
],
"orderStatus": "P",
"orgDistinguishedName": "o=root organization",
"orgUniqueID": "-2001",
"prepareIndicator": "false",
"recordSetComplete": "true",
"recordSetCount": "10",
"recordSetStartNumber": "0",
"recordSetTotal": "10",
"resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/cart\/@self?pageSize=50&pageNumber=1&responseFormat=json",
"resourceName": "cart",
"shipAsComplete": "true",
"storeNameIdentifier": "Aurora",
"storeUniqueID": "10001",
"totalAdjustment": "0.00000",
"totalAdjustmentCurrency": "USD",
"totalProductPrice": "600.00000",
"totalProductPriceCurrency": "USD",
"totalSalesTax": "0.00000",
"totalSalesTaxCurrency": "USD",
"totalShippingCharge": "0.00000",
"totalShippingChargeCurrency": "USD",
"totalShippingTax": "0.00000",
"totalShippingTaxCurrency": "USD",
"x_isPersonalAddressesAllowedForShipping": "true",
"x_isPurchaseOrderNumberRequired": "false",
"x_trackingIds": ""
}
Gets buyer purchase order information for buyer purchase order ID.
getBuyerPurchaseOrderDataBean
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| buyerPurchaseOrderId | The buyer purchase order identifier. | path | string | true | N/A |
| profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 404 | The specified resource couldn't be found. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.payment.beans.BuyerPurchaseOrderDataBean_IBM_BuyerPurchaseOrder_Summary
Gets payment attribute order information for terms & conditions Id.
getPAttributeDataBean
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| initKey_referenceNumber | The referenceNumber key of the access bean | path | string | true | N/A |
| profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 404 | The specified resource couldn't be found. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.utf.beans.PAttributeDataBean_IBM_PAttribute_Detailed
Gets payment policy list information for store.
getPaymentPolicyListDataBean
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 404 | The specified resource couldn't be found. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.payment.beans.PaymentPolicyListDataBean_IBM_PaymentPolicyList_Detailed
GET /wcs/resources/store/10001/cart/@self/payment_policy_list?responseFormat=json
200
{
"resultList": [
{
"message": "",
"paymentPolicyInfoUsableWithoutTA": [
{
"attrPageName": "StandardDiscover",
"longDescription": "Discover Credit Card",
"policyId": "10009",
"policyName": "Discover",
"policyType": "Payment",
"shortDescription": "Discover Credit Card"
},
{
"attrPageName": "StandardCOD",
"longDescription": "Customer will pay cash on delivery",
"policyId": "10007",
"policyName": "COD",
"policyType": "Payment",
"shortDescription": "Cash on delivery"
},
{
"attrPageName": "StandardBillMeLater",
"longDescription": "Bill customer later",
"policyId": "10006",
"policyName": "BillMeLater",
"policyType": "Payment",
"shortDescription": "Bill me later"
},
{
"attrPageName": "StandardMasterCard",
"longDescription": "MasterCard Credit Card",
"policyId": "10003",
"policyName": "Master Card",
"policyType": "Payment",
"shortDescription": "MasterCard Credit Card"
},
{
"attrPageName": "StandardPayLater",
"longDescription": "Customer will pay later",
"policyId": "10008",
"policyName": "PayLater",
"policyType": "Payment",
"shortDescription": "Pay later"
},
{
"attrPageName": "StandardVisa",
"longDescription": "VISA Credit Card",
"policyId": "10002",
"policyName": "VISA",
"policyType": "Payment",
"shortDescription": "VISA Credit Card"
},
{
"attrPageName": "StandardCheck",
"longDescription": "Payment by Check",
"policyId": "10004",
"policyName": "Check",
"policyType": "Payment",
"shortDescription": "Check"
},
{
"attrPageName": "StandardAmex",
"longDescription": "American Express Credit Card",
"policyId": "10005",
"policyName": "AMEX",
"policyType": "Payment",
"shortDescription": "American Express Credit Card"
},
{
"attrPageName": "StandardCOD",
"longDescription": "Pay In Store",
"policyId": "-10021",
"policyName": "PayInStore",
"policyType": "Payment",
"shortDescription": "Pay In Store"
},
{
"attrPageName": "SimplePunchout",
"longDescription": "Simple Punchout",
"policyId": "10010",
"policyName": "SimplePunchout",
"policyType": "Payment",
"shortDescription": "Simple Punchout"
}
],
"primaryRC": -1,
"secondaryRC": -1
}
]
}
Gets usable billing address information for order id.
getUsableBillingAddressListTCDataBean
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| orderId | The order ID. | path | string | true | N/A |
| profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
| paymentTCId | The payment Term & Condition identifier for this payment instruction. | query | string | false | false |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 404 | The specified resource couldn't be found. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary
Gets usable payment information for the shopping cart.
getUsablePaymentInfo
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | integer | false | false |
| pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | integer | false | false |
| orderId | The order ID. | query | string | false | false |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 404 | The specified resource couldn't be found. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10001/cart/@self/usable_payment_info?orderId=&responseFormat=json
200
{
"orderId": "25207",
"resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/cart\/@self\/usable_payment_info?orderId=&responseFormat=json",
"resourceName": "cart",
"usablePaymentInformation": [
{
"description": "Discover Credit Card",
"language": "-1",
"paymentMethodName": "Discover",
"paymentTermConditionId": "",
"usableBillingAddress": [
{
"addressId": "15810",
"nickName": "Default_Billing_10001"
},
{
"addressId": "15308",
"nickName": "jane"
},
{
"addressId": "15309",
"nickName": "john"
}
],
"xumet_attrPageName": "StandardDiscover",
"xumet_policyId": "10009"
},
{
"description": "Cash on delivery",
"language": "-1",
"paymentMethodName": "COD",
"paymentTermConditionId": "",
"usableBillingAddress": [
{
"addressId": "15810",
"nickName": "Default_Billing_10001"
},
{
"addressId": "15308",
"nickName": "jane"
},
{
"addressId": "15309",
"nickName": "john"
}
],
"xumet_attrPageName": "StandardCOD",
"xumet_policyId": "10007"
},
{
"description": "Bill me later",
"language": "-1",
"paymentMethodName": "BillMeLater",
"paymentTermConditionId": "",
"usableBillingAddress": [
{
"addressId": "15810",
"nickName": "Default_Billing_10001"
},
{
"addressId": "15308",
"nickName": "jane"
},
{
"addressId": "15309",
"nickName": "john"
}
],
"xumet_attrPageName": "StandardBillMeLater",
"xumet_policyId": "10006"
},
{
"description": "MasterCard Credit Card",
"language": "-1",
"paymentMethodName": "Master Card",
"paymentTermConditionId": "",
"usableBillingAddress": [
{
"addressId": "15810",
"nickName": "Default_Billing_10001"
},
{
"addressId": "15308",
"nickName": "jane"
},
{
"addressId": "15309",
"nickName": "john"
}
],
"xumet_attrPageName": "StandardMasterCard",
"xumet_policyId": "10003"
},
{
"description": "Pay later",
"language": "-1",
"paymentMethodName": "PayLater",
"paymentTermConditionId": "",
"usableBillingAddress": [
{
"addressId": "15810",
"nickName": "Default_Billing_10001"
},
{
"addressId": "15308",
"nickName": "jane"
},
{
"addressId": "15309",
"nickName": "john"
}
],
"xumet_attrPageName": "StandardPayLater",
"xumet_policyId": "10008"
},
{
"description": "VISA Credit Card",
"language": "-1",
"paymentMethodName": "VISA",
"paymentTermConditionId": "",
"usableBillingAddress": [
{
"addressId": "15810",
"nickName": "Default_Billing_10001"
},
{
"addressId": "15308",
"nickName": "jane"
},
{
"addressId": "15309",
"nickName": "john"
}
],
"xumet_attrPageName": "StandardVisa",
"xumet_policyId": "10002"
},
{
"description": "Check",
"language": "-1",
"paymentMethodName": "Check",
"paymentTermConditionId": "",
"usableBillingAddress": [
{
"addressId": "15810",
"nickName": "Default_Billing_10001"
},
{
"addressId": "15308",
"nickName": "jane"
},
{
"addressId": "15309",
"nickName": "john"
}
],
"xumet_attrPageName": "StandardCheck",
"xumet_policyId": "10004"
},
{
"description": "American Express Credit Card",
"language": "-1",
"paymentMethodName": "AMEX",
"paymentTermConditionId": "",
"usableBillingAddress": [
{
"addressId": "15810",
"nickName": "Default_Billing_10001"
},
{
"addressId": "15308",
"nickName": "jane"
},
{
"addressId": "15309",
"nickName": "john"
}
],
"xumet_attrPageName": "StandardAmex",
"xumet_policyId": "10005"
},
{
"description": "Simple Punchout",
"language": "-1",
"paymentMethodName": "SimplePunchout",
"paymentTermConditionId": "",
"usableBillingAddress": [
{
"addressId": "15810",
"nickName": "Default_Billing_10001"
},
{
"addressId": "15308",
"nickName": "jane"
},
{
"addressId": "15309",
"nickName": "john"
}
],
"xumet_attrPageName": "SimplePunchout",
"xumet_policyId": "10010"
}
]
}
Gets usable shipping information for the shopping cart.
getUsableShippingInfo
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | integer | false | false |
| pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | integer | false | false |
| orderId | The order ID. | query | string | false | false |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 404 | The specified resource couldn't be found. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
GET /wcs/resources/store/10001/cart/@self/usable_shipping_info?pageSize=1&pageNumber=1&orderId=25207&responseFormat=json
200
{
"orderId": "25207",
"orderItem": [
{
"orderItemId": "85206",
"usableShippingAddress": [
{
"addressId": "15308",
"nickName": "jane"
},
{
"addressId": "15309",
"nickName": "john"
}
],
"usableShippingChargePolicy": [
{
"name": "StandardShippingChargeBySeller",
"type": "ShippingCharge",
"uniqueID": "-7001"
}
],
"usableShippingMode": [
{
"carrier": "International Carrier",
"description": "International Priority",
"language": "-1",
"shipModeCode": "International Priority",
"shipModeId": "10054"
},
{
"carrier": "International Carrier",
"description": "International Regular",
"language": "-1",
"shipModeCode": "International Regular",
"shipModeId": "10055"
},
{
"description": "Pickup in store",
"language": "-1",
"shipModeCode": "PickupInStore",
"shipModeId": "10001"
},
{
"carrier": "XYZ Carrier",
"description": "US - 2-Day Express Delivery",
"language": "-1",
"shipModeCode": "US - 2-Day Express Delivery",
"shipModeId": "10053"
},
{
"carrier": "XYZ Carrier",
"description": "US - Overnight Delivery",
"language": "-1",
"shipModeCode": "US - Overnight Delivery",
"shipModeId": "10052"
},
{
"carrier": "XYZ Carrier",
"description": "US - Regular Delivery",
"language": "-1",
"shipModeCode": "US Regular Delivery",
"shipModeId": "10051"
}
]
}
],
"resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/cart\/@self\/usable_shipping_info?pageSize=1&pageNumber=1&orderId=25207&responseFormat=json",
"resourceName": "cart",
"usableShippingAddress": [
{
"addressId": "15308",
"nickName": "jane"
},
{
"addressId": "15309",
"nickName": "john"
}
]
}
Gets allowable shipping information for the store. Deprecated. Use the method that adds support for the locale parameter.
getAllowableShippingModes
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 404 | The specified resource couldn't be found. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$ShippingModes
GET /wcs/resources/store/10001/cart/shipping_modes?responseFormat=json&langId=-1
200
{
"usableShippingMode": [
{
"field1": null,
"field2": "1 to 3 business days",
"shipModeCode": "International Priority",
"shipModeDescription": "International Priority",
"shipModeId": "10054"
},
{
"field1": null,
"field2": "7 to 14 business days",
"shipModeCode": "International Regular",
"shipModeDescription": "International Regular",
"shipModeId": "10055"
},
{
"field1": null,
"field2": null,
"shipModeCode": "PickupInStore",
"shipModeDescription": "Pickup in store",
"shipModeId": "10001"
},
{
"field1": null,
"field2": "2 business days",
"shipModeCode": "US - 2-Day Express Delivery",
"shipModeDescription": "US - 2-Day Express Delivery",
"shipModeId": "10053"
},
{
"field1": null,
"field2": "1 business day",
"shipModeCode": "US - Overnight Delivery",
"shipModeDescription": "US - Overnight Delivery",
"shipModeId": "10052"
},
{
"field1": null,
"field2": "5 to 10 business days",
"shipModeCode": "US Regular Delivery",
"shipModeDescription": "US - Regular Delivery",
"shipModeId": "10051"
}
]
}
Gets allowable shipping information for the store.
getAllowableShippingModes
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 404 | The specified resource couldn't be found. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$ShippingModes
GET /wcs/resources/store/10001/cart/shipping_modes?responseFormat=json&langId=-1
200
{
"usableShippingMode": [
{
"field1": null,
"field2": "1 to 3 business days",
"shipModeCode": "International Priority",
"shipModeDescription": "International Priority",
"shipModeId": "10054"
},
{
"field1": null,
"field2": "7 to 14 business days",
"shipModeCode": "International Regular",
"shipModeDescription": "International Regular",
"shipModeId": "10055"
},
{
"field1": null,
"field2": null,
"shipModeCode": "PickupInStore",
"shipModeDescription": "Pickup in store",
"shipModeId": "10001"
},
{
"field1": null,
"field2": "2 business days",
"shipModeCode": "US - 2-Day Express Delivery",
"shipModeDescription": "US - 2-Day Express Delivery",
"shipModeId": "10053"
},
{
"field1": null,
"field2": "1 business day",
"shipModeCode": "US - Overnight Delivery",
"shipModeDescription": "US - Overnight Delivery",
"shipModeId": "10052"
},
{
"field1": null,
"field2": "5 to 10 business days",
"shipModeCode": "US Regular Delivery",
"shipModeDescription": "US - Regular Delivery",
"shipModeId": "10051"
}
]
}
Adds one or more order items to the shopping cart.
addOrderItem
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | The request object for AddOrderItem. | body | com.ibm.commerce.rest.order.handler.CartHandler$AddOrderItemBodyDescription | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 201 | The requested resource has been created. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$OrderWithOrderItemContainer
POST /wcs/resources/store/10001/cart?responseFormat=json
{
"orderId": ".",
"orderItem": [
{
"productId": "10706",
"quantity": "1"
}
],
"x_calculateOrder": "0",
"x_inventoryValidation": "true"
}
201
{
"orderId": "25207",
"orderItem": [
{
"orderItemId": "85206"
}
]
}
Locks the shopping cart by a CSR.
lockCart
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| cartId | Order identifier. | path | string | true | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer
POST /wcs/resources/store/10001/cart/25012/lock
200
{
"orderId": "25012"
}
Locks the shopping cart when the buyer administrator/CSR has established a session to act on behalf of a user.
lockCartOnBehalf
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| cartId | Order identifier. | path | string | true | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer
Unlocks the shopping cart by a CSR.
unlockCart
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| cartId | Order identifier. | path | string | true | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer
Unlocks the shopping cart when the buyer administrator/CSR has established a session to act on behalf of a user.
unlockCartOnBehalf
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| cartId | Order identifier. | path | string | true | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer
Calculate the cost of the order.
calculateOrder
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| orderId | The order ID. | path | string | true | N/A |
| body | The request object for calculate order. | body | com.ibm.commerce.rest.order.handler.CartHandler$CalculateOrderRequest | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
Creates a scheduled order which is related to a scheduled job.
scheduleOrder
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | The request object for scheduleOrder. | body | com.ibm.commerce.rest.order.handler.CartHandler$OrderScheduleRequest | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$OrderScheduleRequest
Set the specified order as the current pending order.
setPendingOrder
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| orderId | The order ID. | path | string | true | N/A |
| body | The request object for SetPendingOrder. | body | com.ibm.commerce.rest.order.handler.CartHandler$SetPendingOrderRequest | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$SetPendingOrderRequest
POST /wcs/resources/store/10801/cart/25039/set_pending_order
200
{
"orderId": [
"25039"
],
"viewTaskName": "RedirectView"
}
Adds a dynamic kit configuration to cart.
addConfigurationToCart
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | The request body for adding a dynamic kit configuration to cart. | body | com.ibm.commerce.rest.order.handler.CartHandler$AddConfigurationToCartRequest | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$AddConfigurationToCartRequest
Adds a dynamic kit pre-configuration to cart.
addPreConfigurationToCart
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | The request body for adding a dynamic kit configuration to cart. | body | com.ibm.commerce.rest.order.handler.CartHandler$AddPreConfigurationToCartRequest | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$AddPreConfigurationToCartRequest
Checks out the shopping cart.
checkOut
true
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | The request object for checkout. | body | com.ibm.commerce.rest.order.handler.CartHandler$CheckoutRequest | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer
POST /wcs/resources/store/10001/cart/@self/checkout?responseFormat=json
{
"catalogId": "10052",
"langId": "-1",
"notifyMerchant": "1",
"notifyOrderSubmitted": "1",
"notifyShopper": "1",
"notify_EMailSender_recipient": "john@example.com",
"orderId": "25206",
"purchaseorder_id": "",
"storeId": "10001"
}
201
{
"orderId": "25206"
}
Calculate the cost of the order.
calculateOrder
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | body data required for rest method | body | com.ibm.commerce.rest.order.handler.CartHandler$CalculateOrderRequest | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
POST /wcs/resources/store/10001/cart/calculate?responseFormat=json
{
"URL": [
"http:\/\/localhost\/webapp\/wcs\/stores\/servlet\/en\/aurora?calculationUsageId=-1"
],
"calculationUsageId": [
"-2"
],
"continue": [
"1"
],
"createIfEmpty": [
"1"
],
"deleteCartCookie": [
"true"
],
"deleteIfEmpty": [
"*"
],
"fromOrderId": [
"*"
],
"orderId": [
"14029",
"14029"
],
"page": [
""
],
"toOrderId": [
"."
],
"updatePrices": [
"0"
]
}
200
{
"orderId": [
"14029"
],
"viewTaskName": "RedirectView"
}
Copies a specified order.
copyOrder
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | The request object for copy order. | body | com.ibm.commerce.rest.order.handler.CartHandler$CopyOrderRequest | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$CopyOrderRequest
POST /wcs/resources/store/10801/cart/copy_order
{
"URL": "https:\/\/localhost\/wcs\/resources\/store\/10801\/cart\/copy_order",
"copyOrderItemId": "*",
"description": "",
"fromOrderId": "-13579",
"requesttype": "ajax",
"toOrderId": "**"
}
200
{
"orderId": [
"25040"
],
"viewTaskName": "RedirectView"
}
create an order with the description specified
createOrder
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| description | the description for the order | query | string | true | false |
| body | body data required for rest method | body | com.ibm.commerce.rest.order.handler.CartHandler$CreateOrderRequest | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
POST /wcs/resources/store/10801/cart/create_order?responseFormat=json&langId=-1&description=%24%26%5B%7B%7D%28%3D*%29%2B%5D%21%23%7E%25%601800%25+Flowers%27%22%3B
200
{
"outOrderId": "25041",
"redirecturl": "",
"viewTaskName": "RedirectView"
}
Updates one or more order items in the shopping cart. This method is deprecated, use updateOrderItem.
udpateOrderItem
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | Update order item body. | body | cart-cartUpdate | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
PUT /wcs/resources/store/10001/cart/@self
{
"orderItem": [
{
"orderItemId": "85043",
"quantity": "3.0",
"xitem_field1": "3",
"xitem_field2": "4.0"
}
]
}
200
{
"orderId": "25032",
"orderItem": [
{
"orderItemId": "85043"
}
]
}
Applies the quick checkout profile to the current shopping cart.
applyCheckoutProfile
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | Request body required for apply checkout profile. | body | com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer
Deletes the specified order item from the order.
deleteOrderItem
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | The request body for deleting an order item. | body | com.ibm.commerce.rest.order.handler.CartHandler$DeleteOrderItemRequest | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer
Prepares the shopping cart for checkout. This method must be called before the checkout service.
preCheckout
true
false
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | The request object for preCheckout. | body | com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer
PUT /wcs/resources/store/10001/cart/@self/precheckout?responseFormat=json
{
"catalogId": "10052",
"langId": "-1",
"storeId": "10001"
}
200
{
"orderId": "25206"
}
Update a dynamic kit configuration in the cart.
updateConfigurationInCart
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | The request body for updating a dynamic kit configuration in the cart. | body | com.ibm.commerce.rest.order.handler.CartHandler$UpdateConfigurationInCartRequest | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$UpdateConfigurationInCartRequest
Updates one or more order items in the shopping cart.
updateOrderItem
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | Update order item body. | body | com.ibm.commerce.rest.order.handler.CartHandler$UpdateOrderItemBodyDescription | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$OrderWithOrderItemContainer
PUT /wcs/resources/store/10001/cart/@self/update_order_item?responseFormat=json
{
"orderId": "25207",
"orderItem": [
{
"orderItemId": ""
}
],
"x_calculateOrder": "1",
"x_calculationUsage": "-1,-2,-5,-6,-7"
}
200
{
"orderId": "25207"
}
Updates the reward option.
updateRewardOption
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | The request body for updating a reward option. | body | com.ibm.commerce.rest.order.handler.CartHandler$RewardChoiceUpdateRequest | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$RewardChoiceUpdateRequest
Moves order items from one order to another.
moveOrderItem
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| body | The request body for MoveOrderItem. | body | com.ibm.commerce.rest.order.handler.CartHandler$OrderItemMoveRequest | false | N/A |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.order.handler.CartHandler$OrderItemMoveRequest
PUT /wcs/resources/store/10001/cart/move_order_item?responseFormat=json
{
"URL": [
"RESTOrderCalculate?URL=http:\/\/localhost\/webapp\/wcs\/stores\/servlet\/en\/aurora?calculationUsageId=-1&calculationUsageId=-2&deleteCartCookie=true"
],
"calculationUsageId": [
"-1",
"-2",
"-7"
],
"continue": [
"1"
],
"createIfEmpty": [
"1"
],
"deleteIfEmpty": [
"*"
],
"fromOrderId": [
"*"
],
"page": [
""
],
"toOrderId": [
"."
],
"updatePrices": [
"0"
]
}
200
{
"orderId": [
"14029",
"14029"
],
"redirecturl": "RESTOrderCalculate?URL=http:\/\/localhost\/webapp\/wcs\/stores\/servlet\/en\/aurora?calculationUsageId=-1&calculationUsageId=-2&deleteCartCookie=true",
"viewTaskName": "RedirectView"
}
Cancel the specified order.
cancelOrder
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| orderId | The order ID. | path | string | true | N/A |
| forcedCancel | This parameter is used to cancel an order that has deposited payment | query | string | false | false |
| HTTP Status Code | Description |
|---|---|
| 200 | The requested completed successfully. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
DELETE /wcs/resources/store/10801/cart/25036/cancel_order
200
{
"viewTaskName": "RedirectView"
}
Deletes all items in the shopping cart.
cancelOrderInCart
false
true
| Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
|---|---|---|---|---|---|
| storeId | The store identifier. | path | string | true | N/A |
| HTTP Status Code | Description |
|---|---|
| 204 | The requested completed successfully. No content is returned in the response. |
| 400 | Bad request. Some of the inputs provided to the request aren't valid. |
| 401 | Not authenticated. The user session isn't valid. |
| 403 | The user isn't authorized to perform the specified request. |
| 500 | Internal server error. Additional details will be contained on the server logs. |
| Name | Data Type | Required |
|---|---|---|
| currency | string | false |
| usage | string | false |
| displayLevel | string | false |
| descriptionLanguage | string | false |
| userDataField | cart-Adjustment.userDataField array | false |
| amount | string | false |
| language | string | false |
| description | string | false |
| code | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| middleName | string | false |
| lastName | string | false |
| organizationUnitName | string | false |
| primary | string | false |
| personTitle | string | false |
| phone1 | string | true |
| phone2 | string | true |
| mobilePhone1 | string | true |
| addressLine | string array | false |
| billing_address_id | string | false |
| phone1Publish | string | false |
| nickName | string | true |
| addressType | string | false |
| stateOrProvinceName | string | false |
| mobilePhone1Country | string | true |
| state | string | false |
| email1 | string | true |
| email2 | string | true |
| country | string | false |
| attributes | cart-BillingAddress.attributes array | false |
| language | string | false |
| postalCode | string | false |
| firstName | string | false |
| internalOfficeAddress | string | false |
| phone1Type | string | false |
| organizationName | string | false |
| phone2Type | string | false |
| personIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType | false |
| phone2Publish | string | false |
| city | string | false |
| bestCallingTime | string | false |
| zipCode | string | false |
| fax1 | string | true |
| fax2 | string | true |
| geographicalTaxCode | string | false |
| businessTitle | string | false |
| organizationIdentifier | com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType | false |
| geographicalShippingCode | string | false |
| Name | Data Type | Required |
|---|---|---|
| attrValue | string | false |
| attrKey | string | true |
| Name | Data Type | Required |
|---|---|---|
| Order | cart-cart_item array | false |
| Name | Data Type | Required |
|---|---|---|
| orderItem | cart-cartItem array | false |
| channel | com.ibm.commerce.order.facade.datatypes.ChannelType | false |
| rewardOption | cart-rewardOption array | false |
| quoteIdentifier | com.ibm.commerce.foundation.common.datatypes.QuoteIdentifierType | false |
| orderAmount | string | false |
| orderId | string | false |
| placedDate | string | false |
| lastUpdateDate | string | false |
| orderDescription | string | false |
| storeNameIdentifier | string | false |
| financialTransaction | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType array | false |
| cSRComments | com.ibm.commerce.order.facade.datatypes.CSRCommentsType array | false |
| adjustmentRequirement | com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType array | false |
| quoteID | string | false |
| orderIdentifier | string | false |
| paymentStatus | string | false |
| buyerPONumber | string | false |
| orderEditor | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType | false |
| orderStatus | string | false |
| userDataField | cart-cart_item.userDataField array | false |
| shipAsComplete | string | false |
| paymentInstruction | cart-PaymentInstruction array | false |
| orderVersion | string | false |
| orgDistinguishedName | string | false |
| storeOwnerID | string | false |
| storeUniqueID | string | false |
| buyerId | string | false |
| orgUniqueID | string | false |
| promotionCode | cart-cart_item.promotionCode array | false |
| couponCode | cart-CouponCode array | false |
| comments | string | false |
| parentInfo | com.ibm.commerce.order.facade.datatypes.ParentInfoType | false |
| bLockInfo | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType | false |
| buyerDistinguishedName | string | false |
| Name | Data Type | Required |
|---|---|---|
| code | string | false |
| associatedPromotion | cart-cart_item.promotionCode.associatedPromotion array | false |
| Name | Data Type | Required |
|---|---|---|
| description | string | false |
| promotionId | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| timeShipped | string | false |
| createDate | string | false |
| itemAttributes | cart-cartItem.itemAttributes array | false |
| quantity | string | false |
| lastUpdateDate | string | false |
| contractId | string | false |
| ownerID | string | false |
| fulfillmentCenterId | string | false |
| externalOrderItemID | string | false |
| configurationID | string | false |
| orderItemStatus | string | false |
| adjustmentRequirement | com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType array | false |
| availableDate | string | false |
| fulfillmentCenterOwnerId | string | false |
| partNumber | string | true |
| orderItemShippingInfo | string | false |
| correlationGroup | string | false |
| expectedShipDate | string | false |
| userDataField | cart-cartItem.userDataField array | false |
| fulfillmentCenterDescription | com.ibm.commerce.foundation.common.datatypes.DescriptionType | false |
| storeIdentifier | com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType | false |
| productId | string | false |
| timeReleased | string | false |
| usableShippingChargePolicy | cart-UsableShippingChargePolicy array | false |
| orderItemInventoryStatus | string | false |
| orderItemFulfillmentStatus | string | false |
| UOM | string | false |
| comments | string | false |
| offerID | string | false |
| orderItemAmount | string | false |
| orderItemId | string | false |
| orderItemComponent | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType array | false |
| fulfillmentCenterName | string | false |
| Name | Data Type | Required |
|---|---|---|
| attrValue | string | false |
| attrName | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| Order | cart-cartUpdate_item array | false |
| Name | Data Type | Required |
|---|---|---|
| orderItem | cart-cartUpdate_item.orderItem array | false |
| userDataField | cart-cartUpdate_item.userDataField array | false |
| orderId | string | false |
| Name | Data Type | Required |
|---|---|---|
| UOM | string | false |
| userDataField | cart-cartUpdate_item.orderItem.userDataField array | false |
| productId | string | false |
| itemAttributes | cart-cartUpdate_item.orderItem.itemAttributes array | false |
| quantity | string | false |
| partNumber | string | true |
| orderItemId | string | false |
| contractId | string | false |
| fulfillmentCenterId | string | false |
| fulfillmentCenterName | string | false |
| comment | string | false |
| Name | Data Type | Required |
|---|---|---|
| attrValue | string | false |
| attrName | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| couponId | string | false |
| effectiveDateTime | string | false |
| status | string | false |
| promotion | com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType | false |
| userDataField | cart-CouponCode.userDataField array | false |
| expirationDateTime | string | false |
| description | com.ibm.commerce.order.facade.datatypes.CouponDescriptionType array | false |
| code | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| totalAdjustmentCurrency | string | false |
| totalSalesTax | string | false |
| userDataField | cart-OrderAmount.userDataField array | false |
| totalShippingCharge | string | false |
| grandTotalCurrency | string | false |
| totalShippingTaxCurrency | string | false |
| totalTaxByTaxCategory | cart-OrderAmount.totalTaxByTaxCategory array | false |
| genericTotal | com.ibm.commerce.foundation.common.datatypes.GenericTotalType array | false |
| adjustment | cart-Adjustment array | false |
| totalProductPriceCurrency | string | false |
| totalAdjustment | string | false |
| totalSalesTaxCurrency | string | false |
| totalShippingChargeCurrency | string | false |
| grandTotal | string | false |
| totalShippingTax | string | false |
| totalProductPrice | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| currency | string | false |
| taxCategoryCode | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| customerOrderNumber | string | false |
| orderId | string | false |
| externalOrderID | string | false |
| Name | Data Type | Required |
|---|---|---|
| shippingCharge | string | false |
| userDataField | cart-OrderItemAmount.userDataField array | false |
| unitPrice | string | false |
| taxByTaxCategory | com.ibm.commerce.foundation.common.datatypes.TaxByTaxCategoryType array | false |
| orderItemPrice | string | false |
| alternativeCurrencyPrice | com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType array | false |
| genericTotal | com.ibm.commerce.foundation.common.datatypes.GenericTotalType array | false |
| adjustment | cart-Adjustment array | false |
| shippingTaxCurrency | string | false |
| unitQuantity | string | false |
| unitUom | string | false |
| salesTaxCurrency | string | false |
| currency | string | false |
| totalAdjustment | com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType | false |
| shippingChargeCurrency | string | false |
| priceOverride | string | false |
| freeGift | string | false |
| shippingTax | string | false |
| salesTax | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| shipTieCode | string | false |
| userDataField | cart-OrderItemShippingInfo.userDataField array | false |
| physicalStoreId | string | false |
| shippingAddress | string | false |
| shippingCarrierAccountNumber | string | false |
| shippingChargePolicyID | string | false |
| physicalStoreExternalId | string | false |
| shippingMode | string | false |
| shipInstruction | string | false |
| requestedShipDate | string | false |
| shipCarrAccntNum | string | false |
| shippingChargeType | string | true |
| isExpedited | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| orderStatus | string | false |
| xstat_ | java.util.Map$Entry array | false |
| editable | string | false |
| prepareIndicator | string | false |
| buyerApprovalStatus | string | false |
| locked | string | false |
| blocked | string | false |
| Name | Data Type | Required |
|---|---|---|
| protocolData | cart-PaymentInstruction.protocolData array | false |
| paymentRule | string | false |
| piDescription | string | false |
| payMethodId | string | false |
| paymentTermConditionId | string | false |
| priority | string | false |
| userDataField | cart-PaymentInstruction.userDataField array | false |
| minAmount | com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType | false |
| piCurrency | string | false |
| sequenceNumber | string | false |
| piStatus | string | false |
| refundAllowed | string | false |
| piLanguage | string | false |
| piAmount | string | false |
| piId | string | false |
| billingAddress | string | false |
| maxAmount | com.ibm.commerce.foundation.common.datatypes.MonetaryAmountType | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| name | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| rewardSpecGiftItem | cart-rewardOption.rewardSpecGiftItem array | false |
| rewardOptionIdentifier | cart-rewardOption.rewardOptionIdentifier | true |
| adjustmentDescription | string | false |
| giftSetSpecification | cart-rewardOption.giftSetSpecification | false |
| giftSet | cart-rewardOption.giftSet | false |
| rewardSpecification | cart-rewardOption.rewardSpecification | false |
| userData | cart-rewardOption.userData | false |
| amount | cart-rewardOption.amount | false |
| adjustmentCurrency | string | false |
| usage | string | false |
| displayLevel | string | false |
| rewardSpecMaxQuantity | string | false |
| adjustmentLanguage | string | false |
| adjustmentAmount | string | false |
| isPromotionCodeRequired | string | false |
| rewardOptionExternalId | string | false |
| adjustment | cart-rewardOption.adjustment | false |
| code | string | false |
| rewardSpecMaxQuantityUom | string | false |
| adjustmentDisplayLevel | string | false |
| rewardChoice | cart-rewardOption.rewardChoice | false |
| calculationCodeID | cart-rewardOption.calculationCodeID | false |
| rewardChoiceGiftItem | cart-rewardOption.rewardChoiceGiftItem array | false |
| adjustmentUsage | string | false |
| adjustmentCode | string | false |
| description | cart-rewardOption.description | false |
| promotionType | string | false |
| rewardOptionId | string | false |
| Name | Data Type | Required |
|---|---|---|
| usage | string | false |
| calculationCodeID | cart-rewardOption.adjustment.calculationCodeID | false |
| displayLevel | string | false |
| isPromotionCodeRequired | string | false |
| userData | cart-rewardOption.adjustment.userData | false |
| amount | cart-rewardOption.adjustment.amount | false |
| description | cart-rewardOption.adjustment.description | false |
| code | string | false |
| promotionType | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| currency | string | false |
| Name | Data Type | Required |
|---|---|---|
| calculationCodeExternalIdentifier | cart-rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| calculationUsageID | string | false |
| storeIdentifier | cart-rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier | false |
| code | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | cart-rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| language | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | cart-rewardOption.adjustment.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| currency | string | false |
| Name | Data Type | Required |
|---|---|---|
| calculationCodeExternalIdentifier | cart-rewardOption.calculationCodeID.calculationCodeExternalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| calculationUsageID | string | false |
| storeIdentifier | cart-rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier | false |
| code | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | cart-rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| language | string | false |
| Name | Data Type | Required |
|---|---|---|
| giftItem | cart-rewardOption.giftSet.giftItem array | false |
| Name | Data Type | Required |
|---|---|---|
| catalogEntryIdentifier | cart-rewardOption.giftSet.giftItem.catalogEntryIdentifier | false |
| quantity | cart-rewardOption.giftSet.giftItem.quantity | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | cart-rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| storeIdentifier | cart-rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier | false |
| partNumber | string | true |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | cart-rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| uom | string | false |
| Name | Data Type | Required |
|---|---|---|
| giftItem | cart-rewardOption.giftSetSpecification.giftItem array | false |
| maximumQuantity | cart-rewardOption.giftSetSpecification.maximumQuantity | true |
| Name | Data Type | Required |
|---|---|---|
| catalogEntryIdentifier | cart-rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier | false |
| quantity | cart-rewardOption.giftSetSpecification.giftItem.quantity | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | cart-rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| storeIdentifier | cart-rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier | false |
| partNumber | string | true |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | cart-rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| uom | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| uom | string | false |
| Name | Data Type | Required |
|---|---|---|
| giftSet | cart-rewardOption.rewardChoice.giftSet | false |
| userData | cart-rewardOption.rewardChoice.userData | false |
| Name | Data Type | Required |
|---|---|---|
| giftItem | cart-rewardOption.rewardChoice.giftSet.giftItem array | false |
| Name | Data Type | Required |
|---|---|---|
| catalogEntryIdentifier | cart-rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier | false |
| quantity | cart-rewardOption.rewardChoice.giftSet.giftItem.quantity | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | cart-rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| storeIdentifier | cart-rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier | false |
| partNumber | string | true |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | cart-rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| uom | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | cart-rewardOption.rewardChoice.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| uom | string | false |
| externalIdentifier | com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType | false |
| productId | string | false |
| quantity | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | string | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| uom | string | false |
| externalIdentifier | com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType | false |
| productId | string | false |
| Name | Data Type | Required |
|---|---|---|
| giftSetSpecification | cart-rewardOption.rewardSpecification.giftSetSpecification | false |
| userData | cart-rewardOption.rewardSpecification.userData | false |
| Name | Data Type | Required |
|---|---|---|
| giftItem | cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem array | false |
| maximumQuantity | cart-rewardOption.rewardSpecification.giftSetSpecification.maximumQuantity | true |
| Name | Data Type | Required |
|---|---|---|
| catalogEntryIdentifier | cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier | false |
| quantity | cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem.quantity | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| storeIdentifier | cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier | false |
| partNumber | string | true |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| uom | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| uom | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | cart-rewardOption.rewardSpecification.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| userDataField | cart-rewardOption.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| middleName | string | false |
| lastName | string | false |
| organizationUnitName | string | false |
| primary | string | false |
| personTitle | string | false |
| phone1 | string | true |
| phone2 | string | true |
| mobilePhone1 | string | true |
| addressLine | string array | false |
| phone1Publish | string | false |
| nickName | string | true |
| addressType | string | false |
| stateOrProvinceName | string | false |
| mobilePhone1Country | string | true |
| state | string | false |
| email1 | string | true |
| email2 | string | true |
| country | string | false |
| attributes | cart-ShippingAddress.attributes array | false |
| language | string | false |
| postalCode | string | false |
| internalOfficeAddress | string | false |
| firstName | string | false |
| phone1Type | string | false |
| phone2Type | string | false |
| organizationName | string | false |
| personIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType | false |
| phone2Publish | string | false |
| city | string | false |
| bestCallingTime | string | false |
| zipCode | string | false |
| addressId | string | false |
| fax1 | string | true |
| fax2 | string | true |
| geographicalTaxCode | string | false |
| businessTitle | string | false |
| organizationIdentifier | com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType | false |
| geographicalShippingCode | string | false |
| Name | Data Type | Required |
|---|---|---|
| attrValue | string | false |
| attrKey | string | true |
| Name | Data Type | Required |
|---|---|---|
| shipModeLanguage | string | false |
| trackingURL | string | false |
| language | string | false |
| carrier | string | false |
| shipModeId | string | false |
| description | string | false |
| storeId | string | false |
| shipModeCode | string | false |
| shipModeDescription | string | false |
| Name | Data Type | Required |
|---|---|---|
| channel | com.ibm.commerce.order.facade.datatypes.ChannelType | false |
| quoteIdentifier | com.ibm.commerce.foundation.common.datatypes.QuoteIdentifierType | false |
| shipAsComplete | string | false |
| orderId | string | false |
| orderVersion | string | false |
| placedDate | string | false |
| lastUpdateDate | string | false |
| promotionCode | com.ibm.commerce.order.facade.datatypes.PromotionCodeType array | false |
| couponCode | com.ibm.commerce.order.facade.datatypes.CouponCodeType array | false |
| comments | string | false |
| adjustmentRequirement | com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType array | false |
| cSRComments | com.ibm.commerce.order.facade.datatypes.CSRCommentsType array | false |
| quoteID | string | false |
| customerOrderNumber | string | false |
| buyerPONumber | string | false |
| bLockInfo | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType | false |
| orderEditor | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType | false |
| usablePaymentInformation | cart-UsablePaymentInformation array | false |
| externalOrderID | string | false |
| Name | Data Type | Required |
|---|---|---|
| organizationIdentifier | com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType | false |
| nickName | string | true |
| personIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType | false |
| addressId | string | false |
| Name | Data Type | Required |
|---|---|---|
| usableBillingAddress | cart-UsablePaymentInformation.usableBillingAddress array | false |
| paymentMethodName | string | false |
| protocolData | cart-UsablePaymentInformation.protocolData array | false |
| paymentTermConditionId | string | false |
| userDataField | cart-UsablePaymentInformation.userDataField array | false |
| language | string | false |
| description | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| name | string | true |
| Name | Data Type | Required |
|---|---|---|
| organizationIdentifier | com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType | false |
| nickName | string | true |
| personIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType | false |
| addressId | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| organizationIdentifier | com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType | false |
| nickName | string | true |
| personIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType | false |
| addressId | string | false |
| Name | Data Type | Required |
|---|---|---|
| type | string | true |
| name | string | true |
| uniqueID | string | false |
| storeId | com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | cart-UsableShippingInfoOrderItem.userDataField array | false |
| usableShippingMode | cart-UsableShippingMode array | false |
| createDate | string | false |
| quantity | string | false |
| usableShippingChargePolicy | cart-UsableShippingChargePolicy array | false |
| lastUpdateDate | string | false |
| usableShippingAddress | cart-UsableShippingAddress array | false |
| externalOrderItemID | string | false |
| configurationID | string | false |
| UOM | string | false |
| comments | string | false |
| adjustmentRequirement | com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType array | false |
| offerID | string | false |
| orderItemId | string | false |
| correlationGroup | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| userDataField | cart-UsableShippingMode.userDataField array | false |
| trackingURL | string | false |
| language | string | false |
| carrier | string | false |
| shipModeId | string | false |
| description | string | false |
| storeId | string | false |
| shipModeCode | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| language | string | false |
| Name | Data Type | Required |
|---|---|---|
| name | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| currency | string | false |
| Name | Data Type | Required |
|---|---|---|
| uniqueID | string | false |
| distinguishedName | string | false |
| Name | Data Type | Required |
|---|---|---|
| storeIdentifier | com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType.storeIdentifier | false |
| partNumber | string | true |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.foundation.common.datatypes.PartNumberIdentifierType.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier | false |
| uniqueID | string | false |
| distinguishedName | string | false |
| Name | Data Type | Required |
|---|---|---|
| identifier | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.externalIdentifier | false |
| uniqueID | string | false |
| calculationCodeIdentifier | com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier | false |
| Name | Data Type | Required |
|---|---|---|
| calculationCodeExternalIdentifier | com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier.calculationCodeExternalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| calculationUsageID | string | false |
| storeIdentifier | com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier | false |
| code | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| version | string | false |
| storeIdentifier | com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.externalIdentifier.storeIdentifier | false |
| name | string | true |
| revision | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| uniqueID | string | false |
| externalQuoteID | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| taxCategoryCode | string | false |
| Name | Data Type | Required |
|---|---|---|
| resultList | com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary.resultList array | false |
| Name | Data Type | Required |
|---|---|---|
| isPersonalAddressAllowForBilling | string | false |
| billingAddresses | com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary.resultList.billingAddresses array | false |
| orderDataBean | com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary.resultList.orderDataBean | false |
| Name | Data Type | Required |
|---|---|---|
| urlURL | string | false |
| nickNameURL | string | false |
| primary | string | false |
| organizationUnitName | string | false |
| bestCallingTimeURL | string | false |
| phone1 | string | false |
| personTitle | string | false |
| phone2 | string | false |
| cityURL | string | false |
| billingCode | string | false |
| addressField1 | string | false |
| storeDirectory | string | false |
| addressField2 | string | false |
| primaryURL | string | false |
| packageSuppression | string | false |
| organizationUnitNameURL | string | false |
| addressField3 | string | false |
| nickName | string | false |
| createdTimestamp | string | false |
| middleNameURL | string | false |
| state | string | false |
| mobilePhone1Country | string | false |
| firstNameURL | string | false |
| email1 | string | false |
| country | string | false |
| email2 | string | false |
| officeAddress | string | false |
| email1URL | string | false |
| fax1URL | string | false |
| statusURL | string | false |
| publishPhone1URL | string | false |
| stateURL | string | false |
| mobilePhone1CountryURL | string | false |
| packageSuppressionURL | string | false |
| addressField3URL | string | false |
| dataBeanKeyAddressId | string | false |
| billingCodeTypeURL | string | false |
| bestCallingTime | string | false |
| zipCode | string | false |
| addressId | string | false |
| address3URL | string | false |
| phone2TypeURL | string | false |
| organizationNameURL | string | false |
| lastCreate | string | false |
| fax1 | string | false |
| fax2 | string | false |
| officeAddressURL | string | false |
| address1 | string | false |
| address2 | string | false |
| address3 | string | false |
| addressIdURL | string | false |
| middleName | string | false |
| addressTypeURL | string | false |
| lastName | string | false |
| addressField2URL | string | false |
| mobilePhone1 | string | false |
| billingCodeURL | string | false |
| phone2URL | string | false |
| addressType | string | false |
| address2URL | string | false |
| phone1TypeURL | string | false |
| createdTime | string | false |
| memberId | string | false |
| businessTitleURL | string | false |
| firstName | string | false |
| phone1Type | string | false |
| lastCreateURL | string | false |
| phone2Type | string | false |
| organizationName | string | false |
| zipCodeURL | string | false |
| billingCodeType | string | false |
| addressField1URL | string | false |
| mobilePhone1URL | string | false |
| city | string | false |
| phone1URL | string | false |
| personTitleURL | string | false |
| lastNameURL | string | false |
| status | string | false |
| publishPhone1 | string | false |
| address1URL | string | false |
| storeIdURL | string | false |
| stateProvDisplayName | string | false |
| publishPhone2 | string | false |
| countryDisplayName | string | false |
| businessTitle | string | false |
| countryURL | string | false |
| email2URL | string | false |
| fax2URL | string | false |
| publishPhone2URL | string | false |
| isSelfAddress | string | false |
| Name | Data Type | Required |
|---|---|---|
| totalPages | string | false |
| uniqueShippingAddresses | com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary.resultList.orderDataBean.uniqueShippingAddresses array | false |
| buschnId | string | false |
| totalSize | string | false |
| totalShippingCharge | string | false |
| totalTax | string | false |
| addressId | string | false |
| totalAdjustment | string | false |
| totalProductPriceBySumUp | string | false |
| billingAddressDataBean | com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary.resultList.orderDataBean.billingAddressDataBean | false |
| surchargeAdjustmentTotal | string | false |
| totalOrderItemsPrice | string | false |
| actualShipDate | string | false |
| totalShippingTax | string | false |
| type | string | false |
| transferStatus | string | false |
| totalProductPrice | string | false |
| Name | Data Type | Required |
|---|---|---|
| urlURL | string | false |
| nickNameURL | string | false |
| primary | string | false |
| organizationUnitName | string | false |
| bestCallingTimeURL | string | false |
| phone1 | string | false |
| personTitle | string | false |
| phone2 | string | false |
| cityURL | string | false |
| billingCode | string | false |
| addressField1 | string | false |
| storeDirectory | string | false |
| addressField2 | string | false |
| primaryURL | string | false |
| packageSuppression | string | false |
| organizationUnitNameURL | string | false |
| addressField3 | string | false |
| nickName | string | false |
| createdTimestamp | string | false |
| middleNameURL | string | false |
| state | string | false |
| mobilePhone1Country | string | false |
| firstNameURL | string | false |
| email1 | string | false |
| country | string | false |
| email2 | string | false |
| officeAddress | string | false |
| email1URL | string | false |
| fax1URL | string | false |
| statusURL | string | false |
| publishPhone1URL | string | false |
| stateURL | string | false |
| mobilePhone1CountryURL | string | false |
| packageSuppressionURL | string | false |
| addressField3URL | string | false |
| dataBeanKeyAddressId | string | false |
| billingCodeTypeURL | string | false |
| bestCallingTime | string | false |
| zipCode | string | false |
| addressId | string | false |
| address3URL | string | false |
| phone2TypeURL | string | false |
| organizationNameURL | string | false |
| lastCreate | string | false |
| fax1 | string | false |
| fax2 | string | false |
| officeAddressURL | string | false |
| address1 | string | false |
| address2 | string | false |
| address3 | string | false |
| addressIdURL | string | false |
| middleName | string | false |
| addressTypeURL | string | false |
| lastName | string | false |
| addressField2URL | string | false |
| mobilePhone1 | string | false |
| billingCodeURL | string | false |
| phone2URL | string | false |
| addressType | string | false |
| address2URL | string | false |
| phone1TypeURL | string | false |
| createdTime | string | false |
| memberId | string | false |
| businessTitleURL | string | false |
| firstName | string | false |
| phone1Type | string | false |
| lastCreateURL | string | false |
| phone2Type | string | false |
| organizationName | string | false |
| zipCodeURL | string | false |
| billingCodeType | string | false |
| addressField1URL | string | false |
| mobilePhone1URL | string | false |
| city | string | false |
| phone1URL | string | false |
| personTitleURL | string | false |
| lastNameURL | string | false |
| status | string | false |
| publishPhone1 | string | false |
| address1URL | string | false |
| storeIdURL | string | false |
| stateProvDisplayName | string | false |
| publishPhone2 | string | false |
| countryDisplayName | string | false |
| businessTitle | string | false |
| countryURL | string | false |
| email2URL | string | false |
| fax2URL | string | false |
| publishPhone2URL | string | false |
| isSelfAddress | string | false |
| Name | Data Type | Required |
|---|---|---|
| urlURL | string | false |
| nickNameURL | string | false |
| primary | string | false |
| organizationUnitName | string | false |
| bestCallingTimeURL | string | false |
| phone1 | string | false |
| personTitle | string | false |
| phone2 | string | false |
| cityURL | string | false |
| billingCode | string | false |
| addressField1 | string | false |
| storeDirectory | string | false |
| addressField2 | string | false |
| primaryURL | string | false |
| packageSuppression | string | false |
| organizationUnitNameURL | string | false |
| addressField3 | string | false |
| nickName | string | false |
| createdTimestamp | string | false |
| middleNameURL | string | false |
| state | string | false |
| mobilePhone1Country | string | false |
| firstNameURL | string | false |
| email1 | string | false |
| country | string | false |
| email2 | string | false |
| officeAddress | string | false |
| email1URL | string | false |
| fax1URL | string | false |
| statusURL | string | false |
| publishPhone1URL | string | false |
| stateURL | string | false |
| mobilePhone1CountryURL | string | false |
| packageSuppressionURL | string | false |
| addressField3URL | string | false |
| dataBeanKeyAddressId | string | false |
| billingCodeTypeURL | string | false |
| bestCallingTime | string | false |
| zipCode | string | false |
| addressId | string | false |
| address3URL | string | false |
| phone2TypeURL | string | false |
| organizationNameURL | string | false |
| lastCreate | string | false |
| fax1 | string | false |
| fax2 | string | false |
| officeAddressURL | string | false |
| address1 | string | false |
| address2 | string | false |
| address3 | string | false |
| addressIdURL | string | false |
| middleName | string | false |
| addressTypeURL | string | false |
| lastName | string | false |
| addressField2URL | string | false |
| mobilePhone1 | string | false |
| billingCodeURL | string | false |
| phone2URL | string | false |
| addressType | string | false |
| address2URL | string | false |
| phone1TypeURL | string | false |
| createdTime | string | false |
| memberId | string | false |
| businessTitleURL | string | false |
| firstName | string | false |
| phone1Type | string | false |
| lastCreateURL | string | false |
| phone2Type | string | false |
| organizationName | string | false |
| zipCodeURL | string | false |
| billingCodeType | string | false |
| addressField1URL | string | false |
| mobilePhone1URL | string | false |
| city | string | false |
| phone1URL | string | false |
| personTitleURL | string | false |
| lastNameURL | string | false |
| status | string | false |
| publishPhone1 | string | false |
| address1URL | string | false |
| storeIdURL | string | false |
| stateProvDisplayName | string | false |
| publishPhone2 | string | false |
| countryDisplayName | string | false |
| businessTitle | string | false |
| countryURL | string | false |
| email2URL | string | false |
| fax2URL | string | false |
| publishPhone2URL | string | false |
| isSelfAddress | string | false |
| Name | Data Type | Required |
|---|---|---|
| resultList | com.ibm.commerce.order.beans.UsableShipChargesAndAccountByShipModeDataBean_IBM_usableShipChargesByShipMode.resultList array | false |
| Name | Data Type | Required |
|---|---|---|
| numberOfShipModes | string | false |
| shipChargesByShipMode | com.ibm.commerce.order.beans.UsableShipChargesAndAccountByShipModeDataBean_IBM_usableShipChargesByShipMode.resultList.shipChargesByShipMode array | false |
| isShipChargesExist | string | false |
| Name | Data Type | Required |
|---|---|---|
| shipModeDesc | string | false |
| shippingChargeTypes | com.ibm.commerce.order.beans.UsableShipChargesAndAccountByShipModeDataBean_IBM_usableShipChargesByShipMode.resultList.shipChargesByShipMode.shippingChargeTypes array | false |
| numberOfShipChargeTypes | string | false |
| shipModeId | string | false |
| carrierAccountNumber | string | false |
| Name | Data Type | Required |
|---|---|---|
| carrAccntNumber | string | false |
| policyDescription | string | false |
| internalPolicyId | string | false |
| selected | string | false |
| policyName | string | false |
| policyId | string | false |
| Name | Data Type | Required |
|---|---|---|
| adjustmentUsage | string | true |
| adjustmentValue | string | false |
| comments | com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.comments | false |
| userData | com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.userData | false |
| adjustmentCategory | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| language | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.AdjustmentRequirementType.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| userData | com.ibm.commerce.order.facade.datatypes.ChannelType.userData | false |
| channelIdentifer | com.ibm.commerce.order.facade.datatypes.ChannelType.channelIdentifer | false |
| description | com.ibm.commerce.order.facade.datatypes.ChannelType.description | false |
| Name | Data Type | Required |
|---|---|---|
| uniqueID | string | false |
| channelName | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| language | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.ChannelType.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| couponId | string | false |
| effectiveDateTime | string | false |
| status | string | false |
| userData | com.ibm.commerce.order.facade.datatypes.CouponCodeType.userData | false |
| expirationDateTime | string | false |
| promotionIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier | false |
| description | com.ibm.commerce.order.facade.datatypes.CouponCodeType.description array | false |
| code | string | false |
| Name | Data Type | Required |
|---|---|---|
| shortDescription | string | false |
| longDescription | string | false |
| userData | com.ibm.commerce.order.facade.datatypes.CouponCodeType.description.userData | false |
| language | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.CouponCodeType.description.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| calculationCodeIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier | false |
| Name | Data Type | Required |
|---|---|---|
| calculationCodeExternalIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| calculationUsageID | string | false |
| storeIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier | false |
| code | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| version | string | false |
| storeIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier.storeIdentifier | false |
| name | string | true |
| revision | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.order.facade.datatypes.CouponCodeType.promotionIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.CouponCodeType.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| shortDescription | string | false |
| longDescription | string | false |
| userData | com.ibm.commerce.order.facade.datatypes.CouponDescriptionType.userData | false |
| language | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.CouponDescriptionType.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| changeReasonCode | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode | false |
| userData | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.userData | false |
| orderVersion | string | false |
| cSRIdentifier | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.cSRIdentifier | false |
| creationDate | string | false |
| comment | string | false |
| Name | Data Type | Required |
|---|---|---|
| reasonCode | string | false |
| userData | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode.userData | false |
| description | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode.description | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| language | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.changeReasonCode.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.cSRIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| distinguishedName | string | false |
| Name | Data Type | Required |
|---|---|---|
| identifier | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.CSRCommentsType.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| paymentInstructionID | string | false |
| requestAmount | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.requestAmount | false |
| paymentProtocolData | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.paymentProtocolData array | false |
| transactionExtensionData | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.transactionExtensionData array | false |
| avsCode | string | false |
| responseCode | string | false |
| merchantOrderNumber | string | false |
| reasonCode | string | false |
| trackingID | string | false |
| status | string | false |
| referenceNumber | string | false |
| userData | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.userData | false |
| transactionType | string | false |
| requestTime | string | false |
| expirationTime | string | false |
| financialTransactionIdentifier | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.financialTransactionIdentifier | false |
| lastUpdate | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | string | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| name | string | true |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| currency | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| name | string | true |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.FinancialTransactionType.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| userData | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.userData | false |
| orderBlock | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock array | false |
| Name | Data Type | Required |
|---|---|---|
| blockReason | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason | false |
| comments | string | false |
| resovled | string | false |
| userData | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.userData | false |
| timeBlocked | string | false |
| Name | Data Type | Required |
|---|---|---|
| reasonCode | string | false |
| userData | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason.userData | false |
| reansonType | string | false |
| description | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason.description | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| language | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.blockReason.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.orderBlock.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.OrderBLockInfoType.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| configurationID | string | false |
| catalogEntryIdentifier | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier | false |
| orderItemComponentIdentifier | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.orderItemComponentIdentifier | false |
| unitPrice | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice | false |
| userData | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.userData | false |
| quantity | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.quantity | false |
| required | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| storeIdentifier | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier.storeIdentifier | false |
| partNumber | string | true |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| uom | string | false |
| Name | Data Type | Required |
|---|---|---|
| price | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice.price | false |
| alternativeCurrencyPrice | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice.alternativeCurrencyPrice array | false |
| quantity | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice.quantity | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| currency | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| currency | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| uom | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| parentOrderItemIdentifier | com.ibm.commerce.order.facade.datatypes.ParentInfoType.parentOrderItemIdentifier | false |
| relationTypeCode | string | false |
| userData | com.ibm.commerce.order.facade.datatypes.ParentInfoType.userData | false |
| parentOrderIdentifier | com.ibm.commerce.order.facade.datatypes.ParentInfoType.parentOrderIdentifier | false |
| Name | Data Type | Required |
|---|---|---|
| customerOrderNumber | string | false |
| uniqueID | string | false |
| externalOrderID | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalOrderItemID | string | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.ParentInfoType.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| reason | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason | false |
| userData | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.userData | false |
| code | string | false |
| associatedPromotion | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion array | false |
| Name | Data Type | Required |
|---|---|---|
| promotionIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier | false |
| description | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.description | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| language | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| calculationCodeIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier | false |
| Name | Data Type | Required |
|---|---|---|
| calculationCodeExternalIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| calculationUsageID | string | false |
| storeIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier | false |
| code | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| version | string | false |
| storeIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier.storeIdentifier | false |
| name | string | true |
| revision | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.associatedPromotion.promotionIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| reasonCode | string | false |
| userData | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.userData | false |
| valid | string | false |
| description | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.description | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| language | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.reason.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.PromotionCodeType.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| rewardChoice | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice | false |
| rewardSpecification | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification | false |
| userData | com.ibm.commerce.order.facade.datatypes.RewardOptionType.userData | false |
| rewardOptionIdentifier | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardOptionIdentifier | true |
| adjustment | com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment | false |
| Name | Data Type | Required |
|---|---|---|
| usage | string | false |
| calculationCodeID | com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.calculationCodeID | false |
| displayLevel | string | false |
| isPromotionCodeRequired | string | false |
| userData | com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.userData | false |
| amount | com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.amount | false |
| description | com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.description | false |
| code | string | false |
| promotionType | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| currency | string | false |
| Name | Data Type | Required |
|---|---|---|
| calculationCodeExternalIdentifier | com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.calculationCodeID.calculationCodeExternalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| calculationUsageID | string | false |
| storeIdentifier | com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier | false |
| code | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| language | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| giftSet | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet | false |
| userData | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.userData | false |
| Name | Data Type | Required |
|---|---|---|
| giftItem | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem array | false |
| Name | Data Type | Required |
|---|---|---|
| catalogEntryIdentifier | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem.catalogEntryIdentifier | false |
| quantity | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem.quantity | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| storeIdentifier | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier | false |
| partNumber | string | true |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| uom | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | string | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| giftSetSpecification | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification | false |
| userData | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.userData | false |
| Name | Data Type | Required |
|---|---|---|
| giftItem | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem array | false |
| maximumQuantity | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.maximumQuantity | true |
| Name | Data Type | Required |
|---|---|---|
| catalogEntryIdentifier | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier | false |
| quantity | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem.quantity | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| storeIdentifier | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier | false |
| partNumber | string | true |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| externalIdentifier | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier | false |
| uniqueID | string | false |
| Name | Data Type | Required |
|---|---|---|
| nameIdentifier | string | false |
| ownerID | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| uom | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| uom | string | false |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| userDataField | com.ibm.commerce.order.facade.datatypes.RewardOptionType.userData.userDataField array | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |
| Name | Data Type | Required |
|---|---|---|
| resultList | com.ibm.commerce.payment.beans.BuyerPurchaseOrderDataBean_IBM_BuyerPurchaseOrder_Summary.resultList array | false |
| Name | Data Type | Required |
|---|---|---|
| state | string | false |
| currency | string | false |
| buyerPurchaseOrderId | string | false |
| purchaseOrderNumber | string | false |
| amount | string | false |
| accountId | string | false |
| dataBeanKeyBuyerPurchaseOrderId | string | false |
| buyerPurchaseOrderTypeId | string | false |
| Name | Data Type | Required |
|---|---|---|
| resultList | com.ibm.commerce.payment.beans.PaymentPolicyListDataBean_IBM_PaymentPolicyList_Detailed.resultList array | false |
| Name | Data Type | Required |
|---|---|---|
| primaryRC | string | false |
| secondaryRC | string | false |
| paymentPolicyInfoUsableWithoutTA | com.ibm.commerce.payment.beans.PaymentPolicyListDataBean_IBM_PaymentPolicyList_Detailed.resultList.paymentPolicyInfoUsableWithoutTA array | false |
| message | string | false |
| Name | Data Type | Required |
|---|---|---|
| shortDescription | string | false |
| longDescription | string | false |
| attrPageName | string | false |
| policyType | string | false |
| policyName | string | false |
| policyId | string | false |
| Name | Data Type | Required |
|---|---|---|
| reverse | string | false |
| remerge | string | false |
| physicalStoreId | string | false |
| backorder | string | false |
| calculateOrder | string | false |
| check | string | false |
| quantity | string | false |
| contractId | string | false |
| fulfillmentCenterId | string | false |
| addressId | string | false |
| doInventory | string | false |
| UOM | string | false |
| inventoryValidation | string | false |
| ConfigurationXML | string | true |
| catEntryId | string | false |
| merge | string | false |
| calculationUsage | string | false |
| shipModeId | string | false |
| orderItemId | string | false |
| partNumber | string | false |
| allocate | string | false |
| doPrice | string | false |
| comment | string | false |
Description of the addOrderItem input body.
| Name | Data Type | Required |
|---|---|---|
| orderItem | com.ibm.commerce.rest.order.handler.CartHandler$AddOrderItemBodyDescription$OrderItemBodyDescription array | true |
| orderId | string | false |
| x_inventoryValidation | string | false |
| x_calculateOrder | string | false |
| x_calculationUsage | string | false |
Description of orderItem.
| Name | Data Type | Required |
|---|---|---|
| UOM | string | false |
| itemAttributes | com.ibm.commerce.rest.order.handler.CartHandler$AddOrderItemBodyDescription$OrderItemBodyDescription$ItemAttributesBodyDescription array | false |
| productId | string | true |
| quantity | string | true |
| partNumber | string | false |
| contractId | string | false |
| fulfillmentCenterName | string | false |
| fulfillmentCenterId | string | false |
| comment | string | false |
Description of item attributes.
| Name | Data Type | Required |
|---|---|---|
| attrValue | string | true |
| attrName | string | true |
| Name | Data Type | Required |
|---|---|---|
| reverse | string | false |
| remerge | string | false |
| physicalStoreId | string | false |
| backorder | string | false |
| calculateOrder | string | false |
| check | string | false |
| quantity | string | false |
| contractId | string | false |
| fulfillmentCenterId | string | false |
| addressId | string | false |
| doInventory | string | false |
| UOM | string | false |
| inventoryValidation | string | false |
| catEntryId | string | false |
| merge | string | false |
| calculationUsage | string | false |
| shipModeId | string | false |
| orderItemId | string | false |
| partNumber | string | false |
| allocate | string | false |
| doPrice | string | false |
| comment | string | false |
Body of request input for calculateOrder.
| Name | Data Type | Required |
|---|---|---|
| updatePrices | string | false |
| calculationUsageId | string | true |
| doFreeGift | string | false |
| orderId | string | false |
| outOrderName | string | false |
| doPrice | string | false |
Request body input for shopping cart submission for checkout.
| Name | Data Type | Required |
|---|---|---|
| notifyMerchant | string | false |
| notify_EMailSender_recipient | string | false |
| notifyOrderSubmitted | string | false |
| SMS | string | false |
| orderId | string | true |
| purchaseorder_id | string | false |
| notifyShopper | string | false |
| Name | Data Type | Required |
|---|---|---|
| prepare | string | false |
| check | string | false |
| quantity | string | false |
| toOrderId | string | false |
| currency | string | false |
| offerId | string | false |
| requestedShipDate | string | false |
| partNumber | string | false |
| correlationGroup | string | false |
| keepOrdItemValidContract | string | false |
| continue | string | false |
| copyOrdPayInfo | string | false |
| addressId | string | false |
| configurationId | string | false |
| orderComment | string | false |
| isPONumberCopied | string | false |
| merge | string | false |
| partOwnerId | string | false |
| displaySeq | string | false |
| allocate | string | false |
| payInfoFrom | string | false |
| copyOrderUniquePromotionCode | string | false |
| copyOrderItemId | string | false |
| backorder | string | false |
| price | string | false |
| shippingAddressFromOrderProfile | string | false |
| outOrderName | string | false |
| contractId | string | false |
| copyAutoAddedOrderItems | string | false |
| memberId | string | false |
| shippingModeFromOrderProfile | string | false |
| copyOrderPromotionCode | string | false |
| comment | string | false |
| reverse | string | false |
| remerge | string | false |
| orderInfoFrom | string | false |
| shipAsComplete | string | false |
| tcId | string | false |
| blockInfoCopy | string | false |
| refreshContractAndOffer | string | false |
| status | string | false |
| UOM | string | false |
| updateOrderItemId | string | false |
| billingAddressId | string | false |
| inventoryValidation | string | false |
| catEntryId | string | false |
| field1 | string | false |
| field2 | string | false |
| sensitiveInfoCopy | string | false |
| field3 | string | false |
| pay_paymentname | string | false |
| shipModeId | string | false |
| description | string | false |
| outOrderItemName | string | false |
| fromOrderId | string | false |
| Name | Data Type | Required |
|---|---|---|
| outOrderName | string | false |
| Name | Data Type | Required |
|---|---|---|
| catEntryId | string | false |
| check | string | false |
| calculationUsage | string | false |
| calculateOrder | string | false |
| orderId | string | false |
| outOrderName | string | false |
| orderItemId | string | true |
Structure containing an order identifier.
| Name | Data Type | Required |
|---|---|---|
| orderId | string | true |
| Name | Data Type | Required |
|---|---|---|
| inRemerge | string | false |
| inAllocate | string | false |
| inBackorder | string | false |
| inCheck | string | false |
| deleteIfEmpty | string | false |
| outMerge | string | false |
| outAllocate | string | false |
| outOrderName | string | false |
| toOrderId | string | false |
| doInventory | string | false |
| refreshContractAndOffer | string | false |
| moveAutoAddedOrderItems | string | false |
| fromOrderItemId | string | false |
| moveOrderPromotionCode | string | false |
| inMerge | string | false |
| outReverse | string | false |
| createIfEmpty | string | false |
| inOrderName | string | false |
| outRemerge | string | false |
| outBackorder | string | false |
| outCheck | string | false |
| inReverse | string | false |
| outOrderItemName | string | false |
| fromOrderId | string | false |
| Name | Data Type | Required |
|---|---|---|
| start | string | true |
| delay | string | false |
| interval | string | false |
| attempts | string | false |
| host | string | false |
| orderId | string | true |
Structure containing an order ID and order item ID.
| Name | Data Type | Required |
|---|---|---|
| orderItem | com.ibm.commerce.rest.order.handler.CartHandler$OrderWithOrderItemContainer$OrderItemBodyDescription array | true |
| orderId | string | true |
Description of orderItem.
| Name | Data Type | Required |
|---|---|---|
| orderItemId | string | false |
| Name | Data Type | Required |
|---|---|---|
| orderId | string | true |
| rewardOptionId | string | true |
| Name | Data Type | Required |
|---|---|---|
| orderId | string | false |
| outOrderName | string | false |
Shipping mode list.
| Name | Data Type | Required |
|---|---|---|
| usableShippingMode | com.ibm.commerce.rest.order.handler.CartHandler$ShippingModes$UsableShippingMode array | true |
Description of orderItem.
| Name | Data Type | Required |
|---|---|---|
| userData | string | false |
| trackingURL | string | false |
| carrier | string | false |
| shipModeId | string | true |
| description | string | true |
| shipModeCode | string | true |
| Name | Data Type | Required |
|---|---|---|
| ConfigurationXML | string | true |
| orderItemId | string | true |
Description of the updateOrderItem input body.
| Name | Data Type | Required |
|---|---|---|
| orderItem | com.ibm.commerce.rest.order.handler.CartHandler$UpdateOrderItemBodyDescription$OrderItemBodyDescription array | true |
| orderId | string | false |
| x_inventoryValidation | string | false |
| x_calculateOrder | string | false |
| x_calculationUsage | string | false |
Description of orderItem.
| Name | Data Type | Required |
|---|---|---|
| productId | string | true |
| quantity | string | true |
| partNumber | string | false |
| orderItemId | string | false |
| contractId | string | false |
| Name | Data Type | Required |
|---|---|---|
| resultList | com.ibm.commerce.utf.beans.PAttributeDataBean_IBM_PAttribute_Detailed.resultList array | false |
| Name | Data Type | Required |
|---|---|---|
| sequence | string | false |
| encryptFlag | string | false |
| referenceNumber | string | false |
| attrTypeId | string | false |
| PAttributeId | string | false |
| name | string | false |
| accessBeanName | string | false |
| Name | Data Type | Required |
|---|---|---|
| value | string | false |
| key | string | true |