WebSphere Commerce Service - Cart

These services provide APIs related to the shopping cart in a B2B or B2C store. Use these classes to:

• Get, add, update, or delete payment instructions

• Get, add, update, or delete items in the shopping cart

• Get the billing address

• Calculate order prices

• Lock or unlock the cart

• Checkout

• Get or update shipping information

• etc... Schemes: https

  Summary

  Tag: Payment Instruction

  This class provides RESTful services to get, add, update, or delete payment instructions.

  Operation	Description
  GET /store/{storeId}/cart/@self/payment_instruction/punchoutPaymentInfo	Get punch-out payment instructions
  PUT /store/{storeId}/cart/@self/payment_instruction	Update payment instructions
  POST /store/{storeId}/cart/@self/payment_instruction	Get payment instructions
  GET /store/{storeId}/cart/@self/payment_instruction	Delete payment instructions
  DELETE /store/{storeId}/cart/@self/payment_instruction	Add payment instructions
  GET /store/{storeId}/cart/@self/payment_instruction/sensitive_data_mask_by_plain_string/{plainString}	Get sensitive data mask information
  POST /store/{storeId}/cart/@self/payment_instruction/repay	Process payment punch-out request
  DELETE /store/{storeId}/cart/@self/payment_instruction/{paymentInstruction_id}	Delete payment instructions
  POST /store/{storeId}/cart/@self/payment_instruction/callback	Process punch-out call back request

  Tag: Cart

  This class provides RESTful services to get, add, update, or delete items in the shopping cart, calculate order price, get the billing address, lock or unlock the cart, checkout, and many other things. It also provides services to get usable shipping and payment information by delegating to the Order BOD service.

  Operation	Description
  POST /store/{storeId}/cart/@self/checkout	Check out
  DELETE /store/{storeId}/cart/{orderId}/csrcancel_order	Cancel order (CSR)
  PUT /store/{storeId}/cart/move_order_item	Move order items
  GET /store/{storeId}/cart/@self/pattribute/{initKey_referenceNumber}	Get terms and conditions
  PUT /store/{storeId}/cart/@self/update_reward_option	Update reward option
  POST /store/{storeId}/cart/calculate	Calculate order price
  PUT /store/{storeId}/cart/@self/update_order_item	Update order items
  GET /store/{storeId}/cart/@self/buyer_purchase_order/{buyerPurchaseOrderId}	Get purchase order information
  POST /store/{storeId}/cart/@self/add_configuration_to_cart	Add dynamic kit
  POST /store/{storeId}/cart/copy_order	Copy order
  PUT /store/{storeId}/cart/@self/update_configuration_in_cart	Update dynamic kit configuration
  POST /store/{storeId}/cart/{orderId}/set_pending_order	Set pending order
  POST /store/{storeId}/cart/{cartId}/lockOnBehalf	Lock cart (buyer administrator)
  POST /store/{storeId}/cart/{orderId}/schedule_order	Create scheduled order
  POST /store/{storeId}/cart	Add items
  POST /store/{storeId}/cart/@self/renew_order_items	Renew inventory status
  PUT /store/{storeId}/cart/@self/applyCheckoutProfile	Apply quick checkout profile
  POST /store/{storeId}/cart/{orderId}/calculate	Calculate order price
  GET /store/{storeId}/cart/@self/usable_billing_address/{orderId}	Get billing address
  DELETE /store/{storeId}/cart/{orderId}/cancel_order	Cancel order
  GET /store/{storeId}/cart/@self/usable_payment_info	Get payment information
  POST /store/{storeId}/cart/@self/add_preconfiguration_to_cart	Add preconfigured dynamic kit
  POST /store/{storeId}/cart/{cartId}/unlock	Unlock cart (CSR)
  DELETE /store/{storeId}/cart/{orderId}/csrcancel_order_onbehalf	Cancel order (CSR on behalf of)
  PUT /store/{storeId}/cart/@self/precheckout	Prepare for checkout
  PUT /store/{storeId}/cart/@self	Update order items
  GET /store/{storeId}/cart/@self	Get order details
  DELETE /store/{storeId}/cart/@self	Delete items
  POST /store/{storeId}/cart/{cartId}/unlockOnBehalf	Unlock cart (buyer administrator)
  GET /store/{storeId}/cart/@self/payment_policy_list	Get payment policy list
  POST /store/{storeId}/cart/create_order	Create order
  PUT /store/{storeId}/cart/@self/delete_order_item	Delete order item
  POST /store/{storeId}/cart/{cartId}/lock	Lock cart (CSR)

  Tag: Shipping Info

  This class provides RESTful services to get or update shipping information.

  Operation	Description
  PUT /store/{storeId}/cart/@self/shipping_info	Update shipping information
  GET /store/{storeId}/cart/@self/shipping_info	Get shipping instructions
  GET /store/{storeId}/cart/shipping_modes	Get shipping modes
  GET /store/{storeId}/cart/@self/usable_shipping_info	Get shipping information
  GET /store/{storeId}/cart/{orderId}/usable_ship_charges_by_ship_mode	Get shipping charge

  Tag: cart

  Operation	Description
  POST /store/{storeId}/cart/@self/applepay_cancel	Cancel the apple pay order.
  PUT /store/{storeId}/cart/@self/applepay_update	Update the apple pay order.
  POST /store/{storeId}/cart/@self/applepay_process	Process the apple pay order.
  GET /store/{storeId}/cart/@self/usable_shipping_mode	Gets usable shipping information for the shopping cart by address.

  Paths

  Add items

  POST /store/{storeId}/cart

  Tags: Cart

  Adds one or more order items to the shopping cart.

  application/json application/xml

  The request object for AddOrderItem. com.ibm.commerce.rest.order.handler.CartHandler$AddOrderItemBodyDescription

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  No response was specified. Example for application/json

  {
      "orderId": "25207",
      "orderItem": [
          {
              "orderItemId": "85206"
          }
      ]
  }
                                              

  com.ibm.commerce.rest.order.handler.CartHandler$OrderWithOrderItemContainer

  201 Created

  The requested resource has been created.

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Delete items

  DELETE /store/{storeId}/cart/@self

  Tags: Cart

  Deletes all order items from the shopping cart.

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  No response was specified. Empty

  204 No Content

  The requested completed successfully. No content is returned in the response.

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Get order details

  GET /store/{storeId}/cart/@self

  Tags: Cart

  Gets order details for the shopping cart.

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  pageNumber	Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.	query	integer (int32)
  pageSize	Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.	query	integer (int32)
  currency	The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.	query	string , x ∈ { JPY , CNY , BRL , EUR , RON , RUB , PLN , USD , KRW , TWD , CAD , GBP }
  sortOrderItemBy	The sort order of the results for example, sort by orderItemID.	query	string
  profileName	Profile name. Profiles determine the subset of data returned by a query.	query	string , x ∈ { IBM_Summary , IBM_Details }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

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

  cart-cart

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Update order items

  PUT /store/{storeId}/cart/@self

  Tags: Cart

  Deprecated: Updates one or more order items in the shopping cart. Use updateOrderItem.

  application/json application/xml

  Update order item body. cart-cartUpdate

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

  {
      "orderId": "25032",
      "orderItem": [
          {
              "orderItemId": "85043"
          }
      ]
  }
                                              

  cart-cartUpdate

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Add dynamic kit

  POST /store/{storeId}/cart/@self/add_configuration_to_cart

  Tags: Cart

  Adds dynamic kit configurations to the shopping cart.

  application/json application/xml

  The request body for adding a dynamic kit configuration to cart. com.ibm.commerce.rest.order.handler.CartHandler$AddConfigurationToCartRequest

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.rest.order.handler.CartHandler$AddConfigurationToCartRequest

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Add preconfigured dynamic kit

  POST /store/{storeId}/cart/@self/add_preconfiguration_to_cart

  Tags: Cart

  Adds preconfigured dynamic kits to the shopping cart.

  application/json application/xml

  The request body for adding a dynamic kit configuration to cart. com.ibm.commerce.rest.order.handler.CartHandler$AddPreConfigurationToCartRequest

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.rest.order.handler.CartHandler$AddPreConfigurationToCartRequest

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Cancel the apple pay order.

  POST /store/{storeId}/cart/@self/applepay_cancel

  Tags: cart

  storeId	The store identifier.	path	string , x ∈ { 0 , 10001 , 10051 , 10101 , 10151 , 10201 , 10202 }
  responseFormat	The response format. If the request has an input body, that body must also use the format specified in "responseFormat". Valid values include "json" and "xml" without the quotes. If the responseFormat isn't specified, the "accept" HTTP header shall be used to determine the format of the response. If the "accept" HTTP header isn't specified as well, the default response format shall be in json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Empty

  400 Bad Request

  Bad request. Some of the inputs provided to the request aren't valid.

  401 Unauthorized

  Not authenticated. The user session isn't valid.

  403 Forbidden

  The user isn't authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. Additional details will be contained on the server logs.

  Process the apple pay order.

  POST /store/{storeId}/cart/@self/applepay_process

  Tags: cart

  The request object for ApplePayProcess. com.ibm.commerce.rest.order.handler.CartHandler$ApplePayProcessBodyDescription

  storeId	The store identifier.	path	string , x ∈ { 0 , 10001 , 10051 , 10101 , 10151 , 10201 , 10202 }
  responseFormat	The response format. If the request has an input body, that body must also use the format specified in "responseFormat". Valid values include "json" and "xml" without the quotes. If the responseFormat isn't specified, the "accept" HTTP header shall be used to determine the format of the response. If the "accept" HTTP header isn't specified as well, the default response format shall be in json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Empty

  400 Bad Request

  Bad request. Some of the inputs provided to the request aren't valid.

  401 Unauthorized

  Not authenticated. The user session isn't valid.

  403 Forbidden

  The user isn't authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. Additional details will be contained on the server logs.

  Update the apple pay order.

  PUT /store/{storeId}/cart/@self/applepay_update

  Tags: cart

  The request object for Apple pay order update. com.ibm.commerce.rest.order.handler.CartHandler$ApplePayUpdateBodyDescription

  storeId	The store identifier.	path	string , x ∈ { 0 , 10001 , 10051 , 10101 , 10151 , 10201 , 10202 }
  responseFormat	The response format. If the request has an input body, that body must also use the format specified in "responseFormat". Valid values include "json" and "xml" without the quotes. If the responseFormat isn't specified, the "accept" HTTP header shall be used to determine the format of the response. If the "accept" HTTP header isn't specified as well, the default response format shall be in json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Empty

  400 Bad Request

  Bad request. Some of the inputs provided to the request aren't valid.

  401 Unauthorized

  Not authenticated. The user session isn't valid.

  403 Forbidden

  The user isn't authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. Additional details will be contained on the server logs.

  Apply quick checkout profile

  PUT /store/{storeId}/cart/@self/applyCheckoutProfile

  Tags: Cart

  Applies the quick checkout profile to the shopping cart.

  Request body required for apply checkout profile. com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Get purchase order information

  GET /store/{storeId}/cart/@self/buyer_purchase_order/{buyerPurchaseOrderId}

  Tags: Cart

  Gets buyer purchase order information for the specified buyer purchase order ID.

  storeId	The store identifier.	path	string
  buyerPurchaseOrderId	The buyer purchase order identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  profileName	Profile name. Profiles determine the subset of data returned by a query.	query	string

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.payment.beans.BuyerPurchaseOrderDataBean_IBM_BuyerPurchaseOrder_Summary

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Check out

  POST /store/{storeId}/cart/@self/checkout

  Tags: Cart

  Checks out the shopping cart.

  The request object for checkout. com.ibm.commerce.rest.order.handler.CartHandler$CheckoutRequest

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

  {
      "orderId": "25206"
  }
                                              

  com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Delete order item

  PUT /store/{storeId}/cart/@self/delete_order_item

  Tags: Cart

  Deletes the specified order item from the order.

  The request body for deleting an order item. com.ibm.commerce.rest.order.handler.CartHandler$DeleteOrderItemRequest

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Get terms and conditions

  GET /store/{storeId}/cart/@self/pattribute/{initKey_referenceNumber}

  Tags: Cart

  Gets payment attribute order information for the terms and conditions ID.

  storeId	The store identifier.	path	string
  initKey_referenceNumber	The referenceNumber key of the access bean.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  profileName	Profile name. Profiles determine the subset of data returned by a query.	query	string

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.utf.beans.PAttributeDataBean_IBM_PAttribute_Detailed

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Add payment instructions

  DELETE /store/{storeId}/cart/@self/payment_instruction

  Tags: Payment Instruction

  Adds payment instructions to the shopping cart.

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Empty

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Delete payment instructions

  GET /store/{storeId}/cart/@self/payment_instruction

  Tags: Payment Instruction

  Deletes all payment instructions from the shopping cart.

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  currency	The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.	query	string , x ∈ { JPY , CNY , BRL , EUR , RON , RUB , PLN , USD , KRW , TWD , CAD , GBP }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. cart-payment_instruction

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Get payment instructions

  POST /store/{storeId}/cart/@self/payment_instruction

  Tags: Payment Instruction

  Gets payment instructions for the shopping cart.

  application/json application/xml

  The body data required for the REST method. cart-payment_instruction

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  No response was specified. Example for application/json

  {
      "orderId": "25206",
      "paymentInstruction": [
          {
              "piId": "14018"
          }
      ]
  }
                                              

  com.ibm.commerce.rest.order.handler.PaymentInstructionHandler$PaymentInstructionList

  201 Created

  The requested resource has been created.

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Update payment instructions

  PUT /store/{storeId}/cart/@self/payment_instruction

  Tags: Payment Instruction

  Updates payment instructions in the shopping cart.

  application/json application/xml

  Request body. cart-payment_instruction

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.rest.order.handler.PaymentInstructionHandler$PaymentInstructionList

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Process punch-out call back request

  POST /store/{storeId}/cart/@self/payment_instruction/callback

  Tags: Payment Instruction

  Processes punch-out call back requests.

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.payment.punchout.commands.PunchoutPaymentCallBackCmd

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Get punch-out payment instructions

  GET /store/{storeId}/cart/@self/payment_instruction/punchoutPaymentInfo

  Tags: Payment Instruction

  Gets payment instruction for the punch-out payment.

  storeId	The store identifier.	path	string
  orderId	The order identifier.	query	string
  piId	The payment instruction identifier.	query	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  currency	The currency code to use for example, currency=USD. If no currency code is specified, the store default currency is used.	query	string , x ∈ { JPY , CNY , BRL , EUR , RON , RUB , PLN , USD , KRW , TWD , CAD , GBP }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. cart-payment_instruction

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Process payment punch-out request

  POST /store/{storeId}/cart/@self/payment_instruction/repay

  Tags: Payment Instruction

  Processes the punch-out payment requests.

  storeId	The store identifier.	path	string
  orderId	The order identifier.	query	string
  piId	The payment instruction identifier.	query	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Empty

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Get sensitive data mask information

  GET /store/{storeId}/cart/@self/payment_instruction/sensitive_data_mask_by_plain_string/{plainString}

  Tags: Payment Instruction

  Gets sensitive data mask information for plain string.

  storeId	The store identifier.	path	string
  plainString	The plain string for the sensitive data.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  profileName	Profile name. Profiles determine the subset of data returned by a query.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

  {
      "resultList": [
          {
              "maskChar": "*",
              "maskedString": "************1111",
              "plainLength": -4
          }
      ]
  }
                                              

  com.ibm.commerce.edp.beans.EDPSensitiveDataMaskHelperDataBean_IBM_sensitiveDataMaskByPlainString

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Delete payment instructions

  DELETE /store/{storeId}/cart/@self/payment_instruction/{paymentInstruction_id}

  Tags: Payment Instruction

  Deletes payment instructions from the shopping cart.

  storeId	The store identifier.	path	string
  paymentInstruction_id	Payment instruction identifier to delete.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Empty

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Get payment policy list

  GET /store/{storeId}/cart/@self/payment_policy_list

  Tags: Cart

  Lists payment policies for the store.

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  profileName	Profile name. Profiles determine the subset of data returned by a query.	query	string

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

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

  com.ibm.commerce.payment.beans.PaymentPolicyListDataBean_IBM_PaymentPolicyList_Detailed

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Prepare for checkout

  PUT /store/{storeId}/cart/@self/precheckout

  Tags: Cart

  Prepares the shopping cart for checkout. This method must be called before the checkout service.

  The request object for preCheckout. com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

  {
      "orderId": "25206"
  }
                                              

  com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Renew inventory status

  POST /store/{storeId}/cart/@self/renew_order_items

  Tags: Cart

  Renews inventory status, price and address ID for order items. Remove order items that are out of stock.

  storeId		path	string
  responseFormat		query	string

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.orderitems.commands.OrderItemDisplayCmd

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Get shipping instructions

  GET /store/{storeId}/cart/@self/shipping_info

  Tags: Shipping Info

  Gets shipping information for the shopping cart.

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  pageNumber	Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.	query	integer (int32)
  pageSize	Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.	query	integer (int32)
  langId	Language identifier. If not specified, the "locale" parameter is used. If "locale" is not specified, then the store default language is used.	query	string , x ∈ { -1 , -2 , -3 , -4 , -5 , -6 , -7 , -8 , -9 , -10 , -20 , -21 , -22 , -23 }
  locale	The locale to use for example, locale=en_US. If the "langId" parameter is specified, the "locale" parameter is ignored. If no locale is specified, the store default locale is used.	query	string , x ∈ { en_US , fr_FR , de_DE , it_IT , es_ES , pt_BR , zh_CN , zh_TW , ko_KR , ja_JP , ru_RU , ro_RO , pl_PL , ar_EG }
  forUser	User name to act on behalf of.	query	string
  forUserId	User identifier to act on behalf of.	query	string

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. cart-shipping_info

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Update shipping information

  PUT /store/{storeId}/cart/@self/shipping_info

  Tags: Shipping Info

  Updates shipping information for the shopping cart.

  application/json application/xml

  Request body. com.ibm.commerce.rest.order.handler.ShippingInfoHandler$UpdateShippingInfoBodyDescription

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  forUser	User name to act on behalf of.	query	string
  forUserId	User identifier to act on behalf of.	query	string

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

  {
      "orderId": "25206",
      "orderItem": [
          {
              "orderItemId": "85205"
          }
      ]
  }
                                              

  cart-cartUpdate

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Update dynamic kit configuration

  PUT /store/{storeId}/cart/@self/update_configuration_in_cart

  Tags: Cart

  Updates a dynamic kit configuration in the shopping cart.

  application/json application/xml

  The request body for updating a dynamic kit configuration in the cart. com.ibm.commerce.rest.order.handler.CartHandler$UpdateConfigurationInCartRequest

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.rest.order.handler.CartHandler$UpdateConfigurationInCartRequest

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Update order items

  PUT /store/{storeId}/cart/@self/update_order_item

  Tags: Cart

  Updates one or more order items in the shopping cart.

  application/json application/xml

  Update order item body. com.ibm.commerce.rest.order.handler.CartHandler$UpdateOrderItemBodyDescription

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

  {
      "orderId": "25207"
  }
                                              

  com.ibm.commerce.rest.order.handler.CartHandler$OrderWithOrderItemContainer

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Update reward option

  PUT /store/{storeId}/cart/@self/update_reward_option

  Tags: Cart

  Updates the reward option.

  application/json application/xml

  The request body for updating a reward option. com.ibm.commerce.rest.order.handler.CartHandler$RewardChoiceUpdateRequest

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.rest.order.handler.CartHandler$RewardChoiceUpdateRequest

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Get billing address

  GET /store/{storeId}/cart/@self/usable_billing_address/{orderId}

  Tags: Cart

  Gets billing address information for the specified order ID.

  storeId	The store identifier.	path	string
  orderId	The order ID.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  profileName	Profile name. Profiles determine the subset of data returned by a query.	query	string
  paymentTCId	The payment Term & Condition identifier for this payment instruction.	query	string

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Get payment information

  GET /store/{storeId}/cart/@self/usable_payment_info

  Tags: Cart

  Gets payment information for the shopping cart.

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  pageNumber	Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.	query	integer (int32)
  pageSize	Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.	query	integer (int32)
  orderId	The order ID.	query	string

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

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

  cart-usable_payment_info

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Get shipping information

  GET /store/{storeId}/cart/@self/usable_shipping_info

  Tags: Shipping Info

  Gets shipping information for the shopping cart.

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  pageNumber	Page number. Valid values are positive integers starting at 1. Use pageNumber with pageSize.	query	integer (int32)
  pageSize	Page size. Used to limit the amount of data returned by a query. Valid values are integers starting with 1. Use pageSize with pageNumber.	query	integer (int32)
  orderId	The order ID.	query	string

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

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

  cart-usable_shipping_info

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Gets usable shipping information for the shopping cart by address.

  GET /store/{storeId}/cart/@self/usable_shipping_mode

  Tags: cart

  storeId	The store identifier.	path	string , x ∈ { 0 , 10001 , 10051 , 10101 , 10151 , 10201 , 10202 }
  responseFormat	The response format. If the request has an input body, that body must also use the format specified in "responseFormat". Valid values include "json" and "xml" without the quotes. If the responseFormat isn't specified, the "accept" HTTP header shall be used to determine the format of the response. If the "accept" HTTP header isn't specified as well, the default response format shall be in json.	query	string , x ∈ { xml , json }
  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 (int32)
  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 (int32)
  orderId	The order ID.	query	string

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. cart-usable_shipping_info

  400 Bad Request

  Bad request. Some of the inputs provided to the request aren't valid.

  401 Unauthorized

  Not authenticated. The user session isn't valid.

  403 Forbidden

  The user isn't authorized to perform the specified request.

  404 Not Found

  The specified resource couldn't be found.

  500 Internal Server Error

  Internal server error. Additional details will be contained on the server logs.

  Calculate order price

  POST /store/{storeId}/cart/calculate

  Tags: Cart

  Calculates the price of the order.

  The body data required for the REST method. com.ibm.commerce.rest.order.handler.CartHandler$CalculateOrderRequest

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

  {
      "orderId": [
          "14029"
      ],
      "viewTaskName": "RedirectView"
  }
                                              

  Empty

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Copy order

  POST /store/{storeId}/cart/copy_order

  Tags: Cart

  Copies the order into a new order.

  The request object for copy order. com.ibm.commerce.rest.order.handler.CartHandler$CopyOrderRequest

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

  {
      "orderId": [
          "25040"
      ],
      "viewTaskName": "RedirectView"
  }
                                              

  com.ibm.commerce.rest.order.handler.CartHandler$CopyOrderRequest

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Create order

  POST /store/{storeId}/cart/create_order

  Tags: Cart

  Creates an order.

  The body data required for the REST method. com.ibm.commerce.rest.order.handler.CartHandler$CreateOrderRequest

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  description	The description for the order.	query	string

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

  {
      "outOrderId": "25041",
      "redirecturl": "",
      "viewTaskName": "RedirectView"
  }
                                              

  Empty

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Move order items

  PUT /store/{storeId}/cart/move_order_item

  Tags: Cart

  Moves order items from one order to another.

  The request body for MoveOrderItem. com.ibm.commerce.rest.order.handler.CartHandler$OrderItemMoveRequest

  storeId	The store identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

  {
      "orderId": [
          "14029",
          "14029"
      ],
      "redirecturl": "RESTOrderCalculate?URL=http://localhost/webapp/wcs/stores/servlet/en/aurora?calculationUsageId=-1&calculationUsageId=-2&deleteCartCookie=true",
      "viewTaskName": "RedirectView"
  }
                                              

  com.ibm.commerce.rest.order.handler.CartHandler$OrderItemMoveRequest

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Get shipping modes

  GET /store/{storeId}/cart/shipping_modes

  Tags: Shipping Info

  Gets shipping modes for the shopping cart.

  storeId	The store identifier.	path	string
  locale	The locale to use for example, locale=en_US. If the "langId" parameter is specified, the "locale" parameter is ignored. If no locale is specified, the store default locale is used.	query	string , x ∈ { en_US , fr_FR , de_DE , it_IT , es_ES , pt_BR , zh_CN , zh_TW , ko_KR , ja_JP , ru_RU , ro_RO , pl_PL , ar_EG }
  langId	Language identifier. If not specified, the "locale" parameter is used. If "locale" is not specified, then the store default language is used.	query	string , x ∈ { -1 , -2 , -3 , -4 , -5 , -6 , -7 , -8 , -9 , -10 , -20 , -21 , -22 , -23 }
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

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

  com.ibm.commerce.rest.order.handler.CartHandler$ShippingModes

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Lock cart (CSR)

  POST /store/{storeId}/cart/{cartId}/lock

  Tags: Cart

  Allows the CSR to lock the shopping cart.

  storeId	The store identifier.	path	string
  cartId	Order identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

  {
      "orderId": "25012"
  }
                                              

  com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Lock cart (buyer administrator)

  POST /store/{storeId}/cart/{cartId}/lockOnBehalf

  Tags: Cart

  Allows the buyer administrator or CSR to lock the shopping cart. The administrator must have already established a session to act on behalf of a user.

  storeId	The store identifier.	path	string
  cartId	Order identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  forUser	User name to act on behalf of.	query	string
  forUserId	User identifier to act on behalf of.	query	string

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Unlock cart (CSR)

  POST /store/{storeId}/cart/{cartId}/unlock

  Tags: Cart

  Unlocks the shopping cart by a CSR.

  storeId	The store identifier.	path	string
  cartId	Order identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Unlock cart (buyer administrator)

  POST /store/{storeId}/cart/{cartId}/unlockOnBehalf

  Tags: Cart

  Allows the buyer administrator or CSR to unlock the shopping cart. The administrator must have already established a session to act on behalf of a user.

  storeId	The store identifier.	path	string
  cartId	Order identifier.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  forUser	User name to act on behalf of.	query	string
  forUserId	User identifier to act on behalf of.	query	string

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Calculate order price

  POST /store/{storeId}/cart/{orderId}/calculate

  Tags: Cart

  Calculates the price of the order.

  The request object for calculate order. com.ibm.commerce.rest.order.handler.CartHandler$CalculateOrderRequest

  storeId	The store identifier.	path	string
  orderId	The order ID.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Empty

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Cancel order

  DELETE /store/{storeId}/cart/{orderId}/cancel_order

  Tags: Cart

  Cancels the specified order.

  storeId	The store identifier.	path	string
  orderId	The order ID.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  forcedCancel	This parameter is used to cancel an order that has deposited payment.	query	string , x ∈ { true , false }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

  {
      "viewTaskName": "RedirectView"
  }
                                              

  Empty

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Cancel order (CSR)

  DELETE /store/{storeId}/cart/{orderId}/csrcancel_order

  Tags: Cart

  Allows the CSR to cancel the specified order.

  storeId	The store identifier.	path	string
  orderId	The order ID.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  forcedCancel	This parameter is used to cancel an order that has deposited payment.	query	string , x ∈ { true , false }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Empty

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Cancel order (CSR on behalf of)

  DELETE /store/{storeId}/cart/{orderId}/csrcancel_order_onbehalf

  Tags: Cart

  Allows the CSR to cancel the specific order on behalf of a shopper.

  storeId	The store identifier.	path	string
  orderId	The order ID.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  forcedCancel	This parameter is used to cancel an order that has deposited payment.	query	string , x ∈ { true , false }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Empty

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Create scheduled order

  POST /store/{storeId}/cart/{orderId}/schedule_order

  Tags: Cart

  Creates a scheduled order. The order is related to a scheduled job.

  The request object for scheduleOrder. com.ibm.commerce.rest.order.handler.CartHandler$OrderScheduleRequest

  storeId	The store identifier.	path	string
  orderId	The order ID.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. com.ibm.commerce.rest.order.handler.CartHandler$OrderScheduleRequest

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Set pending order

  POST /store/{storeId}/cart/{orderId}/set_pending_order

  Tags: Cart

  Sets the specified order as the pending order.

  The request object for SetPendingOrder. com.ibm.commerce.rest.order.handler.CartHandler$SetPendingOrderRequest

  storeId	The store identifier.	path	string
  orderId	The order ID.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

  {
      "orderId": [
          "25039"
      ],
      "viewTaskName": "RedirectView"
  }
                                              

  com.ibm.commerce.rest.order.handler.CartHandler$SetPendingOrderRequest

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Get shipping charge

  GET /store/{storeId}/cart/{orderId}/usable_ship_charges_by_ship_mode

  Tags: Shipping Info

  Gets usable shipping charge information for the specified order ID.

  storeId	The store identifier.	path	string
  orderId	The order ID.	path	string
  responseFormat	The response format. Valid values are json and xml. If the request contains an input body, it must use the format specified in responseFormat. If the responseFormat is not specified, the accept HTTP header determines the format of the response. If the accept HTTP header is not specified then default response format is json.	query	string , x ∈ { xml , json }
  profileName	Profile name. Profiles determine the subset of data returned by a query.	query	string

  application/json application/xml application/xhtml+xml application/atom+xml

  200 OK

  The requested completed successfully. Example for application/json

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

  com.ibm.commerce.order.beans.UsableShipChargesAndAccountByShipModeDataBean_IBM_usableShipChargesByShipMode

  400 Bad Request

  Bad request. The request could not be understood by the server due to malformed syntax.

  401 Unauthorized

  Not authenticated. The user session is not valid.

  403 Forbidden

  The user is not authorized to perform the specified request.

  404 Not Found

  The specified resource could not be found.

  500 Internal Server Error

  Internal server error. For details, see the server log files.

  Schema definitions

  cart-Adjustment: object

  code: string

  description: string

  language: string

  displayLevel: string

  currency: string

  amount: string (double)

  usage: string

  userDataField: object[]

  cart-Adjustment.userDataField

  descriptionLanguage: string

  cart-Adjustment.userDataField: object

  value: string

  key: string

  cart-BillingAddress: object

  addressType: string

  addressLine: string[]

  string

  personTitle: string

  primary: string

  email2: string

  email1: string

  city: string

  middleName: string

  geographicalTaxCode: string

  state: string

  internalOfficeAddress: string

  fax2: string

  fax1: string

  postalCode: string

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

  phone1Type: string

  nickName: string

  billing_address_id: string

  phone2Type: string

  phone2: string

  businessTitle: string

  phone1: string

  zipCode: string

  bestCallingTime: string

  mobilePhone1Country: string

  phone2Publish: string

  mobilePhone1: string

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

  organizationUnitName: string

  organizationName: string

  language: string

  firstName: string

  lastName: string

  geographicalShippingCode: string

  stateOrProvinceName: string

  phone1Publish: string

  attributes: object[]

  cart-BillingAddress.attributes

  country: string

  cart-BillingAddress.attributes: object

  attrKey: string

  attrValue: string

  cart-cart: object

  Order: object[]

  cart-cart_item

  cart-cart_item: object

  orderItem: object[]

  cart-cartItem

  cSRComments: object[]

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

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

  adjustmentRequirement: object[]

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

  orderVersion: string

  orderStatus: cart-OrderStatus

  quoteID: string

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

  orgDistinguishedName: string

  paymentInstruction: object[]

  cart-PaymentInstruction

  orderIdentifier: cart-OrderIdentifier

  comments: string

  placedDate: string

  storeUniqueID: string

  buyerId: string

  userDataField: object[]

  cart-cart_item.userDataField

  promotionCode: object[]

  cart-cart_item.promotionCode

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

  orderId: string

  shipAsComplete: string

  rewardOption: object[]

  cart-rewardOption

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

  buyerPONumber: string

  orderAmount: cart-OrderAmount

  orgUniqueID: string

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

  orderDescription: string

  couponCode: object[]

  cart-CouponCode

  orderExtendAttribute: object[]

  cart-cart_item.orderExtendAttribute

  paymentStatus: string

  storeNameIdentifier: string

  lastUpdateDate: string

  buyerDistinguishedName: string

  financialTransaction: object[]

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

  storeOwnerID: string

  cart-cart_item.orderExtendAttribute: object

  attributeName: string

  attributeType: string

  attributeValue: string

  cart-cart_item.promotionCode: object

  associatedPromotion: object[]

  cart-cart_item.promotionCode.associatedPromotion

  code: string

  cart-cart_item.promotionCode.associatedPromotion: object

  description: string

  promotionId: string

  cart-cart_item.userDataField: object

  value: string

  key: string

  cart-cartItem: object

  timeReleased: string

  orderItemFulfillmentStatus: string

  externalOrderItemID: string

  adjustmentRequirement: object[]

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

  orderItemInventoryStatus: string

  comments: string

  orderItemExtendAttribute: object[]

  cart-cartItem.orderItemExtendAttribute

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

  UOM: string

  fulfillmentCenterName: string

  orderItemShippingInfo: cart-OrderItemShippingInfo

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

  availableDate: string

  createDate: string

  timeShipped: string

  offerID: string

  fulfillmentCenterId: string

  userDataField: object[]

  cart-cartItem.userDataField

  productId: string

  expectedShipDate: string

  itemAttributes: object[]

  cart-cartItem.itemAttributes

  ownerID: string

  correlationGroup: string

  contractId: string

  orderItemStatus: string

  orderItemId: string

  configurationID: string

  orderItemAmount: cart-OrderItemAmount

  lastUpdateDate: string

  orderItemComponent: object[]

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

  partNumber: string

  quantity: string (double)

  usableShippingChargePolicy: object[]

  cart-UsableShippingChargePolicy

  fulfillmentCenterOwnerId: string

  cart-cartItem.itemAttributes: object

  attrName: string

  attrValue: string

  cart-cartItem.orderItemExtendAttribute: object

  attributeName: string

  attributeType: string

  attributeValue: string

  cart-cartItem.userDataField: object

  value: string

  key: string

  cart-cartUpdate: object

  Order: object[]

  cart-cartUpdate_item

  cart-cartUpdate_item: object

  orderId: string

  shipAsComplete: string

  orderComment: string

  orderItem: object[]

  cart-cartUpdate_item.orderItem

  orderDescription: string

  orderExtendAttribute: object[]

  cart-cartUpdate_item.orderExtendAttribute

  userDataField: object[]

  cart-cartUpdate_item.userDataField

  cart-cartUpdate_item.orderExtendAttribute: object

  attributeName: string

  attributeType: string

  attributeValue: string

  cart-cartUpdate_item.orderItem: object

  comment: string

  fulfillmentCenterName: string

  orderItemId: string

  quantity: string (double)

  fulfillmentCenterId: string

  orderItemExtendAttribute: object[]

  cart-cartUpdate_item.orderItem.orderItemExtendAttribute

  itemAttributes: object[]

  cart-cartUpdate_item.orderItem.itemAttributes

  partNumber: string

  productId: string

  userDataField: object[]

  cart-cartUpdate_item.orderItem.userDataField

  UOM: string

  contractId: string

  cart-cartUpdate_item.orderItem.itemAttributes: object

  attrName: string

  attrValue: string

  cart-cartUpdate_item.orderItem.orderItemExtendAttribute: object

  attributeName: string

  attributeType: string

  attributeValue: string

  cart-cartUpdate_item.orderItem.userDataField: object

  value: string

  key: string

  cart-cartUpdate_item.userDataField: object

  value: string

  key: string

  cart-CouponCode: object

  status: string

  code: string

  couponId: string

  expirationDateTime: string

  effectiveDateTime: string

  promotion: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType

  userDataField: object[]

  cart-CouponCode.userDataField

  description: object[]

  com.ibm.commerce.order.facade.datatypes.CouponDescriptionType

  cart-CouponCode.userDataField: object

  value: string

  key: string

  cart-OrderAmount: object

  grandTotal: string (double)

  adjustment: object[]

  cart-Adjustment

  totalShippingTax: string (double)

  totalSalesTaxCurrency: string

  totalShippingTaxCurrency: string

  totalProductPrice: string (double)

  totalTaxByTaxCategory: object[]

  cart-OrderAmount.totalTaxByTaxCategory

  totalProductPriceCurrency: string

  grandTotalCurrency: string

  totalAdjustment: string (double)

  totalShippingChargeCurrency: string

  totalSalesTax: string (double)

  totalAdjustmentCurrency: string

  userDataField: object[]

  cart-OrderAmount.userDataField

  genericTotal: object[]

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

  totalShippingCharge: string (double)

  cart-OrderAmount.totalTaxByTaxCategory: object

  currency: string

  value: string (double)

  taxCategoryCode: string

  cart-OrderAmount.userDataField: object

  value: string

  key: string

  cart-OrderIdentifier: object

  customerOrderNumber: string

  orderId: string

  externalOrderID: string

  cart-OrderItemAmount: object

  unitQuantity: string (double)

  salesTaxCurrency: string

  shippingTaxCurrency: string

  shippingCharge: string (double)

  unitPrice: string (double)

  shippingTax: string (double)

  taxByTaxCategory: object[]

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

  adjustment: object[]

  cart-Adjustment

  unitUom: string

  currency: string

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

  userDataField: object[]

  cart-OrderItemAmount.userDataField

  alternativeCurrencyPrice: object[]

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

  priceOverride: string

  genericTotal: object[]

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

  freeGift: string

  shippingChargeCurrency: string

  orderItemPrice: string (double)

  salesTax: string (double)

  cart-OrderItemAmount.userDataField: object

  value: string

  key: string

  cart-OrderItemShippingInfo: object

  shippingAddress: cart-ShippingAddress

  requestedShipDate: string

  shippingChargeType: string

  shipInstruction: string

  shipTieCode: string

  shippingChargePolicyID: string

  shippingCarrierAccountNumber: string

  isExpedited: string

  shipCarrAccntNum: string

  userDataField: object[]

  cart-OrderItemShippingInfo.userDataField

  shippingMode: cart-ShippingMode

  physicalStoreId: string

  physicalStoreExternalId: string

  cart-OrderItemShippingInfo.userDataField: object

  value: string

  key: string

  cart-OrderShippingInfo: object

  userDataField: object[]

  cart-OrderShippingInfo.userDataField

  requestedShipDate: string

  shipModeId: string

  addressId: string

  pysicalStoreId: string

  cart-OrderShippingInfo.userDataField: object

  value: string

  key: string

  cart-OrderStatus: object

  xstat_: object[]

  java.util.Map$Entry

  locked: string

  prepareIndicator: string

  buyerApprovalStatus: string

  editable: string

  orderStatus: string

  blocked: string

  cart-payment_instruction: object

  orderId: string

  userDataField: object[]

  cart-payment_instruction.userDataField

  paymentInstruction: object[]

  cart-payment_instruction.paymentInstruction

  paymentStatus: string

  financialTransaction: object[]

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

  cart-payment_instruction.paymentInstruction: object

  addressType: string

  addressLine: string[]

  string

  piId: string

  refundAllowed: string

  personTitle: string

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

  primary: string

  payMethodId: string

  paymentRule: string

  piDescription: string

  email2: string

  piAmount: string (double)

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

  city: string

  piCurrency: string

  sequenceNumber: string (int64)

  piStatus: string

  middleName: string

  geographicalTaxCode: string

  priority: string (int64)

  protocolData: object[]

  cart-payment_instruction.paymentInstruction.protocolData

  state: string

  fax2: string

  fax1: string

  postalCode: string

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

  email1: string

  internalOfficeAddress: string

  billing_address_id: string

  paymentTermConditionId: string

  phone2Type: string

  nickName: string

  phone2: string

  businessTitle: string

  phone1: string

  zipCode: string

  bestCallingTime: string

  mobilePhone1Country: string

  piLanguage: string

  phone2Publish: string

  mobilePhone1: string

  phone1Type: string

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

  organizationUnitName: string

  organizationName: string

  language: string

  firstName: string

  lastName: string

  geographicalShippingCode: string

  stateOrProvinceName: string

  phone1Publish: string

  attributes: object[]

  cart-payment_instruction.paymentInstruction.attributes

  country: string

  userDataField: object[]

  cart-payment_instruction.paymentInstruction.userDataField

  cart-payment_instruction.paymentInstruction.attributes: object

  attrKey: string

  attrValue: string

  cart-payment_instruction.paymentInstruction.protocolData: object

  name: string

  value: string

  cart-payment_instruction.paymentInstruction.userDataField: object

  value: string

  key: string

  cart-payment_instruction.userDataField: object

  value: string

  key: string

  cart-PaymentInstruction: object

  paymentTermConditionId: string

  paymentRule: string

  sequenceNumber: string (int64)

  piId: string

  piStatus: string

  protocolData: object[]

  cart-PaymentInstruction.protocolData

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

  refundAllowed: string

  piCurrency: string

  priority: string (int64)

  payMethodId: string

  billingAddress: cart-BillingAddress

  piDescription: string

  userDataField: object[]

  cart-PaymentInstruction.userDataField

  piLanguage: string

  piAmount: string (double)

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

  cart-PaymentInstruction.protocolData: object

  name: string

  value: string

  cart-PaymentInstruction.userDataField: object

  value: string

  key: string

  cart-rewardOption: object

  code: string

  adjustmentLanguage: string

  adjustmentAmount: string (double)

  calculationCodeID: cart-rewardOption.calculationCodeID

  adjustment: cart-rewardOption.adjustment

  giftSet: cart-rewardOption.giftSet

  rewardSpecGiftItem: object[]

  cart-rewardOption.rewardSpecGiftItem

  adjustmentCode: string

  adjustmentDescription: string

  adjustmentUsage: string

  rewardChoice: cart-rewardOption.rewardChoice

  adjustmentCurrency: string

  usage: string

  userData: cart-rewardOption.userData

  description: cart-rewardOption.description

  rewardOptionIdentifier: cart-rewardOption.rewardOptionIdentifier

  rewardOptionExternalId: string

  promotionType: string

  isPromotionCodeRequired: boolean

  giftSetSpecification: cart-rewardOption.giftSetSpecification

  adjustmentDisplayLevel: string

  displayLevel: string

  amount: cart-rewardOption.amount

  rewardSpecification: cart-rewardOption.rewardSpecification

  rewardChoiceGiftItem: object[]

  cart-rewardOption.rewardChoiceGiftItem

  rewardSpecMaxQuantity: string (double)

  rewardOptionId: string

  rewardSpecMaxQuantityUom: string

  cart-rewardOption.adjustment: object

  userData: cart-rewardOption.adjustment.userData

  code: string

  description: cart-rewardOption.adjustment.description

  displayLevel: string

  calculationCodeID: cart-rewardOption.adjustment.calculationCodeID

  amount: cart-rewardOption.adjustment.amount

  promotionType: string

  usage: string

  isPromotionCodeRequired: boolean

  cart-rewardOption.adjustment.amount: object

  currency: string

  value: number (double)

  cart-rewardOption.adjustment.calculationCodeID: object

  calculationCodeExternalIdentifier: cart-rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier

  uniqueID: string

  cart-rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier: object

  calculationUsageID: string

  code: string

  storeIdentifier: cart-rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier

  cart-rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier: object

  uniqueID: string

  externalIdentifier: cart-rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier

  cart-rewardOption.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier: object

  ownerID: string

  nameIdentifier: string

  cart-rewardOption.adjustment.description: object

  value: string

  language: string

  cart-rewardOption.adjustment.userData: object

  userDataField: object[]

  cart-rewardOption.adjustment.userData.userDataField

  cart-rewardOption.adjustment.userData.userDataField: object

  value: string

  key: string

  cart-rewardOption.amount: object

  currency: string

  value: number (double)

  cart-rewardOption.calculationCodeID: object

  calculationCodeExternalIdentifier: cart-rewardOption.calculationCodeID.calculationCodeExternalIdentifier

  uniqueID: string

  cart-rewardOption.calculationCodeID.calculationCodeExternalIdentifier: object

  calculationUsageID: string

  code: string

  storeIdentifier: cart-rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier

  cart-rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier: object

  uniqueID: string

  externalIdentifier: cart-rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier

  cart-rewardOption.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier: object

  ownerID: string

  nameIdentifier: string

  cart-rewardOption.description: object

  value: string

  language: string

  cart-rewardOption.giftSet: object

  giftItem: object[]

  cart-rewardOption.giftSet.giftItem

  cart-rewardOption.giftSet.giftItem: object

  catalogEntryIdentifier: cart-rewardOption.giftSet.giftItem.catalogEntryIdentifier

  quantity: cart-rewardOption.giftSet.giftItem.quantity

  cart-rewardOption.giftSet.giftItem.catalogEntryIdentifier: object

  uniqueID: string

  externalIdentifier: cart-rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier

  cart-rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier: object

  ownerID: string

  partNumber: string

  storeIdentifier: cart-rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier

  cart-rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier: object

  uniqueID: string

  externalIdentifier: cart-rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier

  cart-rewardOption.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object

  ownerID: string

  nameIdentifier: string

  cart-rewardOption.giftSet.giftItem.quantity: object

  value: number (double)

  uom: string

  cart-rewardOption.giftSetSpecification: object

  maximumQuantity: cart-rewardOption.giftSetSpecification.maximumQuantity

  giftItem: object[]

  cart-rewardOption.giftSetSpecification.giftItem

  cart-rewardOption.giftSetSpecification.giftItem: object

  catalogEntryIdentifier: cart-rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier

  quantity: cart-rewardOption.giftSetSpecification.giftItem.quantity

  cart-rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier: object

  uniqueID: string

  externalIdentifier: cart-rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier

  cart-rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier: object

  ownerID: string

  partNumber: string

  storeIdentifier: cart-rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier

  cart-rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier: object

  uniqueID: string

  externalIdentifier: cart-rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier

  cart-rewardOption.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object

  ownerID: string

  nameIdentifier: string

  cart-rewardOption.giftSetSpecification.giftItem.quantity: object

  value: number (double)

  uom: string

  cart-rewardOption.giftSetSpecification.maximumQuantity: object

  value: number (double)

  uom: string

  cart-rewardOption.rewardChoice: object

  userData: cart-rewardOption.rewardChoice.userData

  giftSet: cart-rewardOption.rewardChoice.giftSet

  cart-rewardOption.rewardChoice.giftSet: object

  giftItem: object[]

  cart-rewardOption.rewardChoice.giftSet.giftItem

  cart-rewardOption.rewardChoice.giftSet.giftItem: object

  catalogEntryIdentifier: cart-rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier

  quantity: cart-rewardOption.rewardChoice.giftSet.giftItem.quantity

  cart-rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier: object

  uniqueID: string

  externalIdentifier: cart-rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier

  cart-rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier: object

  ownerID: string

  partNumber: string

  storeIdentifier: cart-rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier

  cart-rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier: object

  uniqueID: string

  externalIdentifier: cart-rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier

  cart-rewardOption.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object

  ownerID: string

  nameIdentifier: string

  cart-rewardOption.rewardChoice.giftSet.giftItem.quantity: object

  value: number (double)

  uom: string

  cart-rewardOption.rewardChoice.userData: object

  userDataField: object[]

  cart-rewardOption.rewardChoice.userData.userDataField

  cart-rewardOption.rewardChoice.userData.userDataField: object

  value: string

  key: string

  cart-rewardOption.rewardChoiceGiftItem: object

  quantity: string (double)

  uom: string

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

  productId: string

  cart-rewardOption.rewardOptionIdentifier: object

  uniqueID: string

  externalIdentifier: string

  cart-rewardOption.rewardSpecGiftItem: object

  value: string (double)

  uom: string

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

  productId: string

  cart-rewardOption.rewardSpecification: object

  giftSetSpecification: cart-rewardOption.rewardSpecification.giftSetSpecification

  userData: cart-rewardOption.rewardSpecification.userData

  cart-rewardOption.rewardSpecification.giftSetSpecification: object

  maximumQuantity: cart-rewardOption.rewardSpecification.giftSetSpecification.maximumQuantity

  giftItem: object[]

  cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem

  cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem: object

  catalogEntryIdentifier: cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier

  quantity: cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem.quantity

  cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier: object

  uniqueID: string

  externalIdentifier: cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier

  cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier: object

  ownerID: string

  partNumber: string

  storeIdentifier: cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier

  cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier: object

  uniqueID: string

  externalIdentifier: cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier

  cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object

  ownerID: string

  nameIdentifier: string

  cart-rewardOption.rewardSpecification.giftSetSpecification.giftItem.quantity: object

  value: number (double)

  uom: string

  cart-rewardOption.rewardSpecification.giftSetSpecification.maximumQuantity: object

  value: number (double)

  uom: string

  cart-rewardOption.rewardSpecification.userData: object

  userDataField: object[]

  cart-rewardOption.rewardSpecification.userData.userDataField

  cart-rewardOption.rewardSpecification.userData.userDataField: object

  value: string

  key: string

  cart-rewardOption.userData: object

  userDataField: object[]

  cart-rewardOption.userData.userDataField

  cart-rewardOption.userData.userDataField: object

  value: string

  key: string

  cart-shipping_info: object

  orderId: string

  shipAsComplete: string

  userDataField: object[]

  cart-shipping_info.userDataField

  orderItem: object[]

  cart-ShippingInfoOrderItem

  orderShippingInfo: cart-OrderShippingInfo

  cart-shipping_info.userDataField: object

  value: string

  key: string

  cart-ShippingAddress: object

  addressType: string

  addressLine: string[]

  string

  addressId: string

  personTitle: string

  primary: string

  email2: string

  email1: string

  city: string

  middleName: string

  geographicalTaxCode: string

  state: string

  internalOfficeAddress: string

  fax2: string

  fax1: string

  postalCode: string

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

  phone1Type: string

  nickName: string

  phone2Type: string

  phone2: string

  businessTitle: string

  phone1: string

  zipCode: string

  bestCallingTime: string

  mobilePhone1Country: string

  phone2Publish: string

  mobilePhone1: string

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

  organizationUnitName: string

  organizationName: string

  language: string

  firstName: string

  lastName: string

  geographicalShippingCode: string

  stateOrProvinceName: string

  phone1Publish: string

  attributes: object[]

  cart-ShippingAddress.attributes

  country: string

  cart-ShippingAddress.attributes: object

  attrKey: string

  attrValue: string

  cart-ShippingInfoOrderItem: object

  userDataField: object[]

  cart-ShippingInfoOrderItem.userDataField

  orderItemId: string

  orderItemShippingInfo: cart-OrderItemShippingInfo

  cart-ShippingInfoOrderItem.userDataField: object

  value: string

  key: string

  cart-ShippingMode: object

  description: string

  language: string

  storeId: string

  shipModeLanguage: string

  trackingURL: string

  carrier: string

  shipModeDescription: string

  shipModeId: string

  shipModeCode: string

  cart-usable_payment_info: object

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

  orderId: string

  quoteID: string

  couponCode: object[]

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

  cSRComments: object[]

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

  externalOrderID: string

  usablePaymentInformation: object[]

  cart-UsablePaymentInformation

  comments: string

  adjustmentRequirement: object[]

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

  lastUpdateDate: string

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

  shipAsComplete: string

  buyerPONumber: string

  customerOrderNumber: string

  placedDate: string

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

  orderVersion: string

  promotionCode: object[]

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

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

  cart-usable_shipping_info: object

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

  orderId: string

  quoteID: string

  usableShippingAddress: object[]

  cart-usable_shipping_info.usableShippingAddress

  usableShippingMode: object[]

  cart-UsableShippingMode

  couponCode: object[]

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

  cSRComments: object[]

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

  rewardOption: object[]

  com.ibm.commerce.order.facade.datatypes.RewardOptionType

  externalOrderID: string

  comments: string

  adjustmentRequirement: object[]

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

  lastUpdateDate: string

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

  shipAsComplete: string

  buyerPONumber: string

  customerOrderNumber: string

  placedDate: string

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

  orderItem: object[]

  cart-UsableShippingInfoOrderItem

  orderVersion: string

  promotionCode: object[]

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

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

  cart-usable_shipping_info.usableShippingAddress: object

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

  nickName: string

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

  addressId: string

  cart-UsablePaymentInformation: object

  paymentTermConditionId: string

  description: string

  language: string

  protocolData: object[]

  cart-UsablePaymentInformation.protocolData

  usableBillingAddress: object[]

  cart-UsablePaymentInformation.usableBillingAddress

  paymentMethodName: string

  userDataField: object[]

  cart-UsablePaymentInformation.userDataField

  cart-UsablePaymentInformation.protocolData: object

  name: string

  value: string

  cart-UsablePaymentInformation.usableBillingAddress: object

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

  nickName: string

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

  addressId: string

  cart-UsablePaymentInformation.userDataField: object

  value: string

  key: string

  cart-UsableShippingAddress: object

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

  nickName: string

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

  addressId: string

  cart-UsableShippingChargePolicy: object

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

  type: string

  name: string

  uniqueID: string

  cart-UsableShippingInfoOrderItem: object

  orderItemId: string

  externalOrderItemID: string

  usableShippingAddress: object[]

  cart-UsableShippingAddress

  configurationID: string

  offerID: string

  comments: string

  adjustmentRequirement: object[]

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

  lastUpdateDate: string

  createDate: string

  usableShippingMode: object[]

  cart-UsableShippingMode

  userDataField: object[]

  cart-UsableShippingInfoOrderItem.userDataField

  correlationGroup: string

  usableShippingChargePolicy: object[]

  cart-UsableShippingChargePolicy

  UOM: string

  quantity: string (double)

  cart-UsableShippingInfoOrderItem.userDataField: object

  value: string

  key: string

  cart-UsableShippingMode: object

  description: string

  language: string

  storeId: string

  trackingURL: string

  carrier: string

  shipModeCode: string

  shipModeId: string

  userDataField: object[]

  cart-UsableShippingMode.userDataField

  cart-UsableShippingMode.userDataField: object

  value: string

  key: string

  com.ibm.commerce.edp.beans.EDPSensitiveDataMaskHelperDataBean_IBM_sensitiveDataMaskByPlainString: object

  maskedString: string

  plainLength: integer (int32)

  maskChar: string

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

  value: string

  language: string

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

  name: string

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

  currency: string

  value: number (double)

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

  distinguishedName: string

  uniqueID: string

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

  ownerID: string

  partNumber: string

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

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

  uniqueID: string

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

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

  ownerID: string

  nameIdentifier: string

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

  distinguishedName: string

  uniqueID: string

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

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

  identifier: string

  com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType: object

  calculationCodeIdentifier: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier

  uniqueID: string

  externalIdentifier: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.externalIdentifier

  com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier: object

  calculationCodeExternalIdentifier: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier.calculationCodeExternalIdentifier

  uniqueID: string

  com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier.calculationCodeExternalIdentifier: object

  calculationUsageID: string

  code: string

  storeIdentifier: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier

  com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier: object

  uniqueID: string

  externalIdentifier: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier

  com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.calculationCodeIdentifier.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier: object

  ownerID: string

  nameIdentifier: string

  com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.externalIdentifier: object

  storeIdentifier: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.externalIdentifier.storeIdentifier

  version: integer (int64)

  name: string

  revision: integer (int64)

  com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.externalIdentifier.storeIdentifier: object

  uniqueID: string

  externalIdentifier: com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier

  com.ibm.commerce.foundation.common.datatypes.PromotionIdentifierType.externalIdentifier.storeIdentifier.externalIdentifier: object

  ownerID: string

  nameIdentifier: string

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

  externalQuoteID: string

  uniqueID: string

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

  uniqueID: string

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

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

  ownerID: string

  nameIdentifier: string

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

  taxCategoryCode: string

  com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary: object

  resultList: object[]

  com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary.resultList

  com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary.resultList: object

  orderDataBean: com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary.resultList.orderDataBean

  isPersonalAddressAllowForBilling: boolean

  billingAddresses: object[]

  com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary.resultList.billingAddresses

  com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary.resultList.billingAddresses: object

  dataBeanKeyAddressId: string

  organizationNameURL: string

  stateURL: string

  fax1URL: string

  email2: string

  email1: string

  middleNameURL: string

  countryDisplayName: string

  middleName: string

  addressIdURL: string

  officeAddress: string

  phone1TypeURL: string

  address1: string

  address2: string

  address3: string

  zipCode: string

  mobilePhone1: string

  primaryURL: string

  organizationName: string

  billingCode: string

  addressField2URL: string

  storeIdURL: string

  addressId: string

  fax2URL: string

  statusURL: string

  billingCodeType: string

  email1URL: string

  stateProvDisplayName: string

  lastCreateURL: string

  state: string

  phone1Type: string

  phone2Type: string

  phone2: string

  businessTitle: string

  phone1: string

  firstNameURL: string

  createdTimestamp: string

  nickNameURL: string

  organizationUnitName: string

  billingCodeURL: string

  country: string

  storeDirectory: string

  countryURL: string

  cityURL: string

  organizationUnitNameURL: string

  primary: string

  publishPhone1URL: string

  city: string

  lastCreate: string

  addressField1: string

  phone2URL: string

  addressField3: string

  addressField2: string

  fax2: string

  fax1: string

  address1URL: string

  nickName: string

  urlURL: string

  officeAddressURL: string

  phone1URL: string

  email2URL: string

  mobilePhone1Country: string

  mobilePhone1URL: string

  addressTypeURL: string

  firstName: string

  lastName: string

  createdTime: string

  addressType: string

  address2URL: string

  personTitle: string

  lastNameURL: string

  phone2TypeURL: string

  address3URL: string

  businessTitleURL: string

  zipCodeURL: string

  addressField3URL: string

  billingCodeTypeURL: string

  packageSuppressionURL: string

  addressField1URL: string

  publishPhone1: string

  publishPhone2: string

  bestCallingTimeURL: string

  packageSuppression: string

  personTitleURL: string

  bestCallingTime: string

  isSelfAddress: boolean

  mobilePhone1CountryURL: string

  memberId: string

  status: string

  publishPhone2URL: string

  com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary.resultList.orderDataBean: object

  totalOrderItemsPrice: string

  totalProductPrice: number (double)

  actualShipDate: string (date)

  addressId: integer (int64)

  totalShippingTax: number (double)

  totalSize: integer (int32)

  type: string

  uniqueShippingAddresses: object[]

  com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary.resultList.orderDataBean.uniqueShippingAddresses

  surchargeAdjustmentTotal: number (double)

  totalTax: number (double)

  totalAdjustment: string

  billingAddressDataBean: com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary.resultList.orderDataBean.billingAddressDataBean

  totalPages: integer (int32)

  transferStatus: integer (int32)

  buschnId: integer (int32)

  totalProductPriceBySumUp: number (double)

  totalShippingCharge: number (double)

  com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary.resultList.orderDataBean.billingAddressDataBean: object

  dataBeanKeyAddressId: string

  organizationNameURL: string

  stateURL: string

  fax1URL: string

  email2: string

  email1: string

  middleNameURL: string

  countryDisplayName: string

  middleName: string

  addressIdURL: string

  officeAddress: string

  phone1TypeURL: string

  address1: string

  address2: string

  address3: string

  zipCode: string

  mobilePhone1: string

  primaryURL: string

  organizationName: string

  billingCode: string

  addressField2URL: string

  storeIdURL: string

  addressId: string

  fax2URL: string

  statusURL: string

  billingCodeType: string

  email1URL: string

  stateProvDisplayName: string

  lastCreateURL: string

  state: string

  phone1Type: string

  phone2Type: string

  phone2: string

  businessTitle: string

  phone1: string

  firstNameURL: string

  createdTimestamp: string

  nickNameURL: string

  organizationUnitName: string

  billingCodeURL: string

  country: string

  storeDirectory: string

  countryURL: string

  cityURL: string

  organizationUnitNameURL: string

  primary: string

  publishPhone1URL: string

  city: string

  lastCreate: string

  addressField1: string

  phone2URL: string

  addressField3: string

  addressField2: string

  fax2: string

  fax1: string

  address1URL: string

  nickName: string

  urlURL: string

  officeAddressURL: string

  phone1URL: string

  email2URL: string

  mobilePhone1Country: string

  mobilePhone1URL: string

  addressTypeURL: string

  firstName: string

  lastName: string

  createdTime: string

  addressType: string

  address2URL: string

  personTitle: string

  lastNameURL: string

  phone2TypeURL: string

  address3URL: string

  businessTitleURL: string

  zipCodeURL: string

  addressField3URL: string

  billingCodeTypeURL: string

  packageSuppressionURL: string

  addressField1URL: string

  publishPhone1: string

  publishPhone2: string

  bestCallingTimeURL: string

  packageSuppression: string

  personTitleURL: string

  bestCallingTime: string

  isSelfAddress: boolean

  mobilePhone1CountryURL: string

  memberId: string

  status: string

  publishPhone2URL: string

  com.ibm.commerce.order.beans.UsableBillingAddressListDataBean_IBM_UsableBillingAddressList_Summary.resultList.orderDataBean.uniqueShippingAddresses: object

  dataBeanKeyAddressId: string

  organizationNameURL: string

  stateURL: string

  fax1URL: string

  email2: string

  email1: string

  middleNameURL: string

  countryDisplayName: string

  middleName: string

  addressIdURL: string

  officeAddress: string

  phone1TypeURL: string

  address1: string

  address2: string

  address3: string

  zipCode: string

  mobilePhone1: string

  primaryURL: string

  organizationName: string

  billingCode: string

  addressField2URL: string

  storeIdURL: string

  addressId: string

  fax2URL: string

  statusURL: string

  billingCodeType: string

  email1URL: string

  stateProvDisplayName: string

  lastCreateURL: string

  state: string

  phone1Type: string

  phone2Type: string

  phone2: string

  businessTitle: string

  phone1: string

  firstNameURL: string

  createdTimestamp: string

  nickNameURL: string

  organizationUnitName: string

  billingCodeURL: string

  country: string

  storeDirectory: string

  countryURL: string

  cityURL: string

  organizationUnitNameURL: string

  primary: string

  publishPhone1URL: string

  city: string

  lastCreate: string

  addressField1: string

  phone2URL: string

  addressField3: string

  addressField2: string

  fax2: string

  fax1: string

  address1URL: string

  nickName: string

  urlURL: string

  officeAddressURL: string

  phone1URL: string

  email2URL: string

  mobilePhone1Country: string

  mobilePhone1URL: string

  addressTypeURL: string

  firstName: string

  lastName: string

  createdTime: string

  addressType: string

  address2URL: string

  personTitle: string

  lastNameURL: string

  phone2TypeURL: string

  address3URL: string

  businessTitleURL: string

  zipCodeURL: string

  addressField3URL: string

  billingCodeTypeURL: string

  packageSuppressionURL: string

  addressField1URL: string

  publishPhone1: string

  publishPhone2: string

  bestCallingTimeURL: string

  packageSuppression: string

  personTitleURL: string

  bestCallingTime: string

  isSelfAddress: boolean

  mobilePhone1CountryURL: string

  memberId: string

  status: string

  publishPhone2URL: string

  com.ibm.commerce.order.beans.UsableShipChargesAndAccountByShipModeDataBean_IBM_usableShipChargesByShipMode: object

  resultList: object[]

  com.ibm.commerce.order.beans.UsableShipChargesAndAccountByShipModeDataBean_IBM_usableShipChargesByShipMode.resultList

  com.ibm.commerce.order.beans.UsableShipChargesAndAccountByShipModeDataBean_IBM_usableShipChargesByShipMode.resultList: object

  shipChargesByShipMode: object[]

  com.ibm.commerce.order.beans.UsableShipChargesAndAccountByShipModeDataBean_IBM_usableShipChargesByShipMode.resultList.shipChargesByShipMode

  isShipChargesExist: boolean

  numberOfShipModes: integer (int32)

  com.ibm.commerce.order.beans.UsableShipChargesAndAccountByShipModeDataBean_IBM_usableShipChargesByShipMode.resultList.shipChargesByShipMode: object

  shipModeDesc: string

  shippingChargeTypes: object[]

  com.ibm.commerce.order.beans.UsableShipChargesAndAccountByShipModeDataBean_IBM_usableShipChargesByShipMode.resultList.shipChargesByShipMode.shippingChargeTypes

  carrierAccountNumber: string

  numberOfShipChargeTypes: integer (int32)

  shipModeId: string

  com.ibm.commerce.order.beans.UsableShipChargesAndAccountByShipModeDataBean_IBM_usableShipChargesByShipMode.resultList.shipChargesByShipMode.shippingChargeTypes: object

  policyName: string

  internalPolicyId: string

  policyDescription: string

  selected: boolean

  policyId: string

  carrAccntNumber: string

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

  adjustmentUsage: string

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

  adjustmentValue: string

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

  adjustmentCategory: string

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

  value: string

  language: string

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

  userDataField: object[]

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

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

  value: string

  key: string

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

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

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

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

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

  channelName: string

  uniqueID: string

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

  value: string

  language: string

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

  userDataField: object[]

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

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

  value: string

  key: string

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

  status: string

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

  code: string

  couponId: string

  expirationDateTime: string

  description: object[]

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

  effectiveDateTime: string

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

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

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

  shortDescription: string

  language: string

  longDescription: string

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

  userDataField: object[]

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

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

  value: string

  key: string

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

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

  uniqueID: string

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

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

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

  uniqueID: string

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

  calculationUsageID: string

  code: string

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

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

  uniqueID: string

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

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

  ownerID: string

  nameIdentifier: string

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

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

  version: integer (int64)

  name: string

  revision: integer (int64)

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

  uniqueID: string

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

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

  ownerID: string

  nameIdentifier: string

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

  userDataField: object[]

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

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

  value: string

  key: string

  com.ibm.commerce.order.facade.datatypes.CouponDescriptionType: object

  userData: com.ibm.commerce.order.facade.datatypes.CouponDescriptionType.userData

  shortDescription: string

  language: string

  longDescription: string

  com.ibm.commerce.order.facade.datatypes.CouponDescriptionType.userData: object

  userDataField: object[]

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

  com.ibm.commerce.order.facade.datatypes.CouponDescriptionType.userData.userDataField: object

  value: string

  key: string

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

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

  comment: string

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

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

  orderVersion: string

  creationDate: string

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

  reasonCode: string

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

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

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

  value: string

  language: string

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

  userDataField: object[]

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

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

  value: string

  key: string

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

  distinguishedName: string

  uniqueID: string

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

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

  identifier: string

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

  userDataField: object[]

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

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

  value: string

  key: string

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

  status: string

  lastUpdate: string

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

  requestTime: string

  trackingID: string

  paymentProtocolData: object[]

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

  referenceNumber: string

  transactionExtensionData: object[]

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

  paymentInstructionID: string

  merchantOrderNumber: string

  responseCode: string

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

  reasonCode: string

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

  avsCode: string

  expirationTime: string

  transactionType: string

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

  uniqueID: string

  externalIdentifier: string

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

  name: string

  value: string

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

  currency: string

  value: number (double)

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

  name: string

  value: string

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

  userDataField: object[]

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

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

  value: string

  key: string

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

  orderBlock: object[]

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

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

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

  resovled: boolean

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

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

  timeBlocked: string

  comments: string

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

  reasonCode: string

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

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

  reansonType: string

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

  value: string

  language: string

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

  userDataField: object[]

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

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

  value: string

  key: string

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

  userDataField: object[]

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

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

  value: string

  key: string

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

  userDataField: object[]

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

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

  value: string

  key: string

  com.ibm.commerce.order.facade.datatypes.OrderItemComponentType: object

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

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

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

  configurationID: string

  required: boolean

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

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

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

  uniqueID: string

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

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

  ownerID: string

  partNumber: string

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

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

  uniqueID: string

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

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

  ownerID: string

  nameIdentifier: string

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

  uniqueID: string

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

  value: number (double)

  uom: string

  com.ibm.commerce.order.facade.datatypes.OrderItemComponentType.unitPrice: object

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

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

  alternativeCurrencyPrice: object[]

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

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

  currency: string

  value: number (double)

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

  currency: string

  value: number (double)

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

  value: number (double)

  uom: string

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

  userDataField: object[]

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

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

  value: string

  key: string

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

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

  relationTypeCode: string

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

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

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

  customerOrderNumber: string

  externalOrderID: string

  uniqueID: string

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

  uniqueID: string

  externalOrderItemID: string

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

  userDataField: object[]

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

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

  value: string

  key: string

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

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

  associatedPromotion: object[]

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

  code: string

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

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

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

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

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

  value: string

  language: string

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

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

  uniqueID: string

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

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

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

  uniqueID: string

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

  calculationUsageID: string

  code: string

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

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

  uniqueID: string

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

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

  ownerID: string

  nameIdentifier: string

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

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

  version: integer (int64)

  name: string

  revision: integer (int64)

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

  uniqueID: string

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

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

  ownerID: string

  nameIdentifier: string

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

  reasonCode: string

  valid: boolean

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

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

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

  value: string

  language: string

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

  userDataField: object[]

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

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

  value: string

  key: string

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

  userDataField: object[]

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

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

  value: string

  key: string

  com.ibm.commerce.order.facade.datatypes.RewardOptionType: object

  rewardChoice: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice

  userData: com.ibm.commerce.order.facade.datatypes.RewardOptionType.userData

  rewardSpecification: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification

  rewardOptionIdentifier: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardOptionIdentifier

  adjustment: com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment: object

  userData: com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.userData

  code: string

  description: com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.description

  displayLevel: string

  calculationCodeID: com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.calculationCodeID

  amount: com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.amount

  promotionType: string

  usage: string

  isPromotionCodeRequired: boolean

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.amount: object

  currency: string

  value: number (double)

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.calculationCodeID: object

  calculationCodeExternalIdentifier: com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.calculationCodeID.calculationCodeExternalIdentifier

  uniqueID: string

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.calculationCodeID.calculationCodeExternalIdentifier: object

  calculationUsageID: string

  code: string

  storeIdentifier: com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier: object

  uniqueID: string

  externalIdentifier: com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.calculationCodeID.calculationCodeExternalIdentifier.storeIdentifier.externalIdentifier: object

  ownerID: string

  nameIdentifier: string

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.description: object

  value: string

  language: string

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.userData: object

  userDataField: object[]

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.userData.userDataField

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.adjustment.userData.userDataField: object

  value: string

  key: string

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice: object

  userData: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.userData

  giftSet: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet: object

  giftItem: object[]

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem: object

  catalogEntryIdentifier: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem.catalogEntryIdentifier

  quantity: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem.quantity

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem.catalogEntryIdentifier: object

  uniqueID: string

  externalIdentifier: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier: object

  ownerID: string

  partNumber: string

  storeIdentifier: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier: object

  uniqueID: string

  externalIdentifier: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object

  ownerID: string

  nameIdentifier: string

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.giftSet.giftItem.quantity: object

  value: number (double)

  uom: string

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.userData: object

  userDataField: object[]

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.userData.userDataField

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardChoice.userData.userDataField: object

  value: string

  key: string

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardOptionIdentifier: object

  uniqueID: string

  externalIdentifier: string

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification: object

  giftSetSpecification: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification

  userData: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.userData

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification: object

  maximumQuantity: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.maximumQuantity

  giftItem: object[]

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem: object

  catalogEntryIdentifier: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier

  quantity: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem.quantity

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier: object

  uniqueID: string

  externalIdentifier: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier: object

  ownerID: string

  partNumber: string

  storeIdentifier: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier: object

  uniqueID: string

  externalIdentifier: com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem.catalogEntryIdentifier.externalIdentifier.storeIdentifier.externalIdentifier: object

  ownerID: string

  nameIdentifier: string

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.giftItem.quantity: object

  value: number (double)

  uom: string

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.giftSetSpecification.maximumQuantity: object

  value: number (double)

  uom: string

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.userData: object

  userDataField: object[]

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.userData.userDataField

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.rewardSpecification.userData.userDataField: object

  value: string

  key: string

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.userData: object

  userDataField: object[]

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

  com.ibm.commerce.order.facade.datatypes.RewardOptionType.userData.userDataField: object

  value: string

  key: string

  com.ibm.commerce.orderitems.commands.OrderItemDisplayCmd: object

  com.ibm.commerce.payment.beans.BuyerPurchaseOrderDataBean_IBM_BuyerPurchaseOrder_Summary: object

  resultList: object[]

  com.ibm.commerce.payment.beans.BuyerPurchaseOrderDataBean_IBM_BuyerPurchaseOrder_Summary.resultList

  com.ibm.commerce.payment.beans.BuyerPurchaseOrderDataBean_IBM_BuyerPurchaseOrder_Summary.resultList: object

  dataBeanKeyBuyerPurchaseOrderId: string

  purchaseOrderNumber: string

  state: integer (int32)

  buyerPurchaseOrderTypeId: string

  currency: string

  amount: string

  buyerPurchaseOrderId: integer (int64)

  accountId: integer (int64)

  com.ibm.commerce.payment.beans.PaymentPolicyListDataBean_IBM_PaymentPolicyList_Detailed: object

  resultList: object[]

  com.ibm.commerce.payment.beans.PaymentPolicyListDataBean_IBM_PaymentPolicyList_Detailed.resultList

  com.ibm.commerce.payment.beans.PaymentPolicyListDataBean_IBM_PaymentPolicyList_Detailed.resultList: object

  secondaryRC: integer (int32)

  paymentPolicyInfoUsableWithoutTA: object[]

  com.ibm.commerce.payment.beans.PaymentPolicyListDataBean_IBM_PaymentPolicyList_Detailed.resultList.paymentPolicyInfoUsableWithoutTA

  message: string

  primaryRC: integer (int32)

  com.ibm.commerce.payment.beans.PaymentPolicyListDataBean_IBM_PaymentPolicyList_Detailed.resultList.paymentPolicyInfoUsableWithoutTA: object

  policyName: string

  attrPageName: string

  longDescription: string

  policyType: string

  policyId: string

  shortDescription: string

  com.ibm.commerce.payment.punchout.commands.PunchoutPaymentCallBackCmd: object

  com.ibm.commerce.rest.order.handler.CartHandler$AddConfigurationToCartRequest: object

  comment: string

  The identifier of the address to which the products and items are shipped.

  addressId: string

  The reference number of the shipping mode to use for the product or item.

  catEntryId: string

  The identifier of a catalog entry to use to create a new OrderItem.

  check: string

  A list of OrderItems that should be checked by the CheckInventoryAvailability task command.

  UOM: string

  The unit of measure for quantity.

  ConfigXML: string

  The configuration XML of the dynamic kit to add.

  inventoryValidation: string

  Specifies whether inventory status should be validated for adding to cart.

  fulfillmentCenterId: string

  The identifier of the fulfillment center that this item belongs to.

  shipModeId: string

  The identifier associated with a particular shipping service.

  contractId: string

  The identifier of the contract associated with the order.

  physicalStoreId: string

  A comment to include with the created or updated order items.

  allocate: string

  A list of OrderItems that should be allocated from existing inventory.

  doPrice: string

  Specifies whether the command should perform the price calculation subtasks. Set to enable the price tasks (Y), or to disable price tasks (N).

  doInventory: string

  Specifies whether the command should perform the inventory calculation subtasks. Set to either do the price tasks (Y), or not (N). Turning off these tasks might result in better performance, but customers might not get the most current inventory level, when changes occur.

  orderItemId: string

  The identifier of the OrderItem to update.

  calculationUsage: string

  The identifier for the type of calculation to perform on the order.

  reverse: string

  A list of OrderItems whose allocations should be released (that is, de-allocated from existing or expected inventory as appropriate).

  remerge: string

  A list of the OrderItems that should be merged with other OrderItems in the same order and with the same correlationGroup attribute, if possible. OrderItems are not merged unless their InventoryStatus is "NALC", or they are specified by one or more of the allocate, backorder, and reverse parameters.

  calculateOrder: string

  Specifies whether OrderCalculateCmd is called to calculate the charges for the order. 0 = do not call OrderCalculateCmd, 1 = call OrderCalculateCmd.

  merge: string

  A list of OrderItems that should be merged with other OrderItems in the same order if possible, regardless of their correlationGroup attributes.

  backorder: string

  A list of OrderItems that should be allocated from expected inventory if they are not allocated from existing inventory.

  partNumber: string

  The part number of catalog entry.

  quantity: string

  The quantity of the item to add to the order.

  com.ibm.commerce.rest.order.handler.CartHandler$AddOrderItemBodyDescription: object

  Description of the addOrderItem input body.

  orderExtendAttribute: object[]

  order extended attribute

  com.ibm.commerce.rest.order.handler.CartHandler$AddOrderItemBodyDescription$OrderExtendAttributeBodyDescription

  orderId: string

  The order ID

  orderItem: object[]

  list of order items

  com.ibm.commerce.rest.order.handler.CartHandler$AddOrderItemBodyDescription$OrderItemBodyDescription

  x_calculateOrder: string

  Specifies whether OrderCalculateCmd will be called to calculate the charges for the order. 0 = do not call OrderCalculateCmd, 1 = call OrderCalculateCmd.

  x_calculationUsage: string

  The identifier for the type of calculation to be performed on the order.

  x_inventoryValidation: string

  Specifies whether inventory status should be validated for adding to cart.

  com.ibm.commerce.rest.order.handler.CartHandler$AddOrderItemBodyDescription$OrderExtendAttributeBodyDescription: object

  Description of order extended attribute.

  attributeName: string

  attribute name

  attributeType: string

  attribute type

  attributeValue: string

  attribute value

  com.ibm.commerce.rest.order.handler.CartHandler$AddOrderItemBodyDescription$OrderItemBodyDescription: object

  Description of orderItem.

  comment: string

  The order item comment.

  fulfillmentCenterName: string

  The name of the fulfillment center where the order item should be fulfilled.

  quantity: string

  Quantity.

  fulfillmentCenterId: string

  The fulfillment center ID where the order item should be fulfilled.

  orderItemExtendAttribute: object[]

  Order item extended attribute.

  com.ibm.commerce.rest.order.handler.CartHandler$AddOrderItemBodyDescription$OrderItemBodyDescription$OrderItemExtendAttributeBodyDescription

  itemAttributes: object[]

  Item attributes.

  com.ibm.commerce.rest.order.handler.CartHandler$AddOrderItemBodyDescription$OrderItemBodyDescription$ItemAttributesBodyDescription

  partNumber: string

  The reference number that identifies the external part number of the catalog.

  productId: string

  Product ID.

  UOM: string

  The unit of measure of the order item.

  contractId: string

  The contract ID of the contract on which the order item addition is based.

  com.ibm.commerce.rest.order.handler.CartHandler$AddOrderItemBodyDescription$OrderItemBodyDescription$ItemAttributesBodyDescription: object

  Description of item attributes.

  attrName: string

  Attribute name.

  attrValue: string

  Attribute value.

  com.ibm.commerce.rest.order.handler.CartHandler$AddOrderItemBodyDescription$OrderItemBodyDescription$OrderItemExtendAttributeBodyDescription: object

  Description of orderitem extended attribute.

  attributeName: string

  Attribute name.

  attributeType: string

  Attribute type.

  attributeValue: string

  Attribute value.

  com.ibm.commerce.rest.order.handler.CartHandler$AddPreConfigurationToCartRequest: object

  comment: string

  The identifier of the address to which the products and items are shipped.

  addressId: string

  The reference number of the shipping mode to use for the product or item.

  catEntryId: string

  The identifier of a catalog entry to use to create a new OrderItem.

  check: string

  A list of OrderItems that should be checked by the CheckInventoryAvailability task command.

  UOM: string

  The unit of measure for quantity.

  inventoryValidation: string

  Specifies whether inventory status should be validated for adding to cart.

  fulfillmentCenterId: string

  The identifier of the fulfillment center that this item belongs to.

  shipModeId: string

  The identifier associated with a particular shipping service.

  contractId: string

  The identifier of the contract associated with the order.

  physicalStoreId: string

  A comment to include with the created or updated order items.

  allocate: string

  A list of OrderItems that should be allocated from existing inventory.

  doPrice: string

  Specifies whether the command should perform the price calculation subtasks. Set to enable the price tasks (Y), or to disable price tasks (N).

  doInventory: string

  Specifies whether the command should perform the inventory calculation subtasks. Set to either do the price tasks (Y), or not (N). Turning off these tasks might result in better performance, but customers might not get the most current inventory level, when changes occur.

  orderItemId: string

  The identifier of the OrderItem to update.

  calculationUsage: string

  The identifier for the type of calculation to perform on the order.

  reverse: string

  A list of OrderItems whose allocations should be released (that is, de-allocated from existing or expected inventory as appropriate).

  remerge: string

  A list of the OrderItems that should be merged with other OrderItems in the same order and with the same correlationGroup attribute, if possible. OrderItems are not merged unless their InventoryStatus is "NALC", or they are specified by one or more of the allocate, backorder, and reverse parameters.

  calculateOrder: string

  Specifies whether OrderCalculateCmd is called to calculate the charges for the order. 0 = do not call OrderCalculateCmd, 1 = call OrderCalculateCmd.

  merge: string

  A list of OrderItems that should be merged with other OrderItems in the same order if possible, regardless of their correlationGroup attributes.

  backorder: string

  A list of OrderItems that should be allocated from expected inventory if they are not allocated from existing inventory.

  partNumber: string

  The part number of catalog entry.

  quantity: string

  The quantity of the item to add to the order.

  com.ibm.commerce.rest.order.handler.CartHandler$ApplePayProcessBodyDescription: object

  Description of the ApplePayProcess input body.

  billingContact: com.ibm.commerce.rest.order.handler.CartHandler$ApplePayProcessBodyDescription$ApplePayBillingAddressDescription

  applepay billing contact description.

  orderId: string

  order ID

  shippingContact: com.ibm.commerce.rest.order.handler.CartHandler$ApplePayProcessBodyDescription$ApplePayShippingAddressDescription

  apple pay shipping contact description.

  unboundPIId: string

  The unbound payment instruction id for payment type promotion.

  com.ibm.commerce.rest.order.handler.CartHandler$ApplePayProcessBodyDescription$ApplePayBillingAddressDescription: object

  Description of applePayBillingAddress.

  address1: string

  The billing address address line 1.

  address2: string

  The billing address address line 2.

  city: string

  The billing address city.

  country: string

  The billing address country.

  firstName: string

  The billing address first name.

  lastName: string

  The billing address last name.

  state: string

  The billing address state.

  zipCode: string

  The billing address zip code.

  com.ibm.commerce.rest.order.handler.CartHandler$ApplePayProcessBodyDescription$ApplePayShippingAddressDescription: object

  Description of applePayShippingAddress.

  address1: string

  The shipping address address line 1.

  address2: string

  The shipping address address line 2.

  city: string

  The shipping address city.

  country: string

  The shipping address country.

  email1: string

  The shipping address email address.

  firstName: string

  The shipping address first name.

  lastName: string

  The shipping address last name.

  phone1: string

  The shipping address phone number.

  state: string

  The shipping address state.

  zipCode: string

  The shipping address zip code.

  com.ibm.commerce.rest.order.handler.CartHandler$ApplePayUpdateBodyDescription: object

  Description of the ApplePayUpdate input body.

  addressId: string

  Address identifier.

  applePayAddress: com.ibm.commerce.rest.order.handler.CartHandler$ApplePayUpdateBodyDescription$ApplePayAddressDescription

  applePayAddress description.

  orderId: string

  The order ID

  shipModeId: string

  Shipping mode identifier.

  x_calculationUsage: string

  The identifier for the type of calculation to be performed on the order.

  com.ibm.commerce.rest.order.handler.CartHandler$ApplePayUpdateBodyDescription$ApplePayAddressDescription: object

  Description of applePayAddress.

  city: string

  The shipping address city.

  country: string

  The shipping address country.

  state: string

  The shipping address state.

  zipCode: string

  The shipping address zip code.

  com.ibm.commerce.rest.order.handler.CartHandler$CalculateOrderRequest: object

  Body of request input for calculateOrder.

  orderId: string

  Order identifier.

  calculationUsageId: string

  Gives predefined codes for calculation of discounts (-1), shipping (-2), sales tax (-3), shipping tax (-4), coupons (-5), surcharge (-6) and shipping adjustment (-7).

  doPrice: string

  Specifies whether the command should perform the price calculation subtasks. Set to enable the price tasks (Y), or to disable price tasks (N).

  updatePrices: string

  Flag to indicate whether the price of order item is refreshed in this command. if the flag is "1", price is updated. others will not.

  outOrderName: string

  Specifies the names of name-value pairs to pass to a JSP file. The value of each added name-value pair is the reference number of the order to display. If the name is not provided, the default name orderId is used. This parameter can be repeated.

  doFreeGift: string

  Specifies whether the command should perform the free gift handling logic. Set to enable free gift handling, or not to handle free gifts when not required for order recalculation (N). Default is (Y).

  com.ibm.commerce.rest.order.handler.CartHandler$CheckoutRequest: object

  Request body input for shopping cart submission for checkout.

  orderId: string

  Order identifier.

  notifyOrderSubmitted: string

  Specifies whether the customer is notified when the order is successfully submitted for processing. 1=Yes, 0=No (Default).

  SMS: string

  Send SMS notifications to the target phone number.

  orderExtendAttribute: object[]

  Order extended attribute.

  com.ibm.commerce.rest.order.handler.CartHandler$CheckoutRequest$OrderExtendAttributeBodyDescription

  notifyMerchant: string

  Whether the store is notified when the order processing is complete. E-mail notifications are only sent when WebSphere Commerce is configured with WebSphere Commerce Payments. 1=Yes ,0=No.

  notifyShopper: string

  Whether the customer is notified when the order processing is complete. E-mail notifications are only sent when WebSphere Commerce is configured with WebSphere Commerce Payments. 1=Yes, 0=No.

  notify_EMailSender_recipient: string

  Send order e-mail notifications to the target recipient.

  purchaseorder_id: string

  The purchase order ID.

  com.ibm.commerce.rest.order.handler.CartHandler$CheckoutRequest$OrderExtendAttributeBodyDescription: object

  Description of order extended attribute.

  attributeName: string

  Attribute name.

  attributeType: string

  Attribute type.

  attributeValue: string

  Attribute value.

  com.ibm.commerce.rest.order.handler.CartHandler$CopyOrderRequest: object

  comment: string

  A comment to include with the item when order items are added to or updated in the destination order.

  requestedShipDate: string

  The date which the destination order should be shipped.

  addressId: string

  The reference number of the address to which the order items are shipped.

  fromOrderId: string

  Specifies zero or more source orders from which order items is copied.

  catEntryId: string

  The catalog entry ID of the order item.

  offerId: string

  List of offer IDs to chose from when creating a new order item.

  currency: string

  The currency of the order items.

  pay_paymentname: string

  (Deprecated) This is supported for compatibility with earlier versions. With payment rule, ORDPAYINFO is not used, while using payment plugin controller and payment plugins. Sets the payment name-value pairs of the destination order.

  copyOrderItemId: string

  Specifies which order items should be copied from the source orders specified by fromOrderId and added to the destination order specified by toOrderId.

  toOrderId: string

  Specifies the order to create or modify.

  check: string

  List of order items that is to check by the CheckInventory task command.

  UOM: string

  The unit of measure for the quantity.

  prepare: string

  Whether to prepare the order by calling the PrepareOrder command.

  field2: string

  Sets the field2 value of the destination order. If not specified, the corresponding field value of the "orderInfoFrom" order is used, if there is one.

  field3: string

  Sets the field3 value of the destination order. If not specified, the corresponding field value of the "orderInfoFrom" order is used, if there is one.

  field1: string

  Sets the field1 value of the destination order. If not specified, the corresponding field value of the "orderInfoFrom" order is used, if there is one.

  copyOrderPromotionCode: string

  Whether to copy public promotion codes applied to the order.

  inventoryValidation: string

  Whether inventory status should be validated for adding to cart.

  updateOrderItemId: string

  Specifies order items in the destination order to update. It is updated using information from other parameters in the enumeration group specified by i, but not from the source orders for that enumeration group and not from catEntryId and partNumber. Note that the catalog entry ID of an order item cannot be updated.

  keepOrdItemValidContract: string

  Whether to keep eligible contracts.

  allocate: string

  List of order items that is to allocate from existing inventory.

  shipModeId: string

  The reference number associated with a particular shipping service.

  copyOrderUniquePromotionCode: string

  Whether to copy unique promotion codes applied to the order.

  orderInfoFrom: string

  The reference number of an order from which to copy order-level information.

  billingAddressId: string

  The billing address ID of the destination order.

  price: string

  The price of the order items.

  payInfoFrom: string

  The reference number of an order from which to obtain payment information. If more than one order is specified, only the most recently updated of those orders applies.

  status: string

  The status of the destination order.

  shipAsComplete: string

  Specifies if the created or modified order can be partially shipped. If the value is Y, the order is shipped when all order items are available. If the value is N, the order can be partially shipped when some of the order items are available.

  orderComment: string

  The order comment.

  description: string

  The description of the destination order.

  copyAutoAddedOrderItems: string

  Whether to copy auto-added order items.

  shippingModeFromOrderProfile: string

  Whether to use the default shipping mode held in the order profile: if the value is 1, the default shipping mode is copied from the order profile to all the order items of the order specified in toOrderId.

  configurationId: string

  If the order item represents a configured Dynamic Kit, this is the configuration ID.

  blockInfoCopy: string

  Whether the orderblock objects is copied.

  displaySeq: string

  The display sequence of the destination order.

  partOwnerId: string

  The member ID of the part owner, used with partNumber.

  copyOrdPayInfo: string

  Whether to copy order payment information.

  correlationGroup: string

  The group to which this order item is related.

  contractId: string

  The contract reference number associated with the order.

  reverse: string

  List of order items to release the allocation for.

  remerge: string

  List of the order items to merge with other order items in the same order and with the same correlationGroup attribute, if possible.

  outOrderName: string

  The reference number of a destination order.

  outOrderItemName: string

  The reference number of a destination order item.

  isPONumberCopied: string

  Whether the PO number of source order is copied to the destination order.

  refreshContractAndOffer: string

  Whether to refresh the price information for all order items.

  memberId: string

  The reference number of a member, used to resolve special order abbreviations when they appear in fromOrderId.

  merge: string

  List of order items that is to merge with other order items in the same order if possible, regardless of their correlationGroup attributes.

  sensitiveInfoCopy: string

  Whether the payment methods is copied.

  continue: string

  Controls whether the order copy continues when one or more of the order items cannot be copied. A value of 0 terminates and rolls back execution if an order item cannot be created or updated in the target order. A value of 1 ignores the create or update operation for that order item and continues execution. Default is 0.

  shippingAddressFromOrderProfile: string

  Whether to use the default shipping address held in the order profile: if the value is 1, the default shipping address is copied from the order profile to all the order items of the order specified in toOrderId.

  backorder: string

  List of order items that is to allocate from expected inventory.

  partNumber: string

  Part number to resolve to a catalog entry. It overrides catEntryId.

  tcId: string

  The term and condition ID of the destination order.

  quantity: string

  The quantity of the order item.

  com.ibm.commerce.rest.order.handler.CartHandler$CreateOrderRequest: object

  outOrderName: string

  The reference number of a destination order.

  com.ibm.commerce.rest.order.handler.CartHandler$DeleteOrderItemRequest: object

  orderId: string

  The order ID.

  calculationUsage: string

  The identifier for the type of calculation to perform on the order.

  orderItemId: string

  The order item identifier.

  calculateOrder: string

  Specifies whether OrderCalculateCmd is called to calculate the charges for the order. 0 = do not call OrderCalculateCmd, 1 = call OrderCalculateCmd.

  catEntryId: string

  The catalog entry ID of the item to delete from the order.

  outOrderName: string

  Specifies the name-value pairs to add to the redirection URL. The values of the added name-value pairs are the reference numbers of the input orders.

  check: string

  A list of order items that is to check by the CheckInventory task command.

  com.ibm.commerce.rest.order.handler.CartHandler$OrderIdContainer: object

  Structure containing an order identifier.

  orderId: string

  Order identifier.

  com.ibm.commerce.rest.order.handler.CartHandler$OrderItemMoveRequest: object

  outReverse: string

  List of OrderItems whose allocations should be released.

  fromOrderId: string

  The orders from which OrderItems is moved.

  createIfEmpty: string

  The valid value of this parameter is 1 or 0. Default is 0. If the parameter createIfEmpty is specified to 1 and there is no transferred order items, a new empty order is created when either the toOrderId parameter is or the toOrderId parameter is .. but there is no current pending order. The symbol "" means to create new pending order; the symbol ".." means to create new pending order if there are no pending orders currently.

  inReverse: string

  List of OrderItems whose allocations should be released.

  outOrderName: string

  The reference number of an output order.

  outRemerge: string

  List of the OrderItems that should be merged with other OrderItems in the same order and with the same correlationGroup attribute, if possible.

  outAllocate: string

  List of OrderItems that should be allocated from existing inventory.

  inAllocate: string

  List of OrderItems that should be allocated from existing inventory.

  fromOrderItemId: string

  The input OrderItems to move.

  toOrderId: string

  The destination order for the output OrderItems.

  moveAutoAddedOrderItems: string

  Whether the auto added order items is moved.

  inCheck: string

  List of OrderItems that should be checked on inventory.

  outMerge: string

  List of OrderItems that should be merged with other OrderItems in the same order if possible, regardless of their correlationGroup attributes.

  inMerge: string

  List of OrderItems that should be merged with other OrderItems in the same order if possible, regardless of their correlationGroup attributes.

  doInventory: string

  Whether the inventory action is performed.

  deleteIfEmpty: string

  Whether orders should be deleted if no OrderItems remain when the OrderItems are moved.

  outBackorder: string

  List of OrderItems that should be allocated from expected inventory.

  moveOrderPromotionCode: string

  Whether the promotion code is merged into the target order.

  inOrderName: string

  The reference number of an input order.

  refreshContractAndOffer: string

  Whether the price information for all of the order items is refreshed.

  outOrderItemName: string

  The reference number of an output OrderItem.

  inBackorder: string

  List of OrderItems that should be allocated from expected inventory.

  outCheck: string

  List of OrderItems that should be checked on inventory.

  inRemerge: string

  List of OrderItems that should be merged with other OrderItems in the same order and with the same correlationGroup attribute, if possible.

  com.ibm.commerce.rest.order.handler.CartHandler$OrderScheduleRequest: object

  orderId: string

  Order identifier.

  interval: string

  The number of seconds between successive executions of this order.

  host: string

  Host name responsible for processing an order.

  delay: string

  The amount of time, in seconds, before order processing is retried, in case of order processing failure. This parameter must be paired with the attempts parameter.

  start: string

  The time at which the first execution of this order should occur in the format YYYY:MM:DD:hh:mm:ss. Only hh:mm:ss is mandatory.

  attempts: string

  The number of times the scheduler tries processing this order if order processing fails.

  com.ibm.commerce.rest.order.handler.CartHandler$OrderWithOrderItemContainer: object

  Structure containing an order ID and order item ID.

  orderId: string

  Order identifier.

  orderItem: object[]

  List of order items.

  com.ibm.commerce.rest.order.handler.CartHandler$OrderWithOrderItemContainer$OrderItemBodyDescription

  com.ibm.commerce.rest.order.handler.CartHandler$OrderWithOrderItemContainer$OrderItemBodyDescription: object

  Description of orderItem.

  orderItemId: string

  The order item ID.

  com.ibm.commerce.rest.order.handler.CartHandler$RewardChoiceUpdateRequest: object

  orderId: string

  The id of the order to which the reward option record is associated with.

  rewardOptionId: string

  The ID of the reward option record to update with reward choice information.

  com.ibm.commerce.rest.order.handler.CartHandler$SetPendingOrderRequest: object

  orderId: string

  Specifies an order using the order reference number or one of the Order abbreviations. If the parameter is omitted, all the pending orders is set to current. If a specified pending order no longer exists, it is not set to current.

  outOrderName: string

  The reference number of a destination order.

  com.ibm.commerce.rest.order.handler.CartHandler$ShippingModes: object

  Shipping mode list.

  usableShippingMode: object[]

  List of order items.

  com.ibm.commerce.rest.order.handler.CartHandler$ShippingModes$UsableShippingMode

  com.ibm.commerce.rest.order.handler.CartHandler$ShippingModes$UsableShippingMode: object

  Description of orderItem.

  userData: string

  User data.

  description: string

  Shiping mode description.

  trackingURL: string

  Shipping mode tracking URL.

  carrier: string

  Shipping mode carrier.

  shipModeCode: string

  Shipping mode code.

  shipModeId: string

  Shipping mode identifier.

  com.ibm.commerce.rest.order.handler.CartHandler$UpdateConfigurationInCartRequest: object

  ConfigXML: string

  The new configuration XML of the dynamic kit.

  orderItemId: string

  The ID of the order item to update.

  com.ibm.commerce.rest.order.handler.CartHandler$UpdateOrderItemBodyDescription: object

  Description of the updateOrderItem input body.

  orderExtendAttribute: object[]

  order extended attribute

  com.ibm.commerce.rest.order.handler.CartHandler$UpdateOrderItemBodyDescription$OrderExtendAttributeBodyDescription

  orderId: string

  The order ID.

  x_calculationUsage: string

  The identifier for the type of calculation to perform on the order.

  x_calculateOrder: string

  Specifies whether OrderCalculateCmd is called to calculate the charges for the order. 0 = do not call OrderCalculateCmd, 1 = call OrderCalculateCmd.

  orderItem: object[]

  List of order items.

  com.ibm.commerce.rest.order.handler.CartHandler$UpdateOrderItemBodyDescription$OrderItemBodyDescription

  x_inventoryValidation: string

  Specifies whether inventory status should be validated for adding to cart.

  com.ibm.commerce.rest.order.handler.CartHandler$UpdateOrderItemBodyDescription$OrderExtendAttributeBodyDescription: object

  Description of order extended attribute.

  attributeName: string

  attribute name

  attributeType: string

  attribute type

  attributeValue: string

  attribute value

  com.ibm.commerce.rest.order.handler.CartHandler$UpdateOrderItemBodyDescription$OrderItemBodyDescription: object

  Description of orderItem.

  orderItemId: string

  The order item ID.

  contractId: string

  The contract ID of the contract on which the order item addition is based.

  orderItemExtendAttribute: object[]

  Order item extended attribute.

  com.ibm.commerce.rest.order.handler.CartHandler$UpdateOrderItemBodyDescription$OrderItemBodyDescription$OrderItemExtendAttributeBodyDescription

  partNumber: string

  The reference number that identifies the external part number of the catalog.

  quantity: string

  Quantity.

  productId: string

  Product ID.

  com.ibm.commerce.rest.order.handler.CartHandler$UpdateOrderItemBodyDescription$OrderItemBodyDescription$OrderItemExtendAttributeBodyDescription: object

  Description of orderitem extended attribute.

  attributeName: string

  The attribute name.

  attributeType: string

  The attribute type.

  attributeValue: string

  The attribute value.

  com.ibm.commerce.rest.order.handler.PaymentInstructionHandler$PaymentInstructionList: object

  Payment instruction list.

  orderId: string

  Order identifier.

  paymentInstruction: object[]

  List of payment instructions.

  com.ibm.commerce.rest.order.handler.PaymentInstructionHandler$PaymentInstructionList$PaymentInstruction

  com.ibm.commerce.rest.order.handler.PaymentInstructionHandler$PaymentInstructionList$PaymentInstruction: object

  Payment instruction.

  piId: string

  Payment instruction ID.

  com.ibm.commerce.rest.order.handler.ShippingInfoHandler$UpdateShippingInfoBodyDescription: object

  Order update shipping information.

  shipAsComplete: string

  Option to ship the order as complete. Valid values include "true" and "false".

  orderItem: object[]

  A list of order items.

  com.ibm.commerce.rest.order.handler.ShippingInfoHandler$UpdateShippingInfoBodyDescription$OrderItemBodyDescription

  shipModeId: string

  Shipping mode identifier.

  addressId: string

  Address identifier.

  x_calculationUsage: string

  Calculation usage codes.

  com.ibm.commerce.rest.order.handler.ShippingInfoHandler$UpdateShippingInfoBodyDescription$OrderItemBodyDescription: object

  Order item update shipping information.

  physicalStoreId: string

  Physical mode identifier.

  shipModeId: string

  Shipping mode identifier.

  shipInstructions: string

  Shipping instructions.

  addressId: string

  Address identifier.

  orderItemId: string

  Order item identifier.

  com.ibm.commerce.utf.beans.PAttributeDataBean_IBM_PAttribute_Detailed: object

  resultList: object[]

  com.ibm.commerce.utf.beans.PAttributeDataBean_IBM_PAttribute_Detailed.resultList

  com.ibm.commerce.utf.beans.PAttributeDataBean_IBM_PAttribute_Detailed.resultList: object

  PAttributeId: string

  name: string

  referenceNumber: integer (int64)

  encryptFlag: string

  sequence: integer (int32)

  accessBeanName: string

  attrTypeId: string

  Empty: object

  Empty model. Used as default value when no model is specified.

  java.util.Map$Entry: object

  value: string

  key: string